@catladder/pipeline 0.0.0-fix-command-710f75f1 → 0.0.0-fix-error-sql-db-delete-b3878c2e

package/src/types/jobs.ts

@@ -5,6 +5,7 @@ import type {
   GitlabRule,
   GitlabVariables,
   GitlabJobService,
+  GitlabJobImage,
 } from "./gitlab-types";
 
 export const BASE_STAGES = [
@@ -18,7 +19,9 @@ export const BASE_STAGES = [
 ] as const;
 export type BaseStage = typeof BASE_STAGES[number];
 
-export type CatladderJobNeed = string | { job: string; artifacts: boolean };
+export type CatladderJobNeed =
+  | string
+  | { job: string; artifacts: boolean; componentName?: string };
 export type CatladderJob<S = BaseStage> = {
   /**
    * the name of the job (without any env or app prefix and suffix)
@@ -52,9 +55,15 @@ export type CatladderJob<S = BaseStage> = {
 
   /**
    * does this require another job (from the same component)?
+   *
+   * You can also require a job from another component if you set `componentName`
+   *
    */
   needs?: Array<CatladderJobNeed>;
 
+  /**
+   * @deprecated set `componentName` to `needs` if you want to wait for a job from another component
+   */
   needsOtherComponent?: Array<{
     componentName: string;
     job: string;
@@ -78,7 +87,7 @@ export type CatladderJob<S = BaseStage> = {
   /**
    * image to use
    */
-  image?: string;
+  image?: GitlabJobImage;
 
   /**
    * variables to pass

package/src/utils/gitlab.ts

@@ -14,7 +14,7 @@ export const repeatOnFailure = (
   }
 ): string => {
   return `
-    until ${command} &> /dev/null
+    until ${command}
     do
       echo "Trying again."
       sleep ${options.pauseInSeconds}

package/dist/pipeline/createJobs.d.ts

@@ -1,3 +0,0 @@
-import type { PipelineJob } from "../types";
-import type { Config, PipelineTrigger } from "../types/config";
-export declare const createJobs: <T extends "gitlab">(type: T, envs: string[], config: Config, componentName: string, trigger: PipelineTrigger) => Promise<Record<string, PipelineJob<T>>>;

package/dist/pipeline/gitlab/makeGitlabJob.d.ts

@@ -1,10 +0,0 @@
-import type { GitlabJobDef } from "../../types";
-import type { CatladderJob } from "../../types/jobs";
-export declare const makeGitlabJob: ({
-  envMode,
-  needsStages,
-  needsOtherComponent,
-  name,
-  needs,
-  ...rest
-}: CatladderJob<string>) => GitlabJobDef;

package/dist/pipeline/gitlab/makeGitlabJob.js

@@ -1,44 +0,0 @@
-"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 __rest = this && this.__rest || function (s, e) {
-  var t = {};
-  for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
-  if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-    if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
-  }
-  return t;
-};
-exports.__esModule = true;
-exports.makeGitlabJob = void 0;
-var lodash_1 = require("lodash");
-var defaults_1 = require("../../defaults");
-var getJobName = function (need) {
-  return (0, lodash_1.isObject)(need) ? need.job : need;
-};
-var makeGitlabJob = function (_a) {
-  var envMode = _a.envMode,
-    needsStages = _a.needsStages,
-    needsOtherComponent = _a.needsOtherComponent,
-    name = _a.name,
-    needs = _a.needs,
-    rest = __rest(_a, ["envMode", "needsStages", "needsOtherComponent", "name", "needs"]);
-  return __assign(__assign({}, rest), {
-    // sort in a predictable manner for snapshot tests
-    needs: needs === null || needs === void 0 ? void 0 : needs.sort(function (a, b) {
-      return getJobName(a).localeCompare(getJobName(b));
-    }),
-    retry: defaults_1.BASE_RETRY,
-    interruptible: true
-  });
-};
-exports.makeGitlabJob = makeGitlabJob;

package/src/pipeline/createJobs.ts

@@ -1,199 +0,0 @@
-import { isFunction, isObject } from "lodash";
-import { BUILD_TYPES } from "../build";
-import { createContext } from "../context";
-import { DEPLOY_TYPES } from "../deploy";
-import type { PipelineJob, PipelineType } from "../types";
-import type { Config, PipelineTrigger } from "../types/config";
-import type { CommitInfo, Context } from "../types/context";
-import type { CatladderJob, CatladderJobNeed } from "../types/jobs";
-import { notNil } from "../utils";
-import { getBaseCommitInfo } from "./commitInfo/getCommitInfo";
-import { makeGitlabJob } from "./gitlab/makeGitlabJob";
-import { getPackageManagerInfo } from "./packageManager";
-
-const injectDefaultVarsInCustomJobs = (
-  context: Context,
-  jobs: CatladderJob[]
-) =>
-  jobs.map(({ variables, ...job }) => ({
-    variables: {
-      ...(context.environment.envVars ?? {}),
-      ...(variables ?? {}),
-    },
-    ...job,
-  }));
-const getCustomJobs = (context: Context) => {
-  if (!context.componentConfig.customJobs) {
-    return [];
-  }
-  const rawJobs = isFunction(context.componentConfig.customJobs)
-    ? context.componentConfig.customJobs(context)
-    : context.componentConfig.customJobs;
-  return injectDefaultVarsInCustomJobs(context, rawJobs);
-};
-const createRawJobs = (context: Context): CatladderJob[] => {
-  if (context.componentConfig.deploy === false) {
-    return [];
-  }
-  const buildJobs =
-    BUILD_TYPES[context.componentConfig.build.type].jobs(context);
-  const deployJobs =
-    DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context);
-
-  const customJobs = getCustomJobs(context);
-  return [...buildJobs, ...deployJobs, ...customJobs];
-};
-const getFullJobName = (
-  name: string,
-  componentName: string,
-  env?: string | null
-) => {
-  if (env) {
-    return `${componentName} ${name} | ${env} `;
-  }
-  return `${componentName} ${name}`;
-};
-
-const getFullReferencedJobName = (
-  referencedJobName: string,
-  componentName: string,
-  env: string,
-  allRawJobs: CatladderJob[]
-) => {
-  const referencedJob = allRawJobs.find((j) => j.name === referencedJobName);
-  if (!referencedJob) {
-    throw new Error("unknown job referenced: " + referencedJobName);
-  }
-  const envToSet = referencedJob.envMode !== "none" ? env : null;
-  return getFullJobName(referencedJobName, componentName, envToSet);
-};
-// replaces references to other jobs with the full name
-// the full name contains the componentname and the env name (if any)
-const replaceReferences = (
-  job: CatladderJob,
-  componentName: string,
-  env: string,
-  allRawJobs: CatladderJob[]
-): CatladderJob<string> => {
-  const stage =
-    job.envMode === "stagePerEnv" ? `${job.stage} ${env}` : job.stage;
-
-  const needsFromNeeds: CatladderJob["needs"] = job.needs?.map((n) =>
-    isObject(n)
-      ? {
-          job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
-          artifacts: n.artifacts,
-        }
-      : getFullReferencedJobName(n, componentName, env, allRawJobs)
-  );
-  const needsFromOtherComponents: CatladderJob["needs"] =
-    job.needsOtherComponent?.map((other) => ({
-      artifacts: other.artifacts,
-      job: getFullReferencedJobName(
-        other.job,
-        other.componentName,
-        env,
-        allRawJobs
-      ),
-    }));
-  const needs = [
-    ...(needsFromNeeds ?? []),
-    ...(needsFromOtherComponents ?? []),
-  ];
-  return {
-    ...job,
-    stage,
-    needs,
-    environment: job.environment?.on_stop
-      ? {
-          ...job.environment,
-          on_stop: getFullReferencedJobName(
-            job.environment.on_stop,
-            componentName,
-            env,
-            allRawJobs
-          ),
-        }
-      : job.environment,
-  };
-};
-
-// this can be removed once https://gitlab.com/gitlab-org/gitlab/-/issues/220758 is resolved
-const addStageNeeds = (jobs: CatladderJob[]): CatladderJob[] => {
-  // when a job defines needsStages, we add these as needs
-  return jobs.map((job) => {
-    if (!job.needsStages || job.needsStages.length === 0) {
-      return job;
-    }
-
-    const neededJobs = jobs
-      .map((j) => {
-        const neededStage = job.needsStages?.find((s) => j.stage === s.stage);
-        if (neededStage) {
-          return {
-            job: j.name,
-            artifacts: neededStage.artifacts ?? false,
-          };
-        }
-      })
-      .filter(notNil);
-    return {
-      ...job,
-
-      needs: [...(job.needs ?? []), ...neededJobs],
-    };
-  });
-};
-
-export const createJobs = async <T extends PipelineType>(
-  type: T,
-  envs: string[],
-  config: Config,
-  componentName: string,
-  trigger: PipelineTrigger
-): Promise<Record<string, PipelineJob<T>>> => {
-  const commitInfo: CommitInfo = {
-    ...(await getBaseCommitInfo()),
-    trigger,
-  };
-
-  const packageManagerInfo = await getPackageManagerInfo(config, componentName);
-
-  return envs.reduce(async (acc, env) => {
-    const context = await createContext(
-      config,
-      componentName,
-      env,
-      commitInfo,
-      packageManagerInfo
-    );
-    const jobs = addStageNeeds(createRawJobs(context));
-
-    const result = {
-      ...(await acc),
-      ...jobs.reduce<Record<string, PipelineJob<T>>>((acc, job) => {
-        const jobWithResolvedReferences = replaceReferences(
-          job,
-          componentName,
-          env,
-          jobs
-        );
-        const jobName = getFullJobName(
-          job.name,
-          componentName,
-          job.envMode !== "none" ? env : undefined
-        );
-        if (type === "gitlab") {
-          return {
-            ...acc,
-            [jobName]: makeGitlabJob(
-              jobWithResolvedReferences
-            ) as PipelineJob<T>,
-          };
-        }
-        throw new Error("not supported");
-      }, await Promise.resolve({})),
-    };
-    return result;
-  }, {});
-};

package/src/pipeline/gitlab/makeGitlabJob.ts

@@ -1,23 +0,0 @@
-import { isObject } from "lodash";
-import { BASE_RETRY } from "../../defaults";
-import type { GitlabJobDef } from "../../types";
-import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
-const getJobName = (need: CatladderJobNeed) =>
-  isObject(need) ? need.job : need;
-
-export const makeGitlabJob = ({
-  envMode,
-  needsStages,
-  needsOtherComponent,
-  name,
-  needs,
-  ...rest
-}: CatladderJob<string>): GitlabJobDef => {
-  return {
-    ...rest,
-    // sort in a predictable manner for snapshot tests
-    needs: needs?.sort((a, b) => getJobName(a).localeCompare(getJobName(b))),
-    retry: BASE_RETRY,
-    interruptible: true,
-  };
-};