Files
pipelines/app/notes/perf-round5.md
T
alan 98cdf63079 Prevent floating window content rebuilds
Keep window content scope independent from frame changes, and retain the page theme and root page across layer rebuilds. Add repaint boundaries and regression coverage so dragging and resizing avoid unrelated content work while content changes still propagate.
2026-11-11 02:05:30 +00:00

4.7 KiB

Performance round 5: moving a window does not rebuild its content

Round 5's candidate: every pointer event of a window drag rebuilt every window's whole content. WindowScope carried the body Rect and compared the whole WindowEntry, the navigator's ThemeData was rebuilt with copyWith on every build, and the root MaterialPage was a new object on every build.

Change

lib/shell/windows/:

  • window_scope.dart: WindowScope keeps only manager and entry, and notifies only when what content can read changes (id, kind, contentId, serverKey, data). A new WindowBodyScope (an InheritedWidget with the body Rect) carries the position and size that used to be in WindowScope.
  • window_navigator.dart: WindowNavigator.theme(context, child:) became WindowNavigator.themeData(theme), so the layer can keep the page-transition ThemeData. WindowPageBox reads the body from WindowBodyScope, and its page child is a RepaintBoundary.
  • window_layer.dart: _WindowLayerState keeps the page-transition theme in a field and rebuilds it only when Theme.of(context) is a different object; it keeps the root MaterialPage in a field (same key) and rebuilds it only when the kind changes. WindowFrame is wrapped in a RepaintBoundary.

No behaviour change: frames, snapping, resize limits, popups, pushed pages, minimise/maximise, focus and the shell's APIs are as before.

tool/capture/window_probe.dart: ProbeContentState.lastSize records the MediaQuery size the content built at, so tests can see a resize reach it (no visual change).

Deterministic build counts

test/shell/windows/window_rebuild_test.dart:

  • dragging a window's title over 8 pointer moves: the dragged window's content and the other window's content keep their builds count (0 rebuilds);
  • resizing a window over 5 pointer moves: the other window keeps its count, the resized window's content rebuilds and sees the new MediaQuery size (360x380 -> 280x330 body);
  • manager.setContent retargets a content whose element is keyed stably: the same state rebuilds with the new contentId.

Against the old implementation (lib changes stashed, test run unchanged): 2 failed — dragged window rebuilt at move 0 (builds 2 -> 3) and other window rebuilt at move 0 (2 -> 3). The new code passes all 3.

Browser bench

Built twice: the old code (lib/shell/windows changes stashed) into build/probe-before, and this branch into build/probe-app:

/Users/alan/development/flutter/bin/flutter build web \
  --target tool/search_selection_probe_entry.dart --output build/probe-before
/Users/alan/development/flutter/bin/flutter build web \
  --target tool/search_selection_probe_entry.dart --output build/probe-app

Run, from app/, against each build in turn:

node tool/perf/interaction_bench.mjs --build build/probe-before --out /tmp/bench \
  --gpu --only 'desktop: drag a probe window' --repeat 3
node tool/perf/interaction_bench.mjs --build build/probe-app --out /tmp/bench \
  --gpu --only 'desktop: drag a probe window' --repeat 3

Three before/after rounds (the machine was shared with other pipeline test runs; load average 9-14 during these, so frame counts vary. buildMs/frame = buildSum / frames):

round code frames buildSum ms/frame buildMax longest over16 rasterSum
1 before 50 952.2 19.0 63.5 73.9 31 107.4
1 after 49 824.8 16.8 59.1 74.0 27 107.9
2 before 49 615.6 12.6 25.5 28.4 15 62.1
2 after 51 583.0 11.4 37.4 39.9 13 87.2
3 before 51 527.9 10.4 16.2 20.3 9 68.3
3 after 47 606.8 12.9 24.1 26.9 18 83.5

The browser numbers are inconclusive on this loaded machine: only round 1 shows less build work, and the spread between rounds (10.4-19.0 ms/frame on the same code) is larger than the change. The reliable result is the build count: the drag went from one content build per pointer event per window (120 builds over a 40-move drag with three windows) to none. Window chrome and framework layout still run on every pointer event; that is the remaining build cost in this scenario, not content.

Checks

  • tool/memwatch/full.sh 'test/shell/windows test/features/chat/chat_floating_pane_test.dart test/features/terminal': 119 passed, 0 failed.
  • tool/analyze.sh: clean.

Affected UI states (for ui-review)

/runs?windows=2 at 1280x800 light: the windows after a title drag (drag=250,132>300,150), after a corner resize (drag=483,523>120,80), and a page pushed inside a window (click page) then dragged: the content must follow the window, stay inside it, and show no stale or clipped frame.