@scalebun/react-native 1.13.0 → 2.0.1

package/lib/module/features/journey/uiState.js

@@ -49,7 +49,10 @@ const clean = s => typeof s === 'string' ? s.replace(/[;:|]/g, '').trim().slice(
 export function setUiState(name, value) {
   const n = clean(name);
   const v = clean(value);
-  if (n && v) declared.set(n, v);
+  if (!n || !v) return;
+  if (declared.get(n) === v) return;
+  declared.set(n, v);
+  notifyChanged();
 }
 
 /**
@@ -61,7 +64,9 @@ export function setUiState(name, value) {
  * screen.
  */
 export function clearUiState(name) {
+  const before = declared.size;
   if (name === undefined) declared.clear();else declared.delete(clean(name));
+  if (declared.size !== before) notifyChanged();
 }
 
 /**
@@ -83,4 +88,76 @@ export function uiStateSignature() {
   }
   return signature || undefined;
 }
+
+/**
+ * RN-11 — TELL SOMEONE THE STATE CHANGED, so a frame can exist for it.
+ *
+ * THE GAP. Declaring a state used to mutate a Map and nothing else. Nothing captured a frame, so
+ * the visual for a declared state existed only if a screenshot happened to be taken for some other
+ * reason — a navigation, a timer, or the interaction capture that fires AFTER the touch and
+ * photographs the outcome. A state could therefore be recorded as a fact with no picture of it
+ * anywhere, or with a picture of the state that replaced it.
+ *
+ * The native capture reasons are NAVIGATION, MANUAL, INTERACTION and TIMER. None of them is "the
+ * UI changed shape", which is exactly the moment a heatmap needs a frame.
+ *
+ * FIRING ON A REAL CHANGE ONLY, AND WHY THAT IS THE SDK'S JOB. The advice above says to call
+ * `setUiState` when the state changes rather than on every render — but that is advice to the
+ * host, not a guarantee. A component that declares its state inside render is ordinary React, and
+ * trusting the caller would mean a screenshot per render: a performance disaster in exactly the
+ * apps that instrument most carefully. So a redundant set — same dimension, same value — is now a
+ * no-op, and the change test lives here where it cannot be got wrong by a host.
+ *
+ * COALESCED, because a transition usually declares several dimensions in one tick ("drawer:open"
+ * and "overlay:visible" belong to one visual change). Notifying per call would capture the
+ * intermediate shapes, which are states the user never saw.
+ *
+ * The listener is deliberately NOT given the signature. A subscriber that wants it calls
+ * `uiStateSignature()` at the moment it acts, which is the value that will actually be attached
+ * to the next tap; handing over a snapshot invites acting on a state that has already moved on.
+ */
+
+const listeners = new Set();
+let pending = null;
+
+/**
+ * Subscribe to declared-state changes. Returns an unsubscribe.
+ *
+ * Registration is idempotent per function reference, so a component that re-subscribes on every
+ * render does not accumulate listeners — a leak that would only show up in long sessions.
+ */
+export function onUiStateChange(listener) {
+  listeners.add(listener);
+  return () => {
+    listeners.delete(listener);
+  };
+}
+
+/** Drop every listener and any pending notification. For teardown between sessions. */
+export function resetUiStateListeners() {
+  listeners.clear();
+  if (pending !== null) {
+    clearTimeout(pending);
+    pending = null;
+  }
+}
+
+/** For assertions that a re-subscribing caller has not leaked. */
+export function uiStateListenerCount() {
+  return listeners.size;
+}
+function notifyChanged() {
+  if (pending !== null) return;
+  pending = setTimeout(() => {
+    pending = null;
+    for (const listener of listeners) {
+      try {
+        listener();
+      } catch {
+        /* One bad subscriber must not stop the others, and must never surface to the host: a
+           screenshot is not worth an app crash. */
+      }
+    }
+  }, 0);
+}
 //# sourceMappingURL=uiState.js.map

package/lib/module/features/navigation/AutoScreenDetector.js

@@ -36,6 +36,15 @@ export class AutoScreenDetector {
   _manualScreen = null;
   _manualScreenTs = 0;
   _autoScreen = null;
+  /**
+   * When `_autoScreen` was last written.
+   *
+   * Needed so `getCurrentScreen()` can prefer whichever source spoke MOST RECENTLY.
+   * Without a timestamp the only comparison available was "is the manual value still
+   * fresh", which is a different question and gave the wrong answer — see the note on
+   * `_currentScreen()`.
+   */
+  _autoScreenTs = 0;
   /** `name#key` of the last auto-detected screen VISIT — see _extractActiveVisit. */
   _autoVisitSig = null;
   _navigationRef = null;
@@ -110,6 +119,7 @@ export class AutoScreenDetector {
       if (this.isManualScreenActive()) return;
       if (name !== this._autoScreen) {
         this._autoScreen = name;
+        this._autoScreenTs = Date.now();
         this._autoVisitSig = name; // native lifecycle carries no route key — name-only visit
         this._emitScreenChange(name, 'heuristic');
       }
@@ -117,8 +127,19 @@ export class AutoScreenDetector {
   }
 
   /**
-   * Check if a manual screen is currently active.
-   * Used by auto-detection to yield to manual overrides.
+   * Should a WRITER defer to the manual screen right now?
+   *
+   * THIS IS A PRECEDENCE GATE, NOT A VALIDITY TEST, and conflating the two was a real
+   * bug. Its job is what the cooldown constant says: for a short window after a manual
+   * beacon fires, an auto source must not overwrite it — the poller runs every 1500 ms
+   * and would otherwise clobber a fresh declaration with whatever it inferred.
+   *
+   * `getCurrentScreen()` used to reuse this as "is the manual screen still the current
+   * screen", which made a declared screen READABLE for only 2000 ms. Nothing called
+   * `setManualScreen` in production, so the effect was latent — but the moment the
+   * `<ScaleBunScreen>` beacon was wired to it (RN-8), every tap more than two seconds
+   * after a screen mounted would have lost its name, which is very nearly every tap. A
+   * fix that introduced that would have been worse than the gap it closed.
    */
   isManualScreenActive() {
     if (!this._manualScreen) return false;
@@ -178,6 +199,7 @@ export class AutoScreenDetector {
                   const visit = this._extractActiveVisit(state);
                   if (visit && this._visitSig(visit) !== this._autoVisitSig) {
                     this._autoScreen = visit.name;
+                    this._autoScreenTs = Date.now();
                     this._autoVisitSig = this._visitSig(visit);
                     this._emitScreenChange(visit.name, 'navRef');
                   }
@@ -196,6 +218,7 @@ export class AutoScreenDetector {
           const visit = this._extractActiveVisit(state);
           if (visit) {
             this._autoScreen = visit.name;
+            this._autoScreenTs = Date.now();
             this._autoVisitSig = this._visitSig(visit);
             this._emitScreenChange(visit.name, 'navRef');
           }
@@ -239,6 +262,7 @@ export class AutoScreenDetector {
             const visit = this._extractActiveVisit(state);
             if (visit && this._visitSig(visit) !== this._autoVisitSig) {
               this._autoScreen = visit.name;
+              this._autoScreenTs = Date.now();
               this._autoVisitSig = this._visitSig(visit);
               this._emitScreenChange(visit.name, 'heuristic');
             }
@@ -495,16 +519,61 @@ export class AutoScreenDetector {
     this._listeners = [];
     this._manualScreen = null;
     this._autoScreen = null;
+    this._autoScreenTs = 0;
     this._navigationRef = null;
     _instance = null;
   }
 
   /** Get the current best-known screen name */
   getCurrentScreen() {
-    if (this._manualScreen && this.isManualScreenActive()) {
-      return this._manualScreen;
+    return this._currentScreen().name;
+  }
+
+  /**
+   * WHERE the current screen name came from, or 'none'.
+   *
+   * Recorded on every interaction (RN-8) so low screen coverage is DIAGNOSABLE rather
+   * than merely visible. Production shows 13.8% of Android interactions carrying a
+   * screen and 0.5% on iOS, and those numbers cannot today distinguish three different
+   * causes: the app never instrumented anything, the app instrumented manually and the
+   * value never reached interactions, or auto-detection ran and failed. Those have
+   * different owners and different fixes, and guessing between them is how a P0 stays
+   * open.
+   */
+  getCurrentScreenSource() {
+    return this._currentScreen().source;
+  }
+
+  /**
+   * LAST WRITER WINS between the manual beacon and auto-detection.
+   *
+   * A screen declared by `<ScaleBunScreen name>` stays current until something else
+   * declares a different one — that is what mounting a screen means. It does not
+   * expire, which is the correction here: the previous rule returned the manual name
+   * only while it was under 2000 ms old and then silently fell back to the auto value,
+   * which in a manually-instrumented app is `null`.
+   *
+   * Comparing timestamps rather than hard-coding a priority also handles the real
+   * interleaving: an app can use React Navigation for most screens AND drop a manual
+   * beacon on one modal, and whichever spoke last is the truth.
+   */
+  _currentScreen() {
+    const manual = this._manualScreen;
+    const auto = this._autoScreen;
+    if (manual && (!auto || this._manualScreenTs >= this._autoScreenTs)) {
+      return {
+        name: manual,
+        source: 'manual'
+      };
     }
-    return this._autoScreen;
+    if (auto) return {
+      name: auto,
+      source: 'navigation'
+    };
+    return {
+      name: null,
+      source: 'none'
+    };
   }
 
   // ─── Internal ───────────────────────────────────────────────────────

package/lib/module/features/network/NetworkFeature.js

@@ -24,6 +24,7 @@
  */
 
 import { installNetworkMonitoring } from './index';
+import { isThirdPartyBeacon } from './thirdParty';
 import { reportNetworkRequest } from '../replay/integrations/network/networkAdapter';
 import { SessionManager } from '../session/SessionManager';
 import { getTrackedScreen } from '../../debug/screenTracking';
@@ -44,12 +45,28 @@ export class NetworkFeature {
       // self-capture loop. Apply the SAME isSdkInternalUrl filter the replay
       // branch below already uses so genuine app requests still flow through.
       const isInternal = isSdkInternalUrl(data.url, this.options.sdkBaseUrl);
-      if (!isInternal) {
+      /**
+       * Beacons and denied URLs leave NO trace, in any lane.
+       *
+       * A network request reaches three places from here: the analytics echo
+       * (`$network_request`), the local replay pipeline, and the backend network endpoint
+       * that becomes the `network_requests` row the session panel renders. Filtering one
+       * and not the others is how a request half-disappears and two counts of the same
+       * call stop agreeing -- so this is applied to all three.
+       *
+       * Kept separate from `isInternal` rather than folded into it: the SDK's own uploads
+       * are already excluded from two of the three lanes and DELIBERATELY still reach the
+       * local replay pipeline. Widening that here would be an unrelated behaviour change
+       * riding along on a filter.
+       */
+      const isBeaconOrDenied = this.options.captureThirdParty !== true && isThirdPartyBeacon(data.url, this.options.thirdPartyHosts) || matchesDenyUrl(data.url, this.options.denyUrls);
+      const isExcluded = isInternal || isBeaconOrDenied;
+      if (!isExcluded) {
         this.trackFn('$network_request', data);
       }
 
       // Bridge the raw network event into the Session Replay pipeline
-      if (data.type === 'network') {
+      if (data.type === 'network' && !isBeaconOrDenied) {
         reportNetworkRequest({
           method: data.method,
           url: data.url,
@@ -72,8 +89,10 @@ export class NetworkFeature {
         // (correlated by sessionId+timestamp), so we no longer emit
         // NETWORK_REQUEST_* replay events here (that produced duplicate rows
         // and count divergence between replay_events and network_requests).
-        // Skip SDK's own upload calls to prevent recursive event spam.
-        if (!isInternal) {
+        // Skip SDK's own upload calls to prevent recursive event spam, and anything the
+        // beacon/denyUrls filter excluded -- this is the lane that becomes the
+        // network_requests row a person sees on the session panel.
+        if (!isExcluded) {
           const sessionManager = SessionManager.getExistingInstance();
           if (sessionManager) {
             const backendTransport = sessionManager.getBackendTransport();
@@ -107,6 +126,21 @@ export class NetworkFeature {
   }
 }
 
+/**
+ * Substring or RegExp, the same rule as the web SDK's `matchUrl`.
+ *
+ * Spelled out rather than shared because the two SDKs have no common runtime package, and the
+ * rule is two lines. What must NOT differ is the beacon list, which is why that one is a
+ * byte-identical vendored copy with a hash gate rather than a retyped constant.
+ */
+function matchesDenyUrl(url, patterns) {
+  if (!patterns || !patterns.length || !url) return false;
+  for (const p of patterns) {
+    if (typeof p === 'string' ? url.includes(p) : p.test(url)) return true;
+  }
+  return false;
+}
+
 // Returns true if the URL is a ScaleBun SDK internal endpoint that must not be
 // captured — doing so would cause recursive network event spam.
 function isSdkInternalUrl(url, sdkBaseUrl) {

package/lib/module/features/network/thirdParty.js

@@ -0,0 +1,83 @@
+/**
+ * THIRD-PARTY BEACON HOSTS — the one list, and the one matcher, for every layer that drops them.
+ *
+ * WHAT THIS IS FOR
+ * A session on an instrumented site spends most of its network tab on traffic the app did not
+ * meaningfully make: analytics collectors, ad pixels, IP-enrichment calls, tag managers. It is
+ * captured, uploaded, stored and rendered, and none of it answers a question anyone asks a session
+ * replay. One real sign-in screen was 27 requests, most of them beacons.
+ *
+ * It is not only clutter. Session health scores `failedRequests` and `slowRequests`, so a tracker
+ * killed by an ad blocker (a transport error) or one that is simply slow moves a number that is
+ * supposed to describe the APP. That is the part that makes this a correctness fix rather than a
+ * tidy-up.
+ *
+ * WHY HOSTS ONLY, NEVER PATHS
+ * The obvious rules from looking at a network tab are `/collect`, `/p`, `/api/v2/pixel`. Every one
+ * of them is a path that a customer's own API is allowed to have, and dropping a real API call is
+ * far worse than keeping a beacon: the noise is visible and annoying, the missing request is
+ * invisible and misleading. So matching is on the HOSTNAME, with a dot boundary, and a request to
+ * `/collect` on the app's own origin is kept — correctly.
+ *
+ * WHY IT IS A SUFFIX LIST AND NOT A REGEX
+ * Two reasons, both practical. It is applied inside an SDK whose eager bundle is measured in bytes,
+ * and a comma-joined string of suffixes compresses to almost nothing next to an equivalent pattern
+ * source. And it has to be COPIED, byte for byte, into the React Native SDK and into the backend's
+ * ingest path — a list with no syntax is a list that cannot drift in meaning between three
+ * languages' worth of tooling. `third-party:parity` hashes all three copies.
+ *
+ * ZERO IMPORTS, DELIBERATELY. That is what makes the byte-identical copy possible. If an edit here
+ * ever needs an import, the parity gate is the thing that will say so — keep the module pure rather
+ * than weakening the gate.
+ *
+ * WHAT IS DELIBERATELY NOT ON THE LIST
+ * The rule is: a host whose ONLY purpose is to receive telemetry. Everything else stays, because a
+ * dropped request is invisible and a kept one is merely noisy.
+ *
+ *   - Feature-flag and experiment services (LaunchDarkly, Optimizely, Split). Their RESPONSES
+ *     change what the app does, so a failed flag fetch is an application incident and the single
+ *     most useful request in the session.
+ *   - Chat and support widgets (Intercom, Zendesk, Drift). A broken widget is a broken feature the
+ *     user can see.
+ *   - `facebook.com` as a whole. `graph.facebook.com` is an API real apps call; only the pixel
+ *     delivery hosts are listed.
+ *   - CDNs of any kind, even ones that mostly serve tags: they also serve application assets, and
+ *     dropping them would hide a real asset failure.
+ *
+ * When in doubt, leave it out. `denyUrls` stays the per-app escape hatch in both SDKs, and it can
+ * do what this list will not.
+ */
+
+/**
+ * Known telemetry, advertising and enrichment endpoints, as hostname suffixes.
+ *
+ * One comma-joined string rather than an array: identical meaning, materially smaller once gzipped,
+ * and it keeps the copy in three repos a single line to compare by eye.
+ */
+export const THIRD_PARTY_BEACON_HOSTS = 'google-analytics.com,googletagmanager.com,analytics.google.com,doubleclick.net,googlesyndication.com,' + 'googleadservices.com,app-measurement.com,facebook.net,analytics.tiktok.com,' + 'ads-twitter.com,analytics.twitter.com,ct.pinterest.com,bat.bing.com,px.ads.linkedin.com,tr.snapchat.com,' + 'criteo.com,criteo.net,taboola.com,outbrain.com,adroll.com,adsrvr.org,quantserve.com,scorecardresearch.com,' + 'hotjar.com,hotjar.io,clarity.ms,fullstory.com,mouseflow.com,crazyegg.com,luckyorange.com,inspectlet.com,' + 'segment.io,mixpanel.com,amplitude.com,heap.io,heapanalytics.com,rudderstack.com,posthog.com,' + 'matomo.cloud,plausible.io,simpleanalytics.com,statcounter.com,' + 'appsflyer.com,adjust.com,branch.io,' + 'ipify.org,ipinfo.io,ipapi.co,ip-api.com,geolocation-db.com,cloudflareinsights.com,' + 'nr-data.net,browser-intake-datadoghq.com,sentry.io,bugsnag.com,rollbar.com';
+
+/**
+ * True when `url` is addressed to a known beacon host.
+ *
+ * Deliberately total: an unparseable or relative URL is NOT third party. A relative URL is
+ * same-origin by definition — the app's own call — and guessing on garbage input would drop real
+ * requests for no benefit.
+ */
+export function isThirdPartyBeacon(url, hosts) {
+  if (!url) return false;
+  let host = '';
+  try {
+    // A relative URL throws here, which is the answer we want: it is first-party.
+    host = new URL(url).hostname.toLowerCase();
+  } catch {
+    return false;
+  }
+  if (!host) return false;
+  for (const suffix of (hosts ?? THIRD_PARTY_BEACON_HOSTS).split(',')) {
+    // Dot boundary, so `notevil-facebook.com` does not match `facebook.com` while
+    // `connect.facebook.com` does. The bare-equality arm covers the apex domain itself.
+    if (host === suffix || host.endsWith('.' + suffix)) return true;
+  }
+  return false;
+}
+//# sourceMappingURL=thirdParty.js.map