firebase-functions 4.6.0 → 4.8.0

package/lib/params/types.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.ListParam = exports.BooleanParam = exports.FloatParam = exports.IntParam = exports.InternalExpression = exports.StringParam = exports.SecretParam = exports.Param = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
+exports.ListParam = exports.BooleanParam = exports.FloatParam = exports.IntParam = exports.InternalExpression = exports.StringParam = exports.SecretParam = exports.Param = exports.BUCKET_PICKER = exports.multiSelect = exports.select = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
 const logger = require("../logger");
 /*
  * A CEL expression which can be evaluated during function deployment, and
@@ -29,7 +29,7 @@ const logger = require("../logger");
  * an Expression<number> as the value of an option that normally accepts numbers.
  */
 class Expression {
-    /** Returns the Expression's runtime value, based on the CLI's resolution of params. */
+    /** Returns the expression's runtime value, based on the CLI's resolution of parameters. */
     value() {
         if (process.env.FUNCTIONS_CONTROL_API === "true") {
             logger.warn(`${this.toString()}.value() invoked during function deployment, instead of during runtime.`);
@@ -42,10 +42,11 @@ class Expression {
     runtimeValue() {
         throw new Error("Not implemented");
     }
-    /** Returns the Expression's representation as a braced CEL expression. */
+    /** Returns the expression's representation as a braced CEL expression. */
     toCEL() {
         return `{{ ${this.toString()} }}`;
     }
+    /** Returns the expression's representation as JSON. */
     toJSON() {
         return this.toString();
     }
@@ -55,8 +56,8 @@ function valueOf(arg) {
     return arg instanceof Expression ? arg.runtimeValue() : arg;
 }
 /**
- * Returns how an entity (either an Expression or a literal value) should be represented in CEL.
- * - Expressions delegate to the .toString() method, which is used by the WireManifest
+ * Returns how an entity (either an `Expression` or a literal value) should be represented in CEL.
+ * - Expressions delegate to the `.toString()` method, which is used by the WireManifest
  * - Strings have to be quoted explicitly
  * - Arrays are represented as []-delimited, parsable JSON
  * - Numbers and booleans are not quoted explicitly
@@ -136,12 +137,52 @@ class CompareExpression extends Expression {
         const rhsStr = refOf(this.rhs);
         return `${this.lhs} ${this.cmp} ${rhsStr}`;
     }
-    /** Returns a TernaryExpression which can resolve to one of two values, based on the resolution of this comparison. */
+    /** Returns a `TernaryExpression` which can resolve to one of two values, based on the resolution of this comparison. */
     thenElse(ifTrue, ifFalse) {
         return new TernaryExpression(this, ifTrue, ifFalse);
     }
 }
 exports.CompareExpression = CompareExpression;
+/** Create a select input from a series of values or a map of labels to values */
+function select(options) {
+    let wireOpts;
+    if (Array.isArray(options)) {
+        wireOpts = options.map((opt) => ({ value: opt }));
+    }
+    else {
+        wireOpts = Object.entries(options).map(([label, value]) => ({ label, value }));
+    }
+    return {
+        select: {
+            options: wireOpts,
+        },
+    };
+}
+exports.select = select;
+/** Create a multi-select input from a series of values or map of labels to values. */
+function multiSelect(options) {
+    let wireOpts;
+    if (Array.isArray(options)) {
+        wireOpts = options.map((opt) => ({ value: opt }));
+    }
+    else {
+        wireOpts = Object.entries(options).map(([label, value]) => ({ label, value }));
+    }
+    return {
+        multiSelect: {
+            options: wireOpts,
+        },
+    };
+}
+exports.multiSelect = multiSelect;
+/**
+ * Autogenerate a list of buckets in a project that a user can select from.
+ */
+exports.BUCKET_PICKER = {
+    resource: {
+        type: "storage.googleapis.com/Bucket",
+    },
+};
 /**
  * Represents a parametrized value that will be read from .env files if present,
  * or prompted for by the CLI if missing. Instantiate these with the defineX
@@ -157,36 +198,36 @@ class Param extends Expression {
     runtimeValue() {
         throw new Error("Not implemented");
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     cmp(cmp, rhs) {
         return new CompareExpression(cmp, this, rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     equals(rhs) {
         return this.cmp("==", rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     notEquals(rhs) {
         return this.cmp("!=", rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     greaterThan(rhs) {
         return this.cmp(">", rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     greaterThanOrEqualTo(rhs) {
         return this.cmp(">=", rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     lessThan(rhs) {
         return this.cmp("<", rhs);
     }
-    /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    /** Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. */
     lessThanOrEqualTo(rhs) {
         return this.cmp("<=", rhs);
     }
     /**
-     * Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression.
+     * Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
      * @deprecated A typo. Use lessThanOrEqualTo instead.
      */
     lessThanorEqualTo(rhs) {
@@ -266,7 +307,7 @@ exports.StringParam = StringParam;
 /**
  * A CEL expression which represents an internal Firebase variable. This class
  * cannot be instantiated by developers, but we provide several canned instances
- * of it to make available params that will never have to be defined at
+ * of it to make available parameters that will never have to be defined at
  * deployment time, and can always be read from process.env.
  * @internal
  */

package/lib/v1/cloud-functions.js

@@ -28,6 +28,7 @@ const encoding_1 = require("../common/encoding");
 const manifest_1 = require("../runtime/manifest");
 const options_1 = require("../common/options");
 const types_1 = require("../params/types");
+const onInit_1 = require("../common/onInit");
 var change_1 = require("../common/change");
 Object.defineProperty(exports, "Change", { enumerable: true, get: function () { return change_1.Change; } });
 /** @internal */
@@ -69,6 +70,7 @@ function makeCloudFunction({ contextOnlyHandler, dataConstructor = (raw) => raw.
         else {
             context.params = context.params || _makeParams(context, triggerResource);
         }
+        handler = (0, onInit_1.withInit)(handler);
         let promise;
         if (labels && labels["deployment-scheduled"]) {
             // Scheduled function do not have meaningful data, so exclude it

package/lib/v1/index.d.ts

@@ -20,3 +20,4 @@ export * from "./function-builder";
 export * from "./function-configuration";
 import * as params from "../params";
 export { params };
+export { onInit } from "../common/onInit";

package/lib/v1/index.js

@@ -35,7 +35,7 @@ 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.params = exports.app = exports.logger = exports.testLab = exports.tasks = exports.storage = exports.remoteConfig = exports.pubsub = exports.https = exports.firestore = exports.database = exports.auth = exports.analytics = void 0;
+exports.onInit = exports.params = exports.app = exports.logger = exports.testLab = exports.tasks = exports.storage = exports.remoteConfig = exports.pubsub = exports.https = exports.firestore = exports.database = exports.auth = exports.analytics = void 0;
 // Providers:
 const logger = require("../logger");
 exports.logger = logger;
@@ -69,3 +69,5 @@ __exportStar(require("./function-configuration"), exports);
 // NOTE: Equivalent to `export * as params from "../params"` but api-extractor doesn't support that syntax.
 const params = require("../params");
 exports.params = params;
+var onInit_1 = require("../common/onInit");
+Object.defineProperty(exports, "onInit", { enumerable: true, get: function () { return onInit_1.onInit; } });

package/lib/v1/providers/https.js

@@ -27,6 +27,8 @@ const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
 const cloud_functions_1 = require("../cloud-functions");
 const manifest_1 = require("../../runtime/manifest");
+const onInit_1 = require("../../common/onInit");
+const trace_1 = require("../../v2/trace");
 /**
  * Handle HTTP requests.
  * @param handler A function that takes a request and response object,
@@ -48,7 +50,7 @@ exports.onCall = onCall;
 function _onRequestWithOptions(handler, options) {
     // lets us add __endpoint without altering handler:
     const cloudFunction = (req, res) => {
-        return handler(req, res);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(req, res);
     };
     cloudFunction.__trigger = {
         ...(0, cloud_functions_1.optionsToTrigger)(options),
@@ -71,12 +73,14 @@ function _onCallWithOptions(handler, options) {
     // onCallHandler sniffs the function length of the passed-in callback
     // and the user could have only tried to listen to data. Wrap their handler
     // in another handler to avoid accidentally triggering the v2 API
-    const fixedLen = (data, context) => handler(data, context);
-    const func = (0, https_1.onCallHandler)({
+    const fixedLen = (data, context) => {
+        return (0, onInit_1.withInit)(handler)(data, context);
+    };
+    const func = (0, trace_1.wrapTraceContext)((0, https_1.onCallHandler)({
         enforceAppCheck: options.enforceAppCheck,
         consumeAppCheckToken: options.consumeAppCheckToken,
         cors: { origin: true, methods: "POST" },
-    }, fixedLen);
+    }, fixedLen));
     func.__trigger = {
         labels: {},
         ...(0, cloud_functions_1.optionsToTrigger)(options),
@@ -90,7 +94,7 @@ function _onCallWithOptions(handler, options) {
         ...(0, cloud_functions_1.optionsToEndpoint)(options),
         callableTrigger: {},
     };
-    func.run = handler;
+    func.run = fixedLen;
     return func;
 }
 exports._onCallWithOptions = _onCallWithOptions;

package/lib/v2/core.d.ts

@@ -6,6 +6,7 @@ import { Change } from "../common/change";
 import { ManifestEndpoint } from "../runtime/manifest";
 export { Change };
 export { ParamsOf } from "../common/params";
+export { onInit } from "../common/onInit";
 /**
  * A `CloudEventBase` is the base of a cross-platform format for encoding a serverless event.
  * For more information, see https://github.com/cloudevents/spec.

package/lib/v2/core.js

@@ -21,10 +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.Change = void 0;
+exports.onInit = exports.Change = void 0;
 /**
  * Core functionality of the Cloud Functions for Firebase 2nd gen SDK.
  * @packageDocumentation
  */
 const change_1 = require("../common/change");
 Object.defineProperty(exports, "Change", { enumerable: true, get: function () { return change_1.Change; } });
+var onInit_1 = require("../common/onInit");
+Object.defineProperty(exports, "onInit", { enumerable: true, get: function () { return onInit_1.onInit; } });

package/lib/v2/index.d.ts

@@ -20,7 +20,7 @@ import * as testLab from "./providers/testLab";
 import * as firestore from "./providers/firestore";
 export { alerts, database, storage, https, identity, pubsub, logger, tasks, eventarc, scheduler, remoteConfig, testLab, firestore, };
 export { setGlobalOptions, GlobalOptions, SupportedRegion, MemoryOption, VpcEgressSetting, IngressSetting, EventHandlerOptions, } from "./options";
-export { CloudFunction, CloudEvent, ParamsOf } from "./core";
+export { CloudFunction, CloudEvent, ParamsOf, onInit } from "./core";
 export { Change } from "../common/change";
 import * as params from "../params";
 export { params };

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.params = exports.Change = 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.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;
 /**
  * The 2nd gen API for Cloud Functions for Firebase.
  * This SDK supports deep imports. For example, the namespace
@@ -57,6 +57,8 @@ const firestore = require("./providers/firestore");
 exports.firestore = firestore;
 var options_1 = require("./options");
 Object.defineProperty(exports, "setGlobalOptions", { enumerable: true, get: function () { return options_1.setGlobalOptions; } });
+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; } });
 // NOTE: Equivalent to `export * as params from "../params"` but api-extractor doesn't support that syntax.

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

@@ -25,12 +25,13 @@ exports.convertAlertAndApp = exports.getOptsAndAlertTypeAndApp = exports.getEndp
 const manifest_1 = require("../../../runtime/manifest");
 const trace_1 = require("../../trace");
 const options = require("../../options");
+const onInit_1 = require("../../../common/onInit");
 /** @internal */
 exports.eventType = "google.firebase.firebasealerts.alerts.v1.published";
 function onAlertPublished(alertTypeOrOpts, handler) {
     const [opts, alertType, appId] = getOptsAndAlertTypeAndApp(alertTypeOrOpts);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler)(convertAlertAndApp(raw));
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(convertAlertAndApp(raw));
     };
     func.run = handler;
     func.__endpoint = getEndpointAnnotation(opts, alertType, appId);

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

@@ -24,6 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOptsAndApp = exports.onInAppFeedbackPublished = exports.onNewTesterIosDevicePublished = exports.inAppFeedbackAlert = exports.newTesterIosDeviceAlert = void 0;
 const trace_1 = require("../../trace");
 const alerts_1 = require("./alerts");
+const onInit_1 = require("../../../common/onInit");
 /** @internal */
 exports.newTesterIosDeviceAlert = "appDistribution.newTesterIosDevice";
 /** @internal */
@@ -41,7 +42,7 @@ function onNewTesterIosDevicePublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.newTesterIosDeviceAlert, appId);
@@ -61,7 +62,7 @@ function onInAppFeedbackPublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.inAppFeedbackAlert, appId);

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

@@ -24,6 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.onOperation = exports.onPlanAutomatedUpdatePublished = exports.onPlanUpdatePublished = exports.planAutomatedUpdateAlert = exports.planUpdateAlert = void 0;
 const trace_1 = require("../../trace");
 const alerts_1 = require("./alerts");
+const onInit_1 = require("../../../common/onInit");
 /** @internal */
 exports.planUpdateAlert = "billing.planUpdate";
 /** @internal */
@@ -55,7 +56,7 @@ function onOperation(alertType, optsOrHandler, handler) {
         optsOrHandler = {};
     }
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(optsOrHandler, alertType);

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

@@ -24,6 +24,7 @@ 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 trace_1 = require("../../trace");
 const alerts_1 = require("./alerts");
+const onInit_1 = require("../../../common/onInit");
 /** @internal */
 exports.newFatalIssueAlert = "crashlytics.newFatalIssue";
 /** @internal */
@@ -104,7 +105,7 @@ function onOperation(alertType, appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler((0, alerts_1.convertAlertAndApp)(raw)));
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, alertType, appId);

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

@@ -1,7 +1,3 @@
-/**
- * Cloud functions to handle Firebase Performance Monitoring events from Firebase Alerts.
- * @packageDocumentation
- */
 import { CloudEvent, CloudFunction } from "../../core";
 import { EventHandlerOptions } from "../../options";
 import { FirebaseAlertData } from "./alerts";

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

@@ -22,6 +22,12 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertPayload = exports.getOptsAndApp = exports.onThresholdAlertPublished = exports.thresholdAlert = void 0;
+/**
+ * Cloud functions to handle Firebase Performance Monitoring events from Firebase Alerts.
+ * @packageDocumentation
+ */
+const onInit_1 = require("../../../common/onInit");
+const trace_1 = require("../../trace");
 const alerts_1 = require("./alerts");
 /** @internal */
 exports.thresholdAlert = "performance.threshold";
@@ -41,7 +47,7 @@ function onThresholdAlertPublished(appIdOrOptsOrHandler, handler) {
         const event = (0, alerts_1.convertAlertAndApp)(raw);
         const convertedPayload = convertPayload(event.data.payload);
         event.data.payload = convertedPayload;
-        return handler(event);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler(event)));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.thresholdAlert, appId);

package/lib/v2/providers/database.js

@@ -31,6 +31,7 @@ const utils_1 = require("../../common/utilities/utils");
 const manifest_1 = require("../../runtime/manifest");
 const trace_1 = require("../trace");
 const options = require("../options");
+const onInit_1 = require("../../common/onInit");
 /** @internal */
 exports.writtenEventType = "google.firebase.database.ref.v1.written";
 /** @internal */
@@ -181,7 +182,9 @@ function onChangedOperation(eventType, referenceOrOpts, handler) {
         const instanceUrl = getInstance(event);
         const params = makeParams(event, pathPattern, instancePattern);
         const databaseEvent = makeChangedDatabaseEvent(event, instanceUrl, params);
-        return (0, trace_1.wrapTraceContext)(handler)(databaseEvent);
+        // Intentionally put init in the context of traces in case there is something
+        // expensive to observe.
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(databaseEvent);
     };
     func.run = handler;
     func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);
@@ -200,7 +203,7 @@ function onOperation(eventType, referenceOrOpts, handler) {
         const params = makeParams(event, pathPattern, instancePattern);
         const data = eventType === exports.deletedEventType ? event.data.data : event.data.delta;
         const databaseEvent = makeDatabaseEvent(event, data, instanceUrl, params);
-        return handler(databaseEvent);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(databaseEvent);
     };
     func.run = handler;
     func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);

package/lib/v2/providers/eventarc.js

@@ -30,6 +30,7 @@ const encoding_1 = require("../../common/encoding");
 const manifest_1 = require("../../runtime/manifest");
 const trace_1 = require("../trace");
 const options = require("../options");
+const onInit_1 = require("../../common/onInit");
 function onCustomEventPublished(eventTypeOrOpts, handler) {
     var _a;
     let opts;
@@ -42,7 +43,7 @@ function onCustomEventPublished(eventTypeOrOpts, handler) {
         opts = eventTypeOrOpts;
     }
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler)(raw);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(raw);
     };
     func.run = handler;
     const channel = (_a = opts.channel) !== null && _a !== void 0 ? _a : "locations/us-central1/channels/firebase";

package/lib/v2/providers/firestore.js

@@ -31,6 +31,7 @@ Object.defineProperty(exports, "Change", { enumerable: true, get: function () {
 const options_1 = require("../options");
 const firestore_1 = require("../../common/providers/firestore");
 const trace_1 = require("../trace");
+const onInit_1 = require("../../common/onInit");
 /** @internal */
 exports.writtenEventType = "google.cloud.firestore.document.v1.written";
 /** @internal */
@@ -220,7 +221,7 @@ function onOperation(eventType, documentOrOpts, handler) {
         const event = raw;
         const params = makeParams(event.document, documentPattern);
         const firestoreEvent = makeFirestoreEvent(eventType, event, params);
-        return (0, trace_1.wrapTraceContext)(handler)(firestoreEvent);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(firestoreEvent);
     };
     func.run = handler;
     func.__endpoint = makeEndpoint(eventType, opts, documentPattern, database, namespace);
@@ -236,7 +237,7 @@ function onChangedOperation(eventType, documentOrOpts, handler) {
         const event = raw;
         const params = makeParams(event.document, documentPattern);
         const firestoreEvent = makeChangedFirestoreEvent(event, params);
-        return handler(firestoreEvent);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(firestoreEvent);
     };
     func.run = handler;
     func.__endpoint = makeEndpoint(eventType, opts, documentPattern, database, namespace);

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

@@ -175,10 +175,10 @@ export declare function onRequest(handler: (request: Request, response: express.
  * @param handler - A function that takes a {@link https.CallableRequest}.
  * @returns A function that you can export and deploy.
  */
-export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
+export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return extends Promise<unknown> ? Return : Promise<Return>>;
 /**
  * Declares a callable method for clients to call using a Firebase SDK.
  * @param handler - A function that takes a {@link https.CallableRequest}.
  * @returns A function that you can export and deploy.
  */
-export declare function onCall<T = any, Return = any | Promise<any>>(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 extends Promise<unknown> ? Return : Promise<Return>>;

package/lib/v2/providers/https.js

@@ -34,6 +34,7 @@ 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 options = require("../options");
+const onInit_1 = require("../../common/onInit");
 function onRequest(optsOrHandler, handler) {
     let opts;
     if (arguments.length === 1) {
@@ -59,7 +60,7 @@ function onRequest(optsOrHandler, handler) {
             });
         };
     }
-    handler = (0, trace_1.wrapTraceContext)(handler);
+    handler = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler));
     Object.defineProperty(handler, "__trigger", {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -118,7 +119,7 @@ function onCall(optsOrHandler, handler) {
     const origin = (0, debug_1.isDebugFeatureEnabled)("enableCors") ? true : "cors" in opts ? opts.cors : true;
     // onCallHandler 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 fixedLen = (req) => (0, onInit_1.withInit)(handler)(req);
     let func = (0, https_1.onCallHandler)({
         cors: { origin, methods: "POST" },
         enforceAppCheck: (_a = opts.enforceAppCheck) !== null && _a !== void 0 ? _a : options.getGlobalOptions().enforceAppCheck,
@@ -161,7 +162,7 @@ function onCall(optsOrHandler, handler) {
         },
         callableTrigger: {},
     };
-    func.run = handler;
+    func.run = (0, onInit_1.withInit)(handler);
     return func;
 }
 exports.onCall = onCall;

package/lib/v2/providers/identity.js

@@ -27,6 +27,7 @@ Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function (
 const trace_1 = require("../trace");
 const manifest_1 = require("../../runtime/manifest");
 const options = require("../options");
+const onInit_1 = require("../../common/onInit");
 /**
  * Handles an event that is triggered before a user is created
  * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation)
@@ -55,7 +56,7 @@ function beforeOperation(eventType, optsOrHandler, handler) {
     // Create our own function that just calls the provided function so we know for sure that
     // handler takes one argument. This is something common/providers/identity depends on.
     const wrappedHandler = (event) => handler(event);
-    const func = (0, trace_1.wrapTraceContext)((0, identity_1.wrapHandler)(eventType, wrappedHandler));
+    const func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)((0, identity_1.wrapHandler)(eventType, wrappedHandler)));
     const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
     /** Endpoint */
     const baseOptsEndpoint = options.optionsToEndpoint(options.getGlobalOptions());

package/lib/v2/providers/pubsub.js

@@ -30,6 +30,7 @@ const encoding_1 = require("../../common/encoding");
 const manifest_1 = require("../../runtime/manifest");
 const trace_1 = require("../trace");
 const options = require("../options");
+const onInit_1 = require("../../common/onInit");
 /**
  * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
  * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
@@ -125,7 +126,7 @@ function onMessagePublished(topicOrOptions, handler) {
     const func = (raw) => {
         const messagePublishedData = raw.data;
         messagePublishedData.message = new Message(messagePublishedData.message);
-        return (0, trace_1.wrapTraceContext)(handler)(raw);
+        return (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(handler))(raw);
     };
     func.run = handler;
     Object.defineProperty(func, "__trigger", {

package/lib/v2/providers/remoteConfig.js

@@ -22,8 +22,10 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onConfigUpdated = exports.eventType = void 0;
+const onInit_1 = require("../../common/onInit");
 const manifest_1 = require("../../runtime/manifest");
 const options_1 = require("../options");
+const trace_1 = require("../trace");
 /** @internal */
 exports.eventType = "google.firebase.remoteconfig.remoteConfig.v1.updated";
 /**
@@ -40,9 +42,9 @@ function onConfigUpdated(optsOrHandler, handler) {
     }
     const baseOpts = (0, options_1.optionsToEndpoint)((0, options_1.getGlobalOptions)());
     const specificOpts = (0, options_1.optionsToEndpoint)(optsOrHandler);
-    const func = (raw) => {
+    const func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)((raw) => {
         return handler(raw);
-    };
+    }));
     func.run = handler;
     const ep = {
         ...(0, manifest_1.initV2Endpoint)((0, options_1.getGlobalOptions)(), optsOrHandler),

package/lib/v2/providers/scheduler.js

@@ -27,6 +27,7 @@ const manifest_1 = require("../../runtime/manifest");
 const trace_1 = require("../trace");
 const logger = require("../../logger");
 const options = require("../options");
+const onInit_1 = require("../../common/onInit");
 /** @internal */
 function getOpts(args) {
     if (typeof args === "string") {
@@ -72,7 +73,7 @@ function onSchedule(args, handler) {
             res.status(500).send();
         }
     };
-    const func = (0, trace_1.wrapTraceContext)(httpFunc);
+    const func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)(httpFunc));
     func.run = handler;
     const globalOpts = options.getGlobalOptions();
     const baseOptsEndpoint = options.optionsToEndpoint(globalOpts);