firebase-functions 3.16.0 → 3.18.0

package/lib/v2/providers/alerts/crashlytics.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOptsAndApp = exports.onOperation = exports.onNewAnrIssuePublished = exports.onVelocityAlertPublished = exports.onStabilityDigestPublished = exports.onRegressionAlertPublished = exports.onNewNonfatalIssuePublished = exports.onNewFatalIssuePublished = exports.newAnrIssueAlert = exports.velocityAlert = exports.stabilityDigestAlert = exports.regressionAlert = exports.newNonfatalIssueAlert = exports.newFatalIssueAlert = void 0;
+const _1 = require(".");
+/** @internal */
+exports.newFatalIssueAlert = 'crashlytics.newFatalIssue';
+/** @internal */
+exports.newNonfatalIssueAlert = 'crashlytics.newNonfatalIssue';
+/** @internal */
+exports.regressionAlert = 'crashlytics.regression';
+/** @internal */
+exports.stabilityDigestAlert = 'crashlytics.stabilityDigest';
+/** @internal */
+exports.velocityAlert = 'crashlytics.velocity';
+/** @internal */
+exports.newAnrIssueAlert = 'crashlytics.newAnrIssue';
+function onNewFatalIssuePublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.newFatalIssueAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onNewFatalIssuePublished = onNewFatalIssuePublished;
+function onNewNonfatalIssuePublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.newNonfatalIssueAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onNewNonfatalIssuePublished = onNewNonfatalIssuePublished;
+function onRegressionAlertPublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.regressionAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onRegressionAlertPublished = onRegressionAlertPublished;
+function onStabilityDigestPublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.stabilityDigestAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onStabilityDigestPublished = onStabilityDigestPublished;
+function onVelocityAlertPublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.velocityAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onVelocityAlertPublished = onVelocityAlertPublished;
+function onNewAnrIssuePublished(appIdOrOptsOrHandler, handler) {
+    return onOperation(exports.newAnrIssueAlert, appIdOrOptsOrHandler, handler);
+}
+exports.onNewAnrIssuePublished = onNewAnrIssuePublished;
+/** @internal */
+function onOperation(alertType, appIdOrOptsOrHandler, handler) {
+    if (typeof appIdOrOptsOrHandler === 'function') {
+        handler = appIdOrOptsOrHandler;
+        appIdOrOptsOrHandler = {};
+    }
+    const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
+    const func = (raw) => {
+        return handler(raw);
+    };
+    func.run = handler;
+    func.__endpoint = (0, _1.getEndpointAnnotation)(opts, alertType, appId);
+    return func;
+}
+exports.onOperation = onOperation;
+/**
+ * @internal
+ * Helper function to parse the function opts and appId.
+ */
+function getOptsAndApp(appIdOrOpts) {
+    let opts;
+    let appId;
+    if (typeof appIdOrOpts === 'string') {
+        opts = {};
+        appId = appIdOrOpts;
+    }
+    else {
+        appId = appIdOrOpts.appId;
+        opts = { ...appIdOrOpts };
+        delete opts.appId;
+    }
+    return [opts, appId];
+}
+exports.getOptsAndApp = getOptsAndApp;

package/lib/v2/providers/alerts/index.d.ts

@@ -0,0 +1,5 @@
+import * as appDistribution from './appDistribution';
+import * as billing from './billing';
+import * as crashlytics from './crashlytics';
+export { appDistribution, billing, crashlytics };
+export * from './alerts';

package/lib/v2/providers/alerts/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.crashlytics = exports.billing = exports.appDistribution = void 0;
+const appDistribution = require("./appDistribution");
+exports.appDistribution = appDistribution;
+const billing = require("./billing");
+exports.billing = billing;
+const crashlytics = require("./crashlytics");
+exports.crashlytics = crashlytics;
+__exportStar(require("./alerts"), exports);

package/lib/v2/providers/https.d.ts

@@ -1,18 +1,38 @@
 import * as express from 'express';
-import { CallableRequest, FunctionsErrorCode, HttpsError, Request } from '../../common/providers/https';
 import * as options from '../options';
-export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
+import { CallableRequest, FunctionsErrorCode, HttpsError, Request, TaskRateLimits, TaskRequest, TaskRetryConfig } from '../../common/providers/https';
+import { ManifestEndpoint } from '../../runtime/manifest';
+export { Request, CallableRequest, FunctionsErrorCode, HttpsError, TaskRateLimits, TaskRequest, TaskRetryConfig as TaskRetryPolicy, };
 export interface HttpsOptions extends Omit<options.GlobalOptions, 'region'> {
     region?: options.SupportedRegion | string | Array<options.SupportedRegion | string>;
     cors?: string | boolean | RegExp | Array<string | RegExp>;
 }
+export interface TaskQueueOptions extends options.GlobalOptions {
+    retryConfig?: TaskRetryConfig;
+    rateLimits?: TaskRateLimits;
+    /**
+     * Who can enqueue tasks for this function.
+     * If left unspecified, only service accounts which have
+     * roles/cloudtasks.enqueuer and roles/cloudfunctions.invoker
+     * will have permissions.
+     */
+    invoker?: 'private' | string | string[];
+}
 export declare type HttpsFunction = ((req: Request, res: express.Response) => void | Promise<void>) & {
-    __trigger: unknown;
+    __trigger?: unknown;
+    __endpoint: ManifestEndpoint;
 };
 export interface CallableFunction<T, Return> extends HttpsFunction {
     run(data: CallableRequest<T>): Return;
 }
+export interface TaskQueueFunction<T = any> extends HttpsFunction {
+    run(data: TaskRequest<T>): void | Promise<void>;
+}
 export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
 export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
 export declare function onCall<T = any, Return = any | Promise<any>>(opts: HttpsOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
 export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
+/** Handle a request sent to a Cloud Tasks queue. */
+export declare function onTaskDispatched<Args = any>(handler: (request: TaskRequest<Args>) => void | Promise<void>): TaskQueueFunction<Args>;
+/** Handle a request sent to a Cloud Tasks queue. */
+export declare function onTaskDispatched<Args = any>(options: TaskQueueOptions, handler: (request: TaskRequest<Args>) => void | Promise<void>): TaskQueueFunction<Args>;

package/lib/v2/providers/https.js

@@ -21,12 +21,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onCall = exports.onRequest = exports.HttpsError = void 0;
+exports.onTaskDispatched = exports.onCall = exports.onRequest = exports.HttpsError = void 0;
 const cors = require("cors");
 const encoding_1 = require("../../common/encoding");
+const options = require("../options");
 const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
-const options = require("../options");
 function onRequest(optsOrHandler, handler) {
     let opts;
     if (arguments.length === 1) {
@@ -72,6 +72,22 @@ function onRequest(optsOrHandler, handler) {
             return trigger;
         },
     });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    // global options calls region a scalar and https allows it to be an array,
+    // but optionsToTriggerAnnotations handles both cases.
+    const specificOpts = options.optionsToEndpoint(opts);
+    const endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        httpsTrigger: {},
+    };
+    (0, encoding_1.convertIfPresent)(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    handler.__endpoint = endpoint;
     return handler;
 }
 exports.onRequest = onRequest;
@@ -113,7 +129,60 @@ function onCall(optsOrHandler, handler) {
             };
         },
     });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    // global options calls region a scalar and https allows it to be an array,
+    // but optionsToManifestEndpoint handles both cases.
+    const specificOpts = options.optionsToEndpoint(opts);
+    func.__endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        callableTrigger: {},
+    };
     func.run = handler;
     return func;
 }
 exports.onCall = onCall;
+function onTaskDispatched(optsOrHandler, handler) {
+    let opts;
+    if (arguments.length == 1) {
+        opts = {};
+        handler = optsOrHandler;
+    }
+    else {
+        opts = optsOrHandler;
+    }
+    // onEnqueueHandler sniffs the function length to determine which API to present.
+    // fix the length to prevent api versions from being mismatched.
+    const fixedLen = (req) => handler(req);
+    const func = (0, https_1.onDispatchHandler)(fixedLen);
+    Object.defineProperty(func, '__trigger', {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            // global options calls region a scalar and https allows it to be an array,
+            // but optionsToTriggerAnnotations handles both cases.
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            const taskQueueTrigger = {};
+            (0, encoding_1.copyIfPresent)(taskQueueTrigger, opts, 'retryConfig', 'rateLimits');
+            (0, encoding_1.convertIfPresent)(taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+            return {
+                apiVersion: 2,
+                platform: 'gcfv2',
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                taskQueueTrigger,
+            };
+        },
+    });
+    func.run = handler;
+    return func;
+}
+exports.onTaskDispatched = onTaskDispatched;

package/lib/v2/providers/pubsub.d.ts

@@ -1,5 +1,5 @@
-import { CloudEvent, CloudFunction } from '../core';
 import * as options from '../options';
+import { CloudEvent, CloudFunction } from '../core';
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *

package/lib/v2/providers/pubsub.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onMessagePublished = exports.Message = void 0;
 const options = require("../options");
+const encoding_1 = require("../../common/encoding");
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
@@ -69,10 +70,6 @@ function onMessagePublished(topicOrOptions, handler) {
         return handler(raw);
     };
     func.run = handler;
-    // TypeScript doesn't recongize defineProperty as adding a property and complains
-    // that __trigger doesn't exist. We can either cast to any and lose all type safety
-    // or we can just assign a meaningless value before calling defineProperty.
-    func.__trigger = 'silence the transpiler';
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -95,6 +92,24 @@ function onMessagePublished(topicOrOptions, handler) {
             };
         },
     });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    const specificOpts = options.optionsToEndpoint(opts);
+    const endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        eventTrigger: {
+            eventType: 'google.cloud.pubsub.topic.v1.messagePublished',
+            eventFilters: { topic },
+            retry: false,
+        },
+    };
+    (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+    func.__endpoint = endpoint;
     return func;
 }
 exports.onMessagePublished = onMessagePublished;

package/lib/v2/providers/storage.d.ts

@@ -1,5 +1,5 @@
-import { CloudEvent, CloudFunction } from '../core';
 import * as options from '../options';
+import { CloudEvent, CloudFunction } from '../core';
 /**
  * An object within Google Cloud Storage.
  * Ref: https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts

package/lib/v2/providers/storage.js

@@ -22,8 +22,9 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOptsAndBucket = exports.onOperation = exports.onObjectMetadataUpdated = exports.onObjectDeleted = exports.onObjectFinalized = exports.onObjectArchived = exports.metadataUpdatedEvent = exports.deletedEvent = exports.finalizedEvent = exports.archivedEvent = void 0;
-const config_1 = require("../../config");
 const options = require("../options");
+const config_1 = require("../../config");
+const encoding_1 = require("../../common/encoding");
 /** @internal */
 exports.archivedEvent = 'google.cloud.storage.object.v1.archived';
 /** @internal */
@@ -59,10 +60,6 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
         return handler(raw);
     };
     func.run = handler;
-    // TypeScript doesn't recongize defineProperty as adding a property and complains
-    // that __trigger doesn't exist. We can either cast to any and lose all type safety
-    // or we can just assign a meaningless value before calling defineProperty.
-    func.__trigger = 'silence the transpiler';
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -82,6 +79,36 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
             };
         },
     });
+    // TypeScript doesn't recognize defineProperty as adding a property and complains
+    // that __endpoint doesn't exist. We can either cast to any and lose all type safety
+    // or we can just assign a meaningless value before calling defineProperty.
+    func.__endpoint = {};
+    // SDK may attempt to read FIREBASE_CONFIG env var to fetch the default bucket name.
+    // To prevent runtime errors when FIREBASE_CONFIG env var is missing, we use getters.
+    Object.defineProperty(func, '__endpoint', {
+        get: () => {
+            const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+            const specificOpts = options.optionsToEndpoint(opts);
+            const endpoint = {
+                platform: 'gcfv2',
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                eventTrigger: {
+                    eventType,
+                    eventFilters: {
+                        bucket,
+                    },
+                    retry: false,
+                },
+            };
+            (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+            return endpoint;
+        },
+    });
     return func;
 }
 exports.onOperation = onOperation;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.16.0",
+  "version": "3.18.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -22,6 +22,9 @@
     "lib"
   ],
   "main": "lib/index.js",
+  "bin": {
+    "firebase-functions": "./lib/bin/firebase-functions.js"
+  },
   "types": "lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
@@ -54,7 +57,11 @@
     "./v2/https": "./lib/v2/providers/https.js",
     "./v2/params": "./lib/v2/params/index.js",
     "./v2/pubsub": "./lib/v2/providers/pubsub.js",
-    "./v2/storage": "./lib/v2/providers/storage.js"
+    "./v2/storage": "./lib/v2/providers/storage.js",
+    "./v2/alerts": "./lib/v2/providers/alerts/index.js",
+    "./v2/alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js",
+    "./v2/alerts/billing": "./lib/v2/providers/alerts/billing.js",
+    "./v2/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js"
   },
   "typesVersions": {
     "*": {
@@ -114,6 +121,18 @@
       ],
       "v2/storage": [
         "lib/v2/providers/storage"
+      ],
+      "v2/alerts": [
+        "lib/v2/providers/alerts"
+      ],
+      "v2/alerts/appDistribution": [
+        "lib/v2/providers/alerts/appDistribution"
+      ],
+      "v2/alerts/billing": [
+        "lib/v2/providers/alerts/billing"
+      ],
+      "v2/alerts/crashlytics": [
+        "lib/v2/providers/alerts/crashlytics"
       ]
     }
   },
@@ -130,7 +149,8 @@
     "format:fix": "prettier --write '**/*.{json,md,ts,yml,yaml}'",
     "lint": "tslint --config tslint.json --project tsconfig.json ",
     "lint:fix": "tslint --config tslint.json --fix --project tsconfig.json",
-    "test": "mocha"
+    "test": "mocha --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {
     "@types/cors": "^2.8.5",
@@ -161,9 +181,12 @@
     "mock-require": "^3.0.3",
     "mz": "^2.7.0",
     "nock": "^10.0.6",
+    "node-fetch": "^2.6.7",
+    "portfinder": "^1.0.28",
     "prettier": "^1.18.2",
+    "semver": "^7.3.5",
     "sinon": "^7.3.2",
-    "ts-node": "^8.3.0",
+    "ts-node": "^10.4.0",
     "tslint": "^5.18.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-no-unused-expression-chai": "^0.1.4",