@catladder/cli 0.0.0-next-5f70052e → 0.0.0-next-32b3a548

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-next-5f70052e",
+  "version": "0.0.0-next-32b3a548",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/apps/catenv/printVariables.ts

@@ -1,6 +1,6 @@
 import type { Config } from "@catladder/pipeline";
 import { getEnvVarsResolved } from "../../config/getProjectConfig";
-import type { Choice, Variables } from "./types";
+import type { Choice } from "./types";
 import {
   getCurrentComponentAndEnvFromChoice,
   makeKeyValueString,
@@ -54,5 +54,5 @@ export const printVariables = async (config: Config, choice?: Choice) => {
   console.log(makeExportKeyValuestring(variables));
 };
 
-const makeExportKeyValuestring = (variables: Variables) =>
+const makeExportKeyValuestring = (variables: Record<string, string>) =>
   makeKeyValueString(variables, "export ");

package/src/apps/catenv/types.ts

@@ -1,6 +1,6 @@
+import type { VariableValue } from "@catladder/pipeline";
+
 export type Choice = {
   env?: string;
   componentName?: string;
 };
-
-export type Variables = Record<string, string>;

package/src/apps/catenv/utils.ts

@@ -1,7 +1,8 @@
 import type { Config } from "@catladder/pipeline";
 import { join } from "path";
 import { getGitRoot } from "../../utils/projects";
-import type { Choice, Variables } from "./types";
+import type { Choice } from "./types";
+import { escapeForDotEnv } from "@catladder/pipeline";
 export const getComponentFullPath = (
   gitRoot: string,
   config: Config,
@@ -31,19 +32,14 @@ export const getCurrentComponentAndEnvFromChoice = async (
   };
 };
 
-export const makeKeyValueString = (variables: Variables, keyPrefix = "") =>
+export const makeKeyValueString = (
+  variables: Record<string, string>,
+  keyPrefix = "",
+) =>
   Object.entries(variables)
-    .map(([key, value]) => `${keyPrefix}${key}='${value}'`)
+    // quotes are important, otherwise line breaks don't work properly
+    .map(([key, value]) => `${keyPrefix}${key}=${escapeForDotEnv(value)}`)
     .join("\n");
 
-export const sanitizeMultiLine = (variables: Variables) => {
-  return Object.fromEntries(
-    Object.entries(variables).map(([key, value]) => [
-      key,
-      value.replaceAll("\n", "\\n"),
-    ]),
-  );
-};
-
 export const sanitizeEnvVarName = (name: string) =>
   name.replace(/[\s\-.]+/g, "_");

package/src/apps/catenv/writeDotEnvFiles.ts

@@ -1,5 +1,4 @@
 import { writeGeneratedFile, type Config } from "@catladder/pipeline";
-import { writeFile } from "fs-extra";
 import { join } from "path";
 import { getEnvVarsResolved } from "../../config/getProjectConfig";
 import { getGitRoot } from "../../utils/projects";
@@ -8,7 +7,6 @@ import {
   getComponentFullPath,
   getCurrentComponentAndEnvFromChoice,
   makeKeyValueString,
-  sanitizeMultiLine,
 } from "./utils";
 
 export const writeDotEnvFiles = async (config: Config, choice?: Choice) => {
@@ -33,9 +31,8 @@ export const writeDotEnvFiles = async (config: Config, choice?: Choice) => {
     delete variables["_ALL_ENV_VAR_KEYS"];
     const componentDir = getComponentFullPath(gitRoot, config, componentName);
     const filePath = join(componentDir, ".env");
-    // many .dotenv don't like multiline values, so we sanitize them here
-    const variablesSanitized = sanitizeMultiLine(variables);
-    await writeGeneratedFile(filePath, makeKeyValueString(variablesSanitized), {
+
+    await writeGeneratedFile(filePath, makeKeyValueString(variables), {
       commentChar: "#",
     });
   }

package/src/apps/cli/commands/project/cloudSql/commandProjectRestoreDb.ts

@@ -65,7 +65,9 @@ export default async (vorpal: Vorpal) =>
           hosts: [],
         });
 
-        const parsersResult = parser.parse(sourceEnvVars.DATABASE_URL);
+        const parsersResult = parser.parse(
+          sourceEnvVars.DATABASE_URL.toString(),
+        );
         sourcePort = parsersResult.hosts?.[0]?.port;
         sourceUsername = parsersResult.username;
         sourcePassword = parsersResult.password;
@@ -73,13 +75,14 @@ export default async (vorpal: Vorpal) =>
       } else {
         sourcePort = 54399;
         sourceProxy = await startCloudSqlProxyInBackground({
-          instanceName: sourceEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME,
+          instanceName:
+            sourceEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME.toString(),
           localPort: sourcePort,
         });
 
-        sourceUsername = sourceEnvVars.DB_USER;
-        sourcePassword = sourceEnvVars.DB_PASSWORD;
-        sourceDbName = sourceEnvVars.DB_NAME;
+        sourceUsername = sourceEnvVars.DB_USER.toString();
+        sourcePassword = sourceEnvVars.DB_PASSWORD.toString();
+        sourceDbName = sourceEnvVars.DB_NAME?.toString();
       }
 
       const { targetEnvAndComponent } = await this.prompt({
@@ -109,7 +112,9 @@ export default async (vorpal: Vorpal) =>
           hosts: [],
         });
 
-        const parsersResult = parser.parse(targetEnvVars.DATABASE_URL);
+        const parsersResult = parser.parse(
+          targetEnvVars.DATABASE_URL.toString(),
+        );
 
         targetPort = parsersResult.hosts?.[0]?.port;
         targetUsername = parsersResult.username;
@@ -118,13 +123,14 @@ export default async (vorpal: Vorpal) =>
       } else {
         targetPort = 54499;
         targetProxy = await startCloudSqlProxyInBackground({
-          instanceName: targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME,
+          instanceName:
+            targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME.toString(),
           localPort: targetPort,
         });
 
-        targetUsername = targetEnvVars.DB_USER;
-        targetPassword = targetEnvVars.DB_PASSWORD;
-        targetDbName = targetEnvVars.DB_NAME;
+        targetUsername = targetEnvVars.DB_USER.toString();
+        targetPassword = targetEnvVars.DB_PASSWORD.toString();
+        targetDbName = targetEnvVars.DB_NAME.toString();
       }
 
       const { shouldContinue } = await this.prompt({

package/src/apps/cli/commands/project/commandCloudSqlProxy.ts

@@ -87,7 +87,9 @@ const getProxyInfoForKubernetes = async (
   // bit hacky, would be nicer if we would also declare this through env vars
   const cloudSqlValues = createKubernetesCloudsqlBaseValues(context);
 
-  const DB_PASSWORD = envVars?.DB_PASSWORD || envVars?.POSTGRESQL_PASSWORD;
+  const DB_PASSWORD = (
+    envVars?.DB_PASSWORD || envVars?.POSTGRESQL_PASSWORD
+  )?.toString();
 
   const DB_NAME = cloudSqlValues.cloudsql.fullDbName.toString();
 
@@ -114,8 +116,8 @@ const getProxyInfoForCloudRun = async (
 
   const envVars = await getEnvVarsResolved(vorpal, context.env, context.name);
 
-  const DB_PASSWORD = envVars?.DB_PASSWORD;
-  const DB_USER = envVars?.DB_USER;
+  const DB_PASSWORD = envVars?.DB_PASSWORD?.toString();
+  const DB_USER = envVars?.DB_USER?.toString();
 
   const DB_NAME = context.environment.envVars.DB_NAME.toString();
 

package/src/config/getProjectConfig.ts

@@ -1,4 +1,8 @@
-import type { Config, EnvironmentEnvVars } from "@catladder/pipeline";
+import type {
+  Config,
+  EnvironmentEnvVars,
+  VariableValue,
+} from "@catladder/pipeline";
 import {
   readConfig,
   getAllEnvs,

package/dist/pipeline/src/bash/replaceAsync.d.ts

@@ -1,2 +0,0 @@
-import { BashExpression } from "./BashExpression";
-export default function replaceAsync(string: string | BashExpression, searchValue: any, replacer: (substring: string, ...args: any[]) => Promise<string | BashExpression>): Promise<any>;

package/dist/pipeline/src/bash/replaceAsync.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const BashExpression_1 = require("./BashExpression");
-// from https://github.com/dsblv/string-replace-async/blob/main/index.js
-// and adjusted a bit
-async function replaceAsync(string, searchValue, replacer) {
-    const wasBashExpression = string instanceof BashExpression_1.BashExpression;
-    try {
-        // 1. Run fake pass of `replace`, collect values from `replacer` calls
-        // 2. Resolve them with `Promise.all`
-        // 3. Run `replace` with resolved values
-        const values = [];
-        String.prototype.replace.call(string instanceof BashExpression_1.BashExpression ? string : (0, BashExpression_1.bashEscape)(string), searchValue, function (...args) {
-            // eslint-disable-next-line prefer-spread
-            const result = replacer.apply(undefined, args);
-            values.push(result);
-            return "";
-        });
-        const resolvedValues = await Promise.all(values);
-        const containsBashExpression = resolvedValues.some((value) => value instanceof BashExpression_1.BashExpression);
-        const result = (string instanceof BashExpression_1.BashExpression ? string : (0, BashExpression_1.bashEscape)(string)).replace(searchValue, function () {
-            var _a, _b;
-            return (_b = (_a = resolvedValues.shift()) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "";
-        });
-        if (wasBashExpression || containsBashExpression) {
-            return new BashExpression_1.BashExpression(result);
-        }
-        else {
-            return result;
-        }
-    }
-    catch (error) {
-        return Promise.reject(error);
-    }
-}
-exports.default = replaceAsync;
-//# sourceMappingURL=replaceAsync.js.map

package/dist/pipeline/src/bash/replaceAsync.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"replaceAsync.js","sourceRoot":"","sources":["../../../../../pipeline/src/bash/replaceAsync.ts"],"names":[],"mappings":";;AAAA,qDAA8D;AAE9D,wEAAwE;AACxE,qBAAqB;AACN,KAAK,UAAU,YAAY,CACxC,MAA+B,EAC/B,WAAgB,EAChB,QAGqC;IAErC,MAAM,iBAAiB,GAAG,MAAM,YAAY,+BAAc,CAAC;IAE3D,IAAI,CAAC;QACH,sEAAsE;QACtE,qCAAqC;QACrC,wCAAwC;QACxC,MAAM,MAAM,GAA4C,EAAE,CAAC;QAC3D,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAC3B,MAAM,YAAY,+BAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,2BAAU,EAAC,MAAM,CAAC,EAC9D,WAAW,EACX,UAAU,GAAG,IAAI;YACf,yCAAyC;YACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC,CACF,CAAC;QACF,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEjD,MAAM,sBAAsB,GAAG,cAAc,CAAC,IAAI,CAChD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,YAAY,+BAAc,CAC3C,CAAC;QACF,MAAM,MAAM,GAAG,CACb,MAAM,YAAY,+BAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,2BAAU,EAAC,MAAM,CAAC,CAC/D,CAAC,OAAO,CAAC,WAAW,EAAE;;YACrB,OAAO,MAAA,MAAA,cAAc,CAAC,KAAK,EAAE,0CAAE,QAAQ,EAAE,mCAAI,EAAE,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,IAAI,iBAAiB,IAAI,sBAAsB,EAAE,CAAC;YAChD,OAAO,IAAI,+BAAc,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC;AA5CD,+BA4CC"}

package/dist/pipeline/src/context/resolveReferences.d.ts

@@ -1,3 +0,0 @@
-import type { BashExpression } from "../bash/BashExpression";
-import type { UnspecifiedEnvVars } from "..";
-export declare const resolveReferences: (vars: Record<string, string | BashExpression | undefined | null>, getOtherVariables?: (componentName: string, alreadyVisited: Record<string, Record<string, boolean>>) => Promise<UnspecifiedEnvVars>, alreadyVisitedBase?: Record<string, Record<string, boolean>>) => Promise<Record<string, BashExpression>>;

package/dist/pipeline/src/context/resolveReferences.js

@@ -1,56 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveReferences = void 0;
-const lodash_1 = require("lodash");
-const replaceAsync_1 = __importDefault(require("../bash/replaceAsync"));
-// regex to resolve references in catladder variables
-// those expressions have the pattern ${componentName:variableName}
-const REGEX = /\$\{(([^:}]+):)?([^}]+)}/gm;
-const resolveReferences = async (vars, getOtherVariables, alreadyVisitedBase = {}) => {
-    /**
-     *
-     * replace referenced variables with their values in a value string
-     */
-    const replaceSingleValue = async (value, alreadyVisited = alreadyVisitedBase) => {
-        if (REGEX.test(value.toString())) {
-            // we consider variables that got references in it  BashExpressions, because the replacement may be one
-            return await (0, replaceAsync_1.default)(value, REGEX, async (match, _, componentName, variableName) => {
-                var _a, _b;
-                if ((_a = alreadyVisited[componentName]) === null || _a === void 0 ? void 0 : _a[variableName]) {
-                    return match; // prevent endless loop
-                }
-                const newAlreadyVisited = (0, lodash_1.merge)({}, alreadyVisited, {
-                    [componentName]: {
-                        [variableName]: true,
-                    },
-                });
-                const result = componentName
-                    ? (_b = (await (getOtherVariables === null || getOtherVariables === void 0 ? void 0 : getOtherVariables(componentName, newAlreadyVisited).then((r) => r === null || r === void 0 ? void 0 : r[variableName])))) !== null && _b !== void 0 ? _b : null
-                    : vars[variableName]; // is self reference
-                const replaced = result !== null && result !== undefined
-                    ? await replaceSingleValue(result, newAlreadyVisited)
-                    : match;
-                return replaced;
-            });
-        }
-        else {
-            return value;
-        }
-    };
-    return Object.fromEntries(await Promise.all(Object.entries(vars).map(async ([key, value]) => {
-        if (value === null || value === undefined) {
-            return [key, null];
-        }
-        return [
-            key,
-            value !== null && value !== undefined
-                ? await replaceSingleValue(value)
-                : null,
-        ];
-    })));
-};
-exports.resolveReferences = resolveReferences;
-//# sourceMappingURL=resolveReferences.js.map

package/dist/pipeline/src/context/resolveReferences.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolveReferences.js","sourceRoot":"","sources":["../../../../../pipeline/src/context/resolveReferences.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA+B;AAG/B,wEAAgD;AAGhD,qDAAqD;AACrD,mEAAmE;AACnE,MAAM,KAAK,GAAG,4BAA4B,CAAC;AAEpC,MAAM,iBAAiB,GAAG,KAAK,EACpC,IAAgE,EAChE,iBAGgC,EAChC,qBAA8D,EAAE,EAChE,EAAE;IACF;;;OAGG;IACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,KAA8B,EAC9B,iBAGI,kBAAkB,EACY,EAAE;QACpC,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACjC,uGAAuG;YAEvG,OAAO,MAAM,IAAA,sBAAY,EACvB,KAAK,EACL,KAAK,EACL,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE,EAAE;;gBAC9C,IAAI,MAAA,cAAc,CAAC,aAAa,CAAC,0CAAG,YAAY,CAAC,EAAE,CAAC;oBAClD,OAAO,KAAK,CAAC,CAAC,uBAAuB;gBACvC,CAAC;gBACD,MAAM,iBAAiB,GAAG,IAAA,cAAK,EAAC,EAAE,EAAE,cAAc,EAAE;oBAClD,CAAC,aAAa,CAAC,EAAE;wBACf,CAAC,YAAY,CAAC,EAAE,IAAI;qBACrB;iBACF,CAAC,CAAC;gBACH,MAAM,MAAM,GAAG,aAAa;oBAC1B,CAAC,CAAC,MAAA,CAAC,MAAM,CAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,aAAa,EAAE,iBAAiB,EAAE,IAAI,CAC/D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,YAAY,CAAC,CACzB,CAAA,CAAC,mCAAI,IAAI;oBACZ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB;gBAE5C,MAAM,QAAQ,GACZ,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;oBACrC,CAAC,CAAC,MAAM,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,CAAC;oBACrD,CAAC,CAAC,KAAK,CAAC;gBAEZ,OAAO,QAAQ,CAAC;YAClB,CAAC,CACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrB,CAAC;QAED,OAAO;YACL,GAAG;YACH,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;gBACnC,CAAC,CAAC,MAAM,kBAAkB,CAAC,KAAK,CAAC;gBACjC,CAAC,CAAC,IAAI;SACT,CAAC;IACJ,CAAC,CAAC,CACH,CACgC,CAAC;AACtC,CAAC,CAAC;AArEW,QAAA,iBAAiB,qBAqE5B"}