Insert Expression and Field types into GlobalOptions and inheriting types

src/runtime/manifest.ts

@@ -27,12 +27,12 @@ export interface ManifestEndpoint {
  entryPoint?: string;
  region?: string[];
  platform?: string;
- availableMemoryMb?: number;
- maxInstances?: number;
- minInstances?: number;
- concurrency?: number;
+ availableMemoryMb?: number | string;
+ maxInstances?: number | string;
+ minInstances?: number | string;
+ concurrency?: number | string;
  serviceAccountEmail?: string;
- timeoutSeconds?: number;
+ timeoutSeconds?: number | string;
  cpu?: number | 'gcf_gen1';
  vpc?: {
  connector: string;

src/v2/core.ts

@@ -27,16 +27,17 @@
 
 import { Change } from '../common/change';
 import { ManifestEndpoint } from '../runtime/manifest';
+import { Expression } from './expressions';
 
 export { Change };
 
 /** @internal */
 export interface TriggerAnnotation {
  platform?: string;
- concurrency?: number;
- minInstances?: number;
- maxInstances?: number;
- availableMemoryMb?: number;
+ concurrency?: number | Expression<number>;
+ minInstances?: number | Expression<number>;
+ maxInstances?: number | Expression<number>;
+ availableMemoryMb?: number | Expression<number>;
  eventTrigger?: {
  eventType: string;
  resource: string;
@@ -48,7 +49,7 @@ export interface TriggerAnnotation {
  };
  labels?: { [key: string]: string };
  regions?: string[];
- timeout?: string;
+ timeout?: string | Expression<number>;
  vpcConnector?: string;
  vpcConnectorEgressSettings?: string;
  serviceAccountEmail?: string;

src/v2/expressions.ts

@@ -0,0 +1,24 @@
+/* 
+ * A CEL expression which can be evaulated during function deployment, and
+ * resolved to a value of the generic type parameter: i.e, you can pass
+ * an Expression<number> as the value of an option that normally accepts numbers.
+ */
+export type Expression<T extends string | number | boolean> = string; // eslint-disable-line
+
+export type Field<T extends string | number | boolean> = T | Expression<T> | null;
+
+/**
+ * Casts an Expression to its literal string value, for use by __getSpec()
+ * @internal
+ */
+export function ExprString<Expression>(arg: Expression): string {
+ return arg as unknown as string;
+}
+
+/**
+ * Sanity check on whether a CEL expression is actually evaluatable
+ * @internal
+ */
+export function IsValid<Expression>(arg: Expression): boolean {
+ return true;
+}

src/v2/index.ts

@@ -63,3 +63,5 @@ export {
 export { Change } from '../common/change';
 
 export { CloudFunction, CloudEvent } from './core';
+
+export { Expression } from './expressions';

src/v2/options.ts

@@ -37,6 +37,7 @@ import { TriggerAnnotation } from './core';
 import { declaredParams } from './params';
 import { ParamSpec } from './params/types';
 import { HttpsOptions } from './providers/https';
+import { Expression, Field, ExprString } from './expressions';
 
 /**
  * List of all regions supported by Cloud Functions v2
@@ -76,6 +77,10 @@ const MemoryOptionToMB: Record<MemoryOption, number> = {
  '32GiB': 32768,
 };
 
+function isMemoryOption(arg: MemoryOption | Expression<number>): arg is MemoryOption {
+ return (arg in MemoryOptionToMB);
+}
+
 /**
  * List of available options for VpcConnectorEgressSettings.
  */
@@ -104,7 +109,7 @@ export interface GlobalOptions {
  * Amount of memory to allocate to a function.
  * A value of null restores the defaults of 256MB.
  */
- memory?: MemoryOption | null;
+ memory?: MemoryOption | Expression<number> | null;
 
  /**
  * Timeout for the function in sections, possible values are 0 to 540.
@@ -116,21 +121,21 @@ export interface GlobalOptions {
  * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
  * timeout of 1,800s (30 minutes)
  */
- timeoutSeconds?: number | null;
+ timeoutSeconds?: Field<number>;
 
  /**
  * Min number of actual instances to be running at a given time.
  * 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 | null;
+ minInstances?: Field<number>;
 
  /**
  * Max number of instances to be running in parallel.
  * A value of null restores the default max instances.
  */
- maxInstances?: number | null;
+ maxInstances?: Field<number>;
 
  /**
  * Number of requests a function can serve at once.
@@ -139,7 +144,7 @@ export interface GlobalOptions {
  * 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 | null;
+ concurrency?: Field<number>;
 
  /**
  * Fractional number of CPUs to allocate to a function.
@@ -246,8 +251,8 @@ export function optionsToTriggerAnnotations(
  opts,
  'availableMemoryMb',
  'memory',
- (mem: MemoryOption) => {
- return MemoryOptionToMB[mem];
+ (mem: MemoryOption | Expression<number>): number | string => {
+ return isMemoryOption(mem) ? MemoryOptionToMB[mem] : ExprString(mem);
  }
  );
  convertIfPresent(annotation, opts, 'regions', 'region', (region) => {
@@ -308,8 +313,8 @@ export function optionsToEndpoint(
  convertIfPresent(vpc, opts, 'egressSettings', 'vpcConnectorEgressSettings');
  endpoint.vpc = vpc;
  }
- convertIfPresent(endpoint, opts, 'availableMemoryMb', 'memory', (mem) => {
- return MemoryOptionToMB[mem];
+ convertIfPresent(endpoint, opts, 'availableMemoryMb', 'memory', (mem: MemoryOption | Expression<number>): number | string => {
+ return isMemoryOption(mem) ? MemoryOptionToMB[mem] : ExprString(mem);
  });
  convertIfPresent(endpoint, opts, 'region', 'region', (region) => {
  if (typeof region === 'string') {

src/v2/providers/alerts/alerts.ts

@@ -23,6 +23,7 @@
 import { ManifestEndpoint } from '../../../runtime/manifest';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
+import { Expression, Field } from '../../expressions';
 
 /**
  * The CloudEvent data emitted by Firebase Alerts.
@@ -89,7 +90,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
  * Amount of memory to allocate to a function.
  * A value of null restores the defaults of 256MB.
  */
- memory?: options.MemoryOption | null;
+ memory?: options.MemoryOption | Expression<number> | null;
 
  /**
  * Timeout for the function in sections, possible values are 0 to 540.
@@ -101,21 +102,21 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
  * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
  * timeout of 1,800s (30 minutes)
  */
- timeoutSeconds?: number | null;
+ timeoutSeconds?: Field<number>;
 
  /**
  * Min number of actual instances to be running at a given time.
  * 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 | null;
+ minInstances?: Field<number>;
 
  /**
  * Max number of instances to be running in parallel.
  * A value of null restores the default max instances.
  */
- maxInstances?: number | null;
+ maxInstances?: Field<number>;
 
  /**
  * Number of requests a function can serve at once.
@@ -124,7 +125,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
  * 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 | null;
+ concurrency?: Field<number>;
 
  /**
  * Fractional number of CPUs to allocate to a function.

src/v2/providers/alerts/appDistribution.ts

@@ -28,6 +28,7 @@
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
 import { FirebaseAlertData, getEndpointAnnotation } from './alerts';
+import { Expression, Field } from '../../expressions';
 
 /**
  * The internal payload object for adding a new tester device to app distribution.
@@ -76,7 +77,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
  * Amount of memory to allocate to a function.
  * A value of null restores the defaults of 256MB.
  */
- memory?: options.MemoryOption | null;
+ memory?: options.MemoryOption | Expression<number> | null;
 
  /**
  * Timeout for the function in sections, possible values are 0 to 540.
@@ -88,21 +89,21 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
  * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
  * timeout of 1,800s (30 minutes)
  */
- timeoutSeconds?: number | null;
+ timeoutSeconds?: Field<number>;
 
  /**
  * Min number of actual instances to be running at a given time.
  * 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 | null;
+ minInstances?: Field<number>;
 
  /**
  * Max number of instances to be running in parallel.
  * A value of null restores the default max instances.
  */
- maxInstances?: number | null;
+ maxInstances?: Field<number>;
 
  /**
  * Number of requests a function can serve at once.
@@ -111,7 +112,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
  * 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 | null;
+ concurrency?: Field<number>;
 
  /**
  * Fractional number of CPUs to allocate to a function.

src/v2/providers/alerts/crashlytics.ts

@@ -28,6 +28,7 @@
 import { FirebaseAlertData, getEndpointAnnotation } from '.';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
+import { Expression, Field } from '../../expressions';
 
 /** Generic Crashlytics issue interface */
 export interface Issue {
@@ -182,7 +183,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
  * Amount of memory to allocate to a function.
  * A value of null restores the defaults of 256MB.
  */
- memory?: options.MemoryOption | null;
+ memory?: options.MemoryOption | Expression<number> | null;
 
  /**
  * Timeout for the function in sections, possible values are 0 to 540.
@@ -194,21 +195,21 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
  * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
  * timeout of 1,800s (30 minutes)
  */
- timeoutSeconds?: number | null;
+ timeoutSeconds?: Field<number>;
 
  /**
  * Min number of actual instances to be running at a given time.
  * 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 | null;
+ minInstances?: Field<number>;
 
  /**
  * Max number of instances to be running in parallel.
  * A value of null restores the default max instances.
  */
- maxInstances?: number | null;
+ maxInstances?: Field<number>;
 
  /**
  * Number of requests a function can serve at once.
@@ -217,7 +218,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
  * 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 | null;
+ concurrency?: Field<number>;
 
  /**
  * Fractional number of CPUs to allocate to a function.

src/v2/providers/database.ts

@@ -29,6 +29,7 @@ import { PathPattern } from '../../utilities/path-pattern';
 import { applyChange } from '../../utils';
 import { CloudEvent, CloudFunction } from '../core';
 import * as options from '../options';
+import { Expression, Field } from '../expressions';
 
 export { DataSnapshot };
 
@@ -102,7 +103,7 @@ export interface ReferenceOptions extends options.EventHandlerOptions {
  * Amount of memory to allocate to a function.
  * A value of null restores the defaults of 256MB.
  */
- memory?: options.MemoryOption | null;
+ memory?: options.MemoryOption | Expression<number> | null;
 
  /**
  * Timeout for the function in sections, possible values are 0 to 540.
@@ -114,21 +115,21 @@ export interface ReferenceOptions extends options.EventHandlerOptions {
  * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
  * timeout of 1,800s (30 minutes)
  */
- timeoutSeconds?: number | null;
+ timeoutSeconds?: Field<number>;
 
  /**
  * Min number of actual instances to be running at a given time.
  * 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 | null;
+ minInstances?: Field<number>;
 
  /**
  * Max number of instances to be running in parallel.
  * A value of null restores the default max instances.
  */
- maxInstances?: number | null;
+ maxInstances?: Field<number>;
 
  /**
  * Number of requests a function can serve at once.
@@ -137,7 +138,7 @@ export interface ReferenceOptions extends options.EventHandlerOptions {
  * 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 | null;
+ concurrency?: Field<number>;
 
  /**
  * Fractional number of CPUs to allocate to a function.