Deprecate null as configuration value in TS.

Author: taeold

src/common/providers/tasks.ts

@@ -26,38 +26,39 @@ import { DecodedIdToken } from "firebase-admin/auth";
 import * as logger from "../../logger";
 import * as https from "./https";
 import { Expression } from "../../params";
+import { ResetValue } from "../options";
 
 /** How a task should be retried in the event of a non-2xx return. */
 export interface RetryConfig {
   /**
    * Maximum number of times a request should be attempted.
    * If left unspecified, will default to 3.
    */
-  maxAttempts?: number | Expression<number> | null;
+  maxAttempts?: number | Expression<number> | ResetValue;
 
   /**
    * Maximum amount of time for retrying failed task.
    * If left unspecified will retry indefinitely.
    */
-  maxRetrySeconds?: number | Expression<number> | null;
+  maxRetrySeconds?: number | Expression<number> | ResetValue;
 
   /**
    * The maximum amount of time to wait between attempts.
    * If left unspecified will default to 1hr.
    */
-  maxBackoffSeconds?: number | Expression<number> | null;
+  maxBackoffSeconds?: number | Expression<number> | ResetValue;
 
   /**
    * The maximum number of times to double the backoff between
    * retries. If left unspecified will default to 16.
    */
-  maxDoublings?: number | Expression<number> | null;
+  maxDoublings?: number | Expression<number> | ResetValue;
 
   /**
    * The minimum time to wait between attempts. If left unspecified
    * will default to 100ms.
    */
-  minBackoffSeconds?: number | Expression<number> | null;
+  minBackoffSeconds?: number | Expression<number> | ResetValue;
 }
 
 /** How congestion control should be applied to the function. */
@@ -66,13 +67,13 @@ export interface RateLimits {
    * The maximum number of requests that can be outstanding at a time.
    * If left unspecified, will default to 1000.
    */
-  maxConcurrentDispatches?: number | Expression<number> | null;
+  maxConcurrentDispatches?: number | Expression<number> | ResetValue;
 
   /**
    * The maximum number of requests that can be invoked per second.
    * If left unspecified, will default to 500.
    */
-  maxDispatchesPerSecond?: number | Expression<number> | null;
+  maxDispatchesPerSecond?: number | Expression<number> | ResetValue;
 }
 
 /** Metadata about the authorization used to invoke a function. */

src/v1/function-configuration.ts

@@ -82,33 +82,33 @@ export interface ScheduleRetryConfig {
    *
    * @defaultValue 0 (infinite retry)
    */
-  retryCount?: number | Expression<number> | ResetValue | null;
+  retryCount?: number | Expression<number> | ResetValue;
   /**
    * The time limit for retrying a failed job, measured from time when an execution was first attempted.
    *
    * If specified with {@link ScheduleRetryConfig.retryCount}, the job will be retried until both limits are reached.
    *
    * @defaultValue 0
    */
-  maxRetryDuration?: string | Expression<string> | ResetValue | null;
+  maxRetryDuration?: string | Expression<string> | ResetValue;
   /**
    * The minimum amount of time to wait before retrying a job after it fails.
    *
    * @defaultValue 5 seconds
    */
-  minBackoffDuration?: string | Expression<string> | ResetValue | null;
+  minBackoffDuration?: string | Expression<string> | ResetValue;
   /**
    * The maximum amount of time to wait before retrying a job after it fails.
    *
    * @defaultValue 1 hour
    */
-  maxBackoffDuration?: string | Expression<string> | ResetValue | null;
+  maxBackoffDuration?: string | Expression<string> | ResetValue;
   /**
    * The max number of backoff doubling applied at each retry.
    *
    * @defaultValue 5
    */
-  maxDoublings?: number | Expression<number> | ResetValue | null;
+  maxDoublings?: number | Expression<number> | ResetValue;
 }
 
 /**
@@ -139,11 +139,11 @@ export interface Schedule {
    *
    * The value of this field must be a time zone name from the tz database.
    */
-  timeZone?: string | ResetValue | null;
+  timeZone?: string | ResetValue;
   /**
    * Settings that determine the retry behavior.
    */
-  retryConfig?: ScheduleRetryConfig | ResetValue | null;
+  retryConfig?: ScheduleRetryConfig | ResetValue;
 }
 
 /**
@@ -173,32 +173,34 @@ export interface RuntimeOptions {
    * Failure policy of the function, with boolean `true` being equivalent to
    * providing an empty retry object.
    */
-  failurePolicy?: FailurePolicy | boolean | ResetValue | null;
+  failurePolicy?: FailurePolicy | boolean | ResetValue;
   /**
    * Amount of memory to allocate to the function.
    */
-  memory?: typeof VALID_MEMORY_OPTIONS[number] | ResetValue | null;
+  memory?: typeof VALID_MEMORY_OPTIONS[number] | ResetValue;
   /**
    * Timeout for the function in seconds, possible values are 0 to 540.
    */
-  timeoutSeconds?: number | ResetValue | null;
+  timeoutSeconds?: number | ResetValue;
 
   /**
    * Min number of actual instances to be running at a given time.
+   *
+   * @remarks
    * Instances will be billed for memory allocation and 10% of CPU allocation
    * while idle.
    */
-  minInstances?: number | ResetValue | null;
+  minInstances?: number | ResetValue;
 
   /**
    * Max number of actual instances allowed to be running in parallel.
    */
-  maxInstances?: number | ResetValue | null;
+  maxInstances?: number | ResetValue;
 
   /**
    * Connect cloud function to specified VPC connector.
    */
-  vpcConnector?: string | ResetValue | null;
+  vpcConnector?: string | ResetValue;
 
   /**
    * Egress settings for VPC connector.
@@ -208,7 +210,7 @@ export interface RuntimeOptions {
   /**
    * Specific service account for the function to run as.
    */
-  serviceAccount?: "default" | string | ResetValue | null;
+  serviceAccount?: "default" | string | ResetValue;
 
   /**
    * Ingress settings which control where this function can be called from.
@@ -232,6 +234,8 @@ export interface RuntimeOptions {
 
   /**
    * Determines whether Firebase AppCheck is enforced.
+   *
+   * @remarks
    * When true, requests with invalid tokens autorespond with a 401
    * (Unauthorized) error.
    * When false, requests with invalid tokens set context.app to undefiend.

src/v2/options.ts

@@ -90,53 +90,56 @@ export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERN
 export interface GlobalOptions {
   /**
    * Region where functions should be deployed.
-   * HTTP functions can override and specify more than one region.
    */
   region?: SupportedRegion | string;
 
   /**
    * Amount of memory to allocate to a function.
-   * A value of null restores the defaults of 256MB.
    */
-  memory?: MemoryOption | Expression<number> | ResetValue | null;
+  memory?: MemoryOption | Expression<number> | ResetValue;
 
   /**
    * Timeout for the function in sections, possible values are 0 to 540.
    * HTTPS functions can specify a higher timeout.
-   * A value of null restores the default of 60s
+   *
+   * @remarks
    * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
    * function depends on the type of function: Event handling functions have a
    * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
    * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
    * timeout of 1,800s (30 minutes)
    */
-  timeoutSeconds?: number | Expression<number> | ResetValue | null;
+  timeoutSeconds?: number | Expression<number> | ResetValue;
 
   /**
    * Min number of actual instances to be running at a given time.
+   *
+   * @remarks
    * Instances will be billed for memory allocation and 10% of CPU allocation
    * while idle.
-   * A value of null restores the default min instances.
    */
-  minInstances?: number | Expression<number> | ResetValue | null;
+  minInstances?: number | Expression<number> | ResetValue;
 
   /**
    * Max number of instances to be running in parallel.
-   * A value of null restores the default max instances.
    */
-  maxInstances?: number | Expression<number> | ResetValue | null;
+  maxInstances?: number | Expression<number> | ResetValue;
 
   /**
    * Number of requests a function can serve at once.
+   *
+   * @remarks
    * Can only be applied to functions running on Cloud Functions v2.
    * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
    * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
    * The maximum value for concurrency is 1,000.
    */
-  concurrency?: number | Expression<number> | ResetValue | null;
+  concurrency?: number | Expression<number> | ResetValue;
 
   /**
    * Fractional number of CPUs to allocate to a function.
+   *
+   * @remarks
    * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
    * This is different from the defaults when using the gcloud utility and is different from
    * the fixed amount assigned in Google Cloud Functions generation 1.
@@ -147,43 +150,37 @@ export interface GlobalOptions {
 
   /**
    * Connect cloud function to specified VPC connector.
-   * A value of null removes the VPC connector
    */
-  vpcConnector?: string | ResetValue | null;
+  vpcConnector?: string | ResetValue;
 
   /**
    * Egress settings for VPC connector.
-   * A value of null turns off VPC connector egress settings
    */
-  vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue | null;
+  vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;
 
   /**
    * Specific service account for the function to run as.
-   * A value of null restores the default service account.
    */
-  serviceAccount?: string | ResetValue | null;
+  serviceAccount?: string | ResetValue;
 
   /**
    * Ingress settings which control where this function can be called from.
-   * A value of null turns off ingress settings.
    */
-  ingressSettings?: IngressSetting | ResetValue | null;
+  ingressSettings?: IngressSetting | ResetValue;
 
   /**
    * User labels to set on the function.
    */
   labels?: Record<string, string>;
 
-  /**
-   * Invoker to set access control on https functions.
-   */
-  invoker?: "public" | "private" | string | string[];
-
   /*
    * Secrets to bind to a function.
    */
   secrets?: string[];
 
+  /** Whether failed executions should be delivered again. */
+  retry?: boolean | Expression<boolean> | ResetValue;
+
   /**
    * Determines whether Firebase AppCheck is enforced.
    * When true, requests with invalid tokens autorespond with a 401
@@ -225,14 +222,14 @@ export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppChec
   eventFilterPathPatterns?: Record<string, string | Expression<string>>;
 
   /** Whether failed executions should be delivered again. */
-  retry?: boolean | Expression<boolean> | ResetValue | null;
+  retry?: boolean | Expression<boolean> | ResetValue;
 
   /** Region of the EventArc trigger. */
   // region?: string | Expression<string> | null;
   region?: string;
 
   /** The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account. */
-  serviceAccount?: string | ResetValue | null;
+  serviceAccount?: string | ResetValue;
 
   /** The name of the channel where the function receives events. */
   channel?: string;