firebase-functions 3.20.0 → 3.20.1

package/lib/common/providers/tasks.js

@@ -27,17 +27,26 @@ const https = require("./https");
 /** @internal */
 function onDispatchHandler(handler) {
     return async (req, res) => {
+        var _a;
         try {
             if (!https.isValidRequest(req)) {
                 logger.error('Invalid request, unable to process.');
                 throw new https.HttpsError('invalid-argument', 'Bad Request');
             }
-            const context = {};
-            const status = await https.checkAuthToken(req, context);
+            const authHeader = req.header('Authorization') || '';
+            const token = (_a = authHeader.match(/^Bearer (.*)$/)) === null || _a === void 0 ? void 0 : _a[1];
             // Note: this should never happen since task queue functions are guarded by IAM.
-            if (status === 'INVALID') {
+            if (!token) {
                 throw new https.HttpsError('unauthenticated', 'Unauthenticated');
             }
+            // We skip authenticating the token since tq functions are guarded by IAM.
+            const authToken = await https.unsafeDecodeIdToken(token);
+            const context = {
+                auth: {
+                    uid: authToken.uid,
+                    token: authToken,
+                },
+            };
             const data = https.decode(req.body.data);
             if (handler.length === 2) {
                 await handler(data, context);

package/lib/v2/index.d.ts

@@ -5,6 +5,7 @@ import * as https from './providers/https';
 import * as pubsub from './providers/pubsub';
 import * as storage from './providers/storage';
 import * as tasks from './providers/tasks';
-export { alerts, https, pubsub, storage, logger, params, tasks };
+import * as eventarc from './providers/eventarc';
+export { alerts, https, pubsub, storage, logger, params, tasks, eventarc };
 export { setGlobalOptions, GlobalOptions } from './options';
 export { CloudFunction, CloudEvent } from './core';

package/lib/v2/index.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGlobalOptions = exports.tasks = exports.params = exports.logger = exports.storage = exports.pubsub = exports.https = exports.alerts = void 0;
+exports.setGlobalOptions = exports.eventarc = exports.tasks = exports.params = exports.logger = exports.storage = exports.pubsub = exports.https = exports.alerts = void 0;
 const logger = require("../logger");
 exports.logger = logger;
 const params = require("./params");
@@ -36,5 +36,7 @@ const storage = require("./providers/storage");
 exports.storage = storage;
 const tasks = require("./providers/tasks");
 exports.tasks = tasks;
+const eventarc = require("./providers/eventarc");
+exports.eventarc = eventarc;
 var options_1 = require("./options");
 Object.defineProperty(exports, "setGlobalOptions", { enumerable: true, get: function () { return options_1.setGlobalOptions; } });

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

@@ -0,0 +1,32 @@
+import * as options from '../options';
+import { CloudEvent, CloudFunction } from '../core';
+/** Options that can be set on an Eventarc trigger. */
+export interface EventarcTriggerOptions extends options.EventHandlerOptions {
+    /**
+     * Type of the event.
+     */
+    eventType: string;
+    /**
+     * ID of the channel. Can be either:
+     *   * fully qualified channel resource name:
+     *     `projects/{project}/locations/{location}/channels/{channel-id}`
+     *   * partial resource name with location and channel ID, in which case
+     *     the runtime project ID of the function will be used:
+     *     `locations/{location}/channels/{channel-id}`
+     *   * partial channel ID, in which case the runtime project ID of the
+     *     function and `us-central1` as location will be used:
+     *     `{channel-id}`
+     *
+     * If not specified, the default Firebase channel will be used:
+     * `projects/{project}/locations/us-central1/channels/firebase`
+     */
+    channel?: string;
+    /**
+     * Eventarc event exact match filter.
+     */
+    filters?: Record<string, string>;
+}
+export declare type CloudEventHandler = (event: CloudEvent<any>) => any | Promise<any>;
+/** Handle an Eventarc event published on the default channel. */
+export declare function onCustomEventPublished<T = any>(eventType: string, handler: CloudEventHandler): CloudFunction<CloudEvent<T>>;
+export declare function onCustomEventPublished<T = any>(opts: EventarcTriggerOptions, handler: CloudEventHandler): CloudFunction<CloudEvent<T>>;

package/lib/v2/providers/eventarc.js

@@ -0,0 +1,65 @@
+"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.onCustomEventPublished = void 0;
+const options = require("../options");
+const encoding_1 = require("../../common/encoding");
+function onCustomEventPublished(eventTypeOrOpts, handler) {
+    var _a;
+    let opts;
+    if (typeof eventTypeOrOpts === 'string') {
+        opts = {
+            eventType: eventTypeOrOpts,
+        };
+    }
+    else if (typeof eventTypeOrOpts === 'object') {
+        opts = eventTypeOrOpts;
+    }
+    const func = (raw) => {
+        return handler(raw);
+    };
+    func.run = handler;
+    const channel = (_a = opts.channel) !== null && _a !== void 0 ? _a : 'locations/us-central1/channels/firebase';
+    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: opts.eventType,
+            eventFilters: {},
+            retry: false,
+            channel,
+        },
+    };
+    encoding_1.convertIfPresent(endpoint.eventTrigger, opts, 'eventFilters', 'filters');
+    encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry');
+    func.__endpoint = endpoint;
+    return func;
+}
+exports.onCustomEventPublished = onCustomEventPublished;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.20.0",
+  "version": "3.20.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -63,7 +63,8 @@
     "./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"
+    "./v2/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
+    "./v2/eventarc": "./lib/v2/providers/eventarc.js"
   },
   "typesVersions": {
     "*": {
@@ -124,6 +125,9 @@
       "v2/base": [
         "lib/v2/base"
       ],
+      "v2/eventarc": [
+        "lib/v2/providers/eventarc"
+      ],
       "v2/options": [
         "lib/v2/options"
       ],