feat(flutter/cache): SyncController — token-based delta sync

Drives /api/library/sync against drift:
  - reads cursor from SyncMetadata (default 0 = full snapshot)
  - 204 → just bump lastSyncAt, return zeroes
  - 410 → wipe all cached entities + retry from cursor=0
  - 200 → apply upserts + deletes per entity type, advance cursor

Handles all 8 entity types (artist/album/track + like_track/like_album/
like_artist + playlist/playlist_track) for both upsert and delete paths.
Composite-key entities use the "<a>:<b>" string format the server emits.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-09 23:18:15 -04:00
parent 16669a0365
commit ab58f3ffcb
2 changed files with 424 additions and 0 deletions
+131
View File
@@ -0,0 +1,131 @@
import 'package:dio/dio.dart';
import 'package:drift/native.dart' show NativeDatabase;
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:minstrel/cache/audio_cache_manager.dart' show appDbProvider;
import 'package:minstrel/cache/db.dart';
import 'package:minstrel/cache/sync_controller.dart';
import 'package:minstrel/library/library_providers.dart' show dioProvider;
/// Builds a Dio whose adapter resolves every request to the supplied
/// status code + body. Avoids touching the network in tests.
Dio _stubDio({required int status, dynamic body}) {
final dio = Dio();
dio.interceptors.add(InterceptorsWrapper(onRequest: (req, h) {
h.resolve(Response<dynamic>(
requestOptions: req,
statusCode: status,
data: body,
));
}));
return dio;
}
ProviderContainer _container({required AppDb db, required Dio dio}) {
return ProviderContainer(overrides: [
appDbProvider.overrideWithValue(db),
dioProvider.overrideWith((ref) async => dio),
]);
}
void main() {
test('204 advances lastSyncAt without changing cursor', () async {
final db = AppDb(NativeDatabase.memory());
addTearDown(db.close);
final container = _container(db: db, dio: _stubDio(status: 204));
addTearDown(container.dispose);
final result = await container.read(syncControllerProvider.notifier).sync();
expect(result?.upserts, 0);
expect(result?.deletes, 0);
final meta = await db.select(db.syncMetadata).getSingleOrNull();
expect(meta?.lastSyncAt, isNotNull);
});
test('200 with artist upsert writes drift row + advances cursor', () async {
final db = AppDb(NativeDatabase.memory());
addTearDown(db.close);
final container = _container(
db: db,
dio: _stubDio(status: 200, body: {
'cursor': 7,
'upserts': {
'artist': [
{'id': 'a1', 'name': 'A', 'sort_name': 'A'},
],
},
'deletes': {},
}),
);
addTearDown(container.dispose);
final result = await container.read(syncControllerProvider.notifier).sync();
expect(result?.upserts, 1);
expect(result?.cursor, 7);
final artist = await (db.select(db.cachedArtists)
..where((t) => t.id.equals('a1')))
.getSingleOrNull();
expect(artist?.name, 'A');
final meta = await db.select(db.syncMetadata).getSingleOrNull();
expect(meta?.cursor, 7);
});
test('200 with track delete removes the row', () async {
final db = AppDb(NativeDatabase.memory());
addTearDown(db.close);
// Seed an existing cached track
await db.into(db.cachedTracks).insertOnConflictUpdate(
CachedTracksCompanion.insert(
id: 't1', albumId: 'al1', artistId: 'ar1', title: 'song'),
);
final container = _container(
db: db,
dio: _stubDio(status: 200, body: {
'cursor': 3,
'upserts': {},
'deletes': {
'track': ['t1'],
},
}),
);
addTearDown(container.dispose);
final result = await container.read(syncControllerProvider.notifier).sync();
expect(result?.deletes, 1);
final track = await (db.select(db.cachedTracks)
..where((t) => t.id.equals('t1')))
.getSingleOrNull();
expect(track, isNull);
});
test('like_track upsert + delete round-trip', () async {
final db = AppDb(NativeDatabase.memory());
addTearDown(db.close);
final container = _container(
db: db,
dio: _stubDio(status: 200, body: {
'cursor': 1,
'upserts': {
'like_track': [
{'user_id': 'u1', 'track_id': 't1'},
],
},
'deletes': {},
}),
);
addTearDown(container.dispose);
await container.read(syncControllerProvider.notifier).sync();
final liked = await db.select(db.cachedLikes).get();
expect(liked.length, 1);
expect(liked.first.userId, 'u1');
expect(liked.first.entityType, 'track');
expect(liked.first.entityId, 't1');
});
}