Repository navigation
[backport cloud/1.51] fix(layout): keep a node layout ref alive until its last holder releases - #15459
Conversation
…ses (#15092) ## Summary `layoutStore.getNodeLayoutRef` caches one ref per node id, and `cleanupNodeRef` dropped it on the first unmount — silently cutting off every other holder of that same ref. ## Changes - **What**: `cleanupNodeRef` → `retainNodeLayoutRef(nodeId)`, returning `{ layout, release }` and reference-counting holders; the ref and its trigger survive until the last holder releases. Migrates the three long-lived holders (`useNodeLayout`, `canvasCoachTarget`, `useSlotElementTracking`). Transient `getNodeLayoutRef(id).value` reads stay uncounted. - **Breaking**: `layoutStore.cleanupNodeRef` is removed; callers that hold a ref past the current tick use `retainNodeLayoutRef`. ## Review Focus The obvious fix — `Map<NodeId, Set<() => void>>`, as the issue suggests — does not work. The ref is cached per node id, so one id has exactly one ref and one trigger; the Set would hold a single element and cleanup would still drop it. The defect is lifetime, not fan-out, hence reference counting. Counting inside `getNodeLayoutRef` does not work either: ~15 call sites read `.value` transiently and never release, so the count would never reach zero. Hence the explicit retain/release split. Regression coverage, both verified failing before the fix and passing after: - `src/renderer/core/layout/store/layoutStore.multiHolder.test.ts` — two holders, one releases, the other must still be notified. The paired control test (both holders alive) passes in both states, so the red is the defect and not the harness. Note the store's getter reads Yjs live, so a bare `.value` read still returns fresh data; the staleness is only observable through a reactive dependency, which is what the test and the coachmark both use. - `browser_tests/tests/firstRunTourNodeTracking.spec.ts` — the user-visible symptom. The tour spotlights a node, the node's component unmounts and remounts, the user drags the node. Before the fix the spotlight stays frozen (`Expected: not 533.625`) while the node moves away; after, it tracks. The e2e picks a template whose pinned roles this backend actually serves — an unresolvable pin starts no tour at all, which is a silent skip otherwise. Fixes #14385 The same defect exists on `feature/ecs-migration`, where `getNodeLayoutRef` has been rewritten (scoped keys, `ComputedRef` over a revision `ref`) but keeps the same single-trigger lifetime. Ported separately in #15093, since this patch does not apply there. --------- Co-authored-by: Amp <amp@ampcode.com>
🎨 Storybook: ✅ Built — View Storybook📦 Bundle Size
⚡ Performance Report
Absolute values
Raw data{
"timestamp": "2026-08-20T04:10:46.781Z",
"gitSha": "e59102be5976f1c07453fdca5e7ed11fae7a86f1",
"branch": "backport-15092-to-cloud-1.51",
"measurements": [
{
"name": "canvas-idle",
"durationMs": 2033.6869999999863,
"styleRecalcs": 7,
"styleRecalcDurationMs": 5.8309999999999995,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 511.29999999999995,
"heapDeltaBytes": 3754376,
"heapUsedBytes": 68473656,
"domNodes": 14,
"jsHeapTotalBytes": 25427968,
"scriptDurationMs": 6.352999999999999,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "canvas-idle",
"durationMs": 2015.1010000000724,
"styleRecalcs": 10,
"styleRecalcDurationMs": 7.103999999999999,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 450.47099999999995,
"heapDeltaBytes": 4962568,
"heapUsedBytes": 70138492,
"domNodes": 20,
"jsHeapTotalBytes": 24903680,
"scriptDurationMs": 6.774000000000003,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "canvas-mouse-sweep",
"durationMs": 1850.7769999999937,
"styleRecalcs": 75,
"styleRecalcDurationMs": 33.20400000000001,
"layouts": 12,
"layoutDurationMs": 3.603,
"taskDurationMs": 853.135,
"heapDeltaBytes": -17081064,
"heapUsedBytes": 48247796,
"domNodes": -282,
"jsHeapTotalBytes": 23171072,
"scriptDurationMs": 98.35199999999999,
"eventListeners": -153,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333332,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "canvas-mouse-sweep",
"durationMs": 1779.3349999999464,
"styleRecalcs": 73,
"styleRecalcDurationMs": 33.416000000000004,
"layouts": 12,
"layoutDurationMs": 3.6110000000000007,
"taskDurationMs": 827.577,
"heapDeltaBytes": -17248376,
"heapUsedBytes": 48268372,
"domNodes": -278,
"jsHeapTotalBytes": 22908928,
"scriptDurationMs": 92.477,
"eventListeners": -153,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "canvas-zoom-sweep",
"durationMs": 1737.8840000000082,
"styleRecalcs": 32,
"styleRecalcDurationMs": 16.802999999999997,
"layouts": 6,
"layoutDurationMs": 0.6929999999999998,
"taskDurationMs": 364.91200000000003,
"heapDeltaBytes": 7916184,
"heapUsedBytes": 73138388,
"domNodes": 79,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 9.493,
"eventListeners": 19,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333332,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "canvas-zoom-sweep",
"durationMs": 1674.0280000000212,
"styleRecalcs": 29,
"styleRecalcDurationMs": 15.297999999999998,
"layouts": 6,
"layoutDurationMs": 0.6179999999999999,
"taskDurationMs": 361.195,
"heapDeltaBytes": 8230160,
"heapUsedBytes": 73385372,
"domNodes": 77,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 9.623000000000001,
"eventListeners": 21,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "dom-widget-clipping",
"durationMs": 570.3379999999925,
"styleRecalcs": 11,
"styleRecalcDurationMs": 6.809000000000001,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 356.251,
"heapDeltaBytes": -11279348,
"heapUsedBytes": 53996776,
"domNodes": 18,
"jsHeapTotalBytes": 24903680,
"scriptDurationMs": 51.03,
"eventListeners": 0,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333332,
"p95FrameDurationMs": 16.700000000000273
},
{
"name": "dom-widget-clipping",
"durationMs": 561.5750000000617,
"styleRecalcs": 10,
"styleRecalcDurationMs": 5.608999999999999,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 353.10699999999997,
"heapDeltaBytes": -11682964,
"heapUsedBytes": 53596936,
"domNodes": 16,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 48.938,
"eventListeners": 0,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66999999999998,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "large-graph-idle",
"durationMs": 2039.4440000000031,
"styleRecalcs": 10,
"styleRecalcDurationMs": 8.645,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 587.417,
"heapDeltaBytes": 12774516,
"heapUsedBytes": 73064884,
"domNodes": -281,
"jsHeapTotalBytes": 3244032,
"scriptDurationMs": 12.359000000000002,
"eventListeners": -149,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "large-graph-idle",
"durationMs": 2065.2810000000272,
"styleRecalcs": 9,
"styleRecalcDurationMs": 7.058999999999999,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 582.234,
"heapDeltaBytes": 13099596,
"heapUsedBytes": 73220128,
"domNodes": -281,
"jsHeapTotalBytes": 3506176,
"scriptDurationMs": 12.293000000000001,
"eventListeners": -179,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333335,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "large-graph-pan",
"durationMs": 2156.758000000025,
"styleRecalcs": 68,
"styleRecalcDurationMs": 12.464000000000002,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 1223.252,
"heapDeltaBytes": 9554488,
"heapUsedBytes": 70338504,
"domNodes": -283,
"jsHeapTotalBytes": 3436544,
"scriptDurationMs": 355.59999999999997,
"eventListeners": -149,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "large-graph-pan",
"durationMs": 2134.6119999999473,
"styleRecalcs": 69,
"styleRecalcDurationMs": 13.961000000000002,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 1125.8750000000002,
"heapDeltaBytes": -1687500,
"heapUsedBytes": 59508708,
"domNodes": -282,
"jsHeapTotalBytes": 4485120,
"scriptDurationMs": 297.568,
"eventListeners": -179,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66999999999998,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "large-graph-zoom",
"durationMs": 3151.594999999986,
"styleRecalcs": 65,
"styleRecalcDurationMs": 13.545000000000002,
"layouts": 60,
"layoutDurationMs": 7.325999999999999,
"taskDurationMs": 1276.1250000000002,
"heapDeltaBytes": 16495828,
"heapUsedBytes": 79187292,
"domNodes": 12,
"jsHeapTotalBytes": 5242880,
"scriptDurationMs": 348.733,
"eventListeners": 8,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333332,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "large-graph-zoom",
"durationMs": 3196.7769999999973,
"styleRecalcs": 65,
"styleRecalcDurationMs": 12.910000000000002,
"layouts": 60,
"layoutDurationMs": 7.263,
"taskDurationMs": 1354.7800000000002,
"heapDeltaBytes": -3888516,
"heapUsedBytes": 58596144,
"domNodes": -286,
"jsHeapTotalBytes": 4292608,
"scriptDurationMs": 379.348,
"eventListeners": -183,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.699999999999818
},
{
"name": "minimap-idle",
"durationMs": 2017.063999999948,
"styleRecalcs": 9,
"styleRecalcDurationMs": 6.926999999999999,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 578.7549999999999,
"heapDeltaBytes": 12564948,
"heapUsedBytes": 73693468,
"domNodes": -283,
"jsHeapTotalBytes": 2457600,
"scriptDurationMs": 10.780999999999999,
"eventListeners": -179,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "minimap-idle",
"durationMs": 2030.3049999999985,
"styleRecalcs": 7,
"styleRecalcDurationMs": 5.785000000000002,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 586.204,
"heapDeltaBytes": 12684436,
"heapUsedBytes": 74062480,
"domNodes": -286,
"jsHeapTotalBytes": 3244032,
"scriptDurationMs": 12.381999999999998,
"eventListeners": -147,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.699999999999818
},
{
"name": "subgraph-dom-widget-clipping",
"durationMs": 585.9570000000076,
"styleRecalcs": 48,
"styleRecalcDurationMs": 11.102999999999998,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 400.64099999999996,
"heapDeltaBytes": -9955952,
"heapUsedBytes": 55540916,
"domNodes": 22,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 121.59900000000002,
"eventListeners": 8,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.663333333333338,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "subgraph-dom-widget-clipping",
"durationMs": 585.0220000000945,
"styleRecalcs": 46,
"styleRecalcDurationMs": 8.92,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 387.05,
"heapDeltaBytes": -10128960,
"heapUsedBytes": 55356116,
"domNodes": 18,
"jsHeapTotalBytes": 24903680,
"scriptDurationMs": 113.071,
"eventListeners": 8,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "subgraph-idle",
"durationMs": 2001.1930000000007,
"styleRecalcs": 8,
"styleRecalcDurationMs": 6.799000000000001,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 434.654,
"heapDeltaBytes": 5337328,
"heapUsedBytes": 70848976,
"domNodes": 16,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 6.423000000000002,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "subgraph-idle",
"durationMs": 2010.7470000000376,
"styleRecalcs": 10,
"styleRecalcDurationMs": 8.246,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 434.76200000000006,
"heapDeltaBytes": 5218216,
"heapUsedBytes": 70780464,
"domNodes": 20,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 6.194000000000002,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "subgraph-mouse-sweep",
"durationMs": 1723.9159999999742,
"styleRecalcs": 76,
"styleRecalcDurationMs": 34.443,
"layouts": 16,
"layoutDurationMs": 4.132000000000001,
"taskDurationMs": 748.022,
"heapDeltaBytes": -3647528,
"heapUsedBytes": 61752304,
"domNodes": 63,
"jsHeapTotalBytes": 24641536,
"scriptDurationMs": 72.718,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "subgraph-mouse-sweep",
"durationMs": 1694.101000000046,
"styleRecalcs": 76,
"styleRecalcDurationMs": 32.951,
"layouts": 16,
"layoutDurationMs": 4.441,
"taskDurationMs": 730.915,
"heapDeltaBytes": -3956740,
"heapUsedBytes": 61467004,
"domNodes": 61,
"jsHeapTotalBytes": 25165824,
"scriptDurationMs": 73.237,
"eventListeners": 4,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.66333333333335,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "subgraph-transition-enter",
"durationMs": 1366.8799999999806,
"styleRecalcs": 20,
"styleRecalcDurationMs": 26.444999999999997,
"layouts": 15,
"layoutDurationMs": 11.015999999999998,
"taskDurationMs": 835.6339999999998,
"heapDeltaBytes": 22188052,
"heapUsedBytes": 99570016,
"domNodes": 13673,
"jsHeapTotalBytes": 9699328,
"scriptDurationMs": 14.533999999999999,
"eventListeners": 2375,
"totalBlockingTimeMs": 121,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.800000000000182
},
{
"name": "viewport-pan-sweep",
"durationMs": 8185.7640000000065,
"styleRecalcs": 249,
"styleRecalcDurationMs": 36.318999999999996,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 4052.116,
"heapDeltaBytes": 13420548,
"heapUsedBytes": 73882836,
"domNodes": -282,
"jsHeapTotalBytes": 3960832,
"scriptDurationMs": 953.8249999999999,
"eventListeners": -133,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "viewport-pan-sweep",
"durationMs": 8183.569000000034,
"styleRecalcs": 249,
"styleRecalcDurationMs": 34.568000000000005,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 3952.473,
"heapDeltaBytes": 13665968,
"heapUsedBytes": 73705896,
"domNodes": -283,
"jsHeapTotalBytes": 4222976,
"scriptDurationMs": 938.98,
"eventListeners": -133,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "vue-large-graph-idle",
"durationMs": 15826.544000000013,
"styleRecalcs": 0,
"styleRecalcDurationMs": 0,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 14833.113,
"heapDeltaBytes": -39244924,
"heapUsedBytes": 171849060,
"domNodes": -8312,
"jsHeapTotalBytes": -4624384,
"scriptDurationMs": 106.42999999999998,
"eventListeners": -16389,
"totalBlockingTimeMs": 0,
"frameDurationMs": 17.77333333333336,
"p95FrameDurationMs": 16.799999999999272
},
{
"name": "vue-large-graph-idle",
"durationMs": 15262.832000000002,
"styleRecalcs": 0,
"styleRecalcDurationMs": 0,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 14556.763,
"heapDeltaBytes": -31565092,
"heapUsedBytes": 165825756,
"domNodes": -8317,
"jsHeapTotalBytes": -20647936,
"scriptDurationMs": 80.211,
"eventListeners": -16387,
"totalBlockingTimeMs": 0,
"frameDurationMs": 17.223333333333358,
"p95FrameDurationMs": 16.799999999999272
},
{
"name": "vue-large-graph-pan",
"durationMs": 18545.93300000005,
"styleRecalcs": 159,
"styleRecalcDurationMs": 17.767000000000007,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 18092.291,
"heapDeltaBytes": -14877692,
"heapUsedBytes": 182668688,
"domNodes": -8312,
"jsHeapTotalBytes": -12591104,
"scriptDurationMs": 443.512,
"eventListeners": -16385,
"totalBlockingTimeMs": 4,
"frameDurationMs": 17.223333333333358,
"p95FrameDurationMs": 16.799999999999272
},
{
"name": "vue-large-graph-pan",
"durationMs": 18318.39500000001,
"styleRecalcs": 165,
"styleRecalcDurationMs": 17.841999999999995,
"layouts": 0,
"layoutDurationMs": 0,
"taskDurationMs": 17846.984,
"heapDeltaBytes": -13983620,
"heapUsedBytes": 182626076,
"domNodes": -8312,
"jsHeapTotalBytes": -10756096,
"scriptDurationMs": 409.02599999999995,
"eventListeners": -16385,
"totalBlockingTimeMs": 2,
"frameDurationMs": 17.776666666666642,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "workflow-execution",
"durationMs": 456.43200000006345,
"styleRecalcs": 18,
"styleRecalcDurationMs": 21.467,
"layouts": 3,
"layoutDurationMs": 1.1940000000000002,
"taskDurationMs": 110.66500000000002,
"heapDeltaBytes": 5067788,
"heapUsedBytes": 69601196,
"domNodes": 148,
"jsHeapTotalBytes": 4980736,
"scriptDurationMs": 7.069000000000001,
"eventListeners": 97,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666682,
"p95FrameDurationMs": 16.700000000000728
},
{
"name": "workflow-execution",
"durationMs": 451.0420000000295,
"styleRecalcs": 13,
"styleRecalcDurationMs": 16.713,
"layouts": 2,
"layoutDurationMs": 0.34199999999999997,
"taskDurationMs": 99.408,
"heapDeltaBytes": 4924036,
"heapUsedBytes": 69642868,
"domNodes": 123,
"jsHeapTotalBytes": 4980736,
"scriptDurationMs": 6.135,
"eventListeners": 97,
"totalBlockingTimeMs": 0,
"frameDurationMs": 16.666666666666668,
"p95FrameDurationMs": 16.700000000000273
}
]
}🎭 Playwright: ✅ 1818 passed, 0 failed · 4 flaky📊 Browser Reports
|
🎭 Playwright: ⏳ Running... |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## cloud/1.51 #15459 +/- ##
==============================================
+ Coverage 79.11% 81.47% +2.36%
==============================================
Files 2209 1882 -327
Lines 122386 117496 -4890
Branches 38327 36707 -1620
==============================================
- Hits 96821 95726 -1095
+ Misses 24989 21294 -3695
+ Partials 576 476 -100
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 335 files with indirect coverage changes 🚀 New features to boost your workflow:
|
Backport of #15092 to
cloud/1.51Automatically created by backport workflow.