Refactors router

go.mod

@@ -3,16 +3,16 @@ module products
 go 1.26
 
 require (
-	github.com/go-chi/chi/v5 v5.2.5
+	github.com/go-chi/chi/v5 v5.3.0
 	github.com/go-chi/cors v1.2.2
 	github.com/google/uuid v1.6.0
-	github.com/jackc/pgx/v5 v5.9.2
+	github.com/jackc/pgx/v5 v5.10.0
 )
 
 require (
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
 	github.com/jackc/puddle/v2 v2.2.2 // indirect
-	golang.org/x/sync v0.17.0 // indirect
-	golang.org/x/text v0.29.0 // indirect
+	golang.org/x/sync v0.21.0 // indirect
+	golang.org/x/text v0.38.0 // indirect
 )

go.sum

@@ -3,6 +3,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-chi/chi/v5 v5.2.5 h1:Eg4myHZBjyvJmAFjFvWgrqDTXFyOzjj7YIm3L3mu6Ug=
 github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0=
+github.com/go-chi/chi/v5 v5.3.0 h1:halUjDxhshgXHMrao5bB8eNBXo/rnzwr8m5m36glehM=
+github.com/go-chi/chi/v5 v5.3.0/go.mod h1:R+tYY2hNuVUUjxoPtqUdgBqevM9s9njzkTLutVsOCto=
 github.com/go-chi/cors v1.2.2 h1:Jmey33TE+b+rB7fT8MUy1u0I4L+NARQlK6LhzKPSyQE=
 github.com/go-chi/cors v1.2.2/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
@@ -13,6 +15,8 @@ github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7Ulw
 github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
 github.com/jackc/pgx/v5 v5.9.2 h1:3ZhOzMWnR4yJ+RW1XImIPsD1aNSz4T4fyP7zlQb56hw=
 github.com/jackc/pgx/v5 v5.9.2/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
+github.com/jackc/pgx/v5 v5.10.0 h1:VhSvgU2jSli8o3AqIEOTJr7rZwAEUVo4E4XhR94Zfr0=
+github.com/jackc/pgx/v5 v5.10.0/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
 github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
 github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -24,8 +28,12 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
 golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
+golang.org/x/sync v0.21.0 h1:HLII4xRRTtCRkxYp4HNFF0Js/Og6q2i++KXbg0gHCwM=
+golang.org/x/sync v0.21.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
 golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
 golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
+golang.org/x/text v0.38.0 h1:sXmwo9DwP3OK9EZ7PqAdaooSGozfl/3a6/xJcbzPRhE=
+golang.org/x/text v0.38.0/go.mod h1:YXZt3QhHUKYT53r2lLKFIVi6Ao1jdzrTR/KQ09qyxF4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

internal/capability/handler.go

@@ -7,32 +7,20 @@ import (
 	"log/slog"
 	"net/http"
 	"products/internal"
-	"products/internal/capability/db"
 	"time"
 )
 
-type Handler interface {
-	CreateCapability(w http.ResponseWriter, r *http.Request)
-	GetCapability(w http.ResponseWriter, r *http.Request)
-	GetCapabilitiesByFlow(w http.ResponseWriter, r *http.Request)
-	GetCapabilitiesByProduct(w http.ResponseWriter, r *http.Request)
-}
-
-func NewHandler(dbConn db.DBTX) Handler {
-	queries := db.New(dbConn)
-	service := &postgresService{
-		queries: queries,
-	}
-	return &capabilityHandler{
-		service: service,
+func newHandler(svc capabilityService) *handler {
+	return &handler{
+		service: svc,
 	}
 }
 
-type capabilityHandler struct {
+type handler struct {
 	service capabilityService
 }
 
-func (h *capabilityHandler) CreateCapability(w http.ResponseWriter, r *http.Request) {
+func (h *handler) CreateCapability(w http.ResponseWriter, r *http.Request) {
 	capReq := &createCapabilityRequest{}
 	if err := json.NewDecoder(r.Body).Decode(capReq); err != nil {
 		http.Error(w, err.Error(), http.StatusBadRequest)
@@ -52,7 +40,7 @@ func (h *capabilityHandler) CreateCapability(w http.ResponseWriter, r *http.Requ
 	internal.WriteJSONResponse(w, r, http.StatusCreated, newCap)
 }
 
-func (h *capabilityHandler) GetCapability(w http.ResponseWriter, r *http.Request) {
+func (h *handler) GetCapability(w http.ResponseWriter, r *http.Request) {
 	id, ok := internal.GetIntFromRequestPath("id", r)
 	if !ok {
 		internal.HandleHttpError(w, internal.ErrorEnvelope{Detail: "Invalid capability ID"}, http.StatusBadRequest)
@@ -73,7 +61,7 @@ func (h *capabilityHandler) GetCapability(w http.ResponseWriter, r *http.Request
 	internal.WriteJSONResponse(w, r, http.StatusOK, capability)
 }
 
-func (h *capabilityHandler) GetCapabilitiesByFlow(w http.ResponseWriter, r *http.Request) {
+func (h *handler) GetCapabilitiesByFlow(w http.ResponseWriter, r *http.Request) {
 	id, ok := internal.GetIntFromRequestPath("id", r)
 	if !ok {
 		internal.HandleHttpError(w, internal.ErrorEnvelope{Detail: "Invalid capability ID"}, http.StatusBadRequest)
@@ -94,7 +82,7 @@ func (h *capabilityHandler) GetCapabilitiesByFlow(w http.ResponseWriter, r *http
 	internal.WriteJSONResponse(w, r, http.StatusOK, capabilities)
 }
 
-func (h *capabilityHandler) GetCapabilitiesByProduct(w http.ResponseWriter, r *http.Request) {
+func (h *handler) GetCapabilitiesByProduct(w http.ResponseWriter, r *http.Request) {
 	id, ok := internal.GetIntFromRequestPath("id", r)
 	if !ok {
 		internal.HandleHttpError(w, internal.ErrorEnvelope{Detail: "Invalid capability ID"}, http.StatusBadRequest)

internal/capability/handler_test.go

@@ -104,7 +104,7 @@ func TestHandler_CreateCapability(t *testing.T) {
 				tt.mockSetup(mockSvc)
 			}
 
-			h := &capabilityHandler{service: mockSvc}
+			h := &handler{service: mockSvc}
 			h.CreateCapability(w, req)
 
 			if w.Code != tt.expectedStatus {
@@ -129,8 +129,8 @@ func (m *mockDBTX) QueryRow(context.Context, string, ...interface{}) pgx.Row {
 }
 
 func TestNewHandler(t *testing.T) {
-	mockDB := &mockDBTX{}
-	h := NewHandler(mockDB)
+	mockService := &mockCapabilityService{}
+	h := newHandler(mockService)
 	if h == nil {
 		t.Error("expected handler to be non-nil")
 	}
@@ -241,7 +241,7 @@ func TestHandler_GetCapability(t *testing.T) {
 			if tt.mockSetup != nil {
 				tt.mockSetup(mockSvc)
 			}
-			h := &capabilityHandler{service: mockSvc}
+			h := &handler{service: mockSvc}
 
 			h.GetCapability(w, req)
 
@@ -360,7 +360,7 @@ func TestHandler_GetCapabilitiesByFlow(t *testing.T) {
 			if tt.mockSetup != nil {
 				tt.mockSetup(mockSvc)
 			}
-			h := &capabilityHandler{service: mockSvc}
+			h := &handler{service: mockSvc}
 
 			h.GetCapabilitiesByFlow(w, req)
 
@@ -479,7 +479,7 @@ func TestHandler_GetCapabilitiesByProduct(t *testing.T) {
 			if tt.mockSetup != nil {
 				tt.mockSetup(mockSvc)
 			}
-			h := &capabilityHandler{service: mockSvc}
+			h := &handler{service: mockSvc}
 
 			h.GetCapabilitiesByProduct(w, req)
 

internal/capability/router.go

@@ -0,0 +1,30 @@
+package capability
+
+import (
+	"context"
+	"products/internal/capability/db"
+
+	"github.com/go-chi/chi/v5"
+)
+
+type capabilityService interface {
+	CreateCapability(ctx context.Context, req createCapabilityRequest) (db.Capability, error)
+	GetCapability(ctx context.Context, id int) (db.Capability, error)
+	GetCapabilitiesByProduct(ctx context.Context, id int) ([]db.GetCapabilitiesByProductRow, error)
+	GetCapabilitiesByFlow(ctx context.Context, id int) ([]db.Capability, error)
+}
+
+func RegisterRoutes(r chi.Router, dbConn db.DBTX) {
+	s := newPostgresService(dbConn)
+	capHandler := newHandler(s)
+	registerRoutesWithHandler(r, capHandler)
+}
+
+func registerRoutesWithHandler(r chi.Router, capHandler *handler) {
+	r.Get("/products/{id}/capabilities", capHandler.GetCapabilitiesByProduct)
+	r.Get("/flows/{id}/capabilities", capHandler.GetCapabilitiesByFlow)
+	r.Route("/capabilities", func(u chi.Router) {
+		u.Post("/", capHandler.CreateCapability)
+		u.Get("/{id}", capHandler.GetCapability)
+	})
+}

internal/capability/router_test.go

@@ -0,0 +1,65 @@
+package capability
+
+import (
+	"context"
+	"net/http"
+	"products/internal/capability/db"
+	"testing"
+
+	"github.com/go-chi/chi/v5"
+)
+
+type mockService struct {
+	called map[string]bool
+}
+
+func newMockService() *mockService {
+	return &mockService{called: make(map[string]bool)}
+}
+
+func (m *mockService) CreateCapability(ctx context.Context, req createCapabilityRequest) (db.Capability, error) {
+	m.called["CreateCapability"] = true
+	return db.Capability{}, nil
+}
+func (m *mockService) GetCapability(ctx context.Context, id int) (db.Capability, error) {
+	m.called["GetCapability"] = true
+	return db.Capability{}, nil
+}
+func (m *mockService) GetCapabilitiesByProduct(ctx context.Context, id int) ([]db.GetCapabilitiesByProductRow, error) {
+	m.called["GetCapabilitiesByProduct"] = true
+	return nil, nil
+}
+func (m *mockService) GetCapabilitiesByFlow(ctx context.Context, id int) ([]db.Capability, error) {
+	m.called["GetCapabilitiesByFlow"] = true
+	return nil, nil
+}
+
+func TestRegisterRoutesWithHandler(t *testing.T) {
+	h := newHandler(newMockService())
+
+	r := chi.NewRouter()
+	registerRoutesWithHandler(r, h)
+
+	got := map[string]bool{}
+
+	err := chi.Walk(r, func(method string, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
+		got[method+" "+route] = true
+		return nil
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want := []string{
+		"GET /products/{id}/capabilities",
+		"GET /flows/{id}/capabilities",
+		"POST /capabilities/",
+		"GET /capabilities/{id}",
+	}
+
+	for _, route := range want {
+		if !got[route] {
+			t.Errorf("expected route %q to be registered", route)
+		}
+	}
+}

internal/capability/service.go

@@ -1,101 +1,16 @@
 package capability
 
 import (
-	"context"
-	"errors"
-	"log/slog"
 	"products/internal/capability/db"
-
-	"github.com/jackc/pgx/v5"
 )
 
-type capabilityService interface {
-	capabilityStepService
-	CreateCapability(ctx context.Context, req createCapabilityRequest) (db.Capability, error)
-	GetCapability(ctx context.Context, id int) (db.Capability, error)
-	GetCapabilitiesByProduct(ctx context.Context, id int) ([]db.GetCapabilitiesByProductRow, error)
-	GetCapabilitiesByFlow(ctx context.Context, id int) ([]db.Capability, error)
-}
-
-type capabilityStepService interface {
+func newPostgresService(dbConn db.DBTX) capabilityService {
+	queries := db.New(dbConn)
+	return &postgresService{
+		queries: queries,
+	}
 }
 
 type postgresService struct {
 	queries db.Querier
 }
-
-func (s *postgresService) CreateCapability(ctx context.Context, req createCapabilityRequest) (db.Capability, error) {
-	name, err := s.queries.GetFlow(ctx, req.FlowId)
-	if err != nil {
-		if errors.Is(err, pgx.ErrNoRows) {
-			return db.Capability{}, NotFoundError{
-				"Flow not found",
-			}
-		}
-		return db.Capability{}, err
-	}
-	if name == "" {
-		return db.Capability{}, NotFoundError{
-			"Flow not found",
-		}
-	}
-	newCap, err := s.queries.CreateCapability(ctx, req.ToParams())
-	if err != nil {
-		slog.Error("error creating capability: ", slog.String("error", err.Error()))
-		return db.Capability{}, errors.New("error creating capability")
-	}
-	return newCap, nil
-}
-
-func (s *postgresService) GetCapability(ctx context.Context, id int) (db.Capability, error) {
-	capability, err := s.queries.GetCapability(ctx, id)
-	if err != nil {
-		if errors.Is(err, pgx.ErrNoRows) {
-			return db.Capability{}, NotFoundError{
-				"Capability not found",
-			}
-		}
-		return db.Capability{}, err
-	}
-	return capability, nil
-}
-
-func (s *postgresService) GetCapabilitiesByProduct(ctx context.Context, id int) ([]db.GetCapabilitiesByProductRow, error) {
-	_, err := s.queries.GetProduct(ctx, id)
-	if err != nil {
-		if errors.Is(err, pgx.ErrNoRows) {
-			return nil, NotFoundError{
-				"Product not found",
-			}
-		}
-		return nil, err
-	}
-	capabilities, err := s.queries.GetCapabilitiesByProduct(ctx, id)
-	if err != nil {
-		return nil, err
-	}
-	if capabilities == nil {
-		capabilities = []db.GetCapabilitiesByProductRow{}
-	}
-	return capabilities, nil
-}
-
-func (s *postgresService) GetCapabilitiesByFlow(ctx context.Context, id int) ([]db.Capability, error) {
-	_, err := s.queries.GetFlow(ctx, id)
-	if err != nil {
-		if errors.Is(err, pgx.ErrNoRows) {
-			return nil, NotFoundError{
-				"Flow not found",
-			}
-		}
-		return nil, err
-	}
-	capabilities, err := s.queries.GetCapabilitiesByFlow(ctx, id)
-	if err != nil {
-		return nil, err
-	}
-	if capabilities == nil {
-		capabilities = []db.Capability{}
-	}
-	return capabilities, nil
-}