@barefootjs/xyflow 0.28.0 → 0.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barefootjs/xyflow",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Signal-based xyflow wrapper for BarefootJS",
   "type": "module",
   "main": "./dist/index.js",

package/src/__tests__/host-element-store.test.ts

@@ -1,10 +1,20 @@
 /**
- * `<Flow renderNode={Fn}>` hydrates the rendered bridge as a top-level
- * scope outside Flow's `FlowContext.Provider`, so consumers that look up
- * the store via `useFlow()` get back `undefined`. As an escape hatch,
- * `attachFlowSubsystems` stamps the host `<div class="bf-flow">` with
- * `__bfFlowStore` so children can walk up the DOM and read the store
- * without going through the context system.
+ * `attachFlowSubsystems` must NOT stamp the store onto the host element.
+ *
+ * It used to, as an escape hatch for "descendants that miss `FlowContext`" —
+ * on the premise that `<Flow renderNode={Fn}>` hydrates its children as a
+ * top-level scope outside the `FlowContext.Provider`. That premise does not
+ * hold in the rendered DOM: the provider's context map sits on the
+ * `<div class="bf-flow">` host itself, which is an ancestor of every
+ * `.bf-flow__node`, and `useContext` walks `parentElement` — so any connected
+ * descendant resolves the store regardless of which scope it was hydrated as.
+ * The one shape that genuinely failed was a child initialising while its row
+ * was still detached, fixed at the root in the runtime (#2431).
+ *
+ * Nothing ever read the property, so it was a write-only global whose comment
+ * asserted a live product defect that did not exist — and that misreading fed
+ * a wrong priority call. This test pins the removal so it cannot come back
+ * without a reader to justify it.
  */
 import { beforeAll, describe, expect, test } from 'bun:test'
 import { GlobalRegistrator } from '@happy-dom/global-registrator'
@@ -13,8 +23,8 @@ beforeAll(() => {
   if (!GlobalRegistrator.isRegistered) GlobalRegistrator.register()
 })
 
-describe('attachFlowSubsystems exposes the store on the host element', () => {
-  test('sets `__bfFlowStore` on the element it attaches to', async () => {
+describe('attachFlowSubsystems keeps no second store-lookup path', () => {
+  test('does not stamp `__bfFlowStore` on the host element', async () => {
     // Lazy import so happy-dom globals are in place before xyflow loads.
     const { attachFlowSubsystems } = await import('../flow-subsystems')
     const { createFlowStore } = await import('../store')
@@ -28,6 +38,12 @@ describe('attachFlowSubsystems exposes the store on the host element', () => {
     // biome-ignore lint/suspicious/noExplicitAny: minimal props for unit test
     attachFlowSubsystems(el, store as any, {} as any)
 
-    expect((el as HTMLElement & { __bfFlowStore?: unknown }).__bfFlowStore).toBe(store)
+    // Presence, not value: a `toBeUndefined()` read would also pass if the
+    // attach stamped the property and assigned `undefined` to it, which is
+    // still an expando on a public DOM element.
+    expect(Object.hasOwn(el, '__bfFlowStore')).toBe(false)
+    // The attach itself still has to have happened — otherwise this test
+    // would pass against a no-op `attachFlowSubsystems`.
+    expect(store.domNode()).toBe(el)
   })
 })

package/src/flow-subsystems.ts

@@ -88,14 +88,18 @@ export function attachFlowSubsystems<
   el.style.overflow = 'hidden'
 
   store.setDomNode(el)
-  // Expose the store on the host `<div class="bf-flow">` element so
-  // descendants that miss `FlowContext` — e.g. children passed through
-  // `<Flow renderNode={Fn}>` whose returned JSX is hydrated as a
-  // top-level scope outside of Flow's `FlowContext.Provider` — can
-  // still locate the store via `el.closest('.bf-flow').__bfFlowStore`.
-  // Always-set, even on hot remount, so callers can rely on a single
-  // canonical reference.
-  ;(el as HTMLElement & { __bfFlowStore?: typeof store }).__bfFlowStore = store
+  // No `__bfFlowStore` escape hatch here. This used to stamp the store on
+  // the host element for "descendants that miss `FlowContext`", on the
+  // premise that `<Flow renderNode={Fn}>` hydrates its children as a
+  // top-level scope outside the `FlowContext.Provider`. That premise does
+  // not hold in the rendered DOM: the provider's context map lives on this
+  // very `<div class="bf-flow">`, which is an ancestor of every
+  // `.bf-flow__node`, and `useContext` walks `parentElement` — so any
+  // CONNECTED descendant resolves the store no matter which scope it was
+  // hydrated as, verified in a browser. The one shape that did fail was a
+  // child initialising while its row was still detached, and that is fixed
+  // at the root in the runtime (#2431), not by a second lookup path.
+  // Nothing read the property, so it was a write-only global.
   store.setWidth(el.offsetWidth)
   store.setHeight(el.offsetHeight)