@firebase/performance 0.7.7 → 0.7.8-20250716004940

package/dist/index.cjs.js

@@ -10,7 +10,7 @@ var component = require('@firebase/component');
 require('@firebase/installations');
 
 const name = "@firebase/performance";
-const version = "0.7.7";
+const version = "0.7.8-20250716004940";
 
 /**
  * @license
@@ -331,6 +331,9 @@ class SettingsService {
         this.logNetworkAfterSampling = false;
         // TTL of config retrieved from remote config in hours.
         this.configTimeToLive = 12;
+        // The max number of events to send during a flush. This number is kept low to since Chrome has a
+        // shared payload limit for all sendBeacon calls in the same nav context.
+        this.logMaxFlushSize = 40;
     }
     getFlTransportFullUrl() {
         return this.flTransportEndpointUrl.concat('?key=', this.transportKey);
@@ -371,7 +374,7 @@ const MAX_ATTRIBUTE_NAME_LENGTH = 40;
 const MAX_ATTRIBUTE_VALUE_LENGTH = 100;
 function getServiceWorkerStatus() {
     const navigator = Api.getInstance().navigator;
-    if (navigator === null || navigator === void 0 ? void 0 : navigator.serviceWorker) {
+    if (navigator?.serviceWorker) {
         if (navigator.serviceWorker.controller) {
             return 2 /* ServiceWorkerStatus.CONTROLLED */;
         }
@@ -440,24 +443,21 @@ function isValidCustomAttributeValue(value) {
  * limitations under the License.
  */
 function getAppId(firebaseApp) {
-    var _a;
-    const appId = (_a = firebaseApp.options) === null || _a === void 0 ? void 0 : _a.appId;
+    const appId = firebaseApp.options?.appId;
     if (!appId) {
         throw ERROR_FACTORY.create("no app id" /* ErrorCode.NO_APP_ID */);
     }
     return appId;
 }
 function getProjectId(firebaseApp) {
-    var _a;
-    const projectId = (_a = firebaseApp.options) === null || _a === void 0 ? void 0 : _a.projectId;
+    const projectId = firebaseApp.options?.projectId;
     if (!projectId) {
         throw ERROR_FACTORY.create("no project id" /* ErrorCode.NO_PROJECT_ID */);
     }
     return projectId;
 }
 function getApiKey(firebaseApp) {
-    var _a;
-    const apiKey = (_a = firebaseApp.options) === null || _a === void 0 ? void 0 : _a.apiKey;
+    const apiKey = firebaseApp.options?.apiKey;
     if (!apiKey) {
         throw ERROR_FACTORY.create("no api key" /* ErrorCode.NO_API_KEY */);
     }
@@ -516,7 +516,7 @@ function getStoredConfig() {
         const configResponse = JSON.parse(configStringified);
         return configResponse;
     }
-    catch (_a) {
+    catch {
         return;
     }
 }
@@ -618,6 +618,12 @@ function processConfig(config) {
         settingsServiceInstance.tracesSamplingRate =
             DEFAULT_CONFIGS.tracesSamplingRate;
     }
+    if (entries.fpr_log_max_flush_size) {
+        settingsServiceInstance.logMaxFlushSize = Number(entries.fpr_log_max_flush_size);
+    }
+    else if (DEFAULT_CONFIGS.logMaxFlushSize) {
+        settingsServiceInstance.logMaxFlushSize = DEFAULT_CONFIGS.logMaxFlushSize;
+    }
     // Set the per session trace and network logging flags.
     settingsServiceInstance.logTraceAfterSampling = shouldLogAfterSampling(settingsServiceInstance.tracesSamplingRate);
     settingsServiceInstance.logNetworkAfterSampling = shouldLogAfterSampling(settingsServiceInstance.networkRequestsSamplingRate);
@@ -708,6 +714,9 @@ const DEFAULT_SEND_INTERVAL_MS = 10 * 1000;
 const INITIAL_SEND_TIME_DELAY_MS = 5.5 * 1000;
 const MAX_EVENT_COUNT_PER_REQUEST = 1000;
 const DEFAULT_REMAINING_TRIES = 3;
+// Most browsers have a max payload of 64KB for sendbeacon/keep alive payload.
+const MAX_SEND_BEACON_PAYLOAD_SIZE = 65536;
+const TEXT_ENCODER = new TextEncoder();
 let remainingTries = DEFAULT_REMAINING_TRIES;
 /* eslint-enable camelcase */
 let queue = [];
@@ -735,13 +744,28 @@ function dispatchQueueEvents() {
     // The staged events will be used for current logRequest attempt, remaining events will be kept
     // for next attempt.
     const staged = queue.splice(0, MAX_EVENT_COUNT_PER_REQUEST);
+    const data = buildPayload(staged);
+    postToFlEndpoint(data)
+        .then(() => {
+        remainingTries = DEFAULT_REMAINING_TRIES;
+    })
+        .catch(() => {
+        // If the request fails for some reason, add the events that were attempted
+        // back to the primary queue to retry later.
+        queue = [...staged, ...queue];
+        remainingTries--;
+        consoleLogger.info(`Tries left: ${remainingTries}.`);
+        processQueue(DEFAULT_SEND_INTERVAL_MS);
+    });
+}
+function buildPayload(events) {
     /* eslint-disable camelcase */
     // We will pass the JSON serialized event to the backend.
-    const log_event = staged.map(evt => ({
+    const log_event = events.map(evt => ({
         source_extension_json_proto3: evt.message,
         event_time_ms: String(evt.eventTime)
     }));
-    const data = {
+    const transportBatchLog = {
         request_time_ms: String(Date.now()),
         client_info: {
             client_type: 1, // 1 is JS
@@ -751,29 +775,23 @@ function dispatchQueueEvents() {
         log_event
     };
     /* eslint-enable camelcase */
-    postToFlEndpoint(data)
-        .then(() => {
-        remainingTries = DEFAULT_REMAINING_TRIES;
-    })
-        .catch(() => {
-        // If the request fails for some reason, add the events that were attempted
-        // back to the primary queue to retry later.
-        queue = [...staged, ...queue];
-        remainingTries--;
-        consoleLogger.info(`Tries left: ${remainingTries}.`);
-        processQueue(DEFAULT_SEND_INTERVAL_MS);
-    });
+    return JSON.stringify(transportBatchLog);
 }
-function postToFlEndpoint(data) {
+/** Sends to Firelog. Atempts to use sendBeacon otherwsise uses fetch. */
+function postToFlEndpoint(body) {
     const flTransportFullUrl = SettingsService.getInstance().getFlTransportFullUrl();
-    const body = JSON.stringify(data);
-    return navigator.sendBeacon && navigator.sendBeacon(flTransportFullUrl, body)
-        ? Promise.resolve()
-        : fetch(flTransportFullUrl, {
+    const size = TEXT_ENCODER.encode(body).length;
+    if (size <= MAX_SEND_BEACON_PAYLOAD_SIZE &&
+        navigator.sendBeacon &&
+        navigator.sendBeacon(flTransportFullUrl, body)) {
+        return Promise.resolve();
+    }
+    else {
+        return fetch(flTransportFullUrl, {
             method: 'POST',
-            body,
-            keepalive: true
-        }).then();
+            body
+        });
+    }
 }
 function addToQueue(evt) {
     if (!evt.eventTime || !evt.message) {
@@ -795,12 +813,33 @@ serializer) {
     };
 }
 /**
- * Force flush the queued events. Useful at page unload time to ensure all
- * events are uploaded.
+ * Force flush the queued events. Useful at page unload time to ensure all events are uploaded.
+ * Flush will attempt to use sendBeacon to send events async and defaults back to fetch as soon as a
+ * sendBeacon fails. Firefox
  */
 function flushQueuedEvents() {
+    const flTransportFullUrl = SettingsService.getInstance().getFlTransportFullUrl();
     while (queue.length > 0) {
-        dispatchQueueEvents();
+        // Send the last events first to prioritize page load traces
+        const staged = queue.splice(-SettingsService.getInstance().logMaxFlushSize);
+        const body = buildPayload(staged);
+        if (navigator.sendBeacon &&
+            navigator.sendBeacon(flTransportFullUrl, body)) {
+            continue;
+        }
+        else {
+            queue = [...queue, ...staged];
+            break;
+        }
+    }
+    if (queue.length > 0) {
+        const body = buildPayload(queue);
+        fetch(flTransportFullUrl, {
+            method: 'POST',
+            body
+        }).catch(() => {
+            consoleLogger.info(`Failed flushing queued events.`);
+        });
     }
 }
 
@@ -1141,7 +1180,7 @@ class Trace {
         this.durationUs = Math.floor(duration * 1000);
         this.startTimeUs = Math.floor(startTime * 1000);
         if (options && options.attributes) {
-            this.customAttributes = Object.assign({}, options.attributes);
+            this.customAttributes = { ...options.attributes };
         }
         if (options && options.metrics) {
             for (const metricName of Object.keys(options.metrics)) {
@@ -1175,7 +1214,7 @@ class Trace {
      */
     putMetric(counter, numAsInteger) {
         if (isValidMetricName(counter, this.name)) {
-            this.counters[counter] = convertMetricValueToInteger(numAsInteger !== null && numAsInteger !== void 0 ? numAsInteger : 0);
+            this.counters[counter] = convertMetricValueToInteger(numAsInteger ?? 0);
         }
         else {
             throw ERROR_FACTORY.create("invalid custom metric name" /* ErrorCode.INVALID_CUSTOM_METRIC_NAME */, {
@@ -1229,7 +1268,7 @@ class Trace {
         delete this.customAttributes[attr];
     }
     getAttributes() {
-        return Object.assign({}, this.customAttributes);
+        return { ...this.customAttributes };
     }
     setStartTime(startTime) {
         this.startTimeUs = startTime;
@@ -1366,24 +1405,21 @@ function setupOobTraces(performanceController) {
         });
     }
     api.onLCP((metric) => {
-        var _a;
         webVitalMetrics.lcp = {
             value: metric.value,
-            elementAttribution: (_a = metric.attribution) === null || _a === void 0 ? void 0 : _a.element
+            elementAttribution: metric.attribution?.element
         };
     });
     api.onCLS((metric) => {
-        var _a;
         webVitalMetrics.cls = {
             value: metric.value,
-            elementAttribution: (_a = metric.attribution) === null || _a === void 0 ? void 0 : _a.largestShiftTarget
+            elementAttribution: metric.attribution?.largestShiftTarget
         };
     });
     api.onINP((metric) => {
-        var _a;
         webVitalMetrics.inp = {
             value: metric.value,
-            elementAttribution: (_a = metric.attribution) === null || _a === void 0 ? void 0 : _a.interactionTarget
+            elementAttribution: metric.attribution?.interactionTarget
         };
     });
 }
@@ -1456,10 +1492,10 @@ class PerformanceController {
         if (this.initialized) {
             return;
         }
-        if ((settings === null || settings === void 0 ? void 0 : settings.dataCollectionEnabled) !== undefined) {
+        if (settings?.dataCollectionEnabled !== undefined) {
             this.dataCollectionEnabled = settings.dataCollectionEnabled;
         }
-        if ((settings === null || settings === void 0 ? void 0 : settings.instrumentationEnabled) !== undefined) {
+        if (settings?.instrumentationEnabled !== undefined) {
             this.instrumentationEnabled = settings.instrumentationEnabled;
         }
         if (Api.getInstance().requiredApisAvailable()) {
@@ -1526,7 +1562,7 @@ function initializePerformance(app$1, settings) {
     if (provider.isInitialized()) {
         const existingInstance = provider.getImmediate();
         const initialSettings = provider.getOptions();
-        if (util.deepEqual(initialSettings, settings !== null && settings !== void 0 ? settings : {})) {
+        if (util.deepEqual(initialSettings, settings ?? {})) {
             return existingInstance;
         }
         else {
@@ -1568,8 +1604,8 @@ const factory = (container, { options: settings }) => {
 function registerPerformance() {
     app._registerComponent(new component.Component('performance', factory, "PUBLIC" /* ComponentType.PUBLIC */));
     app.registerVersion(name, version);
-    // BUILD_TARGET will be replaced by values like esm2017, cjs2017, etc during the compilation
-    app.registerVersion(name, version, 'cjs2017');
+    // BUILD_TARGET will be replaced by values like esm, cjs, etc during the compilation
+    app.registerVersion(name, version, 'cjs2020');
 }
 registerPerformance();