chore(mobile): refactor authentication (#14322)

2024-11-26 12:43:44 -06:00
parent 5417e34fb6
commit 21f14be949
26 changed files with 619 additions and 354 deletions
@@ -5,7 +5,7 @@ import 'package:immich_mobile/models/backup/backup_state.model.dart';
 import 'package:immich_mobile/providers/backup/backup.provider.dart';
 import 'package:immich_mobile/providers/backup/ios_background_settings.provider.dart';
 import 'package:immich_mobile/providers/backup/manual_upload.provider.dart';
-import 'package:immich_mobile/providers/authentication.provider.dart';
+import 'package:immich_mobile/providers/auth.provider.dart';
 import 'package:immich_mobile/providers/memory.provider.dart';
 import 'package:immich_mobile/providers/gallery_permission.provider.dart';
 import 'package:immich_mobile/providers/notification_permission.provider.dart';
@@ -42,7 +42,7 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
    if (!_wasPaused) return;
    _wasPaused = false;

-    final isAuthenticated = _ref.read(authenticationProvider).isAuthenticated;
+    final isAuthenticated = _ref.read(authProvider).isAuthenticated;

    // Needs to be logged in
    if (isAuthenticated) {
@@ -85,7 +85,7 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
    state = AppLifeCycleEnum.paused;
    _wasPaused = true;

-    if (_ref.read(authenticationProvider).isAuthenticated) {
+    if (_ref.read(authProvider).isAuthenticated) {
      // Do not cancel backup if manual upload is in progress
      if (_ref.read(backupProvider.notifier).backupProgress !=
          BackUpProgressEnum.manualInProgress) {
@@ -0,0 +1,164 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter_udid/flutter_udid.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/entities/store.entity.dart';
+import 'package:immich_mobile/models/auth/login_response.model.dart';
+import 'package:immich_mobile/models/auth/auth_state.model.dart';
+import 'package:immich_mobile/entities/user.entity.dart';
+import 'package:immich_mobile/providers/api.provider.dart';
+import 'package:immich_mobile/services/api.service.dart';
+import 'package:immich_mobile/services/auth.service.dart';
+import 'package:immich_mobile/utils/hash.dart';
+import 'package:logging/logging.dart';
+import 'package:openapi/api.dart';
+
+final authProvider = StateNotifierProvider<AuthNotifier, AuthState>((ref) {
+  return AuthNotifier(
+    ref.watch(authServiceProvider),
+    ref.watch(apiServiceProvider),
+  );
+});
+
+class AuthNotifier extends StateNotifier<AuthState> {
+  final AuthService _authService;
+  final ApiService _apiService;
+  final _log = Logger("AuthenticationNotifier");
+
+  static const Duration _timeoutDuration = Duration(seconds: 7);
+
+  AuthNotifier(
+    this._authService,
+    this._apiService,
+  ) : super(
+          AuthState(
+            deviceId: "",
+            userId: "",
+            userEmail: "",
+            name: '',
+            profileImagePath: '',
+            isAdmin: false,
+            isAuthenticated: false,
+          ),
+        );
+
+  Future<String> validateServerUrl(String url) {
+    return _authService.validateServerUrl(url);
+  }
+
+  Future<LoginResponse> login(String email, String password) async {
+    final response = await _authService.login(email, password);
+    await saveAuthInfo(accessToken: response.accessToken);
+    return response;
+  }
+
+  Future<void> logout() async {
+    try {
+      await _authService.logout();
+    } finally {
+      await _cleanUp();
+    }
+  }
+
+  Future<void> _cleanUp() async {
+    state = AuthState(
+      deviceId: "",
+      userId: "",
+      userEmail: "",
+      name: '',
+      profileImagePath: '',
+      isAdmin: false,
+      isAuthenticated: false,
+    );
+  }
+
+  void updateUserProfileImagePath(String path) {
+    state = state.copyWith(profileImagePath: path);
+  }
+
+  Future<bool> changePassword(String newPassword) async {
+    try {
+      await _authService.changePassword(newPassword);
+      return true;
+    } catch (_) {
+      return false;
+    }
+  }
+
+  Future<bool> saveAuthInfo({
+    required String accessToken,
+  }) async {
+    _apiService.setAccessToken(accessToken);
+
+    // Get the deviceid from the store if it exists, otherwise generate a new one
+    String deviceId =
+        Store.tryGet(StoreKey.deviceId) ?? await FlutterUdid.consistentUdid;
+
+    User? user = Store.tryGet(StoreKey.currentUser);
+
+    UserAdminResponseDto? userResponse;
+    UserPreferencesResponseDto? userPreferences;
+    try {
+      final responses = await Future.wait([
+        _apiService.usersApi.getMyUser().timeout(_timeoutDuration),
+        _apiService.usersApi.getMyPreferences().timeout(_timeoutDuration),
+      ]);
+      userResponse = responses[0] as UserAdminResponseDto;
+      userPreferences = responses[1] as UserPreferencesResponseDto;
+    } on ApiException catch (error, stackTrace) {
+      if (error.code == 401) {
+        _log.severe("Unauthorized access, token likely expired. Logging out.");
+        return false;
+      }
+      _log.severe(
+        "Error getting user information from the server [API EXCEPTION]",
+        stackTrace,
+      );
+    } catch (error, stackTrace) {
+      _log.severe(
+        "Error getting user information from the server [CATCH ALL]",
+        error,
+        stackTrace,
+      );
+
+      if (kDebugMode) {
+        debugPrint(
+          "Error getting user information from the server [CATCH ALL] $error $stackTrace",
+        );
+      }
+    }
+
+    // If the user information is successfully retrieved, update the store
+    // Due to the flow of the code, this will always happen on first login
+    if (userResponse != null) {
+      Store.put(StoreKey.deviceId, deviceId);
+      Store.put(StoreKey.deviceIdHash, fastHash(deviceId));
+      Store.put(
+        StoreKey.currentUser,
+        User.fromUserDto(userResponse, userPreferences),
+      );
+      Store.put(StoreKey.accessToken, accessToken);
+
+      user = User.fromUserDto(userResponse, userPreferences);
+    } else {
+      _log.severe("Unable to get user information from the server.");
+    }
+
+    // If the user is null, the login was not successful
+    // and we don't have a local copy of the user from a prior successful login
+    if (user == null) {
+      return false;
+    }
+
+    state = state.copyWith(
+      isAuthenticated: true,
+      userId: user.id,
+      userEmail: user.email,
+      name: user.name,
+      profileImagePath: user.profileImagePath,
+      isAdmin: user.isAdmin,
+      deviceId: deviceId,
+    );
+
+    return true;
+  }
+}
@@ -1,245 +0,0 @@
-import 'dart:io';
-
-import 'package:device_info_plus/device_info_plus.dart';
-import 'package:flutter/material.dart';
-import 'package:flutter_udid/flutter_udid.dart';
-import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/providers/album/album.provider.dart';
-import 'package:immich_mobile/entities/store.entity.dart';
-import 'package:immich_mobile/models/authentication/authentication_state.model.dart';
-import 'package:immich_mobile/entities/user.entity.dart';
-import 'package:immich_mobile/providers/api.provider.dart';
-import 'package:immich_mobile/providers/db.provider.dart';
-import 'package:immich_mobile/services/api.service.dart';
-import 'package:immich_mobile/utils/db.dart';
-import 'package:immich_mobile/utils/hash.dart';
-import 'package:isar/isar.dart';
-import 'package:logging/logging.dart';
-import 'package:openapi/api.dart';
-
-class AuthenticationNotifier extends StateNotifier<AuthenticationState> {
-  AuthenticationNotifier(
-    this._apiService,
-    this._db,
-    this._ref,
-  ) : super(
-          AuthenticationState(
-            deviceId: "",
-            userId: "",
-            userEmail: "",
-            name: '',
-            profileImagePath: '',
-            isAdmin: false,
-            shouldChangePassword: false,
-            isAuthenticated: false,
-          ),
-        );
-
-  final ApiService _apiService;
-  final Isar _db;
-  final StateNotifierProviderRef<AuthenticationNotifier, AuthenticationState>
-      _ref;
-  final _log = Logger("AuthenticationNotifier");
-
-  static const Duration _timeoutDuration = Duration(seconds: 7);
-
-  Future<bool> login(
-    String email,
-    String password,
-    String serverUrl,
-  ) async {
-    try {
-      // Resolve API server endpoint from user provided serverUrl
-      await _apiService.resolveAndSetEndpoint(serverUrl);
-      await _apiService.serverInfoApi.pingServer();
-    } catch (e) {
-      debugPrint('Invalid Server Endpoint Url $e');
-      return false;
-    }
-
-    // Make sign-in request
-    DeviceInfoPlugin deviceInfoPlugin = DeviceInfoPlugin();
-
-    if (Platform.isIOS) {
-      var iosInfo = await deviceInfoPlugin.iosInfo;
-      _apiService.authenticationApi.apiClient
-          .addDefaultHeader('deviceModel', iosInfo.utsname.machine);
-      _apiService.authenticationApi.apiClient
-          .addDefaultHeader('deviceType', 'iOS');
-    } else {
-      var androidInfo = await deviceInfoPlugin.androidInfo;
-      _apiService.authenticationApi.apiClient
-          .addDefaultHeader('deviceModel', androidInfo.model);
-      _apiService.authenticationApi.apiClient
-          .addDefaultHeader('deviceType', 'Android');
-    }
-
-    try {
-      var loginResponse = await _apiService.authenticationApi.login(
-        LoginCredentialDto(
-          email: email,
-          password: password,
-        ),
-      );
-
-      if (loginResponse == null) {
-        debugPrint('Login Response is null');
-        return false;
-      }
-
-      return setSuccessLoginInfo(
-        accessToken: loginResponse.accessToken,
-        serverUrl: serverUrl,
-      );
-    } catch (e) {
-      debugPrint("Error logging in $e");
-      return false;
-    }
-  }
-
-  Future<void> logout() async {
-    var log = Logger('AuthenticationNotifier');
-    try {
-      String? userEmail = Store.tryGet(StoreKey.currentUser)?.email;
-
-      await _apiService.authenticationApi
-          .logout()
-          .timeout(_timeoutDuration)
-          .then((_) => log.info("Logout was successful for $userEmail"))
-          .onError(
-            (error, stackTrace) =>
-                log.severe("Logout failed for $userEmail", error, stackTrace),
-          );
-    } catch (e, stack) {
-      log.severe('Logout failed', e, stack);
-    } finally {
-      await Future.wait([
-        clearAssetsAndAlbums(_db),
-        Store.delete(StoreKey.currentUser),
-        Store.delete(StoreKey.accessToken),
-      ]);
-      _ref.invalidate(albumProvider);
-
-      state = state.copyWith(
-        deviceId: "",
-        userId: "",
-        userEmail: "",
-        name: '',
-        profileImagePath: '',
-        isAdmin: false,
-        shouldChangePassword: false,
-        isAuthenticated: false,
-      );
-    }
-  }
-
-  updateUserProfileImagePath(String path) {
-    state = state.copyWith(profileImagePath: path);
-  }
-
-  Future<bool> changePassword(String newPassword) async {
-    try {
-      await _apiService.usersApi.updateMyUser(
-        UserUpdateMeDto(
-          password: newPassword,
-        ),
-      );
-
-      state = state.copyWith(shouldChangePassword: false);
-
-      return true;
-    } catch (e) {
-      debugPrint("Error changing password $e");
-      return false;
-    }
-  }
-
-  Future<bool> setSuccessLoginInfo({
-    required String accessToken,
-    required String serverUrl,
-  }) async {
-    _apiService.setAccessToken(accessToken);
-
-    // Get the deviceid from the store if it exists, otherwise generate a new one
-    String deviceId =
-        Store.tryGet(StoreKey.deviceId) ?? await FlutterUdid.consistentUdid;
-
-    bool shouldChangePassword = false;
-    User? user = Store.tryGet(StoreKey.currentUser);
-
-    UserAdminResponseDto? userResponse;
-    UserPreferencesResponseDto? userPreferences;
-    try {
-      final responses = await Future.wait([
-        _apiService.usersApi.getMyUser().timeout(_timeoutDuration),
-        _apiService.usersApi.getMyPreferences().timeout(_timeoutDuration),
-      ]);
-      userResponse = responses[0] as UserAdminResponseDto;
-      userPreferences = responses[1] as UserPreferencesResponseDto;
-    } on ApiException catch (error, stackTrace) {
-      if (error.code == 401) {
-        _log.severe("Unauthorized access, token likely expired. Logging out.");
-        return false;
-      }
-      _log.severe(
-        "Error getting user information from the server [API EXCEPTION]",
-        stackTrace,
-      );
-    } catch (error, stackTrace) {
-      _log.severe(
-        "Error getting user information from the server [CATCH ALL]",
-        error,
-        stackTrace,
-      );
-      debugPrint(
-        "Error getting user information from the server [CATCH ALL] $error $stackTrace",
-      );
-    }
-
-    // If the user information is successfully retrieved, update the store
-    // Due to the flow of the code, this will always happen on first login
-    if (userResponse != null) {
-      Store.put(StoreKey.deviceId, deviceId);
-      Store.put(StoreKey.deviceIdHash, fastHash(deviceId));
-      Store.put(
-        StoreKey.currentUser,
-        User.fromUserDto(userResponse, userPreferences),
-      );
-      Store.put(StoreKey.serverUrl, serverUrl);
-      Store.put(StoreKey.accessToken, accessToken);
-
-      shouldChangePassword = userResponse.shouldChangePassword;
-      user = User.fromUserDto(userResponse, userPreferences);
-    } else {
-      _log.severe("Unable to get user information from the server.");
-    }
-
-    // If the user is null, the login was not successful
-    // and we don't have a local copy of the user from a prior successful login
-    if (user == null) {
-      return false;
-    }
-
-    state = state.copyWith(
-      isAuthenticated: true,
-      userId: user.id,
-      userEmail: user.email,
-      name: user.name,
-      profileImagePath: user.profileImagePath,
-      isAdmin: user.isAdmin,
-      shouldChangePassword: shouldChangePassword,
-      deviceId: deviceId,
-    );
-
-    return true;
-  }
-}
-
-final authenticationProvider =
-    StateNotifierProvider<AuthenticationNotifier, AuthenticationState>((ref) {
-  return AuthenticationNotifier(
-    ref.watch(apiServiceProvider),
-    ref.watch(dbProvider),
-    ref,
-  );
-});
@@ -22,8 +22,8 @@ import 'package:immich_mobile/repositories/backup.repository.dart';
 import 'package:immich_mobile/repositories/file_media.repository.dart';
 import 'package:immich_mobile/services/background.service.dart';
 import 'package:immich_mobile/services/backup.service.dart';
-import 'package:immich_mobile/models/authentication/authentication_state.model.dart';
-import 'package:immich_mobile/providers/authentication.provider.dart';
+import 'package:immich_mobile/models/auth/auth_state.model.dart';
+import 'package:immich_mobile/providers/auth.provider.dart';
 import 'package:immich_mobile/providers/gallery_permission.provider.dart';
 import 'package:immich_mobile/models/server_info/server_disk_info.model.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
@@ -92,7 +92,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
  final log = Logger('BackupNotifier');
  final BackupService _backupService;
  final ServerInfoService _serverInfoService;
-  final AuthenticationState _authState;
+  final AuthState _authState;
  final BackgroundService _backgroundService;
  final GalleryPermissionNotifier _galleryPermissionNotifier;
  final Isar _db;
@@ -765,7 +765,7 @@ final backupProvider =
  return BackupNotifier(
    ref.watch(backupServiceProvider),
    ref.watch(serverInfoServiceProvider),
-    ref.watch(authenticationProvider),
+    ref.watch(authProvider),
    ref.watch(backgroundServiceProvider),
    ref.watch(galleryPermissionNotifier.notifier),
    ref.watch(dbProvider),
@@ -4,7 +4,7 @@ import 'package:collection/collection.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/providers/authentication.provider.dart';
+import 'package:immich_mobile/providers/auth.provider.dart';
 import 'package:immich_mobile/entities/asset.entity.dart';
 import 'package:immich_mobile/models/server_info/server_version.model.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
@@ -103,7 +103,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
  /// Connects websocket to server unless already connected
  void connect() {
    if (state.isConnected) return;
-    final authenticationState = _ref.read(authenticationProvider);
+    final authenticationState = _ref.read(authProvider);

    if (authenticationState.isAuthenticated) {
      try {