@catladder/pipeline 1.150.0 → 1.150.2

package/src/build/node/buildJob.ts

@@ -20,7 +20,7 @@ export const createNodeBuildJobs = (
   }
 
   const defaultImage = getRunnerImage("jobs-default");
-  const yarnInstall = getYarnInstall(context.build);
+  const yarnInstall = getYarnInstall(context);
 
   return createBuildJobs(context, {
     appBuild:
@@ -30,7 +30,7 @@ export const createNodeBuildJobs = (
             runnerVariables: NODE_RUNNER_BUILD_VARIABLES,
             cache: [
               ...(ensureArray(buildConfig.jobCache) ?? []),
-              ...getNodeCache(context.build),
+              ...getNodeCache(context),
               ...getNextCache(context),
             ],
             script: [
@@ -41,8 +41,8 @@ export const createNodeBuildJobs = (
               paths: [
                 context.build.dir,
                 // also copy workspace dependencies in monorepo if packages are shared and they create build artifacts
-                ...(context.build.packageManagerInfo
-                  .currentWorkspaceDependencies ?? []),
+                ...(context.packageManagerInfo.currentWorkspaceDependencies ??
+                  []),
               ].flatMap((dir) => [
                 join(dir, "__build_info.json"),
                 join(dir, "dist"),
@@ -65,14 +65,12 @@ export const createNodeBuildJobs = (
           ? "nginx"
           : "node",
       ),
-      cache: [...getYarnCache(context.build, "pull")],
+      cache: [...getYarnCache(context, "pull")],
       variables: {
         // only required for non static
-        DOCKER_COPY_AND_INSTALL_APP: getDockerAppCopyAndBuildScript(
-          context.build,
-        ),
+        DOCKER_COPY_AND_INSTALL_APP: getDockerAppCopyAndBuildScript(context),
         DOCKER_COPY_WORKSPACE_FILES:
-          context.build.packageManagerInfo.pathsToCopyInDocker
+          context.packageManagerInfo.pathsToCopyInDocker
             .map((dir) => `COPY --chown=node:node ${dir} /app/${dir}`)
             ?.join("\n"),
       },

package/src/build/node/cache.ts

@@ -1,11 +1,11 @@
+import { uniq } from "lodash";
 import { join } from "path";
 import slugify from "slugify";
-import type { BuildContext, ComponentContext } from "../../types/context";
+import type { ComponentContext, Context } from "../../types/context";
 import type { GitlabJobCache } from "../../types/gitlab-types";
-import { uniq } from "lodash";
 
 export const getYarnCache = (
-  context: BuildContext,
+  context: Context,
   policy = "pull-push",
 ): GitlabJobCache[] => {
   const componentIsInWorkspace =
@@ -18,15 +18,15 @@ export const getYarnCache = (
           paths: [".yarn"],
         }
       : {
-          key: slugify(context.dir) + "-yarn",
+          key: slugify(context.build.dir) + "-yarn",
           policy,
-          paths: [join(context.dir, ".yarn")],
+          paths: [join(context.build.dir, ".yarn")],
         },
   ];
 };
 
 export const getNodeModulesCache = (
-  context: BuildContext,
+  context: Context,
   policy = "pull-push",
 ): GitlabJobCache[] => {
   const componentIsInWorkspace =
@@ -39,7 +39,7 @@ export const getNodeModulesCache = (
       // if component is in a shared workspace, use workspace cache. use individual cache else
       key: componentIsInWorkspace
         ? "node-modules-workspace"
-        : slugify(context.dir) + "-node-modules", // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
+        : slugify(context.build.dir) + "-node-modules", // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
       policy,
       paths: [
         ...(componentIsInWorkspace
@@ -49,13 +49,13 @@ export const getNodeModulesCache = (
                 join(w.location, "node_modules"),
               ) ?? []),
             ])
-          : [join(context.dir, "node_modules")]),
+          : [join(context.build.dir, "node_modules")]),
       ],
     },
   ];
 };
 export const getNodeCache = (
-  context: BuildContext,
+  context: Context,
   policy = "pull-push",
 ): GitlabJobCache[] => {
   return [

package/src/build/node/meteor.ts

@@ -32,13 +32,13 @@ export const createMeteorBuildJobs = (
     throw new Error("deploy config is not meteor");
   }
 
-  const yarnInstall = getYarnInstall(context.build);
+  const yarnInstall = getYarnInstall(context);
 
   return createBuildJobs(context, {
     appBuild:
       buildConfig.buildCommand !== null
         ? {
-            cache: [...getNodeCache(context.build), ...getMeteorCache(context)],
+            cache: [...getNodeCache(context), ...getMeteorCache(context)],
             image: getRunnerImage("jobs-meteor"),
             variables: {
               METEOR_DISABLE_OPTIMISTIC_CACHING: "1", // see https://forums.meteor.com/t/veeery-long-building-time-inside-docker-container/58673/17?u=macrozone

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

@@ -10,7 +10,7 @@ import type { PartialDeep } from "../types/utils";
 import { mergeWithMergingArrays } from "../utils";
 import { getEnvironment } from "./getEnvironment";
 import { getEnvironmentContext } from "./getEnvironmentContext";
-import { getPackageManagerInfo } from "../pipeline/packageManager";
+import { getPackageManagerInfoForComponent } from "../pipeline/packageManager";
 
 export type CreateComponentContextContext = {
   config: Config;
@@ -29,7 +29,7 @@ export const createComponentContext = async (
     );
   }
 
-  const packageManagerInfo = await getPackageManagerInfo(
+  const packageManagerInfo = await getPackageManagerInfoForComponent(
     ctx.config,
     ctx.componentName,
   );
@@ -67,7 +67,6 @@ export const createComponentContext = async (
 
     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/packageManager.ts

@@ -1,17 +1,17 @@
 import { existsSync } from "fs";
 import { join } from "path";
 import { pathEqual } from "path-equal";
-import type { Config, PackageManagerInfo } from "../types";
+import type { Config, PackageManagerInfoComponent } from "../types";
 import {
   getWorkspaces,
   getYarnVersion,
   getWorkspaceDependencies,
 } from "./yarn/yarnUtils";
 
-export const getPackageManagerInfo = async (
+export const getPackageManagerInfoForComponent = async (
   config: Config,
   componentName: string,
-): Promise<PackageManagerInfo> => {
+): Promise<PackageManagerInfoComponent> => {
   // currently only supports yarn
   const version = await getYarnVersion();
   if (!version) throw new Error("could not get yarn version");

package/src/pipeline/yarn/yarnUtils.ts

@@ -1,6 +1,6 @@
 import { exec } from "child-process-promise";
 import memoizee from "memoizee";
-import type { PackageManagerInfo, YarnWorkspace } from "../../types";
+import type { PackageManagerInfoComponent, YarnWorkspace } from "../../types";
 
 const execOrFail = async (cmd: string, onFail: string): Promise<string> => {
   try {
@@ -18,7 +18,7 @@ export const getYarnVersion = memoizee(
 );
 // export for mocking
 export const getWorkspaces = memoizee(
-  async (isClassic: boolean): Promise<PackageManagerInfo["workspaces"]> => {
+  async (isClassic: boolean): Promise<Array<YarnWorkspace>> => {
     return isClassic
       ? Object.values(
           JSON.parse(

package/src/types/context.ts

@@ -66,7 +66,7 @@ export type YarnWorkspace = {
   workspaceDependencies: string[];
   mismatchedWorkspaceDependencies: string[];
 };
-export type YarnPackageManagerInfo = {
+export type YarnPackageManagerInfoComponent = {
   type: "yarn";
   version: string;
   workspaces: YarnWorkspace[];
@@ -77,20 +77,21 @@ export type YarnPackageManagerInfo = {
   currentWorkspaceDependencies: string[];
 };
 
-export type PackageManagerInfo = YarnPackageManagerInfo;
+export type PackageManagerInfoComponent = YarnPackageManagerInfoComponent;
 
 export type ContextBeforeConfig = {
   componentName: string;
   fullConfig: Config;
-  packageManagerInfo?: PackageManagerInfo;
+  packageManagerInfo?: PackageManagerInfoComponent;
 };
 
-export type BuildContext = {
+export type BuildContextComponent = {
   dir: string;
-  packageManagerInfo: PackageManagerInfo;
+
   config: BuildConfig;
 };
 
+export type BuildContext = BuildContextComponent;
 export type DeployContext = {
   config: DeployConfig;
 };
@@ -104,24 +105,19 @@ export type ComponentContext = {
    *
    */
   componentConfig: ComponentConfig;
-  build: BuildContext;
+  build: BuildContextComponent;
   deploy?: DeployContext | null;
   fullConfig: Config;
   environment: Environment;
 
   trigger?: PipelineTrigger;
   pipelineType?: PipelineType;
-  /**
-   * @deprecated use buildContext.packageManagerInfo instead
-   */
-  packageManagerInfo: PackageManagerInfo;
+
+  packageManagerInfo: PackageManagerInfoComponent;
 
   customJobs?: CatladderJob[];
 };
 
-/**
- * @deprecated use ComponentContext instead
- */
 export type Context = ComponentContext;
 
 export type CatladderJobWithContext<S = BaseStage> = CatladderJob<S> & {