@catladder/pipeline 1.150.1 → 1.150.3

package/src/build/node/testJob.ts

@@ -30,7 +30,7 @@ export const createNodeTestJobs = (
     needs: [],
     envMode: "none",
   };
-  const yarnInstall = getYarnInstall(context.build);
+  const yarnInstall = getYarnInstall(context);
   const auditJob: CatladderJob | null =
     buildConfig.audit !== false
       ? {
@@ -41,7 +41,7 @@ export const createNodeTestJobs = (
           script: [
             `cd ${context.build.dir}`,
             ...(ensureArray(buildConfig.audit?.command) ?? [
-              context.build.packageManagerInfo.isClassic
+              context.packageManagerInfo.isClassic
                 ? "yarn audit"
                 : "yarn npm audit --environment production", // yarn 2
             ]),
@@ -61,9 +61,9 @@ export const createNodeTestJobs = (
           name: "👮 lint",
           ...base,
           image: buildConfig.lint?.jobImage ?? defaultImage,
-          cache: getNodeCache(context.build),
+          cache: getNodeCache(context),
           script: [
-            ...ensureNodeVersion(context.build),
+            ...ensureNodeVersion(context),
             `cd ${context.build.dir}`,
             ...yarnInstall,
             ...(ensureArray(buildConfig.lint?.command) ?? ["yarn lint"]),
@@ -83,9 +83,9 @@ export const createNodeTestJobs = (
           ...base,
           image:
             buildConfig.test?.jobImage ?? getRunnerImage("jobs-testing-chrome"),
-          cache: getNodeCache(context.build),
+          cache: getNodeCache(context),
           script: [
-            ...ensureNodeVersion(context.build),
+            ...ensureNodeVersion(context),
             `cd ${context.build.dir}`,
             ...yarnInstall,
             ...(ensureArray(buildConfig.test?.command) ?? ["yarn test"]),

package/src/build/node/yarn.ts

@@ -1,5 +1,5 @@
 import { BashExpression } from "../../bash/BashExpression";
-import type { BuildContext, ComponentContext } from "../../types";
+import type { BuildContext, ComponentContext, Context } from "../../types";
 import { ensureArray } from "../../utils";
 import { collapseableSection } from "../../utils/gitlab";
 
@@ -8,7 +8,7 @@ const YARN_INSTALL_CLASSIC = `yarn install --frozen-lockfile`;
 // FIXME: check why and when rebuild is needed
 const YARN_BERRY_PROD_REBUILD = `yarn workspaces focus --production && yarn rebuild`;
 
-const getYarnInstallCommand = (context: BuildContext) => {
+const getYarnInstallCommand = (context: Context) => {
   if (context.packageManagerInfo.isClassic) {
     return YARN_INSTALL_CLASSIC;
   }
@@ -16,7 +16,7 @@ const getYarnInstallCommand = (context: BuildContext) => {
   return `yarn install --immutable`;
 };
 
-export const ensureNodeVersion = (context: BuildContext) =>
+export const ensureNodeVersion = (context: Context) =>
   collapseableSection(
     "nodeinstall",
     "Ensure node version",
@@ -26,13 +26,15 @@ export const ensureNodeVersion = (context: BuildContext) =>
   ]);
 
 export const getYarnInstall = (
-  context: BuildContext,
+  context: Context,
   options?: {
     noCustomPostInstall: boolean;
   },
 ) => {
   const postInstall =
-    "postInstall" in context.config ? context.config.postInstall : null;
+    "postInstall" in context.build.config
+      ? context.build.config.postInstall
+      : null;
   return [
     ...ensureNodeVersion(context),
     ...collapseableSection(
@@ -50,7 +52,7 @@ export const getYarnInstall = (
 
 const DOCKER_COPY_FILES = `COPY --chown=node:node $APP_DIR .`;
 
-export const getDockerAppCopyAndBuildScript = (context: BuildContext) => {
+export const getDockerAppCopyAndBuildScript = (context: Context) => {
   if (context.packageManagerInfo.isClassic) {
     return new BashExpression(
       `

package/src/build/sbom.ts

@@ -11,7 +11,7 @@ export const createSbomBuildJob = (context: ComponentContext): CatladderJob => {
   const defaultImage = "aquasec/trivy:0.38.3";
   const defaultScript = [
     `trivy fs --quiet --format cyclonedx --output "${SBOM_FILE}" ${
-      context.build.packageManagerInfo.componentIsInWorkspace
+      context.packageManagerInfo.componentIsInWorkspace
         ? "."
         : context.build.dir
     }`,

package/src/context/createComponentContext.ts

@@ -64,10 +64,10 @@ export const createComponentContext = async (
   const context: Omit<ComponentContext, "customJobs"> = {
     fullConfig: ctx.config,
     componentConfig,
+    env: ctx.env,
 
     build: {
       dir: dir,
-      packageManagerInfo: packageManagerInfo,
       config: build,
     },
     deploy: deploy

package/src/deploy/custom/deployJob.ts

@@ -19,7 +19,7 @@ export const createCustomDeployJobs = (
     throw new Error("deploy config is not custom");
   }
   // FIXME: custom deploy currently assumes yarn-based project
-  const yarnInstall = getYarnInstall(context.build, {
+  const yarnInstall = getYarnInstall(context, {
     noCustomPostInstall: true,
   });
   return createDeployementJobs(context, {

package/src/pipeline/createAllJobs.ts

@@ -1,19 +1,18 @@
 import { getAllEnvsByTrigger } from "../config";
 import { createComponentContext } from "../context";
 import type {
-  CatladderJobWithContext,
   ComponentContext,
   Config,
   PipelineTrigger,
   PipelineType,
 } from "../types";
+import type { CatladderJob } from "../types/jobs";
 import { createJobsForComponentContext } from "./createJobsForComponent";
 
-export type AllCatladderJobs = {
-  [componentName: string]: {
-    [env: string]: Array<CatladderJobWithContext>;
-  };
-};
+export type AllCatladderJobs = Array<{
+  context: ComponentContext;
+  jobs: Array<CatladderJob>;
+}>;
 
 export type AllJobsContext = {
   config: Config;
@@ -65,17 +64,8 @@ export const createAllJobs = async ({
     pipelineType,
   });
 
-  return allComponentContext.reduce((acc, { componentName, env, context }) => {
-    if (!acc[componentName]) {
-      acc[componentName] = {};
-    }
-    acc[componentName][env] = createJobsForComponentContext(context).map(
-      (job) => ({
-        ...job,
-        context,
-      }),
-    );
-
-    return acc;
-  }, {} as AllCatladderJobs);
+  return allComponentContext.map(({ context }) => ({
+    context,
+    jobs: createJobsForComponentContext(context),
+  }));
 };

package/src/pipeline/createMainPipeline.ts

@@ -43,8 +43,12 @@ export const createMainPipeline = async <T extends PipelineType>(
       // this is purely for better readability in git diffs when you add new components
       .sort((a, b) => {
         const componentNames = Object.keys(config.components);
-        const aIndex = componentNames.findIndex((c) => c === a.componentName);
-        const bIndex = componentNames.findIndex((c) => c === b.componentName);
+        const aIndex = componentNames.findIndex(
+          (c) => c === a.context.componentName,
+        );
+        const bIndex = componentNames.findIndex(
+          (c) => c === b.context.componentName,
+        );
         return aIndex - bIndex;
       })
 

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -1,23 +1,17 @@
 import { isObject, merge } from "lodash";
 import { getInjectVarsScript } from "../../bash/getInjectVarsScript";
 import { BASE_RETRY } from "../../defaults";
-import type {
-  CatladderJobWithContext,
-  ComponentContext,
-  GitlabJobDef,
-  GitlabRule,
-} from "../../types";
+import type { ComponentContext, GitlabJobDef, GitlabRule } from "../../types";
 import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
 import { notNil } from "../../utils";
 import { collapseableSection } from "../../utils/gitlab";
-import type { AllCatladderJobs } from "../createAllJobs";
 import { removeUndefined } from "../../utils/removeUndefined";
+import type { AllCatladderJobs } from "../createAllJobs";
 
 export type AllGitlabJobs = {
   name: string;
   gitlabJob: GitlabJobDef;
-  componentName: string;
-  env: string;
+  context: ComponentContext;
 }[];
 
 export const GITLAB_ENVIRONMENT_URL_VARIABLE = "CL_GITLAB_ENVIRONMENT_URL";
@@ -38,9 +32,12 @@ const getFullReferencedJobName = (
   env: string,
   allJobs: AllCatladderJobs,
 ) => {
-  const referencedJob = allJobs[componentName]?.[env]?.find(
-    (j) => j.name === referencedJobName,
-  );
+  const referencedJob = allJobs
+    .find(
+      (j) => j.context.componentName === componentName && j.context.env === env,
+    )
+    ?.jobs?.find((j) => j.name === referencedJobName);
+
   if (!referencedJob) {
     throw new Error(
       `unknown job referenced: '${referencedJobName}' from '${env}:${componentName}'`,
@@ -54,8 +51,7 @@ const getJobName = (need: CatladderJobNeed) =>
   isObject(need) ? need.job : need;
 
 export const makeGitlabJob = (
-  componentName: string,
-  env: string,
+  context: ComponentContext,
   {
     environment,
     envMode,
@@ -65,21 +61,28 @@ export const makeGitlabJob = (
     needs,
     jobTags,
     script,
-    context,
+
     variables,
     runnerVariables,
     when,
     ...job
-  }: CatladderJobWithContext<string>,
+  }: CatladderJob<string>,
   allJobs: AllCatladderJobs,
   baseRules?: GitlabRule[],
 ): [fullName: string, job: GitlabJobDef] => {
-  const stage = envMode === "stagePerEnv" ? `${job.stage} ${env}` : job.stage;
+  const stage =
+    envMode === "stagePerEnv" ? `${job.stage} ${context.env}` : job.stage;
 
   const needsFromStages: CatladderJob["needs"] = needsStages?.flatMap((n) => {
-    const referencedComponentName = componentName;
+    const referencedComponentName = context.componentName;
     const allJobNamesFromThatStage =
-      allJobs[referencedComponentName]?.[env]
+      allJobs
+        .filter(
+          (j) =>
+            j.context.componentName === referencedComponentName &&
+            j.context.env === context.env,
+        )
+        .flatMap((j) => j.jobs)
         ?.filter((j) => j.stage === n.stage)
         ?.map((j) => j.name) ?? [];
 
@@ -102,13 +105,18 @@ export const makeGitlabJob = (
         ? {
             job: getFullReferencedJobName(
               n.job,
-              n.componentName ?? componentName,
-              env,
+              n.componentName ?? context.componentName,
+              context.env,
               allJobs,
             ),
             artifacts: n.artifacts,
           }
-        : getFullReferencedJobName(n, componentName, env, allJobs),
+        : getFullReferencedJobName(
+            n,
+            context.componentName,
+            context.env,
+            allJobs,
+          ),
     ) // sort in a predictable manner for snapshot tests
     .sort((a, b) => getJobName(a).localeCompare(getJobName(b)));
 
@@ -118,8 +126,8 @@ export const makeGitlabJob = (
 
   const fullJobName = getFullJobName(
     name,
-    componentName,
-    envMode !== "none" ? env : undefined,
+    context.componentName,
+    envMode !== "none" ? context.env : undefined,
   );
 
   // backwards compatibility, some may still use KUBERNETES_CPU_REQUEST, KUBERNETES_MEMORY_REQUEST, etc. in variables.
@@ -189,8 +197,8 @@ export const makeGitlabJob = (
       retry: BASE_RETRY,
       interruptible: true,
     },
-    componentName,
-    env,
+    context.componentName,
+    context.env,
     allJobs,
   );
 
@@ -255,26 +263,19 @@ export const createGitlabJobs = async (
   allJobs: AllCatladderJobs,
   baseRules?: GitlabRule[],
 ): Promise<AllGitlabJobs> => {
-  return Object.keys(allJobs).flatMap((componentName) => {
-    const componentJobs = allJobs[componentName];
-    return Object.keys(componentJobs).flatMap((env) => {
-      const jobs = componentJobs[env];
-
-      return jobs.flatMap((job) => {
-        const [fullJobName, gitlabJob] = makeGitlabJob(
-          componentName,
-          env,
-          job,
-          allJobs,
-          baseRules,
-        );
-        return {
-          name: fullJobName,
-          gitlabJob,
-          componentName,
-          env,
-        };
-      });
+  return allJobs.flatMap(({ context, jobs }) => {
+    return jobs.map((job) => {
+      const [fullJobName, gitlabJob] = makeGitlabJob(
+        context,
+        job,
+        allJobs,
+        baseRules,
+      );
+      return {
+        name: fullJobName,
+        gitlabJob,
+        context,
+      };
     });
   });
 };

package/src/types/context.ts

@@ -87,7 +87,7 @@ export type ContextBeforeConfig = {
 
 export type BuildContextComponent = {
   dir: string;
-  packageManagerInfo: PackageManagerInfoComponent;
+
   config: BuildConfig;
 };
 
@@ -97,6 +97,7 @@ export type DeployContext = {
 };
 export type ComponentContext = {
   componentName: string;
+  env: string;
 
   /**
    * the merged component config.
@@ -112,19 +113,10 @@ export type ComponentContext = {
 
   trigger?: PipelineTrigger;
   pipelineType?: PipelineType;
-  /**
-   * @deprecated use buildContext.packageManagerInfo instead
-   */
+
   packageManagerInfo: PackageManagerInfoComponent;
 
   customJobs?: CatladderJob[];
 };
 
-/**
- * @deprecated use ComponentContext instead
- */
 export type Context = ComponentContext;
-
-export type CatladderJobWithContext<S = BaseStage> = CatladderJob<S> & {
-  context: ComponentContext;
-};