Adds an omit parametrized configuration option for functions to skip …

…deploy (#5117)
firebase · Nov 9, 2022 · dc44460 · dc44460
1 parent be10d72
commit dc44460
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/src/deploy/functions/build.ts b/src/deploy/functions/build.ts
@@ -220,6 +220,9 @@ export const AllIngressSettings: IngressSetting[] = [
 ];
 
 export type Endpoint = Triggered & {
+  // Defaults to false. If true, the function will be ignored during the deploy process.
+  omit?: Field<boolean>;
+
   // Defaults to "gcfv2". "Run" will be an additional option defined later
   platform?: "gcfv1" | "gcfv2";
 
@@ -413,6 +416,9 @@ export function toBackend(
   const bkEndpoints: Array<backend.Endpoint> = [];
   for (const endpointId of Object.keys(build.endpoints)) {
     const bdEndpoint = build.endpoints[endpointId];
+    if (r.resolveBoolean(bdEndpoint.omit || false)) {
+      continue;
+    }
 
     let regions = bdEndpoint.region;
     if (typeof regions === "undefined") {

diff --git a/src/deploy/functions/runtimes/discovery/v1alpha1.ts b/src/deploy/functions/runtimes/discovery/v1alpha1.ts
@@ -44,6 +44,7 @@ export type WireEndpoint = build.Triggered &
   Partial<build.TaskQueueTriggered> &
   Partial<build.BlockingTriggered> &
   Partial<{ scheduleTrigger: WireScheduleTrigger }> & {
+    omit?: build.Field<boolean>;
     labels?: Record<string, string> | null;
     environmentVariables?: Record<string, string> | null;
     availableMemoryMb?: build.MemoryOption | build.Expression<number> | null;
@@ -124,6 +125,7 @@ function assertBuildEndpoint(ep: WireEndpoint, id: string): void {
     region: "array",
     platform: (platform) => build.AllFunctionsPlatforms.includes(platform),
     entryPoint: "string",
+    omit: "Field<boolean>?",
     availableMemoryMb: (mem) => mem === null || isCEL(mem) || build.isValidMemoryOption(mem),
     maxInstances: "Field<number>?",
     minInstances: "Field<number>?",
@@ -395,6 +397,7 @@ function parseEndpointForBuild(
   copyIfPresent(
     parsed,
     ep,
+    "omit",
     "availableMemoryMb",
     "cpu",
     "maxInstances",

diff --git a/src/test/deploy/functions/build.spec.ts b/src/test/deploy/functions/build.spec.ts
@@ -44,6 +44,35 @@ describe("toBackend", () => {
     }
   });
 
+  it("doesn't populate if omit is set on the build", () => {
+    const desiredBuild: build.Build = build.of({
+      func: {
+        omit: true,
+        platform: "gcfv1",
+        region: ["us-central1"],
+        project: "project",
+        runtime: "nodejs16",
+        entryPoint: "func",
+        maxInstances: 42,
+        minInstances: 1,
+        serviceAccount: "service-account-1@",
+        vpc: {
+          connector: "projects/project/locations/region/connectors/connector",
+          egressSettings: "PRIVATE_RANGES_ONLY",
+        },
+        ingressSettings: "ALLOW_ALL",
+        labels: {
+          test: "testing",
+        },
+        httpsTrigger: {
+          invoker: ["public"],
+        },
+      },
+    });
+    const backend = build.toBackend(desiredBuild, {});
+    expect(Object.keys(backend.endpoints).length).to.equal(0);
+  });
+
   it("populates multiple specified invokers correctly", () => {
     const desiredBuild: build.Build = build.of({
       func: {