@grafana/faro-react-native 1.0.0 → 1.1.0

package/README.md

@@ -47,7 +47,12 @@ initializeFaro({
   fetchVitalsInterval: 30000, // optional, ms
   frameMonitoringOptions: {}, // optional, when refreshRateVitals true
   enableTracing: false, // optional, requires @grafana/faro-react-native-tracing
-  tracingOptions: {}, // optional
+  tracingOptions: {
+    instrumentationOptions: {
+      // Traces fetch() by default. Enable this for axios/direct XHR apps.
+      enableXhrInstrumentation: false,
+    },
+  }, // optional
 
   // Instrumentation options - optional
   consoleCaptureOptions: {},
@@ -85,8 +90,8 @@ initializeFaro({
 - **App State Instrumentation** - Tracks when app goes to background/foreground
 - **Performance Instrumentation** - Monitors CPU usage, memory usage, and app startup time using native OS APIs
 - **Startup Instrumentation** - Automatically tracks app startup duration from process start
-- **HTTP Instrumentation** - Tracks HTTP requests (fetch) and correlates them with user actions
-- **XHR Instrumentation** - Tracks XMLHttpRequest calls (replaced by TracingInstrumentation when `enableTracing` is true)
+- **HTTP Instrumentation** - Tracks `fetch()` requests and correlates them with user actions
+- **XHR Instrumentation** - Tracks `XMLHttpRequest` calls when tracing is disabled; with `enableTracing: true`, enable XHR tracing via `tracingOptions.instrumentationOptions.enableXhrInstrumentation`
 
 **Enabled by default** (opt-out via config):
 

package/dist/cjs/generated/faroRNPackageMeta.js

@@ -5,5 +5,5 @@ exports.FARO_REACT_NATIVE_NPM_VERSION = exports.FARO_REACT_NATIVE_NPM_NAME = voi
  * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.
  */
 exports.FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native';
-exports.FARO_REACT_NATIVE_NPM_VERSION = '1.0.0';
+exports.FARO_REACT_NATIVE_NPM_VERSION = '1.1.0';
 //# sourceMappingURL=faroRNPackageMeta.js.map

package/dist/cjs/generated/faroRNPackageMeta.js.map

@@ -1 +1 @@
-{"version":3,"file":"faroRNPackageMeta.js","sourceRoot":"","sources":["../../../src/generated/faroRNPackageMeta.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,0BAA0B,GAAG,4BAAqC,CAAC;AACnE,QAAA,6BAA6B,GAAG,OAAgB,CAAC","sourcesContent":["/**\n * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.\n */\nexport const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native' as const;\nexport const FARO_REACT_NATIVE_NPM_VERSION = '1.0.0' as const;\n"]}
+{"version":3,"file":"faroRNPackageMeta.js","sourceRoot":"","sources":["../../../src/generated/faroRNPackageMeta.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,0BAA0B,GAAG,4BAAqC,CAAC;AACnE,QAAA,6BAA6B,GAAG,OAAgB,CAAC","sourcesContent":["/**\n * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.\n */\nexport const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native' as const;\nexport const FARO_REACT_NATIVE_NPM_VERSION = '1.1.0' as const;\n"]}

package/dist/cjs/util/performanceObserverPolyfill.js

@@ -20,6 +20,8 @@ var globalObj = (typeof globalThis !== 'undefined' && globalThis) ||
     (typeof global !== 'undefined' && global) ||
     (typeof window !== 'undefined' && window) ||
     {};
+var RESOURCE_ENTRY_TYPE = 'resource';
+var FARO_RESOURCE_TIMING_PATCH = '__faroResourceTimingPatch';
 /**
  * No-op PerformanceObserver that matches the Web API interface.
  * Prevents crashes when React Native's native implementation throws.
@@ -41,14 +43,18 @@ var NoopPerformanceObserver = /** @class */ (function () {
     return NoopPerformanceObserver;
 }());
 /**
- * Apply polyfill on React Native iOS to prevent bad_variant_access crash.
- * Must run before any code that might use PerformanceObserver.
+ * Apply React Native performance API compatibility patches.
+ *
+ * Resource Timing lookup is patched on all platforms because OTel web
+ * instrumentation can probe it. The PerformanceObserver replacement is
+ * iOS-only to avoid the native bad_variant_access crash.
  */
 function applyPerformanceObserverPolyfill() {
+    var record = globalObj;
+    patchUnsupportedResourceTimingLookup(record);
     if (react_native_1.Platform.OS !== 'ios') {
         return;
     }
-    var record = globalObj;
     var existing = record['PerformanceObserver'];
     if (existing && existing.name === 'NoopPerformanceObserver') {
         return; // Already applied
@@ -60,4 +66,27 @@ function applyPerformanceObserverPolyfill() {
         // Ignore if global is frozen (e.g. in some test environments)
     }
 }
+function patchUnsupportedResourceTimingLookup(record) {
+    var performance = record['performance'];
+    if (!(performance === null || performance === void 0 ? void 0 : performance.getEntriesByType) || performance.getEntriesByType[FARO_RESOURCE_TIMING_PATCH]) {
+        return;
+    }
+    var originalGetEntriesByType = performance.getEntriesByType.bind(performance);
+    var patchedGetEntriesByType = (function (entryType) {
+        if (entryType === RESOURCE_ENTRY_TYPE) {
+            // OTel web fetch instrumentation probes browser Resource Timing APIs.
+            // React Native does not expose resource entries, and calling through emits
+            // "Deprecated API for given entry type." warnings in development.
+            return [];
+        }
+        return originalGetEntriesByType(entryType);
+    });
+    patchedGetEntriesByType[FARO_RESOURCE_TIMING_PATCH] = true;
+    try {
+        performance.getEntriesByType = patchedGetEntriesByType;
+    }
+    catch (_a) {
+        // Ignore if performance is read-only in a test or host environment.
+    }
+}
 //# sourceMappingURL=performanceObserverPolyfill.js.map

package/dist/cjs/util/performanceObserverPolyfill.js.map

@@ -1 +1 @@
-{"version":3,"file":"performanceObserverPolyfill.js","sourceRoot":"","sources":["../../../src/util/performanceObserverPolyfill.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;AA+DH,4EAgBC;AA7ED,6CAAwC;AAExC,IAAM,SAAS,GACb,CAAC,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC;IACjD,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,EAAE,CAAC;AAqBL;;;GAGG;AACH;IACE,iCACE,SAIS;QAET,+DAA+D;IACjE,CAAC;IAED,yCAAO,GAAP,UAAQ,QAAkC;QACxC,QAAQ;IACV,CAAC;IAED,4CAAU,GAAV;QACE,QAAQ;IACV,CAAC;IAED,6CAAW,GAAX;QACE,OAAO,EAAE,CAAC;IACZ,CAAC;IAEe,2CAAmB,GAAa,EAAE,CAAC;IACrD,8BAAC;CAAA,AAxBD,IAwBC;AAED;;;GAGG;AACH,SAAgB,gCAAgC;IAC9C,IAAI,uBAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,IAAM,MAAM,GAAG,SAAoC,CAAC;IACpD,IAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC/C,IAAI,QAAQ,IAAK,QAAyC,CAAC,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC9F,OAAO,CAAC,kBAAkB;IAC5B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,uBAAuB,CAAC;IAC1D,CAAC;IAAC,WAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;AACH,CAAC","sourcesContent":["/**\n * PerformanceObserver polyfill for React Native iOS\n *\n * React Native 0.84's native PerformanceObserver has a bug on iOS that throws\n * `bad_variant_access` when the observer callback runs and calls getEntries().\n * This happens in NativePerformance.createObserver when the native bridge\n * returns data that causes a C++ variant access error.\n *\n * OpenTelemetry's FetchInstrumentation (and other libs) may use PerformanceObserver\n * for resource timing. We provide a no-op polyfill on React Native iOS to prevent\n * the crash while preserving refresh rate vitals and other functionality.\n *\n * @see https://github.com/facebook/react-native/issues (PerformanceObserver iOS)\n */\n\nimport { Platform } from 'react-native';\n\nconst globalObj =\n  (typeof globalThis !== 'undefined' && globalThis) ||\n  (typeof global !== 'undefined' && global) ||\n  (typeof window !== 'undefined' && window) ||\n  {};\n\ninterface PerformanceEntry {\n  readonly duration: number;\n  readonly entryType: string;\n  readonly name: string;\n  readonly startTime: number;\n}\n\ninterface PerformanceObserverEntryList {\n  getEntries(): PerformanceEntry[];\n  getEntriesByName(name: string, type?: string): PerformanceEntry[];\n  getEntriesByType(type: string): PerformanceEntry[];\n}\n\ninterface PerformanceObserverInit {\n  entryTypes?: string[];\n  type?: string;\n  buffered?: boolean;\n}\n\n/**\n * No-op PerformanceObserver that matches the Web API interface.\n * Prevents crashes when React Native's native implementation throws.\n */\nclass NoopPerformanceObserver {\n  constructor(\n    _callback: (\n      list: PerformanceObserverEntryList,\n      observer: NoopPerformanceObserver,\n      options?: PerformanceObserverInit\n    ) => void\n  ) {\n    // Callback is never invoked - avoids triggering the native bug\n  }\n\n  observe(_options?: PerformanceObserverInit): void {\n    // No-op\n  }\n\n  disconnect(): void {\n    // No-op\n  }\n\n  takeRecords(): PerformanceEntry[] {\n    return [];\n  }\n\n  static readonly supportedEntryTypes: string[] = [];\n}\n\n/**\n * Apply polyfill on React Native iOS to prevent bad_variant_access crash.\n * Must run before any code that might use PerformanceObserver.\n */\nexport function applyPerformanceObserverPolyfill(): void {\n  if (Platform.OS !== 'ios') {\n    return;\n  }\n\n  const record = globalObj as Record<string, unknown>;\n  const existing = record['PerformanceObserver'];\n  if (existing && (existing as unknown as { name?: string }).name === 'NoopPerformanceObserver') {\n    return; // Already applied\n  }\n\n  try {\n    record['PerformanceObserver'] = NoopPerformanceObserver;\n  } catch {\n    // Ignore if global is frozen (e.g. in some test environments)\n  }\n}\n"]}
+{"version":3,"file":"performanceObserverPolyfill.js","sourceRoot":"","sources":["../../../src/util/performanceObserverPolyfill.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;AAqEH,4EAkBC;AArFD,6CAAwC;AAExC,IAAM,SAAS,GACb,CAAC,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC;IACjD,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,EAAE,CAAC;AAEL,IAAM,mBAAmB,GAAG,UAAU,CAAC;AACvC,IAAM,0BAA0B,GAAG,2BAA2B,CAAC;AAqB/D;;;GAGG;AACH;IACE,iCACE,SAIS;QAET,+DAA+D;IACjE,CAAC;IAED,yCAAO,GAAP,UAAQ,QAAkC;QACxC,QAAQ;IACV,CAAC;IAED,4CAAU,GAAV;QACE,QAAQ;IACV,CAAC;IAED,6CAAW,GAAX;QACE,OAAO,EAAE,CAAC;IACZ,CAAC;IAEe,2CAAmB,GAAa,EAAE,CAAC;IACrD,8BAAC;CAAA,AAxBD,IAwBC;AAED;;;;;;GAMG;AACH,SAAgB,gCAAgC;IAC9C,IAAM,MAAM,GAAG,SAAoC,CAAC;IACpD,oCAAoC,CAAC,MAAM,CAAC,CAAC;IAE7C,IAAI,uBAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,IAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC/C,IAAI,QAAQ,IAAK,QAAyC,CAAC,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC9F,OAAO,CAAC,kBAAkB;IAC5B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,uBAAuB,CAAC;IAC1D,CAAC;IAAC,WAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;AACH,CAAC;AAED,SAAS,oCAAoC,CAAC,MAA+B;IAC3E,IAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAI3B,CAAC;IAEd,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAA,IAAI,WAAW,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC/F,OAAO;IACT,CAAC;IAED,IAAM,wBAAwB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChF,IAAM,uBAAuB,GAAG,CAAC,UAAC,SAAiB;QACjD,IAAI,SAAS,KAAK,mBAAmB,EAAE,CAAC;YACtC,sEAAsE;YACtE,2EAA2E;YAC3E,kEAAkE;YAClE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC,CAAwC,CAAC;IAE1C,uBAAuB,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC;IAE3D,IAAI,CAAC;QACH,WAAW,CAAC,gBAAgB,GAAG,uBAAuB,CAAC;IACzD,CAAC;IAAC,WAAM,CAAC;QACP,oEAAoE;IACtE,CAAC;AACH,CAAC","sourcesContent":["/**\n * PerformanceObserver polyfill for React Native iOS\n *\n * React Native 0.84's native PerformanceObserver has a bug on iOS that throws\n * `bad_variant_access` when the observer callback runs and calls getEntries().\n * This happens in NativePerformance.createObserver when the native bridge\n * returns data that causes a C++ variant access error.\n *\n * OpenTelemetry's FetchInstrumentation (and other libs) may use PerformanceObserver\n * for resource timing. We provide a no-op polyfill on React Native iOS to prevent\n * the crash while preserving refresh rate vitals and other functionality.\n *\n * @see https://github.com/facebook/react-native/issues (PerformanceObserver iOS)\n */\n\nimport { Platform } from 'react-native';\n\nconst globalObj =\n  (typeof globalThis !== 'undefined' && globalThis) ||\n  (typeof global !== 'undefined' && global) ||\n  (typeof window !== 'undefined' && window) ||\n  {};\n\nconst RESOURCE_ENTRY_TYPE = 'resource';\nconst FARO_RESOURCE_TIMING_PATCH = '__faroResourceTimingPatch';\n\ninterface PerformanceEntry {\n  readonly duration: number;\n  readonly entryType: string;\n  readonly name: string;\n  readonly startTime: number;\n}\n\ninterface PerformanceObserverEntryList {\n  getEntries(): PerformanceEntry[];\n  getEntriesByName(name: string, type?: string): PerformanceEntry[];\n  getEntriesByType(type: string): PerformanceEntry[];\n}\n\ninterface PerformanceObserverInit {\n  entryTypes?: string[];\n  type?: string;\n  buffered?: boolean;\n}\n\n/**\n * No-op PerformanceObserver that matches the Web API interface.\n * Prevents crashes when React Native's native implementation throws.\n */\nclass NoopPerformanceObserver {\n  constructor(\n    _callback: (\n      list: PerformanceObserverEntryList,\n      observer: NoopPerformanceObserver,\n      options?: PerformanceObserverInit\n    ) => void\n  ) {\n    // Callback is never invoked - avoids triggering the native bug\n  }\n\n  observe(_options?: PerformanceObserverInit): void {\n    // No-op\n  }\n\n  disconnect(): void {\n    // No-op\n  }\n\n  takeRecords(): PerformanceEntry[] {\n    return [];\n  }\n\n  static readonly supportedEntryTypes: string[] = [];\n}\n\n/**\n * Apply React Native performance API compatibility patches.\n *\n * Resource Timing lookup is patched on all platforms because OTel web\n * instrumentation can probe it. The PerformanceObserver replacement is\n * iOS-only to avoid the native bad_variant_access crash.\n */\nexport function applyPerformanceObserverPolyfill(): void {\n  const record = globalObj as Record<string, unknown>;\n  patchUnsupportedResourceTimingLookup(record);\n\n  if (Platform.OS !== 'ios') {\n    return;\n  }\n\n  const existing = record['PerformanceObserver'];\n  if (existing && (existing as unknown as { name?: string }).name === 'NoopPerformanceObserver') {\n    return; // Already applied\n  }\n\n  try {\n    record['PerformanceObserver'] = NoopPerformanceObserver;\n  } catch {\n    // Ignore if global is frozen (e.g. in some test environments)\n  }\n}\n\nfunction patchUnsupportedResourceTimingLookup(record: Record<string, unknown>): void {\n  const performance = record['performance'] as\n    | {\n        getEntriesByType?: ((entryType: string) => PerformanceEntry[]) & Record<string, boolean>;\n      }\n    | undefined;\n\n  if (!performance?.getEntriesByType || performance.getEntriesByType[FARO_RESOURCE_TIMING_PATCH]) {\n    return;\n  }\n\n  const originalGetEntriesByType = performance.getEntriesByType.bind(performance);\n  const patchedGetEntriesByType = ((entryType: string): PerformanceEntry[] => {\n    if (entryType === RESOURCE_ENTRY_TYPE) {\n      // OTel web fetch instrumentation probes browser Resource Timing APIs.\n      // React Native does not expose resource entries, and calling through emits\n      // \"Deprecated API for given entry type.\" warnings in development.\n      return [];\n    }\n\n    return originalGetEntriesByType(entryType);\n  }) as typeof performance.getEntriesByType;\n\n  patchedGetEntriesByType[FARO_RESOURCE_TIMING_PATCH] = true;\n\n  try {\n    performance.getEntriesByType = patchedGetEntriesByType;\n  } catch {\n    // Ignore if performance is read-only in a test or host environment.\n  }\n}\n"]}

package/dist/esm/generated/faroRNPackageMeta.js

@@ -2,5 +2,5 @@
  * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.
  */
 export const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native';
-export const FARO_REACT_NATIVE_NPM_VERSION = '1.0.0';
+export const FARO_REACT_NATIVE_NPM_VERSION = '1.1.0';
 //# sourceMappingURL=faroRNPackageMeta.js.map

package/dist/esm/generated/faroRNPackageMeta.js.map

@@ -1 +1 @@
-{"version":3,"file":"faroRNPackageMeta.js","sourceRoot":"","sources":["../../../src/generated/faroRNPackageMeta.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,4BAAqC,CAAC;AAChF,MAAM,CAAC,MAAM,6BAA6B,GAAG,OAAgB,CAAC","sourcesContent":["/**\n * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.\n */\nexport const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native' as const;\nexport const FARO_REACT_NATIVE_NPM_VERSION = '1.0.0' as const;\n"]}
+{"version":3,"file":"faroRNPackageMeta.js","sourceRoot":"","sources":["../../../src/generated/faroRNPackageMeta.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,4BAAqC,CAAC;AAChF,MAAM,CAAC,MAAM,6BAA6B,GAAG,OAAgB,CAAC","sourcesContent":["/**\n * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.\n */\nexport const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native' as const;\nexport const FARO_REACT_NATIVE_NPM_VERSION = '1.1.0' as const;\n"]}

package/dist/esm/util/performanceObserverPolyfill.js

@@ -17,6 +17,8 @@ const globalObj = (typeof globalThis !== 'undefined' && globalThis) ||
     (typeof global !== 'undefined' && global) ||
     (typeof window !== 'undefined' && window) ||
     {};
+const RESOURCE_ENTRY_TYPE = 'resource';
+const FARO_RESOURCE_TIMING_PATCH = '__faroResourceTimingPatch';
 /**
  * No-op PerformanceObserver that matches the Web API interface.
  * Prevents crashes when React Native's native implementation throws.
@@ -37,14 +39,18 @@ class NoopPerformanceObserver {
 }
 NoopPerformanceObserver.supportedEntryTypes = [];
 /**
- * Apply polyfill on React Native iOS to prevent bad_variant_access crash.
- * Must run before any code that might use PerformanceObserver.
+ * Apply React Native performance API compatibility patches.
+ *
+ * Resource Timing lookup is patched on all platforms because OTel web
+ * instrumentation can probe it. The PerformanceObserver replacement is
+ * iOS-only to avoid the native bad_variant_access crash.
  */
 export function applyPerformanceObserverPolyfill() {
+    const record = globalObj;
+    patchUnsupportedResourceTimingLookup(record);
     if (Platform.OS !== 'ios') {
         return;
     }
-    const record = globalObj;
     const existing = record['PerformanceObserver'];
     if (existing && existing.name === 'NoopPerformanceObserver') {
         return; // Already applied
@@ -56,4 +62,27 @@ export function applyPerformanceObserverPolyfill() {
         // Ignore if global is frozen (e.g. in some test environments)
     }
 }
+function patchUnsupportedResourceTimingLookup(record) {
+    const performance = record['performance'];
+    if (!(performance === null || performance === void 0 ? void 0 : performance.getEntriesByType) || performance.getEntriesByType[FARO_RESOURCE_TIMING_PATCH]) {
+        return;
+    }
+    const originalGetEntriesByType = performance.getEntriesByType.bind(performance);
+    const patchedGetEntriesByType = ((entryType) => {
+        if (entryType === RESOURCE_ENTRY_TYPE) {
+            // OTel web fetch instrumentation probes browser Resource Timing APIs.
+            // React Native does not expose resource entries, and calling through emits
+            // "Deprecated API for given entry type." warnings in development.
+            return [];
+        }
+        return originalGetEntriesByType(entryType);
+    });
+    patchedGetEntriesByType[FARO_RESOURCE_TIMING_PATCH] = true;
+    try {
+        performance.getEntriesByType = patchedGetEntriesByType;
+    }
+    catch (_a) {
+        // Ignore if performance is read-only in a test or host environment.
+    }
+}
 //# sourceMappingURL=performanceObserverPolyfill.js.map

package/dist/esm/util/performanceObserverPolyfill.js.map

@@ -1 +1 @@
-{"version":3,"file":"performanceObserverPolyfill.js","sourceRoot":"","sources":["../../../src/util/performanceObserverPolyfill.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,MAAM,SAAS,GACb,CAAC,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC;IACjD,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,EAAE,CAAC;AAqBL;;;GAGG;AACH,MAAM,uBAAuB;IAC3B,YACE,SAIS;QAET,+DAA+D;IACjE,CAAC;IAED,OAAO,CAAC,QAAkC;QACxC,QAAQ;IACV,CAAC;IAED,UAAU;QACR,QAAQ;IACV,CAAC;IAED,WAAW;QACT,OAAO,EAAE,CAAC;IACZ,CAAC;;AAEe,2CAAmB,GAAa,EAAE,CAAC;AAGrD;;;GAGG;AACH,MAAM,UAAU,gCAAgC;IAC9C,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,SAAoC,CAAC;IACpD,MAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC/C,IAAI,QAAQ,IAAK,QAAyC,CAAC,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC9F,OAAO,CAAC,kBAAkB;IAC5B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,uBAAuB,CAAC;IAC1D,CAAC;IAAC,WAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;AACH,CAAC","sourcesContent":["/**\n * PerformanceObserver polyfill for React Native iOS\n *\n * React Native 0.84's native PerformanceObserver has a bug on iOS that throws\n * `bad_variant_access` when the observer callback runs and calls getEntries().\n * This happens in NativePerformance.createObserver when the native bridge\n * returns data that causes a C++ variant access error.\n *\n * OpenTelemetry's FetchInstrumentation (and other libs) may use PerformanceObserver\n * for resource timing. We provide a no-op polyfill on React Native iOS to prevent\n * the crash while preserving refresh rate vitals and other functionality.\n *\n * @see https://github.com/facebook/react-native/issues (PerformanceObserver iOS)\n */\n\nimport { Platform } from 'react-native';\n\nconst globalObj =\n  (typeof globalThis !== 'undefined' && globalThis) ||\n  (typeof global !== 'undefined' && global) ||\n  (typeof window !== 'undefined' && window) ||\n  {};\n\ninterface PerformanceEntry {\n  readonly duration: number;\n  readonly entryType: string;\n  readonly name: string;\n  readonly startTime: number;\n}\n\ninterface PerformanceObserverEntryList {\n  getEntries(): PerformanceEntry[];\n  getEntriesByName(name: string, type?: string): PerformanceEntry[];\n  getEntriesByType(type: string): PerformanceEntry[];\n}\n\ninterface PerformanceObserverInit {\n  entryTypes?: string[];\n  type?: string;\n  buffered?: boolean;\n}\n\n/**\n * No-op PerformanceObserver that matches the Web API interface.\n * Prevents crashes when React Native's native implementation throws.\n */\nclass NoopPerformanceObserver {\n  constructor(\n    _callback: (\n      list: PerformanceObserverEntryList,\n      observer: NoopPerformanceObserver,\n      options?: PerformanceObserverInit\n    ) => void\n  ) {\n    // Callback is never invoked - avoids triggering the native bug\n  }\n\n  observe(_options?: PerformanceObserverInit): void {\n    // No-op\n  }\n\n  disconnect(): void {\n    // No-op\n  }\n\n  takeRecords(): PerformanceEntry[] {\n    return [];\n  }\n\n  static readonly supportedEntryTypes: string[] = [];\n}\n\n/**\n * Apply polyfill on React Native iOS to prevent bad_variant_access crash.\n * Must run before any code that might use PerformanceObserver.\n */\nexport function applyPerformanceObserverPolyfill(): void {\n  if (Platform.OS !== 'ios') {\n    return;\n  }\n\n  const record = globalObj as Record<string, unknown>;\n  const existing = record['PerformanceObserver'];\n  if (existing && (existing as unknown as { name?: string }).name === 'NoopPerformanceObserver') {\n    return; // Already applied\n  }\n\n  try {\n    record['PerformanceObserver'] = NoopPerformanceObserver;\n  } catch {\n    // Ignore if global is frozen (e.g. in some test environments)\n  }\n}\n"]}
+{"version":3,"file":"performanceObserverPolyfill.js","sourceRoot":"","sources":["../../../src/util/performanceObserverPolyfill.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,MAAM,SAAS,GACb,CAAC,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC;IACjD,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC;IACzC,EAAE,CAAC;AAEL,MAAM,mBAAmB,GAAG,UAAU,CAAC;AACvC,MAAM,0BAA0B,GAAG,2BAA2B,CAAC;AAqB/D;;;GAGG;AACH,MAAM,uBAAuB;IAC3B,YACE,SAIS;QAET,+DAA+D;IACjE,CAAC;IAED,OAAO,CAAC,QAAkC;QACxC,QAAQ;IACV,CAAC;IAED,UAAU;QACR,QAAQ;IACV,CAAC;IAED,WAAW;QACT,OAAO,EAAE,CAAC;IACZ,CAAC;;AAEe,2CAAmB,GAAa,EAAE,CAAC;AAGrD;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC;IAC9C,MAAM,MAAM,GAAG,SAAoC,CAAC;IACpD,oCAAoC,CAAC,MAAM,CAAC,CAAC;IAE7C,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC/C,IAAI,QAAQ,IAAK,QAAyC,CAAC,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC9F,OAAO,CAAC,kBAAkB;IAC5B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,uBAAuB,CAAC;IAC1D,CAAC;IAAC,WAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;AACH,CAAC;AAED,SAAS,oCAAoC,CAAC,MAA+B;IAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAI3B,CAAC;IAEd,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAA,IAAI,WAAW,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC/F,OAAO;IACT,CAAC;IAED,MAAM,wBAAwB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChF,MAAM,uBAAuB,GAAG,CAAC,CAAC,SAAiB,EAAsB,EAAE;QACzE,IAAI,SAAS,KAAK,mBAAmB,EAAE,CAAC;YACtC,sEAAsE;YACtE,2EAA2E;YAC3E,kEAAkE;YAClE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC,CAAwC,CAAC;IAE1C,uBAAuB,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC;IAE3D,IAAI,CAAC;QACH,WAAW,CAAC,gBAAgB,GAAG,uBAAuB,CAAC;IACzD,CAAC;IAAC,WAAM,CAAC;QACP,oEAAoE;IACtE,CAAC;AACH,CAAC","sourcesContent":["/**\n * PerformanceObserver polyfill for React Native iOS\n *\n * React Native 0.84's native PerformanceObserver has a bug on iOS that throws\n * `bad_variant_access` when the observer callback runs and calls getEntries().\n * This happens in NativePerformance.createObserver when the native bridge\n * returns data that causes a C++ variant access error.\n *\n * OpenTelemetry's FetchInstrumentation (and other libs) may use PerformanceObserver\n * for resource timing. We provide a no-op polyfill on React Native iOS to prevent\n * the crash while preserving refresh rate vitals and other functionality.\n *\n * @see https://github.com/facebook/react-native/issues (PerformanceObserver iOS)\n */\n\nimport { Platform } from 'react-native';\n\nconst globalObj =\n  (typeof globalThis !== 'undefined' && globalThis) ||\n  (typeof global !== 'undefined' && global) ||\n  (typeof window !== 'undefined' && window) ||\n  {};\n\nconst RESOURCE_ENTRY_TYPE = 'resource';\nconst FARO_RESOURCE_TIMING_PATCH = '__faroResourceTimingPatch';\n\ninterface PerformanceEntry {\n  readonly duration: number;\n  readonly entryType: string;\n  readonly name: string;\n  readonly startTime: number;\n}\n\ninterface PerformanceObserverEntryList {\n  getEntries(): PerformanceEntry[];\n  getEntriesByName(name: string, type?: string): PerformanceEntry[];\n  getEntriesByType(type: string): PerformanceEntry[];\n}\n\ninterface PerformanceObserverInit {\n  entryTypes?: string[];\n  type?: string;\n  buffered?: boolean;\n}\n\n/**\n * No-op PerformanceObserver that matches the Web API interface.\n * Prevents crashes when React Native's native implementation throws.\n */\nclass NoopPerformanceObserver {\n  constructor(\n    _callback: (\n      list: PerformanceObserverEntryList,\n      observer: NoopPerformanceObserver,\n      options?: PerformanceObserverInit\n    ) => void\n  ) {\n    // Callback is never invoked - avoids triggering the native bug\n  }\n\n  observe(_options?: PerformanceObserverInit): void {\n    // No-op\n  }\n\n  disconnect(): void {\n    // No-op\n  }\n\n  takeRecords(): PerformanceEntry[] {\n    return [];\n  }\n\n  static readonly supportedEntryTypes: string[] = [];\n}\n\n/**\n * Apply React Native performance API compatibility patches.\n *\n * Resource Timing lookup is patched on all platforms because OTel web\n * instrumentation can probe it. The PerformanceObserver replacement is\n * iOS-only to avoid the native bad_variant_access crash.\n */\nexport function applyPerformanceObserverPolyfill(): void {\n  const record = globalObj as Record<string, unknown>;\n  patchUnsupportedResourceTimingLookup(record);\n\n  if (Platform.OS !== 'ios') {\n    return;\n  }\n\n  const existing = record['PerformanceObserver'];\n  if (existing && (existing as unknown as { name?: string }).name === 'NoopPerformanceObserver') {\n    return; // Already applied\n  }\n\n  try {\n    record['PerformanceObserver'] = NoopPerformanceObserver;\n  } catch {\n    // Ignore if global is frozen (e.g. in some test environments)\n  }\n}\n\nfunction patchUnsupportedResourceTimingLookup(record: Record<string, unknown>): void {\n  const performance = record['performance'] as\n    | {\n        getEntriesByType?: ((entryType: string) => PerformanceEntry[]) & Record<string, boolean>;\n      }\n    | undefined;\n\n  if (!performance?.getEntriesByType || performance.getEntriesByType[FARO_RESOURCE_TIMING_PATCH]) {\n    return;\n  }\n\n  const originalGetEntriesByType = performance.getEntriesByType.bind(performance);\n  const patchedGetEntriesByType = ((entryType: string): PerformanceEntry[] => {\n    if (entryType === RESOURCE_ENTRY_TYPE) {\n      // OTel web fetch instrumentation probes browser Resource Timing APIs.\n      // React Native does not expose resource entries, and calling through emits\n      // \"Deprecated API for given entry type.\" warnings in development.\n      return [];\n    }\n\n    return originalGetEntriesByType(entryType);\n  }) as typeof performance.getEntriesByType;\n\n  patchedGetEntriesByType[FARO_RESOURCE_TIMING_PATCH] = true;\n\n  try {\n    performance.getEntriesByType = patchedGetEntriesByType;\n  } catch {\n    // Ignore if performance is read-only in a test or host environment.\n  }\n}\n"]}

package/dist/types/generated/faroRNPackageMeta.d.ts

@@ -2,4 +2,4 @@
  * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.
  */
 export declare const FARO_REACT_NATIVE_NPM_NAME: "@grafana/faro-react-native";
-export declare const FARO_REACT_NATIVE_NPM_VERSION: "1.0.0";
+export declare const FARO_REACT_NATIVE_NPM_VERSION: "1.1.0";

package/dist/types/util/performanceObserverPolyfill.d.ts

@@ -13,7 +13,10 @@
  * @see https://github.com/facebook/react-native/issues (PerformanceObserver iOS)
  */
 /**
- * Apply polyfill on React Native iOS to prevent bad_variant_access crash.
- * Must run before any code that might use PerformanceObserver.
+ * Apply React Native performance API compatibility patches.
+ *
+ * Resource Timing lookup is patched on all platforms because OTel web
+ * instrumentation can probe it. The PerformanceObserver replacement is
+ * iOS-only to avoid the native bad_variant_access crash.
  */
 export declare function applyPerformanceObserverPolyfill(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-react-native",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Faro instrumentations, metas, transports for React Native.",
   "keywords": [
     "observability",
@@ -87,5 +87,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "00172e294e05bcf2faa2193d01aabc43c3cc8134"
+  "gitHead": "8ca367978d53ef163886a2e99690c6f8a61416dc"
 }

package/src/generated/faroRNPackageMeta.ts

@@ -2,4 +2,4 @@
  * NPM package identity for this build. Generated by scripts/sync-faro-rn-package-meta.mjs - do not edit.
  */
 export const FARO_REACT_NATIVE_NPM_NAME = '@grafana/faro-react-native' as const;
-export const FARO_REACT_NATIVE_NPM_VERSION = '1.0.0' as const;
+export const FARO_REACT_NATIVE_NPM_VERSION = '1.1.0' as const;

package/src/util/performanceObserverPolyfill.test.ts

@@ -0,0 +1,48 @@
+import { applyPerformanceObserverPolyfill } from './performanceObserverPolyfill';
+
+describe('applyPerformanceObserverPolyfill', () => {
+  const originalPerformance = global.performance;
+  const originalPerformanceObserver = global.PerformanceObserver;
+
+  afterEach(() => {
+    Object.defineProperty(global, 'performance', {
+      configurable: true,
+      value: originalPerformance,
+      writable: true,
+    });
+    Object.defineProperty(global, 'PerformanceObserver', {
+      configurable: true,
+      value: originalPerformanceObserver,
+      writable: true,
+    });
+  });
+
+  it('returns an empty list for unsupported resource timing lookups', () => {
+    const getEntriesByType = jest.fn(() => [{ entryType: 'mark', name: 'test' }]);
+    Object.defineProperty(global, 'performance', {
+      configurable: true,
+      value: { getEntriesByType },
+      writable: true,
+    });
+
+    applyPerformanceObserverPolyfill();
+
+    expect(global.performance.getEntriesByType('resource')).toEqual([]);
+    expect(getEntriesByType).not.toHaveBeenCalledWith('resource');
+  });
+
+  it('delegates non-resource timing lookups to the original implementation', () => {
+    const markEntry = { entryType: 'mark', name: 'test' };
+    const getEntriesByType = jest.fn(() => [markEntry]);
+    Object.defineProperty(global, 'performance', {
+      configurable: true,
+      value: { getEntriesByType },
+      writable: true,
+    });
+
+    applyPerformanceObserverPolyfill();
+
+    expect(global.performance.getEntriesByType('mark')).toEqual([markEntry]);
+    expect(getEntriesByType).toHaveBeenCalledWith('mark');
+  });
+});

package/src/util/performanceObserverPolyfill.ts

@@ -21,6 +21,9 @@ const globalObj =
   (typeof window !== 'undefined' && window) ||
   {};
 
+const RESOURCE_ENTRY_TYPE = 'resource';
+const FARO_RESOURCE_TIMING_PATCH = '__faroResourceTimingPatch';
+
 interface PerformanceEntry {
   readonly duration: number;
   readonly entryType: string;
@@ -71,15 +74,20 @@ class NoopPerformanceObserver {
 }
 
 /**
- * Apply polyfill on React Native iOS to prevent bad_variant_access crash.
- * Must run before any code that might use PerformanceObserver.
+ * Apply React Native performance API compatibility patches.
+ *
+ * Resource Timing lookup is patched on all platforms because OTel web
+ * instrumentation can probe it. The PerformanceObserver replacement is
+ * iOS-only to avoid the native bad_variant_access crash.
  */
 export function applyPerformanceObserverPolyfill(): void {
+  const record = globalObj as Record<string, unknown>;
+  patchUnsupportedResourceTimingLookup(record);
+
   if (Platform.OS !== 'ios') {
     return;
   }
 
-  const record = globalObj as Record<string, unknown>;
   const existing = record['PerformanceObserver'];
   if (existing && (existing as unknown as { name?: string }).name === 'NoopPerformanceObserver') {
     return; // Already applied
@@ -91,3 +99,35 @@ export function applyPerformanceObserverPolyfill(): void {
     // Ignore if global is frozen (e.g. in some test environments)
   }
 }
+
+function patchUnsupportedResourceTimingLookup(record: Record<string, unknown>): void {
+  const performance = record['performance'] as
+    | {
+        getEntriesByType?: ((entryType: string) => PerformanceEntry[]) & Record<string, boolean>;
+      }
+    | undefined;
+
+  if (!performance?.getEntriesByType || performance.getEntriesByType[FARO_RESOURCE_TIMING_PATCH]) {
+    return;
+  }
+
+  const originalGetEntriesByType = performance.getEntriesByType.bind(performance);
+  const patchedGetEntriesByType = ((entryType: string): PerformanceEntry[] => {
+    if (entryType === RESOURCE_ENTRY_TYPE) {
+      // OTel web fetch instrumentation probes browser Resource Timing APIs.
+      // React Native does not expose resource entries, and calling through emits
+      // "Deprecated API for given entry type." warnings in development.
+      return [];
+    }
+
+    return originalGetEntriesByType(entryType);
+  }) as typeof performance.getEntriesByType;
+
+  patchedGetEntriesByType[FARO_RESOURCE_TIMING_PATCH] = true;
+
+  try {
+    performance.getEntriesByType = patchedGetEntriesByType;
+  } catch {
+    // Ignore if performance is read-only in a test or host environment.
+  }
+}