refactor: move codegenned sql queries into internal packages of each …

…dal (#2567) The codegenned types are an implementation detail and shouldn't be leaked out of their respective dal package. For convenience though, some of the sql types are just type mapped to the new package.
TBD54566975 · Sep 1, 2024 · b849d95 · b849d95
1 parent 37aed73
commit b849d95
Show file tree

Hide file tree

Showing 31 changed files with 130 additions and 91 deletions.
diff --git a/backend/controller/cronjobs/cronjobs.go b/backend/controller/cronjobs/cronjobs.go
@@ -9,7 +9,6 @@ import (
 	"github.com/benbjohnson/clock"
 
 	"github.com/TBD54566975/ftl/backend/controller/cronjobs/dal"
-	cronsql "github.com/TBD54566975/ftl/backend/controller/cronjobs/sql"
 	parentdal "github.com/TBD54566975/ftl/backend/controller/dal"
 	schemapb "github.com/TBD54566975/ftl/backend/protos/xyz/block/ftl/v1/schema"
 	"github.com/TBD54566975/ftl/backend/schema"
@@ -175,7 +174,7 @@ func (s *Service) scheduleCronJob(ctx context.Context, tx *dal.DAL, job model.Cr
 
 	logger.Tracef("Scheduling cron job %q async_call execution at %s", job.Key, nextAttemptForJob)
 	origin := &parentdal.AsyncOriginCron{CronJobKey: job.Key}
-	id, err := tx.CreateAsyncCall(ctx, cronsql.CreateAsyncCallParams{
+	id, err := tx.CreateAsyncCall(ctx, dal.CreateAsyncCallParams{
 		ScheduledAt: nextAttemptForJob,
 		Verb:        schema.RefKey{Module: job.Verb.Module, Name: job.Verb.Name},
 		Origin:      origin.String(),
@@ -189,7 +188,7 @@ func (s *Service) scheduleCronJob(ctx context.Context, tx *dal.DAL, job model.Cr
 		return fmt.Errorf("failed to calculate future execution for cron job %q with schedule %q: %w", job.Key, job.Schedule, err)
 	}
 	logger.Tracef("Updating cron job %q with last attempt at %s and next attempt at %s", job.Key, nextAttemptForJob, futureAttemptForJob)
-	err = tx.UpdateCronJobExecution(ctx, cronsql.UpdateCronJobExecutionParams{
+	err = tx.UpdateCronJobExecution(ctx, dal.UpdateCronJobExecutionParams{
 		LastAsyncCallID: id,
 		LastExecution:   nextAttemptForJob,
 		NextExecution:   futureAttemptForJob,

diff --git a/backend/controller/cronjobs/dal/dal.go b/backend/controller/cronjobs/dal/dal.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/alecthomas/types/optional"
 
-	"github.com/TBD54566975/ftl/backend/controller/cronjobs/sql"
+	"github.com/TBD54566975/ftl/backend/controller/cronjobs/dal/internal/sql"
 	"github.com/TBD54566975/ftl/backend/controller/observability"
 	"github.com/TBD54566975/ftl/backend/libdal"
 	"github.com/TBD54566975/ftl/backend/schema"
@@ -41,9 +41,11 @@ func cronJobFromRow(c sql.CronJob, d sql.Deployment) model.CronJob {
 	}
 }
 
+type CreateAsyncCallParams sql.CreateAsyncCallParams
+
 // CreateAsyncCall creates an async_call row and returns its id
-func (d *DAL) CreateAsyncCall(ctx context.Context, params sql.CreateAsyncCallParams) (int64, error) {
-	id, err := d.db.CreateAsyncCall(ctx, params)
+func (d *DAL) CreateAsyncCall(ctx context.Context, params CreateAsyncCallParams) (int64, error) {
+	id, err := d.db.CreateAsyncCall(ctx, sql.CreateAsyncCallParams(params))
 	if err != nil {
 		return 0, fmt.Errorf("failed to create async call: %w", libdal.TranslatePGError(err))
 	}
@@ -87,10 +89,12 @@ func (d *DAL) IsCronJobPending(ctx context.Context, key model.CronJobKey, startT
 	return pending, nil
 }
 
+type UpdateCronJobExecutionParams sql.UpdateCronJobExecutionParams
+
 // UpdateCronJobExecution updates the last_async_call_id, last_execution, and next_execution of
 // the cron job given by the provided key
-func (d *DAL) UpdateCronJobExecution(ctx context.Context, params sql.UpdateCronJobExecutionParams) error {
-	err := d.db.UpdateCronJobExecution(ctx, params)
+func (d *DAL) UpdateCronJobExecution(ctx context.Context, params UpdateCronJobExecutionParams) error {
+	err := d.db.UpdateCronJobExecution(ctx, sql.UpdateCronJobExecutionParams(params))
 	if err != nil {
 		return fmt.Errorf("failed to update cron job %q: %w", params.Key, libdal.TranslatePGError(err))
 	}

diff --git a/...troller/cronjobs/sql/async_queries.sql.go → ...obs/dal/internal/sql/async_queries.sql.go b/...troller/cronjobs/sql/async_queries.sql.go → ...obs/dal/internal/sql/async_queries.sql.go
diff --git a/backend/controller/cronjobs/sql/db.go → ...ontroller/cronjobs/dal/internal/sql/db.go b/backend/controller/cronjobs/sql/db.go → ...ontroller/cronjobs/dal/internal/sql/db.go
diff --git a/backend/controller/cronjobs/sql/models.go → ...oller/cronjobs/dal/internal/sql/models.go b/backend/controller/cronjobs/sql/models.go → ...oller/cronjobs/dal/internal/sql/models.go
diff --git a/backend/controller/cronjobs/sql/querier.go → ...ller/cronjobs/dal/internal/sql/querier.go b/backend/controller/cronjobs/sql/querier.go → ...ller/cronjobs/dal/internal/sql/querier.go
diff --git a/backend/controller/cronjobs/sql/queries.sql → ...ler/cronjobs/dal/internal/sql/queries.sql b/backend/controller/cronjobs/sql/queries.sql → ...ler/cronjobs/dal/internal/sql/queries.sql
diff --git a/...nd/controller/cronjobs/sql/queries.sql.go → .../cronjobs/dal/internal/sql/queries.sql.go b/...nd/controller/cronjobs/sql/queries.sql.go → .../cronjobs/dal/internal/sql/queries.sql.go
diff --git a/backend/controller/cronjobs/sql/types.go → ...roller/cronjobs/dal/internal/sql/types.go b/backend/controller/cronjobs/sql/types.go → ...roller/cronjobs/dal/internal/sql/types.go
diff --git a/backend/controller/dal/async_calls.go b/backend/controller/dal/async_calls.go
@@ -12,8 +12,8 @@ import (
 	"github.com/alecthomas/types/either"
 	"github.com/alecthomas/types/optional"
 
+	"github.com/TBD54566975/ftl/backend/controller/dal/internal/sql"
 	leasedal "github.com/TBD54566975/ftl/backend/controller/leases/dal"
-	"github.com/TBD54566975/ftl/backend/controller/sql"
 	"github.com/TBD54566975/ftl/backend/controller/sql/sqltypes"
 	"github.com/TBD54566975/ftl/backend/libdal"
 	"github.com/TBD54566975/ftl/backend/schema"