@catladder/pipeline 3.9.3 → 3.10.0

package/dist/constants.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v3-9-3-1d2f2148" || "latest";
+exports.PIPELINE_IMAGE_TAG = "v3-10-0-58aa7394" || "latest";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "git.panter.ch:5001/catladder/catladder";

package/dist/deploy/cloudRun/index.js

@@ -56,7 +56,7 @@ exports.GCLOUD_DEPLOY_CREDENTIALS_KEY = "GCLOUD_DEPLOY_credentialsKey";
 // FIXME: rename to internalHostSuffix, but this means that project-setup needs to be rerun, so its kindof a breaking change
 exports.GCLOUD_RUN_CANONICAL_HOST_SUFFIX = "GCLOUD_RUN_canonicalHostSuffix";
 var getCloudSqlVariables = function (_a) {
-  var _b, _c;
+  var _b, _c, _d;
   var deployConfigRaw = _a.deployConfigRaw,
     environmentSlugPrefix = _a.environmentSlugPrefix,
     env = _a.env,
@@ -70,14 +70,16 @@ var getCloudSqlVariables = function (_a) {
         value = _b[1];
       return "&".concat(key, "=").concat(value);
     }).join("");
-    return {
+    var dbVars = {
       CLOUD_SQL_INSTANCE_CONNECTION_NAME: deployConfigRaw.cloudSql.instanceConnectionName,
       DB_NAME: DB_NAME,
       DB_USER: (_c = deployConfigRaw.cloudSql.dbUser) !== null && _c !== void 0 ? _c : "postgres",
-      DB_PASSWORD: "$" + (0, context_1.getSecretVarName)(env, componentName, "DB_PASSWORD"),
-      DATABASE_URL: "".concat((0, database_1.getDatabaseConnectionString)(deployConfigRaw.cloudSql)).concat(additionalQueryParamsString),
-      DATABASE_JDBC_URL: database_1.DATABASE_JDBC_URL
+      DB_PASSWORD: "$" + (0, context_1.getSecretVarName)(env, componentName, "DB_PASSWORD")
     };
+    return __assign(__assign({}, dbVars), {
+      DATABASE_URL: (0, database_1.getDatabaseConnectionString)(deployConfigRaw.cloudSql, dbVars).concat(additionalQueryParamsString),
+      DATABASE_JDBC_URL: (0, database_1.getDatabaseJdbcUrl)(dbVars, (_d = deployConfigRaw.cloudSql.dbConnectionStringVariablesMode) !== null && _d !== void 0 ? _d : database_1.DEFAULT_DB_VARIABLES_MODE)
+    });
   }
   return {};
 };

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

@@ -1,6 +1,25 @@
+import { type StringOrBashExpression } from "../../../bash";
 import type { ComponentContext } from "../../../types";
 import type { DeployConfigCloudRun, DeployConfigCloudRunCloudSql } from "../../types";
 export declare const getDatabaseDeleteScript: (context: ComponentContext, deployConfig: DeployConfigCloudRun) => string[];
 export declare const getDatabaseCreateScript: (context: ComponentContext, deployConfig: DeployConfigCloudRun) => string[];
-export declare const DATABASE_JDBC_URL = "jdbc:postgresql:///$DB_NAME?cloudSqlInstance=$CLOUD_SQL_INSTANCE_CONNECTION_NAME&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=$DB_USER&password=$DB_PASSWORD";
-export declare const getDatabaseConnectionString: (config: DeployConfigCloudRunCloudSql) => string;
+export type DBVariables = {
+  CLOUD_SQL_INSTANCE_CONNECTION_NAME: StringOrBashExpression;
+  DB_NAME: StringOrBashExpression;
+  DB_USER: StringOrBashExpression;
+  DB_PASSWORD: StringOrBashExpression;
+};
+/**
+ * controls how variables in the connection string are handled
+ *
+ * - legacy: variables like $DB_USER will be kept as environment variables to be replaced at runtime (default). It is not using BashExpressions as this was not the case in the past.
+ * - embedded: variables will be replaced with their actual values in the connection string
+ *
+ * We will remove the legacy mode in the future, as it is confusing. But its unclear whether its a breaking change in some edge cases
+ */
+export type DBVariablesMode = "legacy" | "embedded";
+export declare const DEFAULT_DB_VARIABLES_MODE: DBVariablesMode;
+export declare const getDatabaseJdbcUrl: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
+export declare const getRailsDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
+export declare const getPrismaDatabaseConnectionString: (variables: DBVariables, mode: DBVariablesMode) => StringOrBashExpression;
+export declare const getDatabaseConnectionString: (config: DeployConfigCloudRunCloudSql, variables: DBVariables) => StringOrBashExpression;

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

@@ -25,7 +25,8 @@ var __read = this && this.__read || function (o, n) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getDatabaseConnectionString = exports.DATABASE_JDBC_URL = exports.getDatabaseCreateScript = exports.getDatabaseDeleteScript = void 0;
+exports.getDatabaseConnectionString = exports.getPrismaDatabaseConnectionString = exports.getRailsDatabaseConnectionString = exports.getDatabaseJdbcUrl = exports.DEFAULT_DB_VARIABLES_MODE = exports.getDatabaseCreateScript = exports.getDatabaseDeleteScript = void 0;
+var bash_1 = require("../../../bash");
 var gitlab_1 = require("../../../utils/gitlab");
 var getDatabaseDeleteScript = function (context, deployConfig) {
   if (!deployConfig.cloudSql || !deployConfig.cloudSql.deleteDatabaseOnStop) {
@@ -62,16 +63,36 @@ var getDatabaseCreateScript = function (context, deployConfig) {
   return (0, gitlab_1.allowFailureInScripts)(["echo \"ensuring Database...\"", "gcloud sql databases create ".concat(DB_NAME, " --instance=").concat(instanceId, " --project ").concat(projectId)]);
 };
 exports.getDatabaseCreateScript = getDatabaseCreateScript;
-exports.DATABASE_JDBC_URL = "jdbc:postgresql:///$DB_NAME?cloudSqlInstance=$CLOUD_SQL_INSTANCE_CONNECTION_NAME&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=$DB_USER&password=$DB_PASSWORD";
-var getDatabaseConnectionString = function (config) {
+exports.DEFAULT_DB_VARIABLES_MODE = "legacy";
+var getVariableOrValue = function (key, variables, mode) {
+  return mode === "legacy" ? "$".concat(key) : variables[key];
+};
+var getDatabaseJdbcUrl = function (variables, mode) {
+  var parts = ["jdbc:postgresql:///", getVariableOrValue("DB_NAME", variables, mode), "?cloudSqlInstance=", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", variables, mode), "&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=", getVariableOrValue("DB_USER", variables, mode), "&password=", getVariableOrValue("DB_PASSWORD", variables, mode)];
+  return (0, bash_1.joinBashExpressions)(parts);
+};
+exports.getDatabaseJdbcUrl = getDatabaseJdbcUrl;
+var getRailsDatabaseConnectionString = function (variables, mode) {
+  var parts = ["postgresql://", getVariableOrValue("DB_USER", variables, mode), ":", getVariableOrValue("DB_PASSWORD", variables, mode), "@", encodeURIComponent("/cloudsql/".concat(variables.CLOUD_SQL_INSTANCE_CONNECTION_NAME)), "/", getVariableOrValue("DB_NAME", variables, mode), "?"];
+  return (0, bash_1.joinBashExpressions)(parts);
+};
+exports.getRailsDatabaseConnectionString = getRailsDatabaseConnectionString;
+var getPrismaDatabaseConnectionString = function (variables, mode) {
+  var parts = ["postgresql://", getVariableOrValue("DB_USER", variables, mode), ":", getVariableOrValue("DB_PASSWORD", variables, mode), "@localhost/", getVariableOrValue("DB_NAME", variables, mode), "?host=/cloudsql/", getVariableOrValue("CLOUD_SQL_INSTANCE_CONNECTION_NAME", variables, mode)];
+  return (0, bash_1.joinBashExpressions)(parts);
+};
+exports.getPrismaDatabaseConnectionString = getPrismaDatabaseConnectionString;
+var getDatabaseConnectionString = function (config, variables) {
+  var _a;
+  var mode = (_a = config.dbConnectionStringVariablesMode) !== null && _a !== void 0 ? _a : exports.DEFAULT_DB_VARIABLES_MODE;
   switch (config.dbConnectionStringFormat) {
     case "jdbc":
-      return exports.DATABASE_JDBC_URL;
+      return (0, exports.getDatabaseJdbcUrl)(variables, mode);
     case "rails":
-      return "postgresql://$DB_USER:$DB_PASSWORD@".concat(encodeURIComponent("/cloudsql/".concat(config.instanceConnectionName)), "/$DB_NAME?");
+      return (0, exports.getRailsDatabaseConnectionString)(variables, mode);
     default:
       // prisma
-      return "postgresql://$DB_USER:$DB_PASSWORD@localhost/$DB_NAME?host=/cloudsql/$CLOUD_SQL_INSTANCE_CONNECTION_NAME";
+      return (0, exports.getPrismaDatabaseConnectionString)(variables, mode);
   }
 };
 exports.getDatabaseConnectionString = getDatabaseConnectionString;

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

@@ -1,3 +1,4 @@
+import type { DBVariablesMode } from "../cloudRun/utils/database";
 import type { DeployConfigBase } from "./base";
 export 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 type DeployConfigCloudRunCloudSql = {
@@ -36,6 +37,15 @@ export type DeployConfigCloudRunCloudSql = {
    * defaults to prisma
    */
   dbConnectionStringFormat?: "prisma" | "rails" | "jdbc";
+  /**
+   * controls how variables in the connection string are handled
+   *
+   * - environment: variables like $DB_USER will be kept as environment variables to be replaced at runtime (default)
+   * - embedded: variables will be replaced with their actual values in the connection string
+   *
+   * @default "environment"
+   */
+  dbConnectionStringVariablesMode?: DBVariablesMode;
   /**
    * add additional query params to the database connection string
    */