@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-perf-cli-reduce-bundle-size-with-tsconfig-optimization-3556aaa4

package/src/deploy/types.ts

@@ -1,189 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type DeployConfigBase = {
-  /**
-   * whether to deploy automatically or manual. If not defined, these rules apply:
-   * - prod: manual
-   * - all other envs: auto
-   */
-  when?: "manual" | "auto";
-};
-type AllowUnknownProps<T extends Record<string, unknown>> = T &
-  Record<string, unknown>;
-
-export type DeployConfigKubernetesClusterGCloud = {
-  type: "gcloud";
-  /**
-   * gcoud name of the cluster
-   */
-  name: string;
-  /**
-   * google cloud project id
-   */
-  projectId: string;
-  /**
-   * region
-   */
-  region: string;
-  /**
-   * domain of the cluster, for canonical domains without custom host (e.g. review and dev apps)
-   */
-  domainCanonical?: string;
-};
-export type DeployConfigKubernetesCluster = DeployConfigKubernetesClusterGCloud; // currently only this
-
-export type KubernetesAutoscaleMetricResourceTarget =
-  | {
-      type: "Utilization";
-      averageUtilization: number;
-    }
-  | {
-      type: "AverageValue";
-      averageValue: number | string;
-    };
-export type KubernetesAutoscaleMetric = {
-  type: "Resource";
-  resource: {
-    name: "cpu" | "memory";
-    target: KubernetesAutoscaleMetricResourceTarget;
-  };
-};
-export type KubernetesAutoscale = {
-  minReplicas: number;
-  maxReplicas: number;
-  /**
-   * declare a number of metrics (at least one). Usually you would use cpu as a metric
-   */
-  metrics: KubernetesAutoscaleMetric[];
-};
-type KubernetesHealthDef = {
-  httpGet?: {
-    path?: string;
-    port?: number;
-    httpHeaders?: {
-      name: string;
-      value: string;
-    }[];
-    failureThreshold?: number;
-    timeoutSeconds?: number;
-    periodSeconds?: number;
-    successThreshold?: number;
-  };
-};
-export type DeployConfigKubernetesValues = AllowUnknownProps<{
-  /**
-   * enable cloudsql db. Currently you have to manually set it up
-   */
-  cloudsql?: {
-    enabled: boolean;
-    instanceId?: string;
-    projectId?: string;
-    region?: string;
-  };
-  /**
-   * enable mongodb. The mongodb is deployed using a helm chart.
-   * Consider using external services instead of this.
-   */
-  mongodb?: AllowUnknownProps<{
-    enabled: boolean;
-  }>;
-  /**
-   * enable mailhog. Mailhog is a virtual mail server that catches all outgoing mailsl and show them in a mailbox.
-   * This is great for development as it prevents to accidentially send out real emails and helps with debugging outgoing mails.
-   *
-   * It will automaticaly inject a MAIL_URL env var.
-   *
-   * Turn it of for production.
-   */
-  mailhog?: {
-    enabled: boolean;
-  };
-  /**
-   * post-install/upgrade jobs. These use the app image and have all env vars available.
-   * Typically used for migrations and seeds
-   */
-  jobs?: Record<string, AllowUnknownProps<{ command: string }>>;
-  /**
-   * cronjobs that run periodically. These use the app image have all env vars available.
-   */
-  cronjobs?: Record<
-    string,
-    AllowUnknownProps<{
-      schedule: string;
-      command: string;
-      concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
-    }>
-  >;
-  /**
-   * configuration for the application ("Deployment" in kubernetes)
-   */
-  application?: AllowUnknownProps<{
-    /**
-     * redirects
-     */
-    redirects?: AllowUnknownProps<{ host: string }>[];
-    /**
-     * how many pods will be started
-     */
-    replicas?: number;
-
-    /**
-     * autoscale the pods horizontally
-     */
-    autoscale?: KubernetesAutoscale;
-    /**
-     * kubernetes resources
-     */
-    resources?: {
-      limits?: {
-        cpu?: string;
-        memory?: string;
-      };
-      requests?: {
-        cpu?: string;
-        memory?: string;
-      };
-    };
-    healthRoute?: string;
-    startupProbe?: KubernetesHealthDef;
-    readinessProbe?: KubernetesHealthDef;
-    livenessProbe?: KubernetesHealthDef;
-  }>;
-  /**
-   * Mount secrets as files in the filesystem.
-   * These secrets are still available as env vars, but will contain the path of the file instead
-   */
-  secretsAsFile?: string[];
-}>;
-
-export type DeployConfigKubernetes = {
-  type: "kubernetes";
-  /**
-   * cluster config to use.
-   */
-  cluster: DeployConfigKubernetesCluster;
-  /**
-   * prints out debug info (helm --debug)
-   */
-  debug?: boolean;
-  additionalHelmArgs?: string[];
-  /**
-   * values to configure the app
-   */
-  values?: DeployConfigKubernetesValues;
-} & DeployConfigBase;
-
-type DeployConfigCustom = {
-  type: "custom";
-  requiresDocker: boolean;
-  script: string[];
-  stopScript?: string[];
-} & DeployConfigBase;
-
-export type DeployConfig = DeployConfigKubernetes | DeployConfigCustom;
-
-export const isOfDeployType = <T extends Array<DeployConfig["type"]>>(
-  t: DeployConfig | false,
-  ...types: T
-): t is Extract<DeployConfig, { type: T[number] }> => {
-  return t && types.includes(t.type);
-};

package/src/pipeline/createChildPipeline.test.ts

@@ -1,49 +0,0 @@
-import { Config } from "../types";
-import { createChildPipeline } from "./createChildPipeline";
-
-describe("createChildPipeline", () => {
-  describe("node-app to kuberntes", () => {
-    const config: Config = {
-      appName: "test",
-      customerName: "pan",
-      components: {
-        "my-app": {
-          dir: "myapp",
-          build: {
-            type: "node",
-          },
-          deploy: {
-            type: "kubernetes",
-            cluster: {
-              type: "gcloud",
-              name: "mega-cluster",
-              projectId: "super-google-project",
-              region: "ch-blabla",
-            },
-          },
-        },
-      },
-    };
-
-    it("creates a pipeline for a single app on the main branch", async () => {
-      const { image, jobs } = await createChildPipeline(
-        "gitlab",
-        "mainBranch",
-        config
-      );
-      expect(image).toEqual(
-        "git.panter.ch:5001/catladder/catladder/base-pipeline:"
-      );
-
-      expect(Object.keys(jobs)).toEqual([
-        "my-app audit",
-        "my-app lint",
-        "my-app test",
-        "dev my-app app-build",
-        "dev my-app docker-build",
-        "dev my-app deploy-to-kubernetes",
-        "dev my-app kubernetes-stop",
-      ]);
-    });
-  });
-});

package/src/pipeline/createJobs.ts

@@ -1,195 +0,0 @@
-import { exec } from "child-process-promise";
-import { isFunction, isObject } from "lodash";
-import { BUILD_TYPES } from "../build";
-import { createContext } from "../context";
-import { DEPLOY_TYPES } from "../deploy";
-import { PipelineJob, PipelineType } from "../types";
-import { Config, PipelineTrigger } from "../types/config";
-import { CommitInfo, Context } from "../types/context";
-import { CatladderJob } from "../types/jobs";
-import { notNil } from "../utils";
-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;
-  return {
-    ...job,
-    stage,
-    needs: job.needs?.map((n) =>
-      isObject(n)
-        ? {
-            job: getFullReferencedJobName(
-              n.job,
-              componentName,
-              env,
-              allRawJobs
-            ),
-            artifacts: n.artifacts,
-          }
-        : getFullReferencedJobName(n, componentName, env, allRawJobs)
-    ),
-    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 = {
-    refName: process.env.CI_COMMIT_REF_NAME ?? "unknown",
-    reviewSlug: process.env.CI_MERGE_REQUEST_IID
-      ? `mr${process.env.CI_MERGE_REQUEST_IID}`
-      : "unknown",
-    buildTime: new Date().toISOString(),
-    buildId: await exec("git describe --tags || git rev-parse HEAD").then((s) =>
-      s.stdout.trim()
-    ),
-    trigger,
-  };
-
-  const packageManagerInfo = await getPackageManagerInfo(config, componentName);
-
-  return envs.reduce((acc, env) => {
-    const context = createContext(
-      config,
-      componentName,
-      env,
-      commitInfo,
-      packageManagerInfo
-    );
-    const jobs = addStageNeeds(createRawJobs(context));
-
-    const result = {
-      ...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");
-      }, {}),
-    };
-    return result;
-  }, {});
-};

package/src/pipeline/gitlab/makeGitlabJob.ts

@@ -1,16 +0,0 @@
-import { BASE_RETRY } from "../../defaults";
-import { GitlabJobDef } from "../../types";
-import { CatladderJob } from "../../types/jobs";
-
-export const makeGitlabJob = ({
-  envMode,
-  needsStages,
-  name,
-  ...rest
-}: CatladderJob<string>): GitlabJobDef => {
-  return {
-    ...rest,
-    retry: BASE_RETRY,
-    interruptible: true,
-  };
-};