@catladder/pipeline 3.29.1 → 3.30.0

package/examples/cloud-run-execute-script-on-deploy.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-execute-script-on-deploy";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-execute-script-on-deploy local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-execute-script-on-deploy.ts

@@ -0,0 +1,47 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    app: {
+      dir: "app",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        execute: {
+          "pre-deploy-script": {
+            type: "script",
+            script: ["echo 'deploying'"],
+            when: "preDeploy",
+          },
+          "post-deploy-script": {
+            type: "script",
+            script: ["echo 'deployed'"],
+            when: "postDeploy",
+          },
+          "pre-stop-script": {
+            type: "script",
+            script: ["echo 'stopping'"],
+            when: "preStop",
+          },
+          "post-stop-script": {
+            type: "script",
+            script: ["echo 'stopped'"],
+            when: "postStop",
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Execute script on deploy",
+};

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.29.1",
+  "version": "3.30.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",

package/src/deploy/cloudRun/createJobs/execute/onDeploy.ts

@@ -1,10 +1,8 @@
 import type { StringOrBashExpression } from "../../../../bash";
 import type { ComponentContext } from "../../../../types/context";
-import type {
-  DeployConfigCloudRunExecuteOnDeploy,
-  DeployConfigCloudRunJob,
-  DeployConfigCloudRunService,
-} from "../../../types/googleCloudRun";
+import { ensureArray } from "../../../../utils";
+import type { DeployConfigBaseExecuteOnDeploy } from "../../../types/executeBase";
+import type { DeployConfigCloudRunExecuteOnDeploy } from "../../../types/googleCloudRun";
 import { createArgsString } from "../../utils/createArgsString";
 import { getCloudRunServiceOrJobArgsArg } from "../../utils/getJobOrServiceArgs";
 import { getFullJobName } from "../../utils/jobName";
@@ -17,7 +15,7 @@ import {
 
 type Execute = {
   jobName: StringOrBashExpression;
-  config: DeployConfigCloudRunExecuteOnDeploy;
+  config: DeployConfigCloudRunExecuteOnDeploy | DeployConfigBaseExecuteOnDeploy;
 };
 export const getOnDeployExecuteScript = (
   context: ComponentContext,
@@ -27,7 +25,7 @@ export const getOnDeployExecuteScript = (
 
   return executes
     .filter(({ config }) => config.when === when)
-    .map((execute) => {
+    .flatMap((execute) => {
       return getJobRunScriptForExecute(context, execute);
     });
 };
@@ -37,7 +35,8 @@ const getExecutes = (context: ComponentContext): Execute[] => {
   return [
     ...getLegacyExecutes(context),
     ...Object.entries(deployConfig.execute ?? {}).flatMap(([key, value]) => {
-      if (!value || (value.when !== "schedule" && value.type !== "job")) {
+      // remove all schedule executes
+      if (!value) {
         return [];
       }
       return [
@@ -81,22 +80,30 @@ const getLegacyExecutes = (context: ComponentContext): Execute[] => {
 const getJobRunScriptForExecute = (
   context: ComponentContext,
   { jobName, config }: Execute,
-) => {
-  const commonArgs = getCommonCloudRunArgs(context);
+): string[] => {
+  const type = config.type;
+  if (type === "script") {
+    return ensureArray(config.script);
+  } else if (type === "job") {
+    const commonArgs = getCommonCloudRunArgs(context);
 
-  // always wait for completion for preStop and postStop jobs
-  // since stop will delete the jobs afterwards, so they will fail
-  const waitForCompletion = ["preStop", "postStop"].includes(config.when)
-    ? true // always
-    : "waitForCompletion" in config
-      ? (config.waitForCompletion ?? false) // depends on config
-      : false;
+    // always wait for completion for preStop and postStop jobs
+    // since stop will delete the jobs afterwards, so they will fail
+    const waitForCompletion = ["preStop", "postStop"].includes(config.when)
+      ? true // always
+      : "waitForCompletion" in config
+        ? (config.waitForCompletion ?? false) // depends on config
+        : false;
 
-  const argString = createArgsString({
-    ...commonArgs,
-    wait: waitForCompletion === true ? true : undefined,
-    args: getCloudRunServiceOrJobArgsArg(config.args),
-  });
-  const fullJobName = getFullJobName(context, jobName);
-  return `${gcloudRunCmd()} jobs execute ${fullJobName.toString()} ${argString}`;
+    const argString = createArgsString({
+      ...commonArgs,
+      wait: waitForCompletion === true ? true : undefined,
+      args: getCloudRunServiceOrJobArgsArg(config.args),
+    });
+    const fullJobName = getFullJobName(context, jobName);
+    return [
+      `${gcloudRunCmd()} jobs execute ${fullJobName.toString()} ${argString}`,
+    ];
+  }
+  throw new Error(`unsupported execute type: ${type}`);
 };

package/src/deploy/types/base.ts

@@ -1,4 +1,5 @@
 import type { EnvVars } from "../../types/config";
+import type { DeployConfigBaseExecute } from "./executeBase";
 
 export type DeployConfigBase = {
   /**

package/src/deploy/types/executeBase.ts

@@ -0,0 +1,27 @@
+type DeployConfigBaseExecuteScript = {
+  type: "script";
+  script: string | string[];
+};
+/**
+ * currently only supported for cloud run deployments
+ */
+export type DeployConfigBaseExecuteOnDeploy = DeployConfigBaseExecuteScript &
+  (
+    | {
+        /**
+         * run the job before or after the deploy
+         */
+        when: "preDeploy" | "postDeploy";
+        /**
+         * whether to wait for completion of the job
+         */
+        waitForCompletion?: boolean;
+      }
+    | {
+        /**
+         * run the job before or after the environment is stopped
+         */
+        when: "preStop" | "postStop";
+      }
+  );
+export type DeployConfigBaseExecute = DeployConfigBaseExecuteOnDeploy;

package/src/deploy/types/googleCloudRun.ts

@@ -1,5 +1,9 @@
 import type { DBVariablesMode } from "../cloudRun/utils/database";
 import type { DeployConfigBase } from "./base";
+import type {
+  DeployConfigBaseExecute,
+  DeployConfigBaseExecuteOnDeploy,
+} from "./executeBase";
 
 export type Gcloudregion =
   | "asia-east1"
@@ -424,7 +428,7 @@ export type DeployConfigCloudRunJob =
   | DeployConfigCloudRunJobNormal
   | DeployConfigCloudRunJobWithSchedule;
 
-export type DeployConfigCloudRun = {
+export type DeployConfigCloudRun = Omit<DeployConfigBase, "execute"> & {
   /**
    * cloud run deployment.
    *
@@ -469,7 +473,7 @@ export type DeployConfigCloudRun = {
   execute?: Record<string, DeployConfigCloudRunExecute | null>;
 
   debug?: boolean;
-} & DeployConfigBase;
+};
 
 export type DeployConfigCloudRunVolumes = Record<
   string,
@@ -543,6 +547,7 @@ export type DeployConfigCloudRunExecuteOnDeploy =
     );
 
 export type DeployConfigCloudRunExecuteJob =
+  | DeployConfigBaseExecute
   | DeployConfigCloudRunExecuteJobScheduled
   | DeployConfigCloudRunExecuteOnDeploy;
 
@@ -573,6 +578,7 @@ export type DeployConfigCloudRunExecuteHttp = {
 } & WithSchedule;
 
 export type DeployConfigCloudRunExecute =
+  | DeployConfigBaseExecute
   | DeployConfigCloudRunExecuteJob
   | DeployConfigCloudRunExecuteHttp;