feat: enhance deployment and environment management with environmentIds

jsbroks · jsbroks · commit dfd312d219a7 · 2026-02-16T23:58:45.000-05:00
- Added `environmentIds` as a required field in OpenAPI schemas and related TypeScript interfaces for user approval records.
- Updated the logic in deployment routes to utilize `environmentIds` directly from the request body, improving clarity and consistency.
- Refactored related components to remove unnecessary environment ID fetching logic, streamlining the deployment process.
- Adjusted tests and integration points to ensure proper handling of the new `environmentIds` field across the codebase.
diff --git a/apps/api/openapi/openapi.json b/apps/api/openapi/openapi.json
@@ -2485,7 +2485,8 @@
                }
             },
             "required": [
-               "status"
+               "status",
+               "environmentIds"
             ],
             "type": "object"
          },
diff --git a/apps/api/openapi/schemas/userapprovalrecord.jsonnet b/apps/api/openapi/schemas/userapprovalrecord.jsonnet
@@ -3,7 +3,7 @@ local openapi = import '../lib/openapi.libsonnet';
 {
   UpsertUserApprovalRecordRequest: {
     type: 'object',
-    required: ['status'],
+    required: ['status', 'environmentIds'],
     properties: {
       environmentIds: { type: 'array', items: { type: 'string' } },
       status: openapi.schemaRef('ApprovalStatus'),
diff --git a/apps/api/package.json b/apps/api/package.json
@@ -12,6 +12,7 @@
     "build": "tsc && tsc-alias",
     "clean": "rm -rf .turbo node_modules",
     "dev": "pnpm with-env tsx watch --clear-screen=false src/index.ts",
+    "typecheck": "tsc --noEmit --emitDeclarationOnly false",
     "format": "prettier --check . --ignore-path ../../.gitignore --ignore-path ./src/types/openapi.ts --ignore-path ./openapi/openapi.json && bash -c 'jsonnetfmt -i ./**/*.jsonnet'",
     "format:fix": "prettier --write . --ignore-path ../../.gitignore --ignore-path ./src/types/openapi.ts --ignore-path ./openapi/openapi.json && bash -c 'jsonnetfmt -i ./**/*.jsonnet'",
     "generate": "jsonnet openapi/main.jsonnet > openapi/openapi.json && pnpm generate:types",
diff --git a/apps/api/src/routes/v1/workspaces/deployment-versions.ts b/apps/api/src/routes/v1/workspaces/deployment-versions.ts
@@ -2,58 +2,9 @@ import type { AsyncTypedHandler } from "@/types/api.js";
 import type { WorkspaceEngine } from "@ctrlplane/workspace-engine-sdk";
 import { ApiError, asyncHandler } from "@/types/api.js";
 import { Router } from "express";
-
 import { Event, sendGoEvent } from "@ctrlplane/events";
 import { getClientFor } from "@ctrlplane/workspace-engine-sdk";
 
-const getEnvironmentIds = async (
-  workspaceId: string,
-  deploymentVersionId: string,
-) => {
-  const deploymentVersionResponse = await getClientFor(workspaceId).GET(
-    "/v1/workspaces/{workspaceId}/deploymentversions/{deploymentVersionId}",
-    { params: { path: { workspaceId, deploymentVersionId } } },
-  );
-
-  if (deploymentVersionResponse.error != null)
-    throw new ApiError(
-      deploymentVersionResponse.error.error ?? "Deployment version not found",
-      deploymentVersionResponse.response.status,
-    );
-  const { deploymentId } = deploymentVersionResponse.data;
-
-  const deploymentResponse = await getClientFor(workspaceId).GET(
-    "/v1/workspaces/{workspaceId}/deployments/{deploymentId}",
-    { params: { path: { workspaceId, deploymentId } } },
-  );
-  if (deploymentResponse.error != null)
-    throw new ApiError(
-      deploymentResponse.error.error ?? "Deployment not found",
-      deploymentResponse.response.status,
-    );
-
-  const { deployment } = deploymentResponse.data;
-  const { systemIds } = deployment;
-
-  const environmentIds: string[] = [];
-  for (const systemId of systemIds) {
-    const systemResponse = await getClientFor(workspaceId).GET(
-      "/v1/workspaces/{workspaceId}/systems/{systemId}",
-      { params: { path: { workspaceId, systemId } } },
-    );
-
-    if (systemResponse.error != null)
-      throw new ApiError(
-        systemResponse.error.error ?? "System not found",
-        systemResponse.response.status,
-      );
-    const { environments } = systemResponse.data;
-    environmentIds.push(...environments.map((environment) => environment.id));
-  }
-
-  return environmentIds;
-};
-
 const upsertUserApprovalRecord: AsyncTypedHandler<
   "/v1/workspaces/{workspaceId}/deployment-versions/{deploymentVersionId}/user-approval-records",
   "put"
@@ -71,12 +22,8 @@ const upsertUserApprovalRecord: AsyncTypedHandler<
     reason: req.body.reason,
   };
 
-  const environmentIds =
-    req.body.environmentIds ??
-    (await getEnvironmentIds(workspaceId, deploymentVersionId));
-
   try {
-    for (const environmentId of environmentIds)
+    for (const environmentId of req.body.environmentIds)
       await sendGoEvent({
         workspaceId,
         eventType: Event.UserApprovalRecordCreated,
diff --git a/apps/api/src/types/openapi.ts b/apps/api/src/types/openapi.ts
@@ -1767,7 +1767,7 @@ export interface components {
             slug?: string;
         };
         UpsertUserApprovalRecordRequest: {
-            environmentIds?: string[];
+            environmentIds: string[];
             reason?: string;
             status: components["schemas"]["ApprovalStatus"];
         };
diff --git a/apps/web/app/routes/ws/deployments/_components/DeploymentProvider.tsx b/apps/web/app/routes/ws/deployments/_components/DeploymentProvider.tsx
@@ -1,9 +1,25 @@
-import type { WorkspaceEngine } from "@ctrlplane/workspace-engine-sdk";
 import type { ReactNode } from "react";
 import { createContext, useContext } from "react";
 
-type Deployment = WorkspaceEngine["schemas"]["Deployment"] & {
-  variables: WorkspaceEngine["schemas"]["DeploymentVariableWithValues"][];
+type Deployment = {
+  id: string;
+  name: string;
+  resourceSelector?: string | null;
+  description?: string | null;
+  jobAgentId?: string | null;
+  jobAgentConfig?: Record<string, any> | null;
+  systemDeployments: Array<{
+    systemId: string;
+    system: {
+      id: string;
+      name: string;
+
+      systemEnvironments: Array<{
+        systemId: string;
+        environmentId: string;
+      }>;
+    };
+  }>;
 };
 
 type DeploymentContextType = {
diff --git a/apps/web/app/routes/ws/deployments/_components/RedeployDialog.tsx b/apps/web/app/routes/ws/deployments/_components/RedeployDialog.tsx
@@ -42,12 +42,10 @@ const useRedeploy = (releaseTarget: ReleaseTarget, onClose: () => void) => {
 };
 
 const useDeployment = (deploymentId: string) => {
-  const { workspace } = useWorkspace();
   const { data: deployment, isLoading } = trpc.deployment.get.useQuery({
-    workspaceId: workspace.id,
     deploymentId,
   });
-  return { deployment: deployment?.deployment, isLoading };
+  return { deployment, isLoading };
 };
 
 function DeploymentBadge({ deploymentId }: { deploymentId: string }) {
diff --git a/apps/web/app/routes/ws/deployments/_components/variables/DeploymentVariableSection.tsx b/apps/web/app/routes/ws/deployments/_components/variables/DeploymentVariableSection.tsx
@@ -110,7 +110,6 @@ export function DeploymentVariableSection({
     onSuccess: () => {
       toast.success(`Variable "${variable.variable.key}" deleted`);
       utils.deployment.get.invalidate({
-        workspaceId: workspace.id,
         deploymentId: deploymentId ?? "",
       });
     },
diff --git a/apps/web/app/routes/ws/deployments/_layout.tsx b/apps/web/app/routes/ws/deployments/_layout.tsx
@@ -2,29 +2,26 @@ import { Outlet, useParams } from "react-router";
 
 import { trpc } from "~/api/trpc";
 import { Spinner } from "~/components/ui/spinner";
-import { useWorkspace } from "~/components/WorkspaceProvider";
 import { DeploymentProvider } from "./_components/DeploymentProvider";
 
 export default function DeploymentsLayout() {
-  const { workspace } = useWorkspace();
   const { deploymentId } = useParams();
 
-  const { data: { deployment, variables } = {}, isLoading } =
-    trpc.deployment.get.useQuery(
-      { workspaceId: workspace.id, deploymentId: deploymentId ?? "" },
-      { enabled: deploymentId != null },
-    );
+  const { data: deployment, isLoading } = trpc.deployment.get.useQuery(
+    { deploymentId: deploymentId ?? "" },
+    { enabled: deploymentId != null },
+  );
 
   if (isLoading) {
     return <Spinner />;
   }
 
-  if (deployment == null || variables == null) {
+  if (deployment == null) {
     throw new Error("Deployment not found");
   }
 
   return (
-    <DeploymentProvider deployment={{ ...deployment, variables }}>
+    <DeploymentProvider deployment={deployment}>
       <Outlet />
     </DeploymentProvider>
   );
diff --git a/apps/web/app/routes/ws/deployments/page.$deploymentId.release-targets.tsx b/apps/web/app/routes/ws/deployments/page.$deploymentId.release-targets.tsx
@@ -1,4 +1,4 @@
-import { useState } from "react";
+import { useMemo, useState } from "react";
 import _ from "lodash";
 import { Search } from "lucide-react";
 import { Link, useSearchParams } from "react-router";
@@ -103,11 +103,17 @@ export default function ReleaseTargetsPage() {
     workspaceId: workspace.id,
   });
 
+  const environmentIds = useMemo(() => {
+    return new Set(
+      deployment.systemDeployments.flatMap((sd) =>
+        sd.system.systemEnvironments.map((se) => se.environmentId),
+      ),
+    );
+  }, [deployment.systemDeployments]);
+
   const environments =
     environmentsQuery.data?.filter((environment) =>
-      environment.systemEnvironments.some((se) =>
-        deployment.systemIds.includes(se.systemId),
-      ),
+      environmentIds.has(environment.id),
     ) ?? [];
 
   const releaseTargets = releaseTargetsQuery.data?.items ?? [];
diff --git a/apps/web/app/routes/ws/deployments/page.$deploymentId.resources.tsx b/apps/web/app/routes/ws/deployments/page.$deploymentId.resources.tsx
@@ -2,7 +2,6 @@ import { useState } from "react";
 import { useDebounce } from "react-use";
 import { toast } from "sonner";
 
-import type { Deployment } from "./_components/types";
 import { trpc } from "~/api/trpc";
 import { Button } from "~/components/ui/button";
 import { useWorkspace } from "~/components/WorkspaceProvider";
@@ -31,17 +30,12 @@ const useResources = (selector: string) => {
   return resourcesQuery.data?.items ?? [];
 };
 
-function getCelSelector(deployment: Deployment) {
-  if (deployment.resourceSelector == null) return "false";
-  if ("cel" in deployment.resourceSelector)
-    return deployment.resourceSelector.cel;
-  return "true";
-}
-
 function SelectorWithResources() {
   const { workspace } = useWorkspace();
   const { deployment } = useDeployment();
-  const [selector, setSelector] = useState(getCelSelector(deployment));
+  const [selector, setSelector] = useState(
+    deployment.resourceSelector ?? "false",
+  );
 
   const [selectorDebounced, setSelectorDebounced] = useState(selector);
   useDebounce(() => setSelectorDebounced(selector), 1_000, [selector]);
@@ -68,7 +62,7 @@ function SelectorWithResources() {
           />
         </div>
         <Button
-          className="h-[2.5rem]"
+          className="h-10"
           onClick={() =>
             onResourceSelectorChange(selector).then(() =>
               toast.success(
@@ -78,7 +72,7 @@ function SelectorWithResources() {
           }
           disabled={
             updateDeployment.isPending ||
-            getCelSelector(deployment) === selector
+            deployment.resourceSelector === selector
           }
         >
           Save
diff --git a/apps/web/app/routes/ws/deployments/page.$deploymentId.tsx b/apps/web/app/routes/ws/deployments/page.$deploymentId.tsx
@@ -97,14 +97,17 @@ export default function DeploymentDetail() {
     [policiesQuery.data],
   );
 
-  const environments = useMemo(
+  const envIds = useMemo(
     () =>
-      (environmentsQuery.data ?? []).filter((e) =>
-        e.systemEnvironments.some((se) =>
-          deployment.systemIds.includes(se.systemId),
-        ),
+      deployment.systemDeployments.flatMap((sd) =>
+        sd.system.systemEnvironments.map((se) => se.environmentId),
       ),
-    [deployment.systemIds, environmentsQuery.data],
+    [deployment.systemDeployments],
+  );
+
+  const environments = useMemo(
+    () => (environmentsQuery.data ?? []).filter((e) => envIds.includes(e.id)),
+    [envIds, environmentsQuery.data],
   );
 
   const envDependsOn = useCallback(
diff --git a/apps/web/app/routes/ws/deployments/page.$deploymentId.variables.tsx b/apps/web/app/routes/ws/deployments/page.$deploymentId.variables.tsx
@@ -1,3 +1,5 @@
+import { trpc } from "~/api/trpc";
+import { useWorkspace } from "~/components/WorkspaceProvider";
 import { DeploymentPageHeader } from "./_components/DeploymentPageHeader";
 import { useDeployment } from "./_components/DeploymentProvider";
 import { DeploymentVariableSection } from "./_components/variables/DeploymentVariableSection";
@@ -10,8 +12,13 @@ export function meta() {
 }
 
 function VariablesTable() {
+  const { workspace } = useWorkspace();
   const { deployment } = useDeployment();
-  const { variables } = deployment;
+
+  const { data: variables = [] } = trpc.deployment.variables.useQuery({
+    workspaceId: workspace.id,
+    deploymentId: deployment.id,
+  });
 
   if (variables.length === 0) {
     return (
diff --git a/apps/web/app/routes/ws/deployments/settings/page.$deploymentId.general.tsx b/apps/web/app/routes/ws/deployments/settings/page.$deploymentId.general.tsx
@@ -2,6 +2,7 @@ import type { WorkspaceEngine } from "@ctrlplane/workspace-engine-sdk";
 import { useState } from "react";
 import { ChevronDown } from "lucide-react";
 
+import { trpc } from "~/api/trpc";
 import { Badge } from "~/components/ui/badge";
 import { Button } from "~/components/ui/button";
 import {
@@ -19,6 +20,7 @@ import {
 import { CopyButton } from "~/components/ui/copy-button";
 import { Input } from "~/components/ui/input";
 import { Label } from "~/components/ui/label";
+import { useWorkspace } from "~/components/WorkspaceProvider";
 import { useDeployment } from "../_components/DeploymentProvider";
 
 type Value = WorkspaceEngine["schemas"]["Value"];
@@ -57,11 +59,17 @@ function formatSelector(selector?: {
 }
 
 export default function DeploymentsSettingsPage() {
+  const { workspace } = useWorkspace();
   const { deployment } = useDeployment();
   const [expandedVariables, setExpandedVariables] = useState<Set<string>>(
     new Set(),
   );
 
+  const { data: variables = [] } = trpc.deployment.variables.useQuery({
+    workspaceId: workspace.id,
+    deploymentId: deployment.id,
+  });
+
   const toggleVariable = (variableId: string) => {
     setExpandedVariables((prev) => {
       const next = new Set(prev);
@@ -113,13 +121,13 @@ export default function DeploymentsSettingsPage() {
           </CardDescription>
         </CardHeader>
         <CardContent>
-          {deployment.variables.length === 0 ? (
+          {variables.length === 0 ? (
             <p className="text-sm text-muted-foreground">
               No variables configured for this deployment.
             </p>
           ) : (
             <div className="space-y-4">
-              {deployment.variables.map((variableWithValues) => {
+              {variables.map((variableWithValues) => {
                 const { variable, values } = variableWithValues;
                 const isExpanded = expandedVariables.has(variable.id);
                 const sortedValues = [...values].sort(
diff --git a/apps/web/app/routes/ws/deployments/settings/page.$deploymentId.job-agent.tsx b/apps/web/app/routes/ws/deployments/settings/page.$deploymentId.job-agent.tsx
@@ -28,7 +28,6 @@ import { ArgoCDConfig } from "./_components/ArgoCD";
 import { GithubAgentConfig } from "./_components/GithubAgentConfig";
 import { TerraformCloudConfig } from "./_components/TerraformCloudConfig";
 import { useAllJobAgents, useSelectedJobAgent } from "./_hooks/job-agents";
-import { deploymentJobAgentConfig } from "./deploymentJobAgentConfig";
 
 const formSchema = z.object({
   jobAgentId: z.string(),
diff --git a/apps/web/app/routes/ws/environments/_components/EnvironmentProvider.tsx b/apps/web/app/routes/ws/environments/_components/EnvironmentProvider.tsx
@@ -4,10 +4,16 @@ import { createContext, useContext } from "react";
 type Environment = {
   id: string;
   name: string;
-  systemIds: string[];
-  description?: string;
-  resourceSelector?: { cel?: string; json?: Record<string, unknown> };
-  createdAt: string;
+  systemEnvironments: Array<{
+    systemId: string;
+    system: {
+      id: string;
+      name: string;
+    };
+  }>;
+  description?: string | null;
+  resourceSelector?: string | null;
+  createdAt: Date;
 };
 
 type EnvironmentContextType = {
diff --git a/apps/web/app/routes/ws/environments/_layout.tsx b/apps/web/app/routes/ws/environments/_layout.tsx
diff --git a/apps/web/app/routes/ws/environments/page.$environmentId.resources.tsx b/apps/web/app/routes/ws/environments/page.$environmentId.resources.tsx
diff --git a/packages/trpc/src/routes/deployments.ts b/packages/trpc/src/routes/deployments.ts
diff --git a/packages/trpc/src/routes/environments.ts b/packages/trpc/src/routes/environments.ts
diff --git a/packages/workspace-engine-sdk/src/schema.ts b/packages/workspace-engine-sdk/src/schema.ts

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ local openapi = import '../lib/openapi.libsonnet';`
`3`	`3`	`{`
`4`	`4`	`UpsertUserApprovalRecordRequest: {`
`5`	`5`	`type: 'object',`
`6`		`- required: ['status'],`
	`6`	`+ required: ['status', 'environmentIds'],`
`7`	`7`	`properties: {`
`8`	`8`	`environmentIds: { type: 'array', items: { type: 'string' } },`
`9`	`9`	`status: openapi.schemaRef('ApprovalStatus'),`