@nakedev/go-scaffold 0.5.5 → 0.8.0

package/templates/generate/module/hexagonal/adapters/inbound/http/handler.go.hbs

@@ -7,6 +7,7 @@ import (
 
 	"{{goModule}}/internal/app/{{modulePath}}/application"
 	"{{goModule}}/internal/app/{{modulePath}}/domain"
+	"{{goModule}}/internal/app/{{modulePath}}/ports"
 	"{{goModule}}/internal/shared/apperror"
 	"{{goModule}}/internal/shared/httpx"
 {{#if auth}}	"{{goModule}}/internal/shared/middleware"
@@ -107,10 +108,14 @@ func (h *Handler) create(c *gin.Context) {
 
 func (h *Handler) list(c *gin.Context) {
 	p := pagination.Parse(c)
+	// One struct all the way down, so this module's own filters are read off
+	// the query string here and added as fields on ports.ListFilter — never as
+	// extra arguments on the three signatures below.
+	filter := ports.ListFilter{Search: p.Search, Limit: p.Limit, Offset: p.Offset}
 {{#if cqrs}}
-	items, err := h.queries.List(c.Request.Context(), p.Limit, p.Offset)
+	items, total, err := h.queries.List(c.Request.Context(), filter)
 {{else}}
-	items, err := h.svc.List(c.Request.Context(), p.Limit, p.Offset)
+	items, total, err := h.svc.List(c.Request.Context(), filter)
 {{/if}}
 	if err != nil {
 		c.Error(appError(err))
@@ -120,7 +125,7 @@ func (h *Handler) list(c *gin.Context) {
 	for i := range items {
 		out[i] = toResponse(application.ToResponse(&items[i]))
 	}
-	c.JSON(http.StatusOK, p.Response(out))
+	c.JSON(http.StatusOK, p.ResponseWithTotal(out, total))
 }
 
 func (h *Handler) get(c *gin.Context) {

package/templates/generate/module/hexagonal/adapters/outbound/postgres/repository.go.hbs

@@ -6,6 +6,7 @@ import (
 
 	"{{goModule}}/internal/app/{{modulePath}}/domain"
 	"{{goModule}}/internal/app/{{modulePath}}/ports"
+	"{{goModule}}/internal/shared/dbq"
 	"{{goModule}}/internal/shared/dberr"
 	"{{goModule}}/internal/shared/tx"
 
@@ -30,16 +31,38 @@ func (r *Repository) Create(ctx context.Context, m *domain.{{pascalName}}) error
 	return nil
 }
 
-func (r *Repository) FindAll(ctx context.Context, limit, offset int) ([]domain.{{pascalName}}, error) {
+// FindAll answers one page of the filter and how many rows it matched
+// altogether. Two queries, because a count over a LIMITed query would only
+// ever count the page.
+func (r *Repository) FindAll(ctx context.Context, filter ports.ListFilter) ([]domain.{{pascalName}}, int64, error) {
+	// A closure rather than one *gorm.DB reused twice: conditions accumulate
+	// on the value, so the count would silently inherit the page's LIMIT.
+	matching := func() *gorm.DB {
+		q := tx.From(ctx, r.db).WithContext(ctx).Model(&{{pascalName}}Model{})
+		// TODO: name the columns this list is searched by. dbq.Search is a
+		// no-op until it has at least one, so ?q= is accepted and ignored
+		// until then. Add this module's own filters beside it.
+		q = dbq.Search(q, filter.Search /*, "name", "code" */)
+		return q
+	}
+
+	var total int64
+	if err := matching().Count(&total).Error; err != nil {
+		return nil, 0, mapDatabaseError(err)
+	}
+
 	var rows []{{pascalName}}Model
-	if err := tx.From(ctx, r.db).WithContext(ctx).Order("id desc").Limit(limit).Offset(offset).Find(&rows).Error; err != nil {
-		return nil, mapDatabaseError(err)
+	// created_at orders it, id breaks the ties: without the tiebreaker two
+	// rows written in the same instant can swap between page 1 and page 2,
+	// showing one twice and hiding the other.
+	if err := matching().Order("created_at desc, id").Limit(filter.Limit).Offset(filter.Offset).Find(&rows).Error; err != nil {
+		return nil, 0, mapDatabaseError(err)
 	}
 	items := make([]domain.{{pascalName}}, len(rows))
 	for i := range rows {
 		items[i] = *toDomain(&rows[i])
 	}
-	return items, nil
+	return items, total, nil
 }
 
 func (r *Repository) FindByID(ctx context.Context, id uuid.UUID) (*domain.{{pascalName}}, error) {

package/templates/generate/module/hexagonal/application/cqrs_test.go.hbs

@@ -15,7 +15,7 @@ import (
 // which side of the CQRS boundary was called.
 type repositoryStub struct {
 	createFn   func(context.Context, *domain.{{pascalName}}) error
-	findAllFn  func(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	findAllFn  func(context.Context, ports.ListFilter) ([]domain.{{pascalName}}, int64, error)
 	findByIDFn func(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	updateFn   func(context.Context, *domain.{{pascalName}}) error
 	deleteFn   func(context.Context, uuid.UUID) error
@@ -28,11 +28,11 @@ func (s *repositoryStub) Create(ctx context.Context, m *domain.{{pascalName}}) e
 	}
 	return s.createFn(ctx, m)
 }
-func (s *repositoryStub) FindAll(ctx context.Context, limit, offset int) ([]domain.{{pascalName}}, error) {
+func (s *repositoryStub) FindAll(ctx context.Context, filter ports.ListFilter) ([]domain.{{pascalName}}, int64, error) {
 	if s.findAllFn == nil {
 		panic("unexpected repository.FindAll call")
 	}
-	return s.findAllFn(ctx, limit, offset)
+	return s.findAllFn(ctx, filter)
 }
 func (s *repositoryStub) FindByID(ctx context.Context, id uuid.UUID) (*domain.{{pascalName}}, error) {
 	if s.findByIDFn == nil {

package/templates/generate/module/hexagonal/application/queries.crud.go.hbs

@@ -9,7 +9,7 @@ import (
 )
 
 type QueryPort interface {
-	List(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	List(context.Context, ports.ListFilter) ([]domain.{{pascalName}}, int64, error)
 	Get(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	// go-scaffold:query-interface
 }
@@ -22,8 +22,8 @@ func NewQueryHandler(repo ports.QueryRepository) *QueryHandler {
 	return &QueryHandler{repo: repo}
 }
 
-func (h *QueryHandler) List(ctx context.Context, limit, offset int) ([]domain.{{pascalName}}, error) {
-	return h.repo.FindAll(ctx, limit, offset)
+func (h *QueryHandler) List(ctx context.Context, filter ports.ListFilter) ([]domain.{{pascalName}}, int64, error) {
+	return h.repo.FindAll(ctx, filter)
 }
 
 func (h *QueryHandler) Get(ctx context.Context, id uuid.UUID) (*domain.{{pascalName}}, error) {

package/templates/generate/module/hexagonal/application/service.crud.go.hbs

@@ -13,7 +13,7 @@ import (
 
 type ServicePort interface {
 	Create(context.Context, CreateInput) (*domain.{{pascalName}}, error)
-	List(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	List(context.Context, ports.ListFilter) ([]domain.{{pascalName}}, int64, error)
 	Get(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	Update(context.Context, uuid.UUID, UpdateInput) (*domain.{{pascalName}}, error)
 	Delete(context.Context, uuid.UUID) error
@@ -38,8 +38,8 @@ func (s *Service) Create(ctx context.Context, in CreateInput) (*domain.{{pascalN
 	return m, nil
 }
 
-func (s *Service) List(ctx context.Context, limit, offset int) ([]domain.{{pascalName}}, error) {
-	return s.repo.FindAll(ctx, limit, offset)
+func (s *Service) List(ctx context.Context, filter ports.ListFilter) ([]domain.{{pascalName}}, int64, error) {
+	return s.repo.FindAll(ctx, filter)
 }
 
 func (s *Service) Get(ctx context.Context, id uuid.UUID) (*domain.{{pascalName}}, error) {

package/templates/generate/module/hexagonal/application/service_test.go.hbs

@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"{{goModule}}/internal/app/{{modulePath}}/domain"
+	"{{goModule}}/internal/app/{{modulePath}}/ports"
 
 	"github.com/google/uuid"
 )
@@ -15,7 +16,7 @@ import (
 // orchestration.
 type repositoryStub struct {
 	createFn   func(context.Context, *domain.{{pascalName}}) error
-	findAllFn  func(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	findAllFn  func(context.Context, ports.ListFilter) ([]domain.{{pascalName}}, int64, error)
 	findByIDFn func(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	updateFn   func(context.Context, *domain.{{pascalName}}) error
 	deleteFn   func(context.Context, uuid.UUID) error
@@ -28,11 +29,11 @@ func (s *repositoryStub) Create(ctx context.Context, m *domain.{{pascalName}}) e
 	}
 	return s.createFn(ctx, m)
 }
-func (s *repositoryStub) FindAll(ctx context.Context, limit, offset int) ([]domain.{{pascalName}}, error) {
+func (s *repositoryStub) FindAll(ctx context.Context, filter ports.ListFilter) ([]domain.{{pascalName}}, int64, error) {
 	if s.findAllFn == nil {
 		panic("unexpected repository.FindAll call")
 	}
-	return s.findAllFn(ctx, limit, offset)
+	return s.findAllFn(ctx, filter)
 }
 func (s *repositoryStub) FindByID(ctx context.Context, id uuid.UUID) (*domain.{{pascalName}}, error) {
 	if s.findByIDFn == nil {

package/templates/generate/module/hexagonal/ports/repository.go.hbs

@@ -11,10 +11,26 @@ import (
 	"github.com/google/uuid"
 )
 
+// ListFilter is the whole question the list endpoint asks. The zero value is
+// "the first page of everything", so a caller only sets what it narrows by.
+//
+// Put this module's own filters here as fields rather than as arguments: one
+// struct travels handler -> application -> repository, so adding a filter
+// later is a field and not a fourth parameter on three signatures.
+type ListFilter struct {
+	// Search is ?q= as shared/pagination parsed it, empty when the caller
+	// sent none.
+	Search string
+	Limit  int
+	Offset int
+}
+
 // Repository is the complete persistence port for service-style modules.
 type Repository interface {
 	Create(context.Context, *domain.{{pascalName}}) error
-	FindAll(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	// FindAll answers one page and the total the filter matched, which is what
+	// a client needs to draw "page 3 of 12".
+	FindAll(context.Context, ListFilter) ([]domain.{{pascalName}}, int64, error)
 	FindByID(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	Update(context.Context, *domain.{{pascalName}}) error
 	Delete(context.Context, uuid.UUID) error
@@ -32,7 +48,7 @@ type CommandRepository interface {
 }
 
 type QueryRepository interface {
-	FindAll(context.Context, int, int) ([]domain.{{pascalName}}, error)
+	FindAll(context.Context, ListFilter) ([]domain.{{pascalName}}, int64, error)
 	FindByID(context.Context, uuid.UUID) (*domain.{{pascalName}}, error)
 	// go-scaffold:query-repository-interface
 }