@catladder/pipeline 1.59.0 → 1.60.0

package/src/deploy/index.ts

@@ -1,13 +1,14 @@
 import type { Context } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 import type { CatladderJob } from "../types/jobs";
+import type { PartialDeep } from "../types/utils";
 import { GCLOUD_RUN_DEPLOY_TYPE } from "./cloudRun";
 import { CUSTOM_DEPLOY_TYPE } from "./custom";
 import { DOCKER_TAG_DEPLOY_TYPE } from "./dockerTag";
 import { KUBERNETES_DEPLOY_TYPE } from "./kubernetes";
 import type { DeployConfigGeneric, DeployConfigType } from "./types";
 export * from "./cloudRun";
-export * from "./cloudSql";
+export * from "./kubernetes/cloudSql";
 export * from "./kubernetes";
 export * from "./types";
 export * from "./utils";
@@ -16,7 +17,7 @@ export type DeployTypeDefinition<T extends DeployConfigType> = {
   jobs: (context: Context) => CatladderJob[];
   defaults: (
     envContext: EnvironmentContext<any, T>
-  ) => Partial<DeployConfigGeneric<T>>;
+  ) => PartialDeep<DeployConfigGeneric<T>>;
   additionalSecretKeys: (envContext: EnvironmentContext<any, T>) => string[];
   getAdditionalEnvVars: (
     envContext: EnvironmentContext<any, T>

package/src/deploy/{cloudSql → kubernetes/cloudSql}/index.ts

@@ -1,14 +1,14 @@
-import type { Context } from "../../types";
-import { isOfDeployType } from "../types";
+import type { Context } from "../../../types";
+import { isOfDeployType } from "../../types";
 
-export const hasCloudSQL = (context: Context) => {
+export const hasKubernetesCloudSQL = (context: Context) => {
   if (isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
     return context.componentConfig.deploy.values?.cloudsql?.enabled;
   }
   return false;
 };
 
-export const getCloudSQLConfig = (context: Context) => {
+export const getKubernetesCloudSQLConfig = (context: Context) => {
   if (isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
     return context.componentConfig.deploy.values?.cloudsql;
   }

package/src/deploy/kubernetes/kubeValues.ts

@@ -2,7 +2,7 @@ import { merge } from "lodash";
 
 import type { Context } from "../../types/context";
 import { mergeWithMergingArrays } from "../../utils";
-import { hasCloudSQL } from "../cloudSql";
+import { hasKubernetesCloudSQL } from "./cloudSql";
 import type { DeployConfigKubernetesValues } from "../types";
 import { isOfDeployType } from "../types";
 import { createCloudsqlBaseConfig } from "./cloudsql";
@@ -68,7 +68,7 @@ export const createKubeValues = (context: Context) => {
       env,
       application: createAppConfig(context, application),
     },
-    hasCloudSQL(context) ? createCloudsqlBaseConfig(context) : {},
+    hasKubernetesCloudSQL(context) ? createCloudsqlBaseConfig(context) : {},
     deployConfig.values?.mongodb?.enabled
       ? createMongodbBaseConfig(context)
       : {}

package/src/deploy/types/googleCloudRun.ts

@@ -37,6 +37,21 @@ export type Gcloudregion =
   | "us-west3"
   | "us-west4";
 
+export type DeployConfigCloudRunCloudSql = {
+  type: "unmanaged";
+  instanceConnectionName: string;
+  /**
+   * the prefix of the database, the full db name is this plus the environment slug
+   *
+   * defaults to customerName-appName
+   */
+  dbNamePrefix?: string | false;
+  /**
+   * whether to delete the database if the environment is stopped
+   * defaults to true for review envs, to false for every other environment
+   */
+  deleteDatabaseOnStop?: boolean;
+};
 export type DeployConfigCloudRunService = {
   /**
    * command / entrypoint, fallsback to buildConfig.startcommand
@@ -51,6 +66,11 @@ export type DeployConfigCloudRunJob = {
   command: string;
 
   when: "manual" | "preDeploy" | "postDeploy";
+
+  /**
+   * memory limit of the job, defaults to 51Mi
+   */
+  memory?: `${number}${"M" | "G" | "Mi" | "Gi"}`;
 };
 export type DeployConfigCloudRun = {
   /**
@@ -76,6 +96,11 @@ export type DeployConfigCloudRun = {
   service?: boolean | DeployConfigCloudRunService;
 
   jobs?: {
-    [name: string]: DeployConfigCloudRunJob;
+    [name: string]: DeployConfigCloudRunJob | false | null;
   };
+
+  /**
+   * add cloudSql
+   */
+  cloudSql?: DeployConfigCloudRunCloudSql | false;
 } & DeployConfigBase;

package/src/types/config.ts

@@ -1,8 +1,9 @@
 import type { BuildConfig } from "../build/types";
 import type { DeployConfig } from "../deploy/types";
-import type { PartialDeep } from "type-fest";
+
 import type { CatladderJob } from "./jobs";
 import type { Context } from "./context";
+import type { PartialDeep } from "./utils";
 export type PipelineTrigger = "mainBranch" | "mr" | "taggedRelease";
 
 /**

package/src/types/utils.ts

@@ -0,0 +1,7 @@
+export type PartialDeep<T> = T extends any[]
+  ? T
+  : T extends Record<string, any>
+  ? {
+      [P in keyof T]?: PartialDeep<T[P]>;
+    }
+  : T;

package/src/utils/gitlab.ts

@@ -3,3 +3,21 @@ export const allowFailureInScripts = (script: string[]): string[] => [
   ...script,
   "set -e", // reenable
 ];
+
+export const sanitizeForBashVariable = (name: string) =>
+  name.replace(/-/g, "_");
+
+export const repeatOnFailure = (
+  command: string,
+  options: {
+    pauseInSeconds: number;
+  }
+): string => {
+  return `
+    until ${command} &> /dev/null
+    do
+      echo "Trying again."
+      sleep ${options.pauseInSeconds}
+    done
+  `;
+};

package/dist/deploy/cloudSql/index.d.ts

@@ -1,8 +0,0 @@
-import type { Context } from "../../types";
-export declare const hasCloudSQL: (context: Context) => boolean | undefined;
-export declare const getCloudSQLConfig: (context: Context) => {
-  enabled: boolean;
-  instanceId?: string | undefined;
-  projectId?: string | undefined;
-  region?: string | undefined;
-} | undefined;

package/examples/test.catladder.ts

@@ -1,26 +0,0 @@
-import type { Config } from "../src";
-
-const config: Config = {
-  appName: "test-app",
-  customerName: "pan",
-  components: {
-    api: {
-      dir: "api",
-      build: {
-        type: "node",
-      },
-      deploy: {
-        type: "google-cloudrun",
-        projectId: "asdf",
-        region: "asia-east1",
-        jobs: {
-          migration: {
-            command: "yarn migrate",
-          },
-        },
-      },
-    },
-  },
-};
-
-export default config;