Refactor API for albums feature (#155)

* Rename "shared" to "album" Prepare moving "SharedAlbums" to "Albums" * Update server album API endpoints * Update mobile app album endpoints Also add `putRequest` to mobile network.service * Add GET album collection filter - allow to filter by owner = 'mine' | 'their' - make sharedWithUserIds no longer required when creating an album * Rename remaining variables to "album" * Add ParseMeUUIDPipe to validate uuid or `me` * Add album params validation * Update todo in mobile album service. * Setup e2e testing * Add user e2e tests * Rename database host env variable to DB_HOST * Add some `Album` e2e tests Also fix issues found with the tests * Force push (try to recover DB_HOST env) * Rename db host env variable to `DB_HOSTNAME` * Remove unnecessary `initDb` from test-utils The current database.config is running the migrations: `migrationsRun: true` * Remove `initDb` usage from album e2e test * Update GET albums filter to `shared` - add filter by all / shared / not shared - add response DTOs - add GET albums e2e tests * Update album e2e tests for user.service changes * Update mobile app to use album response DTOs * Refactor album-service DB into album-registry - DB logic refactored into album-repository making it easier to test - add some album-service unit tests - add `clearMocks` to jest configuration * Finish implementing album.service unit tests * Rename response DTO Make them consistent with rest of the project naming * Update debug log messages in mobile network service * Rename table `shared_albums` to `albums` * Rename table `asset_shared_album` * Rename Albums `sharedAssets` to `assets` * Update tests to match updated "delete" response * Fixed asset cannot be compared in Set by adding Equatable package * Remove hero effect to fixed janky animation Co-authored-by: Alex <[email protected]>
immich-app · Jun 18, 2022 · 517a336 · 517a336
1 parent 3511b69
commit 517a336
Show file tree

Hide file tree

Showing 43 changed files with 1,486 additions and 725 deletions.
diff --git a/mobile/lib/modules/sharing/models/shared_album.model.dart b/mobile/lib/modules/sharing/models/shared_album.model.dart
@@ -2,17 +2,17 @@ import 'dart:convert';
 
 import 'package:collection/collection.dart';
 
-import 'package:immich_mobile/modules/sharing/models/shared_asset.model.dart';
-import 'package:immich_mobile/modules/sharing/models/shared_user.model.dart';
+import 'package:immich_mobile/shared/models/immich_asset.model.dart';
+import 'package:immich_mobile/shared/models/user.model.dart';
 
 class SharedAlbum {
   final String id;
   final String ownerId;
   final String albumName;
   final String createdAt;
   final String? albumThumbnailAssetId;
-  final List<SharedUsers> sharedUsers;
-  final List<SharedAssets>? sharedAssets;
+  final List<User> sharedUsers;
+  final List<ImmichAsset>? assets;
 
   SharedAlbum({
     required this.id,
@@ -21,7 +21,7 @@ class SharedAlbum {
     required this.createdAt,
     required this.albumThumbnailAssetId,
     required this.sharedUsers,
-    this.sharedAssets,
+    this.assets,
   });
 
   SharedAlbum copyWith({
@@ -30,8 +30,8 @@ class SharedAlbum {
     String? albumName,
     String? createdAt,
     String? albumThumbnailAssetId,
-    List<SharedUsers>? sharedUsers,
-    List<SharedAssets>? sharedAssets,
+    List<User>? sharedUsers,
+    List<ImmichAsset>? assets,
   }) {
     return SharedAlbum(
       id: id ?? this.id,
@@ -40,7 +40,7 @@ class SharedAlbum {
       createdAt: createdAt ?? this.createdAt,
       albumThumbnailAssetId: albumThumbnailAssetId ?? this.albumThumbnailAssetId,
       sharedUsers: sharedUsers ?? this.sharedUsers,
-      sharedAssets: sharedAssets ?? this.sharedAssets,
+      assets: assets ?? this.assets,
     );
   }
 
@@ -55,8 +55,8 @@ class SharedAlbum {
       result.addAll({'albumThumbnailAssetId': albumThumbnailAssetId});
     }
     result.addAll({'sharedUsers': sharedUsers.map((x) => x.toMap()).toList()});
-    if (sharedAssets != null) {
-      result.addAll({'sharedAssets': sharedAssets!.map((x) => x.toMap()).toList()});
+    if (assets != null) {
+      result.addAll({'assets': assets!.map((x) => x.toMap()).toList()});
     }
 
     return result;
@@ -69,9 +69,9 @@ class SharedAlbum {
       albumName: map['albumName'] ?? '',
       createdAt: map['createdAt'] ?? '',
       albumThumbnailAssetId: map['albumThumbnailAssetId'],
-      sharedUsers: List<SharedUsers>.from(map['sharedUsers']?.map((x) => SharedUsers.fromMap(x))),
-      sharedAssets: map['sharedAssets'] != null
-          ? List<SharedAssets>.from(map['sharedAssets']?.map((x) => SharedAssets.fromMap(x)))
+      sharedUsers: List<User>.from(map['sharedUsers']?.map((x) => User.fromMap(x))),
+      assets: map['assets'] != null
+          ? List<ImmichAsset>.from(map['assets']?.map((x) => ImmichAsset.fromMap(x)))
           : null,
     );
   }
@@ -82,7 +82,7 @@ class SharedAlbum {
 
   @override
   String toString() {
-    return 'SharedAlbum(id: $id, ownerId: $ownerId, albumName: $albumName, createdAt: $createdAt, albumThumbnailAssetId: $albumThumbnailAssetId, sharedUsers: $sharedUsers, sharedAssets: $sharedAssets)';
+    return 'SharedAlbum(id: $id, ownerId: $ownerId, albumName: $albumName, createdAt: $createdAt, albumThumbnailAssetId: $albumThumbnailAssetId, sharedUsers: $sharedUsers, assets: $assets)';
   }
 
   @override
@@ -97,7 +97,7 @@ class SharedAlbum {
         other.createdAt == createdAt &&
         other.albumThumbnailAssetId == albumThumbnailAssetId &&
         listEquals(other.sharedUsers, sharedUsers) &&
-        listEquals(other.sharedAssets, sharedAssets);
+        listEquals(other.assets, assets);
   }
 
   @override
@@ -108,6 +108,6 @@ class SharedAlbum {
         createdAt.hashCode ^
         albumThumbnailAssetId.hashCode ^
         sharedUsers.hashCode ^
-        sharedAssets.hashCode;
+        assets.hashCode;
   }
 }
diff --git a/mobile/lib/modules/sharing/models/shared_asset.model.dart b/mobile/lib/modules/sharing/models/shared_asset.model.dart
diff --git a/mobile/lib/modules/sharing/models/shared_user.model.dart b/mobile/lib/modules/sharing/models/shared_user.model.dart
diff --git a/mobile/lib/modules/sharing/providers/suggested_shared_users.provider.dart b/mobile/lib/modules/sharing/providers/suggested_shared_users.provider.dart
@@ -1,8 +1,8 @@
 import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/shared/models/user_info.model.dart';
+import 'package:immich_mobile/shared/models/user.model.dart';
 import 'package:immich_mobile/shared/services/user.service.dart';
 
-final suggestedSharedUsersProvider = FutureProvider.autoDispose<List<UserInfo>>((ref) async {
+final suggestedSharedUsersProvider = FutureProvider.autoDispose<List<User>>((ref) async {
   UserService userService = UserService();
 
   return await userService.getAllUsersInfo();

diff --git a/mobile/lib/modules/sharing/services/shared_album.service.dart b/mobile/lib/modules/sharing/services/shared_album.service.dart
@@ -12,9 +12,10 @@ class SharedAlbumService {
 
   Future<List<SharedAlbum>> getAllSharedAlbum() async {
     try {
-      var res = await _networkService.getRequest(url: 'shared/allSharedAlbums');
+      var res = await _networkService.getRequest(url: 'album?shared=true');
       List<dynamic> decodedData = jsonDecode(res.toString());
-      List<SharedAlbum> result = List.from(decodedData.map((e) => SharedAlbum.fromMap(e)));
+      List<SharedAlbum> result =
+          List.from(decodedData.map((e) => SharedAlbum.fromMap(e)));
 
       return result;
     } catch (e) {
@@ -24,9 +25,10 @@ class SharedAlbumService {
     return [];
   }
 
-  Future<bool> createSharedAlbum(String albumName, Set<ImmichAsset> assets, List<String> sharedUserIds) async {
+  Future<bool> createSharedAlbum(String albumName, Set<ImmichAsset> assets,
+      List<String> sharedUserIds) async {
     try {
-      var res = await _networkService.postRequest(url: 'shared/createAlbum', data: {
+      var res = await _networkService.postRequest(url: 'album', data: {
         "albumName": albumName,
         "sharedWithUserIds": sharedUserIds,
         "assetIds": assets.map((asset) => asset.id).toList(),
@@ -45,7 +47,7 @@ class SharedAlbumService {
 
   Future<SharedAlbum> getAlbumDetail(String albumId) async {
     try {
-      var res = await _networkService.getRequest(url: 'shared/$albumId');
+      var res = await _networkService.getRequest(url: 'album/$albumId');
       dynamic decodedData = jsonDecode(res.toString());
       SharedAlbum result = SharedAlbum.fromMap(decodedData);
 
@@ -55,9 +57,11 @@ class SharedAlbumService {
     }
   }
 
-  Future<bool> addAdditionalAssetToAlbum(Set<ImmichAsset> assets, String albumId) async {
+  Future<bool> addAdditionalAssetToAlbum(
+      Set<ImmichAsset> assets, String albumId) async {
     try {
-      var res = await _networkService.postRequest(url: 'shared/addAssets', data: {
+      var res =
+          await _networkService.putRequest(url: 'album/$albumId/assets', data: {
         "albumId": albumId,
         "assetIds": assets.map((asset) => asset.id).toList(),
       });
@@ -73,10 +77,11 @@ class SharedAlbumService {
     }
   }
 
-  Future<bool> addAdditionalUserToAlbum(List<String> sharedUserIds, String albumId) async {
+  Future<bool> addAdditionalUserToAlbum(
+      List<String> sharedUserIds, String albumId) async {
     try {
-      var res = await _networkService.postRequest(url: 'shared/addUsers', data: {
-        "albumId": albumId,
+      var res =
+          await _networkService.putRequest(url: 'album/$albumId/users', data: {
         "sharedUserIds": sharedUserIds,
       });
 
@@ -93,7 +98,7 @@ class SharedAlbumService {
 
   Future<bool> deleteAlbum(String albumId) async {
     try {
-      Response res = await _networkService.deleteRequest(url: 'shared/$albumId');
+      Response res = await _networkService.deleteRequest(url: 'album/$albumId');
 
       if (res.statusCode != 200) {
         return false;
@@ -108,7 +113,8 @@ class SharedAlbumService {
 
   Future<bool> leaveAlbum(String albumId) async {
     try {
-      Response res = await _networkService.deleteRequest(url: 'shared/leaveAlbum/$albumId');
+      Response res =
+          await _networkService.deleteRequest(url: 'album/$albumId/user/me');
 
       if (res.statusCode != 200) {
         return false;
@@ -121,10 +127,11 @@ class SharedAlbumService {
     }
   }
 
-  Future<bool> removeAssetFromAlbum(String albumId, List<String> assetIds) async {
+  Future<bool> removeAssetFromAlbum(
+      String albumId, List<String> assetIds) async {
     try {
-      Response res = await _networkService.deleteRequest(url: 'shared/removeAssets/', data: {
-        "albumId": albumId,
+      Response res = await _networkService
+          .deleteRequest(url: 'album/$albumId/assets', data: {
         "assetIds": assetIds,
       });
 
@@ -139,10 +146,11 @@ class SharedAlbumService {
     }
   }
 
-  Future<bool> changeTitleAlbum(String albumId, String ownerId, String newAlbumTitle) async {
+  Future<bool> changeTitleAlbum(
+      String albumId, String ownerId, String newAlbumTitle) async {
     try {
-      Response res = await _networkService.patchRequest(url: 'shared/updateInfo', data: {
-        "albumId": albumId,
+      Response res =
+          await _networkService.patchRequest(url: 'album/$albumId/', data: {
         "ownerId": ownerId,
         "albumName": newAlbumTitle,
       });