@sentry/browser 11.0.0-alpha.2 → 11.0.0-beta.1

package/build/npm/cjs/prod/integrations/bfcache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bfcache.js","sources":["../../../../../src/integrations/bfcache.ts"],"sourcesContent":["import {\n  SENTRY_SEGMENT_NAME,\n  BROWSER_BFCACHE_FRAME,\n  BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT,\n  BROWSER_BFCACHE_OUTCOME,\n  BROWSER_BFCACHE_REASON,\n  SENTRY_ORIGIN,\n} from '@sentry/conventions/attributes';\nimport type { IntegrationFn, SpanAttributes } from '@sentry/core/browser';\nimport { debug, defineIntegration, getCurrentScope, metrics } from '@sentry/core/browser';\nimport { DEBUG_BUILD } from '../debug-build';\nimport { WINDOW } from '../helpers';\n\nconst INTEGRATION_NAME = 'Bfcache';\n\ntype BFCacheOutcome = 'hit' | 'miss';\n\ntype BFCacheFrame = 'top' | 'child';\n\ninterface BFCacheIntegrationOptions {\n  /**\n   * Maximum number of not-restored reasons to emit per miss.\n   *\n   * By default every reason is reported. Set this to cap the number emitted per miss.\n   * Values below 1 are clamped to 1.\n   */\n  maxReasons: number;\n}\n\ninterface NotRestoredReason {\n  reason?: string;\n}\n\ninterface NotRestoredReasons {\n  children?: NotRestoredReasons[] | null;\n  reasons?: (NotRestoredReason | string)[] | null;\n}\n\ninterface NavigationTimingWithNotRestoredReasons extends PerformanceNavigationTiming {\n  notRestoredReasons?: NotRestoredReasons | null;\n}\n\ninterface CollectedReason {\n  reason: string;\n  frame: BFCacheFrame;\n}\n\n/**\n * Captures bfcache hit/miss counters and Chromium notRestoredReasons when available.\n */\nexport const bfcacheIntegration = defineIntegration((options: Partial<BFCacheIntegrationOptions> = {}) => {\n  const maxReasons = _resolveMaxReasons(options.maxReasons);\n\n  return {\n    name: INTEGRATION_NAME,\n\n    setupOnce() {\n      if (!WINDOW.addEventListener || !WINDOW.performance?.getEntriesByType) {\n        DEBUG_BUILD && debug.log(`[${INTEGRATION_NAME}] Browser APIs unavailable, skipping instrumentation.`);\n        return;\n      }\n\n      function onPageShow(event: PageTransitionEvent) {\n        const routeName = _getSegmentName();\n        if (event.persisted) {\n          _captureBFCacheNavigation('hit', 0, routeName);\n          return;\n        }\n\n        const navigationEntry = WINDOW.performance.getEntriesByType('navigation')[0] as\n          | NavigationTimingWithNotRestoredReasons\n          | undefined;\n\n        if (navigationEntry?.type !== 'back_forward') {\n          return;\n        }\n\n        const reasons = _collectNotRestoredReasons(navigationEntry.notRestoredReasons, maxReasons);\n        _captureBFCacheNavigation('miss', reasons.length, routeName);\n\n        // Measures how expensive the fallback reload was when a back/forward navigation missed bfcache.\n        if (typeof navigationEntry.duration === 'number' && navigationEntry.duration > 0) {\n          metrics.distribution('browser.bfcache.reload.duration', navigationEntry.duration, {\n            unit: 'millisecond',\n            attributes: _withOriginAttr({\n              [SENTRY_SEGMENT_NAME]: routeName,\n            }),\n          });\n        }\n\n        reasons.forEach(r => _captureBFCacheReason(r, routeName));\n      }\n\n      // Listener should stay active because the event can trigger for an initial show before the bfcache entry coming into the second one.\n      // This can be platform-dependent so we need to skip as many events till we get to the one containing the entry.\n      // So we can't have { once } or a cleanup logic here, which is fine because `setupOnce` registers it a single time regardless of how many clients are created.\n      WINDOW.addEventListener('pageshow', onPageShow, true);\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Captures a bf navigation as a metric and records the outcome and reason count.\n */\nfunction _captureBFCacheNavigation(outcome: BFCacheOutcome, reasonCount: number, routeName?: string): void {\n  metrics.count('browser.bfcache.navigation', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_OUTCOME]: outcome,\n      // Attribute should be present if reasons are >= 1\n      [BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT]: reasonCount || undefined,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * Maps a collected reason to a metric and captures/sends it.\n */\nfunction _captureBFCacheReason({ reason, frame }: CollectedReason, routeName?: string) {\n  metrics.count('browser.bfcache.not_restored', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_REASON]: reason,\n      [BROWSER_BFCACHE_FRAME]: frame,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * The segment name for a bfcache navigation, read from the scope rather than any span.\n *\n * A hit restore is silent to tracing (no pageload span), but the frozen scope still holds the last\n * transaction name a downstream SDK (Vue/React/etc.) set before the freeze, so we reuse that. On a miss the\n * page reloads with a fresh scope, so this is the new pageload name. Falls back to the raw pathname when unset.\n */\nfunction _getSegmentName(): string | undefined {\n  return getCurrentScope().getScopeData().transactionName || WINDOW.location?.pathname;\n}\n\n/**\n * Resolves the configured `maxReasons` cap. Reports every reason by default and clamps values below 1 to 1,\n * since a cap under 1 would silently drop all reasons.\n *\n * Exported for tests only.\n */\nexport function _resolveMaxReasons(maxReasons: number | undefined): number {\n  if (maxReasons == null) {\n    return Infinity;\n  }\n\n  if (maxReasons < 1) {\n    DEBUG_BUILD &&\n      debug.warn(`[${INTEGRATION_NAME}] \\`maxReasons\\` must be at least 1, got ${maxReasons}. Using 1 instead.`);\n    return 1;\n  }\n\n  return maxReasons;\n}\n\n/**\n * Flattens the (possibly nested) bfcache `notRestoredReasons` tree into a capped list of reasons.\n *\n * Exported for tests only.\n */\nexport function _collectNotRestoredReasons(\n  notRestoredReasons: NotRestoredReasons | null | undefined,\n  maxReasons: number,\n): CollectedReason[] {\n  const reasons: CollectedReason[] = [];\n\n  if (!notRestoredReasons || maxReasons <= 0) {\n    return reasons;\n  }\n\n  _collectReasonsFromFrame(notRestoredReasons, 'top', reasons, maxReasons);\n\n  return reasons;\n}\n\nfunction _collectReasonsFromFrame(\n  frame: NotRestoredReasons,\n  frameType: BFCacheFrame,\n  collectedReasons: CollectedReason[],\n  maxReasons: number,\n): void {\n  if (collectedReasons.length >= maxReasons) {\n    return;\n  }\n\n  frame.reasons?.forEach(reason => {\n    if (collectedReasons.length >= maxReasons) {\n      return;\n    }\n\n    const reasonValue = typeof reason === 'string' ? reason : reason.reason;\n    if (!reasonValue) {\n      return;\n    }\n\n    collectedReasons.push({\n      reason: reasonValue,\n      frame: frameType,\n    });\n  });\n\n  frame.children?.forEach(child => {\n    _collectReasonsFromFrame(child, 'child', collectedReasons, maxReasons);\n  });\n}\n\n/**\n * Adds the origin attributes to a set of attributes, it mutates the original attributes.\n */\nfunction _withOriginAttr(attributes: SpanAttributes): SpanAttributes {\n  attributes[SENTRY_ORIGIN] = 'auto.browser.bfcache';\n\n  return attributes;\n}\n"],"names":["defineIntegration","WINDOW","DEBUG_BUILD","debug","metrics","SENTRY_SEGMENT_NAME","BROWSER_BFCACHE_OUTCOME","BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT","BROWSER_BFCACHE_REASON","BROWSER_BFCACHE_FRAME","getCurrentScope","attributes","SENTRY_ORIGIN"],"mappings":";;;;;;;AAaA,MAAM,gBAAA,GAAmB,SAAA;AAqClB,MAAM,kBAAA,GAAqBA,yBAAA,CAAkB,CAAC,OAAA,GAA8C,EAAC,KAAM;AACxG,EAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,OAAA,CAAQ,UAAU,CAAA;AAExD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IAEN,SAAA,GAAY;AACV,MAAA,IAAI,CAACC,cAAA,CAAO,gBAAA,IAAoB,CAACA,cAAA,CAAO,aAAa,gBAAA,EAAkB;AACrE,QAAAC,sBAAA,IAAeC,aAAA,CAAM,GAAA,CAAI,CAAA,CAAA,EAAI,gBAAgB,CAAA,qDAAA,CAAuD,CAAA;AACpG,QAAA;AAAA,MACF;AAEA,MAAA,SAAS,WAAW,KAAA,EAA4B;AAC9C,QAAA,MAAM,YAAY,eAAA,EAAgB;AAClC,QAAA,IAAI,MAAM,SAAA,EAAW;AACnB,UAAA,yBAAA,CAA0B,KAAA,EAAO,GAAG,SAAS,CAAA;AAC7C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,kBAAkBF,cAAA,CAAO,WAAA,CAAY,gBAAA,CAAiB,YAAY,EAAE,CAAC,CAAA;AAI3E,QAAA,IAAI,eAAA,EAAiB,SAAS,cAAA,EAAgB;AAC5C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,OAAA,GAAU,0BAAA,CAA2B,eAAA,CAAgB,kBAAA,EAAoB,UAAU,CAAA;AACzF,QAAA,yBAAA,CAA0B,MAAA,EAAQ,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAA;AAG3D,QAAA,IAAI,OAAO,eAAA,CAAgB,QAAA,KAAa,QAAA,IAAY,eAAA,CAAgB,WAAW,CAAA,EAAG;AAChF,UAAAG,eAAA,CAAQ,YAAA,CAAa,iCAAA,EAAmC,eAAA,CAAgB,QAAA,EAAU;AAAA,YAChF,IAAA,EAAM,aAAA;AAAA,YACN,YAAY,eAAA,CAAgB;AAAA,cAC1B,CAACC,8BAAmB,GAAG;AAAA,aACxB;AAAA,WACF,CAAA;AAAA,QACH;AAEA,QAAA,OAAA,CAAQ,OAAA,CAAQ,CAAA,CAAA,KAAK,qBAAA,CAAsB,CAAA,EAAG,SAAS,CAAC,CAAA;AAAA,MAC1D;AAKA,MAAAJ,cAAA,CAAO,gBAAA,CAAiB,UAAA,EAAY,UAAA,EAAY,IAAI,CAAA;AAAA,IACtD;AAAA,GACF;AACF,CAAC;AAKD,SAAS,yBAAA,CAA0B,OAAA,EAAyB,WAAA,EAAqB,SAAA,EAA0B;AACzG,EAAAG,eAAA,CAAQ,KAAA,CAAM,8BAA8B,CAAA,EAAG;AAAA,IAC7C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAACE,kCAAuB,GAAG,OAAA;AAAA;AAAA,MAE3B,CAACC,oDAAyC,GAAG,WAAA,IAAe,MAAA;AAAA,MAC5D,CAACF,8BAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AAKA,SAAS,qBAAA,CAAsB,EAAE,MAAA,EAAQ,KAAA,IAA0B,SAAA,EAAoB;AACrF,EAAAD,eAAA,CAAQ,KAAA,CAAM,gCAAgC,CAAA,EAAG;AAAA,IAC/C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAACI,iCAAsB,GAAG,MAAA;AAAA,MAC1B,CAACC,gCAAqB,GAAG,KAAA;AAAA,MACzB,CAACJ,8BAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AASA,SAAS,eAAA,GAAsC;AAC7C,EAAA,OAAOK,yBAAgB,CAAE,YAAA,EAAa,CAAE,eAAA,IAAmBT,eAAO,QAAA,EAAU,QAAA;AAC9E;AAQO,SAAS,mBAAmB,UAAA,EAAwC;AACzE,EAAA,IAAI,cAAc,IAAA,EAAM;AACtB,IAAA,OAAO,QAAA;AAAA,EACT;AAEA,EAAA,IAAI,aAAa,CAAA,EAAG;AAClB,IAAAC,sBAAA,IACEC,cAAM,IAAA,CAAK,CAAA,CAAA,EAAI,gBAAgB,CAAA,yCAAA,EAA4C,UAAU,CAAA,kBAAA,CAAoB,CAAA;AAC3G,IAAA,OAAO,CAAA;AAAA,EACT;AAEA,EAAA,OAAO,UAAA;AACT;AAOO,SAAS,0BAAA,CACd,oBACA,UAAA,EACmB;AACnB,EAAA,MAAM,UAA6B,EAAC;AAEpC,EAAA,IAAI,CAAC,kBAAA,IAAsB,UAAA,IAAc,CAAA,EAAG;AAC1C,IAAA,OAAO,OAAA;AAAA,EACT;AAEA,EAAA,wBAAA,CAAyB,kBAAA,EAAoB,KAAA,EAAO,OAAA,EAAS,UAAU,CAAA;AAEvE,EAAA,OAAO,OAAA;AACT;AAEA,SAAS,wBAAA,CACP,KAAA,EACA,SAAA,EACA,gBAAA,EACA,UAAA,EACM;AACN,EAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,IAAA;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,OAAA,EAAS,QAAQ,CAAA,MAAA,KAAU;AAC/B,IAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,OAAO,MAAA,KAAW,QAAA,GAAW,SAAS,MAAA,CAAO,MAAA;AACjE,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,gBAAA,CAAiB,IAAA,CAAK;AAAA,MACpB,MAAA,EAAQ,WAAA;AAAA,MACR,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH,CAAC,CAAA;AAED,EAAA,KAAA,CAAM,QAAA,EAAU,QAAQ,CAAA,KAAA,KAAS;AAC/B,IAAA,wBAAA,CAAyB,KAAA,EAAO,OAAA,EAAS,gBAAA,EAAkB,UAAU,CAAA;AAAA,EACvE,CAAC,CAAA;AACH;AAKA,SAAS,gBAAgBQ,YAAA,EAA4C;AACnE,EAAAA,YAAA,CAAWC,wBAAa,CAAA,GAAI,sBAAA;AAE5B,EAAA,OAAOD,YAAA;AACT;;;;;;"}

package/build/npm/esm/dev/integrations/bfcache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bfcache.js","sources":["../../../../../src/integrations/bfcache.ts"],"sourcesContent":["import {\n  SENTRY_SEGMENT_NAME,\n  BROWSER_BFCACHE_FRAME,\n  BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT,\n  BROWSER_BFCACHE_OUTCOME,\n  BROWSER_BFCACHE_REASON,\n  SENTRY_ORIGIN,\n} from '@sentry/conventions/attributes';\nimport type { IntegrationFn, SpanAttributes } from '@sentry/core/browser';\nimport { debug, defineIntegration, getCurrentScope, metrics } from '@sentry/core/browser';\nimport { DEBUG_BUILD } from '../debug-build';\nimport { WINDOW } from '../helpers';\n\nconst INTEGRATION_NAME = 'Bfcache';\n\ntype BFCacheOutcome = 'hit' | 'miss';\n\ntype BFCacheFrame = 'top' | 'child';\n\ninterface BFCacheIntegrationOptions {\n  /**\n   * Maximum number of not-restored reasons to emit per miss.\n   *\n   * By default every reason is reported. Set this to cap the number emitted per miss.\n   * Values below 1 are clamped to 1.\n   */\n  maxReasons: number;\n}\n\ninterface NotRestoredReason {\n  reason?: string;\n}\n\ninterface NotRestoredReasons {\n  children?: NotRestoredReasons[] | null;\n  reasons?: (NotRestoredReason | string)[] | null;\n}\n\ninterface NavigationTimingWithNotRestoredReasons extends PerformanceNavigationTiming {\n  notRestoredReasons?: NotRestoredReasons | null;\n}\n\ninterface CollectedReason {\n  reason: string;\n  frame: BFCacheFrame;\n}\n\n/**\n * Captures bfcache hit/miss counters and Chromium notRestoredReasons when available.\n */\nexport const bfcacheIntegration = defineIntegration((options: Partial<BFCacheIntegrationOptions> = {}) => {\n  const maxReasons = _resolveMaxReasons(options.maxReasons);\n\n  return {\n    name: INTEGRATION_NAME,\n\n    setupOnce() {\n      if (!WINDOW.addEventListener || !WINDOW.performance?.getEntriesByType) {\n        DEBUG_BUILD && debug.log(`[${INTEGRATION_NAME}] Browser APIs unavailable, skipping instrumentation.`);\n        return;\n      }\n\n      function onPageShow(event: PageTransitionEvent) {\n        const routeName = _getSegmentName();\n        if (event.persisted) {\n          _captureBFCacheNavigation('hit', 0, routeName);\n          return;\n        }\n\n        const navigationEntry = WINDOW.performance.getEntriesByType('navigation')[0] as\n          | NavigationTimingWithNotRestoredReasons\n          | undefined;\n\n        if (navigationEntry?.type !== 'back_forward') {\n          return;\n        }\n\n        const reasons = _collectNotRestoredReasons(navigationEntry.notRestoredReasons, maxReasons);\n        _captureBFCacheNavigation('miss', reasons.length, routeName);\n\n        // Measures how expensive the fallback reload was when a back/forward navigation missed bfcache.\n        if (typeof navigationEntry.duration === 'number' && navigationEntry.duration > 0) {\n          metrics.distribution('browser.bfcache.reload.duration', navigationEntry.duration, {\n            unit: 'millisecond',\n            attributes: _withOriginAttr({\n              [SENTRY_SEGMENT_NAME]: routeName,\n            }),\n          });\n        }\n\n        reasons.forEach(r => _captureBFCacheReason(r, routeName));\n      }\n\n      // Listener should stay active because the event can trigger for an initial show before the bfcache entry coming into the second one.\n      // This can be platform-dependent so we need to skip as many events till we get to the one containing the entry.\n      // So we can't have { once } or a cleanup logic here, which is fine because `setupOnce` registers it a single time regardless of how many clients are created.\n      WINDOW.addEventListener('pageshow', onPageShow, true);\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Captures a bf navigation as a metric and records the outcome and reason count.\n */\nfunction _captureBFCacheNavigation(outcome: BFCacheOutcome, reasonCount: number, routeName?: string): void {\n  metrics.count('browser.bfcache.navigation', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_OUTCOME]: outcome,\n      // Attribute should be present if reasons are >= 1\n      [BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT]: reasonCount || undefined,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * Maps a collected reason to a metric and captures/sends it.\n */\nfunction _captureBFCacheReason({ reason, frame }: CollectedReason, routeName?: string) {\n  metrics.count('browser.bfcache.not_restored', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_REASON]: reason,\n      [BROWSER_BFCACHE_FRAME]: frame,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * The segment name for a bfcache navigation, read from the scope rather than any span.\n *\n * A hit restore is silent to tracing (no pageload span), but the frozen scope still holds the last\n * transaction name a downstream SDK (Vue/React/etc.) set before the freeze, so we reuse that. On a miss the\n * page reloads with a fresh scope, so this is the new pageload name. Falls back to the raw pathname when unset.\n */\nfunction _getSegmentName(): string | undefined {\n  return getCurrentScope().getScopeData().transactionName || WINDOW.location?.pathname;\n}\n\n/**\n * Resolves the configured `maxReasons` cap. Reports every reason by default and clamps values below 1 to 1,\n * since a cap under 1 would silently drop all reasons.\n *\n * Exported for tests only.\n */\nexport function _resolveMaxReasons(maxReasons: number | undefined): number {\n  if (maxReasons == null) {\n    return Infinity;\n  }\n\n  if (maxReasons < 1) {\n    DEBUG_BUILD &&\n      debug.warn(`[${INTEGRATION_NAME}] \\`maxReasons\\` must be at least 1, got ${maxReasons}. Using 1 instead.`);\n    return 1;\n  }\n\n  return maxReasons;\n}\n\n/**\n * Flattens the (possibly nested) bfcache `notRestoredReasons` tree into a capped list of reasons.\n *\n * Exported for tests only.\n */\nexport function _collectNotRestoredReasons(\n  notRestoredReasons: NotRestoredReasons | null | undefined,\n  maxReasons: number,\n): CollectedReason[] {\n  const reasons: CollectedReason[] = [];\n\n  if (!notRestoredReasons || maxReasons <= 0) {\n    return reasons;\n  }\n\n  _collectReasonsFromFrame(notRestoredReasons, 'top', reasons, maxReasons);\n\n  return reasons;\n}\n\nfunction _collectReasonsFromFrame(\n  frame: NotRestoredReasons,\n  frameType: BFCacheFrame,\n  collectedReasons: CollectedReason[],\n  maxReasons: number,\n): void {\n  if (collectedReasons.length >= maxReasons) {\n    return;\n  }\n\n  frame.reasons?.forEach(reason => {\n    if (collectedReasons.length >= maxReasons) {\n      return;\n    }\n\n    const reasonValue = typeof reason === 'string' ? reason : reason.reason;\n    if (!reasonValue) {\n      return;\n    }\n\n    collectedReasons.push({\n      reason: reasonValue,\n      frame: frameType,\n    });\n  });\n\n  frame.children?.forEach(child => {\n    _collectReasonsFromFrame(child, 'child', collectedReasons, maxReasons);\n  });\n}\n\n/**\n * Adds the origin attributes to a set of attributes, it mutates the original attributes.\n */\nfunction _withOriginAttr(attributes: SpanAttributes): SpanAttributes {\n  attributes[SENTRY_ORIGIN] = 'auto.browser.bfcache';\n\n  return attributes;\n}\n"],"names":[],"mappings":";;;;;AAaA,MAAM,gBAAA,GAAmB,SAAA;AAqClB,MAAM,kBAAA,GAAqB,iBAAA,CAAkB,CAAC,OAAA,GAA8C,EAAC,KAAM;AACxG,EAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,OAAA,CAAQ,UAAU,CAAA;AAExD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IAEN,SAAA,GAAY;AACV,MAAA,IAAI,CAAC,MAAA,CAAO,gBAAA,IAAoB,CAAC,MAAA,CAAO,aAAa,gBAAA,EAAkB;AACrE,QAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,CAAA,EAAI,gBAAgB,CAAA,qDAAA,CAAuD,CAAA;AACpG,QAAA;AAAA,MACF;AAEA,MAAA,SAAS,WAAW,KAAA,EAA4B;AAC9C,QAAA,MAAM,YAAY,eAAA,EAAgB;AAClC,QAAA,IAAI,MAAM,SAAA,EAAW;AACnB,UAAA,yBAAA,CAA0B,KAAA,EAAO,GAAG,SAAS,CAAA;AAC7C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,kBAAkB,MAAA,CAAO,WAAA,CAAY,gBAAA,CAAiB,YAAY,EAAE,CAAC,CAAA;AAI3E,QAAA,IAAI,eAAA,EAAiB,SAAS,cAAA,EAAgB;AAC5C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,OAAA,GAAU,0BAAA,CAA2B,eAAA,CAAgB,kBAAA,EAAoB,UAAU,CAAA;AACzF,QAAA,yBAAA,CAA0B,MAAA,EAAQ,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAA;AAG3D,QAAA,IAAI,OAAO,eAAA,CAAgB,QAAA,KAAa,QAAA,IAAY,eAAA,CAAgB,WAAW,CAAA,EAAG;AAChF,UAAA,OAAA,CAAQ,YAAA,CAAa,iCAAA,EAAmC,eAAA,CAAgB,QAAA,EAAU;AAAA,YAChF,IAAA,EAAM,aAAA;AAAA,YACN,YAAY,eAAA,CAAgB;AAAA,cAC1B,CAAC,mBAAmB,GAAG;AAAA,aACxB;AAAA,WACF,CAAA;AAAA,QACH;AAEA,QAAA,OAAA,CAAQ,OAAA,CAAQ,CAAA,CAAA,KAAK,qBAAA,CAAsB,CAAA,EAAG,SAAS,CAAC,CAAA;AAAA,MAC1D;AAKA,MAAA,MAAA,CAAO,gBAAA,CAAiB,UAAA,EAAY,UAAA,EAAY,IAAI,CAAA;AAAA,IACtD;AAAA,GACF;AACF,CAAC;AAKD,SAAS,yBAAA,CAA0B,OAAA,EAAyB,WAAA,EAAqB,SAAA,EAA0B;AACzG,EAAA,OAAA,CAAQ,KAAA,CAAM,8BAA8B,CAAA,EAAG;AAAA,IAC7C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAAC,uBAAuB,GAAG,OAAA;AAAA;AAAA,MAE3B,CAAC,yCAAyC,GAAG,WAAA,IAAe,MAAA;AAAA,MAC5D,CAAC,mBAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AAKA,SAAS,qBAAA,CAAsB,EAAE,MAAA,EAAQ,KAAA,IAA0B,SAAA,EAAoB;AACrF,EAAA,OAAA,CAAQ,KAAA,CAAM,gCAAgC,CAAA,EAAG;AAAA,IAC/C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAAC,sBAAsB,GAAG,MAAA;AAAA,MAC1B,CAAC,qBAAqB,GAAG,KAAA;AAAA,MACzB,CAAC,mBAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AASA,SAAS,eAAA,GAAsC;AAC7C,EAAA,OAAO,iBAAgB,CAAE,YAAA,EAAa,CAAE,eAAA,IAAmB,OAAO,QAAA,EAAU,QAAA;AAC9E;AAQO,SAAS,mBAAmB,UAAA,EAAwC;AACzE,EAAA,IAAI,cAAc,IAAA,EAAM;AACtB,IAAA,OAAO,QAAA;AAAA,EACT;AAEA,EAAA,IAAI,aAAa,CAAA,EAAG;AAClB,IAAA,WAAA,IACE,MAAM,IAAA,CAAK,CAAA,CAAA,EAAI,gBAAgB,CAAA,yCAAA,EAA4C,UAAU,CAAA,kBAAA,CAAoB,CAAA;AAC3G,IAAA,OAAO,CAAA;AAAA,EACT;AAEA,EAAA,OAAO,UAAA;AACT;AAOO,SAAS,0BAAA,CACd,oBACA,UAAA,EACmB;AACnB,EAAA,MAAM,UAA6B,EAAC;AAEpC,EAAA,IAAI,CAAC,kBAAA,IAAsB,UAAA,IAAc,CAAA,EAAG;AAC1C,IAAA,OAAO,OAAA;AAAA,EACT;AAEA,EAAA,wBAAA,CAAyB,kBAAA,EAAoB,KAAA,EAAO,OAAA,EAAS,UAAU,CAAA;AAEvE,EAAA,OAAO,OAAA;AACT;AAEA,SAAS,wBAAA,CACP,KAAA,EACA,SAAA,EACA,gBAAA,EACA,UAAA,EACM;AACN,EAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,IAAA;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,OAAA,EAAS,QAAQ,CAAA,MAAA,KAAU;AAC/B,IAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,OAAO,MAAA,KAAW,QAAA,GAAW,SAAS,MAAA,CAAO,MAAA;AACjE,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,gBAAA,CAAiB,IAAA,CAAK;AAAA,MACpB,MAAA,EAAQ,WAAA;AAAA,MACR,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH,CAAC,CAAA;AAED,EAAA,KAAA,CAAM,QAAA,EAAU,QAAQ,CAAA,KAAA,KAAS;AAC/B,IAAA,wBAAA,CAAyB,KAAA,EAAO,OAAA,EAAS,gBAAA,EAAkB,UAAU,CAAA;AAAA,EACvE,CAAC,CAAA;AACH;AAKA,SAAS,gBAAgB,UAAA,EAA4C;AACnE,EAAA,UAAA,CAAW,aAAa,CAAA,GAAI,sBAAA;AAE5B,EAAA,OAAO,UAAA;AACT;;;;"}

package/build/npm/esm/prod/integrations/bfcache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bfcache.js","sources":["../../../../../src/integrations/bfcache.ts"],"sourcesContent":["import {\n  SENTRY_SEGMENT_NAME,\n  BROWSER_BFCACHE_FRAME,\n  BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT,\n  BROWSER_BFCACHE_OUTCOME,\n  BROWSER_BFCACHE_REASON,\n  SENTRY_ORIGIN,\n} from '@sentry/conventions/attributes';\nimport type { IntegrationFn, SpanAttributes } from '@sentry/core/browser';\nimport { debug, defineIntegration, getCurrentScope, metrics } from '@sentry/core/browser';\nimport { DEBUG_BUILD } from '../debug-build';\nimport { WINDOW } from '../helpers';\n\nconst INTEGRATION_NAME = 'Bfcache';\n\ntype BFCacheOutcome = 'hit' | 'miss';\n\ntype BFCacheFrame = 'top' | 'child';\n\ninterface BFCacheIntegrationOptions {\n  /**\n   * Maximum number of not-restored reasons to emit per miss.\n   *\n   * By default every reason is reported. Set this to cap the number emitted per miss.\n   * Values below 1 are clamped to 1.\n   */\n  maxReasons: number;\n}\n\ninterface NotRestoredReason {\n  reason?: string;\n}\n\ninterface NotRestoredReasons {\n  children?: NotRestoredReasons[] | null;\n  reasons?: (NotRestoredReason | string)[] | null;\n}\n\ninterface NavigationTimingWithNotRestoredReasons extends PerformanceNavigationTiming {\n  notRestoredReasons?: NotRestoredReasons | null;\n}\n\ninterface CollectedReason {\n  reason: string;\n  frame: BFCacheFrame;\n}\n\n/**\n * Captures bfcache hit/miss counters and Chromium notRestoredReasons when available.\n */\nexport const bfcacheIntegration = defineIntegration((options: Partial<BFCacheIntegrationOptions> = {}) => {\n  const maxReasons = _resolveMaxReasons(options.maxReasons);\n\n  return {\n    name: INTEGRATION_NAME,\n\n    setupOnce() {\n      if (!WINDOW.addEventListener || !WINDOW.performance?.getEntriesByType) {\n        DEBUG_BUILD && debug.log(`[${INTEGRATION_NAME}] Browser APIs unavailable, skipping instrumentation.`);\n        return;\n      }\n\n      function onPageShow(event: PageTransitionEvent) {\n        const routeName = _getSegmentName();\n        if (event.persisted) {\n          _captureBFCacheNavigation('hit', 0, routeName);\n          return;\n        }\n\n        const navigationEntry = WINDOW.performance.getEntriesByType('navigation')[0] as\n          | NavigationTimingWithNotRestoredReasons\n          | undefined;\n\n        if (navigationEntry?.type !== 'back_forward') {\n          return;\n        }\n\n        const reasons = _collectNotRestoredReasons(navigationEntry.notRestoredReasons, maxReasons);\n        _captureBFCacheNavigation('miss', reasons.length, routeName);\n\n        // Measures how expensive the fallback reload was when a back/forward navigation missed bfcache.\n        if (typeof navigationEntry.duration === 'number' && navigationEntry.duration > 0) {\n          metrics.distribution('browser.bfcache.reload.duration', navigationEntry.duration, {\n            unit: 'millisecond',\n            attributes: _withOriginAttr({\n              [SENTRY_SEGMENT_NAME]: routeName,\n            }),\n          });\n        }\n\n        reasons.forEach(r => _captureBFCacheReason(r, routeName));\n      }\n\n      // Listener should stay active because the event can trigger for an initial show before the bfcache entry coming into the second one.\n      // This can be platform-dependent so we need to skip as many events till we get to the one containing the entry.\n      // So we can't have { once } or a cleanup logic here, which is fine because `setupOnce` registers it a single time regardless of how many clients are created.\n      WINDOW.addEventListener('pageshow', onPageShow, true);\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Captures a bf navigation as a metric and records the outcome and reason count.\n */\nfunction _captureBFCacheNavigation(outcome: BFCacheOutcome, reasonCount: number, routeName?: string): void {\n  metrics.count('browser.bfcache.navigation', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_OUTCOME]: outcome,\n      // Attribute should be present if reasons are >= 1\n      [BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT]: reasonCount || undefined,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * Maps a collected reason to a metric and captures/sends it.\n */\nfunction _captureBFCacheReason({ reason, frame }: CollectedReason, routeName?: string) {\n  metrics.count('browser.bfcache.not_restored', 1, {\n    attributes: _withOriginAttr({\n      [BROWSER_BFCACHE_REASON]: reason,\n      [BROWSER_BFCACHE_FRAME]: frame,\n      [SENTRY_SEGMENT_NAME]: routeName,\n    }),\n  });\n}\n\n/**\n * The segment name for a bfcache navigation, read from the scope rather than any span.\n *\n * A hit restore is silent to tracing (no pageload span), but the frozen scope still holds the last\n * transaction name a downstream SDK (Vue/React/etc.) set before the freeze, so we reuse that. On a miss the\n * page reloads with a fresh scope, so this is the new pageload name. Falls back to the raw pathname when unset.\n */\nfunction _getSegmentName(): string | undefined {\n  return getCurrentScope().getScopeData().transactionName || WINDOW.location?.pathname;\n}\n\n/**\n * Resolves the configured `maxReasons` cap. Reports every reason by default and clamps values below 1 to 1,\n * since a cap under 1 would silently drop all reasons.\n *\n * Exported for tests only.\n */\nexport function _resolveMaxReasons(maxReasons: number | undefined): number {\n  if (maxReasons == null) {\n    return Infinity;\n  }\n\n  if (maxReasons < 1) {\n    DEBUG_BUILD &&\n      debug.warn(`[${INTEGRATION_NAME}] \\`maxReasons\\` must be at least 1, got ${maxReasons}. Using 1 instead.`);\n    return 1;\n  }\n\n  return maxReasons;\n}\n\n/**\n * Flattens the (possibly nested) bfcache `notRestoredReasons` tree into a capped list of reasons.\n *\n * Exported for tests only.\n */\nexport function _collectNotRestoredReasons(\n  notRestoredReasons: NotRestoredReasons | null | undefined,\n  maxReasons: number,\n): CollectedReason[] {\n  const reasons: CollectedReason[] = [];\n\n  if (!notRestoredReasons || maxReasons <= 0) {\n    return reasons;\n  }\n\n  _collectReasonsFromFrame(notRestoredReasons, 'top', reasons, maxReasons);\n\n  return reasons;\n}\n\nfunction _collectReasonsFromFrame(\n  frame: NotRestoredReasons,\n  frameType: BFCacheFrame,\n  collectedReasons: CollectedReason[],\n  maxReasons: number,\n): void {\n  if (collectedReasons.length >= maxReasons) {\n    return;\n  }\n\n  frame.reasons?.forEach(reason => {\n    if (collectedReasons.length >= maxReasons) {\n      return;\n    }\n\n    const reasonValue = typeof reason === 'string' ? reason : reason.reason;\n    if (!reasonValue) {\n      return;\n    }\n\n    collectedReasons.push({\n      reason: reasonValue,\n      frame: frameType,\n    });\n  });\n\n  frame.children?.forEach(child => {\n    _collectReasonsFromFrame(child, 'child', collectedReasons, maxReasons);\n  });\n}\n\n/**\n * Adds the origin attributes to a set of attributes, it mutates the original attributes.\n */\nfunction _withOriginAttr(attributes: SpanAttributes): SpanAttributes {\n  attributes[SENTRY_ORIGIN] = 'auto.browser.bfcache';\n\n  return attributes;\n}\n"],"names":[],"mappings":";;;;;AAaA,MAAM,gBAAA,GAAmB,SAAA;AAqClB,MAAM,kBAAA,GAAqB,iBAAA,CAAkB,CAAC,OAAA,GAA8C,EAAC,KAAM;AACxG,EAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,OAAA,CAAQ,UAAU,CAAA;AAExD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IAEN,SAAA,GAAY;AACV,MAAA,IAAI,CAAC,MAAA,CAAO,gBAAA,IAAoB,CAAC,MAAA,CAAO,aAAa,gBAAA,EAAkB;AACrE,QAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,CAAA,EAAI,gBAAgB,CAAA,qDAAA,CAAuD,CAAA;AACpG,QAAA;AAAA,MACF;AAEA,MAAA,SAAS,WAAW,KAAA,EAA4B;AAC9C,QAAA,MAAM,YAAY,eAAA,EAAgB;AAClC,QAAA,IAAI,MAAM,SAAA,EAAW;AACnB,UAAA,yBAAA,CAA0B,KAAA,EAAO,GAAG,SAAS,CAAA;AAC7C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,kBAAkB,MAAA,CAAO,WAAA,CAAY,gBAAA,CAAiB,YAAY,EAAE,CAAC,CAAA;AAI3E,QAAA,IAAI,eAAA,EAAiB,SAAS,cAAA,EAAgB;AAC5C,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,OAAA,GAAU,0BAAA,CAA2B,eAAA,CAAgB,kBAAA,EAAoB,UAAU,CAAA;AACzF,QAAA,yBAAA,CAA0B,MAAA,EAAQ,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAA;AAG3D,QAAA,IAAI,OAAO,eAAA,CAAgB,QAAA,KAAa,QAAA,IAAY,eAAA,CAAgB,WAAW,CAAA,EAAG;AAChF,UAAA,OAAA,CAAQ,YAAA,CAAa,iCAAA,EAAmC,eAAA,CAAgB,QAAA,EAAU;AAAA,YAChF,IAAA,EAAM,aAAA;AAAA,YACN,YAAY,eAAA,CAAgB;AAAA,cAC1B,CAAC,mBAAmB,GAAG;AAAA,aACxB;AAAA,WACF,CAAA;AAAA,QACH;AAEA,QAAA,OAAA,CAAQ,OAAA,CAAQ,CAAA,CAAA,KAAK,qBAAA,CAAsB,CAAA,EAAG,SAAS,CAAC,CAAA;AAAA,MAC1D;AAKA,MAAA,MAAA,CAAO,gBAAA,CAAiB,UAAA,EAAY,UAAA,EAAY,IAAI,CAAA;AAAA,IACtD;AAAA,GACF;AACF,CAAC;AAKD,SAAS,yBAAA,CAA0B,OAAA,EAAyB,WAAA,EAAqB,SAAA,EAA0B;AACzG,EAAA,OAAA,CAAQ,KAAA,CAAM,8BAA8B,CAAA,EAAG;AAAA,IAC7C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAAC,uBAAuB,GAAG,OAAA;AAAA;AAAA,MAE3B,CAAC,yCAAyC,GAAG,WAAA,IAAe,MAAA;AAAA,MAC5D,CAAC,mBAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AAKA,SAAS,qBAAA,CAAsB,EAAE,MAAA,EAAQ,KAAA,IAA0B,SAAA,EAAoB;AACrF,EAAA,OAAA,CAAQ,KAAA,CAAM,gCAAgC,CAAA,EAAG;AAAA,IAC/C,YAAY,eAAA,CAAgB;AAAA,MAC1B,CAAC,sBAAsB,GAAG,MAAA;AAAA,MAC1B,CAAC,qBAAqB,GAAG,KAAA;AAAA,MACzB,CAAC,mBAAmB,GAAG;AAAA,KACxB;AAAA,GACF,CAAA;AACH;AASA,SAAS,eAAA,GAAsC;AAC7C,EAAA,OAAO,iBAAgB,CAAE,YAAA,EAAa,CAAE,eAAA,IAAmB,OAAO,QAAA,EAAU,QAAA;AAC9E;AAQO,SAAS,mBAAmB,UAAA,EAAwC;AACzE,EAAA,IAAI,cAAc,IAAA,EAAM;AACtB,IAAA,OAAO,QAAA;AAAA,EACT;AAEA,EAAA,IAAI,aAAa,CAAA,EAAG;AAClB,IAAA,WAAA,IACE,MAAM,IAAA,CAAK,CAAA,CAAA,EAAI,gBAAgB,CAAA,yCAAA,EAA4C,UAAU,CAAA,kBAAA,CAAoB,CAAA;AAC3G,IAAA,OAAO,CAAA;AAAA,EACT;AAEA,EAAA,OAAO,UAAA;AACT;AAOO,SAAS,0BAAA,CACd,oBACA,UAAA,EACmB;AACnB,EAAA,MAAM,UAA6B,EAAC;AAEpC,EAAA,IAAI,CAAC,kBAAA,IAAsB,UAAA,IAAc,CAAA,EAAG;AAC1C,IAAA,OAAO,OAAA;AAAA,EACT;AAEA,EAAA,wBAAA,CAAyB,kBAAA,EAAoB,KAAA,EAAO,OAAA,EAAS,UAAU,CAAA;AAEvE,EAAA,OAAO,OAAA;AACT;AAEA,SAAS,wBAAA,CACP,KAAA,EACA,SAAA,EACA,gBAAA,EACA,UAAA,EACM;AACN,EAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,IAAA;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,OAAA,EAAS,QAAQ,CAAA,MAAA,KAAU;AAC/B,IAAA,IAAI,gBAAA,CAAiB,UAAU,UAAA,EAAY;AACzC,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,OAAO,MAAA,KAAW,QAAA,GAAW,SAAS,MAAA,CAAO,MAAA;AACjE,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,gBAAA,CAAiB,IAAA,CAAK;AAAA,MACpB,MAAA,EAAQ,WAAA;AAAA,MACR,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH,CAAC,CAAA;AAED,EAAA,KAAA,CAAM,QAAA,EAAU,QAAQ,CAAA,KAAA,KAAS;AAC/B,IAAA,wBAAA,CAAyB,KAAA,EAAO,OAAA,EAAS,gBAAA,EAAkB,UAAU,CAAA;AAAA,EACvE,CAAC,CAAA;AACH;AAKA,SAAS,gBAAgB,UAAA,EAA4C;AACnE,EAAA,UAAA,CAAW,aAAa,CAAA,GAAI,sBAAA;AAE5B,EAAA,OAAO,UAAA;AACT;;;;"}

package/build/npm/types/integrations/bfcache.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bfcache.d.ts","sourceRoot":"","sources":["../../../../src/integrations/bfcache.ts"],"names":[],"mappings":"AAiBA,KAAK,YAAY,GAAG,KAAK,GAAG,OAAO,CAAC;AAEpC,UAAU,yBAAyB;IACjC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,iBAAiB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;IACvC,OAAO,CAAC,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC;CACjD;AAMD,UAAU,eAAe;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB;;CAiDL,CAAC;AAwC3B;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAYzE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,EACzD,UAAU,EAAE,MAAM,GACjB,eAAe,EAAE,CAUnB"}