@keepsnappy/react-native 0.1.0-alpha.15 → 0.1.0-alpha.17

package/js/sdk/core.ts

@@ -1,6 +1,8 @@
 // keepsnappy core: settings, windows, the commit walk, observers, faults, logs.
 // Loaded by boot.ts, which Metro runs before the app's entry module.
 
+import { setPlaceLog } from './place';
+
 import {
   type ActivationStore,
   type Decision,
@@ -12,6 +14,8 @@ import {
 } from './activation';
 import {
   componentName,
+  clientKeyOf,
+  OUTSIDE_APP,
   type Fiber,
   type FiberRoot,
   isComponentTag,
@@ -66,6 +70,7 @@ import {
   type ProfiledFiber,
   type ProfiledRoot,
   recordFiber,
+  recordRolledUp,
   selfMs,
   summarizeWindowProfile,
   totalMs,
@@ -364,6 +369,8 @@ export const perfLog = (message: string, sink: LogSink = settings.log) => {
     }
   }
 };
+setPlaceLog(perfLog);
+
 
 // Requests started per window (fetch/XHR hooks in net-install.ts feed it).
 export const net = createNetCounter({ now, onStart: noteRequestSent });
@@ -466,8 +473,10 @@ interface OpenSampleState {
 // - so does a window that starts within OPEN_SAMPLE_TOLERANCE_MS of the close sample (restarted key);
 // - a window detected long after its t0 (a screen window opened by a press, seen after the new screen rendered) gets
 //   none: its bound is the press's open sample;
-// - else the sampler is asked to sample on its own thread.
-const openSampleFor = (id: number, t0: number): OpenSampleState => {
+// - else the sampler is asked to sample on its own thread. A press always is, however late its touch reached JS: with
+//   no window before it (after a GC command, the background or the flush) the sample before the touch can be seconds
+//   old, so its own sample, a negative lead past t0, is the closer bound.
+const openSampleFor = (id: number, t0: number, press: boolean): OpenSampleState => {
   const none = { openRecord: null, openPending: null };
   if (samplerState.mode === 'off') {
     return none;
@@ -480,7 +489,7 @@ const openSampleFor = (id: number, t0: number): OpenSampleState => {
   ) {
     return { openRecord: lastClose.record, openPending: null };
   }
-  if (now() - samplerState.offsetMs - t0Native > OPEN_SAMPLE_TOLERANCE_MS) {
+  if (!press && now() - samplerState.offsetMs - t0Native > OPEN_SAMPLE_TOLERANCE_MS) {
     return none;
   }
   const reason = `window-start:${id}`;
@@ -611,6 +620,8 @@ const diffStats = (
 export type WindowKind = 'marker' | 'press' | 'screen' | 'background';
 
 interface MarkerWindow {
+  legacyName: string | null;
+  beforeEnd: (() => void) | null;
   id: number;
   key: string;
   name: string;
@@ -839,9 +850,12 @@ export const lastCommitAt = (key: string) =>
 export const isWindowOpen = (key?: string) =>
   key ? openWindows.has(key) : openWindows.size > 0;
 
-const traceName = (name: string) => `keepsnappy:${name}`;
+const traceName = (name: string) => `keepsnappy:${name}`.slice(0, 120);
+const fileNamePart = (name: string) => name.replace(/[^\w.:+-]/g, '_').slice(0, 64);
 
 interface StartOptions {
+  legacyName?: string | null;
+  beforeEnd?: () => void;
   key?: string;
   kind?: WindowKind;
   // Backdates t0 (e.g. to the hardware touch time). performance.now() timebase.
@@ -879,6 +893,8 @@ const backgroundWindow = (source: string, t: number): MarkerWindow => {
     key: name,
     name,
     kind: 'background',
+    legacyName: null,
+    beforeEnd: null,
     trace: traceName(name),
     t0: t,
     t1: null,
@@ -924,7 +940,14 @@ const routeToBackground = (record: CommitRecord) => {
 
 // Segments written and not yet listed for upload (listed at the next flush).
 const pendingStreamFiles: WrittenFile[] = [];
-// A segment is cut at this many commits even between flushes, so a long stretch outside a run stays bounded.
+// What the run lost since the last flush, which reports it. Commit-stream segments that failed to write are missing data
+// (the backend splits work by cause from them). Kept React exports dropped at the run cap or not written, and stream fibers
+// past a segment's cap, leave every measured value complete: counted notes only.
+const runLosses = { stream: 0, exportsCapped: 0, exportsUnwritten: 0, streamFibersDropped: 0 };
+export const setStreamFiberCapForTest = (fibers: number) => commitStream.setMaxFibers(fibers);
+// A segment is cut at this many commits even between flushes, so a long stretch outside a run stays bounded. In a run
+// the cut waits while a window is open (no file I/O inside a measured window, REQ-MEAS-23): every window ends at the
+// flush, which cuts it, and a segment past its fiber cap keeps only the commits' facts.
 const MAX_SEGMENT_COMMITS = 5000;
 
 const cutStream = () => {
@@ -940,7 +963,10 @@ const cutStream = () => {
   }
   if (path) {
     pendingStreamFiles.push({ name: segment.name, windows: [], bytes: segment.json.length });
+  } else if (inRun()) {
+    runLosses.stream++;
   }
+  if (inRun()) runLosses.streamFibersDropped += segment.fibersDropped;
   perfLog(`stream ${JSON.stringify({ name: segment.name, commits: segment.commits, bytes: segment.json.length, fibersDropped: segment.fibersDropped, written: path !== null })}`);
 };
 
@@ -984,12 +1010,14 @@ const start = (name: string, options: StartOptions = {}) => {
   const statsStart = readHermesStats();
   const id = nextWindowId++;
   const startT = options.at ?? now();
-  const openSample = openSampleFor(id, startT);
+  const openSample = openSampleFor(id, startT, options.kind === 'press');
   const window: MarkerWindow = {
     id,
     key,
     name,
     kind: options.kind ?? 'marker',
+    legacyName: options.legacyName ?? null,
+    beforeEnd: options.beforeEnd ?? null,
     trace: traceName(name),
     t0: startT,
     t1: null,
@@ -1043,6 +1071,7 @@ const end = (key: string, reason = 'end', at?: number) => {
   if (!window) {
     return;
   }
+  window.beforeEnd?.();
   window.t1 = at ?? now();
   window.endReason = reason;
   openWindows.delete(key);
@@ -1086,8 +1115,9 @@ const endAll = (reason: string) => {
   }
 };
 
-const rename = (key: string, name: string) => {
+const rename = (key: string, name: string, legacyName?: string | null) => {
   const window = openWindows.get(key);
+  if (window && legacyName !== undefined) window.legacyName = legacyName;
   if (window && window.name !== name) {
     perfLog(`PERF_MARK ${window.name} renamed=${name} id=${window.id}`);
     window.name = name;
@@ -1135,30 +1165,43 @@ const walkCommit = (
   causes: CommitCauses,
 ) => {
   const stack: Fiber[] = [root.current];
+  const owners: string[] = [OUTSIDE_APP];
+  const parents: (string | null)[] = [null];
   const renders: Record<string, number> = {};
   let mounts = 0;
   let visited = 0;
   const ancestors = exported ? createAncestorPaths() : null;
   while (stack.length > 0) {
     const fiber = stack.pop() as Fiber;
+    const inherited = owners.pop() as string;
+    const inheritedParent = parents.pop() as string | null;
+    let owner = inherited, parentOfOwner = inheritedParent;
     visited++;
     const mounted = fiber.alternate === null;
     if (mounted) {
       noteMounted(fiber);
     }
     noteHostFiber(fiber, causes);
-    if (isComponentTag(fiber.tag) && (fiber.flags & PERFORMED_WORK) !== 0) {
+    const component = isComponentTag(fiber.tag);
+    const own = component ? clientKeyOf(fiber) : null;
+    if (own !== null) {
+      owner = own;
+      parentOfOwner = inherited === OUTSIDE_APP ? null : inherited;
+    }
+    if (component && (fiber.flags & PERFORMED_WORK) !== 0) {
       const name = componentName(fiber);
       renders[name] = (renders[name] ?? 0) + 1;
       if (mounted) {
         mounts++;
       }
-      if (profile || exported) {
+      if ((profile && own !== null) || exported) {
         const cause = updateCause(fiber as ProfiledFiber);
-        if (profile) {
-          recordFiber(profile, name, fiber as ProfiledFiber, cause, fiberId(fiber));
+        if (profile && own !== null) {
+          recordFiber(profile, own, fiber as ProfiledFiber, cause, fiberId(fiber), parentOfOwner);
         }
         if (exported) {
+          // Profiled exports assign the rendered id before fresh ancestor ids.
+          if (profile && own === null) fiberId(fiber);
           exported.fibers.push(
             exportFiber(
               fiber,
@@ -1167,10 +1210,14 @@ const walkCommit = (
               totalMs(fiber as ProfiledFiber),
               selfMs(fiber as ProfiledFiber),
               (ancestors as (f: Fiber) => number[])(fiber),
+              owner,
             ),
           );
         }
       }
+      if (profile && own === null) {
+        recordRolledUp(profile, inherited, inheritedParent, name, fiber as ProfiledFiber);
+      }
     }
     // Children not cloned in this render are the previous commit's fibers and
     // carry stale flags, so a bailed-out subtree is skipped entirely.
@@ -1180,6 +1227,8 @@ const walkCommit = (
     }
     for (let child = fiber.child; child !== null; child = child.sibling) {
       stack.push(child);
+      owners.push(owner);
+      parents.push(parentOfOwner);
     }
   }
   return { renders, mounts, visited };
@@ -1217,7 +1266,7 @@ const onCommitFiberRoot = (rendererId: number, root: FiberRoot) => {
     // The figure `profile.renderMs` reads; null when the renderer does not time commits.
     renderMs = isProfilingFiber(profiled.current) ? totalMs(profiled.current) : null;
     if (settings.profile) {
-      profile = createCommitProfile(profiled, seq);
+      profile = createCommitProfile(profiled, seq, t0);
     }
     // Only commits a window can take are exported (open now, or backfilled
     // into a window opened later with a backdated start).
@@ -1264,7 +1313,7 @@ const onCommitFiberRoot = (rendererId: number, root: FiberRoot) => {
   // Work no open window judges is the background of its source: pushes, and loops of earlier actions or of the launch.
   record.background = record.judged ? null : backgroundSource(causes);
   commitStream.noteCommit({ seq, t: t0, renderMs, causes, fibers: exported?.fibers ?? null, updaters: profile?.updaters ?? null });
-  if (commitStream.size() >= MAX_SEGMENT_COMMITS) {
+  if (commitStream.size() >= MAX_SEGMENT_COMMITS && !(inRun() && openWindows.size > 0)) {
     cutStream();
   }
   recordCommit(record);
@@ -1477,7 +1526,7 @@ const netForWindow = (window: MarkerWindow): NetWindow | null =>
   window.net ? net.windowClose(window.id) : null;
 
 const reactExportName = (window: MarkerWindow) =>
-  `react-${PROCESS_ID}-${window.id}-${window.name.replace(/[^\w.:+-]/g, '_')}.json`;
+  `react-${PROCESS_ID}-${window.id}-${fileNamePart(window.name)}.json`;
 
 interface PendingExport {
   name: string;
@@ -1488,7 +1537,12 @@ interface PendingExport {
 }
 
 // React exports held until flush (inside a run), capped like a window's.
-const MAX_PENDING_EXPORT_FIBERS = 400000;
+let maxPendingExportFibers = 400000;
+export const setPendingExportCapForTest = (fibers: number) => {
+  const previous = maxPendingExportFibers;
+  maxPendingExportFibers = fibers;
+  return previous;
+};
 const pendingExports: PendingExport[] = [];
 let pendingExportFibers = 0;
 
@@ -1509,7 +1563,8 @@ const writeReactExport = (window: MarkerWindow) => {
     truncated: window.exportTruncated,
   };
   if (inRun()) {
-    if (pendingExportFibers + window.exportFibers > MAX_PENDING_EXPORT_FIBERS) {
+    if (pendingExportFibers + window.exportFibers > maxPendingExportFibers) {
+      if (settings.diag || budgetBreaks.has(window.id)) runLosses.exportsCapped++;
       return { ...base, deferred: true, dropped: true };
     }
     pendingExports.push({
@@ -1586,6 +1641,7 @@ const writeDeferredFiles = (): ArtifactEntry[] => {
     } catch (error) {
       result = { error: String(error) };
     }
+    if (!result.path && (settings.diag || budgetBreaks.has(pending.window))) runLosses.exportsUnwritten++;
     perfLog(
       `rexport ${JSON.stringify({ name: pending.name, commits: pending.commits.length, fibers: pending.fibers, ...result })}`,
     );
@@ -1720,7 +1776,7 @@ const finalizeWindow = (window: MarkerWindow) => {
   // Sampler first: its records carry the display rate the frame budget needs.
   const sampler = samplerForWindow(window);
   const profile = window.profile
-    ? summarizeWindowProfile(window.profile, { budget: frameBudget })
+    ? summarizeWindowProfile(window.profile, { budget: frameBudget, t0: window.t0 })
     : null;
   const perf = settings.po ? summarizeEntries(window) : null;
   noteBudgetBreak(
@@ -1734,6 +1790,7 @@ const finalizeWindow = (window: MarkerWindow) => {
     windowModel: WINDOW_MODEL,
     id: window.id,
     name: window.name,
+    ...(window.legacyName !== null && window.legacyName !== window.name ? { legacyName: window.legacyName } : {}),
     kind: window.kind,
     t0: window.t0,
     t1: window.t1,
@@ -1799,7 +1856,7 @@ const writeWindowRecord = (window: MarkerWindow, summary: Record<string, unknown
   windowListener?.(`${Date.now()} KEEPSNAPPY window ${json}`);
   if (settings.file) {
     const path = getNative()?.writeText(
-      `window-${window.id}-${window.name.replace(/[^\w.:+-]/g, '_')}.json`,
+      `window-${window.id}-${fileNamePart(window.name)}.json`,
       json,
     );
     perfLog(`window file id=${window.id} path=${path ?? 'unavailable'}`);
@@ -1839,13 +1896,14 @@ const externalSummary = (window: MarkerWindow, timed: boolean) => {
 
 const finalizeBackground = (window: MarkerWindow) => {
   const profile = window.profile
-    ? summarizeWindowProfile(window.profile, { budget: frameBudget })
+    ? summarizeWindowProfile(window.profile, { budget: frameBudget, t0: window.t0 })
     : null;
   writeWindowRecord(window, {
     v: 1,
     windowModel: WINDOW_MODEL,
     id: window.id,
     name: window.name,
+    ...(window.legacyName !== null && window.legacyName !== window.name ? { legacyName: window.legacyName } : {}),
     kind: window.kind,
     t0: window.t0,
     t1: window.t1,
@@ -1903,11 +1961,13 @@ const leakJsHeap = (mb: number) => {
   leakState.retainedMB += mb;
 };
 
-export const isFaultTarget = (windowName: string) =>
-  settings.faultTarget
+export const isFaultTarget = (press: { name: string; legacyName: string; target: { testID: string | null; accessibilityLabel: string | null } }) => {
+  const names = [press.name, press.legacyName, press.target.testID, press.target.accessibilityLabel];
+  return settings.faultTarget
     .split(',')
     .map(part => part.trim())
-    .some(part => part !== '' && windowName.includes(part));
+    .some(part => part !== '' && names.some(name => name?.includes(part)));
+};
 
 export const runOpenFaults = (where: string) => {
   const faults = settings.faults;
@@ -2086,6 +2146,16 @@ const flushOnce = async (ack: string | undefined) => {
   } catch (error) {
     perfLog(`artifacts failed ${String(error)}`);
   }
+  if (runToken !== null) {
+    if (runLosses.stream > 0) {
+      if (status === 'ok') status = 'error';
+      detail += ` lost stream=${runLosses.stream}`;
+    }
+    if (runLosses.exportsCapped > 0) detail += ` exports capped=${runLosses.exportsCapped}`;
+    if (runLosses.exportsUnwritten > 0) detail += ` exports unwritten=${runLosses.exportsUnwritten}`;
+    if (runLosses.streamFibersDropped > 0) detail += ` stream fibersDropped=${runLosses.streamFibersDropped}`;
+  }
+  Object.assign(runLosses, { stream: 0, exportsCapped: 0, exportsUnwritten: 0, streamFibersDropped: 0 });
   try {
     await sendEarlierArtifacts(deadline);
   } catch (error) {

package/js/sdk/device-model.ts

@@ -0,0 +1,10 @@
+// The model a device reports to the API: what the OS calls the hardware, never the marketing name. expo-device's `modelId` is an
+// iPhone's machine id ("iPhone17,1") and null on Android, where `modelName` is already Build.MODEL ("SM-S911B"); `modelName` on iOS
+// is the marketing name, so the id comes first. A simulator keeps its name: there `modelId` is the host's `uname` machine ("arm64")
+// and `modelName` is "Simulator iOS" (an emulator's Build.MODEL carries the word the API reads the device kind from).
+export const deviceModelOf = (device: { isDevice?: boolean | null; modelId?: string | null; modelName?: string | null }): string | null => {
+  const modelId = /^(arm64|x86_64|i386)$/i.test(device.modelId ?? '') && device.isDevice === false ? null : device.modelId;
+  if (device.isDevice !== false) return modelId || device.modelName || null;
+  const model = device.modelName || modelId;
+  return model ? /(simulator|emulator|sdk_gphone|android sdk built for)/i.test(model) ? model : `${model} Simulator` : null;
+};