Skip to content

chore: maybe init workspace from server #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 16, 2025
Merged

chore: maybe init workspace from server #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d256a36
init
adityachoudhari26 Oct 16, 2025
a62a126
fxi
adityachoudhari26 Oct 16, 2025
476ea9a
clean up logs
adityachoudhari26 Oct 16, 2025
58659da
noit
adityachoudhari26 Oct 16, 2025
abe401f
cleanup
adityachoudhari26 Oct 16, 2025
c114043
fix
adityachoudhari26 Oct 16, 2025
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
19 changes: 19 additions & 0 deletions apps/workspace-engine/pkg/db/workspaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,22 @@ func GetWorkspaceIDs(ctx context.Context) ([]string, error) {
}
return workspaceIDs, nil
}

const WORKSPACE_EXISTS_QUERY = `
SELECT EXISTS(SELECT 1 FROM workspace WHERE id = $1)
`

func WorkspaceExists(ctx context.Context, workspaceId string) (bool, error) {
db, err := GetDB(ctx)
if err != nil {
return false, err
}
defer db.Release()

var exists bool
err = db.QueryRow(ctx, WORKSPACE_EXISTS_QUERY, workspaceId).Scan(&exists)
if err != nil {
return false, err
}
return exists, nil
}
26 changes: 26 additions & 0 deletions apps/workspace-engine/pkg/db/workspaces_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,34 @@ package db

import (
"testing"

"github.com/google/uuid"
)

func TestDBWorkspaces_WorkspaceExists(t *testing.T) {
workspaceID, conn := setupTestWithWorkspace(t)
_ = conn // Avoid "declared but not used" error

// Test that the workspace exists
exists, err := WorkspaceExists(t.Context(), workspaceID)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !exists {
t.Fatalf("expected workspace %s to exist", workspaceID)
}

// Test that a non-existent workspace returns false
nonExistentID := uuid.New().String()
exists, err = WorkspaceExists(t.Context(), nonExistentID)
if err != nil {
t.Fatalf("expected no error for non-existent workspace, got %v", err)
}
if exists {
t.Fatalf("expected workspace %s to not exist, but it does", nonExistentID)
}
}

func TestDBWorkspaces_GetWorkspaceIDs(t *testing.T) {
// Create multiple workspaces
workspaceID1, conn1 := setupTestWithWorkspace(t)
Expand Down
20 changes: 9 additions & 11 deletions apps/workspace-engine/pkg/events/handler/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ func (el *EventListener) ListenAndRoute(ctx context.Context, msg *kafka.Message)
changeSet := changeset.NewChangeSet[any]()
if !wsExists {
ws = workspace.New(rawEvent.WorkspaceID)
if err := loadWorkspaceWithInitialState(ctx, ws); err != nil {
if err := workspace.PopulateWorkspaceWithInitialState(ctx, ws); err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "failed to load workspace")
log.Error("Failed to load workspace", "error", err, "workspaceID", rawEvent.WorkspaceID)
Expand All @@ -154,7 +154,14 @@ func (el *EventListener) ListenAndRoute(ctx context.Context, msg *kafka.Message)
}
ctx = changeset.WithChangeSet(ctx, changeSet)

err := handler(ctx, ws, rawEvent)
if err := handler(ctx, ws, rawEvent); err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "handler failed")
log.Error("Handler failed to process event",
"eventType", rawEvent.EventType,
"error", err)
return fmt.Errorf("handler failed to process event %s: %w", rawEvent.EventType, err)
}

releaseTargetChanges, err := ws.ReleaseManager().ProcessChanges(ctx, changeSet)
if err != nil {
Expand All @@ -173,15 +180,6 @@ func (el *EventListener) ListenAndRoute(ctx context.Context, msg *kafka.Message)
return fmt.Errorf("failed to flush changeset: %w", err)
}

if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "handler failed")
log.Error("Handler failed to process event",
"eventType", rawEvent.EventType,
"error", err)
return fmt.Errorf("handler failed to process event %s: %w", rawEvent.EventType, err)
}

span.SetStatus(codes.Ok, "event processed successfully")
log.Debug("Successfully processed event",
"eventType", rawEvent.EventType)
Expand Down
7 changes: 5 additions & 2 deletions apps/workspace-engine/pkg/server/openapi/deployments/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ import (
type Deployments struct{}

func (s *Deployments) GetDeploymentResources(c *gin.Context, workspaceId string, deploymentId string) {
ws := utils.GetWorkspace(c, workspaceId)
if ws == nil {
ws, err := utils.GetWorkspace(c, workspaceId)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": err.Error(),
})
return
}

Expand Down
7 changes: 5 additions & 2 deletions apps/workspace-engine/pkg/server/openapi/environments/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ import (
type Environments struct{}

func (s *Environments) GetEnvironmentResources(c *gin.Context, workspaceId string, environmentId string) {
ws := utils.GetWorkspace(c, workspaceId)
if ws == nil {
ws, err := utils.GetWorkspace(c, workspaceId)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": err.Error(),
})
return
}

Expand Down
8 changes: 4 additions & 4 deletions apps/workspace-engine/pkg/server/openapi/policies/policies.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ import (
type Policies struct{}

func (p *Policies) GetReleaseTargetsForPolicy(c *gin.Context, workspaceId oapi.WorkspaceId, policyId oapi.PolicyId) {
ws := utils.GetWorkspace(c, workspaceId)
if ws == nil {
c.JSON(http.StatusNotFound, gin.H{
"error": "Workspace not found",
ws, err := utils.GetWorkspace(c, workspaceId)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": "Failed to get workspace: " + err.Error(),
})
return
}
Comment on lines +15 to 21
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Apply the workspace not-found error handling pattern here.

As noted in my comment on utils.go lines 18-20, the current error handling returns 500 Internal Server Error for all GetWorkspace failures, including when a workspace doesn't exist in the database. Once utils.GetWorkspace is updated to return a sentinel ErrWorkspaceNotFound error, this handler should detect it and return 404 Not Found instead.

See the suggested fix in apps/workspace-engine/pkg/server/openapi/utils/utils.go at lines 18-20. After implementing the sentinel error pattern there, update this handler to distinguish between 404 and 500 cases.

🤖 Prompt for AI Agents 
In apps/workspace-engine/pkg/server/openapi/policies/policies.go around lines 15
to 21, the handler currently treats all errors from utils.GetWorkspace as 500;
update it to check for the sentinel utils.ErrWorkspaceNotFound and return
c.JSON(http.StatusNotFound, ...) when that error is returned, otherwise preserve
the existing InternalServerError behavior; ensure you perform a type/equality
check against utils.ErrWorkspaceNotFound (or errors.Is) and keep the existing
error message content for both branches.

Expand Down
16 changes: 8 additions & 8 deletions apps/workspace-engine/pkg/server/openapi/releasetargets/releasetargets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ type ReleaseTargets struct {
// EvaluateReleaseTarget implements oapi.ServerInterface.
func (s *ReleaseTargets) EvaluateReleaseTarget(c *gin.Context, workspaceId oapi.WorkspaceId) {
// Get workspace
ws := utils.GetWorkspace(c, workspaceId)
if ws == nil {
c.JSON(http.StatusNotFound, gin.H{
"error": "Workspace not found",
ws, err := utils.GetWorkspace(c, workspaceId)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": err.Error(),
})
return
}
Expand Down Expand Up @@ -69,10 +69,10 @@ func (s *ReleaseTargets) EvaluateReleaseTarget(c *gin.Context, workspaceId oapi.

// GetPoliciesForReleaseTarget implements oapi.ServerInterface.
func (s *ReleaseTargets) GetPoliciesForReleaseTarget(c *gin.Context, workspaceId oapi.WorkspaceId, releaseTargetId oapi.ReleaseTargetId) {
ws := utils.GetWorkspace(c, workspaceId)
if ws == nil {
c.JSON(http.StatusNotFound, gin.H{
"error": "Workspace not found",
ws, err := utils.GetWorkspace(c, workspaceId)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": "Failed to get workspace: " + err.Error(),
})
return
}
Expand Down
28 changes: 19 additions & 9 deletions apps/workspace-engine/pkg/server/openapi/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
package utils

import (
"net/http"
"fmt"
"workspace-engine/pkg/db"
"workspace-engine/pkg/workspace"

"github.com/gin-gonic/gin"
)

func GetWorkspace(c *gin.Context, workspaceId string) *workspace.Workspace {
ok := workspace.HasWorkspace(workspaceId)
if !ok {
c.JSON(http.StatusNotFound, gin.H{
"error": "Workspace not found",
})
return nil
func GetWorkspace(c *gin.Context, workspaceId string) (*workspace.Workspace, error) {
existsInDB, err := db.WorkspaceExists(c.Request.Context(), workspaceId)
if err != nil {
return nil, err
}
if !existsInDB {
return nil, fmt.Errorf("workspace %s not found in database", workspaceId)
}

if workspace.Exists(workspaceId) {
return workspace.GetWorkspace(workspaceId), nil
}

return workspace.GetWorkspace(workspaceId)
ws := workspace.New(workspaceId)
if err := workspace.PopulateWorkspaceWithInitialState(c.Request.Context(), ws); err != nil {
return nil, fmt.Errorf("failed to populate workspace with initial state: %w", err)
}
workspace.Set(workspaceId, ws)
return ws, nil
}
5 changes: 2 additions & 3 deletions ...ce-engine/pkg/events/handler/workspace.go → ...ngine/pkg/workspace/populate_workspace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package handler
package workspace

import (
"context"
"workspace-engine/pkg/db"
"workspace-engine/pkg/workspace"
)

func loadWorkspaceWithInitialState(ctx context.Context, ws *workspace.Workspace) error {
func PopulateWorkspaceWithInitialState(ctx context.Context, ws *Workspace) error {
initialWorkspaceState, err := db.LoadWorkspace(ctx, ws.ID)
if err != nil {
return err
Expand Down
Loading