firebase-functions 5.0.1 → 5.1.1

package/lib/logger/index.js

@@ -63,6 +63,10 @@ function removeCircular(obj, refs = []) {
  * @public
  */
 function write(entry) {
+    const ctx = trace_1.traceContext.getStore();
+    if (ctx === null || ctx === void 0 ? void 0 : ctx.traceId) {
+        entry["logging.googleapis.com/trace"] = `projects/${process.env.GCLOUD_PROJECT}/traces/${ctx.traceId}`;
+    }
     common_1.UNPATCHED_CONSOLE[common_1.CONSOLE_SEVERITY[entry.severity]](JSON.stringify(removeCircular(entry)));
 }
 exports.write = write;
@@ -123,16 +127,12 @@ function entryFromArgs(severity, args) {
     if (lastArg && typeof lastArg === "object" && lastArg.constructor === Object) {
         entry = args.pop();
     }
-    const ctx = trace_1.traceContext.getStore();
     // mimic `console.*` behavior, see https://nodejs.org/api/console.html#console_console_log_data_args
     let message = (0, util_1.format)(...args);
     if (severity === "ERROR" && !args.find((arg) => arg instanceof Error)) {
         message = new Error(message).stack || message;
     }
     const out = {
-        "logging.googleapis.com/trace": (ctx === null || ctx === void 0 ? void 0 : ctx.traceId)
-            ? `projects/${process.env.GCLOUD_PROJECT}/traces/${ctx.traceId}`
-            : undefined,
         ...entry,
         severity,
     };

package/lib/params/index.d.ts

@@ -30,11 +30,10 @@ export declare const gcloudProject: Param<string>;
 export declare const storageBucket: Param<string>;
 /**
  * Declares a secret param, that will persist values only in Cloud Secret Manager.
- * Secrets are stored interally as bytestrings. Use `ParamOptions.as` to provide type
+ * Secrets are stored internally as bytestrings. Use `ParamOptions.as` to provide type
  * hinting during parameter resolution.
  *
  * @param name The name of the environment variable to use to load the parameter.
- * @param options Configuration options for the parameter.
  * @returns A parameter with a `string` return type for `.value`.
  */
 export declare function defineSecret(name: string): SecretParam;

package/lib/params/index.js

@@ -77,11 +77,10 @@ exports.gcloudProject = new types_1.InternalExpression("GCLOUD_PROJECT", (env) =
 exports.storageBucket = new types_1.InternalExpression("STORAGE_BUCKET", (env) => { var _a; return ((_a = JSON.parse(env.FIREBASE_CONFIG)) === null || _a === void 0 ? void 0 : _a.storageBucket) || ""; });
 /**
  * Declares a secret param, that will persist values only in Cloud Secret Manager.
- * Secrets are stored interally as bytestrings. Use `ParamOptions.as` to provide type
+ * Secrets are stored internally as bytestrings. Use `ParamOptions.as` to provide type
  * hinting during parameter resolution.
  *
  * @param name The name of the environment variable to use to load the parameter.
- * @param options Configuration options for the parameter.
  * @returns A parameter with a `string` return type for `.value`.
  */
 function defineSecret(name) {

package/lib/params/types.d.ts

@@ -33,7 +33,7 @@ export declare class CompareExpression<T extends string | number | boolean | str
 type ParamValueType = "string" | "list" | "boolean" | "int" | "float" | "secret";
 /** Create a select input from a series of values. */
 export declare function select<T>(options: T[]): SelectInput<T>;
-/** Create a select input from a map of labels to vaues. */
+/** Create a select input from a map of labels to values. */
 export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
 /** Create a multi-select input from a series of values. */
 export declare function multiSelect(options: string[]): MultiSelectInput;

package/lib/runtime/loader.js

@@ -51,7 +51,7 @@ async function loadModule(functionsDir) {
     }
 }
 /* @internal */
-function extractStack(module, endpoints, requiredAPIs, prefix = "") {
+function extractStack(module, endpoints, requiredAPIs, extensions, prefix = "") {
     for (const [name, valAsUnknown] of Object.entries(module)) {
         // We're introspecting untrusted code here. Any is appropraite
         const val = valAsUnknown;
@@ -65,12 +65,75 @@ function extractStack(module, endpoints, requiredAPIs, prefix = "") {
                 requiredAPIs.push(...val.__requiredAPIs);
             }
         }
-        else if (typeof val === "object" && val !== null) {
-            extractStack(val, endpoints, requiredAPIs, prefix + name + "-");
+        else if (isFirebaseRefExtension(val)) {
+            extensions[val.instanceId] = {
+                params: convertExtensionParams(val.params),
+                ref: val.FIREBASE_EXTENSION_REFERENCE,
+                events: val.events || [],
+            };
+        }
+        else if (isFirebaseLocalExtension(val)) {
+            extensions[val.instanceId] = {
+                params: convertExtensionParams(val.params),
+                localPath: val.FIREBASE_EXTENSION_LOCAL_PATH,
+                events: val.events || [],
+            };
+        }
+        else if (isObject(val)) {
+            extractStack(val, endpoints, requiredAPIs, extensions, prefix + name + "-");
         }
     }
 }
 exports.extractStack = extractStack;
+function toTitleCase(txt) {
+    return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase();
+}
+function snakeToCamelCase(txt) {
+    let ret = txt.toLowerCase();
+    ret = ret.replace(/_/g, " ");
+    ret = ret.replace(/\w\S*/g, toTitleCase);
+    ret = ret.charAt(0).toLowerCase() + ret.substring(1);
+    return ret;
+}
+function convertExtensionParams(params) {
+    const systemPrefixes = {
+        FUNCTION: "firebaseextensions.v1beta.function",
+        V2FUNCTION: "firebaseextensions.v1beta.v2function",
+    };
+    const converted = {};
+    for (const [rawKey, paramVal] of Object.entries(params)) {
+        let key = rawKey;
+        if (rawKey.startsWith("_") && rawKey !== "_EVENT_ARC_REGION") {
+            const prefix = rawKey.substring(1).split("_")[0];
+            const suffix = rawKey.substring(2 + prefix.length); // 2 for underscores
+            key = `${systemPrefixes[prefix]}/${snakeToCamelCase(suffix)}`;
+        }
+        if (Array.isArray(paramVal)) {
+            converted[key] = paramVal.join(",");
+        }
+        else {
+            converted[key] = paramVal;
+        }
+    }
+    return converted;
+}
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+const isFirebaseLocalExtension = (val) => {
+    return (isObject(val) &&
+        typeof val.FIREBASE_EXTENSION_LOCAL_PATH === "string" &&
+        typeof val.instanceId === "string" &&
+        isObject(val.params) &&
+        (!val.events || Array.isArray(val.events)));
+};
+const isFirebaseRefExtension = (val) => {
+    return (isObject(val) &&
+        typeof val.FIREBASE_EXTENSION_REFERENCE === "string" &&
+        typeof val.instanceId === "string" &&
+        isObject(val.params) &&
+        (!val.events || Array.isArray(val.events)));
+};
 /* @internal */
 function mergeRequiredAPIs(requiredAPIs) {
     const apiToReasons = {};
@@ -90,12 +153,14 @@ exports.mergeRequiredAPIs = mergeRequiredAPIs;
 async function loadStack(functionsDir) {
     const endpoints = {};
     const requiredAPIs = [];
+    const extensions = {};
     const mod = await loadModule(functionsDir);
-    extractStack(mod, endpoints, requiredAPIs);
+    extractStack(mod, endpoints, requiredAPIs, extensions);
     const stack = {
         endpoints,
         specVersion: "v1alpha1",
         requiredAPIs: mergeRequiredAPIs(requiredAPIs),
+        extensions,
     };
     if (params.declaredParams.length > 0) {
         stack.params = params.declaredParams.map((p) => p.toSpec());

package/lib/runtime/manifest.d.ts

@@ -1,8 +1,18 @@
 import { ResetValue } from "../common/options";
 import { Expression } from "../params";
-import { WireParamSpec } from "../params/types";
+import { WireParamSpec, SecretParam } from "../params/types";
 /**
- * An definition of a function as appears in the Manifest.
+ * A definition of an extension as appears in the Manifest.
+ * Exactly one of ref or localPath must be present.
+ */
+export interface ManifestExtension {
+    params: Record<string, string | SecretParam>;
+    ref?: string;
+    localPath?: string;
+    events: string[];
+}
+/**
+ * A definition of a function as appears in the Manifest.
  *
  * @alpha
  */
@@ -83,7 +93,8 @@ export interface ManifestRequiredAPI {
     reason: string;
 }
 /**
- * An definition of a function deployment as appears in the Manifest.
+ * A definition of a function/extension deployment as appears in the Manifest.
+ *
  * @alpha
  */
 export interface ManifestStack {
@@ -91,6 +102,7 @@ export interface ManifestStack {
     params?: WireParamSpec<any>[];
     requiredAPIs: ManifestRequiredAPI[];
     endpoints: Record<string, ManifestEndpoint>;
+    extensions?: Record<string, ManifestExtension>;
 }
 /**
  * Returns the JSON representation of a ManifestStack, which has CEL

package/lib/v1/config.d.ts

@@ -3,6 +3,6 @@ export { firebaseConfig } from "../common/config";
  * Store and retrieve project configuration data such as third-party API
  * keys or other settings. You can set configuration values using the
  * Firebase CLI as described in
- * [Environment Configuration](/docs/functions/config-env).
+ * https://firebase.google.com/docs/functions/config-env.
  */
 export declare function config(): Record<string, any>;

package/lib/v1/config.js

@@ -35,7 +35,7 @@ exports.resetCache = resetCache;
  * Store and retrieve project configuration data such as third-party API
  * keys or other settings. You can set configuration values using the
  * Firebase CLI as described in
- * [Environment Configuration](/docs/functions/config-env).
+ * https://firebase.google.com/docs/functions/config-env.
  */
 function config() {
     // K_CONFIGURATION is only set in GCFv2

package/lib/v2/options.d.ts

@@ -43,7 +43,7 @@ export interface GlobalOptions {
      * The minimum timeout for a 2nd gen function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes).
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -43,6 +43,7 @@ exports.onAlertPublished = onAlertPublished;
  * @internal
  */
 function getEndpointAnnotation(opts, alertType, appId) {
+    var _a;
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     const specificOpts = options.optionsToEndpoint(opts);
     const endpoint = {
@@ -59,7 +60,7 @@ function getEndpointAnnotation(opts, alertType, appId) {
             eventFilters: {
                 alerttype: alertType,
             },
-            retry: !!opts.retry,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     if (appId) {

package/lib/v2/providers/database.js

@@ -143,6 +143,7 @@ function makeChangedDatabaseEvent(event, instance, params) {
 }
 /** @internal */
 function makeEndpoint(eventType, opts, path, instance) {
+    var _a;
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     const specificOpts = options.optionsToEndpoint(opts);
     const eventFilters = {};
@@ -166,7 +167,7 @@ function makeEndpoint(eventType, opts, path, instance) {
             eventType,
             eventFilters,
             eventFilterPathPatterns,
-            retry: false,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
 }

package/lib/v2/providers/eventarc.js

@@ -32,7 +32,7 @@ const trace_1 = require("../trace");
 const options = require("../options");
 const onInit_1 = require("../../common/onInit");
 function onCustomEventPublished(eventTypeOrOpts, handler) {
-    var _a;
+    var _a, _b;
     let opts;
     if (typeof eventTypeOrOpts === "string") {
         opts = {
@@ -61,7 +61,7 @@ function onCustomEventPublished(eventTypeOrOpts, handler) {
         eventTrigger: {
             eventType: opts.eventType,
             eventFilters: {},
-            retry: false,
+            retry: (_b = opts.retry) !== null && _b !== void 0 ? _b : false,
             channel,
         },
     };

package/lib/v2/providers/firestore.js

@@ -256,6 +256,7 @@ function makeChangedFirestoreEvent(event, params) {
 exports.makeChangedFirestoreEvent = makeChangedFirestoreEvent;
 /** @internal */
 function makeEndpoint(eventType, opts, document, database, namespace) {
+    var _a;
     const baseOpts = (0, options_1.optionsToEndpoint)((0, options_1.getGlobalOptions)());
     const specificOpts = (0, options_1.optionsToEndpoint)(opts);
     const eventFilters = {
@@ -283,7 +284,7 @@ function makeEndpoint(eventType, opts, document, database, namespace) {
             eventType,
             eventFilters,
             eventFilterPathPatterns,
-            retry: !!opts.retry,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
 }

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

@@ -10,7 +10,7 @@ export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
 /**
  * Options that can be set on an onRequest HTTPS function.
  */
-export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
+export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceAppCheck"> {
     /**
      * If true, do not deploy or emulate this function.
      */

package/lib/v2/providers/https.js

@@ -128,7 +128,7 @@ function onCall(optsOrHandler, handler) {
     // on the origin header of the request. If there is only one element in the
     // array, this is unnecessary.
     if (Array.isArray(origin) && origin.length === 1) {
-        origin = origin[1];
+        origin = origin[0];
     }
     // onCallHandler sniffs the function length to determine which API to present.
     // fix the length to prevent api versions from being mismatched.

package/lib/v2/providers/pubsub.js

@@ -112,6 +112,7 @@ exports.Message = Message;
  * @typeParam T - Type representing `Message.data`'s JSON format
  */
 function onMessagePublished(topicOrOptions, handler) {
+    var _a;
     let topic;
     let opts;
     if (typeof topicOrOptions === "string") {
@@ -162,7 +163,7 @@ function onMessagePublished(topicOrOptions, handler) {
         eventTrigger: {
             eventType: "google.cloud.pubsub.topic.v1.messagePublished",
             eventFilters: { topic },
-            retry: false,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, "retry", "retry");

package/lib/v2/providers/remoteConfig.js

@@ -36,6 +36,7 @@ exports.eventType = "google.firebase.remoteconfig.remoteConfig.v1.updated";
  * @returns A function that you can export and deploy.
  */
 function onConfigUpdated(optsOrHandler, handler) {
+    var _a;
     if (typeof optsOrHandler === "function") {
         handler = optsOrHandler;
         optsOrHandler = {};
@@ -58,7 +59,7 @@ function onConfigUpdated(optsOrHandler, handler) {
         eventTrigger: {
             eventType: exports.eventType,
             eventFilters: {},
-            retry: !!optsOrHandler.retry,
+            retry: (_a = optsOrHandler.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     func.__endpoint = ep;

package/lib/v2/providers/storage.js

@@ -133,6 +133,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
     // To prevent runtime errors when FIREBASE_CONFIG env var is missing, we use getters.
     Object.defineProperty(func, "__endpoint", {
         get: () => {
+            var _a;
             const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
             const specificOpts = options.optionsToEndpoint(opts);
             const endpoint = {
@@ -147,7 +148,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
                 eventTrigger: {
                     eventType,
                     eventFilters: { bucket },
-                    retry: false,
+                    retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
                 },
             };
             (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, "retry", "retry");

package/lib/v2/providers/tasks.js

@@ -86,6 +86,7 @@ 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/lib/v2/providers/testLab.js

@@ -37,6 +37,7 @@ exports.eventType = "google.firebase.testlab.testMatrix.v1.completed";
  * @alpha
  */
 function onTestMatrixCompleted(optsOrHandler, handler) {
+    var _a;
     if (typeof optsOrHandler === "function") {
         handler = optsOrHandler;
         optsOrHandler = {};
@@ -59,7 +60,7 @@ function onTestMatrixCompleted(optsOrHandler, handler) {
         eventTrigger: {
             eventType: exports.eventType,
             eventFilters: {},
-            retry: !!optsOrHandler.retry,
+            retry: (_a = optsOrHandler.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     func.__endpoint = ep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "5.0.1",
+  "version": "5.1.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -182,7 +182,7 @@
     "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown --project functions && npm run docgen:v2:toc",
     "docgen:v2": "npm run build && npm run docgen:v2:extract && npm run docgen:v2:gen",
     "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack",
-    "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json",
+    "build:release": "npm ci --production && npm install --no-save typescript && tsc -p tsconfig.release.json",
     "build": "tsc -p tsconfig.release.json",
     "build:watch": "npm run build -- -w",
     "format": "npm run format:ts && npm run format:other",