Files
iptvnator/docs/architecture/zoneless-migration.md
T
3cc5af1492 perf(playback): make the web players and M3U player OnPush (#1822)
* perf(playback): make the web players and M3U player OnPush

Plan item C6 step 3 for playback: the eight Eager components in
libs/ui/playback (video.js, ArtPlayer, HTML5/hls/mpegts, audio player,
web player view, VOD details, sidebar, external-player dialog) and the M3U
video player and VOD detail switch to OnPush. The player libraries' events
already reach the UI through the signal-backed controls adapter or
outputs, and the players' DOM belongs to the libraries.

The M3U video player rendered three plain fields written outside template
events: the channel-number overlay, cleared by a 2 s debounce timer, and
the player choice, written from an IndexedDB read and a settings effect.
They are signals now, and a test checks that the overlay leaves the DOM
when the timer fires.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(playback): let the overlay's signal write schedule its own render

Review follow-up (Greptile): the test forced a render with
fixture.detectChanges() after the debounce timer, so it would pass even
if the signal write stopped scheduling an OnPush render. It now runs the
fixture with autoDetectChanges and only advances the fake timers; with
plain fields under OnPush the overlay never renders and the test fails.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: 4gray <fourgray@proton.me>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 14:12:52 +02:00

16 KiB
Raw Blame History

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; the idle work audit 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): 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. 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)

  • libs/ui/components/src/lib/confirm-dialog/confirm-dialog.component.ts
  • libs/ui/components/src/lib/content-hero/content-hero.component.ts
  • libs/ui/components/src/lib/expandable-text/expandable-text.component.ts
  • libs/ui/components/src/lib/portal-detail-shell/content-about.component.ts
  • libs/ui/components/src/lib/portal-detail-shell/portal-detail-shell.component.ts
  • libs/ui/components/src/lib/progress-capsule/progress-capsule.component.ts
  • libs/ui/components/src/lib/season-container/episode-info-dialog.component.ts
  • libs/ui/components/src/lib/watched-badge/watched-badge.component.ts
  • libs/ui/epg/src/lib/epg-item-description/epg-item-description.component.ts
  • libs/ui/epg/src/lib/epg-progress-panel/epg-progress-panel.component.ts (idle audit root; also EpgTrustConfirmDialogComponent)
  • 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-only files that set Eager are not listed; they do not ship. The guard skips every *.spec.ts / *.test.ts file with or without a suffix of one or more segments (*.spec-stubs.ts, *.test-helpers.ts, *.test-data-stubs.ts, …), test-setup.ts and test-stubs/ directories.

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
[x] 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
[x] 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 <video>): callbacks bump signals in the control adapters or emit outputs whose parent handlers write signals.
  • Observers (13 Intersection/Resize/Mutation observers) and document and window listeners (~40): signals or DOM only. @HostListener bindings are Angular listeners and mark their view.
  • Timers (~130 setTimeout/setInterval/rAF/queueMicrotask): all write signals, touch the DOM or focus, or have no UI state, apart from the two in the table above.
  • Dialogs and snackbars (20 afterClosed/onAction sites): signals, stores, outputs or navigation, apart from the one in the table above.
  • No production code uses NgZone.onStable, onMicrotaskEmpty, isStable, ApplicationRef.tick(), Zone.current or ngDoCheck.

Build, tests and runtime details

  • provideServiceWorker(..., { registrationStrategy: 'registerWhenStable:30000' }): under zoneless "stable" means no pending tasks. The 30 s bound still registers the worker; check the PWA build in the flag PR.
  • change-detection-tick-counter.ts wraps ApplicationRef._tick, which the zoneless scheduler also calls, so the counters stay comparable.
  • Specs that need zone.js: fakeAsync in playlist-switcher.component.spec.ts and stalker-live-navigation.spec.ts, waitForAsync in 13 files. They keep zone.js/testing until rewritten; removing zone.js from the build polyfills does not affect them.
  • Unreferenced leftovers to delete in the flip PR: apps/web/src/polyfills.ts, apps/web/src/polyfills-test.ts, apps/web/src/setup-jest.ts (no project, tsconfig or Jest config uses them).

Measuring a PR

Build electron-performance and run the journeys as described in performance journeys, then paste renderer.cdTicksToFirstCard, renderer.cdTicksIdle30s, renderer.cdTicksToFirstPage and renderer.cdTicksToPlaying before and after. While zone.js is on, removing Eager does not change the number of ticks, only the work per tick; expect the counters to stay put until the flag PR and the template work (DOM mutations, profile time) to drop.