@catladder/pipeline 1.134.0 → 1.135.0

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

@@ -0,0 +1,45 @@
+import { merge } from "lodash";
+
+import { getDockerJobBaseProps } from "../../../build/docker";
+import { getRunnerImage } from "../../../runner";
+import type { Context } from "../../../types/context";
+import type { CatladderJob } from "../../../types/jobs";
+import { allowFailureInScripts } from "../../../utils/gitlab";
+import { createDeployementJobs } from "../../base";
+
+import { isOfDeployType } from "../../types";
+import { getDeployJobVariables } from "./variables";
+import { getCloudRunDeployScripts } from "./getCloudRunDeployScripts";
+import { getCloudRunStopScripts } from "./getCloudRunStopScripts";
+
+export const createGoogleCloudRunDeployJobs = (
+  context: Context
+): CatladderJob[] => {
+  const deployConfig = context.componentConfig.deploy;
+  if (deployConfig === false) {
+    return [];
+  }
+  if (!isOfDeployType(deployConfig, "google-cloudrun")) {
+    // should not happen
+    throw new Error("deploy config is wrong");
+  }
+
+  const deployScripts = getCloudRunDeployScripts(context);
+  const stopScripts = getCloudRunStopScripts(context);
+
+  return createDeployementJobs(context, {
+    deploy: merge(getDockerJobBaseProps(context), {
+      artifacts: { paths: ["____envvars.yaml"] },
+      variables: getDeployJobVariables(context),
+      image: getRunnerImage("gcloud"),
+      script: deployScripts,
+    }),
+    stop: {
+      image: getRunnerImage("gcloud"),
+      variables: {
+        CLOUDSDK_CORE_DISABLE_PROMPTS: "1",
+      },
+      script: allowFailureInScripts(stopScripts),
+    },
+  });
+};

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

@@ -0,0 +1,21 @@
+import { dump } from "js-yaml";
+import { omit } from "lodash";
+
+import type { Context } from "../../../types/context";
+
+import { GCLOUD_DEPLOY_CREDENTIALS_KEY } from "../../..";
+
+export function getDeployJobVariables(context: Context) {
+  const allEnvVars = omit(
+    context.environment.envVars,
+    GCLOUD_DEPLOY_CREDENTIALS_KEY
+  );
+  return {
+    CLOUDSDK_CORE_DISABLE_PROMPTS: "1",
+    ENV_VARS: dump(allEnvVars, {
+      lineWidth: -1,
+      quotingType: "'",
+      forceQuotes: true,
+    }),
+  };
+}

package/src/deploy/cloudRun/index.ts

@@ -3,7 +3,7 @@ import { getSecretVarName } from "../../context";
 import type { EnvironmentContext } from "../../types/environmentContext";
 import { sanitizeForBashVariable } from "../../utils/gitlab";
 import { getFullDbName } from "../cloudSql/utils";
-import { createGoogleCloudRunDeployJobs } from "./deployJob";
+import { createGoogleCloudRunDeployJobs } from "./createJobs";
 import { getCloudRunJobName } from "./utils/jobName";
 
 export const GCLOUD_DEPLOY_CREDENTIALS_KEY = "GCLOUD_DEPLOY_credentialsKey";

package/src/deploy/types/googleCloudRun.ts

@@ -117,6 +117,16 @@ export type DeployConfigCloudRunService = {
    * memory limit. Defaults to 512MB
    */
   memory?: Memory;
+
+  /**
+   *
+   * set the execution environment.
+   *
+   * see https://cloud.google.com/run/docs/about-execution-environments
+   *
+   * defaults to gen1 according to gcloud
+   */
+  executionEnvironment?: "gen2" | "gen1";
 };
 
 export type DeployConfigCloudRunJobBase = {
@@ -187,7 +197,7 @@ export type DeployConfigCloudRun = {
   service?: boolean | DeployConfigCloudRunService;
 
   /**
-   * deploy additional services with different entry points. 
+   * deploy additional services with different entry points.
    */
   additionalServices?: {
     [name: string]: DeployConfigCloudRunService;

package/dist/deploy/cloudRun/deployJob.d.ts

@@ -1,3 +0,0 @@
-import type { Context } from "../../types/context";
-import type { CatladderJob } from "../../types/jobs";
-export declare const createGoogleCloudRunDeployJobs: (context: Context) => CatladderJob[];

package/dist/deploy/cloudRun/deployJob.js

@@ -1,261 +0,0 @@
-"use strict";
-
-var __assign = this && this.__assign || function () {
-  __assign = Object.assign || function (t) {
-    for (var s, i = 1, n = arguments.length; i < n; i++) {
-      s = arguments[i];
-      for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
-    }
-    return t;
-  };
-  return __assign.apply(this, arguments);
-};
-var __read = this && this.__read || function (o, n) {
-  var m = typeof Symbol === "function" && o[Symbol.iterator];
-  if (!m) return o;
-  var i = m.call(o),
-    r,
-    ar = [],
-    e;
-  try {
-    while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-  } catch (error) {
-    e = {
-      error: error
-    };
-  } finally {
-    try {
-      if (r && !r.done && (m = i["return"])) m.call(i);
-    } finally {
-      if (e) throw e.error;
-    }
-  }
-  return ar;
-};
-var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
-  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-    if (ar || !(i in from)) {
-      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-      ar[i] = from[i];
-    }
-  }
-  return to.concat(ar || Array.prototype.slice.call(from));
-};
-exports.__esModule = true;
-exports.createGoogleCloudRunDeployJobs = void 0;
-var js_yaml_1 = require("js-yaml");
-var lodash_1 = require("lodash");
-var _1 = require(".");
-var docker_1 = require("../../build/docker");
-var getLabels_1 = require("../../context/getLabels");
-var runner_1 = require("../../runner");
-var gitlab_1 = require("../../utils/gitlab");
-var base_1 = require("../base");
-var sbom_1 = require("../sbom");
-var types_1 = require("../types");
-var createArgsString_1 = require("./utils/createArgsString");
-var database_1 = require("./utils/database");
-var gcloudServiceAccountLoginCommands_1 = require("./utils/gcloudServiceAccountLoginCommands");
-var jobName_1 = require("./utils/jobName");
-var artifactsRegistry_1 = require("./artifactsRegistry");
-var getServiceName_1 = require("./utils/getServiceName");
-var cleanup_1 = require("./cleanup");
-var setGoogleProjectNumberScript = function (deployConfig) {
-  return ["export GCLOUD_PROJECT_NUMBER=$(gcloud projects describe ".concat(deployConfig.projectId, " --format=\"value(projectNumber)\")"), "echo \"GCLOUD_PROJECT_NUMBER: $GCLOUD_PROJECT_NUMBER\""];
-};
-var makeLabelString = function (obj) {
-  return Object.entries(obj).map(function (_a) {
-    var _b = __read(_a, 2),
-      key = _b[0],
-      value = _b[1];
-    return "".concat(key, "=").concat(value);
-  }).join(",");
-};
-var createGoogleCloudRunDeployJobs = function (context) {
-  var _a, _b, _c;
-  var deployConfig = context.componentConfig.deploy;
-  if (deployConfig === false) {
-    return [];
-  }
-  if (!(0, types_1.isOfDeployType)(deployConfig, "google-cloudrun")) {
-    // should not happen
-    throw new Error("deploy config is wrong");
-  }
-  var allEnvVars = (0, lodash_1.omit)(context.environment.envVars, _1.GCLOUD_DEPLOY_CREDENTIALS_KEY);
-  var commonArgs = {
-    project: deployConfig.projectId,
-    region: deployConfig.region
-  };
-  var commonDeployArgs = __assign(__assign({
-    image: (0, artifactsRegistry_1.getArtifactsRegistryImage)(context)
-  }, commonArgs), {
-    "set-cloudsql-instances": deployConfig.cloudSql ? deployConfig.cloudSql.instanceConnectionName : undefined
-  });
-  var serviceName = (0, getServiceName_1.getServiceName)(context);
-  var getFullJobName = function (name) {
-    return (0, jobName_1.getCloudRunJobName)(context.environment.fullName, name);
-  };
-  var jobsWithNames = Object.entries((_a = deployConfig.jobs) !== null && _a !== void 0 ? _a : {})
-  // filter out disabled jobs
-  .filter(function (entry) {
-    return Boolean(entry[1]);
-  }).map(function (_a) {
-    var _b = __read(_a, 2),
-      name = _b[0],
-      job = _b[1];
-    return {
-      jobName: getFullJobName(name),
-      job: job
-    };
-  });
-  var jobsWithSchedule = jobsWithNames.filter(function (entry) {
-    return entry.job.when === "schedule";
-  }).map(function (_a) {
-    var job = _a.job,
-      jobName = _a.jobName;
-    return {
-      job: job,
-      jobName: jobName,
-      schedulerName: jobName + "-scheduler"
-    };
-  });
-  var getServiceDeployScript = function (service, nameSuffix) {
-    var _a, _b, _c, _d, _e;
-    var customConfig = service !== true ? service : undefined;
-    var command = service !== true ? (_a = service === null || service === void 0 ? void 0 : service.command) !== null && _a !== void 0 ? _a : context.componentConfig.build.startCommand : undefined;
-    var commandArray = command ? Array.isArray(command) ? command : command.split(" ") : undefined;
-    var fullServiceName = "".concat(serviceName).concat(nameSuffix !== null && nameSuffix !== void 0 ? nameSuffix : "");
-    var argsString = (0, createArgsString_1.createArgsString)(__assign(__assign({
-      // command as empty string resets it to default (uses the image's entrypoint)
-      command: commandArray ? '"' + commandArray.join(",") + '"' : '""'
-    }, commonDeployArgs), {
-      labels: makeLabelString(__assign(__assign({}, (0, getLabels_1.getLabels)(context)), {
-        "cloud-run-service-name": fullServiceName
-      })),
-      "env-vars-file": "____envvars.yaml",
-      "min-instances": (_b = customConfig === null || customConfig === void 0 ? void 0 : customConfig.minInstances) !== null && _b !== void 0 ? _b : 0,
-      "max-instances": (_c = customConfig === null || customConfig === void 0 ? void 0 : customConfig.maxInstances) !== null && _c !== void 0 ? _c : 100,
-      "cpu-throttling": (customConfig === null || customConfig === void 0 ? void 0 : customConfig.noCpuThrottling) !== true,
-      memory: customConfig === null || customConfig === void 0 ? void 0 : customConfig.memory,
-      "allow-unauthenticated": (_d = customConfig === null || customConfig === void 0 ? void 0 : customConfig.allowUnauthenticated) !== null && _d !== void 0 ? _d : true,
-      ingress: (_e = customConfig === null || customConfig === void 0 ? void 0 : customConfig.ingress) !== null && _e !== void 0 ? _e : "all",
-      "cpu-boost": true
-    }));
-    return "gcloud run deploy ".concat(fullServiceName, " ").concat(argsString);
-  };
-  var getJobCreateScriptsForJob = function (jobName, job) {
-    // due to some oversight from google, jobs create does not accept `--env-vars-file` 🤦
-    // lucky, update on the other hand accepts it... so let's just imediatly update it
-    // also we cannot upsert a job, so we have to create it and catch the error and then update
-    var commandArray = Array.isArray(job.command) ? job.command : job.command.split(" ");
-    var commonDeployArgsString = (0, createArgsString_1.createArgsString)(__assign(__assign({
-      command: '"' + commandArray.join(",") + '"'
-    }, commonDeployArgs), {
-      labels: makeLabelString(__assign(__assign({}, (0, getLabels_1.getLabels)(context)), {
-        "cloud-run-job-name": jobName
-      })),
-      image: job.image || commonDeployArgs.image,
-      memory: job.memory || "512Mi",
-      "task-timeout": job.timeout || "10m"
-    }));
-    var argsString = "".concat(jobName, " ").concat(commonDeployArgsString);
-    return __spreadArray(__spreadArray([], __read((0, gitlab_1.allowFailureInScripts)(["gcloud beta run jobs create ".concat(argsString)])), false), ["gcloud beta run jobs update ".concat(argsString, " --env-vars-file=____envvars.yaml")], false);
-  };
-  var commonArgsString = (0, createArgsString_1.createArgsString)(commonArgs);
-  var getJobCreateScripts = function () {
-    return jobsWithNames.map(function (_a) {
-      var job = _a.job,
-        jobName = _a.jobName;
-      return getJobCreateScriptsForJob(jobName, job);
-    }).flat();
-  };
-  var getJobRunScriptForJob = function (jobName, wait) {
-    return "gcloud beta run jobs execute ".concat(jobName, " ").concat(commonArgsString).concat(wait ? " --wait" : "");
-  };
-  var getJobRunScripts = function (when) {
-    return jobsWithNames.filter(function (_a) {
-      var job = _a.job;
-      return job.when === when;
-    }).map(function (_a) {
-      var jobName = _a.jobName;
-      return getJobRunScriptForJob(jobName,
-      // wait for completin on stop jobs, since stop will delete the jobs afterwards, so they will fail
-      ["preStop", "postStop"].includes(when));
-    });
-  };
-  var getCreateScheduleScripts = function () {
-    return jobsWithSchedule.map(function (_a) {
-      var _b;
-      var job = _a.job,
-        jobName = _a.jobName,
-        schedulerName = _a.schedulerName;
-      var argsString = (0, createArgsString_1.createArgsString)({
-        project: deployConfig.projectId,
-        location: deployConfig.region,
-        schedule: "\"".concat(job.schedule, "\""),
-        "max-retry-attempts": (_b = job.maxRetryAttempts) !== null && _b !== void 0 ? _b : 0,
-        uri: "\"https://".concat(deployConfig.region, "-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/").concat(deployConfig.projectId, "/jobs/").concat(jobName, ":run\""),
-        "http-method": "POST",
-        "oauth-service-account-email": "$GCLOUD_PROJECT_NUMBER-compute@developer.gserviceaccount.com"
-      });
-      var commonArgs = "http ".concat(schedulerName, " ").concat(argsString);
-      return __spreadArray(__spreadArray([], __read((0, gitlab_1.allowFailureInScripts)(["gcloud scheduler jobs create ".concat(commonArgs)])), false), ["gcloud scheduler jobs update ".concat(commonArgs)], false);
-    }).flat();
-  };
-  var getDeleteSchedulesScripts = function () {
-    var argsString = (0, createArgsString_1.createArgsString)({
-      project: deployConfig.projectId,
-      location: deployConfig.region
-    });
-    return jobsWithSchedule.map(function (_a) {
-      var schedulerName = _a.schedulerName;
-      return ["gcloud scheduler jobs delete ".concat(schedulerName, " ").concat(argsString)];
-    }).flat();
-  };
-  var getDeleteJobsScripts = function () {
-    return jobsWithNames.flatMap(function (_a) {
-      var jobName = _a.jobName;
-      return [
-      // first delete all job executions. Otherwise delete might fail if one of those is still running
-      "gcloud beta run jobs executions list ".concat(commonArgsString, " --job ").concat(jobName, " --format=\"value(name)\" | xargs -I {} gcloud beta run jobs executions delete {}  --quiet ").concat(commonArgsString), "gcloud beta run jobs delete ".concat(jobName, " ").concat(commonArgsString)];
-    });
-  };
-  var deployScripts = __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, gitlab_1.collapseableSection)("prepare", "Prepare...")(__spreadArray(__spreadArray([], __read((0, gcloudServiceAccountLoginCommands_1.gcloudServiceAccountLoginCommands)(context)), false), __read(setGoogleProjectNumberScript(deployConfig)), false))), false), __read((0, gitlab_1.collapseableSection)("deploy", "Deploy to cloud run")(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(["echo \"$ENV_VARS\" > ____envvars.yaml"], __read(deployConfig.cloudSql ? (0, database_1.getDatabaseCreateScript)(context, deployConfig) // we create the db, so that we can also delete it afterwards
-  : []), false), __read(getCreateScheduleScripts()), false), __read(getJobCreateScripts()), false), __read(getJobRunScripts("preDeploy")), false), __read(deployConfig.service !== false ? [getServiceDeployScript(deployConfig.service)] : []), false), __read(Object.entries((_b = deployConfig.additionalServices) !== null && _b !== void 0 ? _b : {}).map(function (_a) {
-    var _b = __read(_a, 2),
-      name = _b[0],
-      service = _b[1];
-    return getServiceDeployScript(service, "-" + name);
-  })), false), __read(getJobRunScripts("postDeploy")), false))), false), __read((0, gitlab_1.collapseableSection)("cleanup", "Cleanup")((0, cleanup_1.getRemoveOldRevisionsAndImagesCommand)(context, "postDeploy") // we cleanup inactive images both on deploy and stop
-  )), false), __read((0, sbom_1.getDependencyTrackUploadScript)(context)), false);
-  var stopScripts = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, gcloudServiceAccountLoginCommands_1.gcloudServiceAccountLoginCommands)(context)), false), __read(getJobRunScripts("preStop")), false), __read(deployConfig.service !== false ? ["gcloud run services delete ".concat(serviceName, " ").concat(commonArgsString)] : []), false), __read(Object.entries((_c = deployConfig.additionalServices) !== null && _c !== void 0 ? _c : {}).map(function (_a) {
-    var _b = __read(_a, 1),
-      name = _b[0];
-    return "gcloud run services delete ".concat(serviceName, "-").concat(name, " ").concat(commonArgsString);
-  })), false), __read(getJobRunScripts("postStop")), false), __read(getDeleteSchedulesScripts()), false), __read(getDeleteJobsScripts()), false), __read(deployConfig.cloudSql && deployConfig.cloudSql.deleteDatabaseOnStop ? (0, database_1.getDatabaseDeleteScript)(context, deployConfig) : []), false), __read((0, cleanup_1.getRemoveOldRevisionsAndImagesCommand)(context, "onStop")), false), __read((0, sbom_1.getDependencyTrackDeleteScript)(context)), false);
-  return (0, base_1.createDeployementJobs)(context, {
-    deploy: (0, lodash_1.merge)((0, docker_1.getDockerJobBaseProps)(context), {
-      artifacts: {
-        paths: ["____envvars.yaml"]
-      },
-      variables: {
-        CLOUDSDK_CORE_DISABLE_PROMPTS: "1",
-        ENV_VARS: (0, js_yaml_1.dump)(allEnvVars, {
-          lineWidth: -1,
-          quotingType: "'",
-          forceQuotes: true
-        })
-      },
-      image: (0, runner_1.getRunnerImage)("gcloud"),
-      script: deployScripts
-    }),
-    stop: {
-      image: (0, runner_1.getRunnerImage)("gcloud"),
-      variables: {
-        CLOUDSDK_CORE_DISABLE_PROMPTS: "1"
-      },
-      script: (0, gitlab_1.allowFailureInScripts)(stopScripts)
-    }
-  });
-};
-exports.createGoogleCloudRunDeployJobs = createGoogleCloudRunDeployJobs;