@catladder/pipeline 1.153.1 → 1.154.0

package/dist/pipeline/gitlab/createGitlabJobs.js

@@ -175,16 +175,24 @@ var utils_1 = require("../../utils");
 var gitlab_1 = require("../../utils/gitlab");
 var removeUndefined_1 = require("../../utils/removeUndefined");
 exports.GITLAB_ENVIRONMENT_URL_VARIABLE = "CL_GITLAB_ENVIRONMENT_URL";
-var getFullJobName = function (name, componentName, env) {
+var getFullJobName = function (_a) {
+  var type = _a.type,
+    name = _a.name,
+    baseName = _a.baseName,
+    allJobs = _a.allJobs,
+    env = _a.env;
+  var shouldAddIcon = allJobs.workspaces.length > 0;
+  var icon = type === "component" ? "🔹" : "🔸";
+  var prefix = shouldAddIcon ? icon + " " : "";
   if (env) {
-    return "".concat(componentName, " ").concat(name, " | ").concat(env, " ");
+    return "".concat(prefix).concat(baseName, " ").concat(name, " | ").concat(env, " ");
   }
-  return "".concat(componentName, " ").concat(name);
+  return "".concat(prefix).concat(baseName, " ").concat(name);
 };
-var getFullReferencedJobName = function (referencedJobName, componentName, env, allJobs) {
+var getFullReferencedJobNameFromComponent = function (referencedJobName, componentName, env, allJobs) {
   var _a, _b;
-  var referencedJob = (_b = (_a = allJobs.find(function (j) {
-    return j.context.componentName === componentName && j.context.env === env;
+  var referencedJob = (_b = (_a = allJobs.components.find(function (j) {
+    return j.context.name === componentName && j.context.env === env;
   })) === null || _a === void 0 ? void 0 : _a.jobs) === null || _b === void 0 ? void 0 : _b.find(function (j) {
     return j.name === referencedJobName;
   });
@@ -192,61 +200,59 @@ var getFullReferencedJobName = function (referencedJobName, componentName, env,
     throw new Error("unknown job referenced: '".concat(referencedJobName, "' from '").concat(env, ":").concat(componentName, "'"));
   }
   var envToSet = referencedJob.envMode !== "none" ? env : null;
-  return getFullJobName(referencedJobName, componentName, envToSet);
+  return getFullJobName({
+    type: "component",
+    name: referencedJobName,
+    baseName: componentName,
+    env: envToSet,
+    allJobs: allJobs
+  });
+};
+var getFullReferencedJobNameFromWorkspace = function (referencedJobName, workspaceName, env, allJobs) {
+  var _a, _b;
+  var referencedJob = (_b = (_a = allJobs.workspaces.find(function (w) {
+    return w.context.name === workspaceName;
+  })) === null || _a === void 0 ? void 0 : _a.jobs) === null || _b === void 0 ? void 0 : _b.find(function (j) {
+    return j.name === referencedJobName;
+  });
+  if (!referencedJob) {
+    throw new Error("unknown job referenced: '".concat(referencedJobName, "' from workspace ").concat(env, ":").concat(workspaceName, "'"));
+  }
+  var envToSet = referencedJob.envMode !== "none" ? env : null;
+  return getFullJobName({
+    type: "workspace",
+    name: referencedJobName,
+    baseName: workspaceName,
+    env: envToSet,
+    allJobs: allJobs
+  });
 };
 var getJobName = function (need) {
   return (0, lodash_1.isObject)(need) ? need.job : need;
 };
-var makeGitlabJob = function (context, _a, allJobs, baseRules) {
-  var _b, _c;
-  var environment = _a.environment,
-    envMode = _a.envMode,
-    needsStages = _a.needsStages,
-    needsOtherComponent = _a.needsOtherComponent,
-    name = _a.name,
-    needs = _a.needs,
-    jobTags = _a.jobTags,
-    script = _a.script,
-    variables = _a.variables,
-    runnerVariables = _a.runnerVariables,
-    when = _a.when,
-    job = __rest(_a, ["environment", "envMode", "needsStages", "needsOtherComponent", "name", "needs", "jobTags", "script", "variables", "runnerVariables", "when"]);
+var makeGitlabJob = function (context, job, allJobs, baseRules) {
+  var _a, _b;
+  var environment = job.environment,
+    envMode = job.envMode,
+    needsStages = job.needsStages,
+    needsOtherComponent = job.needsOtherComponent,
+    name = job.name,
+    needs = job.needs,
+    jobTags = job.jobTags,
+    script = job.script,
+    variables = job.variables,
+    runnerVariables = job.runnerVariables,
+    when = job.when,
+    rest = __rest(job, ["environment", "envMode", "needsStages", "needsOtherComponent", "name", "needs", "jobTags", "script", "variables", "runnerVariables", "when"]);
   var stage = envMode === "stagePerEnv" ? "".concat(job.stage, " ").concat(context.env) : job.stage;
-  var needsFromStages = needsStages === null || needsStages === void 0 ? void 0 : needsStages.flatMap(function (n) {
-    var _a, _b, _c;
-    var referencedComponentName = context.componentName;
-    var allJobNamesFromThatStage = (_c = (_b = (_a = allJobs.filter(function (j) {
-      return j.context.componentName === referencedComponentName && j.context.env === context.env;
-    }).flatMap(function (j) {
-      return j.jobs;
-    })) === null || _a === void 0 ? void 0 : _a.filter(function (j) {
-      return j.stage === n.stage;
-    })) === null || _b === void 0 ? void 0 : _b.map(function (j) {
-      return j.name;
-    })) !== null && _c !== void 0 ? _c : [];
-    return allJobNamesFromThatStage.map(function (job) {
-      var _a;
-      return {
-        job: job,
-        artifacts: (_a = n.artifacts) !== null && _a !== void 0 ? _a : false,
-        componentName: referencedComponentName
-      };
-    });
+  var deduplicatedGitlabNeeds = getGitlabNeeds(context, job, allJobs);
+  var fullJobName = getFullJobName({
+    type: context.type,
+    name: name,
+    baseName: context.name,
+    env: envMode !== "none" ? context.env : undefined,
+    allJobs: allJobs
   });
-  var cleanedNeeds = __spreadArray(__spreadArray(__spreadArray([], __read(needsFromStages !== null && needsFromStages !== void 0 ? needsFromStages : []), false), __read(needs !== null && needs !== void 0 ? needs : []), false), __read(needsOtherComponent !== null && needsOtherComponent !== void 0 ? needsOtherComponent : []), false);
-  var gitlabNeeds = cleanedNeeds === null || cleanedNeeds === void 0 ? void 0 : cleanedNeeds.map(function (n) {
-    var _a;
-    return (0, lodash_1.isObject)(n) ? {
-      job: getFullReferencedJobName(n.job, (_a = n.componentName) !== null && _a !== void 0 ? _a : context.componentName, context.env, allJobs),
-      artifacts: n.artifacts
-    } : getFullReferencedJobName(n, context.componentName, context.env, allJobs);
-  }).sort(function (a, b) {
-    return getJobName(a).localeCompare(getJobName(b));
-  });
-  var deduplicatedGitlabNeeds = __spreadArray([], __read(new Map(gitlabNeeds.map(function (n) {
-    return [(0, lodash_1.isObject)(n) ? n.job : n, n];
-  })).values()), false);
-  var fullJobName = getFullJobName(name, context.componentName, envMode !== "none" ? context.env : undefined);
   // backwards compatibility, some may still use KUBERNETES_CPU_REQUEST, KUBERNETES_MEMORY_REQUEST, etc. in variables.
   // those should now be set in the runnerVariables as they don't work in the variables key of the catladder job, becuase those get injected
   var PIPELINE_RUNNER_VARIABLES = ["KUBERNETES_CPU_REQUEST", "KUBERNETES_MEMORY_REQUEST", "KUBERNETES_CPU_LIMIT", "KUBERNETES_MEMORY_LIMIT"];
@@ -266,51 +272,56 @@ var makeGitlabJob = function (context, _a, allJobs, baseRules) {
   if (Object.keys(legacyRunnerVariables).length > 0) {
     console.warn("Legacy variables detected in ".concat(fullJobName, ": ").concat(Object.keys(legacyRunnerVariables).join(", "), ". Please move them to the runnerVariables key."));
   }
-  var rules = __spreadArray(__spreadArray([], __read((_b = job.rules) !== null && _b !== void 0 ? _b : []), false), __read(baseRules ? baseRules.map(function (rule) {
+  var rules = __spreadArray(__spreadArray([], __read((_a = job.rules) !== null && _a !== void 0 ? _a : []), false), __read(baseRules ? baseRules.map(function (rule) {
     return __assign({
       when: when
     }, rule);
   }) : when ? [{
     when: when
   }] : []), false);
-  var modified = addGitlabEnvironment(context, environment, __assign(__assign({}, job), {
+  var gitlabJob = __assign(__assign({}, rest), {
     rules: rules.length > 0 ? rules : undefined,
     variables: __assign(__assign({}, legacyRunnerVariables), runnerVariables),
-    script: __spreadArray(__spreadArray([], __read(varsInjectScripts), false), __read((_c = script === null || script === void 0 ? void 0 : script.filter(utils_1.notNil)) !== null && _c !== void 0 ? _c : []), false),
+    script: __spreadArray(__spreadArray([], __read(varsInjectScripts), false), __read((_b = script === null || script === void 0 ? void 0 : script.filter(utils_1.notNil)) !== null && _b !== void 0 ? _b : []), false),
     tags: jobTags,
     stage: stage,
     // sort in a predictable manner for snapshot tests
     needs: deduplicatedGitlabNeeds,
     retry: defaults_1.BASE_RETRY,
     interruptible: true
-  }), context.componentName, context.env, allJobs);
+  });
+  var modified = addGitlabEnvironment(context, environment, gitlabJob, allJobs);
   return [fullJobName, (0, removeUndefined_1.removeUndefined)(modified)];
 };
 exports.makeGitlabJob = makeGitlabJob;
-var addGitlabEnvironment = function (context, environment, job, componentName, env,
-// TODO: we could actually pull this from contxt
-allJobs) {
+var addGitlabEnvironment = function (context, catladderJobEnvironment, job, allJobs) {
   var _a, _b;
-  if (!environment) {
+  if (!catladderJobEnvironment) {
+    return job;
+  }
+  if (context.type !== "component") {
+    // don't add enviornment for workspace jobs atm.
     return job;
   }
-  var _c = context.environment,
-    url = _c.url,
-    envType = _c.envType;
-  var on_stop = environment.on_stop,
-    restEnvironment = __rest(environment, ["on_stop"]);
+  var env = context.env,
+    name = context.name,
+    environment = context.environment;
+  var url = environment.url,
+    envType = environment.envType;
+  var on_stop = catladderJobEnvironment.on_stop,
+    restEnvironment = __rest(catladderJobEnvironment, ["on_stop"]);
   // those can be dynamic, so we therefore have to do this: https://docs.gitlab.com/ee/ci/environments/#set-a-dynamic-environment-url
   var dotEnvFile = "gitlab_environment.env";
   var scriptToAdd = ["echo \"".concat(exports.GITLAB_ENVIRONMENT_URL_VARIABLE, "=").concat(url, "\" >> ").concat(dotEnvFile)];
   // this is NOT a bashVariable since it NEEDS to be used as a string in gitlab
-  var gitlabEnvironmentName = envType === "review" ? "".concat(env, "/$CI_COMMIT_REF_NAME/").concat(componentName) // FIXME: should be replaced with mr name as well
-  : "".concat(env, "/").concat(componentName);
+  var gitlabEnvironmentName = envType === "review" ? "".concat(env, "/$CI_COMMIT_REF_NAME/").concat(name) // FIXME: should be replaced with mr name as well
+  : "".concat(env, "/").concat(name);
   return __assign(__assign({}, job), {
     environment: __assign(__assign({
       name: gitlabEnvironmentName,
       url: "$".concat(exports.GITLAB_ENVIRONMENT_URL_VARIABLE)
     }, on_stop ? {
-      on_stop: getFullReferencedJobName(on_stop, componentName, env, allJobs)
+      on_stop: getFullReferencedJobNameFromComponent(on_stop, name, env, allJobs)
     } : {}), restEnvironment),
     artifacts: (0, lodash_1.merge)((_a = job.artifacts) !== null && _a !== void 0 ? _a : {}, {
       reports: {
@@ -323,7 +334,8 @@ allJobs) {
 var createGitlabJobs = function (allJobs, baseRules) {
   return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
-      return [2 /*return*/, allJobs.flatMap(function (_a) {
+      // TODO: add workspace jobs
+      return [2 /*return*/, __spreadArray(__spreadArray([], __read(allJobs.workspaces), false), __read(allJobs.components), false).flatMap(function (_a) {
         var context = _a.context,
           jobs = _a.jobs;
         return jobs.map(function (job) {
@@ -340,4 +352,110 @@ var createGitlabJobs = function (allJobs, baseRules) {
     });
   });
 };
-exports.createGitlabJobs = createGitlabJobs;
+exports.createGitlabJobs = createGitlabJobs;
+function getGitlabNeeds(context, job, allJobs) {
+  var needs = context.type === "workspace" ? getGitlabNeedsForWorkspaceJob(context, job, allJobs) : getGitlabNeedsForComponentJob(context, job, allJobs);
+  return deduplicateNeeds(needs);
+}
+function deduplicateNeeds(needs) {
+  return needs ? __spreadArray([], __read(new Map(needs.map(function (n) {
+    return [(0, lodash_1.isObject)(n) ? n.job : n, n];
+  })).values()), false) : undefined;
+}
+function getGitlabNeedsForComponentJob(context, _a, allJobs) {
+  var needsStages = _a.needsStages,
+    needs = _a.needs,
+    needsOtherComponent = _a.needsOtherComponent;
+  var needsFromStages = needsStages === null || needsStages === void 0 ? void 0 : needsStages.flatMap(function (n) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var componentName = context.name;
+    if (!n.workspaceName) {
+      var allJobNamesFromThatStage = (_c = (_b = (_a = allJobs.components.filter(function (j) {
+        return j.context.name === componentName && j.context.env === context.env;
+      }).flatMap(function (j) {
+        return j.jobs;
+      })) === null || _a === void 0 ? void 0 : _a.filter(function (j) {
+        return j.stage === n.stage;
+      })) === null || _b === void 0 ? void 0 : _b.map(function (j) {
+        return j.name;
+      })) !== null && _c !== void 0 ? _c : [];
+      return allJobNamesFromThatStage.map(function (job) {
+        var _a;
+        return {
+          job: job,
+          artifacts: (_a = n.artifacts) !== null && _a !== void 0 ? _a : false,
+          componentName: componentName
+        };
+      });
+    } else {
+      var allJobNamesFromThatStage = (_h = (_g = (_f = (_e = (_d = allJobs.workspaces.find(function (w) {
+        return w.context.name === n.workspaceName && w.context.env === context.env;
+      })) === null || _d === void 0 ? void 0 : _d.jobs) === null || _e === void 0 ? void 0 : _e.flatMap(function (j) {
+        return j;
+      })) === null || _f === void 0 ? void 0 : _f.filter(function (j) {
+        return j.stage === n.stage;
+      })) === null || _g === void 0 ? void 0 : _g.map(function (j) {
+        return j.name;
+      })) !== null && _h !== void 0 ? _h : [];
+      return allJobNamesFromThatStage.map(function (job) {
+        var _a;
+        return {
+          job: job,
+          artifacts: (_a = n.artifacts) !== null && _a !== void 0 ? _a : false,
+          workspaceName: n.workspaceName
+        };
+      });
+    }
+  });
+  var cleanedNeeds = __spreadArray(__spreadArray(__spreadArray([], __read(needsFromStages !== null && needsFromStages !== void 0 ? needsFromStages : []), false), __read(needs !== null && needs !== void 0 ? needs : []), false), __read(needsOtherComponent !== null && needsOtherComponent !== void 0 ? needsOtherComponent : []), false);
+  return cleanedNeeds === null || cleanedNeeds === void 0 ? void 0 : cleanedNeeds.map(function (n) {
+    var _a;
+    return (0, lodash_1.isObject)(n) ? "workspaceName" in n ? {
+      job: getFullReferencedJobNameFromWorkspace(n.job, n.workspaceName, context.env, allJobs),
+      artifacts: n.artifacts
+    } : {
+      job: getFullReferencedJobNameFromComponent(n.job, (_a = n.componentName) !== null && _a !== void 0 ? _a : context.name, context.env, allJobs),
+      artifacts: n.artifacts
+    } : getFullReferencedJobNameFromComponent(n, context.name, context.env, allJobs);
+  }).sort(function (a, b) {
+    return getJobName(a).localeCompare(getJobName(b));
+  });
+}
+/**
+ *
+ *unclear whether we actually need this. So far jobs in a workspace don't have needs to other jobs from the same workspace
+ */
+function getGitlabNeedsForWorkspaceJob(context, _a, allJobs) {
+  var needsStages = _a.needsStages,
+    needs = _a.needs;
+  var needsFromStages = needsStages === null || needsStages === void 0 ? void 0 : needsStages.flatMap(function (n) {
+    var _a, _b, _c, _d;
+    var workspaceName = (_a = n.workspaceName) !== null && _a !== void 0 ? _a : context.name;
+    var allJobNamesFromThatStage = (_d = (_c = (_b = allJobs.workspaces.filter(function (j) {
+      return j.context.name === workspaceName && j.context.env === context.env;
+    }).flatMap(function (j) {
+      return j.jobs;
+    })) === null || _b === void 0 ? void 0 : _b.filter(function (j) {
+      return j.stage === n.stage;
+    })) === null || _c === void 0 ? void 0 : _c.map(function (j) {
+      return j.name;
+    })) !== null && _d !== void 0 ? _d : [];
+    return allJobNamesFromThatStage.map(function (job) {
+      var _a;
+      return {
+        job: job,
+        artifacts: (_a = n.artifacts) !== null && _a !== void 0 ? _a : false,
+        workspaceName: workspaceName
+      };
+    });
+  });
+  var cleanedNeeds = __spreadArray(__spreadArray([], __read(needsFromStages !== null && needsFromStages !== void 0 ? needsFromStages : []), false), __read(needs !== null && needs !== void 0 ? needs : []), false);
+  return cleanedNeeds === null || cleanedNeeds === void 0 ? void 0 : cleanedNeeds.map(function (n) {
+    return (0, lodash_1.isObject)(n) ? {
+      job: getFullReferencedJobNameFromWorkspace(n.job, "workspaceName" in n && n.workspaceName ? n.workspaceName : context.name, context.env, allJobs),
+      artifacts: n.artifacts
+    } : getFullReferencedJobNameFromWorkspace(n, context.name, context.env, allJobs);
+  }).sort(function (a, b) {
+    return getJobName(a).localeCompare(getJobName(b));
+  });
+}

package/dist/pipeline/packageManager.d.ts

@@ -1,2 +1,3 @@
-import type { Config, PackageManagerInfoComponent } from "../types";
-export declare const getPackageManagerInfoForComponent: (config: Config, componentName: string) => Promise<PackageManagerInfoComponent>;
+import type { Config, PackageManagerInfoBase, PackageManagerInfoComponent } from "../types";
+export declare const getPackageManagerInfoForComponent: (config: Config, componentName: string) => Promise<PackageManagerInfoComponent>;
+export declare const getPackageManagerInfoBase: () => Promise<PackageManagerInfoBase>;

package/dist/pipeline/packageManager.js

@@ -1,5 +1,15 @@
 "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) {
@@ -149,26 +159,22 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getPackageManagerInfoForComponent = void 0;
+exports.getPackageManagerInfoBase = exports.getPackageManagerInfoForComponent = void 0;
 var fs_1 = require("fs");
 var path_1 = require("path");
 var path_equal_1 = require("path-equal");
 var yarnUtils_1 = require("./yarn/yarnUtils");
 var getPackageManagerInfoForComponent = function (config, componentName) {
   return __awaiter(void 0, void 0, void 0, function () {
-    var version, isClassic, component, workspaces, currentWorkspace, componentIsInWorkspace, workspaceRoot, packageJson, workspacePackageJson, lockFile, configFiles, configFilePaths, currentWorkspaceDependencies, pathsToCopyInDocker;
+    var baseInfo, workspaces, component, currentWorkspace, componentIsInWorkspace, workspaceRoot, packageJson, workspacePackageJson, lockFile, configFiles, configFilePaths, currentWorkspaceDependencies, pathsToCopyInDocker;
     return __generator(this, function (_a) {
       switch (_a.label) {
         case 0:
-          return [4 /*yield*/, (0, yarnUtils_1.getYarnVersion)()];
+          return [4 /*yield*/, (0, exports.getPackageManagerInfoBase)()];
         case 1:
-          version = _a.sent();
-          if (!version) throw new Error("could not get yarn version");
-          isClassic = version.startsWith("1");
+          baseInfo = _a.sent();
+          workspaces = baseInfo.workspaces;
           component = config.components[componentName];
-          return [4 /*yield*/, (0, yarnUtils_1.getWorkspaces)(isClassic)];
-        case 2:
-          workspaces = _a.sent();
           currentWorkspace = workspaces.find(function (w) {
             return (0, path_equal_1.pathEqual)(component.dir, w.location);
           });
@@ -185,18 +191,40 @@ var getPackageManagerInfoForComponent = function (config, componentName) {
           });
           currentWorkspaceDependencies = currentWorkspace ? (0, yarnUtils_1.getWorkspaceDependencies)(currentWorkspace, workspaces) : [];
           pathsToCopyInDocker = __spreadArray(__spreadArray(__spreadArray(__spreadArray([packageJson], __read(workspacePackageJson ? [workspacePackageJson] : []), false), [lockFile], false), __read(configFilePaths), false), __read(currentWorkspaceDependencies), false);
-          return [2 /*return*/, {
-            type: "yarn",
-            workspaces: workspaces,
-            version: version,
-            isClassic: isClassic,
+          return [2 /*return*/, __assign(__assign({}, baseInfo), {
             currentWorkspace: currentWorkspace,
             currentWorkspaceDependencies: currentWorkspaceDependencies,
             componentIsInWorkspace: componentIsInWorkspace,
             pathsToCopyInDocker: pathsToCopyInDocker
+          })];
+      }
+    });
+  });
+};
+exports.getPackageManagerInfoForComponent = getPackageManagerInfoForComponent;
+// TODO: memoizee
+var getPackageManagerInfoBase = function () {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var version, isClassic, workspaces;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          return [4 /*yield*/, (0, yarnUtils_1.getYarnVersion)()];
+        case 1:
+          version = _a.sent();
+          if (!version) throw new Error("could not get yarn version");
+          isClassic = version.startsWith("1");
+          return [4 /*yield*/, (0, yarnUtils_1.getWorkspaces)(isClassic)];
+        case 2:
+          workspaces = _a.sent();
+          return [2 /*return*/, {
+            type: "yarn",
+            workspaces: workspaces,
+            version: version,
+            isClassic: isClassic
           }];
       }
     });
   });
 };
-exports.getPackageManagerInfoForComponent = getPackageManagerInfoForComponent;
+exports.getPackageManagerInfoBase = getPackageManagerInfoBase;