@catladder/pipeline 1.80.4 → 1.81.1

package/examples/__snapshots__/cloud-run-with-sql.ts.snap

@@ -267,7 +267,7 @@ COPY --chown=node:node api/yarn.lock /app/api/yarn.lock",
           "gcloud beta run jobs create pan-test-app-dev-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=node --memory=512Mi",
           "set -e",
           "gcloud beta run jobs update pan-test-app-dev-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=node --memory=512Mi --env-vars-file=____envvars.yaml",
-          "gcloud run deploy pan-test-app-dev-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=node --env-vars-file=____envvars.yaml --allow-unauthenticated --min-instances=0 --max-instances=5",
+          "gcloud run deploy pan-test-app-dev-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=node --env-vars-file=____envvars.yaml --min-instances=0 --max-instances=5 --allow-unauthenticated",
           "gcloud beta run jobs execute pan-test-app-dev-api-migration --project=google-project-id --region=europe-west6",
           "docker image rm europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
@@ -1186,7 +1186,7 @@ COPY --chown=node:node api/yarn.lock /app/api/yarn.lock",
           "gcloud beta run jobs create pan-test-app-review-mr1234-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=node --memory=512Mi",
           "set -e",
           "gcloud beta run jobs update pan-test-app-review-mr1234-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=node --memory=512Mi --env-vars-file=____envvars.yaml",
-          "gcloud run deploy pan-test-app-review-mr1234-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=node --env-vars-file=____envvars.yaml --allow-unauthenticated --min-instances=0 --max-instances=5",
+          "gcloud run deploy pan-test-app-review-mr1234-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=node --env-vars-file=____envvars.yaml --min-instances=0 --max-instances=5 --allow-unauthenticated",
           "gcloud beta run jobs execute pan-test-app-review-mr1234-api-migration --project=google-project-id --region=europe-west6",
           "docker image rm europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
@@ -2203,7 +2203,7 @@ COPY --chown=node:node api/yarn.lock /app/api/yarn.lock",
           "gcloud beta run jobs create pan-test-app-prod-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=node --memory=512Mi",
           "set -e",
           "gcloud beta run jobs update pan-test-app-prod-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=node --memory=512Mi --env-vars-file=____envvars.yaml",
-          "gcloud run deploy pan-test-app-prod-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=node --env-vars-file=____envvars.yaml --allow-unauthenticated --min-instances=0 --max-instances=5",
+          "gcloud run deploy pan-test-app-prod-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=node --env-vars-file=____envvars.yaml --min-instances=0 --max-instances=5 --allow-unauthenticated",
           "gcloud beta run jobs execute pan-test-app-prod-api-migration --project=google-project-id --region=europe-west6",
           "docker image rm europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
@@ -2334,7 +2334,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "gcloud beta run jobs create pan-test-app-stage-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=node --memory=512Mi",
           "set -e",
           "gcloud beta run jobs update pan-test-app-stage-api-send-reminders --command="yarn,job:send-reminders" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=node --memory=512Mi --env-vars-file=____envvars.yaml",
-          "gcloud run deploy pan-test-app-stage-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=node --env-vars-file=____envvars.yaml --allow-unauthenticated --min-instances=0 --max-instances=5",
+          "gcloud run deploy pan-test-app-stage-api --command="yarn,start" --image=europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=google-project-id --region=europe-west6 --set-cloudsql-instances=projectId:region:instancename --labels=customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=node --env-vars-file=____envvars.yaml --min-instances=0 --max-instances=5 --allow-unauthenticated",
           "gcloud beta run jobs execute pan-test-app-stage-api-migration --project=google-project-id --region=europe-west6",
           "docker image rm europe-west6-docker.pkg.dev/google-project-id/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],

package/examples/cloud-run-non-public.ts

@@ -0,0 +1,27 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+        service: {
+          allowUnauthenticated: false,
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.80.4",
+  "version": "1.81.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/context/__tests__/resolveReferences.test.ts

@@ -17,12 +17,9 @@ describe("resolveReferences", () => {
         FOO: "foo from frontend",
       },
     };
-    const result = await resolveReferences(
-      variables,
-      async (componentName, variableName) => {
-        return otherVariables[componentName]?.[variableName];
-      }
-    );
+    const result = await resolveReferences(variables, async (componentName) => {
+      return otherVariables[componentName];
+    });
 
     expect(result).toEqual({
       a: "hello world",
@@ -53,12 +50,9 @@ describe("resolveReferences", () => {
         FOO: "foo from api",
       },
     };
-    const result = await resolveReferences(
-      variables,
-      async (componentName, variableName) => {
-        return otherVariables[componentName]?.[variableName];
-      }
-    );
+    const result = await resolveReferences(variables, async (componentName) => {
+      return otherVariables[componentName];
+    });
 
     expect(result).toEqual({
       FOO: "hello from foo from api",
@@ -72,12 +66,9 @@ describe("resolveReferences", () => {
       b: "a not found value looks like this: '${api:FOO}'",
     };
     const otherVariables: Record<string, Record<string, string>> = {};
-    const result = await resolveReferences(
-      variables,
-      async (componentName, variableName) => {
-        return otherVariables[componentName]?.[variableName];
-      }
-    );
+    const result = await resolveReferences(variables, async (componentName) => {
+      return otherVariables[componentName];
+    });
 
     expect(result).toEqual({
       a: "hello world",
@@ -97,12 +88,9 @@ describe("resolveReferences", () => {
         FOO: "hi, ${api:FOO}",
       },
     };
-    const result = await resolveReferences(
-      variables,
-      async (componentName, variableName) => {
-        return otherVariables[componentName]?.[variableName] ?? "";
-      }
-    );
+    const result = await resolveReferences(variables, async (componentName) => {
+      return otherVariables[componentName];
+    });
 
     expect(result).toEqual({
       a: "value is hi, foo from api!",
@@ -121,12 +109,9 @@ describe("resolveReferences", () => {
         FOO: "frontend ${api:FOO}",
       },
     };
-    const result = await resolveReferences(
-      variables,
-      async (componentName, variableName) => {
-        return otherVariables[componentName]?.[variableName] ?? "";
-      }
-    );
+    const result = await resolveReferences(variables, async (componentName) => {
+      return otherVariables[componentName];
+    });
 
     expect(result).toEqual({
       a: "value is frontend api ${frontend:FOO}!",

package/src/context/getEnvironmentVariables.ts

@@ -53,7 +53,7 @@ export const getEnvironmentVariables = async (
   } else {
     const additionalEnvVars = deployConfigRaw
       ? DEPLOY_TYPES[deployConfigRaw.type].getAdditionalEnvVars(
-          environmentContext
+          environmentContext as never
         )
       : {};
 
@@ -66,7 +66,9 @@ export const getEnvironmentVariables = async (
     predefinedVariables = {
       ...basePredefinedVariables,
       // Rails before 6.1 (mis)uses the `HOST` environment variable to specify the IP to bind to
-      ...(config.components[componentName].build.type === "rails" ? {} : {HOST: host}),
+      ...(config.components[componentName].build.type === "rails"
+        ? {}
+        : { HOST: host }),
       ROOT_URL: url,
       ...additionalEnvVars,
     };
@@ -75,7 +77,7 @@ export const getEnvironmentVariables = async (
 
   const additionalSecretKeys = deployConfigRaw
     ? DEPLOY_TYPES[deployConfigRaw.type].additionalSecretKeys(
-        environmentContext
+        environmentContext as never
       )
     : [];
 
@@ -115,7 +117,7 @@ export const getEnvironmentVariables = async (
 
   const envVars = await resolveReferences(
     envVarsRaw,
-    async (otherComponentName, variableName, alreadyVisited) => {
+    async (otherComponentName, alreadyVisited) => {
       const { envVars: otherEnvVars } = await getEnvironmentVariables(
         config,
         otherComponentName,
@@ -123,7 +125,7 @@ export const getEnvironmentVariables = async (
         commitInfo,
         alreadyVisited
       );
-      return otherEnvVars[variableName];
+      return otherEnvVars;
     },
     alreadyVisited
   );

package/src/context/resolveReferences.ts

@@ -7,9 +7,8 @@ export const resolveReferences = async (
   vars: Record<string, string>,
   getOtherVariables?: (
     componentName: string,
-    variableName: string,
     alreadyVisited: Record<string, Record<string, boolean>>
-  ) => Promise<string | null>,
+  ) => Promise<Record<string, string | null>>,
   alreadyVisitedBase: Record<string, Record<string, boolean>> = {}
 ) => {
   const replaceSingleValue = async (
@@ -30,10 +29,8 @@ export const resolveReferences = async (
             },
           });
           const result = componentName
-            ? (await getOtherVariables?.(
-                componentName,
-                variableName,
-                newAlreadyVisited
+            ? (await getOtherVariables?.(componentName, newAlreadyVisited).then(
+                (r) => r?.[variableName]
               )) ?? null
             : vars[variableName]; // is self reference
 

package/src/deploy/cloudRun/deployJob.ts

@@ -119,12 +119,17 @@ export const createGoogleCloudRunDeployJobs = (
       command: command ? '"' + command.split(" ").join(",") + '"' : undefined, // not sure if quotes are needed
       ...commonDeployArgs,
       "env-vars-file": "____envvars.yaml",
-      "allow-unauthenticated": true,
       "min-instances": customConfig?.minInstances,
       "max-instances": customConfig?.maxInstances,
       "no-cpu-throttling": customConfig?.noCpuThrottling,
     });
-    return `gcloud run deploy ${serviceName}${nameSuffix ?? ""} ${argsString}`;
+    const authenticationString =
+      customConfig?.allowUnauthenticated ?? true
+        ? "--allow-unauthenticated"
+        : "--no-allow-unauthenticated";
+    return `gcloud run deploy ${serviceName}${
+      nameSuffix ?? ""
+    } ${argsString} ${authenticationString}`;
   };
 
   const getJobCreateScriptsForJob = (

package/src/deploy/types/googleCloudRun.ts

@@ -85,9 +85,14 @@ export type DeployConfigCloudRunService = {
   maxInstances?: number;
 
   /**
-   * set to true for workers
+   * set to true to allways allocate cpu, e.g. for workers. Careful that this is expensive!
    */
   noCpuThrottling?: true;
+
+  /**
+   * whether to allow public access (defaults to true)
+   */
+  allowUnauthenticated?: boolean;
 };
 
 export type DeployConfigCloudRunJobBase = {