Files
plezy/test/services/media_browser_paths_test.dart
T
edde746 05fd622968 feat(emby): add Emby as a MediaBrowser backend alongside Jellyfin
Emby is Jellyfin's upstream ancestor and speaks a near-identical MediaBrowser
API, so the existing Jellyfin stack is parameterised by a `MediaBrowserDialect`
rather than forked. `JellyfinClient`, its auth service, endpoint discovery, LAN
discovery, and the add/edit connection screens all take the dialect and keep one
implementation; `MediaBackend.emby` and `ConnectionKind.emby` carry it through
the neutral models, the Drift `kind` discriminator, downloads, and caches.

Every divergence below was measured against a live Emby 4.9.5 server, not
inferred from documentation, and each is documented at its capability getter.
Jellyfin's request strings stay byte-identical so nothing about its behaviour
changes.

Routes and auth
- Emby only accepts the pre-10.9 user-scoped item routes (`/Users/{id}/Items/…`,
  `/Users/{id}/PlayedItems/…`, `/Users/{id}/FavoriteItems/…`); the unprefixed
  forms Jellyfin 10.11 added return 404.
- The API is also served under a legacy `/emby` prefix, and both dialects accept
  the token as `X-Emby-Token` or `api_key=`.
- Emby answers only its own LAN discovery datagram ("who is EmbyServer?") and
  ignores Jellyfin's; its default HTTPS port is 8920.
- No `/QuickConnect` route exists, so Quick Connect stays Jellyfin-only.

Row fields Emby withholds
- `ProductionYear`, `OfficialRating`, `PremiereDate` and `DateCreated` are absent
  from list rows unless named in `Fields`, which would otherwise strip the year
  and age-rating badge from every card in the app.
- `UserData.LastPlayedDate` never appears on a list row under `Fields=UserData`,
  `EnableUserData=true` or the user-scoped `Ids=` form — only on the single-item
  detail route, or when the Emby-specific `UserDataLastPlayedDate` token is
  requested. Without it every recency-ordered surface silently degrades to
  library-add time, and `JellyfinApiCache.applyWatchState` stamps
  `DateTime.now()` on watched rows, so an offline watch-state pull would rewrite
  the cached play time of everything it walked.

Continue Watching and Next Up
- Emby computes Next Up per series only: the library-wide `/Shows/NextUp` query
  returns nothing under every parameter combination tried. The shelf is
  therefore reconstructed from a played-episode recency scan plus one
  `/Shows/NextUp?SeriesId=` per distinct series, bounded by a shared wall clock
  that covers the scan as well — per-request timeouts cannot bound the pass
  because `MediaServerHttpClient` times the connect and receive phases
  independently. Rows are stamped with their series' newest play from the same
  response that ordered them, so no per-series enrichment request is needed.
- `/Shows/NextUp` ignores `NextUpDateCutoff`, and no server-side played-date
  filter exists to delegate to (`MinDatePlayed` and `MinDateLastPlayed` are
  ignored; `MinDateLastSaved`, `MinDateCreated` and `MinPremiereDate` filter
  unrelated dates), so the 365-day window is applied to the scanned dates.
- The resume route returns items with no saved position, including plain next
  episodes, so the Emby resume leg reads from `/Items?Filters=IsResumable`.
- Emby is ahead of Jellyfin in one place: `/Users/{id}/Items/{id}/HideFromResume`
  makes Continue Watching removal a real capability.

Everything else
- `/Sessions/Playing` and `/Sessions/Playing/Progress` reject a body with no
  `PlaySessionId` (HTTP 400), so playback reporting always sends one.
- Passing any `MediaTypes` value to the playlist query returns an empty list.
- There is no aggregate `/Items/Filters` route; the four filter facets are
  reassembled from `/Genres`, `/OfficialRatings`, `/Studios` and `/Tags`.
- Metadata writes take name-pair lists (`Genres: [{'Name': 'Action'}]`); the
  plain string array is accepted and then silently discarded.
- Custom artwork uploads must be base64 text, not raw bytes — which was broken
  for Jellyfin too and is fixed for both.
- Trickplay, media segments and lyrics 404 on Emby, so scrub previews are absent
  and intro/credit markers fall back to chapter names.

Verified against a local Emby 4.9.5 and a Jellyfin 10.11.11 control server:
onboarding, browse, detail, playable stream URLs serving real bytes, subtitle
sidecars, watch-state write and restore, hubs, cross-server aggregation and
search across both backends simultaneously.
2026-08-05 06:09:26 +02:00

54 lines
3.0 KiB
Dart

import 'package:flutter_test/flutter_test.dart';
import 'package:plezy/media/media_browser_dialect.dart';
import 'package:plezy/services/media_browser_paths.dart';
/// Route table for the endpoints where the two MediaBrowser dialects diverge.
///
/// Every Emby expectation below was measured against Emby 4.9.5; the Jellyfin
/// spelling of the same route returns 404 there (500 for `/Users/Me`, which
/// binds `Me` as a user id). These are the exact strings the client sends, so a
/// regression here is a silent loss of watch state or Continue Watching.
void main() {
const jellyfin = MediaBrowserPaths(dialect: MediaBrowserDialect.jellyfin, userId: 'user-1');
const emby = MediaBrowserPaths(dialect: MediaBrowserDialect.emby, userId: 'user-1');
group('Jellyfin uses the 10.9+ unprefixed routes', () {
test('current user', () => expect(jellyfin.currentUser, '/Users/Me'));
test('resume', () => expect(jellyfin.resumeItems, '/UserItems/Resume'));
test('played', () => expect(jellyfin.playedItem('item-9'), '/UserPlayedItems/item-9'));
test('favorite', () => expect(jellyfin.favoriteItem('item-9'), '/UserFavoriteItems/item-9'));
test('rating', () => expect(jellyfin.itemRating('item-9'), '/UserItems/item-9/Rating'));
test('trailers', () => expect(jellyfin.localTrailers('item-9'), '/Items/item-9/LocalTrailers'));
test('extras', () => expect(jellyfin.specialFeatures('item-9'), '/Items/item-9/SpecialFeatures'));
});
group('Emby uses the original user-scoped routes', () {
test('current user', () => expect(emby.currentUser, '/Users/user-1'));
test('resume', () => expect(emby.resumeItems, '/Users/user-1/Items/Resume'));
test('played', () => expect(emby.playedItem('item-9'), '/Users/user-1/PlayedItems/item-9'));
test('favorite', () => expect(emby.favoriteItem('item-9'), '/Users/user-1/FavoriteItems/item-9'));
test('rating', () => expect(emby.itemRating('item-9'), '/Users/user-1/Items/item-9/Rating'));
test('trailers', () => expect(emby.localTrailers('item-9'), '/Users/user-1/Items/item-9/LocalTrailers'));
test('extras', () => expect(emby.specialFeatures('item-9'), '/Users/user-1/Items/item-9/SpecialFeatures'));
});
group('path segment encoding', () {
test('item ids are percent-encoded so a hostile id cannot escape the path', () {
expect(emby.playedItem('a/b?c'), '/Users/user-1/PlayedItems/a%2Fb%3Fc');
expect(jellyfin.playedItem('a/b?c'), '/UserPlayedItems/a%2Fb%3Fc');
});
test('user ids are percent-encoded in the user-scoped forms', () {
const hostile = MediaBrowserPaths(dialect: MediaBrowserDialect.emby, userId: 'u/1');
expect(hostile.currentUser, '/Users/u%2F1');
expect(hostile.resumeItems, '/Users/u%2F1/Items/Resume');
});
test('Emby item ids are opaque numeric strings and pass through unchanged', () {
// Emby ids look like "7330"; Jellyfin's are 32-char hex GUIDs. Both are
// treated as opaque.
expect(emby.playedItem('7330'), '/Users/user-1/PlayedItems/7330');
});
});
}