Allow v1 and v2 functions to set the Omit option on a function (#1298)

Author: Berlioz

src/runtime/manifest.ts

@@ -32,6 +32,7 @@ import { WireParamSpec } from "../params/types";
 export interface ManifestEndpoint {
   entryPoint?: string;
   region?: string[];
+  omit?: boolean | Expression<boolean>;
   platform?: string;
   availableMemoryMb?: number | Expression<number> | ResetValue;
   maxInstances?: number | Expression<number> | ResetValue;

src/v1/cloud-functions.ts

@@ -597,6 +597,7 @@ export function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint
   copyIfPresent(
     endpoint,
     options,
+    "omit",
     "minInstances",
     "maxInstances",
     "ingressSettings",

src/v1/function-configuration.ts

@@ -252,6 +252,10 @@ export interface RuntimeOptions {
  * Configuration options for a function that applies during function deployment.
  */
 export interface DeploymentOptions extends RuntimeOptions {
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
   /**
    * Regions where function should be deployed.
    */

src/v2/options.ts

@@ -94,6 +94,11 @@ export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERN
  * These options are common to HTTPS and Event handling functions.
  */
 export interface GlobalOptions {
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */
@@ -317,6 +322,7 @@ export function optionsToEndpoint(
   copyIfPresent(
     endpoint,
     opts,
+    "omit",
     "concurrency",
     "minInstances",
     "maxInstances",

src/v2/providers/alerts/alerts.ts

@@ -86,6 +86,11 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
   /** Scope the function to trigger on a specific application. */
   appId?: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/alerts/appDistribution.ts

@@ -97,6 +97,11 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
   /** Scope the function to trigger on a specific application. */
   appId?: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/alerts/crashlytics.ts

@@ -177,6 +177,11 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
   /** Scope the function to trigger on a specific application. */
   appId?: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/database.ts

@@ -98,6 +98,11 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
    */
   instance?: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/eventarc.ts

@@ -62,6 +62,11 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
    */
   filters?: Record<string, string>;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/https.ts

@@ -50,6 +50,11 @@ export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
  * Options that can be set on an onRequest HTTPS function.
  */
 export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /** HTTP functions can override global options and can specify multiple regions to deploy to. */
   region?: SupportedRegion | string | Array<SupportedRegion | string>;
 

src/v2/providers/identity.ts

@@ -64,6 +64,11 @@ export interface BlockingOptions {
   /** Pass the Refresh Token credential to the function. */
   refreshToken?: boolean;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/pubsub.ts

@@ -155,6 +155,11 @@ export interface PubSubOptions extends options.EventHandlerOptions {
   /** The Pub/Sub topic to watch for message events */
   topic: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/storage.ts

@@ -203,6 +203,11 @@ export interface StorageOptions extends options.EventHandlerOptions {
   /** The name of the bucket containing this object. */
   bucket?: string;
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */

src/v2/providers/tasks.ts

@@ -60,6 +60,11 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
    */
   invoker?: "private" | string | string[];
 
+  /**
+   * If true, do not deploy or emulate this function.
+   */
+  omit?: boolean | Expression<boolean>;
+
   /**
    * Region where functions should be deployed.
    */