@sentry/react-native 5.29.0 → 6.0.0-alpha.0

package/dist/js/tracing/integrations/nativeFrames.js

@@ -0,0 +1,256 @@
+import { __awaiter } from "tslib";
+import { spanToJSON } from '@sentry/core';
+import { logger, timestampInSeconds } from '@sentry/utils';
+import { isRootSpan } from '../../utils/span';
+import { NATIVE } from '../../wrapper';
+/**
+ * Timeout from the final native frames fetch to processing the associated transaction.
+ * If the transaction is not processed by this time, the native frames will be dropped
+ * and not added to the event.
+ */
+const FINAL_FRAMES_TIMEOUT_MS = 2000;
+/** The listeners for each native frames response, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */
+const _framesListeners = new Map();
+/** The native frames at the transaction finish time, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */
+const _finishFrames = new Map();
+/**
+ * A margin of error of 50ms is allowed for the async native bridge call.
+ * Anything larger would reduce the accuracy of our frames measurements.
+ */
+const MARGIN_OF_ERROR_SECONDS = 0.05;
+/**
+ * Instrumentation to add native slow/frozen frames measurements onto transactions.
+ */
+export const nativeFramesIntegration = () => {
+    const name = 'NativeFrames';
+    /** The native frames at the finish time of the most recent span. */
+    let _lastSpanFinishFrames = undefined;
+    const _spanToNativeFramesAtStartMap = new Map();
+    /**
+     * Hooks into the client start and end span events.
+     */
+    const setup = (client) => {
+        const { enableNativeFramesTracking } = client.getOptions();
+        if (enableNativeFramesTracking && !NATIVE.enableNative) {
+            // Do not enable native frames tracking if native is not available.
+            logger.warn('[ReactNativeTracing] NativeFramesTracking is not available on the Web, Expo Go and other platforms without native modules.');
+            return;
+        }
+        if (!enableNativeFramesTracking && NATIVE.enableNative) {
+            // Disable native frames tracking when native available and option is false.
+            NATIVE.disableNativeFramesTracking();
+            return;
+        }
+        if (!enableNativeFramesTracking) {
+            return;
+        }
+        NATIVE.enableNativeFramesTracking();
+        client.on('spanStart', _onSpanStart);
+        client.on('spanEnd', _onSpanFinish);
+        logger.log('[ReactNativeTracing] Native frames instrumentation initialized.');
+    };
+    /**
+     * Adds frames measurements to an event. Called from a valid event processor.
+     * Awaits for finish frames if needed.
+     */
+    const processEvent = (event) => {
+        return _processEvent(event);
+    };
+    /**
+     * Fetches the native frames in background if the given span is a root span.
+     *
+     * @param {Span} rootSpan - The span that has started.
+     */
+    const _onSpanStart = (rootSpan) => {
+        if (!isRootSpan(rootSpan)) {
+            return;
+        }
+        logger.debug(`[NativeFrames] Fetching frames for root span start (${rootSpan.spanContext().spanId}).`);
+        NATIVE.fetchNativeFrames()
+            .then(frames => {
+            if (!frames) {
+                logger.warn(`[NativeFrames] Fetched frames for root span start (${rootSpan.spanContext().spanId}), but no frames were returned.`);
+                return;
+            }
+            _spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames);
+        })
+            .then(undefined, error => {
+            logger.error(`[NativeFrames] Error while fetching frames for root span start (${rootSpan.spanContext().spanId})`, error);
+        });
+    };
+    /**
+     * Called on a span finish to fetch native frames to support transactions with trimEnd.
+     * Only to be called when a span does not have an end timestamp.
+     */
+    const _onSpanFinish = (span) => {
+        if (isRootSpan(span)) {
+            return _onTransactionFinish(span);
+        }
+        const timestamp = timestampInSeconds();
+        void NATIVE.fetchNativeFrames()
+            .then(frames => {
+            if (!frames) {
+                return;
+            }
+            _lastSpanFinishFrames = {
+                timestamp,
+                nativeFrames: frames,
+            };
+        })
+            .then(undefined, error => {
+            logger.error(`[NativeFrames] Error while fetching frames for child span end.`, error);
+        });
+    };
+    /**
+     * To be called when a transaction is finished
+     */
+    const _onTransactionFinish = (span) => {
+        _fetchFramesForTransaction(span).then(undefined, (reason) => {
+            logger.error(`[NativeFrames] Error while fetching frames for root span start (${span.spanContext().spanId})`, reason);
+        });
+    };
+    /**
+     * Returns the computed frames measurements and awaits for them if they are not ready yet.
+     */
+    const _getFramesMeasurements = (traceId, finalEndTimestamp, startFrames) => {
+        if (_finishFrames.has(traceId)) {
+            logger.debug(`[NativeFrames] Native end frames already fetched for trace id (${traceId}).`);
+            return Promise.resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames));
+        }
+        return new Promise(resolve => {
+            const timeout = setTimeout(() => {
+                logger.debug(`[NativeFrames] Native end frames listener removed by timeout for trace id (${traceId}).`);
+                _framesListeners.delete(traceId);
+                resolve(null);
+            }, 2000);
+            _framesListeners.set(traceId, () => {
+                logger.debug(`[NativeFrames] Native end frames listener called for trace id (${traceId}).`);
+                resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames));
+                clearTimeout(timeout);
+                _framesListeners.delete(traceId);
+            });
+        });
+    };
+    /**
+     * Returns the computed frames measurements given ready data
+     */
+    const _prepareMeasurements = (traceId, finalEndTimestamp, // The actual transaction finish time.
+    startFrames) => {
+        let finalFinishFrames;
+        const finish = _finishFrames.get(traceId);
+        if (finish &&
+            finish.nativeFrames &&
+            // Must be in the margin of error of the actual transaction finish time (finalEndTimestamp)
+            Math.abs(finish.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS) {
+            logger.debug(`[NativeFrames] Using frames from root span end (traceId, ${traceId}).`);
+            finalFinishFrames = finish.nativeFrames;
+        }
+        else if (_lastSpanFinishFrames &&
+            Math.abs(_lastSpanFinishFrames.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS) {
+            // Fallback to the last span finish if it is within the margin of error of the actual finish timestamp.
+            // This should be the case for trimEnd.
+            logger.debug(`[NativeFrames] Using native frames from last span end (traceId, ${traceId}).`);
+            finalFinishFrames = _lastSpanFinishFrames.nativeFrames;
+        }
+        else {
+            logger.warn(`[NativeFrames] Frames were collected within larger than margin of error delay for traceId (${traceId}). Dropping the inaccurate values.`);
+            return null;
+        }
+        const measurements = {
+            frames_total: {
+                value: finalFinishFrames.totalFrames - startFrames.totalFrames,
+                unit: 'none',
+            },
+            frames_frozen: {
+                value: finalFinishFrames.frozenFrames - startFrames.frozenFrames,
+                unit: 'none',
+            },
+            frames_slow: {
+                value: finalFinishFrames.slowFrames - startFrames.slowFrames,
+                unit: 'none',
+            },
+        };
+        if (measurements.frames_frozen.value <= 0 &&
+            measurements.frames_slow.value <= 0 &&
+            measurements.frames_total.value <= 0) {
+            logger.warn(`[NativeFrames] Detected zero slow or frozen frames. Not adding measurements to traceId (${traceId}).`);
+            return null;
+        }
+        return measurements;
+    };
+    /**
+     * Fetch finish frames for a transaction at the current time. Calls any awaiting listeners.
+     */
+    const _fetchFramesForTransaction = (span) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const traceId = spanToJSON(span).trace_id;
+        if (!traceId) {
+            return;
+        }
+        const startFrames = _spanToNativeFramesAtStartMap.get(span.spanContext().traceId);
+        // This timestamp marks when the finish frames were retrieved. It should be pretty close to the transaction finish.
+        const timestamp = timestampInSeconds();
+        let finishFrames = null;
+        if (startFrames) {
+            finishFrames = yield NATIVE.fetchNativeFrames();
+        }
+        _finishFrames.set(traceId, {
+            nativeFrames: finishFrames,
+            timestamp,
+        });
+        (_a = _framesListeners.get(traceId)) === null || _a === void 0 ? void 0 : _a();
+        setTimeout(() => _cancelEndFrames(span), FINAL_FRAMES_TIMEOUT_MS);
+    });
+    /**
+     * On a finish frames failure, we cancel the await.
+     */
+    const _cancelEndFrames = (span) => {
+        const spanJSON = spanToJSON(span);
+        const traceId = spanJSON.trace_id;
+        if (!traceId) {
+            return;
+        }
+        if (_finishFrames.has(traceId)) {
+            _finishFrames.delete(traceId);
+            logger.log(`[NativeFrames] Native frames timed out for ${spanJSON.op} transaction ${spanJSON.description}. Not adding native frames measurements.`);
+        }
+    };
+    /**
+     * Adds frames measurements to an event. Called from a valid event processor.
+     * Awaits for finish frames if needed.
+     */
+    const _processEvent = (event) => __awaiter(void 0, void 0, void 0, function* () {
+        var _b;
+        if (event.type !== 'transaction' ||
+            !event.transaction ||
+            !event.contexts ||
+            !event.contexts.trace ||
+            !event.timestamp ||
+            !event.contexts.trace.trace_id) {
+            return event;
+        }
+        const traceOp = event.contexts.trace.op;
+        const traceId = event.contexts.trace.trace_id;
+        const startFrames = _spanToNativeFramesAtStartMap.get(traceId);
+        _spanToNativeFramesAtStartMap.delete(traceId);
+        if (!startFrames) {
+            logger.warn(`[NativeFrames] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but it already ended.`);
+            return event;
+        }
+        const measurements = yield _getFramesMeasurements(traceId, event.timestamp, startFrames);
+        if (!measurements) {
+            logger.log(`[NativeFrames] Could not fetch native frames for ${traceOp} transaction ${event.transaction}. Not adding native frames measurements.`);
+            return event;
+        }
+        logger.log(`[Measurements] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify(measurements, undefined, 2)}`);
+        event.measurements = Object.assign(Object.assign({}, ((_b = event.measurements) !== null && _b !== void 0 ? _b : {})), measurements);
+        _finishFrames.delete(traceId);
+        return event;
+    });
+    return {
+        name,
+        setup,
+        processEvent,
+    };
+};
+//# sourceMappingURL=nativeFrames.js.map

package/dist/js/tracing/integrations/nativeFrames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeFrames.js","sourceRoot":"","sources":["../../../../src/js/tracing/integrations/nativeFrames.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAI3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;;;GAIG;AACH,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAQrC,gJAAgJ;AAChJ,MAAM,gBAAgB,GAA4B,IAAI,GAAG,EAAE,CAAC;AAE5D,mJAAmJ;AACnJ,MAAM,aAAa,GAAkF,IAAI,GAAG,EAAE,CAAC;AAE/G;;;GAGG;AACH,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAgB,EAAE;IACvD,MAAM,IAAI,GAAW,cAAc,CAAC;IAEpC,oEAAoE;IACpE,IAAI,qBAAqB,GAKT,SAAS,CAAC;IAC1B,MAAM,6BAA6B,GAAsC,IAAI,GAAG,EAAE,CAAC;IAEnF;;OAEG;IACH,MAAM,KAAK,GAAG,CAAC,MAAc,EAAQ,EAAE;QACrC,MAAM,EAAE,0BAA0B,EAAE,GAAG,MAAM,CAAC,UAAU,EAA8B,CAAC;QAEvF,IAAI,0BAA0B,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YACtD,mEAAmE;YACnE,MAAM,CAAC,IAAI,CACT,4HAA4H,CAC7H,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,0BAA0B,IAAI,MAAM,CAAC,YAAY,EAAE;YACtD,4EAA4E;YAC5E,MAAM,CAAC,2BAA2B,EAAE,CAAC;YACrC,OAAO;SACR;QAED,IAAI,CAAC,0BAA0B,EAAE;YAC/B,OAAO;SACR;QAED,MAAM,CAAC,0BAA0B,EAAE,CAAC;QAEpC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACpC,MAAM,CAAC,GAAG,CAAC,iEAAiE,CAAC,CAAC;IAChF,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,YAAY,GAAG,CAAC,KAAY,EAAkB,EAAE;QACpD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,YAAY,GAAG,CAAC,QAAc,EAAQ,EAAE;QAC5C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,OAAO;SACR;QAED,MAAM,CAAC,KAAK,CAAC,uDAAuD,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,IAAI,CAAC,CAAC;QAEvG,MAAM,CAAC,iBAAiB,EAAE;aACvB,IAAI,CAAC,MAAM,CAAC,EAAE;YACb,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,CAAC,IAAI,CACT,sDACE,QAAQ,CAAC,WAAW,EAAE,CAAC,MACzB,iCAAiC,CAClC,CAAC;gBACF,OAAO;aACR;YAED,6BAA6B,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC;aACD,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;YACvB,MAAM,CAAC,KAAK,CACV,mEAAmE,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,EACnG,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,aAAa,GAAG,CAAC,IAAU,EAAQ,EAAE;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE;YACpB,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;SACnC;QAED,MAAM,SAAS,GAAG,kBAAkB,EAAE,CAAC;QAEvC,KAAK,MAAM,CAAC,iBAAiB,EAAE;aAC5B,IAAI,CAAC,MAAM,CAAC,EAAE;YACb,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO;aACR;YAED,qBAAqB,GAAG;gBACtB,SAAS;gBACT,YAAY,EAAE,MAAM;aACrB,CAAC;QACJ,CAAC,CAAC;aACD,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;YACvB,MAAM,CAAC,KAAK,CAAC,gEAAgE,EAAE,KAAK,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,oBAAoB,GAAG,CAAC,IAAU,EAAQ,EAAE;QAChD,0BAA0B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAe,EAAE,EAAE;YACnE,MAAM,CAAC,KAAK,CACV,mEAAmE,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,EAC/F,MAAM,CACP,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,sBAAsB,GAAG,CAC7B,OAAe,EACf,iBAAyB,EACzB,WAAiC,EACG,EAAE;QACtC,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,kEAAkE,OAAO,IAAI,CAAC,CAAC;YAC5F,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;SACvF;QAED,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC9B,MAAM,CAAC,KAAK,CAAC,8EAA8E,OAAO,IAAI,CAAC,CAAC;gBACxG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAEjC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,EAAE,IAAI,CAAC,CAAC;YAET,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE;gBACjC,MAAM,CAAC,KAAK,CAAC,kEAAkE,OAAO,IAAI,CAAC,CAAC;gBAC5F,OAAO,CAAC,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC;gBAEvE,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,oBAAoB,GAAG,CAC3B,OAAe,EACf,iBAAyB,EAAE,sCAAsC;IACjE,WAAiC,EACN,EAAE;QAC7B,IAAI,iBAAmD,CAAC;QAExD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1C,IACE,MAAM;YACN,MAAM,CAAC,YAAY;YACnB,2FAA2F;YAC3F,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,iBAAiB,CAAC,GAAG,uBAAuB,EACxE;YACA,MAAM,CAAC,KAAK,CAAC,4DAA4D,OAAO,IAAI,CAAC,CAAC;YACtF,iBAAiB,GAAG,MAAM,CAAC,YAAY,CAAC;SACzC;aAAM,IACL,qBAAqB;YACrB,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,SAAS,GAAG,iBAAiB,CAAC,GAAG,uBAAuB,EACvF;YACA,uGAAuG;YACvG,uCAAuC;YACvC,MAAM,CAAC,KAAK,CAAC,mEAAmE,OAAO,IAAI,CAAC,CAAC;YAC7F,iBAAiB,GAAG,qBAAqB,CAAC,YAAY,CAAC;SACxD;aAAM;YACL,MAAM,CAAC,IAAI,CACT,8FAA8F,OAAO,oCAAoC,CAC1I,CAAC;YACF,OAAO,IAAI,CAAC;SACb;QAED,MAAM,YAAY,GAAG;YACnB,YAAY,EAAE;gBACZ,KAAK,EAAE,iBAAiB,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW;gBAC9D,IAAI,EAAE,MAAM;aACb;YACD,aAAa,EAAE;gBACb,KAAK,EAAE,iBAAiB,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY;gBAChE,IAAI,EAAE,MAAM;aACb;YACD,WAAW,EAAE;gBACX,KAAK,EAAE,iBAAiB,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBAC5D,IAAI,EAAE,MAAM;aACb;SACF,CAAC;QAEF,IACE,YAAY,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;YACrC,YAAY,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;YACnC,YAAY,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC,EACpC;YACA,MAAM,CAAC,IAAI,CACT,2FAA2F,OAAO,IAAI,CACvG,CAAC;YACF,OAAO,IAAI,CAAC;SACb;QAED,OAAO,YAAY,CAAC;IACtB,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,0BAA0B,GAAG,CAAO,IAAU,EAAiB,EAAE;;QACrE,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;QAC1C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,MAAM,WAAW,GAAG,6BAA6B,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;QAElF,mHAAmH;QACnH,MAAM,SAAS,GAAG,kBAAkB,EAAE,CAAC;QACvC,IAAI,YAAY,GAAgC,IAAI,CAAC;QACrD,IAAI,WAAW,EAAE;YACf,YAAY,GAAG,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;SACjD;QAED,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE;YACzB,YAAY,EAAE,YAAY;YAC1B,SAAS;SACV,CAAC,CAAC;QAEH,MAAA,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,2CAAI,CAAC;QAElC,UAAU,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,uBAAuB,CAAC,CAAC;IACpE,CAAC,CAAA,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,CAAC,IAAU,EAAQ,EAAE;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC9B,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE9B,MAAM,CAAC,GAAG,CACR,8CAA8C,QAAQ,CAAC,EAAE,gBAAgB,QAAQ,CAAC,WAAW,0CAA0C,CACxI,CAAC;SACH;IACH,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,aAAa,GAAG,CAAO,KAAY,EAAkB,EAAE;;QAC3D,IACE,KAAK,CAAC,IAAI,KAAK,aAAa;YAC5B,CAAC,KAAK,CAAC,WAAW;YAClB,CAAC,KAAK,CAAC,QAAQ;YACf,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK;YACrB,CAAC,KAAK,CAAC,SAAS;YAChB,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAC9B;YACA,OAAO,KAAK,CAAC;SACd;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC9C,MAAM,WAAW,GAAG,6BAA6B,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/D,6BAA6B,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,CAAC,IAAI,CACT,8CAA8C,KAAK,CAAC,WAAW,cAAc,KAAK,CAAC,QAAQ,sCAAsC,CAClI,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAEzF,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,CAAC,GAAG,CACR,oDAAoD,OAAO,gBAAgB,KAAK,CAAC,WAAW,0CAA0C,CACvI,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,CAAC,GAAG,CACR,yCAAyC,OAAO,gBAAgB,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,SAAS,CAClG,YAAY,EACZ,SAAS,EACT,CAAC,CACF,EAAE,CACJ,CAAC;QAEF,KAAK,CAAC,YAAY,mCACb,CAAC,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC,GAC1B,YAAY,CAChB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,KAAK;QACL,YAAY;KACb,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { spanToJSON } from '@sentry/core';\nimport type { Client, Event, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types';\nimport { logger, timestampInSeconds } from '@sentry/utils';\n\nimport type { NativeFramesResponse } from '../../NativeRNSentry';\nimport type { ReactNativeClientOptions } from '../../options';\nimport { isRootSpan } from '../../utils/span';\nimport { NATIVE } from '../../wrapper';\n\n/**\n * Timeout from the final native frames fetch to processing the associated transaction.\n * If the transaction is not processed by this time, the native frames will be dropped\n * and not added to the event.\n */\nconst FINAL_FRAMES_TIMEOUT_MS = 2000;\n\nexport interface FramesMeasurements extends Measurements {\n  frames_total: { value: number; unit: MeasurementUnit };\n  frames_slow: { value: number; unit: MeasurementUnit };\n  frames_frozen: { value: number; unit: MeasurementUnit };\n}\n\n/** The listeners for each native frames response, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */\nconst _framesListeners: Map<string, () => void> = new Map();\n\n/** The native frames at the transaction finish time, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */\nconst _finishFrames: Map<string, { timestamp: number; nativeFrames: NativeFramesResponse | null }> = new Map();\n\n/**\n * A margin of error of 50ms is allowed for the async native bridge call.\n * Anything larger would reduce the accuracy of our frames measurements.\n */\nconst MARGIN_OF_ERROR_SECONDS = 0.05;\n\n/**\n * Instrumentation to add native slow/frozen frames measurements onto transactions.\n */\nexport const nativeFramesIntegration = (): Integration => {\n  const name: string = 'NativeFrames';\n\n  /** The native frames at the finish time of the most recent span. */\n  let _lastSpanFinishFrames:\n    | {\n        timestamp: number;\n        nativeFrames: NativeFramesResponse;\n      }\n    | undefined = undefined;\n  const _spanToNativeFramesAtStartMap: Map<string, NativeFramesResponse> = new Map();\n\n  /**\n   * Hooks into the client start and end span events.\n   */\n  const setup = (client: Client): void => {\n    const { enableNativeFramesTracking } = client.getOptions() as ReactNativeClientOptions;\n\n    if (enableNativeFramesTracking && !NATIVE.enableNative) {\n      // Do not enable native frames tracking if native is not available.\n      logger.warn(\n        '[ReactNativeTracing] NativeFramesTracking is not available on the Web, Expo Go and other platforms without native modules.',\n      );\n      return;\n    }\n\n    if (!enableNativeFramesTracking && NATIVE.enableNative) {\n      // Disable native frames tracking when native available and option is false.\n      NATIVE.disableNativeFramesTracking();\n      return;\n    }\n\n    if (!enableNativeFramesTracking) {\n      return;\n    }\n\n    NATIVE.enableNativeFramesTracking();\n\n    client.on('spanStart', _onSpanStart);\n    client.on('spanEnd', _onSpanFinish);\n    logger.log('[ReactNativeTracing] Native frames instrumentation initialized.');\n  };\n\n  /**\n   * Adds frames measurements to an event. Called from a valid event processor.\n   * Awaits for finish frames if needed.\n   */\n  const processEvent = (event: Event): Promise<Event> => {\n    return _processEvent(event);\n  };\n\n  /**\n   * Fetches the native frames in background if the given span is a root span.\n   *\n   * @param {Span} rootSpan - The span that has started.\n   */\n  const _onSpanStart = (rootSpan: Span): void => {\n    if (!isRootSpan(rootSpan)) {\n      return;\n    }\n\n    logger.debug(`[NativeFrames] Fetching frames for root span start (${rootSpan.spanContext().spanId}).`);\n\n    NATIVE.fetchNativeFrames()\n      .then(frames => {\n        if (!frames) {\n          logger.warn(\n            `[NativeFrames] Fetched frames for root span start (${\n              rootSpan.spanContext().spanId\n            }), but no frames were returned.`,\n          );\n          return;\n        }\n\n        _spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames);\n      })\n      .then(undefined, error => {\n        logger.error(\n          `[NativeFrames] Error while fetching frames for root span start (${rootSpan.spanContext().spanId})`,\n          error,\n        );\n      });\n  };\n\n  /**\n   * Called on a span finish to fetch native frames to support transactions with trimEnd.\n   * Only to be called when a span does not have an end timestamp.\n   */\n  const _onSpanFinish = (span: Span): void => {\n    if (isRootSpan(span)) {\n      return _onTransactionFinish(span);\n    }\n\n    const timestamp = timestampInSeconds();\n\n    void NATIVE.fetchNativeFrames()\n      .then(frames => {\n        if (!frames) {\n          return;\n        }\n\n        _lastSpanFinishFrames = {\n          timestamp,\n          nativeFrames: frames,\n        };\n      })\n      .then(undefined, error => {\n        logger.error(`[NativeFrames] Error while fetching frames for child span end.`, error);\n      });\n  };\n\n  /**\n   * To be called when a transaction is finished\n   */\n  const _onTransactionFinish = (span: Span): void => {\n    _fetchFramesForTransaction(span).then(undefined, (reason: unknown) => {\n      logger.error(\n        `[NativeFrames] Error while fetching frames for root span start (${span.spanContext().spanId})`,\n        reason,\n      );\n    });\n  };\n\n  /**\n   * Returns the computed frames measurements and awaits for them if they are not ready yet.\n   */\n  const _getFramesMeasurements = (\n    traceId: string,\n    finalEndTimestamp: number,\n    startFrames: NativeFramesResponse,\n  ): Promise<FramesMeasurements | null> => {\n    if (_finishFrames.has(traceId)) {\n      logger.debug(`[NativeFrames] Native end frames already fetched for trace id (${traceId}).`);\n      return Promise.resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames));\n    }\n\n    return new Promise(resolve => {\n      const timeout = setTimeout(() => {\n        logger.debug(`[NativeFrames] Native end frames listener removed by timeout for trace id (${traceId}).`);\n        _framesListeners.delete(traceId);\n\n        resolve(null);\n      }, 2000);\n\n      _framesListeners.set(traceId, () => {\n        logger.debug(`[NativeFrames] Native end frames listener called for trace id (${traceId}).`);\n        resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames));\n\n        clearTimeout(timeout);\n        _framesListeners.delete(traceId);\n      });\n    });\n  };\n\n  /**\n   * Returns the computed frames measurements given ready data\n   */\n  const _prepareMeasurements = (\n    traceId: string,\n    finalEndTimestamp: number, // The actual transaction finish time.\n    startFrames: NativeFramesResponse,\n  ): FramesMeasurements | null => {\n    let finalFinishFrames: NativeFramesResponse | undefined;\n\n    const finish = _finishFrames.get(traceId);\n    if (\n      finish &&\n      finish.nativeFrames &&\n      // Must be in the margin of error of the actual transaction finish time (finalEndTimestamp)\n      Math.abs(finish.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS\n    ) {\n      logger.debug(`[NativeFrames] Using frames from root span end (traceId, ${traceId}).`);\n      finalFinishFrames = finish.nativeFrames;\n    } else if (\n      _lastSpanFinishFrames &&\n      Math.abs(_lastSpanFinishFrames.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS\n    ) {\n      // Fallback to the last span finish if it is within the margin of error of the actual finish timestamp.\n      // This should be the case for trimEnd.\n      logger.debug(`[NativeFrames] Using native frames from last span end (traceId, ${traceId}).`);\n      finalFinishFrames = _lastSpanFinishFrames.nativeFrames;\n    } else {\n      logger.warn(\n        `[NativeFrames] Frames were collected within larger than margin of error delay for traceId (${traceId}). Dropping the inaccurate values.`,\n      );\n      return null;\n    }\n\n    const measurements = {\n      frames_total: {\n        value: finalFinishFrames.totalFrames - startFrames.totalFrames,\n        unit: 'none',\n      },\n      frames_frozen: {\n        value: finalFinishFrames.frozenFrames - startFrames.frozenFrames,\n        unit: 'none',\n      },\n      frames_slow: {\n        value: finalFinishFrames.slowFrames - startFrames.slowFrames,\n        unit: 'none',\n      },\n    };\n\n    if (\n      measurements.frames_frozen.value <= 0 &&\n      measurements.frames_slow.value <= 0 &&\n      measurements.frames_total.value <= 0\n    ) {\n      logger.warn(\n        `[NativeFrames] Detected zero slow or frozen frames. Not adding measurements to traceId (${traceId}).`,\n      );\n      return null;\n    }\n\n    return measurements;\n  };\n\n  /**\n   * Fetch finish frames for a transaction at the current time. Calls any awaiting listeners.\n   */\n  const _fetchFramesForTransaction = async (span: Span): Promise<void> => {\n    const traceId = spanToJSON(span).trace_id;\n    if (!traceId) {\n      return;\n    }\n\n    const startFrames = _spanToNativeFramesAtStartMap.get(span.spanContext().traceId);\n\n    // This timestamp marks when the finish frames were retrieved. It should be pretty close to the transaction finish.\n    const timestamp = timestampInSeconds();\n    let finishFrames: NativeFramesResponse | null = null;\n    if (startFrames) {\n      finishFrames = await NATIVE.fetchNativeFrames();\n    }\n\n    _finishFrames.set(traceId, {\n      nativeFrames: finishFrames,\n      timestamp,\n    });\n\n    _framesListeners.get(traceId)?.();\n\n    setTimeout(() => _cancelEndFrames(span), FINAL_FRAMES_TIMEOUT_MS);\n  };\n\n  /**\n   * On a finish frames failure, we cancel the await.\n   */\n  const _cancelEndFrames = (span: Span): void => {\n    const spanJSON = spanToJSON(span);\n    const traceId = spanJSON.trace_id;\n    if (!traceId) {\n      return;\n    }\n\n    if (_finishFrames.has(traceId)) {\n      _finishFrames.delete(traceId);\n\n      logger.log(\n        `[NativeFrames] Native frames timed out for ${spanJSON.op} transaction ${spanJSON.description}. Not adding native frames measurements.`,\n      );\n    }\n  };\n\n  /**\n   * Adds frames measurements to an event. Called from a valid event processor.\n   * Awaits for finish frames if needed.\n   */\n  const _processEvent = async (event: Event): Promise<Event> => {\n    if (\n      event.type !== 'transaction' ||\n      !event.transaction ||\n      !event.contexts ||\n      !event.contexts.trace ||\n      !event.timestamp ||\n      !event.contexts.trace.trace_id\n    ) {\n      return event;\n    }\n\n    const traceOp = event.contexts.trace.op;\n    const traceId = event.contexts.trace.trace_id;\n    const startFrames = _spanToNativeFramesAtStartMap.get(traceId);\n    _spanToNativeFramesAtStartMap.delete(traceId);\n    if (!startFrames) {\n      logger.warn(\n        `[NativeFrames] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but it already ended.`,\n      );\n      return event;\n    }\n\n    const measurements = await _getFramesMeasurements(traceId, event.timestamp, startFrames);\n\n    if (!measurements) {\n      logger.log(\n        `[NativeFrames] Could not fetch native frames for ${traceOp} transaction ${event.transaction}. Not adding native frames measurements.`,\n      );\n      return event;\n    }\n\n    logger.log(\n      `[Measurements] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify(\n        measurements,\n        undefined,\n        2,\n      )}`,\n    );\n\n    event.measurements = {\n      ...(event.measurements ?? {}),\n      ...measurements,\n    };\n\n    _finishFrames.delete(traceId);\n\n    return event;\n  };\n\n  return {\n    name,\n    setup,\n    processEvent,\n  };\n};\n"]}

package/dist/js/tracing/integrations/stalltracking.d.ts

@@ -0,0 +1,31 @@
+import type { Integration, Measurements, MeasurementUnit } from '@sentry/types';
+import { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../../measurements';
+export interface StallMeasurements extends Measurements {
+    [STALL_COUNT]: {
+        value: number;
+        unit: MeasurementUnit;
+    };
+    [STALL_TOTAL_TIME]: {
+        value: number;
+        unit: MeasurementUnit;
+    };
+    [STALL_LONGEST_TIME]: {
+        value: number;
+        unit: MeasurementUnit;
+    };
+}
+/**
+ * Stall measurement tracker inspired by the `JSEventLoopWatchdog` used internally in React Native:
+ * https://github.com/facebook/react-native/blob/006f5afe120c290a37cf6ff896748fbc062bf7ed/Libraries/Interaction/JSEventLoopWatchdog.js
+ *
+ * However, we modified the interval implementation to instead have a fixed loop timeout interval of `LOOP_TIMEOUT_INTERVAL_MS`.
+ * We then would consider that iteration a stall when the total time for that interval to run is greater than `LOOP_TIMEOUT_INTERVAL_MS + minimumStallThreshold`
+ */
+export declare const stallTrackingIntegration: ({ minimumStallThresholdMs, }?: {
+    /**
+     * How long in milliseconds an event loop iteration can be delayed for before being considered a "stall."
+     * @default 50
+     */
+    minimumStallThresholdMs?: number;
+}) => Integration;
+//# sourceMappingURL=stalltracking.d.ts.map

package/dist/js/tracing/integrations/stalltracking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stalltracking.d.ts","sourceRoot":"","sources":["../../../../src/js/tracing/integrations/stalltracking.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAU,WAAW,EAAE,YAAY,EAAE,eAAe,EAAQ,MAAM,eAAe,CAAC;AAK9F,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAMvF,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,CAAC,WAAW,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,eAAe,CAAA;KAAE,CAAC;IACxD,CAAC,gBAAgB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,eAAe,CAAA;KAAE,CAAC;IAC7D,CAAC,kBAAkB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,eAAe,CAAA;KAAE,CAAC;CAChE;AASD;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;IAGnC;;;OAGG;8BACuB,MAAM;MACzB,WA0TR,CAAC"}

package/dist/js/tracing/integrations/stalltracking.js

@@ -0,0 +1,236 @@
+/* eslint-disable max-lines */
+import { getRootSpan, spanToJSON } from '@sentry/core';
+import { logger, timestampInSeconds } from '@sentry/utils';
+import { AppState } from 'react-native';
+import { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../../measurements';
+import { isRootSpan } from '../../utils/span';
+import { getLatestChildSpanEndTimestamp, isNearToNow, setSpanMeasurement } from '../utils';
+const INTEGRATION_NAME = 'StallTracking';
+/** Margin of error of 20ms */
+const MARGIN_OF_ERROR_SECONDS = 0.02;
+/** How long between each iteration in the event loop tracker timeout */
+const LOOP_TIMEOUT_INTERVAL_MS = 50;
+/** Limit for how many transactions the stall tracker will track at a time to prevent leaks due to transactions not being finished */
+const MAX_RUNNING_TRANSACTIONS = 10;
+/**
+ * Stall measurement tracker inspired by the `JSEventLoopWatchdog` used internally in React Native:
+ * https://github.com/facebook/react-native/blob/006f5afe120c290a37cf6ff896748fbc062bf7ed/Libraries/Interaction/JSEventLoopWatchdog.js
+ *
+ * However, we modified the interval implementation to instead have a fixed loop timeout interval of `LOOP_TIMEOUT_INTERVAL_MS`.
+ * We then would consider that iteration a stall when the total time for that interval to run is greater than `LOOP_TIMEOUT_INTERVAL_MS + minimumStallThreshold`
+ */
+export const stallTrackingIntegration = ({ minimumStallThresholdMs = 50, } = {}) => {
+    const statsByRootSpan = new Map();
+    const state = {
+        isTracking: false,
+        timeout: null,
+        isBackground: false,
+        lastIntervalMs: 0,
+        totalStallTime: 0,
+        stallCount: 0,
+        backgroundEventListener: (appState) => {
+            if (appState === 'active') {
+                state.isBackground = false;
+                if (state.timeout != null) {
+                    state.lastIntervalMs = timestampInSeconds() * 1000;
+                    state.iteration();
+                }
+            }
+            else {
+                state.isBackground = true;
+                state.timeout !== null && clearTimeout(state.timeout);
+            }
+        },
+        iteration: () => {
+            var _a;
+            const now = timestampInSeconds() * 1000;
+            const totalTimeTaken = now - state.lastIntervalMs;
+            if (totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + minimumStallThresholdMs) {
+                const stallTime = totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS;
+                state.stallCount += 1;
+                state.totalStallTime += stallTime;
+                for (const [transaction, value] of statsByRootSpan.entries()) {
+                    const longestStallTime = Math.max((_a = value.longestStallTime) !== null && _a !== void 0 ? _a : 0, stallTime);
+                    statsByRootSpan.set(transaction, Object.assign(Object.assign({}, value), { longestStallTime }));
+                }
+            }
+            state.lastIntervalMs = now;
+            if (state.isTracking && !state.isBackground) {
+                state.timeout = setTimeout(state.iteration, LOOP_TIMEOUT_INTERVAL_MS);
+            }
+        },
+    };
+    const setup = (client) => {
+        client.on('spanStart', _onSpanStart);
+        client.on('spanEnd', _onSpanEnd);
+    };
+    const _onSpanStart = (rootSpan) => {
+        if (!isRootSpan(rootSpan)) {
+            return;
+        }
+        if (statsByRootSpan.has(rootSpan)) {
+            logger.error('[StallTracking] Tried to start stall tracking on a transaction already being tracked. Measurements might be lost.');
+            return;
+        }
+        _startTracking();
+        statsByRootSpan.set(rootSpan, {
+            longestStallTime: 0,
+            atTimestamp: null,
+            atStart: _getCurrentStats(rootSpan),
+        });
+        _flushLeakedTransactions();
+    };
+    const _onSpanEnd = (rootSpan) => {
+        if (!isRootSpan(rootSpan)) {
+            return _onChildSpanEnd(rootSpan);
+        }
+        const transactionStats = statsByRootSpan.get(rootSpan);
+        if (!transactionStats) {
+            // Transaction has been flushed out somehow, we return null.
+            logger.log('[StallTracking] Stall measurements were not added to transaction due to exceeding the max count.');
+            statsByRootSpan.delete(rootSpan);
+            _shouldStopTracking();
+            return;
+        }
+        // The endTimestamp is always set, but type-wise it's optional
+        // https://github.com/getsentry/sentry-javascript/blob/38bd57b0785c97c413f36f89ff931d927e469078/packages/core/src/tracing/sentrySpan.ts#L170
+        const endTimestamp = spanToJSON(rootSpan).timestamp;
+        let statsOnFinish;
+        if (isNearToNow(endTimestamp)) {
+            statsOnFinish = _getCurrentStats(rootSpan);
+        }
+        else {
+            // The idleSpan in JS V8 is always trimmed to the last span's endTimestamp (timestamp).
+            // The unfinished child spans are removed from the root span after the `spanEnd` event.
+            const latestChildSpanEnd = getLatestChildSpanEndTimestamp(rootSpan);
+            if (latestChildSpanEnd !== endTimestamp) {
+                logger.log('[StallTracking] Stall measurements not added due to a custom `endTimestamp` (root end is not equal to the latest child span end).');
+            }
+            if (!transactionStats.atTimestamp) {
+                logger.log('[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now. And no previous stats from child end were found.');
+            }
+            if (latestChildSpanEnd === endTimestamp && transactionStats.atTimestamp) {
+                statsOnFinish = transactionStats.atTimestamp.stats;
+            }
+        }
+        statsByRootSpan.delete(rootSpan);
+        _shouldStopTracking();
+        if (!statsOnFinish) {
+            if (typeof endTimestamp !== 'undefined') {
+                logger.log('[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now.', 'endTimestamp', endTimestamp, 'now', timestampInSeconds());
+            }
+            return;
+        }
+        setSpanMeasurement(rootSpan, STALL_COUNT, statsOnFinish.stall_count.value - transactionStats.atStart.stall_count.value, transactionStats.atStart.stall_count.unit);
+        setSpanMeasurement(rootSpan, STALL_TOTAL_TIME, statsOnFinish.stall_total_time.value - transactionStats.atStart.stall_total_time.value, transactionStats.atStart.stall_total_time.unit);
+        setSpanMeasurement(rootSpan, STALL_LONGEST_TIME, statsOnFinish.stall_longest_time.value, statsOnFinish.stall_longest_time.unit);
+    };
+    const _onChildSpanEnd = (childSpan) => {
+        const rootSpan = getRootSpan(childSpan);
+        const finalEndTimestamp = spanToJSON(childSpan).timestamp;
+        if (finalEndTimestamp) {
+            _markSpanFinish(rootSpan, finalEndTimestamp);
+        }
+    };
+    /**
+     * Logs the finish time of the span for use in `trimEnd: true` transactions.
+     */
+    const _markSpanFinish = (rootSpan, childSpanEndTime) => {
+        const previousStats = statsByRootSpan.get(rootSpan);
+        if (previousStats) {
+            if (Math.abs(timestampInSeconds() - childSpanEndTime) > MARGIN_OF_ERROR_SECONDS) {
+                logger.log('[StallTracking] Span end not logged due to end timestamp being outside the margin of error from now.');
+                if (previousStats.atTimestamp && previousStats.atTimestamp.timestamp < childSpanEndTime) {
+                    // We also need to delete the stat for the last span, as the transaction would be trimmed to this span not the last one.
+                    statsByRootSpan.set(rootSpan, Object.assign(Object.assign({}, previousStats), { atTimestamp: null }));
+                }
+            }
+            else {
+                statsByRootSpan.set(rootSpan, Object.assign(Object.assign({}, previousStats), { atTimestamp: {
+                        timestamp: childSpanEndTime,
+                        stats: _getCurrentStats(rootSpan),
+                    } }));
+            }
+        }
+    };
+    /**
+     * Get the current stats for a transaction at a given time.
+     */
+    const _getCurrentStats = (span) => {
+        var _a, _b;
+        return {
+            stall_count: { value: state.stallCount, unit: 'none' },
+            stall_total_time: { value: state.totalStallTime, unit: 'millisecond' },
+            stall_longest_time: {
+                value: (_b = (_a = statsByRootSpan.get(span)) === null || _a === void 0 ? void 0 : _a.longestStallTime) !== null && _b !== void 0 ? _b : 0,
+                unit: 'millisecond',
+            },
+        };
+    };
+    /**
+     * Start tracking stalls
+     */
+    const _startTracking = () => {
+        if (!state.isTracking) {
+            state.isTracking = true;
+            state.lastIntervalMs = Math.floor(timestampInSeconds() * 1000);
+            state.iteration();
+        }
+    };
+    /**
+     * Stops the stall tracking interval and calls reset().
+     */
+    const _stopTracking = () => {
+        state.isTracking = false;
+        if (state.timeout !== null) {
+            clearTimeout(state.timeout);
+            state.timeout = null;
+        }
+        _reset();
+    };
+    /**
+     * Will stop tracking if there are no more transactions.
+     */
+    const _shouldStopTracking = () => {
+        if (statsByRootSpan.size === 0) {
+            _stopTracking();
+        }
+    };
+    /**
+     * Clears all the collected stats
+     */
+    const _reset = () => {
+        state.stallCount = 0;
+        state.totalStallTime = 0;
+        state.lastIntervalMs = 0;
+        statsByRootSpan.clear();
+    };
+    /**
+     * Deletes leaked transactions (Earliest transactions when we have more than MAX_RUNNING_TRANSACTIONS transactions.)
+     */
+    const _flushLeakedTransactions = () => {
+        if (statsByRootSpan.size > MAX_RUNNING_TRANSACTIONS) {
+            let counter = 0;
+            const len = statsByRootSpan.size - MAX_RUNNING_TRANSACTIONS;
+            const transactions = statsByRootSpan.keys();
+            for (const t of transactions) {
+                if (counter >= len)
+                    break;
+                counter += 1;
+                statsByRootSpan.delete(t);
+            }
+        }
+    };
+    // Avoids throwing any error if using React Native on a environment that doesn't implement AppState.
+    if (AppState === null || AppState === void 0 ? void 0 : AppState.isAvailable) {
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        AppState.addEventListener('change', state.backgroundEventListener);
+    }
+    return {
+        name: INTEGRATION_NAME,
+        setup,
+        /** For testing only @private */
+        _internalState: state,
+    };
+};
+//# sourceMappingURL=stalltracking.js.map

package/dist/js/tracing/integrations/stalltracking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stalltracking.js","sourceRoot":"","sources":["../../../../src/js/tracing/integrations/stalltracking.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,8BAA8B,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE3F,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAQzC,8BAA8B;AAC9B,MAAM,uBAAuB,GAAG,IAAI,CAAC;AACrC,wEAAwE;AACxE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,qIAAqI;AACrI,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,EACvC,uBAAuB,GAAG,EAAE,MAO1B,EAAE,EAAe,EAAE;IACrB,MAAM,eAAe,GAUjB,IAAI,GAAG,EAAE,CAAC;IAEd,MAAM,KAAK,GAiBP;QACF,UAAU,EAAE,KAAK;QACjB,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,KAAK;QACnB,cAAc,EAAE,CAAC;QACjB,cAAc,EAAE,CAAC;QACjB,UAAU,EAAE,CAAC;QACb,uBAAuB,EAAE,CAAC,QAAwB,EAAQ,EAAE;YAC1D,IAAI,QAAQ,KAAM,QAA2B,EAAE;gBAC7C,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC3B,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE;oBACzB,KAAK,CAAC,cAAc,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;oBACnD,KAAK,CAAC,SAAS,EAAE,CAAC;iBACnB;aACF;iBAAM;gBACL,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;gBAC1B,KAAK,CAAC,OAAO,KAAK,IAAI,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACvD;QACH,CAAC;QACD,SAAS,EAAE,GAAS,EAAE;;YACpB,MAAM,GAAG,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;YACxC,MAAM,cAAc,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,CAAC;YAElD,IAAI,cAAc,IAAI,wBAAwB,GAAG,uBAAuB,EAAE;gBACxE,MAAM,SAAS,GAAG,cAAc,GAAG,wBAAwB,CAAC;gBAC5D,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC;gBACtB,KAAK,CAAC,cAAc,IAAI,SAAS,CAAC;gBAElC,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,eAAe,CAAC,OAAO,EAAE,EAAE;oBAC5D,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAA,KAAK,CAAC,gBAAgB,mCAAI,CAAC,EAAE,SAAS,CAAC,CAAC;oBAE1E,eAAe,CAAC,GAAG,CAAC,WAAW,kCAC1B,KAAK,KACR,gBAAgB,IAChB,CAAC;iBACJ;aACF;YAED,KAAK,CAAC,cAAc,GAAG,GAAG,CAAC;YAE3B,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE;gBAC3C,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;aACvE;QACH,CAAC;KACF,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,MAAc,EAAQ,EAAE;QACrC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,QAAc,EAAQ,EAAE;QAC5C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,OAAO;SACR;QAED,IAAI,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACjC,MAAM,CAAC,KAAK,CACV,mHAAmH,CACpH,CAAC;YACF,OAAO;SACR;QAED,cAAc,EAAE,CAAC;QACjB,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE;YAC5B,gBAAgB,EAAE,CAAC;YACnB,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC;SACpC,CAAC,CAAC;QACH,wBAAwB,EAAE,CAAC;IAC7B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,QAAc,EAAQ,EAAE;QAC1C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;SAClC;QAED,MAAM,gBAAgB,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,CAAC,gBAAgB,EAAE;YACrB,4DAA4D;YAC5D,MAAM,CAAC,GAAG,CAAC,kGAAkG,CAAC,CAAC;YAE/G,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjC,mBAAmB,EAAE,CAAC;YAEtB,OAAO;SACR;QAED,8DAA8D;QAC9D,4IAA4I;QAC5I,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;QAEpD,IAAI,aAA4C,CAAC;QACjD,IAAI,WAAW,CAAC,YAAY,CAAC,EAAE;YAC7B,aAAa,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;SAC5C;aAAM;YACL,uFAAuF;YACvF,uFAAuF;YAEvF,MAAM,kBAAkB,GAAG,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YACpE,IAAI,kBAAkB,KAAK,YAAY,EAAE;gBACvC,MAAM,CAAC,GAAG,CACR,mIAAmI,CACpI,CAAC;aACH;YAED,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE;gBACjC,MAAM,CAAC,GAAG,CACR,6IAA6I,CAC9I,CAAC;aACH;YAED,IAAI,kBAAkB,KAAK,YAAY,IAAI,gBAAgB,CAAC,WAAW,EAAE;gBACvE,aAAa,GAAG,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC;aACpD;SACF;QAED,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,mBAAmB,EAAE,CAAC;QAEtB,IAAI,CAAC,aAAa,EAAE;YAClB,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE;gBACvC,MAAM,CAAC,GAAG,CACR,4FAA4F,EAC5F,cAAc,EACd,YAAY,EACZ,KAAK,EACL,kBAAkB,EAAE,CACrB,CAAC;aACH;YAED,OAAO;SACR;QAED,kBAAkB,CAChB,QAAQ,EACR,WAAW,EACX,aAAa,CAAC,WAAW,CAAC,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAC5E,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAC1C,CAAC;QAEF,kBAAkB,CAChB,QAAQ,EACR,gBAAgB,EAChB,aAAa,CAAC,gBAAgB,CAAC,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,EACtF,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAC/C,CAAC;QAEF,kBAAkB,CAChB,QAAQ,EACR,kBAAkB,EAClB,aAAa,CAAC,kBAAkB,CAAC,KAAK,EACtC,aAAa,CAAC,kBAAkB,CAAC,IAAI,CACtC,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,SAAe,EAAQ,EAAE;QAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;QAExC,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC;QAC1D,IAAI,iBAAiB,EAAE;YACrB,eAAe,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;SAC9C;IACH,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,eAAe,GAAG,CAAC,QAAc,EAAE,gBAAwB,EAAQ,EAAE;QACzE,MAAM,aAAa,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,aAAa,EAAE;YACjB,IAAI,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,gBAAgB,CAAC,GAAG,uBAAuB,EAAE;gBAC/E,MAAM,CAAC,GAAG,CACR,sGAAsG,CACvG,CAAC;gBAEF,IAAI,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,SAAS,GAAG,gBAAgB,EAAE;oBACvF,wHAAwH;oBACxH,eAAe,CAAC,GAAG,CAAC,QAAQ,kCACvB,aAAa,KAChB,WAAW,EAAE,IAAI,IACjB,CAAC;iBACJ;aACF;iBAAM;gBACL,eAAe,CAAC,GAAG,CAAC,QAAQ,kCACvB,aAAa,KAChB,WAAW,EAAE;wBACX,SAAS,EAAE,gBAAgB;wBAC3B,KAAK,EAAE,gBAAgB,CAAC,QAAQ,CAAC;qBAClC,IACD,CAAC;aACJ;SACF;IACH,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,CAAC,IAAU,EAAqB,EAAE;;QACzD,OAAO;YACL,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE;YACtD,gBAAgB,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,aAAa,EAAE;YACtE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,MAAA,MAAA,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,0CAAE,gBAAgB,mCAAI,CAAC;gBACvD,IAAI,EAAE,aAAa;aACpB;SACF,CAAC;IACJ,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,cAAc,GAAG,GAAS,EAAE;QAChC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YACrB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YACxB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,CAAC;YAE/D,KAAK,CAAC,SAAS,EAAE,CAAC;SACnB;IACH,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,aAAa,GAAG,GAAS,EAAE;QAC/B,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;QAEzB,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE;YAC1B,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC5B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;SACtB;QAED,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,mBAAmB,GAAG,GAAS,EAAE;QACrC,IAAI,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE;YAC9B,aAAa,EAAE,CAAC;SACjB;IACH,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,MAAM,GAAG,GAAS,EAAE;QACxB,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;QACrB,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC;QACzB,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC;QACzB,eAAe,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,wBAAwB,GAAG,GAAS,EAAE;QAC1C,IAAI,eAAe,CAAC,IAAI,GAAG,wBAAwB,EAAE;YACnD,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,GAAG,wBAAwB,CAAC;YAC5D,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE;gBAC5B,IAAI,OAAO,IAAI,GAAG;oBAAE,MAAM;gBAC1B,OAAO,IAAI,CAAC,CAAC;gBACb,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aAC3B;SACF;IACH,CAAC,CAAC;IAEF,oGAAoG;IACpG,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,WAAW,EAAE;QACzB,6DAA6D;QAC7D,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;KACpE;IAED,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,KAAK;QAEL,gCAAgC;QAChC,cAAc,EAAE,KAAK;KACP,CAAC;AACnB,CAAC,CAAC","sourcesContent":["/* eslint-disable max-lines */\nimport { getRootSpan, spanToJSON } from '@sentry/core';\nimport type { Client, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types';\nimport { logger, timestampInSeconds } from '@sentry/utils';\nimport type { AppStateStatus } from 'react-native';\nimport { AppState } from 'react-native';\n\nimport { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../../measurements';\nimport { isRootSpan } from '../../utils/span';\nimport { getLatestChildSpanEndTimestamp, isNearToNow, setSpanMeasurement } from '../utils';\n\nconst INTEGRATION_NAME = 'StallTracking';\n\nexport interface StallMeasurements extends Measurements {\n  [STALL_COUNT]: { value: number; unit: MeasurementUnit };\n  [STALL_TOTAL_TIME]: { value: number; unit: MeasurementUnit };\n  [STALL_LONGEST_TIME]: { value: number; unit: MeasurementUnit };\n}\n\n/** Margin of error of 20ms */\nconst MARGIN_OF_ERROR_SECONDS = 0.02;\n/** How long between each iteration in the event loop tracker timeout */\nconst LOOP_TIMEOUT_INTERVAL_MS = 50;\n/** Limit for how many transactions the stall tracker will track at a time to prevent leaks due to transactions not being finished */\nconst MAX_RUNNING_TRANSACTIONS = 10;\n\n/**\n * Stall measurement tracker inspired by the `JSEventLoopWatchdog` used internally in React Native:\n * https://github.com/facebook/react-native/blob/006f5afe120c290a37cf6ff896748fbc062bf7ed/Libraries/Interaction/JSEventLoopWatchdog.js\n *\n * However, we modified the interval implementation to instead have a fixed loop timeout interval of `LOOP_TIMEOUT_INTERVAL_MS`.\n * We then would consider that iteration a stall when the total time for that interval to run is greater than `LOOP_TIMEOUT_INTERVAL_MS + minimumStallThreshold`\n */\nexport const stallTrackingIntegration = ({\n  minimumStallThresholdMs = 50,\n}: {\n  /**\n   * How long in milliseconds an event loop iteration can be delayed for before being considered a \"stall.\"\n   * @default 50\n   */\n  minimumStallThresholdMs?: number;\n} = {}): Integration => {\n  const statsByRootSpan: Map<\n    Span,\n    {\n      longestStallTime: number;\n      atStart: StallMeasurements;\n      atTimestamp: {\n        timestamp: number;\n        stats: StallMeasurements;\n      } | null;\n    }\n  > = new Map();\n\n  const state: {\n    isTracking: boolean;\n    timeout: ReturnType<typeof setTimeout> | null;\n    isBackground: boolean;\n    /** Switch that enables the iteration once app moves from background to foreground. */\n    backgroundEventListener: (appState: AppStateStatus) => void;\n    /** The last timestamp the iteration ran in milliseconds */\n    lastIntervalMs: number;\n    /** Total amount of time of all stalls that occurred during the current tracking session */\n    totalStallTime: number;\n    /** Total number of stalls that occurred during the current tracking session */\n    stallCount: number;\n    /**\n     * Iteration of the stall tracking interval. Measures how long the timer strayed from its expected time of running, and how\n     * long the stall is for.\n     */\n    iteration: () => void;\n  } = {\n    isTracking: false,\n    timeout: null,\n    isBackground: false,\n    lastIntervalMs: 0,\n    totalStallTime: 0,\n    stallCount: 0,\n    backgroundEventListener: (appState: AppStateStatus): void => {\n      if (appState === ('active' as AppStateStatus)) {\n        state.isBackground = false;\n        if (state.timeout != null) {\n          state.lastIntervalMs = timestampInSeconds() * 1000;\n          state.iteration();\n        }\n      } else {\n        state.isBackground = true;\n        state.timeout !== null && clearTimeout(state.timeout);\n      }\n    },\n    iteration: (): void => {\n      const now = timestampInSeconds() * 1000;\n      const totalTimeTaken = now - state.lastIntervalMs;\n\n      if (totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + minimumStallThresholdMs) {\n        const stallTime = totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS;\n        state.stallCount += 1;\n        state.totalStallTime += stallTime;\n\n        for (const [transaction, value] of statsByRootSpan.entries()) {\n          const longestStallTime = Math.max(value.longestStallTime ?? 0, stallTime);\n\n          statsByRootSpan.set(transaction, {\n            ...value,\n            longestStallTime,\n          });\n        }\n      }\n\n      state.lastIntervalMs = now;\n\n      if (state.isTracking && !state.isBackground) {\n        state.timeout = setTimeout(state.iteration, LOOP_TIMEOUT_INTERVAL_MS);\n      }\n    },\n  };\n\n  const setup = (client: Client): void => {\n    client.on('spanStart', _onSpanStart);\n    client.on('spanEnd', _onSpanEnd);\n  };\n\n  const _onSpanStart = (rootSpan: Span): void => {\n    if (!isRootSpan(rootSpan)) {\n      return;\n    }\n\n    if (statsByRootSpan.has(rootSpan)) {\n      logger.error(\n        '[StallTracking] Tried to start stall tracking on a transaction already being tracked. Measurements might be lost.',\n      );\n      return;\n    }\n\n    _startTracking();\n    statsByRootSpan.set(rootSpan, {\n      longestStallTime: 0,\n      atTimestamp: null,\n      atStart: _getCurrentStats(rootSpan),\n    });\n    _flushLeakedTransactions();\n  };\n\n  const _onSpanEnd = (rootSpan: Span): void => {\n    if (!isRootSpan(rootSpan)) {\n      return _onChildSpanEnd(rootSpan);\n    }\n\n    const transactionStats = statsByRootSpan.get(rootSpan);\n\n    if (!transactionStats) {\n      // Transaction has been flushed out somehow, we return null.\n      logger.log('[StallTracking] Stall measurements were not added to transaction due to exceeding the max count.');\n\n      statsByRootSpan.delete(rootSpan);\n      _shouldStopTracking();\n\n      return;\n    }\n\n    // The endTimestamp is always set, but type-wise it's optional\n    // https://github.com/getsentry/sentry-javascript/blob/38bd57b0785c97c413f36f89ff931d927e469078/packages/core/src/tracing/sentrySpan.ts#L170\n    const endTimestamp = spanToJSON(rootSpan).timestamp;\n\n    let statsOnFinish: StallMeasurements | undefined;\n    if (isNearToNow(endTimestamp)) {\n      statsOnFinish = _getCurrentStats(rootSpan);\n    } else {\n      // The idleSpan in JS V8 is always trimmed to the last span's endTimestamp (timestamp).\n      // The unfinished child spans are removed from the root span after the `spanEnd` event.\n\n      const latestChildSpanEnd = getLatestChildSpanEndTimestamp(rootSpan);\n      if (latestChildSpanEnd !== endTimestamp) {\n        logger.log(\n          '[StallTracking] Stall measurements not added due to a custom `endTimestamp` (root end is not equal to the latest child span end).',\n        );\n      }\n\n      if (!transactionStats.atTimestamp) {\n        logger.log(\n          '[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now. And no previous stats from child end were found.',\n        );\n      }\n\n      if (latestChildSpanEnd === endTimestamp && transactionStats.atTimestamp) {\n        statsOnFinish = transactionStats.atTimestamp.stats;\n      }\n    }\n\n    statsByRootSpan.delete(rootSpan);\n    _shouldStopTracking();\n\n    if (!statsOnFinish) {\n      if (typeof endTimestamp !== 'undefined') {\n        logger.log(\n          '[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now.',\n          'endTimestamp',\n          endTimestamp,\n          'now',\n          timestampInSeconds(),\n        );\n      }\n\n      return;\n    }\n\n    setSpanMeasurement(\n      rootSpan,\n      STALL_COUNT,\n      statsOnFinish.stall_count.value - transactionStats.atStart.stall_count.value,\n      transactionStats.atStart.stall_count.unit,\n    );\n\n    setSpanMeasurement(\n      rootSpan,\n      STALL_TOTAL_TIME,\n      statsOnFinish.stall_total_time.value - transactionStats.atStart.stall_total_time.value,\n      transactionStats.atStart.stall_total_time.unit,\n    );\n\n    setSpanMeasurement(\n      rootSpan,\n      STALL_LONGEST_TIME,\n      statsOnFinish.stall_longest_time.value,\n      statsOnFinish.stall_longest_time.unit,\n    );\n  };\n\n  const _onChildSpanEnd = (childSpan: Span): void => {\n    const rootSpan = getRootSpan(childSpan);\n\n    const finalEndTimestamp = spanToJSON(childSpan).timestamp;\n    if (finalEndTimestamp) {\n      _markSpanFinish(rootSpan, finalEndTimestamp);\n    }\n  };\n\n  /**\n   * Logs the finish time of the span for use in `trimEnd: true` transactions.\n   */\n  const _markSpanFinish = (rootSpan: Span, childSpanEndTime: number): void => {\n    const previousStats = statsByRootSpan.get(rootSpan);\n    if (previousStats) {\n      if (Math.abs(timestampInSeconds() - childSpanEndTime) > MARGIN_OF_ERROR_SECONDS) {\n        logger.log(\n          '[StallTracking] Span end not logged due to end timestamp being outside the margin of error from now.',\n        );\n\n        if (previousStats.atTimestamp && previousStats.atTimestamp.timestamp < childSpanEndTime) {\n          // We also need to delete the stat for the last span, as the transaction would be trimmed to this span not the last one.\n          statsByRootSpan.set(rootSpan, {\n            ...previousStats,\n            atTimestamp: null,\n          });\n        }\n      } else {\n        statsByRootSpan.set(rootSpan, {\n          ...previousStats,\n          atTimestamp: {\n            timestamp: childSpanEndTime,\n            stats: _getCurrentStats(rootSpan),\n          },\n        });\n      }\n    }\n  };\n\n  /**\n   * Get the current stats for a transaction at a given time.\n   */\n  const _getCurrentStats = (span: Span): StallMeasurements => {\n    return {\n      stall_count: { value: state.stallCount, unit: 'none' },\n      stall_total_time: { value: state.totalStallTime, unit: 'millisecond' },\n      stall_longest_time: {\n        value: statsByRootSpan.get(span)?.longestStallTime ?? 0,\n        unit: 'millisecond',\n      },\n    };\n  };\n\n  /**\n   * Start tracking stalls\n   */\n  const _startTracking = (): void => {\n    if (!state.isTracking) {\n      state.isTracking = true;\n      state.lastIntervalMs = Math.floor(timestampInSeconds() * 1000);\n\n      state.iteration();\n    }\n  };\n\n  /**\n   * Stops the stall tracking interval and calls reset().\n   */\n  const _stopTracking = (): void => {\n    state.isTracking = false;\n\n    if (state.timeout !== null) {\n      clearTimeout(state.timeout);\n      state.timeout = null;\n    }\n\n    _reset();\n  };\n\n  /**\n   * Will stop tracking if there are no more transactions.\n   */\n  const _shouldStopTracking = (): void => {\n    if (statsByRootSpan.size === 0) {\n      _stopTracking();\n    }\n  };\n\n  /**\n   * Clears all the collected stats\n   */\n  const _reset = (): void => {\n    state.stallCount = 0;\n    state.totalStallTime = 0;\n    state.lastIntervalMs = 0;\n    statsByRootSpan.clear();\n  };\n\n  /**\n   * Deletes leaked transactions (Earliest transactions when we have more than MAX_RUNNING_TRANSACTIONS transactions.)\n   */\n  const _flushLeakedTransactions = (): void => {\n    if (statsByRootSpan.size > MAX_RUNNING_TRANSACTIONS) {\n      let counter = 0;\n      const len = statsByRootSpan.size - MAX_RUNNING_TRANSACTIONS;\n      const transactions = statsByRootSpan.keys();\n      for (const t of transactions) {\n        if (counter >= len) break;\n        counter += 1;\n        statsByRootSpan.delete(t);\n      }\n    }\n  };\n\n  // Avoids throwing any error if using React Native on a environment that doesn't implement AppState.\n  if (AppState?.isAvailable) {\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    AppState.addEventListener('change', state.backgroundEventListener);\n  }\n\n  return {\n    name: INTEGRATION_NAME,\n    setup,\n\n    /** For testing only @private */\n    _internalState: state,\n  } as Integration;\n};\n"]}

package/dist/js/tracing/integrations/userInteraction.d.ts

@@ -0,0 +1,11 @@
+import type { Integration, Span } from '@sentry/types';
+export declare const userInteractionIntegration: () => Integration;
+/**
+ * Starts a new transaction for a user interaction.
+ * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen.
+ */
+export declare const startUserInteractionSpan: (userInteractionId: {
+    elementId: string | undefined;
+    op: string;
+}) => Span | undefined;
+//# sourceMappingURL=userInteraction.d.ts.map

package/dist/js/tracing/integrations/userInteraction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userInteraction.d.ts","sourceRoot":"","sources":["../../../../src/js/tracing/integrations/userInteraction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAoB,MAAM,eAAe,CAAC;AAWzE,eAAO,MAAM,0BAA0B,QAAO,WAI7C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sBAAuB;IAC1D,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;CACZ,KAAG,IAAI,GAAG,SAmEV,CAAC"}