@catladder/pipeline 3.7.0 → 3.8.0

package/examples/cloud-run-health-check-defaults.test.ts

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

package/examples/cloud-run-health-check-defaults.ts

@@ -0,0 +1,28 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: true,
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/examples/cloud-run-health-check-only-startup.test.ts

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

package/examples/cloud-run-health-check-only-startup.ts

@@ -0,0 +1,38 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: {
+            livenessProbe: false,
+            startupProbe: {
+              type: "http1",
+              failureThreshold: 43,
+              initialDelaySeconds: 4,
+              path: "/something2",
+              periodSeconds: 5,
+              timeoutSeconds: 6,
+            },
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/examples/cloud-run-health-check.test.ts

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

package/examples/cloud-run-health-check.ts

@@ -0,0 +1,45 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: {
+            livenessProbe: {
+              type: "http1",
+              failureThreshold: 42,
+              initialDelaySeconds: 1,
+              path: "/something",
+              periodSeconds: 2,
+              timeoutSeconds: 3,
+            },
+            startupProbe: {
+              type: "http1",
+              failureThreshold: 43,
+              initialDelaySeconds: 4,
+              path: "/something2",
+              periodSeconds: 5,
+              timeoutSeconds: 6,
+            },
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/package.json

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

package/src/deploy/cloudRun/createJobs/cloudRunServices.ts

@@ -12,6 +12,7 @@ import {
   makeLabelString,
 } from "./common";
 import { ENV_VARS_FILENAME } from "./constants";
+import { healthCheckCliArgs } from "./healthCheck";
 import { createVolumeConfig } from "./volumes";
 
 export const getServiceDeployScript = (
@@ -38,6 +39,7 @@ export const getServiceDeployScript = (
       : command.split(" ")
     : undefined;
   const fullServiceName = serviceName.concat(nameSuffix ?? "");
+
   const argsString = createArgsString(
     {
       // command as empty string resets it to default (uses the image's entrypoint)
@@ -67,6 +69,7 @@ export const getServiceDeployScript = (
       "execution-environment": customConfig?.executionEnvironment,
       gpu: customConfig?.gpu,
       "gpu-type": customConfig?.gpuType,
+      ...healthCheckCliArgs(customConfig?.healthCheck),
     },
     ...createVolumeConfig(customConfig?.volumes, "service"),
   );
@@ -103,5 +106,8 @@ const requiresBeta = (config: DeployConfigCloudRunService | undefined) => {
   if (config.gpu && config.gpu > 0) {
     return true;
   }
+  if (config.healthCheck !== undefined) {
+    return true;
+  }
   return false;
 };

package/src/deploy/cloudRun/createJobs/healthCheck.ts

@@ -0,0 +1,64 @@
+import type { DeployConfigCloudRunProbeShared } from "../../types";
+import {
+  defaultLivenessProbe,
+  defaultStartupProbe,
+  type DeployConfigCloudRunProbe,
+  type DeployConfigCloudRunService,
+} from "../../types";
+
+const PORT = 8080;
+
+export function healthCheckCliArgs(
+  healthCheck: DeployConfigCloudRunService["healthCheck"],
+) {
+  const shouldNotSetHealthCheck = healthCheck === undefined;
+  if (shouldNotSetHealthCheck) {
+    return undefined;
+  }
+
+  const shouldUseDefaultProbe = healthCheck === true;
+
+  if (shouldUseDefaultProbe) {
+    return {
+      "startup-probe": toArgValue(probeToKeyValuePairs(defaultStartupProbe)),
+      "liveness-probe": toArgValue(probeToKeyValuePairs(defaultLivenessProbe)),
+    };
+  }
+
+  return {
+    "startup-probe": toArgValue(probeToKeyValuePairs(healthCheck.startupProbe)),
+    "liveness-probe": healthCheck.livenessProbe
+      ? toArgValue(probeToKeyValuePairs(healthCheck.livenessProbe))
+      : "", // NOTE: empty string ("") removes liveness probe
+  };
+}
+
+function probeToKeyValuePairs(
+  probe: DeployConfigCloudRunProbe,
+): [string, unknown][] {
+  const sharedArgs = Object.entries({
+    initialDelaySeconds: probe.initialDelaySeconds,
+    timeoutSeconds: probe.timeoutSeconds,
+    periodSeconds: probe.periodSeconds,
+    failureThreshold: probe.failureThreshold,
+  } satisfies DeployConfigCloudRunProbeShared);
+
+  switch (probe.type) {
+    case "tcp":
+      return [...sharedArgs, ["tcpSocket.port", PORT]];
+    case "http1":
+      return [
+        ...sharedArgs,
+        ["httpGet.port", PORT],
+        ["httpGet.path", probe.path],
+        // NOTE: headers are not supported by "gcloud beta" at the moment
+      ];
+    default:
+      probe satisfies never;
+      return [];
+  }
+}
+
+function toArgValue(keyValues: [string, unknown][]) {
+  return keyValues.map(([key, value]) => `${key}=${value}`).join(",");
+}

package/src/deploy/types/googleCloudRun.ts

@@ -191,9 +191,110 @@ export type DeployConfigCloudRunService = {
    * args to pass to the command
    */
   args?: string[];
+
+  /**
+   * Configuration of the health check.
+   *
+   * When set to `true`, startup and liveness probes will be
+   * configured to `defaultStartupProbe` and `defaultLivenessProbe`.
+   *
+   * When not set, default Cloud Run's health check
+   * configuration is used (startup TCP probe and no liveness probe).
+   */
+  healthCheck?:
+    | true
+    | {
+        /**
+         * Startup probe configuration.
+         */
+        startupProbe: DeployConfigCloudRunProbe;
+
+        /**
+         * Liveness probe configuration.
+         * `false` disables the liveness probe.
+         */
+        livenessProbe: false | DeployConfigCloudRunProbe;
+      };
 } & DeployConfigCloudRunWithVolumes &
   DeployConfigCloudRunNetworkConfig;
 
+export const defaultStartupProbe: DeployConfigCloudRunProbe = {
+  type: "http1",
+  path: "/__health",
+
+  initialDelaySeconds: 5,
+  timeoutSeconds: 1,
+  periodSeconds: 30,
+  failureThreshold: 3,
+};
+
+export const defaultLivenessProbe: DeployConfigCloudRunProbe = {
+  ...defaultStartupProbe,
+
+  initialDelaySeconds: 0,
+  timeoutSeconds: 10,
+  periodSeconds: 30,
+  failureThreshold: 3,
+};
+
+export type DeployConfigCloudRunProbe =
+  | DeployConfigCloudRunHttp1Probe
+  | DeployConfigCloudRunTcpProbe;
+
+export type DeployConfigCloudRunProbeShared = {
+  /**
+   * The period in seconds at which to perform the probe.
+   * For example 2 to perform the probe every 2 seconds.
+   * Specify a value **from 1 second to 240** seconds.
+   */
+  periodSeconds: number;
+
+  /**
+   * The number of seconds to wait after the container has started before performing the first probe.
+   * Specify a value **from 0 seconds to 240** seconds.
+   */
+  initialDelaySeconds: number;
+
+  /**
+   * The number of seconds to wait until the probe times out.
+   * This value cannot exceed the value specified for `period`.
+   * Specify a value **from 1 to 240**.
+   */
+  timeoutSeconds: number;
+
+  /**
+   * The number of times to retry the probe before shutting down the container.
+   */
+  failureThreshold: number;
+};
+
+export type DeployConfigCloudRunTcpProbe = DeployConfigCloudRunProbeShared & {
+  /**
+   * Cloud Run makes a TCP connection to open the TCP Socket on the specified port.
+   * If Cloud Run is unable to establish a connection, it indicates a failure.
+   */
+  type: "tcp";
+};
+
+export type DeployConfigCloudRunHttp1Probe = DeployConfigCloudRunProbeShared & {
+  /**
+   * **This will NOT work with http2 enabled services**
+   *
+   * Cloud Run makes an HTTP GET request to the service health check endpoint (for example, /ready).
+   * Any response between 200 and 400 is a success, everything else indicates failure.
+   *
+   * If a startup probe does not succeed within the specified time (failureThreshold * period), which cannot exceed 240 seconds, the container is shut down.
+   *
+   * If the HTTP startup probe succeeds within the specified time, and you have enabled liveness probe, the HTTP liveness probe is started.
+   */
+  type: "http1";
+
+  /**
+   * the route path to check for health status of the service starting with a `/`.
+   */
+  path: string;
+};
+
 export type DeployConfigCloudRunNetworkConfig = {
   /* the vpc network, see https://cloud.google.com/sdk/gcloud/reference/run/deploy#--network  */
   network?: string;