Feat: Add approval and approval approver to openapi spec and get-job-status action

apps/webservice/src/app/api/v1/jobs/[jobId]/route.ts

@@ -6,6 +6,7 @@ import { db } from "@ctrlplane/db/client";
 import {
   deployment,
   environment,
+  environmentPolicyApproval,
   job,
   jobVariable,
   release,
@@ -15,19 +16,54 @@ import {
   target,
   targetMetadata,
   updateJob,
+  user,
 } from "@ctrlplane/db/schema";
 import { onJobCompletion } from "@ctrlplane/job-dispatch";
 import { variablesAES256 } from "@ctrlplane/secrets";
 import { JobStatus } from "@ctrlplane/validators/jobs";
 
 import { getUser } from "~/app/api/v1/auth";
 
+type ApprovalJoinResult = {
+  environment_policy_approval: typeof environmentPolicyApproval.$inferSelect;
+  user: typeof user.$inferSelect | null;
+};
+
+const getApprovalDetails = async (releaseId: string, policyId: string) =>
+  db
+    .select()
+    .from(environmentPolicyApproval)
+    .leftJoin(user, eq(environmentPolicyApproval.userId, user.id))
+    .where(
+      and(
+        eq(environmentPolicyApproval.releaseId, releaseId),
+        eq(environmentPolicyApproval.policyId, policyId),
+      ),
+    )
+    .then(takeFirstOrNull)
+    .then(mapApprovalResponse);
+
+const mapApprovalResponse = (row: ApprovalJoinResult | null) =>
+  !row
+    ? null
+    : {
+        id: row.environment_policy_approval.id,
+        status: row.environment_policy_approval.status,
+        approver:
+          row.user && row.environment_policy_approval.status !== "pending"
+            ? {
+                id: row.user.id,
+                name: row.user.name,
+              }
+            : null,
+      };
+
 export const GET = async (
   req: NextRequest,
   { params }: { params: { jobId: string } },
 ) => {
-  const user = await getUser(req);
-  if (!user)
+  const caller = await getUser(req);
+  if (!caller)
     return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
 
   const je = await db
@@ -51,6 +87,13 @@ export const GET = async (
       release: row.release,
     }));
 
+  const policyId = je.environment?.policyId;
+
+  const approval =
+    je.release?.id && policyId
+      ? await getApprovalDetails(je.release.id, policyId)
+      : null;
+
   const jobVariableRows = await db
     .select()
     .from(jobVariable)
@@ -80,6 +123,7 @@ export const GET = async (
     ...je,
     variables,
     target: targetWithMetadata,
+    approval,
   });
 };
 

integrations/github-get-job-inputs/src/index.ts

@@ -51,8 +51,15 @@ async function run() {
     .then((response) => {
       core.info(JSON.stringify(response, null, 2));
 
-      const { variables, target, release, environment, runbook, deployment } =
-        response;
+      const {
+        variables,
+        target,
+        release,
+        environment,
+        runbook,
+        deployment,
+        approval,
+      } = response;
 
       setOutputAndLog("base_url", baseUrl);
 
@@ -75,11 +82,15 @@ async function run() {
       setOutputsRecursively("release_config", release?.config);
       setOutputsRecursively("release_metadata", release?.metadata);
 
+      setOutputAndLog("approval_status", approval.status);
+      setOutputAndLog("approval_approver_id", approval.approver?.id);
+      setOutputAndLog("approval_approver_name", approval.approver?.name);
+
       setOutputAndLog("deployment_id", deployment?.id);
       setOutputAndLog("deployment_name", deployment?.name);
       setOutputAndLog("deployment_slug", deployment?.slug);
 
-      for (const [key, value] of Object.entries(variables ?? {})) {
+      for (const [key, value] of Object.entries(variables)) {
         const sanitizedKey = key.replace(/[.\-/\s\t]+/g, "_");
         setOutputAndLog(`variable_${sanitizedKey}`, value);
       }

openapi.v1.yaml

@@ -310,7 +310,6 @@ paths:
                         invalid_integration,
                         external_run_not_found,
                       ]
-
                   release:
                     type: object
                     properties:
@@ -323,7 +322,6 @@ paths:
                       config:
                         type: object
                     required: [id, version, metadata, config]
-
                   deployment:
                     type: object
                     properties:
@@ -338,7 +336,6 @@ paths:
                       jobAgentId:
                         type: string
                     required: [id, version, slug, systemId, jobAgentId]
-
                   runbook:
                     type: object
                     properties:
@@ -351,7 +348,6 @@ paths:
                       jobAgentId:
                         type: string
                     required: [id, name, systemId, jobAgentId]
-
                   target:
                     type: object
                     properties:
@@ -380,7 +376,6 @@ paths:
                       - workspaceId
                       - config
                       - metadata
-
                   environment:
                     type: object
                     properties:
@@ -391,15 +386,39 @@ paths:
                       systemId:
                         type: string
                     required: [id, name, systemId]
-
                   variables:
                     type: object
+                  approval:
+                    type: object
+                    nullable: true
+                    properties:
+                      id:
+                        type: string
+                      status:
+                        type: string
+                        enum: [pending, approved, rejected]
+                      approver:
+                        type: object
+                        nullable: true
+                        description: Null when status is pending, contains approver details when approved or rejected
+                        properties:
+                          id:
+                            type: string
+                          name:
+                            type: string
+                        required:
+                          - id
+                          - name
+                    required:
+                      - id
+                      - status
                 required:
                   - id
                   - status
                   - createdAt
                   - updatedAt
-                  - variable
+                  - variables
+                  - approval
     patch:
       summary: Update a job
       operationId: updateJob

packages/node-sdk/openapitools.json

@@ -7,7 +7,7 @@
       "v1": {
         "generatorName": "typescript-fetch",
         "output": "#{cwd}/src",
-        "glob": "../../openapi.yaml"
+        "glob": "../../openapi.v1.yaml"
       }
     }
   }

packages/node-sdk/src/.openapi-generator/FILES

@@ -6,6 +6,8 @@ models/CreateRelease200Response.ts
 models/CreateReleaseRequest.ts
 models/GetAgentRunningJob200ResponseInner.ts
 models/GetJob200Response.ts
+models/GetJob200ResponseApproval.ts
+models/GetJob200ResponseApprovalApprover.ts
 models/GetJob200ResponseDeployment.ts
 models/GetJob200ResponseEnvironment.ts
 models/GetJob200ResponseRelease.ts