yorickr/plezy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(emby): add Emby as a MediaBrowser backend alongside Jellyfin

Browse Source 
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.
This commit is contained in:
edde746
2026-08-05 06:09:26 +02:00
parent f36e20bcad
commit 05fd622968
128 changed files with 4917 additions and 1429 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/screens/settings/add_connection_screen_test.dart
+109
View File
@@ -0,0 +1,109 @@
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:plezy/focus/focusable_wrapper.dart';
import 'package:plezy/focus/input_mode_tracker.dart';
import 'package:plezy/media/media_backend.dart';
import 'package:plezy/media/media_browser_dialect.dart';
import 'package:plezy/profiles/profile.dart';
import 'package:plezy/screens/settings/add_connection_screen.dart';
import 'package:plezy/screens/settings/add_jellyfin_screen.dart';
import 'package:plezy/screens/settings/add_plex_account_screen.dart';
import 'package:plezy/theme/mono_theme.dart';
import 'package:plezy/widgets/backend_badge.dart';
/// The "Add connection" picker is the only route to a new server, so a backend
/// missing from this list is unreachable no matter how complete its client is.
void main() {
Widget app(Widget home) => MaterialApp(
theme: monoTheme(dark: true),
home: InputModeTracker(child: home),
);
Profile profile(String id) =>
Profile.local(id: id, displayName: id, sortOrder: 0, createdAt: DateTime.fromMillisecondsSinceEpoch(0));
testWidgets('offers Plex, Jellyfin and Emby, each with its own badge', (tester) async {
await tester.pumpWidget(app(const AddConnectionScreen()));
await tester.pumpAndSettle();
expect(find.text('Sign in with Plex'), findsOneWidget);
expect(find.text('Connect to Jellyfin'), findsOneWidget);
expect(find.text('Connect to Emby'), findsOneWidget);
final badges = tester.widgetList<BackendBadge>(find.byType(BackendBadge)).map((b) => b.backend).toList();
expect(badges, containsAll(<MediaBackend>[MediaBackend.plex, MediaBackend.jellyfin, MediaBackend.emby]));
});
/// The pushed sign-in screen starts a 2s LAN discovery sweep and a
/// platform package-info read, neither of which settles under
/// `pumpAndSettle`. Bounded frames are enough: the route's widget exists as
/// soon as the push completes.
Future<AddJellyfinScreen> tapCard(WidgetTester tester, String label) async {
await tester.tap(find.text(label));
await tester.pump();
await tester.pump(const Duration(milliseconds: 400));
return tester.widget<AddJellyfinScreen>(find.byType(AddJellyfinScreen));
}
testWidgets('the Emby card opens the sign-in screen bound to the Emby dialect', (tester) async {
await tester.pumpWidget(app(const AddConnectionScreen()));
await tester.pumpAndSettle();
final screen = await tapCard(tester, 'Connect to Emby');
expect(screen.dialect, MediaBrowserDialect.emby);
expect(screen.targetProfile, isNull);
expect(find.text('Add Emby server'), findsOneWidget);
});
testWidgets('the Jellyfin card still opens the Jellyfin dialect', (tester) async {
await tester.pumpWidget(app(const AddConnectionScreen()));
await tester.pumpAndSettle();
final screen = await tapCard(tester, 'Connect to Jellyfin');
expect(screen.dialect, MediaBrowserDialect.jellyfin);
expect(find.text('Add Jellyfin server'), findsOneWidget);
});
testWidgets('the Plex card is unaffected by the new option', (tester) async {
await tester.pumpWidget(app(const AddConnectionScreen()));
await tester.pumpAndSettle();
await tester.tap(find.text('Sign in with Plex'));
await tester.pump();
await tester.pump(const Duration(milliseconds: 400));
expect(find.byType(AddPlexAccountScreen), findsOneWidget);
expect(find.byType(AddJellyfinScreen), findsNothing);
});
testWidgets('a scoped Emby card names the profile it will bind to', (tester) async {
final target = profile('Living Room');
await tester.pumpWidget(app(AddConnectionScreen(targetProfile: target)));
await tester.pumpAndSettle();
expect(find.text('Sign in to your Emby server. Binds to Living Room.'), findsOneWidget);
expect(find.text('Sign in to your Jellyfin server. Binds to Living Room.'), findsOneWidget);
final screen = await tapCard(tester, 'Connect to Emby');
expect(screen.dialect, MediaBrowserDialect.emby);
expect(screen.targetProfile?.id, target.id);
});
testWidgets('the D-pad steps through all three backend cards', (tester) async {
await tester.pumpWidget(app(const AddConnectionScreen()));
await tester.pumpAndSettle();
// The cards share a debugLabel, so track focus-node identity instead.
final visited = <FocusNode>{};
for (var i = 0; i < 6; i++) {
await tester.sendKeyEvent(LogicalKeyboardKey.arrowDown);
await tester.pumpAndSettle();
final focused = FocusManager.instance.primaryFocus;
if (focused != null) visited.add(focused);
}
expect(find.byType(FocusableWrapper), findsNWidgets(3));
expect(visited.length, greaterThanOrEqualTo(3), reason: 'D-pad did not reach every backend card');
});
}
test/screens/settings/add_jellyfin_screen_test.dart
+81 -5
View File
@@ -12,6 +12,7 @@ import 'package:plezy/connection/connection_registry.dart';
import 'package:plezy/database/app_database.dart';
import 'package:plezy/focus/input_mode_tracker.dart';
import 'package:plezy/media/ids.dart';
import 'package:plezy/media/media_browser_dialect.dart';
import 'package:plezy/profiles/active_profile_binder.dart';
import 'package:plezy/profiles/active_profile_provider.dart';
import 'package:plezy/profiles/plex_home_service.dart';
@@ -400,7 +401,12 @@ void main() {
child: _testApp(
AddJellyfinScreen(
localDiscoveryFactory: () async => [
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-1', name: 'Home'),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-1',
name: 'Home',
dialect: MediaBrowserDialect.jellyfin,
),
],
),
),
@@ -582,6 +588,56 @@ void main() {
expect(find.text('Home'), findsOneWidget);
});
testWidgets('the Emby dialect renames the screen and never offers Quick Connect', (tester) async {
resetSharedPreferencesForTest();
// The same handler advertises Quick Connect as enabled. Emby has no
// /QuickConnect/* routes at all, so the affordance must be gated on the
// dialect rather than on what the server claims.
await tester.pumpWidget(
_testApp(
AddJellyfinScreen(
dialect: MediaBrowserDialect.emby,
authServiceFactory: () => _jellyfinAuthService(quickConnectEnabled: true),
localDiscoveryFactory: _noLocalServers,
),
),
);
await tester.pump();
expect(find.text('Add Emby server'), findsOneWidget);
expect(find.text('Add Jellyfin server'), findsNothing);
final urlField = tester.widget<TextField>(find.byType(TextField).first);
expect(urlField.decoration?.hintText, 'https://emby.example.com');
await tester.enterText(find.byType(TextField).first, 'https://emby.example.com');
await tester.testTextInput.receiveAction(TextInputAction.go);
await tester.pumpAndSettle();
expect(find.text('Use Quick Connect'), findsNothing);
// The password form is still reachable — Emby's only sign-in path.
expect(find.text('Sign in'), findsOneWidget);
});
testWidgets('the Jellyfin dialect still offers Quick Connect when the server has it', (tester) async {
resetSharedPreferencesForTest();
await tester.pumpWidget(
_testApp(
AddJellyfinScreen(
authServiceFactory: () => _jellyfinAuthService(quickConnectEnabled: true),
localDiscoveryFactory: _noLocalServers,
),
),
);
await tester.pump();
expect(find.text('Add Jellyfin server'), findsOneWidget);
await tester.enterText(find.byType(TextField).first, 'https://jf.example.com');
await tester.testTextInput.receiveAction(TextInputAction.go);
await tester.pumpAndSettle();
expect(find.text('Use Quick Connect'), findsOneWidget);
});
testWidgets('Quick Connect shows the code prominently and cancel returns to the form', (tester) async {
resetSharedPreferencesForTest();
await tester.pumpWidget(
@@ -639,7 +695,12 @@ void main() {
authServiceFactory: () =>
_jellyfinAuthService(quickConnectEnabled: true, initiateDelay: const Duration(milliseconds: 50)),
localDiscoveryFactory: () async => [
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-1', name: 'Home'),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-1',
name: 'Home',
dialect: MediaBrowserDialect.jellyfin,
),
],
),
),
@@ -690,7 +751,12 @@ void main() {
AddJellyfinScreen(
authServiceFactory: () => _jellyfinAuthService(),
localDiscoveryFactory: () async => [
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-1', name: 'Home'),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-1',
name: 'Home',
dialect: MediaBrowserDialect.jellyfin,
),
],
),
),
@@ -713,8 +779,18 @@ void main() {
child: _testApp(
AddJellyfinScreen(
localDiscoveryFactory: () async => [
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-1', name: 'Home'),
DiscoveredJellyfinServer(address: 'http://192.168.1.30:8096', id: 'srv-2', name: 'Office'),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-1',
name: 'Home',
dialect: MediaBrowserDialect.jellyfin,
),
DiscoveredJellyfinServer(
address: 'http://192.168.1.30:8096',
id: 'srv-2',
name: 'Office',
dialect: MediaBrowserDialect.jellyfin,
),
],
),
),
test/screens/setup_database_recovery_test.dart
+4 -2
View File
@@ -64,7 +64,8 @@ void main() {
expect(find.text(t.auth.localDataRecoveryRequired), findsOneWidget);
expect(find.text(t.auth.signInWithPlex), findsOneWidget);
expect(find.text(t.auth.connectToJellyfin), findsOneWidget);
expect(find.text(t.auth.connectToMediaBrowser(product: 'Jellyfin')), findsOneWidget);
expect(find.text(t.auth.connectToMediaBrowser(product: 'Emby')), findsOneWidget);
});
testWidgets('fresh AuthScreen has normal actions without recovery notice', (tester) async {
@@ -73,6 +74,7 @@ void main() {
expect(find.text(t.auth.localDataRecoveryRequired), findsNothing);
expect(find.text(t.auth.signInWithPlex), findsOneWidget);
expect(find.text(t.auth.connectToJellyfin), findsOneWidget);
expect(find.text(t.auth.connectToMediaBrowser(product: 'Jellyfin')), findsOneWidget);
expect(find.text(t.auth.connectToMediaBrowser(product: 'Emby')), findsOneWidget);
});
}