Extract functions config to avoid dependency cycles, assign failure policy to triggers.

Author: merlinnot

src/cloud-functions.ts

@@ -22,7 +22,11 @@
 
 import { Request, Response } from 'express';
 import * as _ from 'lodash';
-import { DeploymentOptions, FailurePolicy } from './function-builder';
+import {
+  DeploymentOptions,
+  FailurePolicy,
+  Schedule,
+} from './function-configuration';
 export { Request, Response };
 
 const WILDCARD_REGEX = new RegExp('{[^/{}]*}', 'g');
@@ -99,7 +103,6 @@ export class Change<T> {
 
 /**
  * ChangeJson is the JSON format used to construct a Change object.
- * @internal
  */
 export interface ChangeJson {
   /**
@@ -185,20 +188,6 @@ export interface Resource {
   labels?: { [tag: string]: string };
 }
 
-export interface ScheduleRetryConfig {
-  retryCount?: number;
-  maxRetryDuration?: string;
-  minBackoffDuration?: string;
-  maxBackoffDuration?: string;
-  maxDoublings?: number;
-}
-
-export interface Schedule {
-  schedule: string;
-  timeZone?: string;
-  retryConfig?: ScheduleRetryConfig;
-}
-
 /**
  * TriggerAnnotated is used internally by the firebase CLI to understand what
  * type of Cloud Function to deploy.
@@ -268,11 +257,16 @@ export interface MakeCloudFunctionArgs<EventData> {
 }
 
 export function optionsToTrigger({
-  regions,
-  timeoutSeconds,
+  failurePolicy,
   memory,
+  regions,
   schedule,
+  timeoutSeconds,
 }: DeploymentOptions): TriggerAnnotated['__trigger'] {
+  const defaultFailurePolicy: FailurePolicy = {
+    retry: {},
+  };
+
   const memoryLookup = {
     '128MB': 128,
     '256MB': 256,
@@ -282,6 +276,11 @@ export function optionsToTrigger({
   };
 
   return {
+    ...(failurePolicy === undefined || failurePolicy === false
+      ? {}
+      : failurePolicy === true
+      ? { failurePolicy: defaultFailurePolicy }
+      : { failurePolicy }),
     ...(memory === undefined
       ? {}
       : { availableMemoryMb: memoryLookup[memory] }),

src/function-builder.ts

@@ -39,34 +39,15 @@ import * as https from './providers/https';
 import * as pubsub from './providers/pubsub';
 import * as remoteConfig from './providers/remoteConfig';
 import * as storage from './providers/storage';
-import { CloudFunction, EventContext, Schedule } from './cloud-functions';
-
-/**
- * List of all regions supported by Cloud Functions.
- */
-const SUPPORTED_REGIONS = [
-  'us-central1',
-  'us-east1',
-  'europe-west1',
-  'europe-west2',
-  'asia-east2',
-  'asia-northeast1',
-];
-
-/**
- * List of available memory options supported by Cloud Functions.
- */
-const VALID_MEMORY_OPTS = ['128MB', '256MB', '512MB', '1GB', '2GB'] as const;
-
-/**
- * Cloud Functions min timeout value.
- */
-const MIN_TIMEOUT_SECONDS = 0;
-
-/**
- * Cloud Functions max timeout value.
- */
-const MAX_TIMEOUT_SECONDS = 540;
+import { CloudFunction, EventContext } from './cloud-functions';
+import {
+  RuntimeOptions,
+  VALID_MEMORY_OPTS,
+  MIN_TIMEOUT_SECONDS,
+  MAX_TIMEOUT_SECONDS,
+  SUPPORTED_REGIONS,
+  DeploymentOptions,
+} from './function-configuration';
 
 /**
  * Assert that the runtime options passed in are valid.
@@ -174,31 +155,6 @@ export function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder {
   return new FunctionBuilder(runtimeOptions);
 }
 
-export interface FailurePolicy {
-  retry: {};
-}
-
-export interface RuntimeOptions {
-  /**
-   * Failure policy of the function, boolean `true` is equivalent to providing
-   * an empty policy.
-   */
-  failurePolicy?: FailurePolicy | boolean;
-  /**
-   * Amount of memory to allocate to the function.
-   */
-  memory?: typeof VALID_MEMORY_OPTS[number];
-  /**
-   * Timeout for the function in seconds, possible values are 0 to 540.
-   */
-  timeoutSeconds?: number;
-}
-
-export interface DeploymentOptions extends RuntimeOptions {
-  regions?: string[];
-  schedule?: Schedule;
-}
-
 export class FunctionBuilder {
   constructor(private options: DeploymentOptions) {}
 
@@ -237,6 +193,12 @@ export class FunctionBuilder {
   }
 
   get https() {
+    if (this.options.failurePolicy !== undefined) {
+      console.warn(
+        'RuntimeOptions.failurePolicy is not supported in https functions.'
+      );
+    }
+
     return {
       /**
        * Handle HTTP requests.

src/function-configuration.ts

@@ -0,0 +1,71 @@
+/**
+ * List of all regions supported by Cloud Functions.
+ */
+export const SUPPORTED_REGIONS = [
+  'us-central1',
+  'us-east1',
+  'europe-west1',
+  'europe-west2',
+  'asia-east2',
+  'asia-northeast1',
+];
+
+/**
+ * Cloud Functions min timeout value.
+ */
+export const MIN_TIMEOUT_SECONDS = 0;
+
+/**
+ * Cloud Functions max timeout value.
+ */
+export const MAX_TIMEOUT_SECONDS = 540;
+
+/**
+ * List of available memory options supported by Cloud Functions.
+ */
+export const VALID_MEMORY_OPTS = [
+  '128MB',
+  '256MB',
+  '512MB',
+  '1GB',
+  '2GB',
+] as const;
+
+export interface ScheduleRetryConfig {
+  retryCount?: number;
+  maxRetryDuration?: string;
+  minBackoffDuration?: string;
+  maxBackoffDuration?: string;
+  maxDoublings?: number;
+}
+
+export interface Schedule {
+  schedule: string;
+  timeZone?: string;
+  retryConfig?: ScheduleRetryConfig;
+}
+
+export interface FailurePolicy {
+  retry: {};
+}
+
+export interface RuntimeOptions {
+  /**
+   * Failure policy of the function, boolean `true` is equivalent to providing
+   * an empty policy.
+   */
+  failurePolicy?: FailurePolicy | boolean;
+  /**
+   * Amount of memory to allocate to the function.
+   */
+  memory?: typeof VALID_MEMORY_OPTS[number];
+  /**
+   * Timeout for the function in seconds, possible values are 0 to 540.
+   */
+  timeoutSeconds?: number;
+}
+
+export interface DeploymentOptions extends RuntimeOptions {
+  regions?: string[];
+  schedule?: Schedule;
+}

src/index.ts

@@ -55,5 +55,6 @@ export {
 export * from './config';
 export * from './cloud-functions';
 export * from './function-builder';
+export * from './function-configuration';
 
 setup();

src/providers/analytics.ts

@@ -28,7 +28,7 @@ import {
   Event,
   EventContext,
 } from '../cloud-functions';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
 /** @internal */
 export const provider = 'google.analytics';

src/providers/auth.ts

@@ -28,7 +28,7 @@ import {
 } from '../cloud-functions';
 import * as firebase from 'firebase-admin';
 import * as _ from 'lodash';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
 /** @internal */
 export const provider = 'google.firebase.auth';

src/providers/crashlytics.ts

@@ -25,7 +25,7 @@ import {
   CloudFunction,
   EventContext,
 } from '../cloud-functions';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
 /** @internal */
 export const provider = 'google.firebase.crashlytics';

src/providers/database.ts

@@ -32,7 +32,7 @@ import {
 import { normalizePath, applyChange, pathParts, joinPath } from '../utils';
 import * as firebase from 'firebase-admin';
 import { firebaseConfig } from '../config';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
 /** @internal */
 export const provider = 'google.firebase.database';

src/providers/firestore.ts

@@ -32,7 +32,7 @@ import {
   EventContext,
 } from '../cloud-functions';
 import { dateToTimestampProto } from '../encoder';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
 /** @internal */
 export const provider = 'google.firestore';

src/providers/https.ts

@@ -26,15 +26,12 @@ import * as _ from 'lodash';
 import * as cors from 'cors';
 import { apps } from '../apps';
 import { HttpsFunction, optionsToTrigger, Runnable } from '../cloud-functions';
-import { DeploymentOptions } from '../function-builder';
+import { DeploymentOptions } from '../function-configuration';
 
-/**
- *
- *
- */
 export interface Request extends express.Request {
   rawBody: Buffer;
 }
+
 /**
  * Handle HTTP requests.
  * @param handler A function that takes a request and response object,