@catladder/pipeline 1.141.1 → 1.142.1

package/src/deploy/types/googleCloudRun.ts

@@ -62,6 +62,21 @@ export type DeployConfigCloudRunCloudSql = {
    */
   deleteDatabaseOnStop?: boolean;
 
+  /**
+   * format of the `DATABASE_URL` environment variable
+   *
+   * the options are:
+   * - prisma: adds [required but ignored hostname](https://www.prisma.io/docs/orm/overview/databases/postgresql#connecting-via-sockets):
+   *   `postgresql://$DB_USER:$DB_PASSWORD@localhost/$DB_NAME?host=/cloudsql/$CLOUD_SQL_INSTANCE_CONNECTION_NAME`
+   * - rails: percent-encodes the socket in the host part
+   *   `postgresql://$DB_USER:$DB_PASSWORD@%2Fcloudsql%2FprojectId%3Aregion%3Ainstancename/$DB_NAME?`
+   * - jdbc: for use with Google Cloud SQL Connector for Java
+   *   `jdbc:postgresql:///$DB_NAME?cloudSqlInstance=$CLOUD_SQL_INSTANCE_CONNECTION_NAME&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=$DB_USER&password=$DB_PASSWORD`
+   *
+   * defaults to prisma
+   */
+  dbConnectionStringFormat?: "prisma" | "rails" | "jdbc";
+
   /**
    * add additional query params to the database connection string
    */

package/src/pipeline/createChildPipeline.ts

@@ -1,11 +1,9 @@
-import { getAllEnvsInAllComponents } from "../config";
-import { RULES_ALWAYS } from "../rules";
-import { getRunnerImage } from "../runner";
-import type { GitlabPipeline, Pipeline, PipelineType } from "../types";
+import type { Pipeline, PipelineType } from "../types";
 import type { Config, PipelineTrigger } from "../types/config";
-import { BASE_STAGES } from "../types/jobs";
 import { createAllJobs } from "./createAllJobs";
+import { getPipelineStages } from "./getPipelineStages";
 import { createGitlabJobs } from "./gitlab/createGitlabJobs";
+import { createGitlabPipelineFromStagesAndJobs } from "./gitlab/createGitlabPipeline";
 
 export const createChildPipeline = async <T extends PipelineType>(
   type: T,
@@ -13,34 +11,14 @@ export const createChildPipeline = async <T extends PipelineType>(
   config: Config
 ): Promise<Pipeline<T>> => {
   const jobs = await createAllJobs(config, trigger);
+  const stages = getPipelineStages(config);
 
-  // while technically not required, we group different envs in its own stage
-  // each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
-  // this is just so that it looks nicer in gitlab and makes running mutliple manual tasks more easy to use
-
-  const allEnvs = getAllEnvsInAllComponents(config);
-  const stages = BASE_STAGES.reduce<string[]>(
-    (acc, baseStage) => [
-      ...acc,
-      baseStage,
-      ...allEnvs.map((e) => `${baseStage} ${e}`),
-    ],
-    []
-  );
   if (type === "gitlab") {
-    const pipeline: GitlabPipeline = {
-      image: getRunnerImage("jobs-default"), // default image
-      variables: {
-        FF_USE_FASTZIP: "true",
-        GIT_DEPTH: 1, // no need the full depth
-      },
-      workflow: {
-        rules: RULES_ALWAYS,
-      },
+    const gitlabJobs = await createGitlabJobs(jobs);
+    return createGitlabPipelineFromStagesAndJobs(
       stages,
-      jobs: await createGitlabJobs(jobs),
-    };
-    return pipeline as Pipeline<T>;
+      gitlabJobs
+    ) as Pipeline<T>;
   }
   throw new Error(`${type} is not supported`);
 };

package/src/pipeline/getPipelineStages.ts

@@ -0,0 +1,22 @@
+import { getAllEnvsInAllComponents } from "../config";
+import type { Config } from "../types/config";
+import { BASE_STAGES } from "../types/jobs";
+
+/**
+ * 
+  while technically not required, we group different envs in its own stage
+  each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
+  this is just so that it looks nicer in gitlab and makes running mutliple manual tasks more easy to use
+ */
+export function getPipelineStages(config: Config) {
+  const allEnvs = getAllEnvsInAllComponents(config);
+  const stages = BASE_STAGES.reduce<string[]>(
+    (acc, baseStage) => [
+      ...acc,
+      baseStage,
+      ...allEnvs.map((e) => `${baseStage} ${e}`),
+    ],
+    []
+  );
+  return stages;
+}

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -5,7 +5,7 @@ import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
 import type { AllCatladderJobs } from "../createAllJobs";
 import { notNil } from "../../utils";
 
-type AllGitlabJobs = Record<string, GitlabJobDef>;
+export type AllGitlabJobs = Record<string, GitlabJobDef>;
 
 const removeUndefined = <T extends Record<string, unknown>>(obj: T): T =>
   Object.fromEntries(

package/src/pipeline/gitlab/createGitlabPipeline.ts

@@ -0,0 +1,22 @@
+import { RULES_ALWAYS } from "../../rules";
+import { getRunnerImage } from "../../runner";
+import type { Pipeline } from "../../types";
+import type { AllGitlabJobs } from "./createGitlabJobs";
+
+export function createGitlabPipelineFromStagesAndJobs(
+  stages: string[],
+  gitlabJobs: AllGitlabJobs
+): Pipeline<"gitlab"> {
+  return {
+    image: getRunnerImage("jobs-default"), // default image
+    variables: {
+      FF_USE_FASTZIP: "true",
+      GIT_DEPTH: 1, // no need the full depth
+    },
+    workflow: {
+      rules: RULES_ALWAYS,
+    },
+    stages,
+    jobs: gitlabJobs,
+  };
+}