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.
268 lines
10 KiB
Dart
268 lines
10 KiB
Dart
import 'dart:convert';
|
|
|
|
import 'package:drift/drift.dart' show Value;
|
|
import 'package:drift/native.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
import 'package:plezy/connection/connection.dart';
|
|
import 'package:plezy/connection/connection_registry.dart';
|
|
import 'package:plezy/database/app_database.dart';
|
|
import 'package:plezy/media/media_browser_dialect.dart';
|
|
import 'package:plezy/services/credential_vault.dart';
|
|
import 'package:plezy/services/plex_auth_service.dart';
|
|
|
|
import '../test_helpers/prefs.dart';
|
|
|
|
/// The id of the connection currently flagged default, read straight from the
|
|
/// row (the registry maintains the flag; there is no public reader).
|
|
Future<String?> _defaultConnectionId(AppDatabase db) async {
|
|
for (final row in await db.select(db.connections).get()) {
|
|
if (row.isDefault) return row.id;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
JellyfinConnection _jellyfin({String id = 'srv-1', String userName = 'edde', int createdAtMs = 1_000_000}) {
|
|
return JellyfinConnection(
|
|
id: id,
|
|
baseUrl: 'https://jellyfin.local',
|
|
serverName: 'Home',
|
|
serverMachineId: 'jf-machine-$id',
|
|
userId: 'user-$id',
|
|
userName: userName,
|
|
accessToken: 'tok-$id',
|
|
deviceId: 'dev-1',
|
|
createdAt: DateTime.fromMillisecondsSinceEpoch(createdAtMs),
|
|
);
|
|
}
|
|
|
|
JellyfinConnection _emby({String id = 'emby-1', String accessToken = 'emby-token', int createdAtMs = 1_000_000}) {
|
|
return JellyfinConnection(
|
|
id: id,
|
|
baseUrl: 'https://emby.local',
|
|
serverName: 'Emby Home',
|
|
serverMachineId: 'emby-machine-$id',
|
|
userId: 'user-$id',
|
|
userName: 'edde',
|
|
accessToken: accessToken,
|
|
deviceId: 'dev-1',
|
|
dialect: MediaBrowserDialect.emby,
|
|
createdAt: DateTime.fromMillisecondsSinceEpoch(createdAtMs),
|
|
);
|
|
}
|
|
|
|
PlexAccountConnection _plex({String id = 'plex-1'}) {
|
|
return PlexAccountConnection(
|
|
id: id,
|
|
accountToken: 'tok-$id',
|
|
clientIdentifier: 'cid-$id',
|
|
accountLabel: 'me@example.com',
|
|
servers: [
|
|
PlexServer(
|
|
name: 'Server $id',
|
|
clientIdentifier: 'server-$id',
|
|
accessToken: 'server-token-$id',
|
|
connections: [
|
|
PlexConnection(
|
|
protocol: 'https',
|
|
address: 'plex.example.com',
|
|
port: 443,
|
|
uri: 'https://plex.example.com',
|
|
local: false,
|
|
relay: false,
|
|
ipv6: false,
|
|
),
|
|
],
|
|
owned: true,
|
|
),
|
|
],
|
|
createdAt: DateTime.fromMillisecondsSinceEpoch(1_000_000),
|
|
);
|
|
}
|
|
|
|
void main() {
|
|
late AppDatabase db;
|
|
late ConnectionRegistry registry;
|
|
|
|
setUp(() {
|
|
resetSharedPreferencesForTest();
|
|
db = AppDatabase.forTesting(NativeDatabase.memory());
|
|
registry = ConnectionRegistry(db);
|
|
});
|
|
|
|
tearDown(() async {
|
|
await db.close();
|
|
});
|
|
|
|
group('ConnectionRegistry', () {
|
|
test('list() returns empty when no connections stored', () async {
|
|
expect(await registry.list(), isEmpty);
|
|
expect(await _defaultConnectionId(db), isNull);
|
|
});
|
|
|
|
test('first upserted connection becomes the default', () async {
|
|
await registry.upsert(_jellyfin(id: 'a'));
|
|
final list = await registry.list();
|
|
expect(list.length, 1);
|
|
expect(list.first.id, 'a');
|
|
|
|
expect(await _defaultConnectionId(db), 'a');
|
|
});
|
|
|
|
test('upsert preserves type discriminator (Plex vs Jellyfin)', () async {
|
|
await registry.upsert(_plex(id: 'p'));
|
|
await registry.upsert(_jellyfin(id: 'j'));
|
|
|
|
final plex = await registry.get('p');
|
|
final jelly = await registry.get('j');
|
|
expect(plex, isA<PlexAccountConnection>());
|
|
expect(jelly, isA<JellyfinConnection>());
|
|
|
|
expect((plex as PlexAccountConnection).accountToken, 'tok-p');
|
|
expect((jelly as JellyfinConnection).baseUrl, 'https://jellyfin.local');
|
|
});
|
|
|
|
test('Emby upsert preserves its persisted discriminator and connection dialect', () async {
|
|
await registry.upsert(_emby(id: 'e'));
|
|
|
|
final restored = await registry.get('e') as JellyfinConnection;
|
|
final row = await (db.select(db.connections)..where((table) => table.id.equals('e'))).getSingle();
|
|
|
|
expect(restored.dialect, MediaBrowserDialect.emby);
|
|
expect(restored.kind, ConnectionKind.emby);
|
|
expect(restored.kind.id, 'emby');
|
|
expect(row.kind, 'emby');
|
|
});
|
|
|
|
test('Jellyfin and Emby rows coexist and round-trip to their own dialects', () async {
|
|
await registry.upsert(_jellyfin(id: 'j'));
|
|
await registry.upsert(_emby(id: 'e'));
|
|
|
|
final jellyfin = await registry.get('j') as JellyfinConnection;
|
|
final emby = await registry.get('e') as JellyfinConnection;
|
|
final rows = await db.select(db.connections).get();
|
|
final kindById = {for (final row in rows) row.id: row.kind};
|
|
|
|
expect(jellyfin.dialect, MediaBrowserDialect.jellyfin);
|
|
expect(jellyfin.kind, ConnectionKind.jellyfin);
|
|
expect(emby.dialect, MediaBrowserDialect.emby);
|
|
expect(emby.kind, ConnectionKind.emby);
|
|
expect(kindById, {'j': 'jellyfin', 'e': 'emby'});
|
|
});
|
|
|
|
test('upsert encrypts tokens at rest and decrypts on read', () async {
|
|
await registry.upsert(_plex(id: 'p'));
|
|
await registry.upsert(_jellyfin(id: 'j'));
|
|
await registry.upsert(_emby(id: 'e', accessToken: 'emby-raw-token'));
|
|
|
|
final rows = await db.select(db.connections).get();
|
|
expect(rows.singleWhere((r) => r.id == 'p').configJson, isNot(contains('tok-p')));
|
|
expect(rows.singleWhere((r) => r.id == 'p').configJson, isNot(contains('server-token-p')));
|
|
expect(rows.singleWhere((r) => r.id == 'j').configJson, isNot(contains('tok-j')));
|
|
expect(rows.singleWhere((r) => r.id == 'e').configJson, isNot(contains('emby-raw-token')));
|
|
|
|
expect((await registry.get('p') as PlexAccountConnection).accountToken, 'tok-p');
|
|
expect((await registry.get('p') as PlexAccountConnection).servers.single.accessToken, 'server-token-p');
|
|
expect((await registry.get('j') as JellyfinConnection).accessToken, 'tok-j');
|
|
expect((await registry.get('e') as JellyfinConnection).accessToken, 'emby-raw-token');
|
|
});
|
|
|
|
test('read migrates legacy plaintext Plex server tokens', () async {
|
|
final plex = _plex(id: 'legacy');
|
|
final config = plex.toConfigJson();
|
|
config['accountToken'] = await CredentialVault.protect(plex.accountToken);
|
|
await db
|
|
.into(db.connections)
|
|
.insert(
|
|
ConnectionsCompanion.insert(
|
|
id: plex.id,
|
|
kind: plex.kind.id,
|
|
displayName: plex.displayName,
|
|
configJson: jsonEncode(config),
|
|
createdAt: plex.createdAt.millisecondsSinceEpoch,
|
|
isDefault: const Value(true),
|
|
),
|
|
);
|
|
|
|
final restored = await registry.get('legacy') as PlexAccountConnection;
|
|
expect(restored.accountToken, 'tok-legacy');
|
|
expect(restored.servers.single.accessToken, 'server-token-legacy');
|
|
|
|
final row = await (db.select(db.connections)..where((t) => t.id.equals('legacy'))).getSingle();
|
|
expect(row.configJson, isNot(contains('server-token-legacy')));
|
|
});
|
|
|
|
test('setDefault flips the flag and clears it on others', () async {
|
|
await registry.upsert(_jellyfin(id: 'a'));
|
|
await registry.upsert(_jellyfin(id: 'b'));
|
|
// First is default by default; explicitly switch to b.
|
|
await registry.setDefault('b');
|
|
expect(await _defaultConnectionId(db), 'b');
|
|
// Switch back to a.
|
|
await registry.setDefault('a');
|
|
expect(await _defaultConnectionId(db), 'a');
|
|
});
|
|
|
|
test('remove deletes a row and re-elects a default when needed', () async {
|
|
await registry.upsert(_jellyfin(id: 'a'));
|
|
await registry.upsert(_jellyfin(id: 'b'));
|
|
// a is default (first one in).
|
|
await registry.remove('a');
|
|
// b should now be the default.
|
|
expect(await _defaultConnectionId(db), 'b');
|
|
// Removing the last clears the default cleanly.
|
|
await registry.remove('b');
|
|
expect(await _defaultConnectionId(db), isNull);
|
|
});
|
|
|
|
test('re-upsert preserves the existing default flag', () async {
|
|
// Regression: a token/metadata refresh that re-upserts an existing
|
|
// default row used to clear `isDefault` because the writer always
|
|
// wrote `isFirst` (false on update).
|
|
await registry.upsert(_jellyfin(id: 'a'));
|
|
await registry.upsert(_jellyfin(id: 'b'));
|
|
expect(await _defaultConnectionId(db), 'a');
|
|
|
|
// Re-upsert the default with refreshed credentials.
|
|
await registry.upsert(_jellyfin(id: 'a', userName: 'refreshed'));
|
|
expect(await _defaultConnectionId(db), 'a');
|
|
|
|
// And re-upserting a non-default row doesn't accidentally promote it.
|
|
await registry.upsert(_jellyfin(id: 'b', userName: 'refreshed'));
|
|
expect(await _defaultConnectionId(db), 'a');
|
|
});
|
|
|
|
test('re-upsert preserves the original creation order', () async {
|
|
// Regression: creation order decides which connection lends a profile
|
|
// its picture (issue #1667) and which row `remove` promotes to default.
|
|
// Re-authenticating rebuilds the model with `DateTime.now()` under the
|
|
// same stable id, so an unguarded writer restamped the originally-first
|
|
// connection and shuffled it to last.
|
|
await registry.upsert(_jellyfin(id: 'first', createdAtMs: 1_000_000));
|
|
await registry.upsert(_jellyfin(id: 'second', createdAtMs: 2_000_000));
|
|
|
|
await registry.upsert(_jellyfin(id: 'first', createdAtMs: 9_000_000));
|
|
|
|
final list = await registry.list();
|
|
expect(list.map((c) => c.id).toList(), ['first', 'second']);
|
|
expect(list.first.createdAt, DateTime.fromMillisecondsSinceEpoch(1_000_000));
|
|
});
|
|
|
|
test('a genuinely new connection keeps the creation time it was built with', () async {
|
|
await registry.upsert(_jellyfin(id: 'a', createdAtMs: 5_000_000));
|
|
|
|
expect((await registry.list()).single.createdAt, DateTime.fromMillisecondsSinceEpoch(5_000_000));
|
|
});
|
|
|
|
test('recordAuthSuccess updates lastAuthenticatedAt without losing config', () async {
|
|
await registry.upsert(_jellyfin(id: 'a'));
|
|
final at = DateTime.fromMillisecondsSinceEpoch(2_000_000);
|
|
await registry.recordAuthSuccess('a', at);
|
|
|
|
final c = await registry.get('a') as JellyfinConnection;
|
|
expect(c.lastAuthenticatedAt, at);
|
|
expect(c.baseUrl, 'https://jellyfin.local');
|
|
expect(c.accessToken, 'tok-a');
|
|
});
|
|
});
|
|
}
|