@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-refactor-env-context-9e652b63

package/dist/catladder-gitlab.js

@@ -45,8 +45,7 @@ var _b = process.env,
     CI_COMMIT_BRANCH = _b.CI_COMMIT_BRANCH,
     CI_DEFAULT_BRANCH = _b.CI_DEFAULT_BRANCH;
 var isDefaultBranch = Boolean(CI_DEFAULT_BRANCH) && CI_COMMIT_BRANCH === CI_DEFAULT_BRANCH;
-var isHotfixBranch = false; // TODO:  $CI_COMMIT_BRANCH =~ /^[0-9]+\.([0-9]+|x)\.x$/
-
+var isHotfixBranch = CI_COMMIT_BRANCH ? /^[0-9]+\.([0-9]+|x)\.x$/.test(CI_COMMIT_BRANCH) : false;
 var isMergeRequest = Boolean(CI_MERGE_REQUEST_ID);
 var isTaggedRelease = Boolean(CI_COMMIT_TAG);
 console.info("catladder version ".concat(constants_1.PIPELINE_IMAGE_TAG));

package/dist/config/configruedEnvs.d.ts

@@ -1,4 +1,4 @@
-import { Config, PipelineTrigger } from "../types";
+import type { Config, PipelineTrigger } from "../types";
 export declare const getAllEnvs: (config: Config, componentName: string) => string[];
 export declare const getAllEnvsInAllComponents: (config: Config) => string[];
 export declare const getAllEnvsByTrigger: (config: Config, componentName: string, trigger: PipelineTrigger) => string[];

package/dist/config/readConfig.d.ts

@@ -1,4 +1,4 @@
-import { Config } from "../types";
+import type { Config } from "../types";
 export declare const readConfigSync: (directory?: string) => {
   config: Config;
   path: string;

package/dist/constants.js

@@ -2,5 +2,5 @@
 
 exports.__esModule = true;
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "node16-ddfae617" || "";
+exports.PIPELINE_IMAGE_TAG = "refactor-env-context-9e652b63" || "";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "";

package/dist/context/getEnvConfig.d.ts

@@ -0,0 +1,9 @@
+import type { Config } from "../types/config";
+export declare const getEnvConfig: (config: Config, componentName: string, env: string) => {
+  env?: import("../types/config").Env | undefined;
+  dir: string;
+  customJobs?: import("../types/jobs").CatladderJob<"test" | "stop" | "setup" | "build" | "deploy" | "verify" | "rollback">[] | ((context: import("..").Context) => import("../types/jobs").CatladderJob<"test" | "stop" | "setup" | "build" | "deploy" | "verify" | "rollback">[]) | undefined;
+} & import("../types/config").DefaultEnvConfig & {
+  type?: "dev" | "review" | "stage" | "prod" | "local" | undefined;
+  host?: string | undefined;
+} & import("type-fest/source/partial-deep").PartialObjectDeep<import("../types/config").DefaultEnvConfig>;

package/dist/context/getEnvConfig.js

@@ -0,0 +1,26 @@
+"use strict";
+
+exports.__esModule = true;
+exports.getEnvConfig = void 0;
+
+var utils_1 = require("../utils");
+
+var getEnvConfig = function (config, componentName, env) {
+  var _a, _b;
+
+  var defaultConfig = config.components[componentName];
+
+  if (!defaultConfig) {
+    throw new Error("unknown component " + componentName);
+  }
+
+  var envCustomizations = (_b = (_a = defaultConfig.env) === null || _a === void 0 ? void 0 : _a[env]) !== null && _b !== void 0 ? _b : {};
+
+  if (envCustomizations === false) {
+    throw new Error("env is disabled: " + env);
+  }
+
+  return (0, utils_1.mergeWithMergingArrays)(defaultConfig, envCustomizations);
+};
+
+exports.getEnvConfig = getEnvConfig;

package/dist/context/getEnvType.d.ts

@@ -0,0 +1,4 @@
+import type { EnvType } from "../types";
+export declare const getEnvType: (env: string, envConfig: {
+  type?: EnvType;
+}) => EnvType;

package/dist/context/getEnvType.js

@@ -0,0 +1,18 @@
+"use strict";
+
+exports.__esModule = true;
+exports.getEnvType = void 0;
+
+var types_1 = require("../types");
+
+var getEnvType = function (env, envConfig) {
+  if (envConfig.type) return envConfig.type;
+
+  if ((0, types_1.isKnowEnvType)(env)) {
+    return env;
+  }
+
+  throw new Error("unknown env type: " + env);
+};
+
+exports.getEnvType = getEnvType;

package/dist/context/getEnvironment.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from "../types/config";
+import type { CommitInfo, Environment } from "../types/context";
+export declare const getEnvironment: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined) => Promise<Environment>;

package/dist/context/getEnvironment.js

@@ -0,0 +1,187 @@
+"use strict";
+
+var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt(value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value);
+    });
+  }
+
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
+
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+};
+
+var __generator = this && this.__generator || function (thisArg, body) {
+  var _ = {
+    label: 0,
+    sent: function () {
+      if (t[0] & 1) throw t[1];
+      return t[1];
+    },
+    trys: [],
+    ops: []
+  },
+      f,
+      y,
+      t,
+      g;
+  return g = {
+    next: verb(0),
+    "throw": verb(1),
+    "return": verb(2)
+  }, typeof Symbol === "function" && (g[Symbol.iterator] = function () {
+    return this;
+  }), g;
+
+  function verb(n) {
+    return function (v) {
+      return step([n, v]);
+    };
+  }
+
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
+
+    while (_) try {
+      if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+      if (y = 0, t) op = [op[0] & 2, t.value];
+
+      switch (op[0]) {
+        case 0:
+        case 1:
+          t = op;
+          break;
+
+        case 4:
+          _.label++;
+          return {
+            value: op[1],
+            done: false
+          };
+
+        case 5:
+          _.label++;
+          y = op[1];
+          op = [0];
+          continue;
+
+        case 7:
+          op = _.ops.pop();
+
+          _.trys.pop();
+
+          continue;
+
+        default:
+          if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+            _ = 0;
+            continue;
+          }
+
+          if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+            _.label = op[1];
+            break;
+          }
+
+          if (op[0] === 6 && _.label < t[1]) {
+            _.label = t[1];
+            t = op;
+            break;
+          }
+
+          if (t && _.label < t[2]) {
+            _.label = t[2];
+
+            _.ops.push(op);
+
+            break;
+          }
+
+          if (t[2]) _.ops.pop();
+
+          _.trys.pop();
+
+          continue;
+      }
+
+      op = body.call(thisArg, _);
+    } catch (e) {
+      op = [6, e];
+      y = 0;
+    } finally {
+      f = t = 0;
+    }
+
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
+  }
+};
+
+exports.__esModule = true;
+exports.getEnvironment = void 0;
+
+var getEnvironmentContext_1 = require("./getEnvironmentContext");
+
+var getEnvironmentVariables_1 = require("./getEnvironmentVariables");
+
+var getEnvironment = function (config, componentName, env, commitInfo) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var _a, envVars, secretEnvVarKeys, host, url, envVarContext, envType;
+
+    return __generator(this, function (_b) {
+      switch (_b.label) {
+        case 0:
+          return [4
+          /*yield*/
+          , (0, getEnvironmentVariables_1.getEnvironmentVariables)(config, componentName, env, commitInfo)];
+
+        case 1:
+          _a = _b.sent(), envVars = _a.envVars, secretEnvVarKeys = _a.secretEnvVarKeys, host = _a.host, url = _a.url;
+          envVarContext = (0, getEnvironmentContext_1.getEnvironmentContext)(config, env, componentName, commitInfo);
+          envType = envVarContext.envType;
+          return [2
+          /*return*/
+          , {
+            envType: envType,
+            host: host,
+            url: url,
+            gitlabEnvironment: {
+              name: envVarContext.gitlabEnvironmentName,
+              url: url
+            },
+            fullName: envVarContext.fullName,
+            slug: envVarContext.environmentSlug,
+            shortName: env,
+            envVars: envVars,
+            secretEnvVarKeys: secretEnvVarKeys
+          }];
+      }
+    });
+  });
+};
+
+exports.getEnvironment = getEnvironment;

package/dist/context/getEnvironmentContext.d.ts

@@ -0,0 +1,4 @@
+import type { Config } from "../types/config";
+import type { CommitInfo } from "../types/context";
+import type { EnvironmentContext } from "../types/environmentContext";
+export declare const getEnvironmentContext: (config: Config, env: string, componentName: string, commitInfo?: CommitInfo | undefined) => EnvironmentContext<any, any>;

package/dist/context/getEnvironmentContext.js

@@ -0,0 +1,36 @@
+"use strict";
+
+exports.__esModule = true;
+exports.getEnvironmentContext = void 0;
+
+var getEnvConfig_1 = require("./getEnvConfig");
+
+var getEnvType_1 = require("./getEnvType");
+
+var getEnvironmentSlug = function (envConfig, env, componentName, commitInfo) {
+  var envType = (0, getEnvType_1.getEnvType)(env, envConfig);
+  return envType === "review" && commitInfo ? "".concat(env, "-").concat(commitInfo.reviewSlug, "-").concat(componentName) : "".concat(env, "-").concat(componentName);
+};
+
+var getEnvironmentContext = function (config, env, componentName, commitInfo) {
+  var envConfigRaw = (0, getEnvConfig_1.getEnvConfig)(config, componentName, env);
+  var envType = (0, getEnvType_1.getEnvType)(env, envConfigRaw);
+  var environmentSlug = getEnvironmentSlug(envConfigRaw, env, componentName, commitInfo);
+  var gitlabEnvironmentName = envType === "review" && commitInfo ? "".concat(env, "/").concat(commitInfo.refName, "/").concat(componentName) : "".concat(env, "/").concat(componentName);
+  var fullName = "".concat(config.customerName, "-").concat(config.appName, "-").concat(environmentSlug);
+  return {
+    envConfigRaw: envConfigRaw,
+    deployConfigRaw: envConfigRaw.deploy,
+    buildConfigRaw: envConfigRaw.build,
+    environmentSlug: environmentSlug,
+    gitlabEnvironmentName: gitlabEnvironmentName,
+    fullName: fullName,
+    envType: envType,
+    commitInfo: commitInfo,
+    componentName: componentName,
+    env: env,
+    fullConfig: config
+  };
+};
+
+exports.getEnvironmentContext = getEnvironmentContext;

package/dist/context/getEnvironmentVariables.d.ts

@@ -0,0 +1,10 @@
+import type { CommitInfo, Context } from "../types";
+import type { Config } from "../types/config";
+export declare const getEnvironmentVariables: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, alreadyVisited?: Record<string, Record<string, boolean>>) => Promise<{
+  envVars: Record<string, string>;
+  secretEnvVarKeys: string[];
+  host: string;
+  url: string;
+}>;
+export declare const getSecretVarName: (env: string, componentName: string, key: string) => string;
+export declare const getSecretVarNameForContext: (context: Context, key: string) => string;

package/dist/context/getEnvironmentVariables.js

@@ -0,0 +1,322 @@
+"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 __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt(value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value);
+    });
+  }
+
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
+
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+};
+
+var __generator = this && this.__generator || function (thisArg, body) {
+  var _ = {
+    label: 0,
+    sent: function () {
+      if (t[0] & 1) throw t[1];
+      return t[1];
+    },
+    trys: [],
+    ops: []
+  },
+      f,
+      y,
+      t,
+      g;
+  return g = {
+    next: verb(0),
+    "throw": verb(1),
+    "return": verb(2)
+  }, typeof Symbol === "function" && (g[Symbol.iterator] = function () {
+    return this;
+  }), g;
+
+  function verb(n) {
+    return function (v) {
+      return step([n, v]);
+    };
+  }
+
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
+
+    while (_) try {
+      if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+      if (y = 0, t) op = [op[0] & 2, t.value];
+
+      switch (op[0]) {
+        case 0:
+        case 1:
+          t = op;
+          break;
+
+        case 4:
+          _.label++;
+          return {
+            value: op[1],
+            done: false
+          };
+
+        case 5:
+          _.label++;
+          y = op[1];
+          op = [0];
+          continue;
+
+        case 7:
+          op = _.ops.pop();
+
+          _.trys.pop();
+
+          continue;
+
+        default:
+          if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+            _ = 0;
+            continue;
+          }
+
+          if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+            _.label = op[1];
+            break;
+          }
+
+          if (op[0] === 6 && _.label < t[1]) {
+            _.label = t[1];
+            t = op;
+            break;
+          }
+
+          if (t && _.label < t[2]) {
+            _.label = t[2];
+
+            _.ops.push(op);
+
+            break;
+          }
+
+          if (t[2]) _.ops.pop();
+
+          _.trys.pop();
+
+          continue;
+      }
+
+      op = body.call(thisArg, _);
+    } catch (e) {
+      op = [6, e];
+      y = 0;
+    } finally {
+      f = t = 0;
+    }
+
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
+  }
+};
+
+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.getSecretVarNameForContext = exports.getSecretVarName = exports.getEnvironmentVariables = void 0;
+
+var lodash_1 = require("lodash");
+
+var deploy_1 = require("../deploy");
+
+var getEnvironmentContext_1 = require("./getEnvironmentContext");
+
+var resolveReferences_1 = require("./resolveReferences");
+
+var getEnvironmentVariables = function (config, componentName, env, commitInfo, alreadyVisited // to prevent endless loop
+) {
+  if (alreadyVisited === void 0) {
+    alreadyVisited = {};
+  }
+
+  return __awaiter(void 0, void 0, void 0, function () {
+    var environmentContext, envConfigRaw, deployConfigRaw, envType, basePredefinedVariables, predefinedVariables, host, url, devLocalConfig, port, additionalEnvVars, publicEnvVarsRaw, additionalSecretKeys, secretEnvVarKeys, secretEnvVars, legacyFromComponents, publicEnvVarsRawWithLegasyFromComponents, publicEnvVarsRawSanitized, envVarsRaw, envVars;
+
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+
+    return __generator(this, function (_k) {
+      switch (_k.label) {
+        case 0:
+          environmentContext = (0, getEnvironmentContext_1.getEnvironmentContext)(config, env, componentName, commitInfo);
+          envConfigRaw = environmentContext.envConfigRaw, deployConfigRaw = environmentContext.deployConfigRaw, envType = environmentContext.envType;
+          basePredefinedVariables = {
+            ENV_SHORT: env,
+            APP_DIR: envConfigRaw.dir,
+            ENV_TYPE: envType
+          };
+
+          if (envType === "local") {
+            devLocalConfig = envConfigRaw;
+            port = (_a = devLocalConfig.port) !== null && _a !== void 0 ? _a : 3000;
+            host = "localhost:" + port;
+            url = "http://" + host;
+            predefinedVariables = {
+              ENV_SHORT: "local",
+              ROOT_URL: url,
+              PORT: port.toString()
+            };
+          } else {
+            additionalEnvVars = deployConfigRaw ? deploy_1.DEPLOY_TYPES[deployConfigRaw.type].getAdditionalEnvVars(environmentContext) : {};
+            host = (_c = (_b = envConfigRaw === null || envConfigRaw === void 0 ? void 0 : envConfigRaw.host) !== null && _b !== void 0 ? _b : additionalEnvVars.HOST_CANONICAL) !== null && _c !== void 0 ? _c : "unknown-host.example.com";
+            url = "https://".concat(host);
+            predefinedVariables = __assign(__assign(__assign({}, basePredefinedVariables), {
+              HOST: host,
+              ROOT_URL: url
+            }), additionalEnvVars);
+          }
+
+          publicEnvVarsRaw = (_e = (_d = envConfigRaw.vars) === null || _d === void 0 ? void 0 : _d.public) !== null && _e !== void 0 ? _e : {};
+          additionalSecretKeys = deployConfigRaw ? deploy_1.DEPLOY_TYPES[deployConfigRaw.type].additionalSecretKeys(environmentContext) : [];
+          secretEnvVarKeys = __spreadArray(__spreadArray([], __read((_g = (_f = envConfigRaw.vars) === null || _f === void 0 ? void 0 : _f.secret) !== null && _g !== void 0 ? _g : []), false), __read(additionalSecretKeys), false);
+          secretEnvVars = Object.fromEntries(secretEnvVarKeys.map(function (key) {
+            return [key, "$".concat((0, exports.getSecretVarName)(env, componentName, key))];
+          }));
+          legacyFromComponents = (_j = (_h = envConfigRaw.vars) === null || _h === void 0 ? void 0 : _h.fromComponents) !== null && _j !== void 0 ? _j : {};
+          publicEnvVarsRawWithLegasyFromComponents = (0, lodash_1.merge)({}, (0, resolveReferences_1.translateLegacyFromComponents)(legacyFromComponents), publicEnvVarsRaw);
+          publicEnvVarsRawSanitized = Object.fromEntries(Object.entries(publicEnvVarsRawWithLegasyFromComponents).map(function (_a) {
+            var _b = __read(_a, 2),
+                key = _b[0],
+                value = _b[1];
+
+            return [key, (0, lodash_1.isObject)(value) ? JSON.stringify(value) : "".concat(value)];
+          }));
+          envVarsRaw = addIndexVar(__assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVarsRawSanitized));
+          return [4
+          /*yield*/
+          , (0, resolveReferences_1.resolveReferences)(envVarsRaw, function (otherComponentName, variableName, alreadyVisited) {
+            return __awaiter(void 0, void 0, void 0, function () {
+              var otherEnvVars;
+              return __generator(this, function (_a) {
+                switch (_a.label) {
+                  case 0:
+                    return [4
+                    /*yield*/
+                    , (0, exports.getEnvironmentVariables)(config, env, otherComponentName, commitInfo, alreadyVisited)];
+
+                  case 1:
+                    otherEnvVars = _a.sent().envVars;
+                    return [2
+                    /*return*/
+                    , otherEnvVars[variableName]];
+                }
+              });
+            });
+          }, alreadyVisited)];
+
+        case 1:
+          envVars = _k.sent();
+          return [2
+          /*return*/
+          , {
+            envVars: envVars,
+            secretEnvVarKeys: secretEnvVarKeys,
+            host: host,
+            url: url
+          }];
+      }
+    });
+  });
+};
+
+exports.getEnvironmentVariables = getEnvironmentVariables;
+
+var sanitizeForEnVar = function (s) {
+  return s.replace(/-/g, "_");
+};
+
+var getSecretVarName = function (env, componentName, key) {
+  return "CL_".concat(sanitizeForEnVar(env), "_").concat(sanitizeForEnVar(componentName), "_").concat(key);
+}; // remove dash from component name
+
+
+exports.getSecretVarName = getSecretVarName;
+
+var addIndexVar = function (vars) {
+  return __assign(__assign({}, vars), {
+    _ALL_ENV_VAR_KEYS: JSON.stringify(Object.keys(vars))
+  });
+};
+
+var getSecretVarNameForContext = function (context, key) {
+  return (0, exports.getSecretVarName)(context.environment.shortName, context.componentName, key);
+};
+
+exports.getSecretVarNameForContext = getSecretVarNameForContext;

package/dist/context/getLabels.d.ts

@@ -0,0 +1,8 @@
+import type { Context } from "../types";
+export declare const getLabels: (context: Context) => {
+  "customer-name": string | undefined;
+  "app-name": string | undefined;
+  "env-type": string | undefined;
+  "env-name": string | undefined;
+  "build-type": string | undefined;
+};