Skip to content

chore: init workflow manager #759

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
adityachoudhari26 merged 12 commits into from
Jan 28, 2026
Merged

chore: init workflow manager #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f81baab
chore: init workflow manager
adityachoudhari26 Jan 27, 2026
5c31191
more init
adityachoudhari26 Jan 27, 2026
1c19027
refactor: update workflow schemas and models
jsbroks Jan 28, 2026
60383de
refactor: clean up template functions and tests
jsbroks Jan 28, 2026
8d8b9a1
job agents
jsbroks Jan 28, 2026
833a520
add capbilities
jsbroks Jan 28, 2026
0ed372f
add cap check
jsbroks Jan 28, 2026
f7b078f
fmt
jsbroks Jan 28, 2026
474d960
tfe
jsbroks Jan 28, 2026
d68c434
Merge branch 'main' of github.com:sizzldev/ctrlplane into init-workfl…
adityachoudhari26 Jan 28, 2026
2c16dee
cleanup
adityachoudhari26 Jan 28, 2026
cb0df85
fix package
adityachoudhari26 Jan 28, 2026
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
72 changes: 48 additions & 24 deletions apps/workspace-engine/oapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,21 +702,21 @@
"status": {
"$ref": "#/components/schemas/JobStatus"
},
"taskId": {
"type": "string"
},
"traceToken": {
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"workflowStepId": {
"type": "string"
}
},
"required": [
"id",
"releaseId",
"taskId",
"workflowStepId",
"jobAgentId",
"jobAgentConfig",
"status",
Expand Down Expand Up @@ -807,9 +807,9 @@
"releaseId",
"startedAt",
"status",
"taskId",
"traceToken",
"updatedAt"
"updatedAt",
"workflowStepId"
],
"type": "string"
},
Expand Down Expand Up @@ -1835,6 +1835,24 @@
],
"type": "object"
},
"TestRunnerJobAgentConfig": {
"properties": {
"delaySeconds": {
"description": "Delay in seconds before resolving the job.",
"format": "int",
"type": "integer"
},
"message": {
"description": "Optional message to include in the job output.",
"type": "string"
},
"status": {
"description": "Final status to set (e.g. \"successful\", \"failure\").",
"type": "string"
}
},
"type": "object"
},
"UserApprovalRecord": {
"properties": {
"createdAt": {
Expand Down Expand Up @@ -2097,6 +2115,22 @@
}
]
},
"WorkflowJobAgentConfig": {
"properties": {
"config": {
"additionalProperties": true,
"type": "object"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"config"
],
"type": "object"
},
"WorkflowNumberInput": {
"properties": {
"default": {
Expand Down Expand Up @@ -2124,17 +2158,20 @@
"id": {
"type": "string"
},
"workflowId": {
"type": "string"
"index": {
"type": "integer"
},
"workflowStepTemplateId": {
"jobAgent": {
"$ref": "#/components/schemas/WorkflowJobAgentConfig"
},
"workflowId": {
"type": "string"
}
},
"required": [
"id",
"workflowId",
"workflowStepTemplateId"
"index"
],
"type": "object"
},
Expand All @@ -2144,20 +2181,7 @@
"type": "string"
},
"jobAgent": {
"properties": {
"config": {
"additionalProperties": true,
"type": "object"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"config"
],
"type": "object"
"$ref": "#/components/schemas/WorkflowJobAgentConfig"
},
"name": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions apps/workspace-engine/oapi/spec/schemas/jobs.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ local Job = {
required: [
'id',
'releaseId',
'taskId',
'workflowStepId',
'jobAgentId',
'jobAgentConfig',
'status',
Expand All @@ -16,7 +16,7 @@ local Job = {
properties: {
id: { type: 'string' },
releaseId: { type: 'string' },
taskId: { type: 'string' },
workflowStepId: { type: 'string' },
jobAgentId: { type: 'string' },
jobAgentConfig: openapi.schemaRef('JobAgentConfig'),
externalId: { type: 'string' },
Expand Down
23 changes: 13 additions & 10 deletions apps/workspace-engine/oapi/spec/schemas/workflows.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
local openapi = import '../lib/openapi.libsonnet';

{
WorkflowJobAgentConfig: {
type: 'object',
required: ['id', 'config'],
properties: {
id: { type: 'string' },
config: { type: 'object', additionalProperties: true },
},
},

WorkflowStepTemplate: {
type: 'object',
required: ['id', 'name', 'jobAgent'],
properties: {
name: { type: 'string' },
id: { type: 'string' },
jobAgent: {
type: 'object',
required: ['id', 'config'],
properties: {
id: { type: 'string' },
config: { type: 'object', additionalProperties: true },
},
},
jobAgent: openapi.schemaRef('WorkflowJobAgentConfig'),
},
},

Expand Down Expand Up @@ -88,11 +90,12 @@ local openapi = import '../lib/openapi.libsonnet';

WorkflowStep: {
type: 'object',
required: ['id', 'workflowId', 'workflowStepTemplateId'],
required: ['id', 'workflowId', 'index'],
properties: {
id: { type: 'string' },
index: { type: 'integer' },
workflowId: { type: 'string' },
workflowStepTemplateId: { type: 'string' },
jobAgent: openapi.schemaRef('WorkflowJobAgentConfig'),
},
},
}
11 changes: 0 additions & 11 deletions apps/workspace-engine/pkg/oapi/job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,6 @@ func (j *Job) GetTerraformCloudJobAgentConfig() (*TerraformCloudJobAgentConfig,
return &cfg, nil
}

// TestRunnerJobAgentConfig defines config for test-runner job agent.
type TestRunnerJobAgentConfig struct {
Type string `json:"type,omitempty"`
DelaySeconds *int `json:"delaySeconds,omitempty"`
Status *string `json:"status,omitempty"`
Message *string `json:"message,omitempty"`
}

func (j *Job) GetTestRunnerJobAgentConfig() (*TestRunnerJobAgentConfig, error) {
cfgJson, err := json.Marshal(j.JobAgentConfig)
if err != nil {
Expand All @@ -162,8 +154,5 @@ func (j *Job) GetTestRunnerJobAgentConfig() (*TestRunnerJobAgentConfig, error) {
if err := json.Unmarshal(cfgJson, &cfg); err != nil {
return nil, fmt.Errorf("failed to unmarshal job agent config: %w", err)
}
if cfg.Type != "test-runner" {
return nil, fmt.Errorf("config type is not test-runner")
}
return &cfg, nil
}
38 changes: 27 additions & 11 deletions apps/workspace-engine/pkg/oapi/oapi.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions apps/workspace-engine/pkg/oapi/workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package oapi

func (w *Workflow) Map() map[string]interface{} {
return structToMap(w)
}
32 changes: 32 additions & 0 deletions apps/workspace-engine/pkg/workspace/jobagents/argo/argoapp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package argo

import (
"context"
"workspace-engine/pkg/workspace/jobagents/types"
"workspace-engine/pkg/workspace/store"
)

var _ types.Dispatchable = &ArgoApplication{}

type ArgoApplication struct {
store *store.Store
}

func NewArgoApplication(store *store.Store) *ArgoApplication {
return &ArgoApplication{store: store}
}

func (a *ArgoApplication) Type() string {
return "argo-application"
}

func (a *ArgoApplication) Supports() types.Capabilities {
return types.Capabilities{
Workflows: true,
Deployments: false,
}
}

func (a *ArgoApplication) Dispatch(ctx context.Context, context types.RenderContext) error {
panic("unimplemented")
Comment on lines +30 to +31
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Jan 28, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Avoid panic in Dispatch; return a typed error instead.

This dispatcher is registered by default; a panic will crash the workspace engine if the Argo agent is invoked. Return a descriptive error until implemented.

🐛 Proposed fix 
 import (
 	"context"
+	"errors"
 	"workspace-engine/pkg/workspace/jobagents/types"
 	"workspace-engine/pkg/workspace/store"
 )
@@
 func (a *ArgoApplication) Dispatch(ctx context.Context, context types.RenderContext) error {
-	panic("unimplemented")
+	return errors.New("argo-application dispatch not implemented")
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
func (a *ArgoApplication) Dispatch(ctx context.Context, context types.RenderContext) error {
panic("unimplemented")
func (a *ArgoApplication) Dispatch(ctx context.Context, context types.RenderContext) error {
return errors.New("argo-application dispatch not implemented")
}
🤖 Prompt for AI Agents 
In `@apps/workspace-engine/pkg/workspace/jobagents/argo/argoapp.go` around lines
30 - 31, Replace the panic in ArgoApplication.Dispatch with a returned error so
the workspace engine doesn't crash when the Argo agent is invoked; in the method
ArgoApplication.Dispatch(ctx context.Context, context types.RenderContext)
return a descriptive, typed error (e.g., errors.New or fmt.Errorf) such as
"ArgoApplication.Dispatch not implemented" or a package-level sentinel error,
ensuring callers can handle it without process termination.

}
33 changes: 33 additions & 0 deletions apps/workspace-engine/pkg/workspace/jobagents/github/githubaction.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package github

import (
"context"
"workspace-engine/pkg/workspace/jobagents/types"
"workspace-engine/pkg/workspace/store"
)

var _ types.Dispatchable = &GithubAction{}

type GithubAction struct {
store *store.Store
}

func NewGithubAction(store *store.Store) *GithubAction {
return &GithubAction{store: store}
}

func (a *GithubAction) Type() string {
return "github-action"
}

func (a *GithubAction) Supports() types.Capabilities {
return types.Capabilities{
Workflows: true,
Deployments: false,
}
}

// Dispatch implements types.Dispatchable.
func (a *GithubAction) Dispatch(ctx context.Context, context types.RenderContext) error {
panic("unimplemented")
Comment on lines +30 to +32
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Jan 28, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Avoid panic in Dispatch; return an error until implemented.

A panic here will crash the process whenever the GitHub agent is selected. Prefer a descriptive error.

🐛 Proposed fix 
 import (
 	"context"
+	"errors"
 	"workspace-engine/pkg/workspace/jobagents/types"
 	"workspace-engine/pkg/workspace/store"
 )
@@
 func (a *GithubAction) Dispatch(ctx context.Context, context types.RenderContext) error {
-	panic("unimplemented")
+	return errors.New("github-action dispatch not implemented")
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Dispatch implements types.Dispatchable.
func (a *GithubAction) Dispatch(ctx context.Context, context types.RenderContext) error {
panic("unimplemented")
// Dispatch implements types.Dispatchable.
func (a *GithubAction) Dispatch(ctx context.Context, context types.RenderContext) error {
return errors.New("github-action dispatch not implemented")
}
🤖 Prompt for AI Agents 
In `@apps/workspace-engine/pkg/workspace/jobagents/github/githubaction.go` around
lines 30 - 32, The Dispatch method on GithubAction currently panics; replace the
panic with returning a descriptive error instead (e.g., using fmt.Errorf or
errors.New) so callers receive a clear failure rather than crashing; update the
GithubAction.Dispatch(ctx context.Context, context types.RenderContext)
implementation to return an error such as "github action dispatch not
implemented" and ensure the method signature and imports reflect the chosen
error constructor.

}
Loading
Loading