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

package/dist/context/getLabels.js

@@ -0,0 +1,49 @@
+"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 __importDefault = this && this.__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+
+exports.__esModule = true;
+exports.getLabels = void 0;
+
+var slugify_1 = __importDefault(require("slugify"));
+
+var sanitize = function (value) {
+  if (!value) return value; //"The value can only contain lowercase letters, numeric characters, underscores and dashes. The value can be at most 63 characters long. International characters are allowed."
+  // slugify should do the job
+
+  return (0, slugify_1["default"])(value).toLowerCase();
+};
+
+var getLabels = function (context) {
+  var _a, _b, _c;
+
+  var labels = __assign({
+    "customer-name": sanitize(context.fullConfig.customerName),
+    "app-name": sanitize(context.fullConfig.appName),
+    "env-type": sanitize(context.environment.envType),
+    "env-name": sanitize(context.environment.shortName),
+    "build-type": sanitize((_a = context.componentConfig.build) === null || _a === void 0 ? void 0 : _a.type)
+  }, (_c = (_b = context.fullConfig.meta) === null || _b === void 0 ? void 0 : _b.labels) !== null && _c !== void 0 ? _c : {});
+
+  return labels;
+};
+
+exports.getLabels = getLabels;

package/dist/context/index.d.ts

@@ -1,6 +1,5 @@
-import { Config } from "../types/config";
-import { CommitInfo, Context, Environment } from "../types/context";
-export declare const getSecretVarName: (env: string, componentName: string, key: string) => string;
-export declare const getSecretVarNameForContext: (context: Context, key: string) => string;
-export declare const getEnvironment: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, alreadyVisited?: Record<string, Record<string, boolean>>) => Environment;
-export declare const createContext: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, packageManagerInfo?: import("../types/context").YarnPackageManagerInfo | undefined) => Context;
+import type { Config } from "../types/config";
+import type { CommitInfo, Context } from "../types/context";
+export * from "./getEnvironment";
+export * from "./getEnvironmentVariables";
+export declare const createContext: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, packageManagerInfo?: import("../types/context").YarnPackageManagerInfo | undefined) => Promise<Context>;

package/dist/context/index.js

@@ -1,224 +1,219 @@
 "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];
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  Object.defineProperty(o, k2, {
+    enumerable: true,
+    get: function () {
+      return m[k];
     }
+  });
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+
+var __exportStar = this && this.__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 
-    return t;
-  };
+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 __assign.apply(this, arguments);
-};
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
 
-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;
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
     }
-  }
 
-  return ar;
-};
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
 
-var __importDefault = this && this.__importDefault || function (mod) {
-  return mod && mod.__esModule ? mod : {
-    "default": mod
-  };
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
 };
 
-exports.__esModule = true;
-exports.createContext = exports.getEnvironment = exports.getSecretVarNameForContext = exports.getSecretVarName = void 0;
+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]);
+    };
+  }
 
-var lodash_1 = require("lodash");
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
 
-var slugify_1 = __importDefault(require("slugify"));
+    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];
 
-var build_1 = require("../build");
+      switch (op[0]) {
+        case 0:
+        case 1:
+          t = op;
+          break;
 
-var deploy_1 = require("../deploy");
+        case 4:
+          _.label++;
+          return {
+            value: op[1],
+            done: false
+          };
 
-var config_1 = require("../types/config");
+        case 5:
+          _.label++;
+          y = op[1];
+          op = [0];
+          continue;
 
-var utils_1 = require("../utils");
+        case 7:
+          op = _.ops.pop();
 
-var resolveReferences_1 = require("./resolveReferences");
+          _.trys.pop();
 
-var sanitizeForEnVar = function (s) {
-  return s.replace(/-/g, "_");
-};
+          continue;
 
-var getSecretVarName = function (env, componentName, key) {
-  return "CL_".concat(sanitizeForEnVar(env), "_").concat(sanitizeForEnVar(componentName), "_").concat(key);
-}; // remove dash from component name
+        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;
+          }
 
-exports.getSecretVarName = getSecretVarName;
+          if (op[0] === 6 && _.label < t[1]) {
+            _.label = t[1];
+            t = op;
+            break;
+          }
 
-var getSecretVarNameForContext = function (context, key) {
-  return (0, exports.getSecretVarName)(context.environment.shortName, context.componentName, key);
-};
+          if (t && _.label < t[2]) {
+            _.label = t[2];
 
-exports.getSecretVarNameForContext = getSecretVarNameForContext;
+            _.ops.push(op);
 
-var getEnvironment = function (config, componentName, env, commitInfo, alreadyVisited // to prevent endless loop
-) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            break;
+          }
 
-  if (alreadyVisited === void 0) {
-    alreadyVisited = {};
-  }
+          if (t[2]) _.ops.pop();
 
-  var componentConfig = config.components[componentName];
+          _.trys.pop();
 
-  if (!componentConfig) {
-    throw new Error("unknown component " + componentName);
-  }
+          continue;
+      }
 
-  var defaultConfig = componentConfig;
-  var envConfig = (_b = (_a = componentConfig.env) === null || _a === void 0 ? void 0 : _a[env]) !== null && _b !== void 0 ? _b : {};
+      op = body.call(thisArg, _);
+    } catch (e) {
+      op = [6, e];
+      y = 0;
+    } finally {
+      f = t = 0;
+    }
 
-  if (envConfig === false) {
-    throw new Error("env is disabled: " + env);
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
   }
+};
 
-  var mergedConfig = (0, utils_1.mergeWithMergingArrays)(defaultConfig, envConfig); // env type: if its set manually, use that, otherwise use the known env types
+exports.__esModule = true;
+exports.createContext = void 0;
 
-  var envType = (_c = envConfig === null || envConfig === void 0 ? void 0 : envConfig.type) !== null && _c !== void 0 ? _c : (0, config_1.isKnowEnvType)(env) ? env : null;
+var build_1 = require("../build");
 
-  if (!envType) {
-    throw new Error("Missing type in environment " + env + " in component " + componentName);
-  }
+var deploy_1 = require("../deploy");
 
-  var basePredefinedVariables = {
-    ENV_SHORT: env,
-    APP_DIR: componentConfig.dir,
-    ENV_TYPE: envType
-  };
-  var environmentName = envType === "review" && commitInfo ? "".concat(env, "/").concat(commitInfo.refName, "/").concat(componentName) : "".concat(env, "/").concat(componentName);
-  var environmentSlug = envType === "review" && commitInfo ? "".concat(env, "-").concat(commitInfo.reviewSlug, "-").concat(componentName) : "".concat(env, "-").concat(componentName);
-  var predefinedVariables;
-  var host;
-  var url;
-
-  if (envType === "local") {
-    var devLocalConfig = mergedConfig;
-    var port = (_d = devLocalConfig.port) !== null && _d !== void 0 ? _d : 3000;
-    host = "localhost:" + port;
-    url = "http://" + host;
-    predefinedVariables = {
-      ENV_SHORT: "local",
-      ROOT_URL: url,
-      PORT: port.toString()
-    };
-  } else {
-    var RELEASE_NAME = "".concat(config.customerName, "-").concat(config.appName, "-").concat(environmentSlug);
-    var componentSlug = (0, slugify_1["default"])(componentName);
-    var envInUrl = envType === "review" && commitInfo ? "".concat(commitInfo.reviewSlug, ".").concat(env) : env;
-    var domainCanonical = (mergedConfig === null || mergedConfig === void 0 ? void 0 : mergedConfig.deploy) && (mergedConfig === null || mergedConfig === void 0 ? void 0 : mergedConfig.deploy.type) === "kubernetes" && ((_e = mergedConfig.deploy.cluster) === null || _e === void 0 ? void 0 : _e.domainCanonical) || // for convenience, we allow clusters to define a canonical domain, because a cluster has a fixed ip and you will usually have a domain pointing to that cluster
-    config.domainCanonical || "panter.cloud";
-    var HOST_CANONICAL = "".concat(componentSlug, ".").concat(envInUrl, ".").concat(config.appName, ".").concat(config.customerName, ".").concat(domainCanonical);
-    host = (_f = mergedConfig === null || mergedConfig === void 0 ? void 0 : mergedConfig.host) !== null && _f !== void 0 ? _f : HOST_CANONICAL;
-    var url_1 = "https://".concat(host); // FIXME: move to kube specific jobs
-
-    var KUBE_APP_NAME = envType === "review" && commitInfo ? "".concat(commitInfo.reviewSlug, "-").concat(componentName) : componentName;
-    var KUBE_NAMESPACE = (0, deploy_1.getKubernetesNamespace)(config, env);
-    predefinedVariables = __assign(__assign({}, basePredefinedVariables), {
-      HOST_CANONICAL: HOST_CANONICAL,
-      ROOT_URL: url_1,
-      KUBE_NAMESPACE: KUBE_NAMESPACE,
-      KUBE_APP_NAME: KUBE_APP_NAME,
-      RELEASE_NAME: RELEASE_NAME
-    });
-  }
+var utils_1 = require("../utils");
 
-  var publicEnvVarsRaw = (_h = (_g = mergedConfig.vars) === null || _g === void 0 ? void 0 : _g.public) !== null && _h !== void 0 ? _h : {};
-  var secretEnvVarKeys = (_k = (_j = mergedConfig.vars) === null || _j === void 0 ? void 0 : _j.secret) !== null && _k !== void 0 ? _k : [];
-  var secretEnvVars = Object.fromEntries(secretEnvVarKeys.map(function (key) {
-    return [key, "$".concat((0, exports.getSecretVarName)(env, componentName, key))];
-  })); // this is deprecated, we now support: $componentname:FOO
-
-  var legacyFromComponents = (_m = (_l = mergedConfig.vars) === null || _l === void 0 ? void 0 : _l.fromComponents) !== null && _m !== void 0 ? _m : {};
-  var publicEnvVarsRawWithLegasyFromComponents = (0, lodash_1.merge)({}, (0, resolveReferences_1.translateLegacyFromComponents)(legacyFromComponents), publicEnvVarsRaw);
-  var 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)];
-  }));
-
-  var envVarsRaw = __assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVarsRawSanitized);
-
-  var envVars = (0, resolveReferences_1.resolveReferences)(envVarsRaw, function (componentName, variableName, alreadyVisited) {
-    var envVars = (0, exports.getEnvironment)(config, componentName, env, commitInfo, alreadyVisited).envVars;
-    return envVars[variableName];
-  }, alreadyVisited);
-  return {
-    envType: envType,
-    host: host,
-    fullName: environmentName,
-    slug: environmentSlug,
-    shortName: env,
-    url: predefinedVariables.ROOT_URL,
-    envVars: envVars,
-    secretEnvVarKeys: secretEnvVarKeys
-  };
-};
+var getEnvironment_1 = require("./getEnvironment");
 
-exports.getEnvironment = getEnvironment;
+var getEnvironmentContext_1 = require("./getEnvironmentContext");
 
-var createContext = function (config, componentName, env, commitInfo, packageManagerInfo) {
-  var _a, _b;
+__exportStar(require("./getEnvironment"), exports);
 
-  if (!/^[a-z0-9-]+$/.test(componentName)) {
-    throw new Error("componentName may only contain lower case letters, numbers and -");
-  }
+__exportStar(require("./getEnvironmentVariables"), exports);
 
-  var rawConfig = config.components[componentName];
-
-  if (!rawConfig) {
-    throw new Error("unknown component " + componentName);
-  } // envs can override the config
-
-
-  var envConfig = (_b = (_a = rawConfig.env) === null || _a === void 0 ? void 0 : _a[env]) !== null && _b !== void 0 ? _b : {};
-  var componentConfigWithoutDefaults = (0, utils_1.mergeWithMergingArrays)(rawConfig, envConfig); // fill in defaults of build and deploy
-
-  var defaults = componentConfigWithoutDefaults.deploy ? {
-    build: build_1.BUILD_TYPES[componentConfigWithoutDefaults.build.type].defaults(),
-    deploy: deploy_1.DEPLOY_TYPES[componentConfigWithoutDefaults.deploy.type].defaults()
-  } : {
-    build: {},
-    deploy: {}
-  };
-  var componentConfig = (0, utils_1.mergeWithMergingArrays)(defaults, componentConfigWithoutDefaults);
-  return {
-    fullConfig: config,
-    componentConfig: componentConfig,
-    componentName: componentName,
-    environment: (0, exports.getEnvironment)(config, componentName, env, commitInfo),
-    commitInfo: commitInfo,
-    packageManagerInfo: packageManagerInfo
-  };
+var createContext = function (config, componentName, env, commitInfo, packageManagerInfo) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var envContext, componentConfigWithoutDefaults, defaults, componentConfig;
+
+    var _a;
+
+    return __generator(this, function (_b) {
+      switch (_b.label) {
+        case 0:
+          if (!/^[a-z0-9-]+$/.test(componentName)) {
+            throw new Error("componentName may only contain lower case letters, numbers and -");
+          }
+
+          envContext = (0, getEnvironmentContext_1.getEnvironmentContext)(config, env, componentName, commitInfo);
+          componentConfigWithoutDefaults = envContext.envConfigRaw;
+          defaults = componentConfigWithoutDefaults.deploy ? {
+            build: build_1.BUILD_TYPES[componentConfigWithoutDefaults.build.type].defaults(envContext),
+            deploy: deploy_1.DEPLOY_TYPES[componentConfigWithoutDefaults.deploy.type].defaults(envContext)
+          } : {
+            build: {},
+            deploy: {}
+          };
+          componentConfig = (0, utils_1.mergeWithMergingArrays)(defaults, componentConfigWithoutDefaults);
+          _a = {
+            fullConfig: config,
+            componentConfig: componentConfig,
+            componentName: componentName
+          };
+          return [4
+          /*yield*/
+          , (0, getEnvironment_1.getEnvironment)(config, componentName, env, commitInfo)];
+
+        case 1:
+          return [2
+          /*return*/
+          , (_a.environment = _b.sent(), _a.commitInfo = commitInfo, _a.packageManagerInfo = packageManagerInfo, _a)];
+      }
+    });
+  });
 };
 
 exports.createContext = createContext;

package/dist/context/resolveReferences.d.ts

@@ -1,6 +1,4 @@
-export declare const resolveReferences: (vars: Record<string, string>, getOtherVariables?: ((componentName: string, variableName: string, alreadyVisited: Record<string, Record<string, boolean>>) => string | null) | undefined, alreadyVisitedBase?: Record<string, Record<string, boolean>>) => {
-  [k: string]: string;
-};
+export declare const resolveReferences: (vars: Record<string, string>, getOtherVariables?: ((componentName: string, variableName: string, alreadyVisited: Record<string, Record<string, boolean>>) => Promise<string | null>) | undefined, alreadyVisitedBase?: Record<string, Record<string, boolean>>) => Promise<Record<string, string>>;
 export declare const translateLegacyFromComponents: (fromComponents: Record<string, Record<string, string>>) => {
   [k: string]: string;
 };