firebase-functions 6.3.1 → 6.4.0

package/lib/bin/firebase-functions.js

@@ -23,6 +23,8 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 const express = require("express");
+const fs = require("fs/promises");
+const path = require("path");
 const loader_1 = require("../runtime/loader");
 const manifest_1 = require("../runtime/manifest");
 function printUsageAndExit() {
@@ -42,30 +44,76 @@ if (args.length > 1) {
     }
     functionsDir = args[0];
 }
-let server = undefined;
-const app = express();
-function handleQuitquitquit(req, res) {
+function handleQuitquitquit(req, res, server) {
     res.send("ok");
     server.close();
 }
-app.get("/__/quitquitquit", handleQuitquitquit);
-app.post("/__/quitquitquit", handleQuitquitquit);
-if (process.env.FUNCTIONS_CONTROL_API === "true") {
-    app.get("/__/functions.yaml", async (req, res) => {
+if (process.env.FUNCTIONS_MANIFEST_OUTPUT_PATH) {
+    void (async () => {
+        var _a;
+        const outputPath = process.env.FUNCTIONS_MANIFEST_OUTPUT_PATH;
         try {
+            // Validate the output path
+            const dir = path.dirname(outputPath);
+            try {
+                await fs.access(dir, fs.constants.W_OK);
+            }
+            catch (e) {
+                console.error(`Error: Cannot write to directory '${dir}': ${e instanceof Error ? e.message : String(e)}`);
+                console.error("Please ensure the directory exists and you have write permissions.");
+                process.exit(1);
+            }
             const stack = await (0, loader_1.loadStack)(functionsDir);
-            res.setHeader("content-type", "text/yaml");
-            res.send(JSON.stringify((0, manifest_1.stackToWire)(stack)));
+            const wireFormat = (0, manifest_1.stackToWire)(stack);
+            await fs.writeFile(outputPath, JSON.stringify(wireFormat, null, 2));
+            process.exit(0);
         }
         catch (e) {
-            console.error(e);
-            res.status(400).send(`Failed to generate manifest from function source: ${e}`);
+            if (e.code === "ENOENT") {
+                console.error(`Error: Directory '${path.dirname(outputPath)}' does not exist.`);
+                console.error("Please create the directory or specify a valid path.");
+            }
+            else if (e.code === "EACCES") {
+                console.error(`Error: Permission denied writing to '${outputPath}'.`);
+                console.error("Please check file permissions or choose a different location.");
+            }
+            else if ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes("Failed to generate manifest")) {
+                console.error(e.message);
+            }
+            else {
+                console.error(`Failed to generate manifest from function source: ${e instanceof Error ? e.message : String(e)}`);
+            }
+            if (e instanceof Error && e.stack) {
+                console.error(e.stack);
+            }
+            process.exit(1);
         }
-    });
+    })();
 }
-let port = 8080;
-if (process.env.PORT) {
-    port = Number.parseInt(process.env.PORT);
+else {
+    let server = undefined;
+    const app = express();
+    app.get("/__/quitquitquit", (req, res) => handleQuitquitquit(req, res, server));
+    app.post("/__/quitquitquit", (req, res) => handleQuitquitquit(req, res, server));
+    if (process.env.FUNCTIONS_CONTROL_API === "true") {
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        app.get("/__/functions.yaml", async (req, res) => {
+            try {
+                const stack = await (0, loader_1.loadStack)(functionsDir);
+                res.setHeader("content-type", "text/yaml");
+                res.send(JSON.stringify((0, manifest_1.stackToWire)(stack)));
+            }
+            catch (e) {
+                console.error(e);
+                const errorMessage = e instanceof Error ? e.message : String(e);
+                res.status(400).send(`Failed to generate manifest from function source: ${errorMessage}`);
+            }
+        });
+    }
+    let port = 8080;
+    if (process.env.PORT) {
+        port = Number.parseInt(process.env.PORT);
+    }
+    console.log("Serving at port", port);
+    server = app.listen(port);
 }
-console.log("Serving at port", port);
-server = app.listen(port);

package/lib/common/providers/database.js

@@ -99,6 +99,9 @@ class DataSnapshot {
     val() {
         const parts = (0, path_1.pathParts)(this._childPath);
         let source = this._data;
+        if (source === null) {
+            return null;
+        }
         if (parts.length) {
             for (const part of parts) {
                 if (source[part] === undefined) {

package/lib/common/trace.d.ts

@@ -1,3 +1,6 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from "async_hooks";
+export declare const traceContext: AsyncLocalStorage<TraceContext>;
 export interface TraceContext {
     version: string;
     traceId: string;

package/lib/common/trace.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractTraceContext = exports.traceContext = void 0;
 const async_hooks_1 = require("async_hooks");
-/* @internal */
 exports.traceContext = new async_hooks_1.AsyncLocalStorage();
 /**
  * A regex to match the Cloud Trace header.

package/lib/logger/index.js

@@ -55,6 +55,7 @@ function removeCircular(obj, refs = []) {
             returnObj[k] = removeCircular(obj[k], refs);
         }
     }
+    refs.pop();
     return returnObj;
 }
 /**

package/lib/v1/cloud-functions.d.ts

@@ -55,8 +55,8 @@ export interface EventContext<Params = Record<string, string>> {
      * does not exist.
      */
     auth?: {
-        token: object;
         uid: string;
+        token: EventContextAuthToken;
     };
     /**
      * The level of permissions for a user.
@@ -152,6 +152,28 @@ export interface EventContext<Params = Record<string, string>> {
      */
     timestamp: string;
 }
+/**
+ * https://firebase.google.com/docs/reference/security/database#authtoken
+ */
+export interface EventContextAuthToken {
+    iss: string;
+    aud: string;
+    auth_time: number;
+    iat: number;
+    exp: number;
+    sub: string;
+    email?: string;
+    email_verified?: boolean;
+    phone_number?: string;
+    name?: string;
+    firebase?: {
+        identities?: {
+            [key: string]: string[];
+        };
+        sign_in_provider?: string;
+        tenant?: string;
+    };
+}
 /**
  * Resource is a standard format for defining a resource
  * (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the

package/lib/v2/index.d.ts

@@ -22,6 +22,7 @@ export { alerts, database, storage, https, identity, pubsub, logger, tasks, even
 export { setGlobalOptions, GlobalOptions, SupportedRegion, MemoryOption, VpcEgressSetting, IngressSetting, EventHandlerOptions, } from "./options";
 export { CloudFunction, CloudEvent, ParamsOf, onInit } from "./core";
 export { Change } from "../common/change";
+export { traceContext } from "../common/trace";
 import * as params from "../params";
 export { params };
 export { config } from "../v1/config";

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.app = exports.config = exports.params = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
+exports.app = exports.config = exports.params = exports.traceContext = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
 /**
  * The 2nd gen API for Cloud Functions for Firebase.
  * This SDK supports deep imports. For example, the namespace
@@ -61,6 +61,8 @@ var core_1 = require("./core");
 Object.defineProperty(exports, "onInit", { enumerable: true, get: function () { return core_1.onInit; } });
 var change_1 = require("../common/change");
 Object.defineProperty(exports, "Change", { enumerable: true, get: function () { return change_1.Change; } });
+var trace_1 = require("../common/trace");
+Object.defineProperty(exports, "traceContext", { enumerable: true, get: function () { return trace_1.traceContext; } });
 // NOTE: Equivalent to `export * as params from "../params"` but api-extractor doesn't support that syntax.
 const params = require("../params");
 exports.params = params;

package/lib/v2/options.d.ts

@@ -134,11 +134,22 @@ export declare function setGlobalOptions(options: GlobalOptions): void;
  * Additional fields that can be set on any event-handling function.
  */
 export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppCheck"> {
-    /** Type of the event. Valid values are TODO */
+    /** Type of the event. */
     eventType?: string;
-    /** TODO */
+    /**
+     * Filters events based on exact matches on the CloudEvents attributes.
+     *
+     * Each key-value pair represents an attribute name and its required value for exact matching.
+     * Events must match all specified filters to trigger the function.
+     */
     eventFilters?: Record<string, string | Expression<string>>;
-    /** TODO */
+    /**
+     * Filters events based on path pattern matching on the CloudEvents attributes.
+     *
+     * Similar to eventFilters, but supports wildcard patterns for flexible matching where `*` matches
+     * any single path segment, `**` matches zero or more path segments, and `{param}` captures a path segment
+     * as a parameter
+     */
     eventFilterPathPatterns?: Record<string, string | Expression<string>>;
     /** Whether failed executions should be delivered again. */
     retry?: boolean | Expression<boolean> | ResetValue;

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

@@ -22,7 +22,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceApp
      * If this is an `Array`, allows requests from domains matching at least one entry of the array.
      * Defaults to true for {@link https.CallableFunction} and false otherwise.
      */
-    cors?: string | boolean | RegExp | Array<string | RegExp>;
+    cors?: string | Expression<string> | Expression<string[]> | boolean | RegExp | Array<string | RegExp>;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -140,18 +140,24 @@ export interface CallableOptions<T = any> extends HttpsOptions {
      */
     heartbeatSeconds?: number | null;
     /**
-     * Callback for whether a request is authorized.
+     * (Deprecated) Callback for whether a request is authorized.
      *
      * Designed to allow reusable auth policies to be passed as an options object. Two built-in reusable policies exist:
      * isSignedIn and hasClaim.
+     *
+     * @deprecated
      */
     authPolicy?: (auth: AuthData | null, data: T) => boolean | Promise<boolean>;
 }
 /**
+ * @deprecated
+ *
  * An auth policy that requires a user to be signed in.
  */
 export declare const isSignedIn: () => (auth: AuthData | null) => boolean;
 /**
+ * @deprecated
+ *
  * An auth policy that requires a user to be both signed in and have a specific claim (optionally with a specific value)
  */
 export declare const hasClaim: (claim: string, value?: string) => (auth: AuthData | null) => boolean;

package/lib/v2/providers/https.js

@@ -33,15 +33,20 @@ const debug_1 = require("../../common/debug");
 const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
 const manifest_1 = require("../../runtime/manifest");
+const params_1 = require("../../params");
 const options = require("../options");
 const onInit_1 = require("../../common/onInit");
 const logger = require("../../logger");
 /**
+ * @deprecated
+ *
  * An auth policy that requires a user to be signed in.
  */
 const isSignedIn = () => (auth) => !!auth;
 exports.isSignedIn = isSignedIn;
 /**
+ * @deprecated
+ *
  * An auth policy that requires a user to be both signed in and have a specific claim (optionally with a specific value)
  */
 const hasClaim = (claim, value) => (auth) => {
@@ -64,7 +69,7 @@ function onRequest(optsOrHandler, handler) {
         opts = optsOrHandler;
     }
     if ((0, debug_1.isDebugFeatureEnabled)("enableCors") || "cors" in opts) {
-        let origin = opts.cors;
+        let origin = opts.cors instanceof params_1.Expression ? opts.cors.value() : opts.cors;
         if ((0, debug_1.isDebugFeatureEnabled)("enableCors")) {
             // Respect `cors: false` to turn off cors even if debug feature is enabled.
             origin = opts.cors === false ? false : true;
@@ -142,7 +147,19 @@ function onCall(optsOrHandler, handler) {
     else {
         opts = optsOrHandler;
     }
-    let origin = (0, debug_1.isDebugFeatureEnabled)("enableCors") ? true : "cors" in opts ? opts.cors : true;
+    let cors;
+    if ("cors" in opts) {
+        if (opts.cors instanceof params_1.Expression) {
+            cors = opts.cors.value();
+        }
+        else {
+            cors = opts.cors;
+        }
+    }
+    else {
+        cors = true;
+    }
+    let origin = (0, debug_1.isDebugFeatureEnabled)("enableCors") ? true : cors;
     // Arrays cause the access-control-allow-origin header to be dynamic based
     // on the origin header of the request. If there is only one element in the
     // array, this is unnecessary.

package/lib/v2/providers/tasks.js

@@ -86,7 +86,6 @@ function onTaskDispatched(optsOrHandler, handler) {
     (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.rateLimits, opts.rateLimits, "maxConcurrentDispatches", "maxDispatchesPerSecond");
     (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, options.getGlobalOptions(), "invoker", "invoker", encoding_1.convertInvoker);
     (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, opts, "invoker", "invoker", encoding_1.convertInvoker);
-    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, "retry", "retry");
     func.__requiredAPIs = [
         {
             api: "cloudtasks.googleapis.com",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "6.3.1",
+  "version": "6.4.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",