react-render-detective 0.4.0 → 0.5.0

package/dist/index.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 var chunkJD4IJ4MN_cjs = require('./chunk-JD4IJ4MN.cjs');
-var chunkDZ3BZ654_cjs = require('./chunk-DZ3BZ654.cjs');
+var chunkOSPTERGK_cjs = require('./chunk-OSPTERGK.cjs');
 var chunkH5RG2EPP_cjs = require('./chunk-H5RG2EPP.cjs');
 var React = require('react');
 var jsxRuntime = require('react/jsx-runtime');
@@ -26,6 +26,40 @@ function _interopNamespace(e) {
 
 var React__namespace = /*#__PURE__*/_interopNamespace(React);
 
+// src/console/style.ts
+var PALETTE = {
+  plain: "",
+  dim: "color:#8a94a6",
+  strong: "font-weight:600",
+  good: "color:#1f9d5b",
+  warn: "color:#c2820a",
+  bad: "color:#d1493f;font-weight:600"
+};
+var supportsStyling = () => {
+  try {
+    return typeof window !== "undefined" && typeof document !== "undefined";
+  } catch {
+    return false;
+  }
+};
+function styled(segments) {
+  if (!supportsStyling()) {
+    return [segments.map((s) => typeof s === "string" ? s : s[0]).join("")];
+  }
+  let format = "";
+  const styles = [];
+  for (const segment of segments) {
+    if (typeof segment === "string") {
+      format += segment.replace(/%/g, "%%");
+      continue;
+    }
+    const [text, tone] = segment;
+    format += `%c${text.replace(/%/g, "%%")}%c`;
+    styles.push(PALETTE[tone], "");
+  }
+  return [format, ...styles];
+}
+
 // src/console/reporter.ts
 var ICON = {
   normal: "\xB7",
@@ -34,30 +68,102 @@ var ICON = {
   "very-slow": "\u25B2\u25B2",
   critical: "\u25A0"
 };
+var BATCH_WINDOW_MS = 400;
 function attachConsoleReporter(detective) {
-  return detective.subscribe((event) => {
-    const mode = detective.config.mode;
-    if (mode === "silent") return;
+  let pending = [];
+  let timer;
+  const flush = () => {
+    timer = void 0;
+    const batch = pending;
+    pending = [];
+    if (batch.length === 0) return;
     try {
-      if (mode === "verbose") printVerbose(event);
-      else printConcise(event, detective.config.slowRenderThreshold);
+      printBatch(batch, detective.config.slowRenderThreshold);
     } catch {
     }
+  };
+  const unsubscribe = detective.subscribe((event) => {
+    const mode = detective.config.mode;
+    if (mode === "silent") return;
+    if (mode === "verbose") {
+      try {
+        printVerbose(event);
+      } catch {
+      }
+      return;
+    }
+    pending.push(event);
+    if (timer === void 0) {
+      timer = setTimeout(flush, BATCH_WINDOW_MS);
+      timer.unref?.();
+    }
   });
+  return () => {
+    unsubscribe();
+    if (timer !== void 0) clearTimeout(timer);
+  };
 }
-function printConcise(event, slowThreshold) {
-  const { diagnosis, timings, component } = event;
-  const changed = event.changedProps.map((c) => c.key).join(", ");
-  const parts = [
-    `[RRD] ${component.name} #${event.renderNumber}`,
-    `Reason: ${label(event)}`,
-    changed ? `Changed: ${changed}` : void 0,
-    timings.subtreeDuration > 0 ? `Duration: ${timings.selfDuration.toFixed(1)}ms` : void 0
-  ].filter(Boolean);
-  const line = `${ICON[diagnosis.severity] ?? "\xB7"} ${parts.join("  ")}`;
-  const slow = timings.selfDuration >= slowThreshold;
-  if (slow) console.warn(line);
-  else console.log(line);
+function printBatch(batch, slowThreshold) {
+  const byComponent = /* @__PURE__ */ new Map();
+  let totalMs = 0;
+  let avoidable = 0;
+  for (const event of batch) {
+    const key = event.component.name;
+    const entry = byComponent.get(key) ?? {
+      name: key,
+      source: event.component.source,
+      count: 0,
+      totalMs: 0,
+      reasons: /* @__PURE__ */ new Map(),
+      notableReasons: /* @__PURE__ */ new Map(),
+      avoidable: 0,
+      remount: false,
+      slow: false
+    };
+    entry.count++;
+    entry.totalMs += event.timings.selfDuration;
+    entry.reasons.set(event.diagnosis.reason, (entry.reasons.get(event.diagnosis.reason) ?? 0) + 1);
+    if (event.diagnosis.potentiallyAvoidable || event.timings.selfDuration >= slowThreshold) {
+      entry.notableReasons.set(event.diagnosis.reason, (entry.notableReasons.get(event.diagnosis.reason) ?? 0) + 1);
+    }
+    if (event.diagnosis.potentiallyAvoidable) entry.avoidable++;
+    if (event.diagnosis.summary.includes("rebuilt")) entry.remount = true;
+    if (event.timings.selfDuration >= slowThreshold) entry.slow = true;
+    if (!entry.worst || event.timings.selfDuration > entry.worst.timings.selfDuration) entry.worst = event;
+    byComponent.set(key, entry);
+    totalMs += event.timings.selfDuration;
+    if (event.diagnosis.potentiallyAvoidable) avoidable++;
+  }
+  const notable = [...byComponent.values()].filter((a) => a.avoidable > 0 || a.slow || a.remount);
+  if (notable.length === 0) return;
+  const ranked = [...notable].sort((a, b) => b.totalMs - a.totalMs);
+  const anySlow = ranked.some((a) => a.slow);
+  const segments = [
+    ["[RRD] ", "dim"],
+    [`${batch.length} render${batch.length === 1 ? "" : "s"}`, "strong"],
+    [` \xB7 ${totalMs.toFixed(1)}ms`, "dim"]
+  ];
+  if (avoidable > 0) segments.push([` \xB7 ${avoidable} potentially avoidable`, "warn"]);
+  for (const a of ranked.slice(0, 8)) {
+    const reasonSource = a.notableReasons.size > 0 ? a.notableReasons : a.reasons;
+    const reason = [...reasonSource.entries()].sort((x, y) => y[1] - x[1])[0]?.[0] ?? "unknown";
+    const tone = a.remount ? "bad" : a.slow ? "warn" : a.avoidable > 0 ? "warn" : "good";
+    const label2 = `  ${ICON[a.slow ? "slow" : "normal"]} ${a.name}${a.count > 1 ? ` \xD7${a.count}` : ""}`;
+    segments.push("\n", [label2.padEnd(30), tone], [`${a.totalMs.toFixed(1)}ms`, "plain"], [`  ${reason}`, "dim"]);
+    if (a.remount) segments.push(["  rebuilt", "bad"]);
+    if (a.avoidable > 0) segments.push([`  ${a.avoidable} avoidable`, "warn"]);
+    if (a.source) segments.push(["\n      " + a.source, "dim"]);
+  }
+  const worst = ranked[0]?.worst;
+  segments.push(
+    "\n",
+    [
+      worst?.diagnosis.suggestion ? `  \u2192 ${worst.diagnosis.suggestion}` : "  \u2192 rrd.printOpportunities() to rank everything by recoverable time",
+      "dim"
+    ]
+  );
+  const log = anySlow ? console.warn : console.log;
+  log(...styled(segments));
 }
 function printVerbose(event) {
   const { diagnosis, timings } = event;
@@ -80,12 +186,10 @@ function printVerbose(event) {
       for (const c of event.changedProps) console.log(propLine(c));
       console.groupEnd();
     }
-    if (event.unchangedProps.length > 0) {
-      console.log(`Props same:  ${event.unchangedProps.join(", ")}`);
-    }
+    if (event.unchangedProps.length > 0) console.log(`Props same:  ${event.unchangedProps.join(", ")}`);
     if (event.trackedState.length > 0) {
       console.log(
-        `State:       ${event.trackedState.map((s) => `${s.name}: ${chunkDZ3BZ654_cjs.formatInspected(s.previous)} \u2192 ${chunkDZ3BZ654_cjs.formatInspected(s.current)}`).join(", ")}`
+        `State:       ${event.trackedState.map((s) => `${s.name}: ${chunkOSPTERGK_cjs.formatInspected(s.previous)} \u2192 ${chunkOSPTERGK_cjs.formatInspected(s.current)}`).join(", ")}`
       );
     }
     if (event.contextChanges.length > 0) {
@@ -102,11 +206,11 @@ function printVerbose(event) {
 }
 function propLine(c) {
   const head = `${c.key} (${c.valueType}) \u2014 ${describeKind(c)}`;
-  if (c.kind === "added") return `${head}: ${chunkDZ3BZ654_cjs.formatInspected(c.current)}`;
-  if (c.kind === "removed") return `${head}: was ${chunkDZ3BZ654_cjs.formatInspected(c.previous)}`;
+  if (c.kind === "added") return `${head}: ${chunkOSPTERGK_cjs.formatInspected(c.current)}`;
+  if (c.kind === "removed") return `${head}: was ${chunkOSPTERGK_cjs.formatInspected(c.previous)}`;
   return `${head}
-    previous: ${chunkDZ3BZ654_cjs.formatInspected(c.previous)}
-    current:  ${chunkDZ3BZ654_cjs.formatInspected(c.current)}`;
+    previous: ${chunkOSPTERGK_cjs.formatInspected(c.previous)}
+    current:  ${chunkOSPTERGK_cjs.formatInspected(c.current)}`;
 }
 function describeKind(c) {
   switch (c.kind) {
@@ -381,7 +485,7 @@ function formatOpportunities(opportunities) {
 var AncestryContext = React.createContext(void 0);
 AncestryContext.displayName = "RenderDetectiveAncestry";
 function useInstrumentedNode(name, props, source) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const parent = React.useContext(AncestryContext);
   const [node] = React.useState(
     () => detective.enabled ? detective.createNode(name, parent, source) : void 0
@@ -431,7 +535,7 @@ var IS_WRAPPER = /* @__PURE__ */ Symbol.for("react-render-detective.wrapper");
 function withRenderDetective(Component, options = {}) {
   if (Component[IS_WRAPPER]) return Component;
   const name = options.name ?? componentName(Component);
-  chunkDZ3BZ654_cjs.getDetective().noteDefinition(name, options.source, options.declaredInRender === true);
+  chunkOSPTERGK_cjs.getDetective().noteDefinition(name, options.source, options.declaredInRender === true);
   function RenderDetected(props) {
     const { node, onRender } = useInstrumentedNode(name, props, options.source);
     return renderInstrumented(node, onRender, /* @__PURE__ */ jsxRuntime.jsx(Component, { ...props }));
@@ -447,7 +551,7 @@ function RenderDetective({ name, children }) {
   return renderInstrumented(node, onRender, children);
 }
 function useRenderDiagnostics(name, props) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const parent = React.useContext(AncestryContext);
   const [node] = React.useState(() => {
     if (!detective.enabled) return void 0;
@@ -482,7 +586,7 @@ function useRenderDiagnostics(name, props) {
 }
 var useOwnerId = typeof React__namespace.useId === "function" ? React__namespace.useId : () => "";
 function useTrackedState(name, initial) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const node = React.useContext(AncestryContext);
   const ownerId = useOwnerId();
   const [state, setState] = React.useState(initial);
@@ -492,8 +596,8 @@ function useTrackedState(name, initial) {
   if (node && owns && !Object.is(previous.current, state)) {
     detective.recordStateChange(node, {
       name,
-      previous: chunkDZ3BZ654_cjs.inspect(previous.current, detective.config.inspection),
-      current: chunkDZ3BZ654_cjs.inspect(state, detective.config.inspection)
+      previous: chunkOSPTERGK_cjs.inspect(previous.current, detective.config.inspection),
+      current: chunkOSPTERGK_cjs.inspect(state, detective.config.inspection)
     });
     previous.current = state;
   } else if (!owns) {
@@ -502,7 +606,7 @@ function useTrackedState(name, initial) {
   return [state, setState];
 }
 function useTrackedEffect(name, effect, deps) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const previous = React.useRef(void 0);
   const changed = React.useRef([]);
   if (detective.enabled) {
@@ -518,7 +622,7 @@ function useTrackedEffect(name, effect, deps) {
   }, deps);
 }
 function useTrackedContextValue(contextName, value) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const previous = React.useRef(void 0);
   const first = React.useRef(true);
   if (detective.enabled) {
@@ -526,8 +630,8 @@ function useTrackedContextValue(contextName, value) {
       first.current = false;
     } else if (!Object.is(previous.current, value)) {
       const prev = previous.current;
-      const equal = chunkDZ3BZ654_cjs.shallowEqual(prev, value, detective.config);
-      const changedKeys = isRecord(prev) && isRecord(value) ? chunkDZ3BZ654_cjs.diffProps(prev, value, detective.config).changed.map((c) => c.key) : [];
+      const equal = chunkOSPTERGK_cjs.shallowEqual(prev, value, detective.config);
+      const changedKeys = isRecord(prev) && isRecord(value) ? chunkOSPTERGK_cjs.diffProps(prev, value, detective.config).changed.map((c) => c.key) : [];
       detective.recordContextChange({
         contextName,
         changedKeys,
@@ -552,7 +656,7 @@ function tracker() {
   return g[INTERACTIONS];
 }
 function init(options = {}) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   detective.init(options);
   const g = globalThis;
   g[REPORTER]?.();
@@ -569,28 +673,28 @@ function init(options = {}) {
   }
 }
 function configure(options) {
-  chunkDZ3BZ654_cjs.getDetective().configure(options);
+  chunkOSPTERGK_cjs.getDetective().configure(options);
 }
 function getConfig() {
-  return chunkDZ3BZ654_cjs.getDetective().config;
+  return chunkOSPTERGK_cjs.getDetective().config;
 }
 function isEnabled() {
-  return chunkDZ3BZ654_cjs.getDetective().enabled;
+  return chunkOSPTERGK_cjs.getDetective().enabled;
 }
 function getEvents() {
-  return chunkDZ3BZ654_cjs.getDetective().getEvents();
+  return chunkOSPTERGK_cjs.getDetective().getEvents();
 }
 function getStats() {
-  return chunkDZ3BZ654_cjs.getDetective().getStats();
+  return chunkOSPTERGK_cjs.getDetective().getStats();
 }
 function getComponentStats(name) {
-  return chunkDZ3BZ654_cjs.getDetective().getComponentStats(name);
+  return chunkOSPTERGK_cjs.getDetective().getComponentStats(name);
 }
 function subscribe(listener) {
-  return chunkDZ3BZ654_cjs.getDetective().subscribe(listener);
+  return chunkOSPTERGK_cjs.getDetective().subscribe(listener);
 }
 function clear() {
-  chunkDZ3BZ654_cjs.getDetective().clear();
+  chunkOSPTERGK_cjs.getDetective().clear();
   tracker().clear();
 }
 function reset() {
@@ -599,18 +703,18 @@ function reset() {
   g[REPORTER] = void 0;
   g[INTERACTIONS]?.stop();
   g[INTERACTIONS] = void 0;
-  chunkDZ3BZ654_cjs.getDetective().reset();
+  chunkOSPTERGK_cjs.getDetective().reset();
 }
 function explain(componentName2) {
   const explanation = explainStructured(componentName2);
   return explanation ? chunkJD4IJ4MN_cjs.formatExplanation(explanation) : void 0;
 }
 function explainStructured(componentName2) {
-  return chunkJD4IJ4MN_cjs.explainEvents(componentName2, getEvents(), chunkDZ3BZ654_cjs.getDetective().lifecycleOf(componentName2));
+  return chunkJD4IJ4MN_cjs.explainEvents(componentName2, getEvents(), chunkOSPTERGK_cjs.getDetective().lifecycleOf(componentName2));
 }
 function getRenderProfile(scenario) {
   const remounts = {};
-  for (const stats of chunkDZ3BZ654_cjs.getDetective().getComponentStats()) remounts[stats.name] = stats.remountCount;
+  for (const stats of chunkOSPTERGK_cjs.getDetective().getComponentStats()) remounts[stats.name] = stats.remountCount;
   return chunkH5RG2EPP_cjs.profileFromEvents(scenario, getEvents(), remounts);
 }
 function getInteractions() {
@@ -639,7 +743,7 @@ function measureInteraction(label2, action) {
   return tracker().measure(label2, action);
 }
 function getOpportunities(limit = 10) {
-  const detective = chunkDZ3BZ654_cjs.getDetective();
+  const detective = chunkOSPTERGK_cjs.getDetective();
   const lifecycles = /* @__PURE__ */ new Map();
   for (const stats of detective.getComponentStats()) {
     lifecycles.set(stats.name, { remounts: stats.remountCount });