From 26ca8e2cb0bccc0c3763619fb0631d93dfd639e9 Mon Sep 17 00:00:00 2001 From: 4gray <4gray@users.noreply.github.com> Date: Sun, 4 Oct 2026 16:44:40 +0200 Subject: [PATCH 01/20] perf(ui): make the libs/ui Eager components OnPush (#1818) * docs(performance): inventory the zoneless change-detection migration Plan item C6 step 2. docs/architecture/zoneless-migration.md lists the 66 production files (67 components) that still set ChangeDetectionStrategy.Eager, the ten places where a template-read plain field is written outside an Angular event, the NgZone and ChangeDetectorRef calls to remove at the flip, and the IPC, player, observer, timer and dialog paths checked as signal-safe. On Angular 22 an unset changeDetection already means OnPush, so only the explicit Eager components re-render on every tick. zoneless-migration.spec.ts in the performance harness compares the checklist with the code: a new Eager component, or a converted one left unticked, fails it. Co-Authored-By: Claude Opus 5.5 * perf(ui): make the libs/ui Eager components OnPush Plan item C6 step 3 for libs/ui/components and libs/ui/epg: eleven components (twelve with the EPG trust dialog) set ChangeDetectionStrategy.Eager and were checked on every tick, among them the always-mounted EPG progress panel the idle audit found re-rendering on every idle tick. Their template state is already signals, signal inputs, immutable dialog data or fields written from template events, so they switch to OnPush without other changes. The epg-item-description spec mutated dialog data after creation and marked only the fixture's host view; it now marks the component's own view, which OnPush requires. The libs/ui playback and remote-control components stay Eager for their own PRs. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: 4gray Co-authored-by: Claude Opus 5.5 --- .../performance/zoneless-migration.spec.ts | 91 +++++++ docs/architecture/performance-journeys.md | 3 +- docs/architecture/zoneless-migration.md | 254 ++++++++++++++++++ docs/maintenance/agent-context-map.md | 1 + .../confirm-dialog.component.ts | 3 +- .../content-hero/content-hero.component.ts | 3 +- .../expandable-text.component.ts | 3 +- .../content-about.component.ts | 3 +- .../portal-detail-shell.component.ts | 3 +- .../progress-capsule.component.ts | 3 +- .../episode-info-dialog.component.ts | 3 +- .../watched-badge/watched-badge.component.ts | 3 +- .../epg-item-description.component.spec.ts | 10 +- .../epg-item-description.component.ts | 2 +- .../epg-progress-panel.component.ts | 4 +- .../epg-source-status.component.ts | 2 +- 16 files changed, 367 insertions(+), 24 deletions(-) create mode 100644 apps/electron-backend-e2e/src/performance/zoneless-migration.spec.ts create mode 100644 docs/architecture/zoneless-migration.md diff --git a/apps/electron-backend-e2e/src/performance/zoneless-migration.spec.ts b/apps/electron-backend-e2e/src/performance/zoneless-migration.spec.ts new file mode 100644 index 000000000..c326c4a92 --- /dev/null +++ b/apps/electron-backend-e2e/src/performance/zoneless-migration.spec.ts @@ -0,0 +1,91 @@ +/* eslint-disable playwright/expect-expect -- These are Node assertion-based repository contract tests. */ +import assert from 'node:assert/strict'; +import { readdirSync, readFileSync } from 'node:fs'; +import { join, relative, sep } from 'node:path'; +import test from 'node:test'; +import { fileURLToPath } from 'node:url'; + +// docs/architecture/zoneless-migration.md lists every component that still +// opts out of OnPush. This keeps the checklist and the code in step: a new +// Eager component fails here, and so does a converted one left unticked. + +const workspaceRoot = fileURLToPath(new URL('../../../../', import.meta.url)); +const checklistPath = 'docs/architecture/zoneless-migration.md'; +const sourceRoots = ['apps', 'libs']; +const skippedDirectories = new Set(['node_modules', 'dist', 'coverage']); +const testOnlyFile = + /(\.spec|\.spec-stubs|\.spec-data|\.test-helpers|test-setup)\.ts$/; + +function listProductionSources(directory: string): string[] { + const files: string[] = []; + for (const entry of readdirSync(directory, { withFileTypes: true })) { + const path = join(directory, entry.name); + if (entry.isDirectory()) { + if (skippedDirectories.has(entry.name)) continue; + if (entry.name.endsWith('-e2e')) continue; + files.push(...listProductionSources(path)); + } else if ( + entry.name.endsWith('.ts') && + !entry.name.endsWith('.d.ts') && + !testOnlyFile.test(entry.name) + ) { + files.push(relative(workspaceRoot, path).split(sep).join('/')); + } + } + return files; +} + +function readSources(): Map { + const sources = new Map(); + for (const root of sourceRoots) { + for (const file of listProductionSources(join(workspaceRoot, root))) { + sources.set(file, readFileSync(join(workspaceRoot, file), 'utf8')); + } + } + return sources; +} + +function readEagerChecklist(): { open: string[]; done: string[] } { + const markdown = readFileSync(join(workspaceRoot, checklistPath), 'utf8'); + const section = markdown.split(/^## Eager components$/m)[1]; + assert.ok( + section, + `${checklistPath} must have an "Eager components" section` + ); + const body = section.split(/^## /m)[0]; + const open: string[] = []; + const done: string[] = []; + for (const match of body.matchAll(/^- \[( |x)\] `([^`]+\.ts)`/gm)) { + (match[1] === 'x' ? done : open).push(match[2]); + } + return { open: open.sort(), done: done.sort() }; +} + +const sources = readSources(); + +test('the zoneless checklist lists exactly the components that are still Eager', () => { + const eager = [...sources] + .filter(([, text]) => text.includes('ChangeDetectionStrategy.Eager')) + .map(([file]) => file) + .sort(); + const { open } = readEagerChecklist(); + + assert.deepEqual( + eager, + open, + `Production files with ChangeDetectionStrategy.Eager must match the unticked entries in ${checklistPath}. ` + + 'Do not add Eager components; tick an entry when its component is converted.' + ); +}); + +test('ticked checklist entries name files that exist', () => { + for (const file of readEagerChecklist().done) { + assert.ok(sources.has(file), `${file} is ticked but does not exist`); + } +}); + +test('no production component uses the deprecated Default strategy alias', () => { + for (const [file, text] of sources) { + assert.doesNotMatch(text, /ChangeDetectionStrategy\.Default\b/, file); + } +}); diff --git a/docs/architecture/performance-journeys.md b/docs/architecture/performance-journeys.md index 776e5c3dd..25ab024cf 100644 --- a/docs/architecture/performance-journeys.md +++ b/docs/architecture/performance-journeys.md @@ -208,7 +208,8 @@ window, and `evidence.idle.domMutations` the mutation records in the whole document. The [idle work audit](idle-work-audit-2026-09.md) found Eager components re-rendering on every such tick in a dev build; this counter measures the ticks in the optimized build, so plan item C6 can show what -zoneless change detection removes. +zoneless change detection removes; its checklist is the +[zoneless migration](zoneless-migration.md). The window opens when the settle window closes, so startup data still landing is not idle work, and it is timed by a renderer `setTimeout`. The diff --git a/docs/architecture/zoneless-migration.md b/docs/architecture/zoneless-migration.md new file mode 100644 index 000000000..630d51ff2 --- /dev/null +++ b/docs/architecture/zoneless-migration.md @@ -0,0 +1,254 @@ +# Zoneless change-detection migration + +Working checklist for plan item C6 of the performance journeys plan: move the +renderer (`apps/web`) from zone.js to `provideZonelessChangeDetection()`. +The win is measured with the change-detection tick counters described in +[performance journeys](performance-journeys.md#change-detection-ticks); the +[idle work audit](idle-work-audit-2026-09.md) found the Eager roots that +re-render on every tick. Update this file in the same PR that converts an item. + +The inventory was taken on `e8b181fce` (2026-10-04, Angular 22.1.6). Run +`pnpm nx run electron-backend-e2e:test-performance-harness` after editing the +Eager list: `zoneless-migration.spec.ts` fails when the list and the code +disagree, so a new Eager component cannot land unnoticed and a converted one +must be ticked here. + +## Starting point + +- **OnPush is already the default.** Since Angular 22 an unset + `changeDetection` means OnPush, and the old `Default` strategy is spelled + `ChangeDetectionStrategy.Eager`. Only components that set `Eager` are + checked on every tick. `ChangeDetectionStrategy.Default` is not used. +- **Renderer bootstrap.** `apps/web/src/app/app.config.ts` provides + `provideZoneChangeDetection({ eventCoalescing: true })` and + `apps/web/project.json` builds with `"polyfills": ["zone.js"]`. + `apps/remote-control-web` does the same; it is a separate app and outside + this migration unless a step says otherwise. +- **Unit tests already run zoneless.** Every `src/test-setup.ts` (apps/web, + apps/remote-control-web and 24 libs) calls `setupZonelessTestEnv` and loads + `zone.js`/`zone.js/testing` only for `fakeAsync` and `waitForAsync`. A + component that passes its specs is therefore not proof of zone-free + production behavior when the spec calls `fixture.detectChanges()` itself. +- **IPC callbacks never ran in the Angular zone.** `window.electron.on*` + listeners arrive through `contextBridge` and are not zone-patched, so every + one that works today already writes signals or calls `NgZone.run`. +- **Counters before the migration** (macOS, from + [performance journeys](performance-journeys.md#change-detection-ticks)): + `renderer.cdTicksToFirstCard` 20–21 (the one-tick zone.js race), + `renderer.cdTicksIdle30s` 3, `renderer.cdTicksToFirstPage` 22; + `renderer.cdTicksToPlaying` has no recorded run yet. + +## PR sequence + +1. [ ] Keep `@ngrx/store-devtools` out of production bundles (#1810, open). Not a + zone change; it lowered `renderer.initialBytes` before the migration + starts moving it. +2. [x] This inventory and its guard spec. +3. [ ] Per-project PRs, in this order, each converting the project's Eager + components and fixing its zone-dependent sites while zone.js stays on: + `libs/ui/*`, `libs/workspace/*`, `libs/playlist/*`, `libs/portal/*`, + playback (`libs/ui/playback`, `libs/playlist/m3u/feature-player`), + `apps/web`. Each reports the tick counters before and after and runs the + affected unit and E2E tests. +4. [ ] `provideZonelessChangeDetection()` behind a build-time + `fileReplacements` flag, off by default; all four journeys and the + Electron E2E suite run with it on. +5. [ ] Flag on by default, `zone.js` out of `polyfills`, new tick baselines + (`renderer.cdTicksIdle30s` and any counter that becomes deterministic once + the zone.js race is gone). + +## Eager components + +66 production files, 67 components (`epg-progress-panel.component.ts` holds +two). Tick an entry by deleting `changeDetection: ChangeDetectionStrategy.Eager` +(or setting OnPush) once its template state is signals, signal inputs or +explicitly marked. The guard spec compares the unticked entries with the +files that still contain `ChangeDetectionStrategy.Eager`. + +### apps/web (15) + +- [ ] `apps/web/src/app/app.component.ts` (idle audit root) +- [ ] `apps/web/src/app/app-update-notification-panel.component.ts` (idle audit root) +- [ ] `apps/web/src/app/settings/app-update-release-notes-dialog.component.ts` +- [ ] `apps/web/src/app/settings/settings.component.ts` +- [ ] `apps/web/src/app/settings/settings-about-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-backup-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-dashboard-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-delete-all-playlists-dialog.component.ts` +- [ ] `apps/web/src/app/settings/settings-epg-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-general-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-playback-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-remote-control-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-reset-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-tmdb-section.component.ts` +- [ ] `apps/web/src/app/settings/settings-unsaved-changes-dialog.component.ts` + +### libs/ui (20 files, 21 components) + +- [x] `libs/ui/components/src/lib/confirm-dialog/confirm-dialog.component.ts` +- [x] `libs/ui/components/src/lib/content-hero/content-hero.component.ts` +- [x] `libs/ui/components/src/lib/expandable-text/expandable-text.component.ts` +- [x] `libs/ui/components/src/lib/portal-detail-shell/content-about.component.ts` +- [x] `libs/ui/components/src/lib/portal-detail-shell/portal-detail-shell.component.ts` +- [x] `libs/ui/components/src/lib/progress-capsule/progress-capsule.component.ts` +- [x] `libs/ui/components/src/lib/season-container/episode-info-dialog.component.ts` +- [x] `libs/ui/components/src/lib/watched-badge/watched-badge.component.ts` +- [x] `libs/ui/epg/src/lib/epg-item-description/epg-item-description.component.ts` +- [x] `libs/ui/epg/src/lib/epg-progress-panel/epg-progress-panel.component.ts` (idle audit root; also `EpgTrustConfirmDialogComponent`) +- [x] `libs/ui/epg/src/lib/epg-source-status/epg-source-status.component.ts` +- [ ] `libs/ui/remote-control/src/lib/remote-control/remote-control.component.ts` (`apps/remote-control-web` only) +- [ ] `libs/ui/playback/src/lib/art-player/art-player.component.ts` +- [ ] `libs/ui/playback/src/lib/audio-player/audio-player.component.ts` +- [ ] `libs/ui/playback/src/lib/external-player-info-dialog/external-player-info-dialog.component.ts` +- [ ] `libs/ui/playback/src/lib/html-video-player/html-video-player.component.ts` +- [ ] `libs/ui/playback/src/lib/video-player/sidebar/sidebar.component.ts` +- [ ] `libs/ui/playback/src/lib/vjs-player/vjs-player.component.ts` +- [ ] `libs/ui/playback/src/lib/vod-details/vod-details.component.ts` +- [ ] `libs/ui/playback/src/lib/web-player-view/web-player-view.component.ts` + +`libs/ui/playback` (8) goes with the playback PR, not the `libs/ui` one. + +### apps/remote-control-web (1) + +- [ ] `apps/remote-control-web/src/app/app.ts` (separate app; converts with `remote-control.component.ts`) + +### libs/workspace (7) + +- [ ] `libs/workspace/shell/feature/src/lib/workspace-command-palette/workspace-command-palette.component.ts` +- [ ] `libs/workspace/shell/feature/src/lib/workspace-context-panel/workspace-collection-context-panel.component.ts` +- [ ] `libs/workspace/shell/feature/src/lib/workspace-context-panel/workspace-context-panel.component.ts` +- [ ] `libs/workspace/shell/feature/src/lib/workspace-context-panel/workspace-settings-context-panel.component.ts` +- [ ] `libs/workspace/shell/feature/src/lib/workspace-keyboard-shortcuts/workspace-keyboard-shortcuts-dialog.component.ts` +- [ ] `libs/workspace/shell/feature/src/lib/workspace-shell/workspace-shell.component.ts` (idle audit root) +- [ ] `libs/workspace/shell/feature/src/lib/workspace-sources/workspace-sources.component.ts` + +### libs/playlist (14) + +- [ ] `libs/playlist/import/feature/src/lib/add-playlist-dialog/add-playlist-dialog.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/auto-import/auto-import.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/file-upload/file-upload.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/stalker-portal-import/stalker-portal-import.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/text-import/text-import.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/url-upload/url-upload.component.ts` +- [ ] `libs/playlist/import/feature/src/lib/xtream-code-import/xtream-code-import.component.ts` +- [ ] `libs/playlist/m3u/feature-player/src/lib/m3u-vod-detail/m3u-vod-detail.component.ts` +- [ ] `libs/playlist/m3u/feature-player/src/lib/video-player/video-player.component.ts` +- [ ] `libs/playlist/shared/ui/src/lib/recent-playlists/empty-state/empty-state.component.ts` +- [ ] `libs/playlist/shared/ui/src/lib/recent-playlists/playlist-info/playlist-info.component.ts` +- [ ] `libs/playlist/shared/ui/src/lib/recent-playlists/playlist-item/playlist-item.component.ts` +- [ ] `libs/playlist/shared/ui/src/lib/source-health/source-cleanup-dialog.component.ts` +- [ ] `libs/playlist/shared/ui/src/lib/source-health/source-health-indicator.component.ts` + +`libs/playlist/m3u/feature-player` (2) goes with the playback PR. + +### libs/portal (9) + +- [ ] `libs/portal/shared/ui/src/lib/components/favorites-layout/favorites-layout.component.ts` +- [ ] `libs/portal/shared/ui/src/lib/components/playlist-error-view/playlist-error-view.component.ts` +- [ ] `libs/portal/shared/ui/src/lib/components/search-form/search-form.component.ts` +- [ ] `libs/portal/shared/ui/src/lib/navigation/portal-rail-links.component.ts` +- [ ] `libs/portal/stalker/feature/src/lib/stalker-catalog-detail/stalker-catalog-detail.component.ts` +- [ ] `libs/portal/stalker/feature/src/lib/stalker-favorites-button/stalker-favorites-button.component.ts` +- [ ] `libs/portal/stalker/feature/src/lib/stalker-series-view/stalker-series-view.component.ts` +- [ ] `libs/portal/xtream/feature/src/lib/global-search-results/global-search-results.component.ts` +- [ ] `libs/portal/xtream/feature/src/lib/serial-details/serial-details.component.ts` + +Test stubs that set Eager (`*.spec.ts`, `*.spec-stubs.ts`, `*.spec-data.ts`, +`*.test-helpers.ts`) are not listed; they do not ship. + +## Zone-dependent sites + +Plain (non-signal) fields read by a template and written from a callback +that is not an Angular template event. Under zone.js the next tick happens to +refresh an Eager view; under zoneless nothing schedules one. Each fix makes +the field a signal (or a `computed`), or writes it through one. + +| Done | Site | What depends on the zone | Owning PR | +| --- | --- | --- | --- | +| [ ] | `libs/playlist/m3u/feature-player/src/lib/video-player/video-player.component.ts` `onChannelNumberInput`/`clearChannelNumberInput` | 2 s `window.setTimeout` hides the channel-number overlay through plain `showChannelNumberOverlay`/`channelNumberInput` | playback | +| [ ] | same file, `applySettings` and the settings `effect()` | IndexedDB `storage.get(...).subscribe` and an effect assign plain `playerSettings`, which picks the player in the template | playback | +| [ ] | `libs/playlist/shared/ui/src/lib/recent-playlists/playlist-item/playlist-item.component.ts` `checkPortalStatus` | plain `portalStatus` assigned after `await` in `ngOnInit` (PWA only: skipped when source health is supported) | playlist | +| [ ] | `libs/playlist/shared/ui/src/lib/recent-playlists/playlist-info/playlist-info.component.ts` (EPG clear and EPG file pick handlers) | plain `playlist` reassigned after `await` | playlist | +| [ ] | `libs/playlist/import/feature/src/lib/stalker-portal-import/stalker-portal-import.component.ts` (device-id derivation) | `form.patchValue` after `await`; template getters read `control.value`, which is not signal-backed | playlist | +| [ ] | `libs/portal/stalker/feature/src/lib/stalker-live-stream-layout/stalker-live-stream-layout.component.ts` (favorites load) | `favorites` Map filled in a `subscribe` without `markForCheck`; the component is OnPush already, so this is a latent bug today | portal | +| [ ] | `libs/portal/xtream/feature/src/lib/portal-channels-list/portal-channels-list.component.ts` (favorites load) | same pattern; the neighbouring `favoriteMarks.changes$` handler does call `markForCheck` | portal | +| [ ] | same file, programme dialog `afterClosed` | deletes from `epgPrograms`/`currentProgramsProgress` after `await` without marking | portal | +| [ ] | `apps/web/src/app/settings/settings-backup.facade.ts` (backup import) | `change` listener on a detached file input → `hydrateFromStore()`; section templates read `form().value.theme`/`coverSize` | apps/web | +| [ ] | `libs/ui/remote-control/src/lib/remote-control/remote-control.component.ts` | plain `isLoading`/`error`/`status` written after `await` and from a 2 s `setInterval` | only if `apps/remote-control-web` goes zoneless | + +## Explicit zone and change-detector calls + +They keep working under zoneless (`NgZone` becomes `NoopNgZone`, so `run` +and `runOutsideAngular` just call through). Remove them in the flip PR, not +before: with zone.js on they still matter. + +- [ ] `apps/web/src/app/settings/settings-unload-guard.service.ts`: two + `zone.run` calls around the window-close dialog (IPC + `onWindowCloseRequested` and `beforeunload`). +- [ ] `libs/ui/playback/src/lib/embedded-mpv-player/embedded-mpv-session-controller.ts`: + `runOutsideAngular(() => setInterval(...))` for the position poll; + `embedded-mpv-session-controller.position.spec.ts` asserts the call and + changes with it. +- [ ] `libs/workspace/dashboard/data-access/src/lib/dashboard-data.service.ts`: + 18 `ngZone.run(() => signal.set(...))` calls, all redundant around signal + writes. +- [ ] `libs/workspace/dashboard/data-access/src/lib/dashboard-source-expiry.service.ts`: + one `ngZone.run` around a signal update. +- `ChangeDetectorRef` in `stalker-live-stream-layout.component.ts` + (4 × `markForCheck`, 1 × `detectChanges` before measuring a row) and + `portal-channels-list.component.ts` (3 × `markForCheck`, 2 × + `detectChanges`): correct under zoneless; replace the Maps with signals in + the portal PR if it stays small. + +## Checked and signal-safe + +No change needed; recorded so the flag PR knows where to look if a journey +regresses. Embedded MPV and external players are the riskiest paths because +their events arrive over IPC. + +- **IPC listeners** (17 registrations): app update status, external player + sessions, window close and window state, player errors, playlist open + requests, embedded MPV sessions, playback history gate, downloads, + recordings, playlist refresh, DB operation and save progress, EPG progress, + playback position updates, channel change and remote-control commands. All + write signals, signal stores or NgRx, or have no UI state. +- **Player libraries** (video.js, mpegts.js, hls.js, artplayer, shaka, native + `