react-x11 2.1.1 → 2.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-x11",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "react renderer with X11 as a target",
   "main": "./src/index.js",
   "files": [

package/src/ClickToComponent.js

@@ -11,14 +11,44 @@
 // original source — we only have to parse the stack text and skip the
 // frames inside React/the reconciler itself.
 import { spawn } from 'node:child_process';
+import { dirname, sep } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { setClickToComponentHandler } from './events.js';
 import { selectInDevTools } from './DevToolsIntegration.js';
 
 const STACK_FRAME = /^\s*at\s+(?:(.+?)\s+\()?(.+?):(\d+):(\d+)\)?\s*$/;
 
+// The frames to walk past before the JSX call site itself: React captures
+// the Error inside `jsxDEV`/`createElement`, and an element created by this
+// renderer (or by node internals) is never what a click means. `SELF_DIR` is
+// whichever copy of react-x11 is running — the repo's own `src/` for the
+// examples and tests, an installed `node_modules/react-x11/src` for an app.
+//
+// Everything *else* in `node_modules` is deliberately not skipped here: a
+// frame inside an installed package is a real call site, it is just not one
+// in the application's source, and telling the two apart is what lets
+// `resolveOwnedLocation` climb to the owner that is. Skipping every
+// `node_modules` frame instead would walk straight past the library
+// component and land on whatever application frame happens to be deeper in
+// the render stack — usually the `render()` call at startup, which looks
+// like an answer and isn't.
+const REACT_RUNTIME =
+  /[\\/]node_modules[\\/](react|react-dom|react-reconciler|scheduler)[\\/]/;
+const SELF_DIR = dirname(fileURLToPath(import.meta.url)) + sep;
+
+function isInternalFrame(file) {
+  return (
+    file.startsWith('node:') ||
+    file === '<anonymous>' ||
+    file.startsWith(SELF_DIR) ||
+    REACT_RUNTIME.test(file)
+  );
+}
+
 /** The first stack frame outside React/the reconciler/node internals — the
- * user's own JSX call site for whatever element this Error was captured at.
+ * JSX call site for whatever element this Error was captured at, wherever it
+ * was written. `installed` marks a call site that lives inside an installed
+ * package rather than in the application's own source.
  * Exported because `react-x11/test`'s `sourceOf` answers the same question
  * for a test that a click answers for an editor. */
 export function resolveLocation(debugStack) {
@@ -28,26 +58,54 @@ export function resolveLocation(debugStack) {
     const match = line.match(STACK_FRAME);
     if (!match) continue;
     const [, functionName, rawFile, lineStr, columnStr] = match;
-    if (
-      rawFile.includes('/node_modules/') ||
-      rawFile.startsWith('node:') ||
-      rawFile === '<anonymous>'
-    ) {
-      continue;
-    }
     const file = rawFile.startsWith('file://')
       ? fileURLToPath(rawFile)
       : rawFile;
+    if (isInternalFrame(file)) continue;
     return {
       functionName,
       file,
       line: Number(lineStr),
       column: Number(columnStr),
+      installed: file.includes(`${sep}node_modules${sep}`),
     };
   }
   return null;
 }
 
+/** The nearest source location a click can mean: the clicked element's own
+ * JSX call site when the application wrote it, and otherwise the first owner
+ * up the chain that it did write. An element rendered by an installed
+ * component — a design system's `<Toolbar>`, a chart library's internals —
+ * has its call site inside that package; what the user meant by clicking it
+ * is the `<Toolbar ... />` line in their own file that put it on screen.
+ *
+ * Returns `{ fiber, location, depth }`, `depth` being how many owners up the
+ * location came from (0 = the clicked element's own). Falls back to the
+ * nearest installed call site when nothing in the chain is application
+ * source — opening a package's own file beats refusing to open anything —
+ * and null only when React has no debug info at all. */
+export function resolveOwnedLocation(fiber) {
+  let fallback = null;
+  let depth = 0;
+  for (let owner = fiber; owner; owner = owner._debugOwner, depth++) {
+    const location = resolveLocation(owner._debugStack);
+    if (!location) continue;
+    if (!location.installed) return { fiber: owner, location, depth };
+    fallback ??= { fiber: owner, location, depth };
+  }
+  return fallback;
+}
+
+/** What the clicked thing *is* — `<box>` for a host node, the component's
+ * name for a composite one. (`componentName` below answers a different
+ * question: who *wrote* it.) */
+function elementLabel(fiber) {
+  const type = fiber.type;
+  if (typeof type === 'string') return `<${type}>`;
+  return type?.displayName || type?.name || '(anonymous)';
+}
+
 function componentName(fiber) {
   const owner = fiber._debugOwner;
   const type = owner?.type;
@@ -119,13 +177,39 @@ function openInEditor({ file, line, column }) {
     bin = OPEN_URI_COMMAND;
     args = [editorUri(scheme, file, line, column)];
   }
-  const child = spawn(bin, args, { detached: true, stdio: 'ignore' });
+  // stderr is kept (rather than the whole stdio ignored) for one reason:
+  // `open`/`xdg-open` exit non-zero and print *there* when nothing claims
+  // the scheme — an editor that isn't installed, or one whose URL handler
+  // was never registered. Swallowing that is what makes click-to-component
+  // look like it only logs: the location resolves, the console line prints,
+  // and the editor silently never opens.
+  const child = spawn(bin, args, {
+    detached: true,
+    stdio: ['ignore', 'ignore', 'pipe'],
+  });
+  let stderr = '';
+  // ...and unref'd, so keeping it does not keep the process alive: a pipe is
+  // a ref'd handle, and an editor that outlives the app it was launched from
+  // is the normal case, not a reason to hold the event loop open.
+  child.stderr.unref();
+  child.stderr.on('data', (chunk) => {
+    stderr += chunk;
+  });
   child.on('error', (err) => {
     console.warn(
       `react-x11: click-to-component could not launch "${bin}" (${err.code ?? err.message}). ` +
         'Set REACT_X11_EDITOR to your editor CLI (cursor, code, code-insiders, windsurf, vim, nvim).',
     );
   });
+  child.on('exit', (code) => {
+    if (!code) return;
+    console.warn(
+      `react-x11: click-to-component — \`${bin} ${args.join(' ')}\` exited ${code}. ` +
+        (stderr.trim() ? `${stderr.trim()} ` : '') +
+        `Set REACT_X11_EDITOR to the editor you actually use (currently "${name}"; ` +
+        'cursor, code, code-insiders, windsurf, vim, nvim, or any registered URI scheme).',
+    );
+  });
   child.unref();
 }
 
@@ -146,17 +230,29 @@ function handleClick(node, native) {
     );
     return;
   }
-  const location = resolveLocation(fiber._debugStack);
-  if (!location) {
+  const resolved = resolveOwnedLocation(fiber);
+  if (!resolved) {
     console.warn(
-      'react-x11: click-to-component — no source location found. This needs ' +
-        'React running in development mode (fiber._debugStack).',
+      'react-x11: click-to-component — no source location found for this ' +
+        'element or any of its owners. This needs React running in ' +
+        'development mode (fiber._debugStack).',
     );
     return;
   }
+  const { fiber: sourceFiber, location, depth } = resolved;
+  // What was clicked is not always what has a source: say so rather than
+  // silently opening a file the click doesn't obviously correspond to.
+  const climbed =
+    depth > 0
+      ? ` (${depth} owner${depth > 1 ? 's' : ''} up from the clicked ` +
+        `${elementLabel(fiber)})`
+      : '';
+  const installed = location.installed ? ' — inside an installed package' : '';
   console.log(
-    `[click-to-component] ${componentName(fiber)} → ` +
-      `${location.file}:${location.line}:${location.column}`,
+    `[click-to-component] ${componentName(sourceFiber)} → ` +
+      `${location.file}:${location.line}:${location.column}` +
+      climbed +
+      installed,
   );
   if (native?.buttons & 1) {
     // Alt+Shift+Click

package/src/foreignnodes.js

@@ -340,6 +340,13 @@ export class ForeignNode extends Node {
     this._syncGeometry();
   }
 
+  // the scroll fast path moves `abs` without coming through absolutize
+  // (issue #405), and the embedded window has to follow it all the same
+  _shiftAbs(dx, dy) {
+    super._shiftAbs(dx, dy);
+    this._syncGeometry();
+  }
+
   _syncGeometry() {
     const socket = this.socket;
     if (!socket) return;

package/src/glnodes.js

@@ -230,6 +230,13 @@ export class GlAreaNode extends Node {
     this._syncGeometry();
   }
 
+  // the scroll fast path moves `abs` without coming through absolutize
+  // (issue #405), and the real X window has to follow it all the same
+  _shiftAbs(dx, dy) {
+    super._shiftAbs(dx, dy);
+    this._syncGeometry();
+  }
+
   _syncGeometry() {
     const wnd = this.window;
     if (!wnd) return;

package/src/nodes.js

@@ -2244,8 +2244,19 @@ export class Node {
   }
 
   /** The theme above or on this node changed: drop the caches and restyle
-   * the subtree, since a token can appear at any depth. */
-  _themeChanged() {
+   * the subtree, since a token can appear at any depth.
+   *
+   * `mounting` is `insertBefore` attaching a subtree that has never been in
+   * the tree: the walk still resolves every token — the nodes can see their
+   * ancestors now — but it claims no damage (issue #402). A node that has
+   * never painted has no stale pixels to cover, and the rect it is about to
+   * occupy is claimed by the child-list/layout-diff protocol like any other
+   * inserted child's; the unbounded claims below would turn every commit
+   * that mounts a token-styled node into a full-window repaint — which is
+   * every re-slice of a virtualized list whose rows follow the palette. A
+   * live theme *swap* is the other caller and keeps them: it moves pixels
+   * that are already on screen, anywhere in the subtree. */
+  _themeChanged(mounting = false) {
     // This walk visits every node itself, so the per-node re-resolution below
     // is enough — a style swap it causes must not start a second walk of the
     // same subtree from halfway down.
@@ -2269,19 +2280,23 @@ export class Node {
         if (localTextStyleChanged(this.style, before)) {
           this._textContentChanged();
         }
-        this.root?.invalidate(true, null, 'theme');
+        if (!mounting) this.root?.invalidate(true, null, 'theme');
       }
       // The palette is the floor under the cascade, so a theme swap moves the
       // resolved style of every node that named none of its own — and none of
       // that is in a style object, so nothing above would have noticed. A
       // swap that only changes `fontFamily` is the case that made this worth
       // having: nothing else about the node changes, and a cached layout
-      // carries the face it was shaped with.
-      if (this._retext() !== 0) this.root?.invalidate(true, null, 'theme');
+      // carries the face it was shaped with. `_retext` runs on a mount too —
+      // its own claims are bounded — but cannot answer non-zero there: a
+      // node that was never attached has never resolved a text style.
+      if (this._retext() !== 0 && !mounting) {
+        this.root?.invalidate(true, null, 'theme');
+      }
       if (wasDirection !== undefined && this.direction !== wasDirection) {
         this._directionMoved();
       }
-      for (const child of this.children) child._themeChanged();
+      for (const child of this.children) child._themeChanged(mounting);
     } finally {
       inThemeWalk--;
     }
@@ -2447,9 +2462,10 @@ export class Node {
       // popups live anywhere in the JSX tree but are independent
       // override-redirect windows: bookkeeping only, no yoga, no paint —
       // but they do inherit the theme of where they are written
+      const mounting = child.parent == null;
       this._spliceChild(child, beforeChild);
       child.parent = this;
-      if (this.theme || child.props.theme) child._themeChanged();
+      if (this.theme || child.props.theme) child._themeChanged(mounting);
       a11yHooks.attached?.(this, child);
       return;
     }
@@ -2495,6 +2511,10 @@ export class Node {
     if (child.parent === this && this._joinsYoga(child)) {
       this.yoga.removeChild(child.yoga);
     }
+    // no parent means never attached: this insert is a mount, and the theme
+    // walk resolves without claiming — a keyed reorder arrives here too, with
+    // its parent still set, and that one keeps the claims (issue #402)
+    const mounting = child.parent == null;
     const index = this._spliceChild(child, beforeChild);
     child.parent = this;
     if (this._joinsYoga(child)) {
@@ -2504,7 +2524,7 @@ export class Node {
     child._registerSizeQueries();
     // it can see its ancestors now, so any token in its style can resolve.
     // With no theme anywhere there is nothing to resolve and nothing to walk
-    if (this.theme || child.props.theme) child._themeChanged();
+    if (this.theme || child.props.theme) child._themeChanged(mounting);
     this._textContentChanged();
     this._childListChanged(before);
     a11yHooks.attached?.(this, child);
@@ -3241,6 +3261,74 @@ export class Node {
     }
   }
 
+  /**
+   * Move an already-laid-out subtree by a constant, without asking yoga
+   * anything — the scroll fast path's walk (issue #405).
+   *
+   * A pure-scroll frame changes nothing about the arrangement inside a
+   * viewport: every descendant sits exactly where the last pass put it,
+   * shifted by the scroll delta. `absolutize` would re-derive each rect
+   * through four wasm-boundary getters to learn what one addition already
+   * says, so the scroller calls this instead — only after proving nothing
+   * inside was laid out this pass (see `_absolutizeChildren`).
+   *
+   * `abs` is adjusted in place rather than replaced: its identity is
+   * already long-lived (`_assignAbs` keeps the object whenever a rect is
+   * unchanged), and everything that records a rect for later copies it.
+   * The cached hit bounds ride along instead of being dropped — a uniform
+   * translation is the one change a cached union survives — which keeps a
+   * wheel flick from rebuilding the pane's whole hit-bounds tree per notch.
+   *
+   * No layout diff runs here, and none is owed: under a blit ledger the
+   * shifted diff's claims are the *deviations* from exactly this
+   * translation, and a subtree nothing laid out again has none.
+   */
+  _shiftAbs(dx, dy) {
+    if (!this.yoga) return;
+    const abs = this.abs;
+    abs.x += dx;
+    abs.y += dy;
+    const b = this._hitBoundsCache;
+    if (b) {
+      b.left += dx;
+      b.right += dx;
+      b.top += dy;
+      b.bottom += dy;
+    }
+    this._shiftChildren(dx, dy);
+  }
+
+  /** Split from `_shiftAbs` so a scroller can reroute its children through
+   * its own offset bookkeeping — the box moves rigidly, but the children's
+   * origin also carries scroll offsets that may have changed again this
+   * same frame (`Scrollable._shiftChildren`). */
+  _shiftChildren(dx, dy) {
+    for (const child of this.children) {
+      if (!child.isWindow) child._shiftAbs(dx, dy);
+    }
+  }
+
+  /**
+   * A layout-affecting change at this node may change how far the content
+   * of an enclosing scroll pane reaches through a route yoga never
+   * witnesses — an element that paints its own content growing its extent
+   * announces it with `invalidate(true, this, 'scroll')`
+   * (docs/extending.md), and no yoga node is dirtied by that. Mark every
+   * scroller whose measurement can see this node, so the next pass asks
+   * `measureScrollContent` again instead of reusing the cached reach
+   * (issue #405). The walk stops where the measurement does: at the first
+   * ancestor that clips its children, whose overflow is its own business.
+   */
+  _markScrollMeasureDirty() {
+    for (let n = this; n; n = n.parent) {
+      // only a Scrollable carries the flag; a stale `true` on a box that is
+      // not currently a scroller costs nothing and re-measures correctly if
+      // its style later makes it one
+      if (n._scrollMeasureDirty === false) n._scrollMeasureDirty = true;
+      if (n !== this && n.clipsChildren()) return;
+    }
+  }
+
   /**
    * Ask the owning window to repaint. The damage lives on the window node,
    * which is the only node with a frame clock — this forwards there, so an
@@ -3254,6 +3342,9 @@ export class Node {
    * the mount invalidates in full anyway.
    */
   invalidate(layoutChanged = false, damage = null, reason = null) {
+    // a layout change may grow what an enclosing scroll pane has to scroll,
+    // through a route yoga never sees (issue #405)
+    if (layoutChanged) this._markScrollMeasureDirty();
     this.root?.invalidate(layoutChanged, damage, reason);
   }
 
@@ -3409,6 +3500,7 @@ export class Node {
    * FULL_DAMAGE the way a bare `invalidate(true, null)` would.
    */
   _invalidateLayout(reason) {
+    this._markScrollMeasureDirty();
     const root = this.root;
     if (!root) return;
     // Same walk, same frame, same answer — see `_childListBefore`, whose
@@ -5259,6 +5351,10 @@ export const Scrollable = (Base) =>
       this.scrollX = 0;
       this.contentHeight = 0;
       this.contentWidth = 0;
+      // `measureScrollContent` owed a fresh answer — true until the first
+      // layout pass measures, and re-raised by any change yoga cannot see
+      // (`_markScrollMeasureDirty`, issue #405)
+      this._scrollMeasureDirty = true;
     }
 
     /**
@@ -5281,6 +5377,9 @@ export const Scrollable = (Base) =>
      * position the same way when a box stops scrolling.
      */
     _overflowChanged() {
+      // whichever way the style flipped, the next scrolling pass starts
+      // from a fresh measurement
+      this._scrollMeasureDirty = true;
       if (this.isScroller()) return;
       this._scrollIntoViewTarget = null;
       this._childOrigin = null;
@@ -5315,20 +5414,39 @@ export const Scrollable = (Base) =>
         return;
       }
       const rtl = this.direction === 'rtl';
-      const size = this.measureScrollContent();
-      if (!Number.isFinite(size?.width) || !Number.isFinite(size?.height)) {
-        // A NaN here does not throw on its own: it becomes a NaN max scroll,
-        // a NaN offset, and every child laid out at NaN — a whole tree gone
-        // with nothing naming the element that did it.
-        throw new Error(
-          `react-x11: <${this.kind}>.measureScrollContent() must return ` +
-            '{ width, height } as finite numbers; it returned ' +
-            `${describeSize(size)}. Return { width: 0, height: 0 } for ` +
-            'content that has not arrived yet.',
-        );
+      // A pure-scroll pass re-learns nothing by walking (issue #405): the
+      // content reach and every child's place *inside* the pane only change
+      // when layout inside the pane changes. Yoga's own has-new-layout flag
+      // is the witness — consumed here and nowhere else — set by any pass
+      // that laid this node or anything under it out again, and left clear
+      // by one that merely scrolled. `_scrollMeasureDirty` covers the one
+      // route yoga cannot see: an element that paints its own content
+      // growing its extent (docs/extending.md), announced through
+      // `invalidate(true, this, 'scroll')`. The root's yoga node re-flags
+      // on every pass, so a `<window overflow='scroll'>` always takes the
+      // full walk — the pane that holds an app's long list is a box.
+      const clean =
+        this._childOrigin != null &&
+        !this._scrollMeasureDirty &&
+        !this.yoga.hasNewLayout();
+      if (!clean) {
+        const size = this.measureScrollContent();
+        if (!Number.isFinite(size?.width) || !Number.isFinite(size?.height)) {
+          // A NaN here does not throw on its own: it becomes a NaN max
+          // scroll, a NaN offset, and every child laid out at NaN — a whole
+          // tree gone with nothing naming the element that did it.
+          throw new Error(
+            `react-x11: <${this.kind}>.measureScrollContent() must return ` +
+              '{ width, height } as finite numbers; it returned ' +
+              `${describeSize(size)}. Return { width: 0, height: 0 } for ` +
+              'content that has not arrived yet.',
+          );
+        }
+        this.contentWidth = size.width;
+        this.contentHeight = size.height;
+        this._scrollMeasureDirty = false;
+        this.yoga.markLayoutSeen();
       }
-      this.contentWidth = size.width;
-      this.contentHeight = size.height;
       this._resolveScrollIntoView();
       this.scrollY = clampScroll(this.scrollY, this._maxScroll('y'));
       this.scrollX = clampScroll(this.scrollX, this._maxScroll('x'));
@@ -5353,6 +5471,23 @@ export const Scrollable = (Base) =>
       const wasOrigin = this._childOrigin;
       const shifted = wasOrigin && (wasOrigin.x !== ox || wasOrigin.y !== oy);
       this._childOrigin = { x: ox, y: oy };
+      if (clean) {
+        // The fast path (issue #405): nothing inside was laid out, so every
+        // child sits exactly where the last pass put it, shifted by however
+        // far the origin moved — one uniform translation instead of a
+        // per-node yoga re-derivation. The layout diff is owed nothing by
+        // construction: under a blit ledger the shifted diff's claims are
+        // the deviations from this very translation, and a clean pane has
+        // none — the walk below lands every node where the diff would have
+        // reported silence.
+        if (!shifted) return;
+        const dx = ox - wasOrigin.x;
+        const dy = oy - wasOrigin.y;
+        for (const child of this.children) {
+          if (!child.isWindow) child._shiftAbs(dx, dy);
+        }
+        return;
+      }
       const outer = layoutDiffSink;
       const outerShift = layoutDiffShift;
       const ledger = shifted && this._blitLedgerOpen();
@@ -5396,6 +5531,22 @@ export const Scrollable = (Base) =>
       }
     }
 
+    /**
+     * A scroller inside a shifting subtree does not ride the translation
+     * blindly: its box moves rigidly, but its children's origin also
+     * carries the scroll offsets, which may have changed again this very
+     * frame — a wheel on a nested pane while an outer one scrolls.
+     * Re-entering `_absolutizeChildren` folds both into one delta, and
+     * re-runs the gate, so a nested pane that is not clean still walks
+     * properly. (Reached only under an outer pane's fast path, which
+     * proved nothing in here was laid out — the nested gate can only
+     * decline over its own `_scrollMeasureDirty`.)
+     */
+    _shiftChildren(dx, dy) {
+      if (!this.isScroller()) return super._shiftChildren(dx, dy);
+      this._absolutizeChildren(this.abs.x, this.abs.y);
+    }
+
     /**
      * Tell the owner how big the viewport and the content turned out, when
      * either changes. Layout happens on the frame clock, *after* the commit
@@ -5457,8 +5608,14 @@ export const Scrollable = (Base) =>
      * wheel, the scrollbars, the scroll keys and the AT-SPI scroll pane all
      * read the numbers this returns (docs/extending.md).
      *
-     * Called once per layout pass, from `absolutize`, so it may read yoga
-     * geometry but must not invalidate or paint.
+     * Called at most once per layout pass, from `absolutize`, so it may
+     * read yoga geometry but must not invalidate or paint — and cached
+     * across passes that laid nothing inside the pane out again (issue
+     * #405): a pass that merely scrolled reuses the last answer, since a
+     * scroll cannot change how far the content reaches. An element whose
+     * extent changed by a route layout never saw — rows arrived, a line
+     * was typed — announces it with `invalidate(true, this, 'scroll')`,
+     * and the next pass asks again.
      */
     measureScrollContent() {
       const rtl = this.direction === 'rtl';
@@ -9743,6 +9900,7 @@ export class WindowNode extends Scrollable(Node) {
       return;
     }
     if (child.isWindow) {
+      const mounting = child.parent == null;
       this._spliceChild(child, beforeChild);
       child.parent = this;
       // Initial children are realized when this window realizes; a child
@@ -9754,7 +9912,7 @@ export class WindowNode extends Scrollable(Node) {
         child.realize(this.window);
         if (child.window) this._xStack.push(child.window.id);
       }
-      if (this.theme || child.props.theme) child._themeChanged();
+      if (this.theme || child.props.theme) child._themeChanged(mounting);
       // React reorders a keyed list with one insertBefore per moved child;
       // restacking once at the end of the commit skips the intermediate
       // orders, which nobody ever sees.