Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package releasetargets

import (
"context"

"workspace-engine/pkg/oapi"

"workspace-engine/pkg/db"

"github.com/google/uuid"
gocache "github.com/patrickmn/go-cache"
"go.opentelemetry.io/otel/attribute"
)

type GetJobsForReleaseTarget interface {
GetJobsForReleaseTarget(
ctx context.Context,
releaseTarget *oapi.ReleaseTarget,
) map[string]*oapi.Job
}
Comment on lines +15 to +20
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Error paths are currently indistinguishable from “no jobs.”

Line 51, Line 55, Line 59, and Line 67 return nil for parse/DB failures, but the interface (Line 15-20) cannot surface errors. That makes transient failures look like empty results, which can mis-evaluate policy decisions.

Proposed direction
 type GetJobsForReleaseTarget interface {
 	GetJobsForReleaseTarget(
 		ctx context.Context,
 		releaseTarget *oapi.ReleaseTarget,
-	) map[string]*oapi.Job
+	) (map[string]*oapi.Job, error)
 }

 func (s *PostgresGetJobsForReleaseTarget) GetJobsForReleaseTarget(
 	ctx context.Context,
 	releaseTarget *oapi.ReleaseTarget,
-) map[string]*oapi.Job {
+) (map[string]*oapi.Job, error) {
   ...
 	deploymentID, err := uuid.Parse(releaseTarget.DeploymentId)
 	if err != nil {
-		return nil
+		return nil, fmt.Errorf("parse deployment id: %w", err)
 	}
   ...
 	if err != nil {
-		return nil
+		return nil, fmt.Errorf("list jobs by release target: %w", err)
 	}
   ...
-	return jobs
+	return jobs, nil
 }

Also applies to: 49-68

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@apps/workspace-engine/pkg/store/releasetargets/get_jobs_for_release_target.go`
around lines 15 - 20, The current GetJobsForReleaseTarget interface and its
implementations hide parse/DB errors by returning nil maps (in
GetJobsForReleaseTarget implementations at the locations referenced), making
error paths indistinguishable from “no jobs”; change the GetJobsForReleaseTarget
signature to return (map[string]*oapi.Job, error), update every implementation
of GetJobsForReleaseTarget to return a non-nil error on parse/DB failures
(instead of nil), and propagate those errors to callers so callers can
distinguish transient failures from empty results; ensure to update any call
sites to handle the new error return and adjust tests accordingly.


var _ GetJobsForReleaseTarget = (*PostgresGetJobsForReleaseTarget)(nil)

type PostgresGetJobsForReleaseTarget struct {
cache *gocache.Cache
}

func NewGetJobsForReleaseTarget(opts ...Option) *PostgresGetJobsForReleaseTarget {
return &PostgresGetJobsForReleaseTarget{cache: buildCache(opts)}
}

func (s *PostgresGetJobsForReleaseTarget) GetJobsForReleaseTarget(
ctx context.Context,
releaseTarget *oapi.ReleaseTarget,
) map[string]*oapi.Job {
ctx, span := tracer.Start(ctx, "Store.GetJobsForReleaseTarget")
defer span.End()

span.SetAttributes(attribute.String("release_target.deployment_id", releaseTarget.DeploymentId))
span.SetAttributes(attribute.String("release_target.environment_id", releaseTarget.EnvironmentId))
span.SetAttributes(attribute.String("release_target.resource_id", releaseTarget.ResourceId))

if s.cache != nil {
if v, ok := s.cache.Get(releaseTarget.Key()); ok {
return v.(map[string]*oapi.Job)
}
}

deploymentID, err := uuid.Parse(releaseTarget.DeploymentId)
if err != nil {
return nil
}
environmentID, err := uuid.Parse(releaseTarget.EnvironmentId)
if err != nil {
return nil
}
resourceID, err := uuid.Parse(releaseTarget.ResourceId)
if err != nil {
return nil
}
rows, err := db.GetQueries(ctx).ListJobsByReleaseTarget(ctx, db.ListJobsByReleaseTargetParams{
DeploymentID: deploymentID,
EnvironmentID: environmentID,
ResourceID: resourceID,
})
if err != nil {
return nil
}

jobs := make(map[string]*oapi.Job, len(rows))
for _, row := range rows {
jobs[row.ID.String()] = db.ToOapiJob(db.ListJobsByReleaseIDRow(row))
}

if s.cache != nil {
s.cache.SetDefault(releaseTarget.Key(), jobs)
}

return jobs
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type releaseGetter = store.ReleaseGetter

type releaseTargetForDeploymentAndEnvironmentGetter = releasetargets.GetReleaseTargetsForDeploymentAndEnvironment
type releaseTargetForDeploymentGetter = releasetargets.GetReleaseTargetsForDeployment
type jobsForReleaseTargetGetter = releasetargets.GetJobsForReleaseTarget

type Getters interface {
environmentGetter
Expand Down Expand Up @@ -73,6 +74,7 @@ type PostgresGetters struct {
releaseGetter
releaseTargetForDeploymentAndEnvironmentGetter
releaseTargetForDeploymentGetter
jobsForReleaseTargetGetter

queries *db.Queries
}
Expand All @@ -81,13 +83,17 @@ func NewPostgresGetters(
queries *db.Queries,
rtForDep releasetargets.GetReleaseTargetsForDeployment,
rtForDepEnv releasetargets.GetReleaseTargetsForDeploymentAndEnvironment,
jobsForRT releasetargets.GetJobsForReleaseTarget,
) *PostgresGetters {
if rtForDep == nil {
rtForDep = releasetargets.NewGetReleaseTargetsForDeployment()
}
if rtForDepEnv == nil {
rtForDepEnv = releasetargets.NewGetReleaseTargetsForDeploymentAndEnvironment()
}
if jobsForRT == nil {
jobsForRT = releasetargets.NewGetJobsForReleaseTarget()
}
return &PostgresGetters{
queries: queries,
environmentGetter: store.NewPostgresEnvironmentGetter(queries),
Expand All @@ -96,6 +102,7 @@ func NewPostgresGetters(
releaseGetter: store.NewPostgresReleaseGetter(queries),
releaseTargetForDeploymentAndEnvironmentGetter: rtForDepEnv,
releaseTargetForDeploymentGetter: rtForDep,
jobsForReleaseTargetGetter: jobsForRT,
}
}

Expand Down Expand Up @@ -155,36 +162,6 @@ func (p *PostgresGetters) GetReleaseTargetsForEnvironment(
return targets, nil
}

func (p *PostgresGetters) GetJobsForReleaseTarget(
ctx context.Context,
releaseTarget *oapi.ReleaseTarget,
) map[string]*oapi.Job {
ctx, span := gettersTracer.Start(ctx, "GetJobsForReleaseTarget")
defer span.End()

span.SetAttributes(attribute.String("release_target.deployment_id", releaseTarget.DeploymentId))
span.SetAttributes(
attribute.String("release_target.environment_id", releaseTarget.EnvironmentId),
)
span.SetAttributes(attribute.String("release_target.resource_id", releaseTarget.ResourceId))

rows, err := p.queries.ListJobsByReleaseTarget(ctx, db.ListJobsByReleaseTargetParams{
DeploymentID: uuid.MustParse(releaseTarget.DeploymentId),
EnvironmentID: uuid.MustParse(releaseTarget.EnvironmentId),
ResourceID: uuid.MustParse(releaseTarget.ResourceId),
})
if err != nil {
return nil
}
span.SetAttributes(attribute.Int("jobs.count", len(rows)))

jobs := make(map[string]*oapi.Job, len(rows))
for _, row := range rows {
jobs[row.ID.String()] = db.ToOapiJob(db.ListJobsByReleaseIDRow(row))
}
return jobs
}

func (p *PostgresGetters) GetAllPolicies(
ctx context.Context,
workspaceID string,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ func NewPostgresGetters(
rtForDep releasetargets.GetReleaseTargetsForDeployment,
rtForDepEnv releasetargets.GetReleaseTargetsForDeploymentAndEnvironment,
policiesForRT policies.GetPoliciesForReleaseTarget,
jobsForRT releasetargets.GetJobsForReleaseTarget,
) *PostgresGetters {
return &PostgresGetters{
policiesForReleaseTargetGetter: policiesForRT,
Expand All @@ -61,6 +62,7 @@ func NewPostgresGetters(
queries,
rtForDep,
rtForDepEnv,
jobsForRT,
),
queries: queries,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import (
)

func TestPostgresGetters_GetReleaseTargetsForDeployment_InvalidUUID(t *testing.T) {
g := NewPostgresGetters(nil, nil, nil, nil)
g := NewPostgresGetters(nil, nil, nil, nil, nil)

_, err := g.GetReleaseTargetsForDeployment(context.Background(), "not-a-uuid")
require.Error(t, err)
assert.Contains(t, err.Error(), "parse deployment id")
}

func TestPostgresGetters_GetReleaseTargetsForDeployment_DoesNotPanic(t *testing.T) {
g := NewPostgresGetters(nil, nil, nil, nil)
g := NewPostgresGetters(nil, nil, nil, nil, nil)

assert.NotPanics(t, func() {
_, _ = g.GetReleaseTargetsForDeployment(context.Background(), "not-a-uuid")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ import (
"context"
"log/slog"

"github.com/charmbracelet/log"
"github.com/google/uuid"
"workspace-engine/pkg/db"
"workspace-engine/pkg/oapi"
"workspace-engine/pkg/store"
"workspace-engine/pkg/store/releasetargets"
)

type environmentGetter = store.EnvironmentGetter
type deploymentGetter = store.DeploymentGetter
type releaseGetter = store.ReleaseGetter
type resourceGetter = store.ResourceGetter
type jobsForReleaseTargetGetter = releasetargets.GetJobsForReleaseTarget

type Getters interface {
environmentGetter
Expand All @@ -32,13 +33,17 @@ type Getters interface {

var _ Getters = (*PostgresGetters)(nil)

func NewPostgresGetters(queries *db.Queries) *PostgresGetters {
func NewPostgresGetters(queries *db.Queries, jobsForRT releasetargets.GetJobsForReleaseTarget) *PostgresGetters {
if jobsForRT == nil {
jobsForRT = releasetargets.NewGetJobsForReleaseTarget()
}
return &PostgresGetters{
queries: queries,
environmentGetter: store.NewPostgresEnvironmentGetter(queries),
deploymentGetter: store.NewPostgresDeploymentGetter(queries),
releaseGetter: store.NewPostgresReleaseGetter(queries),
resourceGetter: store.NewPostgresResourceGetter(queries),
queries: queries,
environmentGetter: store.NewPostgresEnvironmentGetter(queries),
deploymentGetter: store.NewPostgresDeploymentGetter(queries),
releaseGetter: store.NewPostgresReleaseGetter(queries),
resourceGetter: store.NewPostgresResourceGetter(queries),
jobsForReleaseTargetGetter: jobsForRT,
}
}

Expand All @@ -47,72 +52,10 @@ type PostgresGetters struct {
deploymentGetter
releaseGetter
resourceGetter
jobsForReleaseTargetGetter
queries *db.Queries
}

func (p *PostgresGetters) GetJobsForReleaseTarget(
ctx context.Context,
releaseTarget *oapi.ReleaseTarget,
) map[string]*oapi.Job {
if releaseTarget == nil {
return nil
}
deploymentIDUUID, err := uuid.Parse(releaseTarget.DeploymentId)
if err != nil {
log.Error(
"failed to parse deployment id",
"deploymentID",
releaseTarget.DeploymentId,
"error",
err,
)
return nil
}
environmentIDUUID, err := uuid.Parse(releaseTarget.EnvironmentId)
if err != nil {
log.Error(
"failed to parse environment id",
"environmentID",
releaseTarget.EnvironmentId,
"error",
err,
)
return nil
}
resourceIDUUID, err := uuid.Parse(releaseTarget.ResourceId)
if err != nil {
log.Error(
"failed to parse resource id",
"resourceID",
releaseTarget.ResourceId,
"error",
err,
)
return nil
}
rows, err := p.queries.ListJobsByReleaseTarget(ctx, db.ListJobsByReleaseTargetParams{
DeploymentID: deploymentIDUUID,
EnvironmentID: environmentIDUUID,
ResourceID: resourceIDUUID,
})
if err != nil {
log.Error(
"failed to get jobs for release target",
"releaseTarget",
releaseTarget.Key(),
"error",
err,
)
return nil
}
jobs := make(map[string]*oapi.Job, len(rows))
for _, row := range rows {
job := db.ToOapiJob(db.ListJobsByReleaseIDRow(row))
jobs[job.Id] = job
}
return jobs
}

func (p *PostgresGetters) GetAllReleaseTargets(
ctx context.Context,
workspaceID string,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,10 @@ func (c *Controller) Process(ctx context.Context, item reconcile.Item) (reconcil
policiesForRT := policies.NewPostgresGetPoliciesForReleaseTarget(
policies.WithCache(cacheTTL),
)
getter = NewPostgresGetter(c.queries, rtForDep, rtForDepEnv, policiesForRT)
jobsForRT := releasetargets.NewGetJobsForReleaseTarget(
releasetargets.WithCache(cacheTTL),
)
getter = NewPostgresGetter(c.queries, rtForDep, rtForDepEnv, policiesForRT, jobsForRT)
}

exists, err := getter.ReleaseTargetExists(ctx, rt)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,15 @@ func NewPostgresGetter(
rtForDep releasetargets.GetReleaseTargetsForDeployment,
rtForDepEnv releasetargets.GetReleaseTargetsForDeploymentAndEnvironment,
policiesForRT policies.GetPoliciesForReleaseTarget,
jobsForRT releasetargets.GetJobsForReleaseTarget,
) *PostgresGetter {
return &PostgresGetter{
policiesGetter: policyeval.NewPostgresGetter(
queries,
rtForDep,
rtForDepEnv,
policiesForRT,
jobsForRT,
),
variableResolverGetter: variableresolver.NewPostgresGetter(queries),
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,17 @@ func NewPostgresGetter(
rtForDep releasetargets.GetReleaseTargetsForDeployment,
rtForDepEnv releasetargets.GetReleaseTargetsForDeploymentAndEnvironment,
policiesForRT policies.GetPoliciesForReleaseTarget,
jobsForRT releasetargets.GetJobsForReleaseTarget,
) Getter {
return &PostgresGetter{
gradualrolloutGetter: gradualrollout.NewPostgresGetters(
queries,
rtForDep,
rtForDepEnv,
policiesForRT,
jobsForRT,
),
versioncooldown: versioncooldown.NewPostgresGetters(queries),
versioncooldown: versioncooldown.NewPostgresGetters(queries, jobsForRT),
deploymentdependency: deploymentdependency.NewPostgresGetters(queries),
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ func (c *Controller) Process(ctx context.Context, item reconcile.Item) (reconcil
policiesForRT := policies.NewPostgresGetPoliciesForReleaseTarget(
policies.WithCache(cacheTTL),
)
getter = NewPostgresGetter(c.queries, rtForDep, rtForDepEnv, policiesForRT)
jobsForRT := releasetargets.NewGetJobsForReleaseTarget(
releasetargets.WithCache(cacheTTL),
)
getter = NewPostgresGetter(c.queries, rtForDep, rtForDepEnv, policiesForRT, jobsForRT)
}

_, err = Reconcile(ctx, getter, c.setter, versionID)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ func NewPostgresGetter(
rtForDep releasetargets.GetReleaseTargetsForDeployment,
rtForDepEnv releasetargets.GetReleaseTargetsForDeploymentAndEnvironment,
policiesForRT policies.GetPoliciesForReleaseTarget,
jobsForRT releasetargets.GetJobsForReleaseTarget,
) *PostgresGetter {
return &PostgresGetter{
policyEvalGetter: pevalgetters.NewPostgresGetter(
queries,
rtForDep,
rtForDepEnv,
policiesForRT,
jobsForRT,
),
}
}
Expand Down
Loading