firebase-functions 3.18.0 → 3.20.0

package/lib/v2/providers/tasks.js

@@ -0,0 +1,89 @@
+"use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onTaskDispatched = void 0;
+const options = require("../options");
+const encoding_1 = require("../../common/encoding");
+const tasks_1 = require("../../common/providers/tasks");
+function onTaskDispatched(optsOrHandler, handler) {
+    let opts;
+    if (arguments.length == 1) {
+        opts = {};
+        handler = optsOrHandler;
+    }
+    else {
+        opts = optsOrHandler;
+    }
+    // onDispatchHandler 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 = tasks_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 = {};
+            encoding_1.copyIfPresent(taskQueueTrigger, opts, 'retryConfig', 'rateLimits');
+            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,
+            };
+        },
+    });
+    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,
+        },
+        taskQueueTrigger: {},
+    };
+    encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'retryConfig');
+    encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'rateLimits');
+    encoding_1.convertIfPresent(func.__endpoint.taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    func.__requiredAPIs = [
+        {
+            api: 'cloudtasks.googleapis.com',
+            reason: 'Needed for task queue functions',
+        },
+    ];
+    func.run = handler;
+    return func;
+}
+exports.onTaskDispatched = onTaskDispatched;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.18.0",
+  "version": "3.20.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -40,6 +40,7 @@
     "./lib/providers/pubsub": "./lib/providers/pubsub.js",
     "./lib/providers/remoteConfig": "./lib/providers/remoteConfig.js",
     "./lib/providers/storage": "./lib/providers/storage.js",
+    "./lib/providers/tasks": "./lib/providers/tasks.js",
     "./lib/providers/testLab": "./lib/providers/testLab.js",
     "./v1": "./lib/index.js",
     "./v1/analytics": "./lib/providers/analytics.js",
@@ -58,6 +59,7 @@
     "./v2/params": "./lib/v2/params/index.js",
     "./v2/pubsub": "./lib/v2/providers/pubsub.js",
     "./v2/storage": "./lib/v2/providers/storage.js",
+    "./v2/tasks": "./lib/v2/providers/tasks.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",
@@ -98,12 +100,27 @@
       "v1/storage": [
         "lib/providers/storage"
       ],
+      "v1/tasks": [
+        "lib/providers/tasks"
+      ],
       "v1/testLab": [
         "lib/providers/testLab"
       ],
       "v2": [
         "lib/v2"
       ],
+      "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"
+      ],
       "v2/base": [
         "lib/v2/base"
       ],
@@ -122,17 +139,8 @@
       "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"
+      "v2/tasks": [
+        "lib/v2/providers/tasks"
       ]
     }
   },
@@ -149,7 +157,7 @@
     "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 --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test": "mocha --file ./mocha/setup.ts \"spec/**/*.spec.ts\"",
     "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {
@@ -157,7 +165,8 @@
     "@types/express": "4.17.3",
     "cors": "^2.8.5",
     "express": "^4.17.1",
-    "lodash": "^4.17.14"
+    "lodash": "^4.17.14",
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "@types/chai": "^4.1.7",
@@ -168,6 +177,7 @@
     "@types/mock-require": "^2.0.0",
     "@types/nock": "^10.0.3",
     "@types/node": "^8.10.50",
+    "@types/node-fetch": "^3.0.3",
     "@types/sinon": "^7.0.13",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",