@sentry/react-native 5.31.1 → 6.0.0-alpha.1

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

@@ -0,0 +1,195 @@
+import { __awaiter } from "tslib";
+import { logger, timestampInSeconds } from '@sentry/utils';
+import { AsyncExpiringMap } from '../../utils/AsyncExpiringMap';
+import { isRootSpan } from '../../utils/span';
+import { NATIVE } from '../../wrapper';
+/**
+ * Timeout from the start of a span to fetching the associated native frames.
+ */
+const FETCH_FRAMES_TIMEOUT_MS = 2000;
+/**
+ * This is the time end frames data from the native layer will be
+ * kept in memory and waiting for the event processing. This ensures that spans
+ * which are never processed are not leaking memory.
+ */
+const END_FRAMES_TIMEOUT_MS = 2000;
+/**
+ * This is the time start frames data from the native layer will be
+ * kept in memory and waiting for span end. This ensures that spans
+ * which never end or are not processed are not leaking memory.
+ */
+const START_FRAMES_TIMEOUT_MS = 60000;
+/**
+ * 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;
+const INTEGRATION_NAME = 'NativeFrames';
+export const createNativeFramesIntegrations = (enable) => {
+    if (!enable && NATIVE.enableNative) {
+        // On Android this will free up resource when JS reloaded (native modules stay) and thus JS side of the SDK reinitialized.
+        NATIVE.disableNativeFramesTracking();
+        return undefined;
+    }
+    return nativeFramesIntegration();
+};
+/**
+ * Instrumentation to add native slow/frozen frames measurements onto transactions.
+ */
+export const nativeFramesIntegration = () => {
+    /** The native frames at the finish time of the most recent span. */
+    let _lastChildSpanEndFrames = null;
+    const _spanToNativeFramesAtStartMap = new AsyncExpiringMap({
+        ttl: START_FRAMES_TIMEOUT_MS,
+    });
+    const _spanToNativeFramesAtEndMap = new AsyncExpiringMap({ ttl: END_FRAMES_TIMEOUT_MS });
+    /**
+     * Hooks into the client start and end span events.
+     */
+    const setup = (client) => {
+        if (!NATIVE.enableNative) {
+            logger.warn(`[${INTEGRATION_NAME}] This is not available on the Web, Expo Go and other platforms without native modules.`);
+            return undefined;
+        }
+        NATIVE.enableNativeFramesTracking();
+        client.on('spanStart', fetchStartFramesForSpan);
+        client.on('spanEnd', fetchEndFramesForSpan);
+    };
+    const fetchStartFramesForSpan = (rootSpan) => {
+        if (!isRootSpan(rootSpan)) {
+            return;
+        }
+        const spanId = rootSpan.spanContext().spanId;
+        logger.debug(`[${INTEGRATION_NAME}] Fetching frames for root span start (${spanId}).`);
+        _spanToNativeFramesAtStartMap.set(spanId, new Promise(resolve => {
+            fetchNativeFrames()
+                .then(frames => resolve(frames))
+                .then(undefined, error => {
+                logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error);
+                resolve(null);
+            });
+        }));
+    };
+    const fetchEndFramesForSpan = (span) => {
+        const timestamp = timestampInSeconds();
+        const spanId = span.spanContext().spanId;
+        if (isRootSpan(span)) {
+            const hasStartFrames = _spanToNativeFramesAtStartMap.has(spanId);
+            if (!hasStartFrames) {
+                // We don't have start frames, won't be able to calculate the difference.
+                return;
+            }
+            logger.debug(`[${INTEGRATION_NAME}] Fetch frames for root span end (${spanId}).`);
+            _spanToNativeFramesAtEndMap.set(spanId, new Promise(resolve => {
+                fetchNativeFrames()
+                    .then(frames => {
+                    resolve({
+                        timestamp,
+                        nativeFrames: frames,
+                    });
+                })
+                    .then(undefined, error => {
+                    logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error);
+                    resolve(null);
+                });
+            }));
+            return undefined;
+        }
+        else {
+            logger.debug(`[${INTEGRATION_NAME}] Fetch frames for child span end (${spanId}).`);
+            fetchNativeFrames()
+                .then(frames => {
+                _lastChildSpanEndFrames = {
+                    timestamp,
+                    nativeFrames: frames,
+                };
+            })
+                .catch(error => logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error));
+        }
+    };
+    const processEvent = (event) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        if (event.type !== 'transaction' ||
+            !event.transaction ||
+            !event.contexts ||
+            !event.contexts.trace ||
+            !event.timestamp ||
+            !event.contexts.trace.span_id) {
+            return event;
+        }
+        const traceOp = event.contexts.trace.op;
+        const spanId = event.contexts.trace.span_id;
+        const startFrames = yield _spanToNativeFramesAtStartMap.pop(spanId);
+        if (!startFrames) {
+            logger.warn(`[${INTEGRATION_NAME}] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but the transaction already ended.`);
+            return event;
+        }
+        const endFrames = yield _spanToNativeFramesAtEndMap.pop(spanId);
+        let finalEndFrames;
+        if (endFrames && isClose(endFrames.timestamp, event.timestamp)) {
+            // Must be in the margin of error of the actual transaction finish time (finalEndTimestamp)
+            logger.debug(`[${INTEGRATION_NAME}] Using frames from root span end (spanId, ${spanId}).`);
+            finalEndFrames = endFrames.nativeFrames;
+        }
+        else if (_lastChildSpanEndFrames && isClose(_lastChildSpanEndFrames.timestamp, event.timestamp)) {
+            // 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(`[${INTEGRATION_NAME}] Using native frames from last child span end (spanId, ${spanId}).`);
+            finalEndFrames = _lastChildSpanEndFrames.nativeFrames;
+        }
+        else {
+            logger.warn(`[${INTEGRATION_NAME}] Frames were collected within larger than margin of error delay for spanId (${spanId}). Dropping the inaccurate values.`);
+            return event;
+        }
+        const measurements = {
+            frames_total: {
+                value: finalEndFrames.totalFrames - startFrames.totalFrames,
+                unit: 'none',
+            },
+            frames_frozen: {
+                value: finalEndFrames.frozenFrames - startFrames.frozenFrames,
+                unit: 'none',
+            },
+            frames_slow: {
+                value: finalEndFrames.slowFrames - startFrames.slowFrames,
+                unit: 'none',
+            },
+        };
+        if (measurements.frames_frozen.value <= 0 &&
+            measurements.frames_slow.value <= 0 &&
+            measurements.frames_total.value <= 0) {
+            logger.warn(`[${INTEGRATION_NAME}] Detected zero slow or frozen frames. Not adding measurements to spanId (${spanId}).`);
+            return event;
+        }
+        logger.log(`[${INTEGRATION_NAME}] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify(measurements, undefined, 2)}`);
+        event.measurements = Object.assign(Object.assign({}, ((_a = event.measurements) !== null && _a !== void 0 ? _a : {})), measurements);
+        return event;
+    });
+    return {
+        name: INTEGRATION_NAME,
+        setup,
+        processEvent,
+    };
+};
+function fetchNativeFrames() {
+    return new Promise((resolve, reject) => {
+        NATIVE.fetchNativeFrames()
+            .then(value => {
+            if (!value) {
+                reject('Native frames response is null.');
+                return;
+            }
+            resolve(value);
+        })
+            .then(undefined, error => {
+            reject(error);
+        });
+        setTimeout(() => {
+            reject('Fetching native frames took too long. Dropping frames.');
+        }, FETCH_FRAMES_TIMEOUT_MS);
+    });
+}
+function isClose(t1, t2) {
+    return Math.abs(t1 - t2) < MARGIN_OF_ERROR_SECONDS;
+}
+//# 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":";AACA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAG3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,MAAM,uBAAuB,GAAG,IAAK,CAAC;AAEtC;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,IAAK,CAAC;AAEpC;;;;GAIG;AACH,MAAM,uBAAuB,GAAG,KAAM,CAAC;AAEvC;;;GAGG;AACH,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAaxC,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,MAA2B,EAA2B,EAAE;IACrG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,EAAE;QAClC,0HAA0H;QAC1H,MAAM,CAAC,2BAA2B,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,uBAAuB,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAgB,EAAE;IACvD,oEAAoE;IACpE,IAAI,uBAAuB,GAA6C,IAAI,CAAC;IAC7E,MAAM,6BAA6B,GAAmD,IAAI,gBAAgB,CAAC;QACzG,GAAG,EAAE,uBAAuB;KAC7B,CAAC,CAAC;IACH,MAAM,2BAA2B,GAC/B,IAAI,gBAAgB,CAAC,EAAE,GAAG,EAAE,qBAAqB,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,KAAK,GAAG,CAAC,MAAc,EAAQ,EAAE;QACrC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YACxB,MAAM,CAAC,IAAI,CACT,IAAI,gBAAgB,yFAAyF,CAC9G,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,CAAC,0BAA0B,EAAE,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;QAChD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,uBAAuB,GAAG,CAAC,QAAc,EAAQ,EAAE;QACvD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,OAAO;SACR;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,0CAA0C,MAAM,IAAI,CAAC,CAAC;QACvF,6BAA6B,CAAC,GAAG,CAC/B,MAAM,EACN,IAAI,OAAO,CAA8B,OAAO,CAAC,EAAE;YACjD,iBAAiB,EAAE;iBAChB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;iBAC/B,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;gBACvB,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,uCAAuC,EAAE,KAAK,CAAC,CAAC;gBACjF,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAAC,IAAU,EAAQ,EAAE;QACjD,MAAM,SAAS,GAAG,kBAAkB,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC;QAEzC,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE;YACpB,MAAM,cAAc,GAAG,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjE,IAAI,CAAC,cAAc,EAAE;gBACnB,yEAAyE;gBACzE,OAAO;aACR;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,qCAAqC,MAAM,IAAI,CAAC,CAAC;YAClF,2BAA2B,CAAC,GAAG,CAC7B,MAAM,EACN,IAAI,OAAO,CAA2C,OAAO,CAAC,EAAE;gBAC9D,iBAAiB,EAAE;qBAChB,IAAI,CAAC,MAAM,CAAC,EAAE;oBACb,OAAO,CAAC;wBACN,SAAS;wBACT,YAAY,EAAE,MAAM;qBACrB,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;oBACvB,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,uCAAuC,EAAE,KAAK,CAAC,CAAC;oBACjF,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CACH,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,sCAAsC,MAAM,IAAI,CAAC,CAAC;YACnF,iBAAiB,EAAE;iBAChB,IAAI,CAAC,MAAM,CAAC,EAAE;gBACb,uBAAuB,GAAG;oBACxB,SAAS;oBACT,YAAY,EAAE,MAAM;iBACrB,CAAC;YACJ,CAAC,CAAC;iBACD,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,uCAAuC,EAAE,KAAK,CAAC,CAAC,CAAC;SACrG;IACH,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAO,KAAY,EAAkB,EAAE;;QAC1D,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,OAAO,EAC7B;YACA,OAAO,KAAK,CAAC;SACd;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5C,MAAM,WAAW,GAAG,MAAM,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpE,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,CAAC,IAAI,CACT,IAAI,gBAAgB,iCAAiC,KAAK,CAAC,WAAW,cAAc,KAAK,CAAC,QAAQ,mDAAmD,CACtJ,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,SAAS,GAAG,MAAM,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAChE,IAAI,cAAgD,CAAC;QAErD,IAAI,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE;YAC9D,2FAA2F;YAC3F,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,8CAA8C,MAAM,IAAI,CAAC,CAAC;YAC3F,cAAc,GAAG,SAAS,CAAC,YAAY,CAAC;SACzC;aAAM,IAAI,uBAAuB,IAAI,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE;YACjG,uGAAuG;YACvG,uCAAuC;YACvC,MAAM,CAAC,KAAK,CAAC,IAAI,gBAAgB,2DAA2D,MAAM,IAAI,CAAC,CAAC;YACxG,cAAc,GAAG,uBAAuB,CAAC,YAAY,CAAC;SACvD;aAAM;YACL,MAAM,CAAC,IAAI,CACT,IAAI,gBAAgB,gFAAgF,MAAM,oCAAoC,CAC/I,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,YAAY,GAAG;YACnB,YAAY,EAAE;gBACZ,KAAK,EAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW;gBAC3D,IAAI,EAAE,MAAM;aACb;YACD,aAAa,EAAE;gBACb,KAAK,EAAE,cAAc,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY;gBAC7D,IAAI,EAAE,MAAM;aACb;YACD,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBACzD,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,IAAI,gBAAgB,6EAA6E,MAAM,IAAI,CAC5G,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,CAAC,GAAG,CACR,IAAI,gBAAgB,4BAA4B,OAAO,gBAAgB,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,SAAS,CACzG,YAAY,EACZ,SAAS,EACT,CAAC,CACF,EAAE,CACJ,CAAC;QACF,KAAK,CAAC,YAAY,mCACb,CAAC,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC,GAC1B,YAAY,CAChB,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,KAAK;QACL,YAAY;KACb,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,iBAAiB;IACxB,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3D,MAAM,CAAC,iBAAiB,EAAE;aACvB,IAAI,CAAC,KAAK,CAAC,EAAE;YACZ,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,CAAC,iCAAiC,CAAC,CAAC;gBAC1C,OAAO;aACR;YACD,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC;aACD,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;YACvB,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,wDAAwD,CAAC,CAAC;QACnE,CAAC,EAAE,uBAAuB,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,EAAU,EAAE,EAAU;IACrC,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,uBAAuB,CAAC;AACrD,CAAC","sourcesContent":["import type { Client, Event, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types';\nimport { logger, timestampInSeconds } from '@sentry/utils';\n\nimport type { NativeFramesResponse } from '../../NativeRNSentry';\nimport { AsyncExpiringMap } from '../../utils/AsyncExpiringMap';\nimport { isRootSpan } from '../../utils/span';\nimport { NATIVE } from '../../wrapper';\n\n/**\n * Timeout from the start of a span to fetching the associated native frames.\n */\nconst FETCH_FRAMES_TIMEOUT_MS = 2_000;\n\n/**\n * This is the time end frames data from the native layer will be\n * kept in memory and waiting for the event processing. This ensures that spans\n * which are never processed are not leaking memory.\n */\nconst END_FRAMES_TIMEOUT_MS = 2_000;\n\n/**\n * This is the time start frames data from the native layer will be\n * kept in memory and waiting for span end. This ensures that spans\n * which never end or are not processed are not leaking memory.\n */\nconst START_FRAMES_TIMEOUT_MS = 60_000;\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\nconst INTEGRATION_NAME = 'NativeFrames';\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\ninterface NativeFramesResponseWithTimestamp {\n  timestamp: number;\n  nativeFrames: NativeFramesResponse;\n}\n\nexport const createNativeFramesIntegrations = (enable: boolean | undefined): Integration | undefined => {\n  if (!enable && NATIVE.enableNative) {\n    // On Android this will free up resource when JS reloaded (native modules stay) and thus JS side of the SDK reinitialized.\n    NATIVE.disableNativeFramesTracking();\n    return undefined;\n  }\n\n  return nativeFramesIntegration();\n};\n\n/**\n * Instrumentation to add native slow/frozen frames measurements onto transactions.\n */\nexport const nativeFramesIntegration = (): Integration => {\n  /** The native frames at the finish time of the most recent span. */\n  let _lastChildSpanEndFrames: NativeFramesResponseWithTimestamp | null = null;\n  const _spanToNativeFramesAtStartMap: AsyncExpiringMap<string, NativeFramesResponse> = new AsyncExpiringMap({\n    ttl: START_FRAMES_TIMEOUT_MS,\n  });\n  const _spanToNativeFramesAtEndMap: AsyncExpiringMap<string, NativeFramesResponseWithTimestamp | null> =\n    new AsyncExpiringMap({ ttl: END_FRAMES_TIMEOUT_MS });\n\n  /**\n   * Hooks into the client start and end span events.\n   */\n  const setup = (client: Client): void => {\n    if (!NATIVE.enableNative) {\n      logger.warn(\n        `[${INTEGRATION_NAME}] This is not available on the Web, Expo Go and other platforms without native modules.`,\n      );\n      return undefined;\n    }\n\n    NATIVE.enableNativeFramesTracking();\n    client.on('spanStart', fetchStartFramesForSpan);\n    client.on('spanEnd', fetchEndFramesForSpan);\n  };\n\n  const fetchStartFramesForSpan = (rootSpan: Span): void => {\n    if (!isRootSpan(rootSpan)) {\n      return;\n    }\n\n    const spanId = rootSpan.spanContext().spanId;\n    logger.debug(`[${INTEGRATION_NAME}] Fetching frames for root span start (${spanId}).`);\n    _spanToNativeFramesAtStartMap.set(\n      spanId,\n      new Promise<NativeFramesResponse | null>(resolve => {\n        fetchNativeFrames()\n          .then(frames => resolve(frames))\n          .then(undefined, error => {\n            logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error);\n            resolve(null);\n          });\n      }),\n    );\n  };\n\n  const fetchEndFramesForSpan = (span: Span): void => {\n    const timestamp = timestampInSeconds();\n    const spanId = span.spanContext().spanId;\n\n    if (isRootSpan(span)) {\n      const hasStartFrames = _spanToNativeFramesAtStartMap.has(spanId);\n      if (!hasStartFrames) {\n        // We don't have start frames, won't be able to calculate the difference.\n        return;\n      }\n\n      logger.debug(`[${INTEGRATION_NAME}] Fetch frames for root span end (${spanId}).`);\n      _spanToNativeFramesAtEndMap.set(\n        spanId,\n        new Promise<NativeFramesResponseWithTimestamp | null>(resolve => {\n          fetchNativeFrames()\n            .then(frames => {\n              resolve({\n                timestamp,\n                nativeFrames: frames,\n              });\n            })\n            .then(undefined, error => {\n              logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error);\n              resolve(null);\n            });\n        }),\n      );\n      return undefined;\n    } else {\n      logger.debug(`[${INTEGRATION_NAME}] Fetch frames for child span end (${spanId}).`);\n      fetchNativeFrames()\n        .then(frames => {\n          _lastChildSpanEndFrames = {\n            timestamp,\n            nativeFrames: frames,\n          };\n        })\n        .catch(error => logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error));\n    }\n  };\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.span_id\n    ) {\n      return event;\n    }\n\n    const traceOp = event.contexts.trace.op;\n    const spanId = event.contexts.trace.span_id;\n    const startFrames = await _spanToNativeFramesAtStartMap.pop(spanId);\n    if (!startFrames) {\n      logger.warn(\n        `[${INTEGRATION_NAME}] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but the transaction already ended.`,\n      );\n      return event;\n    }\n\n    const endFrames = await _spanToNativeFramesAtEndMap.pop(spanId);\n    let finalEndFrames: NativeFramesResponse | undefined;\n\n    if (endFrames && isClose(endFrames.timestamp, event.timestamp)) {\n      // Must be in the margin of error of the actual transaction finish time (finalEndTimestamp)\n      logger.debug(`[${INTEGRATION_NAME}] Using frames from root span end (spanId, ${spanId}).`);\n      finalEndFrames = endFrames.nativeFrames;\n    } else if (_lastChildSpanEndFrames && isClose(_lastChildSpanEndFrames.timestamp, event.timestamp)) {\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(`[${INTEGRATION_NAME}] Using native frames from last child span end (spanId, ${spanId}).`);\n      finalEndFrames = _lastChildSpanEndFrames.nativeFrames;\n    } else {\n      logger.warn(\n        `[${INTEGRATION_NAME}] Frames were collected within larger than margin of error delay for spanId (${spanId}). Dropping the inaccurate values.`,\n      );\n      return event;\n    }\n\n    const measurements = {\n      frames_total: {\n        value: finalEndFrames.totalFrames - startFrames.totalFrames,\n        unit: 'none',\n      },\n      frames_frozen: {\n        value: finalEndFrames.frozenFrames - startFrames.frozenFrames,\n        unit: 'none',\n      },\n      frames_slow: {\n        value: finalEndFrames.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        `[${INTEGRATION_NAME}] Detected zero slow or frozen frames. Not adding measurements to spanId (${spanId}).`,\n      );\n      return event;\n    }\n\n    logger.log(\n      `[${INTEGRATION_NAME}] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify(\n        measurements,\n        undefined,\n        2,\n      )}`,\n    );\n    event.measurements = {\n      ...(event.measurements ?? {}),\n      ...measurements,\n    };\n    return event;\n  };\n\n  return {\n    name: INTEGRATION_NAME,\n    setup,\n    processEvent,\n  };\n};\n\nfunction fetchNativeFrames(): Promise<NativeFramesResponse> {\n  return new Promise<NativeFramesResponse>((resolve, reject) => {\n    NATIVE.fetchNativeFrames()\n      .then(value => {\n        if (!value) {\n          reject('Native frames response is null.');\n          return;\n        }\n        resolve(value);\n      })\n      .then(undefined, error => {\n        reject(error);\n      });\n\n    setTimeout(() => {\n      reject('Fetching native frames took too long. Dropping frames.');\n    }, FETCH_FRAMES_TIMEOUT_MS);\n  });\n}\n\nfunction isClose(t1: number, t2: number): boolean {\n  return Math.abs(t1 - t2) < MARGIN_OF_ERROR_SECONDS;\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"}

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

@@ -0,0 +1,70 @@
+import { getActiveSpan, getClient, getCurrentScope, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
+import { logger } from '@sentry/utils';
+import { onlySampleIfChildSpans } from '../onSpanEndUtils';
+import { SPAN_ORIGIN_AUTO_INTERACTION } from '../origin';
+import { getCurrentReactNativeTracingIntegration } from '../reactnativetracing';
+import { clearActiveSpanFromScope, isSentryInteractionSpan, startIdleSpan } from '../span';
+const INTEGRATION_NAME = 'UserInteraction';
+export const userInteractionIntegration = () => {
+    return {
+        name: INTEGRATION_NAME,
+    };
+};
+/**
+ * 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 const startUserInteractionSpan = (userInteractionId) => {
+    const client = getClient();
+    if (!client) {
+        return undefined;
+    }
+    const tracing = getCurrentReactNativeTracingIntegration();
+    if (!tracing) {
+        logger.log(`[${INTEGRATION_NAME}] Tracing integration is not available. Can not start user interaction span.`);
+        return undefined;
+    }
+    const options = client.getOptions();
+    const { elementId, op } = userInteractionId;
+    if (!options.enableUserInteractionTracing) {
+        logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing is disabled.`);
+        return undefined;
+    }
+    if (!elementId) {
+        logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction with undefined elementId.`);
+        return undefined;
+    }
+    if (!tracing.state.currentRoute) {
+        logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction without a current route.`);
+        return undefined;
+    }
+    const activeTransaction = getActiveSpan();
+    const activeTransactionIsNotInteraction = activeTransaction && !isSentryInteractionSpan(activeTransaction);
+    if (activeTransaction && activeTransactionIsNotInteraction) {
+        logger.warn(`[${INTEGRATION_NAME}] Did not create ${op} transaction because active transaction ${spanToJSON(activeTransaction).description} exists on the scope.`);
+        return undefined;
+    }
+    const name = `${tracing.state.currentRoute}.${elementId}`;
+    if (activeTransaction &&
+        spanToJSON(activeTransaction).description === name &&
+        spanToJSON(activeTransaction).op === op) {
+        logger.warn(`[${INTEGRATION_NAME}] Did not create ${op} transaction because it the same transaction ${spanToJSON(activeTransaction).description} already exists on the scope.`);
+        return undefined;
+    }
+    const scope = getCurrentScope();
+    const context = {
+        name,
+        op,
+        scope,
+    };
+    clearActiveSpanFromScope(scope);
+    const newSpan = startIdleSpan(context, {
+        idleTimeout: tracing.options.idleTimeoutMs,
+        finalTimeout: tracing.options.finalTimeoutMs,
+    });
+    newSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SPAN_ORIGIN_AUTO_INTERACTION);
+    onlySampleIfChildSpans(client, newSpan);
+    logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing Created ${op} transaction ${name}.`);
+    return newSpan;
+};
+//# sourceMappingURL=userInteraction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userInteraction.js","sourceRoot":"","sources":["../../../../src/js/tracing/integrations/userInteraction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,gCAAgC,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEvH,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,uCAAuC,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE3F,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAE3C,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAgB,EAAE;IAC1D,OAAO;QACL,IAAI,EAAE,gBAAgB;KACvB,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,iBAGxC,EAAoB,EAAE;IACrB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,OAAO,GAAG,uCAAuC,EAAE,CAAC;IAC1D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,8EAA8E,CAAC,CAAC;QAC/G,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAA8B,CAAC;IAChE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,iBAAiB,CAAC;IAC5C,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE;QACzC,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,yCAAyC,CAAC,CAAC;QAC1E,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,iFAAiF,CAAC,CAAC;QAClH,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE;QAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,gFAAgF,CAAC,CAAC;QACjH,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,iBAAiB,GAAG,aAAa,EAAE,CAAC;IAC1C,MAAM,iCAAiC,GAAG,iBAAiB,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAC3G,IAAI,iBAAiB,IAAI,iCAAiC,EAAE;QAC1D,MAAM,CAAC,IAAI,CACT,IAAI,gBAAgB,oBAAoB,EAAE,2CACxC,UAAU,CAAC,iBAAiB,CAAC,CAAC,WAChC,uBAAuB,CACxB,CAAC;QACF,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,IAAI,SAAS,EAAE,CAAC;IAC1D,IACE,iBAAiB;QACjB,UAAU,CAAC,iBAAiB,CAAC,CAAC,WAAW,KAAK,IAAI;QAClD,UAAU,CAAC,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,EACvC;QACA,MAAM,CAAC,IAAI,CACT,IAAI,gBAAgB,oBAAoB,EAAE,gDACxC,UAAU,CAAC,iBAAiB,CAAC,CAAC,WAChC,+BAA+B,CAChC,CAAC;QACF,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,MAAM,OAAO,GAAqB;QAChC,IAAI;QACJ,EAAE;QACF,KAAK;KACN,CAAC;IACF,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE;QACrC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,aAAa;QAC1C,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc;KAC7C,CAAC,CAAC;IACH,OAAO,CAAC,YAAY,CAAC,gCAAgC,EAAE,4BAA4B,CAAC,CAAC;IACrF,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,sCAAsC,EAAE,gBAAgB,IAAI,GAAG,CAAC,CAAC;IAChG,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC","sourcesContent":["import { getActiveSpan, getClient, getCurrentScope, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';\nimport type { Integration, Span, StartSpanOptions } from '@sentry/types';\nimport { logger } from '@sentry/utils';\n\nimport type { ReactNativeClientOptions } from '../../options';\nimport { onlySampleIfChildSpans } from '../onSpanEndUtils';\nimport { SPAN_ORIGIN_AUTO_INTERACTION } from '../origin';\nimport { getCurrentReactNativeTracingIntegration } from '../reactnativetracing';\nimport { clearActiveSpanFromScope, isSentryInteractionSpan, startIdleSpan } from '../span';\n\nconst INTEGRATION_NAME = 'UserInteraction';\n\nexport const userInteractionIntegration = (): Integration => {\n  return {\n    name: INTEGRATION_NAME,\n  };\n};\n\n/**\n * Starts a new transaction for a user interaction.\n * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen.\n */\nexport const startUserInteractionSpan = (userInteractionId: {\n  elementId: string | undefined;\n  op: string;\n}): Span | undefined => {\n  const client = getClient();\n  if (!client) {\n    return undefined;\n  }\n\n  const tracing = getCurrentReactNativeTracingIntegration();\n  if (!tracing) {\n    logger.log(`[${INTEGRATION_NAME}] Tracing integration is not available. Can not start user interaction span.`);\n    return undefined;\n  }\n\n  const options = client.getOptions() as ReactNativeClientOptions;\n  const { elementId, op } = userInteractionId;\n  if (!options.enableUserInteractionTracing) {\n    logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing is disabled.`);\n    return undefined;\n  }\n  if (!elementId) {\n    logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction with undefined elementId.`);\n    return undefined;\n  }\n  if (!tracing.state.currentRoute) {\n    logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction without a current route.`);\n    return undefined;\n  }\n\n  const activeTransaction = getActiveSpan();\n  const activeTransactionIsNotInteraction = activeTransaction && !isSentryInteractionSpan(activeTransaction);\n  if (activeTransaction && activeTransactionIsNotInteraction) {\n    logger.warn(\n      `[${INTEGRATION_NAME}] Did not create ${op} transaction because active transaction ${\n        spanToJSON(activeTransaction).description\n      } exists on the scope.`,\n    );\n    return undefined;\n  }\n\n  const name = `${tracing.state.currentRoute}.${elementId}`;\n  if (\n    activeTransaction &&\n    spanToJSON(activeTransaction).description === name &&\n    spanToJSON(activeTransaction).op === op\n  ) {\n    logger.warn(\n      `[${INTEGRATION_NAME}] Did not create ${op} transaction because it the same transaction ${\n        spanToJSON(activeTransaction).description\n      } already exists on the scope.`,\n    );\n    return undefined;\n  }\n\n  const scope = getCurrentScope();\n  const context: StartSpanOptions = {\n    name,\n    op,\n    scope,\n  };\n  clearActiveSpanFromScope(scope);\n  const newSpan = startIdleSpan(context, {\n    idleTimeout: tracing.options.idleTimeoutMs,\n    finalTimeout: tracing.options.finalTimeoutMs,\n  });\n  newSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SPAN_ORIGIN_AUTO_INTERACTION);\n  onlySampleIfChildSpans(client, newSpan);\n  logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing Created ${op} transaction ${name}.`);\n  return newSpan;\n};\n"]}