@catladder/pipeline 0.0.0-refactor-docker-9fda97e9 → 0.0.0-refactor-docker-c24f8608

package/src/context/index.ts

@@ -4,7 +4,7 @@ import { DEPLOY_TYPES } from "../deploy";
 import type { DeployConfig, DeployConfigType } from "../deploy/types";
 import type { PipelineType } from "../types";
 import type { Config, PipelineTrigger } from "../types/config";
-import type { Context, PackageManagerInfo } from "../types/context";
+import type { ComponentContext, PackageManagerInfo } from "../types/context";
 import type { PartialDeep } from "../types/utils";
 import { mergeWithMergingArrays } from "../utils";
 import { getEnvironment } from "./getEnvironment";
@@ -13,7 +13,7 @@ import { getEnvironmentContext } from "./getEnvironmentContext";
 export * from "./getEnvironment";
 export * from "./getEnvironmentVariables";
 
-export type CreateContextContext = {
+export type CreateComponentContextContext = {
   config: Config;
   componentName: string;
   env: string;
@@ -22,12 +22,12 @@ export type CreateContextContext = {
   packageManagerInfo?: PackageManagerInfo;
 };
 
-export const createContext = async (
-  ctx: CreateContextContext
-): Promise<Context> => {
+export const createComponentContext = async (
+  ctx: CreateComponentContextContext,
+): Promise<ComponentContext> => {
   if (!/^[a-z0-9-]+$/.test(ctx.componentName)) {
     throw new Error(
-      "componentName may only contain lower case letters, numbers and -"
+      "componentName may only contain lower case letters, numbers and -",
     );
   }
 
@@ -53,12 +53,17 @@ export const createContext = async (
       };
   const componentConfig = mergeWithMergingArrays(
     defaults,
-    componentConfigWithoutDefaults
+    componentConfigWithoutDefaults,
   );
 
   return {
     fullConfig: ctx.config,
     componentConfig,
+    buildContext: {
+      dir: componentConfig.dir,
+      packageManagerInfo: ctx.packageManagerInfo,
+      config: componentConfig.build,
+    },
     componentName: ctx.componentName,
     environment: await getEnvironment(ctx),
     packageManagerInfo: ctx.packageManagerInfo,
@@ -66,3 +71,8 @@ export const createContext = async (
     trigger: ctx.trigger,
   };
 };
+
+/**
+ * @deprecated use createComponentContext instead
+ */
+export const createContext = createComponentContext;

package/src/context/resolveReferences.ts

@@ -12,9 +12,9 @@ export const resolveReferences = async (
   vars: Record<string, string | BashExpression | undefined | null>,
   getOtherVariables?: (
     componentName: string,
-    alreadyVisited: Record<string, Record<string, boolean>>
+    alreadyVisited: Record<string, Record<string, boolean>>,
   ) => Promise<UnspecifiedEnvVars>,
-  alreadyVisitedBase: Record<string, Record<string, boolean>> = {}
+  alreadyVisitedBase: Record<string, Record<string, boolean>> = {},
 ) => {
   /**
    *
@@ -22,7 +22,10 @@ export const resolveReferences = async (
    */
   const replaceSingleValue = async (
     value: string | BashExpression,
-    alreadyVisited: Record<string, Record<string, boolean>> = alreadyVisitedBase
+    alreadyVisited: Record<
+      string,
+      Record<string, boolean>
+    > = alreadyVisitedBase,
   ): Promise<string | BashExpression> => {
     if (REGEX.test(value.toString())) {
       // we consider variables that got references in it  BashExpressions, because the replacement may be one
@@ -41,7 +44,7 @@ export const resolveReferences = async (
           });
           const result = componentName
             ? (await getOtherVariables?.(componentName, newAlreadyVisited).then(
-                (r) => r?.[variableName]
+                (r) => r?.[variableName],
               )) ?? null
             : vars[variableName]; // is self reference
 
@@ -51,7 +54,7 @@ export const resolveReferences = async (
               : match;
 
           return replaced;
-        }
+        },
       );
     } else {
       return value;
@@ -71,13 +74,13 @@ export const resolveReferences = async (
             ? await replaceSingleValue(value)
             : null,
         ];
-      })
-    )
+      }),
+    ),
   ) as Record<string, BashExpression>;
 };
 
 export const translateLegacyFromComponents = (
-  fromComponents: Record<string, Record<string, string>>
+  fromComponents: Record<string, Record<string, string>>,
 ) => {
   return Object.fromEntries(
     Object.entries(fromComponents).flatMap(([componentName, variables]) => {
@@ -85,6 +88,6 @@ export const translateLegacyFromComponents = (
         ourName,
         "${" + componentName + ":" + otherName + "}",
       ]);
-    })
+    }),
   );
 };

package/src/context/transformJobOnlyVars.ts

@@ -16,7 +16,7 @@ import {
 export const transformJobOnlyVars = async (
   env: string,
   componentName: string,
-  vars: EnvVars | null
+  vars: EnvVars | null,
 ): Promise<{
   envVars: UnspecifiedEnvVars;
   secretEnvVarKeys: SecretEnvVar[];

package/src/context/utils/envVars.ts

@@ -8,7 +8,7 @@ export const stringifyValues = (obj: Record<string, unknown>) =>
     Object.entries(obj).map(([key, value]) => [
       key,
       isObject(value) ? JSON.stringify(value) : `${value}`,
-    ])
+    ]),
   );
 
 export const stringListToSecreteEnvVarList = (keys: string[]): SecretEnvVar[] =>
@@ -16,12 +16,12 @@ export const stringListToSecreteEnvVarList = (keys: string[]): SecretEnvVar[] =>
 export const makeSecretEnvVarMapping = (
   env: string,
   componentName: string,
-  secretEnvVars: SecretEnvVar[]
+  secretEnvVars: SecretEnvVar[],
 ) => {
   return Object.fromEntries(
     secretEnvVars.map(({ key }) => [
       key,
       getBashVariable(getSecretVarName(env, componentName, key)),
-    ])
+    ]),
   );
 };

package/src/deploy/base/deploy.ts

@@ -3,7 +3,7 @@ import {
   requiresDockerBuild,
 } from "../../build/docker";
 import { SBOM_BUILD_JOB_NAME } from "../../build/sbom";
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { sbomDeactivated } from "../sbom";
 import { contextIsStoppable } from "../utils";
@@ -24,8 +24,8 @@ export type DeployJobDefinition = Pick<
   | "runnerVariables"
 >;
 export const createDeployJob = (
-  context: Context,
-  jobDefinition: DeployJobDefinition
+  context: ComponentContext,
+  jobDefinition: DeployJobDefinition,
 ): CatladderJob => {
   const hasDocker = requiresDockerBuild(context);
   const isStoppable = contextIsStoppable(context);
@@ -34,8 +34,8 @@ export const createDeployJob = (
     context.environment.envType === "review"
       ? "1 week"
       : context.environment.envType === "dev"
-      ? "4 weeks"
-      : undefined;
+        ? "4 weeks"
+        : undefined;
 
   // if auto or manual is configured explicitly, use that
   const whenDeployDefined =
@@ -47,8 +47,8 @@ export const createDeployJob = (
     context.environment.envType !== "prod"
       ? "auto" // is not stage, auto deploy
       : context.componentConfig.env?.stage === false
-      ? "auto" // is prod, but no staging, auto deploy
-      : "manual"; // manually deploy
+        ? "auto" // is prod, but no staging, auto deploy
+        : "manual"; // manually deploy
   const whenDeploy = whenDeployDefined ? whenDeployDefined : whenDeployDefault;
 
   return {

package/src/deploy/base/index.ts

@@ -1,16 +1,16 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { createDeployJob, type DeployJobDefinition } from "./deploy";
 import { createRollbackJob, type RollbackJobDefinition } from "./rollback";
 import { createStopJob, type StopJobDefinition } from "./stop";
 
 export const createDeployementJobs = (
-  context: Context,
+  context: ComponentContext,
   definitions: {
     deploy: DeployJobDefinition;
     stop?: StopJobDefinition;
     rollback?: RollbackJobDefinition;
-  }
+  },
 ): CatladderJob[] => {
   return [
     createDeployJob(context, definitions.deploy),

package/src/deploy/base/rollback.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { DEPLOY_RUNNER_VARIABLES } from "./variables";
 
@@ -9,8 +9,8 @@ export type RollbackJobDefinition = Pick<
   "script" | "variables" | "runnerVariables" | "image"
 >;
 export const createRollbackJob = (
-  context: Context,
-  jobDefinition: RollbackJobDefinition
+  context: ComponentContext,
+  jobDefinition: RollbackJobDefinition,
 ): CatladderJob => {
   return {
     name: ROLLBACK_JOB_NAME,

package/src/deploy/base/stop.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 
 import { DEPLOY_RUNNER_VARIABLES } from "./variables";
@@ -9,8 +9,8 @@ export type StopJobDefinition = Pick<
   "script" | "variables" | "image" | "runnerVariables"
 >;
 export const createStopJob = (
-  context: Context,
-  jobDefinition: StopJobDefinition
+  context: ComponentContext,
+  jobDefinition: StopJobDefinition,
 ): CatladderJob => {
   return {
     name: STOP_JOB_NAME,

package/src/deploy/cloudRun/artifactsRegistry.ts

@@ -1,13 +1,13 @@
 import type { StringOrBashExpression } from "../../bash/BashExpression";
 import { joinBashExpressions } from "../../bash/BashExpression";
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import { allowFailureInScripts } from "../../utils/gitlab";
 import { isOfDeployType } from "../types";
 import { removeFirstLinesFromCommandOutput } from "./utils/removeFirstLinesFromCommandOutput";
 
 export const getArtifactsRegistryHost = ({
   componentConfig: { deploy },
-}: Context) => {
+}: ComponentContext) => {
   if (!isOfDeployType(deploy, "google-cloudrun")) {
     // should not happen
     throw new Error("deploy config is wrong");
@@ -15,7 +15,7 @@ export const getArtifactsRegistryHost = ({
   return `${deploy.region}-docker.pkg.dev`;
 };
 
-export const getArtifactsRegistryDockerUrl = (context: Context) => {
+export const getArtifactsRegistryDockerUrl = (context: ComponentContext) => {
   const deployConfig = context.componentConfig.deploy;
 
   if (!isOfDeployType(deployConfig, "google-cloudrun")) {
@@ -35,8 +35,8 @@ export const getArtifactsRegistryDockerUrl = (context: Context) => {
  * lecacyReviewImageName is only temporary. In old versions the images had no reviewslug in review apps, which makes cleanup harder. We delete all those images now, but need the path
  */
 export const getArtifactsRegistryImageName = (
-  context: Context,
-  lecacyReviewImageName = false
+  context: ComponentContext,
+  lecacyReviewImageName = false,
 ) => {
   if (lecacyReviewImageName && context.environment.envType !== "review") {
     throw new Error("lecacyReviewImageName is only allowed for review app");
@@ -55,19 +55,21 @@ export const getArtifactsRegistryImageName = (
   return joinBashExpressions(gcloudImagePath, "/");
 };
 
-export const getArtifactsRegistryBuildCacheImage = (context: Context) => {
+export const getArtifactsRegistryBuildCacheImage = (
+  context: ComponentContext,
+) => {
   const dockerUrl = getArtifactsRegistryDockerUrl(context);
   // does not include env, so that after merge, you might get more cache hits (review-->dev)
   const gcloudImagePath = [dockerUrl, "caches", context.componentName];
   return gcloudImagePath.join("/");
 };
 
-export const getArtifactsRegistryImage = (context: Context) =>
+export const getArtifactsRegistryImage = (context: ComponentContext) =>
   `${getArtifactsRegistryImageName(context)}:$DOCKER_IMAGE_TAG`;
 
 const getDeleteImageCommands = (
   fullImageName: StringOrBashExpression,
-  keepNewest = 0
+  keepNewest = 0,
 ) => {
   if (keepNewest === 0) {
     // no need to list tags, we delete the whole thing
@@ -80,7 +82,7 @@ const getDeleteImageCommands = (
 
   const listImagesToDeletecommand = removeFirstLinesFromCommandOutput(
     listAllImagesCommand,
-    keepNewest
+    keepNewest,
   );
   const deleteImageCommand = `gcloud artifacts docker images delete ${fullImageName}@$version --quiet --delete-tags`;
 
@@ -96,7 +98,10 @@ const getDeleteImageCommands = (
  * @param keep how many of the newest images to keep
  * @returns
  */
-export const getDeleteUnusedImagesCommands = (context: Context, keep = 0) => {
+export const getDeleteUnusedImagesCommands = (
+  context: ComponentContext,
+  keep = 0,
+) => {
   const deployConfig = context.componentConfig.deploy;
   if (deployConfig === false) {
     return [];
@@ -119,8 +124,8 @@ export const getDeleteUnusedImagesCommands = (context: Context, keep = 0) => {
       ? allowFailureInScripts(
           getDeleteImageCommands(
             getArtifactsRegistryImageName(context, true),
-            0
-          )
+            0,
+          ),
         )
       : []),
   ];

package/src/deploy/cloudRun/cleanup.ts

@@ -1,10 +1,10 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import { getDeleteUnusedImagesCommands } from "./artifactsRegistry";
 import { getDeleteUnusedRevisionsCommands } from "./cloudRunRevisions";
 
 export const getRemoveOldRevisionsAndImagesCommand = (
-  context: Context,
-  when: "postDeploy" | "onStop"
+  context: ComponentContext,
+  when: "postDeploy" | "onStop",
 ) => {
   if (when === "onStop") {
     // service is already deleted, so we don't need to delete old revisions, just delete all images
@@ -19,11 +19,11 @@ export const getRemoveOldRevisionsAndImagesCommand = (
 
   const deleteOldRevisionsCommands = getDeleteUnusedRevisionsCommands(
     context,
-    revisionsToKeep
+    revisionsToKeep,
   );
   const deleteOldImagesCommands = getDeleteUnusedImagesCommands(
     context,
-    imagesToKeep
+    imagesToKeep,
   );
 
   return [...deleteOldRevisionsCommands, ...deleteOldImagesCommands];

package/src/deploy/cloudRun/cloudRunRevisions.ts

@@ -1,15 +1,15 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import { isOfDeployType } from "../types";
 import { createArgsString } from "./utils/createArgsString";
 import { getServiceName } from "./utils/getServiceName";
 import { removeFirstLinesFromCommandOutput } from "./utils/removeFirstLinesFromCommandOutput";
 
 const getListRevisionsCommand = (
-  context: Context,
+  context: ComponentContext,
   args: {
     filter?: string;
     format: string;
-  }
+  },
 ) => {
   const serviceName = getServiceName(context);
   const deployConfig = context.componentConfig.deploy;
@@ -34,8 +34,8 @@ const getListRevisionsCommand = (
 };
 
 export const getDeleteUnusedRevisionsCommands = (
-  context: Context,
-  keep: number
+  context: ComponentContext,
+  keep: number,
 ) => {
   const deployConfig = context.componentConfig.deploy;
   if (deployConfig === false) {
@@ -54,7 +54,7 @@ export const getDeleteUnusedRevisionsCommands = (
   // this removes the newest `revisionsToKeep` images
   const listRevisionsToDeleteCmd = removeFirstLinesFromCommandOutput(
     listAllInactiveRevisionsCmd,
-    keep
+    keep,
   );
   const deleteRevisionCmd = `gcloud run revisions delete ${createArgsString({
     project: deployConfig.projectId,

package/src/deploy/cloudRun/createJobs/cloudRunJobs.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../../../types/context";
+import type { ComponentContext } from "../../../types/context";
 import { allowFailureInScripts } from "../../../utils/gitlab";
 
 import type {
@@ -24,9 +24,9 @@ import type {
 import { ENV_VARS_FILENAME } from "./constants";
 
 const getJobRunScriptForJob = (
-  context: Context,
+  context: ComponentContext,
   jobName: StringOrBashExpression,
-  wait: boolean
+  wait: boolean,
 ) => {
   const commonArgs = getCommonCloudRunArgs(context);
 
@@ -36,7 +36,7 @@ const getJobRunScriptForJob = (
   }`;
 };
 
-export const getDeleteSchedulesScripts = (context: Context) => {
+export const getDeleteSchedulesScripts = (context: ComponentContext) => {
   const deployConfig = getCloudRunDeployConfig(context);
   const jobsWithSchedule = getCloudRunJobsWithSchedule(context);
   const argsString = createArgsString({
@@ -52,7 +52,7 @@ export const getDeleteSchedulesScripts = (context: Context) => {
     .flat();
 };
 
-export const getDeleteJobsScripts = (context: Context) => {
+export const getDeleteJobsScripts = (context: ComponentContext) => {
   const commonArgs = getCommonCloudRunArgs(context);
   const commonArgsString = createArgsString(commonArgs);
   const jobsWithNames = getCloudRunJobsWithNames(context);
@@ -65,8 +65,8 @@ export const getDeleteJobsScripts = (context: Context) => {
 };
 
 export const getJobRunScripts = (
-  context: Context,
-  when: DeployConfigCloudRunJob["when"]
+  context: ComponentContext,
+  when: DeployConfigCloudRunJob["when"],
 ) => {
   const jobsWithNames = getCloudRunJobsWithNames(context);
   return jobsWithNames
@@ -76,12 +76,12 @@ export const getJobRunScripts = (
         context,
         jobName,
         // wait for completin on stop jobs, since stop will delete the jobs afterwards, so they will fail
-        ["preStop", "postStop"].includes(when)
-      )
+        ["preStop", "postStop"].includes(when),
+      ),
     );
 };
 
-export const getJobCreateScripts = (context: Context) => {
+export const getJobCreateScripts = (context: ComponentContext) => {
   const jobsWithNames = getCloudRunJobsWithNames(context);
 
   return jobsWithNames
@@ -90,9 +90,9 @@ export const getJobCreateScripts = (context: Context) => {
 };
 
 const getJobCreateScriptsForJob = (
-  context: Context,
+  context: ComponentContext,
   jobName: StringOrBashExpression,
-  job: DeployConfigCloudRunJob
+  job: DeployConfigCloudRunJob,
 ) => {
   const commonDeployArgs = getCommonDeployArgs(context);
 
@@ -125,14 +125,14 @@ const getJobCreateScriptsForJob = (
   return [
     ...allowFailureInScripts([`${gcloudRunCmd()} jobs create ${argsString}`]),
     `${gcloudRunCmd(
-      requiresBeta ? "beta" : undefined
+      requiresBeta ? "beta" : undefined,
     )} jobs update ${argsString} ${createArgsString(
-      ...createVolumeConfig(job?.volumes, "job")
+      ...createVolumeConfig(job?.volumes, "job"),
     )}`,
   ];
 };
 
-export const getCreateScheduleScripts = (context: Context) => {
+export const getCreateScheduleScripts = (context: ComponentContext) => {
   const jobsWithSchedule = getCloudRunJobsWithSchedule(context);
   const deployConfig = getCloudRunDeployConfig(context);
 
@@ -160,17 +160,17 @@ export const getCreateScheduleScripts = (context: Context) => {
     .flat();
 };
 
-const getCloudRunJobsWithSchedule = (context: Context) => {
+const getCloudRunJobsWithSchedule = (context: ComponentContext) => {
   const jobsWithNames = getCloudRunJobsWithNames(context);
 
   return jobsWithNames
     .filter(
       (
-        entry
+        entry,
       ): entry is {
         jobName: BashExpression;
         job: DeployConfigCloudRunJobWithSchedule;
-      } => entry.job.when === "schedule"
+      } => entry.job.when === "schedule",
     )
     .map(({ job, jobName }) => ({
       job,
@@ -179,7 +179,7 @@ const getCloudRunJobsWithSchedule = (context: Context) => {
     }));
 };
 
-const getCloudRunJobsWithNames = (context: Context) => {
+const getCloudRunJobsWithNames = (context: ComponentContext) => {
   const deployConfig = getCloudRunDeployConfig(context);
 
   const getFullJobName = (name: string) =>
@@ -188,7 +188,7 @@ const getCloudRunJobsWithNames = (context: Context) => {
   const jobsWithNames = Object.entries(deployConfig.jobs ?? {})
     // filter out disabled jobs
     .filter((entry): entry is [string, DeployConfigCloudRunJob] =>
-      Boolean(entry[1])
+      Boolean(entry[1]),
     )
     .map(([name, job]) => ({
       jobName: getFullJobName(name),

package/src/deploy/cloudRun/createJobs/cloudRunServices.ts

@@ -1,5 +1,5 @@
 import { getLabels } from "../../../context/getLabels";
-import type { Context } from "../../../types/context";
+import type { ComponentContext } from "../../../types/context";
 
 import type { DeployConfigCloudRunService } from "../../types/googleCloudRun";
 import { createArgsString } from "../utils/createArgsString";
@@ -14,9 +14,9 @@ import { ENV_VARS_FILENAME } from "./constants";
 import { createVolumeConfig } from "./volumes";
 
 export const getServiceDeployScript = (
-  context: Context,
+  context: ComponentContext,
   service: DeployConfigCloudRunService | true | undefined,
-  nameSuffix?: string
+  nameSuffix?: string,
 ) => {
   const commonDeployArgs = getCommonDeployArgs(context);
 
@@ -54,20 +54,20 @@ export const getServiceDeployScript = (
       "cpu-boost": true,
       "execution-environment": customConfig?.executionEnvironment,
     },
-    ...createVolumeConfig(customConfig?.volumes, "service")
+    ...createVolumeConfig(customConfig?.volumes, "service"),
   );
   // volumes require beta
   const requiresBeta =
     customConfig?.volumes && Object.keys(customConfig?.volumes).length > 0;
 
   return `${gcloudRunCmd(
-    requiresBeta ? "beta" : undefined
+    requiresBeta ? "beta" : undefined,
   )} deploy ${fullServiceName} ${argsString}`;
 };
 
 export const getServiceDeleteScript = (
-  context: Context,
-  serviceSuffix?: string
+  context: ComponentContext,
+  serviceSuffix?: string,
 ) => {
   const commonArgs = getCommonCloudRunArgs(context);
 

package/src/deploy/cloudRun/createJobs/common.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../../../types/context";
+import type { ComponentContext } from "../../../types/context";
 
 import { isOfDeployType } from "../../types";
 import type { DeployConfigCloudRun } from "../../types/googleCloudRun";
@@ -16,7 +16,7 @@ export const gcloudSchedulerCmd = (version?: "beta") => {
 };
 
 export const setGoogleProjectNumberScript = (
-  deployConfig: DeployConfigCloudRun
+  deployConfig: DeployConfigCloudRun,
 ) => [
   `export GCLOUD_PROJECT_NUMBER=$(${gcloudCmd()} projects describe ${
     deployConfig.projectId
@@ -29,7 +29,7 @@ export const makeLabelString = (obj: Record<string, unknown>) =>
     .map(([key, value]) => `${key}=${value}`)
     .join(",");
 
-export const getCloudRunDeployConfig = (context: Context) => {
+export const getCloudRunDeployConfig = (context: ComponentContext) => {
   const deployConfig = context.componentConfig.deploy;
   if (!isOfDeployType(deployConfig, "google-cloudrun")) {
     // should not happen
@@ -38,7 +38,7 @@ export const getCloudRunDeployConfig = (context: Context) => {
   return deployConfig;
 };
 
-export function getCommonCloudRunArgs(context: Context) {
+export function getCommonCloudRunArgs(context: ComponentContext) {
   const deployConfig = getCloudRunDeployConfig(context);
   return {
     project: deployConfig.projectId,
@@ -46,7 +46,7 @@ export function getCommonCloudRunArgs(context: Context) {
   };
 }
 
-export function getCommonDeployArgs(context: Context) {
+export function getCommonDeployArgs(context: ComponentContext) {
   const commonArgs = getCommonCloudRunArgs(context);
   const deployConfig = getCloudRunDeployConfig(context);
   return {