@catladder/pipeline 4.1.0 → 4.2.0

package/src/build/artifacts/createBuildJobArtifact.ts

@@ -11,20 +11,28 @@ import { componentContextNeedsBuildTimeDotEnv } from "../base/writeDotEnv";
 const uniqueAndAlphabeticalSort = (arr: string[]): string[] => {
   return uniq(arr).sort((a, b) => a.localeCompare(b));
 };
-export const createBuildJobArtifacts = (
+export const createBuildJobArtifacts = async (
   context: Context,
-): CatladderJob["artifacts"] => {
+): Promise<CatladderJob["artifacts"]> => {
   const paths =
     context.type === "workspace"
-      ? context.components.flatMap((c) => getArtifactsPathForComponent(c))
-      : getArtifactsPathForComponent(context, ["__build_info.json"]);
+      ? (
+          await Promise.all(
+            context.components.map((c) => getArtifactsPathForComponent(c)),
+          )
+        ).flat()
+      : await getArtifactsPathForComponent(context, ["__build_info.json"]);
 
   const exclude =
     context.type === "workspace"
-      ? context.components.flatMap((c) =>
-          getAllArtifactExcludePathsForComponent(c),
-        )
-      : getAllArtifactExcludePathsForComponent(context);
+      ? (
+          await Promise.all(
+            context.components.map((c) =>
+              getAllArtifactExcludePathsForComponent(c),
+            ),
+          )
+        ).flat()
+      : await getAllArtifactExcludePathsForComponent(context);
   return {
     paths: uniqueAndAlphabeticalSort(paths),
     ...(exclude.length > 0
@@ -43,44 +51,43 @@ export const createBuildJobArtifacts = (
         : {},
   };
 };
-const _getArtifactPathsForComponent = (
+const _getArtifactPathsForComponent = async (
   c: ComponentContext,
   configKey: "artifactsPaths" | "artifactsExcludePaths",
   additionalPaths?: string[],
-): string[] => {
+): Promise<string[]> => {
+  // in theory, we only need "direct",
+  // but in some cases project may have packages in the workspace that create build artifacts, which aren't components
+  // this highly depends on the build tool. To be safe, we get all
+  const componentDirs = await c.build.getComponentDirs("all");
   return [
     ...(c.build.type !== "disabled" ? (c.build.config[configKey] ?? []) : []),
     ...(additionalPaths ?? []),
   ]?.flatMap((artifact) =>
-    c.build
-      // in theory, we only need "direct",
-      // but in some cases project may have packages in the workspace that create build artifacts, which aren't components
-      // this highly depends on the build tool. To be safe, we get all
-      .getComponentDirs("all")
-      .flatMap((cDir) => join(cDir, artifact)),
+    componentDirs.flatMap((cDir: string) => join(cDir, artifact)),
   );
 };
 
 const getArtifactsPathForComponent = (
   c: ComponentContext,
   additionalPaths?: string[],
-): string[] => {
+): Promise<string[]> => {
   return _getArtifactPathsForComponent(c, "artifactsPaths", additionalPaths);
 };
 
-const getAllArtifactExcludePathsForComponent = (
+const getAllArtifactExcludePathsForComponent = async (
   c: ComponentContext,
-): string[] => {
+): Promise<string[]> => {
   return [
     ...getDotEnvPathsForComponent(c), // always exclude .env files
-    ...getArtifactExcludePathsForComponent(c),
+    ...(await getArtifactExcludePathsForComponent(c)),
   ];
 };
 
 const getArtifactExcludePathsForComponent = (
   c: ComponentContext,
   additionalPaths?: string[],
-): string[] => {
+): Promise<string[]> => {
   return _getArtifactPathsForComponent(
     c,
     "artifactsExcludePaths",

package/src/build/base/createAppBuildJob.ts

@@ -21,10 +21,10 @@ import {
   writeDotEnv,
 } from "./writeDotEnv";
 
-export const createAppBuildJob = (
+export const createAppBuildJob = async (
   context: ComponentContext<BuildContextStandalone> | WorkspaceContext,
   { script, variables, runnerVariables, cache, ...def }: AppBuildJobDefinition,
-): CatladderJob => {
+): Promise<CatladderJob> => {
   return merge(
     {
       name: APP_BUILD_JOB_NAME,
@@ -63,7 +63,7 @@ export const createAppBuildJob = (
         `cd ${context.build.dir}`,
         ...ensureArray(script),
       ],
-      artifacts: createBuildJobArtifacts(context),
+      artifacts: await createBuildJobArtifacts(context),
     },
     def,
   );

package/src/build/base/index.ts

@@ -15,16 +15,16 @@ import { createDockerBuildJobBase, requiresDockerBuild } from "../docker";
 import { APP_BUILD_JOB_NAME } from "./constants";
 import { createAppBuildJob } from "./createAppBuildJob";
 
-export const createComponentBuildJobs = (
+export const createComponentBuildJobs = async (
   context: ComponentContextWithBuild,
   definitions: {
     appBuild?: AppBuildJobDefinition;
     dockerBuild: DockerBuildJobDefinition;
   },
-): CatladderJob[] => {
+): Promise<CatladderJob[]> => {
   return [
     ...(definitions.appBuild && componentContextIsStandaloneBuild(context)
-      ? [createAppBuildJob(context, definitions.appBuild)]
+      ? [await createAppBuildJob(context, definitions.appBuild)]
       : []),
     ...(requiresDockerBuild(context)
       ? [
@@ -51,13 +51,13 @@ export const createComponentBuildJobs = (
   ];
 };
 
-export const createWorkspaceBuildJobs = (
+export const createWorkspaceBuildJobs = async (
   context: WorkspaceContext,
   definitions: {
     appBuild?: AppBuildJobDefinition;
   },
-): CatladderJob[] => {
+): Promise<CatladderJob[]> => {
   return definitions.appBuild
-    ? [createAppBuildJob(context, definitions.appBuild)]
+    ? [await createAppBuildJob(context, definitions.appBuild)]
     : [];
 };

package/src/build/custom/buildJob.ts

@@ -6,9 +6,9 @@ import type { CatladderJob } from "../../types/jobs";
 import { createComponentBuildJobs } from "../base";
 import { createBuildJobDefinition } from "../base/createBuildJobDefinition";
 
-export const createCustomBuildJobs = (
+export const createCustomBuildJobs = async (
   context: ComponentContextWithBuild,
-): CatladderJob[] => {
+): Promise<CatladderJob[]> => {
   const buildConfig = context.build.config;
 
   if (!isOfBuildType(buildConfig, "custom")) {

package/src/build/custom/index.ts

@@ -3,8 +3,11 @@ import type { CatladderJob } from "../../types/jobs";
 import { createCustomBuildJobs } from "./buildJob";
 import { createCustomTestJobs } from "./testJob";
 
-export const createCustomJobs = (
+export const createCustomJobs = async (
   context: ComponentContextWithBuild,
-): CatladderJob[] => {
-  return [...createCustomTestJobs(context), ...createCustomBuildJobs(context)];
+): Promise<CatladderJob[]> => {
+  return [
+    ...createCustomTestJobs(context),
+    ...(await createCustomBuildJobs(context)),
+  ];
 };

package/src/build/rails/build.ts

@@ -9,9 +9,9 @@ import {
 } from "../docker";
 import { isOfBuildType } from "../types";
 
-export const createRailsBuildJobs = (
+export const createRailsBuildJobs = async (
   context: ComponentContextWithBuild,
-): CatladderJob[] => {
+): Promise<CatladderJob[]> => {
   const buildConfig = context.build.config;
   if (!isOfBuildType(buildConfig, "rails")) {
     // should not happen

package/src/build/rails/index.ts

@@ -3,8 +3,11 @@ import type { CatladderJob } from "../../types/jobs";
 import { createRailsBuildJobs } from "./build";
 import { createRailsTestJobs } from "./testJob";
 
-export const createRailsJobs = (
+export const createRailsJobs = async (
   context: ComponentContextWithBuild,
-): CatladderJob[] => {
-  return [...createRailsTestJobs(context), ...createRailsBuildJobs(context)];
+): Promise<CatladderJob[]> => {
+  return [
+    ...createRailsTestJobs(context),
+    ...(await createRailsBuildJobs(context)),
+  ];
 };

package/src/context/createComponentContext.ts

@@ -75,16 +75,13 @@ export const createComponentContext = async (
     componentConfigWithoutDefaults,
   );
 
-  const [environment, packageManagerInfo] = await Promise.all([
-    getEnvironment(ctx),
-    packageManagerInfoPromise,
-  ]);
+  const environment = await getEnvironment(ctx);
   const { deploy, build, customJobs, dir } = componentConfig;
-  const getComponentDirs: BuildContext["getComponentDirs"] = (mode) => [
+  const getComponentDirs: BuildContext["getComponentDirs"] = async (mode) => [
     dir,
     // also copy workspace dependencies in monorepo if packages are shared and they create build artifacts
     ...(mode === "all"
-      ? (packageManagerInfo.currentWorkspaceDependencies ?? [])
+      ? ((await packageManagerInfoPromise).currentWorkspaceDependencies ?? [])
       : []),
   ];
   const _getBuildContext = (): BuildContextComponent => {

package/src/context/createWorkspaceContext.ts

@@ -47,8 +47,14 @@ export async function createWorkspaceContext({
     build: {
       type: "workspace",
       dir: workspaceConfig.dir ?? ".",
-      getComponentDirs: (mode) =>
-        uniq(components.flatMap((c) => c.build.getComponentDirs(mode))),
+      getComponentDirs: async (mode) =>
+        uniq(
+          (
+            await Promise.all(
+              components.map((c) => c.build.getComponentDirs(mode)),
+            )
+          ).flat(),
+        ),
       buildType: workspaceConfig.type,
       config: workspaceConfig,
     },

package/src/types/context.ts

@@ -104,7 +104,7 @@ export type BuildContextBase = {
    *
    * in case of a workspace this contains all components in the workspace (+ yarn workspace dependencies if mode = all)
    */
-  getComponentDirs: (mode: "direct" | "all") => string[];
+  getComponentDirs: (mode: "direct" | "all") => Promise<string[]>;
 };
 
 export type BuildContextComponentBase = BuildContextBase;