@catladder/pipeline 1.59.0 → 1.60.0

package/dist/constants.js

@@ -2,5 +2,5 @@
 
 exports.__esModule = true;
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v1-59-0-e967002c" || "";
+exports.PIPELINE_IMAGE_TAG = "v1-60-0-3b922c26" || "";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "";

package/dist/deploy/cloudRun/deployJob.js

@@ -56,10 +56,12 @@ var types_1 = require("../types");
 
 var gcloudServiceAccountLoginCommands_1 = require("./utils/gcloudServiceAccountLoginCommands");
 
+var database_1 = require("./utils/database");
+
 var gitlab_1 = require("../../utils/gitlab");
 
 var createGoogleCloudRunDeployJobs = function (context) {
-  var _a, _b;
+  var _a;
 
   var deployConfig = context.componentConfig.deploy;
 
@@ -88,7 +90,8 @@ var createGoogleCloudRunDeployJobs = function (context) {
     return "".concat(key, "=").concat(value);
   }).join(",");
   var commonArgs = "--project ".concat(deployConfig.projectId, " --region=").concat(deployConfig.region);
-  var commonDeployArgs = "--image ".concat(gcloudImageName, " ").concat(commonArgs, " --labels ").concat(labelsString);
+  var cloudRunArgs = deployConfig.cloudSql ? "--set-cloudsql-instances=".concat(deployConfig.cloudSql.instanceConnectionName) : "";
+  var commonDeployArgs = "--image ".concat(gcloudImageName, " ").concat(commonArgs, " ").concat(cloudRunArgs, " --labels ").concat(labelsString);
   var serviceName = context.environment.fullName.toLowerCase();
 
   var getServiceDeployScript = function (service) {
@@ -103,7 +106,7 @@ var createGoogleCloudRunDeployJobs = function (context) {
     // 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 args = "".concat(jobName, " --command=\"").concat(job.command.split(" ").join(","), "\" ").concat(commonDeployArgs);
+    var args = "".concat(jobName, " --command=\"").concat(job.command.split(" ").join(","), "\" ").concat(commonDeployArgs, " --memory=").concat(job.memory || "512Mi");
     return __spreadArray(__spreadArray([], __read((0, gitlab_1.allowFailureInScripts)(["gcloud beta run jobs create ".concat(args)])), false), ["gcloud beta run jobs update ".concat(args, " --env-vars-file=____envvars.yaml")], false);
   };
 
@@ -112,10 +115,13 @@ var createGoogleCloudRunDeployJobs = function (context) {
   };
 
   var getFullJobName = function (name) {
-    return context.environment.fullName.toLowerCase() + "-" + name;
+    return context.environment.fullName.toLowerCase() + "-" + name.toLowerCase();
   };
 
-  var jobsWithNames = Object.entries((_a = deployConfig.jobs) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
+  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];
@@ -123,7 +129,8 @@ var createGoogleCloudRunDeployJobs = function (context) {
     return [getFullJobName(name), job];
   });
 
-  var cloudRunDeployScripts = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(["echo \"$ENV_VARS\" > ____envvars.yaml", "cat ____envvars.yaml"], __read(jobsWithNames.map(function (_a) {
+  var cloudRunDeployScripts = __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(jobsWithNames.map(function (_a) {
     var _b = __read(_a, 2),
         name = _b[0],
         job = _b[1];
@@ -131,37 +138,32 @@ var createGoogleCloudRunDeployJobs = function (context) {
     return getJobCreateScripts(name, job);
   }).flat()), false), __read(jobsWithNames.filter(function (_a) {
     var _b = __read(_a, 2),
-        name = _b[0],
         job = _b[1];
 
     return job.when === "preDeploy";
   }).map(function (_a) {
-    var _b = __read(_a, 2),
-        name = _b[0],
-        job = _b[1];
+    var _b = __read(_a, 1),
+        name = _b[0];
 
     return getJobRunScript(name);
   })), false), __read(deployConfig.service !== false ? [getServiceDeployScript(deployConfig.service)] : []), false), __read(jobsWithNames.filter(function (_a) {
     var _b = __read(_a, 2),
-        name = _b[0],
         job = _b[1];
 
     return job.when === "postDeploy";
   }).map(function (_a) {
-    var _b = __read(_a, 2),
-        name = _b[0],
-        job = _b[1];
+    var _b = __read(_a, 1),
+        name = _b[0];
 
     return getJobRunScript(name);
   })), false), ["docker image rm ".concat(gcloudImageName)], false);
 
-  var cloudRunStopScripts = __spreadArray(__spreadArray([], __read(deployConfig.service !== false ? ["gcloud run services delete ".concat(serviceName, " ").concat(commonArgs)] : []), false), __read(Object.entries((_b = deployConfig.jobs) !== null && _b !== void 0 ? _b : {}).map(function (_a) {
-    var _b = __read(_a, 2),
-        name = _b[0],
-        job = _b[1];
+  var cloudRunStopScripts = __spreadArray(__spreadArray(__spreadArray([], __read(deployConfig.service !== false ? ["gcloud run services delete ".concat(serviceName, " ").concat(commonArgs)] : []), false), __read(jobsWithNames.map(function (_a) {
+    var _b = __read(_a, 1),
+        name = _b[0];
 
-    return "gcloud beta run jobs delete ".concat(getJobRunScript(name), " ").concat(commonArgs);
-  })), false);
+    return "gcloud beta run jobs delete ".concat(name, " ").concat(commonArgs);
+  })), false), __read(deployConfig.cloudSql && deployConfig.cloudSql.deleteDatabaseOnStop ? (0, database_1.getDatabaseDeleteScript)(context, deployConfig) : []), false);
 
   var baseStopJob = (0, base_1.getBaseDeploymentStopJob)(context);
   return [(0, lodash_1.merge)({}, baseDeploymentJob, (0, docker_1.getDockerJobBaseProps)(context), {

package/dist/deploy/cloudRun/index.js

@@ -39,22 +39,69 @@ var __read = this && this.__read || function (o, n) {
   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.GCLOUD_RUN_DEPLOY_TYPE = exports.GCLOUD_RUN_CANONICAL_HOST_SUFFIX = exports.GCLOUD_DEPLOY_CREDENTIALS_KEY = void 0;
 
 var context_1 = require("../../context");
 
+var gitlab_1 = require("../../utils/gitlab");
+
 var deployJob_1 = require("./deployJob");
 
 exports.GCLOUD_DEPLOY_CREDENTIALS_KEY = "GCLOUD_DEPLOY_credentialsKey";
 exports.GCLOUD_RUN_CANONICAL_HOST_SUFFIX = "GCLOUD_RUN_canonicalHostSuffix";
+
+var getCloudSqlVariables = function (_a) {
+  var _b;
+
+  var deployConfigRaw = _a.deployConfigRaw,
+      environmentSlug = _a.environmentSlug,
+      env = _a.env,
+      componentName = _a.componentName,
+      fullConfig = _a.fullConfig;
+
+  if (deployConfigRaw && deployConfigRaw.cloudSql) {
+    var DB_NAME = [(_b = deployConfigRaw.cloudSql.dbNamePrefix) !== null && _b !== void 0 ? _b : "".concat(fullConfig.customerName, "-").concat(fullConfig.appName), environmentSlug].filter(Boolean).join("-");
+    return {
+      CLOUD_SQL_INSTANCE_CONNECTION_NAME: deployConfigRaw.cloudSql.instanceConnectionName,
+      DB_NAME: DB_NAME,
+      DB_USER: "postgres",
+      DB_PASSWORD: "$" + (0, context_1.getSecretVarName)(env, componentName, "DB_PASSWORD"),
+      DATABASE_URL: "postgresql://$DB_USER:$DB_PASSWORD@localhost/$DB_NAME?host=/cloudsql/$CLOUD_SQL_INSTANCE_CONNECTION_NAME"
+    };
+  }
+
+  return {};
+};
+
 exports.GCLOUD_RUN_DEPLOY_TYPE = {
   jobs: deployJob_1.createGoogleCloudRunDeployJobs,
-  defaults: function () {
+  defaults: function (_a) {
+    var deployConfigRaw = _a.deployConfigRaw,
+        envType = _a.envType;
+
+    if (deployConfigRaw && deployConfigRaw.cloudSql) {
+      return {
+        cloudSql: {
+          deleteDatabaseOnStop: envType === "review"
+        }
+      };
+    }
+
     return {};
   },
-  additionalSecretKeys: function () {
-    return [exports.GCLOUD_DEPLOY_CREDENTIALS_KEY];
+  additionalSecretKeys: function (ctx) {
+    return __spreadArray([exports.GCLOUD_DEPLOY_CREDENTIALS_KEY], __read(ctx.deployConfigRaw && ctx.deployConfigRaw.cloudSql ? ["DB_PASSWORD"] : []), false);
   },
   getAdditionalEnvVars: function (ctx) {
     var fullName = ctx.fullName,
@@ -67,10 +114,10 @@ exports.GCLOUD_RUN_DEPLOY_TYPE = {
           name = _b[0],
           job = _b[1];
 
-      return ["CLOUD_RUN_JOB_TRIGGER_URL_" + name, "https://".concat(deployConfigRaw.region, "-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/").concat(deployConfigRaw.projectId, "/jobs/").concat(name, ":run")];
+      return ["CLOUD_RUN_JOB_TRIGGER_URL_" + (0, gitlab_1.sanitizeForBashVariable)(name), "https://".concat(deployConfigRaw.region, "-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/").concat(deployConfigRaw.projectId, "/jobs/").concat(name, ":run")];
     })) : {};
-    return __assign({
+    return __assign(__assign({
       HOST_CANONICAL: HOST_CANONICAL
-    }, jobTriggers);
+    }, getCloudSqlVariables(ctx)), jobTriggers);
   }
 };

package/dist/deploy/cloudRun/utils/database.d.ts

@@ -0,0 +1,4 @@
+import type { Context } from "../../../types";
+import type { DeployConfigCloudRun } from "../../types";
+export declare const getDatabaseDeleteScript: (context: Context, deployConfig: DeployConfigCloudRun) => string[];
+export declare const getDatabaseCreateScript: (context: Context, deployConfig: DeployConfigCloudRun) => string[];

package/dist/deploy/cloudRun/utils/database.js

@@ -0,0 +1,82 @@
+"use strict";
+
+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;
+};
+
+exports.__esModule = true;
+exports.getDatabaseCreateScript = exports.getDatabaseDeleteScript = void 0;
+
+var gitlab_1 = require("../../../utils/gitlab");
+
+var getDatabaseDeleteScript = function (context, deployConfig) {
+  var _a;
+
+  if (!deployConfig.cloudSql || !deployConfig.cloudSql.deleteDatabaseOnStop) {
+    throw new Error("not possible");
+  }
+
+  var DB_NAME = ((_a = context.environment.envVars) !== null && _a !== void 0 ? _a : {}).DB_NAME;
+
+  if (!DB_NAME) {
+    throw new Error("error: env vars did not specify DB_NAME");
+  }
+
+  var _b = __read(deployConfig.cloudSql.instanceConnectionName.split(":"), 3),
+      projectId = _b[0],
+      region = _b[1],
+      instanceId = _b[2]; // unfortunatly the database cannot be deleted right after the service has stopped, as it might still have connections
+  // we have to repeate this process
+
+
+  return ["echo \"deleting database ".concat(DB_NAME, "...\""), "echo \"\uD83D\uDC46 this can take multiple attemps (3-5min), because google cloud run may still have a connection to the database after the cloud run service is shut down\"", (0, gitlab_1.repeatOnFailure)("gcloud sql databases delete ".concat(DB_NAME, " --instance=").concat(instanceId, " --project ").concat(projectId), {
+    pauseInSeconds: 10
+  })];
+};
+
+exports.getDatabaseDeleteScript = getDatabaseDeleteScript;
+
+var getDatabaseCreateScript = function (context, deployConfig) {
+  var _a;
+
+  if (!deployConfig.cloudSql) {
+    throw new Error("not possible");
+  }
+
+  var DB_NAME = ((_a = context.environment.envVars) !== null && _a !== void 0 ? _a : {}).DB_NAME;
+
+  if (!DB_NAME) {
+    throw new Error("error: env vars did not specify DB_NAME");
+  }
+
+  var _b = __read(deployConfig.cloudSql.instanceConnectionName.split(":"), 3),
+      projectId = _b[0],
+      region = _b[1],
+      instanceId = _b[2]; // may fail if it already exists
+
+
+  return (0, gitlab_1.allowFailureInScripts)(["echo \"ensuring Database...\"", "gcloud sql databases create ".concat(DB_NAME, " --instance=").concat(instanceId, " --project ").concat(projectId)]);
+};
+
+exports.getDatabaseCreateScript = getDatabaseCreateScript;

package/dist/deploy/index.d.ts

@@ -1,15 +1,16 @@
 import type { Context } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 import type { CatladderJob } from "../types/jobs";
+import type { PartialDeep } from "../types/utils";
 import type { DeployConfigGeneric, DeployConfigType } from "./types";
 export * from "./cloudRun";
-export * from "./cloudSql";
+export * from "./kubernetes/cloudSql";
 export * from "./kubernetes";
 export * from "./types";
 export * from "./utils";
 export declare type DeployTypeDefinition<T extends DeployConfigType> = {
   jobs: (context: Context) => CatladderJob[];
-  defaults: (envContext: EnvironmentContext<any, T>) => Partial<DeployConfigGeneric<T>>;
+  defaults: (envContext: EnvironmentContext<any, T>) => PartialDeep<DeployConfigGeneric<T>>;
   additionalSecretKeys: (envContext: EnvironmentContext<any, T>) => string[];
   getAdditionalEnvVars: (envContext: EnvironmentContext<any, T>) => Record<string, string | undefined | null>;
 };

package/dist/deploy/index.js

@@ -30,7 +30,7 @@ var kubernetes_1 = require("./kubernetes");
 
 __exportStar(require("./cloudRun"), exports);
 
-__exportStar(require("./cloudSql"), exports);
+__exportStar(require("./kubernetes/cloudSql"), exports);
 
 __exportStar(require("./kubernetes"), exports);
 

package/dist/deploy/kubernetes/cloudSql/index.d.ts

@@ -0,0 +1,8 @@
+import type { Context } from "../../../types";
+export declare const hasKubernetesCloudSQL: (context: Context) => boolean | undefined;
+export declare const getKubernetesCloudSQLConfig: (context: Context) => {
+  enabled: boolean;
+  instanceId?: string | undefined;
+  projectId?: string | undefined;
+  region?: string | undefined;
+} | undefined;

package/dist/deploy/{cloudSql → kubernetes/cloudSql}/index.js

@@ -1,11 +1,11 @@
 "use strict";
 
 exports.__esModule = true;
-exports.getCloudSQLConfig = exports.hasCloudSQL = void 0;
+exports.getKubernetesCloudSQLConfig = exports.hasKubernetesCloudSQL = void 0;
 
-var types_1 = require("../types");
+var types_1 = require("../../types");
 
-var hasCloudSQL = function (context) {
+var hasKubernetesCloudSQL = function (context) {
   var _a, _b;
 
   if ((0, types_1.isOfDeployType)(context.componentConfig.deploy, "kubernetes")) {
@@ -15,9 +15,9 @@ var hasCloudSQL = function (context) {
   return false;
 };
 
-exports.hasCloudSQL = hasCloudSQL;
+exports.hasKubernetesCloudSQL = hasKubernetesCloudSQL;
 
-var getCloudSQLConfig = function (context) {
+var getKubernetesCloudSQLConfig = function (context) {
   var _a;
 
   if ((0, types_1.isOfDeployType)(context.componentConfig.deploy, "kubernetes")) {
@@ -27,4 +27,4 @@ var getCloudSQLConfig = function (context) {
   throw new Error("cannot get cloud sql config");
 };
 
-exports.getCloudSQLConfig = getCloudSQLConfig;
+exports.getKubernetesCloudSQLConfig = getKubernetesCloudSQLConfig;

package/dist/deploy/kubernetes/kubeValues.js

@@ -18,7 +18,7 @@ var lodash_1 = require("lodash");
 
 var utils_1 = require("../../utils");
 
-var cloudSql_1 = require("../cloudSql");
+var cloudSql_1 = require("./cloudSql");
 
 var types_1 = require("../types");
 
@@ -88,7 +88,7 @@ var createKubeValues = function (context) {
   var defaultKubeValues = (0, lodash_1.merge)({
     env: env,
     application: createAppConfig(context, application)
-  }, (0, cloudSql_1.hasCloudSQL)(context) ? (0, cloudsql_1.createCloudsqlBaseConfig)(context) : {}, ((_b = (_a = deployConfig.values) === null || _a === void 0 ? void 0 : _a.mongodb) === null || _b === void 0 ? void 0 : _b.enabled) ? (0, mongodb_1.createMongodbBaseConfig)(context) : {});
+  }, (0, cloudSql_1.hasKubernetesCloudSQL)(context) ? (0, cloudsql_1.createCloudsqlBaseConfig)(context) : {}, ((_b = (_a = deployConfig.values) === null || _a === void 0 ? void 0 : _a.mongodb) === null || _b === void 0 ? void 0 : _b.enabled) ? (0, mongodb_1.createMongodbBaseConfig)(context) : {});
   var kubeValues = (0, processSecretsAsFiles_1.processSecretsAsFiles)((0, utils_1.mergeWithMergingArrays)(defaultKubeValues, rest));
   return kubeValues;
 };

package/dist/deploy/types/googleCloudRun.d.ts

@@ -1,5 +1,22 @@
 import type { DeployConfigBase } from "./base";
 export declare type Gcloudregion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-southwest1" | "europe-west1" | "europe-west4" | "europe-west8" | "europe-west9" | "me-west1" | "us-central1" | "us-east1" | "us-east4" | "us-east5" | "us-south1" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "asia-south2" | "australia-southeast1" | "australia-southeast2" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "northamerica-northeast2" | "southamerica-east1" | "southamerica-west1" | "us-west2" | "us-west3" | "us-west4";
+export declare type DeployConfigCloudRunCloudSql = {
+  type: "unmanaged";
+  instanceConnectionName: string;
+  /**
+   * the prefix of the database, the full db name is this plus the environment slug
+   *
+   * defaults to customerName-appName
+   */
+
+  dbNamePrefix?: string | false;
+  /**
+   * whether to delete the database if the environment is stopped
+   * defaults to true for review envs, to false for every other environment
+   */
+
+  deleteDatabaseOnStop?: boolean;
+};
 export declare type DeployConfigCloudRunService = {
   /**
    * command / entrypoint, fallsback to buildConfig.startcommand
@@ -12,6 +29,11 @@ export declare type DeployConfigCloudRunJob = {
    */
   command: string;
   when: "manual" | "preDeploy" | "postDeploy";
+  /**
+   * memory limit of the job, defaults to 51Mi
+   */
+
+  memory?: `${number}${"M" | "G" | "Mi" | "Gi"}`;
 };
 export declare type DeployConfigCloudRun = {
   /**
@@ -38,6 +60,11 @@ export declare type DeployConfigCloudRun = {
 
   service?: boolean | DeployConfigCloudRunService;
   jobs?: {
-    [name: string]: DeployConfigCloudRunJob;
+    [name: string]: DeployConfigCloudRunJob | false | null;
   };
+  /**
+   * add cloudSql
+   */
+
+  cloudSql?: DeployConfigCloudRunCloudSql | false;
 } & DeployConfigBase;