chore: db migration for adding slug to workflow (#1136)

Author: adityachoudhari26

apps/api/openapi/openapi.json

@@ -326,6 +326,10 @@
                },
                "name": {
                   "type": "string"
+               },
+               "slug": {
+                  "description": "URL-safe identifier unique within the workspace. Derived from name if omitted.",
+                  "type": "string"
                }
             },
             "required": [
@@ -2679,6 +2683,10 @@
                },
                "name": {
                   "type": "string"
+               },
+               "slug": {
+                  "description": "URL-safe identifier unique within the workspace.",
+                  "type": "string"
                }
             },
             "required": [
@@ -3417,11 +3425,15 @@
                },
                "name": {
                   "type": "string"
+               },
+               "slug": {
+                  "type": "string"
                }
             },
             "required": [
                "id",
                "name",
+               "slug",
                "inputs",
                "jobAgents"
             ],

apps/api/openapi/schemas/workflows.jsonnet

@@ -115,6 +115,7 @@ local openapi = import '../lib/openapi.libsonnet';
     required: ['name', 'inputs', 'jobAgents'],
     properties: {
       name: { type: 'string' },
+      slug: { type: 'string', description: 'URL-safe identifier unique within the workspace. Derived from name if omitted.' },
       inputs: {
         type: 'array',
         items: openapi.schemaRef('WorkflowInput'),
@@ -131,6 +132,7 @@ local openapi = import '../lib/openapi.libsonnet';
     required: ['name', 'inputs', 'jobAgents'],
     properties: {
       name: { type: 'string' },
+      slug: { type: 'string', description: 'URL-safe identifier unique within the workspace.' },
       inputs: {
         type: 'array',
         items: openapi.schemaRef('WorkflowInput'),
@@ -144,10 +146,11 @@ local openapi = import '../lib/openapi.libsonnet';
 
   Workflow: {
     type: 'object',
-    required: ['id', 'name', 'inputs', 'jobAgents'],
+    required: ['id', 'name', 'slug', 'inputs', 'jobAgents'],
     properties: {
       id: { type: 'string' },
       name: { type: 'string' },
+      slug: { type: 'string' },
       inputs: {
         type: 'array',
         items: openapi.schemaRef('WorkflowInput'),

apps/api/src/routes/v1/workspaces/workflows.ts

@@ -7,6 +7,12 @@ import { db } from "@ctrlplane/db/client";
 import * as schema from "@ctrlplane/db/schema";
 import { getClientFor } from "@ctrlplane/workspace-engine-sdk";
 
+const slugifyWorkflowName = (name: string) =>
+  name
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+
 const listWorkflows: AsyncTypedHandler<
   "/v1/workspaces/{workspaceId}/workflows",
   "get"
@@ -29,9 +35,10 @@ const listWorkflows: AsyncTypedHandler<
     .limit(limit)
     .offset(offset);
 
-  const items = rows.map(({ id, name, inputs, jobAgents }) => ({
+  const items = rows.map(({ id, name, slug, inputs, jobAgents }) => ({
     id,
     name,
+    slug,
     inputs,
     jobAgents,
   }));
@@ -44,14 +51,15 @@ const createWorkflow: AsyncTypedHandler<
   "post"
 > = async (req, res) => {
   const { workspaceId } = req.params;
+  const slug = req.body.slug ?? slugifyWorkflowName(req.body.name);
   const created = await db
     .insert(schema.workflow)
-    .values({ ...req.body, workspaceId })
+    .values({ ...req.body, slug, workspaceId })
     .returning()
     .then(takeFirst);
 
   const { id, name, inputs, jobAgents } = created;
-  res.status(201).json({ id, name, inputs, jobAgents });
+  res.status(201).json({ id, name, slug, inputs, jobAgents });
 };
 
 const getWorkflow: AsyncTypedHandler<
@@ -72,8 +80,8 @@ const getWorkflow: AsyncTypedHandler<
 
   if (workflow == null) throw new NotFoundError("Workflow not found");
 
-  const { id, name, inputs, jobAgents } = workflow;
-  res.json({ id, name, inputs, jobAgents });
+  const { id, name, slug, inputs, jobAgents } = workflow;
+  res.json({ id, name, slug, inputs, jobAgents });
 };
 
 const updateWorkflow: AsyncTypedHandler<
@@ -95,8 +103,8 @@ const updateWorkflow: AsyncTypedHandler<
 
   if (updated == null) throw new NotFoundError("Workflow not found");
 
-  const { id, name, inputs, jobAgents } = updated;
-  res.status(202).json({ id, name, inputs, jobAgents });
+  const { id, name, slug, inputs, jobAgents } = updated;
+  res.status(202).json({ id, name, slug, inputs, jobAgents });
 };
 
 const deleteWorkflow: AsyncTypedHandler<
@@ -117,8 +125,8 @@ const deleteWorkflow: AsyncTypedHandler<
 
   if (deleted == null) throw new NotFoundError("Workflow not found");
 
-  const { id, name, inputs, jobAgents } = deleted;
-  res.status(202).json({ id, name, inputs, jobAgents });
+  const { id, name, slug, inputs, jobAgents } = deleted;
+  res.status(202).json({ id, name, slug, inputs, jobAgents });
 };
 
 const createWorkflowRun: AsyncTypedHandler<

apps/api/src/types/openapi.ts

@@ -1236,6 +1236,8 @@ export interface components {
             inputs: components["schemas"]["WorkflowInput"][];
             jobAgents: components["schemas"]["CreateWorkflowJobAgent"][];
             name: string;
+            /** @description URL-safe identifier unique within the workspace. Derived from name if omitted. */
+            slug?: string;
         };
         CreateWorkflowJobAgent: {
             /** @description Configuration for the job agent */
@@ -2069,6 +2071,8 @@ export interface components {
             inputs: components["schemas"]["WorkflowInput"][];
             jobAgents: components["schemas"]["CreateWorkflowJobAgent"][];
             name: string;
+            /** @description URL-safe identifier unique within the workspace. */
+            slug?: string;
         };
         UpdateWorkspaceRequest: {
             /** @description Display name of the workspace */
@@ -2334,6 +2338,7 @@ export interface components {
             inputs: components["schemas"]["WorkflowInput"][];
             jobAgents: components["schemas"]["WorkflowJobAgent"][];
             name: string;
+            slug: string;
         };
         WorkflowArrayInput: components["schemas"]["WorkflowManualArrayInput"] | components["schemas"]["WorkflowSelectorArrayInput"];
         WorkflowBooleanInput: {

apps/workspace-engine/oapi/openapi.json

@@ -3035,11 +3035,15 @@
                },
                "name": {
                   "type": "string"
+               },
+               "slug": {
+                  "type": "string"
                }
             },
             "required": [
                "id",
                "name",
+               "slug",
                "inputs",
                "jobs"
             ],

apps/workspace-engine/oapi/spec/schemas/workflows.jsonnet

@@ -14,10 +14,11 @@ local openapi = import '../lib/openapi.libsonnet';
 
   Workflow: {
     type: 'object',
-    required: ['id', 'name', 'inputs', 'jobs'],
+    required: ['id', 'name', 'slug', 'inputs', 'jobs'],
     properties: {
       id: { type: 'string' },
       name: { type: 'string' },
+      slug: { type: 'string' },
       inputs: {
         type: 'array',
         items: openapi.schemaRef('WorkflowInput'),

apps/workspace-engine/pkg/db/models.go

@@ -264,9 +264,11 @@ CREATE TABLE user_approval_record (
 CREATE TABLE workflow (
     id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
     name TEXT NOT NULL,
+    slug TEXT NOT NULL,
     inputs JSONB NOT NULL DEFAULT '[]',
     job_agents JSONB NOT NULL DEFAULT '[]',
-    workspace_id UUID NOT NULL REFERENCES workspace(id) ON DELETE CASCADE
+    workspace_id UUID NOT NULL REFERENCES workspace(id) ON DELETE CASCADE,
+    UNIQUE (workspace_id, slug)
 );
 
 CREATE TABLE workflow_run (