Files
plezy/lib/services/library_events/plex_library_event_socket.dart
T
edde746 5a666fd10f feat(discover): refresh home and library content from server library push events
New media added server-side was invisible while the app was open - the
client had no channel for library-change notifications, so the home
screen and library tabs sat stale until an app restart.

Each online server now runs a reconnecting websocket push channel
(Plex `/:/websockets/notifications`; Jellyfin/Emby `/socket` with the
dialect deltas, including Emby's capabilities registration), owned per
server by a LibraryEventService supervisor that follows server
online/offline/replaced-client transitions and app lifecycle. Channels
emit one coalesced LibraryChangeEvent per burst on a leading-edge
throttle modeled on Plex Web's repopulate pacing: the first settled
change surfaces immediately and a library scan's flood merges behind
it. Connection failure degrades silently to the stale-refresh paths -
bounded reconnect backoff, re-armed on every status sync.

Consumers pace their reaction through one shared RefreshPacer: burst
debounce, blocked retry while video playback or an active scroll owns
the surface, a cooldown bounding pass frequency during bulk imports,
and credit for committed pull passes so a push landing right after a
fresh load defers to the cooldown's trailing edge.

- Discover runs a debounced full pass and swaps the result in place;
  the hero carousel resets only when a pass lands first content, so a
  push never yanks a screen the user is reading. Pushed removals drop
  from every visible list immediately via the deletion bus, scoped to
  the emitting server.
- The visible library tab swaps its data in place: transaction tabs
  reload without clearing, and the browse and paginated card grids
  refetch their loaded span (Plex Web's repopulateRange) with the
  scroll offset anchored on the first visible item and the span
  clamped after alpha jumps. Hidden tabs - and tabs behind another
  main tab - mark per-library staleness epochs instead and reload when
  next shown; epochs are snapshotted at load start so a push racing an
  in-flight fetch stays stale.
- The stale-resume and tab-shown paths refetch home hubs (previously
  Continue Watching only), covering setups where the socket cannot
  connect.

close #1646
2026-08-31 18:52:03 +02:00

80 lines
3.1 KiB
Dart

import 'library_event_socket.dart';
/// Plex realtime notifications: `ws(s)://<server>/:/websockets/notifications`.
///
/// Every frame is a `NotificationContainer`. One library scan floods the
/// socket (156 frames measured on Plex 1.43 for a single new movie: 80
/// `activity`, 52 `progress`, 14 `timeline`, plus unrelated `playing`
/// session traffic), so only settled `timeline` entries feed the debounce:
///
/// ```json
/// {"NotificationContainer": {"type": "timeline", "TimelineEntry": [
/// {"identifier": "com.plexapp.plugins.library", "sectionID": "1",
/// "itemID": "10141", "type": 1, "state": 5, "metadataState": "created"}]}}
/// ```
///
/// `state` walks 0→5 while an item is scanned/matched/analyzed; `state == 5`
/// is the settled commit. A deletion emits the same entry with `type: -1`
/// (measured; the kind field is replaced, there is no separate deleted state).
/// Adds and metadata updates are indistinguishable at settle time, so both
/// advisory flags are set for non-deletions.
class PlexLibraryEventSocket extends LibraryEventSocket {
PlexLibraryEventSocket({
required super.serverId,
required this.baseUrl,
required this.token,
super.channelFactory,
super.debounce = const Duration(seconds: 10),
super.retryBaseDelay,
super.maxConnectAttempts,
});
/// Read live so an endpoint failover or token refresh lands on the next
/// connect attempt.
final String Function() baseUrl;
final String? Function() token;
/// Only timeline entries from the library plugin describe library content;
/// other identifiers carry playlist/butler/provider timelines.
static const _libraryIdentifier = 'com.plexapp.plugins.library';
/// Timeline `state` for a settled (fully committed) entry.
static const _stateSettled = 5;
/// Timeline `type` marking a deleted item.
static const _typeDeleted = -1;
@override
Uri buildUri() {
// Keep any reverse-proxy path prefix from the base URL, like the
// MediaBrowser socket does.
final base = webSocketBase(baseUrl());
return base.replace(path: '${base.path}/:/websockets/notifications', queryParameters: {'X-Plex-Token': ?token()});
}
@override
void onFrame(dynamic frame) {
final decoded = tryDecodeJsonFrame(frame);
final container = decoded?['NotificationContainer'];
if (container is! Map) return;
if (container['type'] != 'timeline') return;
final entries = container['TimelineEntry'];
if (entries is! List) return;
for (final entry in entries) {
if (entry is! Map) continue;
if (entry['identifier'] != _libraryIdentifier) continue;
if (entry['state'] != _stateSettled) continue;
final sectionId = entry['sectionID']?.toString();
final itemId = entry['itemID']?.toString();
final removed = entry['type'] == _typeDeleted;
scheduleLibraryChange(
libraryIds: [if (sectionId != null && sectionId.isNotEmpty) sectionId],
removedItemIds: [if (removed && itemId != null && itemId.isNotEmpty) itemId],
added: !removed,
updated: !removed,
removed: removed,
);
}
}
}