feat(mobile): remove announcement overlay and show in app bar dialog (#…

…5104) Co-authored-by: shalong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
immich-app · Nov 17, 2023 · 4daf247 · 4daf247
1 parent 63a745c
commit 4daf247
Show file tree

Hide file tree

Showing 13 changed files with 159 additions and 239 deletions.
diff --git a/mobile/assets/i18n/en-US.json b/mobile/assets/i18n/en-US.json
@@ -292,6 +292,7 @@
   "server_info_box_app_version": "App Version",
   "server_info_box_server_url": "Server URL",
   "server_info_box_server_version": "Server Version",
+  "server_info_box_latest_release":"Latest Version",
   "setting_image_viewer_help": "The detail viewer loads the small thumbnail first, then loads the medium-size preview (if enabled), finally loads the original (if enabled).",
   "setting_image_viewer_original_subtitle": "Enable to load the original full-resolution image (large!). Disable to reduce data usage (both network and on device cache).",
   "setting_image_viewer_original_title": "Load original image",

diff --git a/mobile/lib/main.dart b/mobile/lib/main.dart
@@ -26,11 +26,9 @@ import 'package:immich_mobile/shared/models/store.dart';
 import 'package:immich_mobile/shared/models/user.dart';
 import 'package:immich_mobile/shared/providers/app_state.provider.dart';
 import 'package:immich_mobile/shared/providers/db.provider.dart';
-import 'package:immich_mobile/shared/providers/release_info.provider.dart';
 import 'package:immich_mobile/shared/services/immich_logger.service.dart';
 import 'package:immich_mobile/shared/services/local_notification.service.dart';
 import 'package:immich_mobile/shared/views/immich_loading_overlay.dart';
-import 'package:immich_mobile/shared/views/version_announcement_overlay.dart';
 import 'package:immich_mobile/utils/http_ssl_cert_override.dart';
 import 'package:immich_mobile/utils/immich_app_theme.dart';
 import 'package:immich_mobile/utils/migration.dart';
@@ -196,7 +194,6 @@ class ImmichAppState extends ConsumerState<ImmichApp>
   @override
   Widget build(BuildContext context) {
     var router = ref.watch(appRouterProvider);
-    ref.watch(releaseInfoProvider.notifier).checkGithubReleaseInfo();
 
     return MaterialApp(
       localizationsDelegates: context.localizationDelegates,
@@ -217,7 +214,6 @@ class ImmichAppState extends ConsumerState<ImmichApp>
             ),
           ),
           const ImmichLoadingOverlay(),
-          const VersionAnnouncementOverlay(),
         ],
       ),
     );

diff --git a/mobile/lib/shared/models/server_info/server_info.model.dart b/mobile/lib/shared/models/server_info/server_info.model.dart
@@ -5,43 +5,52 @@ import 'package:immich_mobile/shared/models/server_info/server_version.model.dar
 
 class ServerInfo {
   final ServerVersion serverVersion;
+  final ServerVersion latestVersion;
   final ServerFeatures serverFeatures;
   final ServerConfig serverConfig;
   final ServerDiskInfo serverDiskInfo;
   final bool isVersionMismatch;
+  final bool isNewReleaseAvailable;
   final String versionMismatchErrorMessage;
 
   ServerInfo({
     required this.serverVersion,
+    required this.latestVersion,
     required this.serverFeatures,
     required this.serverConfig,
-    required this.isVersionMismatch,
     required this.serverDiskInfo,
+    required this.isVersionMismatch,
+    required this.isNewReleaseAvailable,
     required this.versionMismatchErrorMessage,
   });
 
   ServerInfo copyWith({
     ServerVersion? serverVersion,
+    ServerVersion? latestVersion,
     ServerFeatures? serverFeatures,
     ServerConfig? serverConfig,
     ServerDiskInfo? serverDiskInfo,
     bool? isVersionMismatch,
+    bool? isNewReleaseAvailable,
     String? versionMismatchErrorMessage,
   }) {
     return ServerInfo(
       serverVersion: serverVersion ?? this.serverVersion,
+      latestVersion: latestVersion ?? this.latestVersion,
       serverFeatures: serverFeatures ?? this.serverFeatures,
       serverConfig: serverConfig ?? this.serverConfig,
+      serverDiskInfo: serverDiskInfo ?? this.serverDiskInfo,
       isVersionMismatch: isVersionMismatch ?? this.isVersionMismatch,
+      isNewReleaseAvailable:
+          isNewReleaseAvailable ?? this.isNewReleaseAvailable,
       versionMismatchErrorMessage:
           versionMismatchErrorMessage ?? this.versionMismatchErrorMessage,
-      serverDiskInfo: serverDiskInfo ?? this.serverDiskInfo,
     );
   }
 
   @override
   String toString() {
-    return 'ServerInfo(serverVersion: $serverVersion, serverFeatures: $serverFeatures, serverConfig: $serverConfig, isVersionMismatch: $isVersionMismatch, versionMismatchErrorMessage: $versionMismatchErrorMessage, serverDiskInfo: $serverDiskInfo)';
+    return 'ServerInfo(serverVersion: $serverVersion, latestVersion: $latestVersion, serverFeatures: $serverFeatures, serverConfig: $serverConfig, serverDiskInfo: $serverDiskInfo, isVersionMismatch: $isVersionMismatch, isNewReleaseAvailable: $isNewReleaseAvailable, versionMismatchErrorMessage: $versionMismatchErrorMessage)';
   }
 
   @override
@@ -50,20 +59,24 @@ class ServerInfo {
 
     return other is ServerInfo &&
         other.serverVersion == serverVersion &&
+        other.latestVersion == latestVersion &&
         other.serverFeatures == serverFeatures &&
         other.serverConfig == serverConfig &&
         other.serverDiskInfo == serverDiskInfo &&
         other.isVersionMismatch == isVersionMismatch &&
+        other.isNewReleaseAvailable == isNewReleaseAvailable &&
         other.versionMismatchErrorMessage == versionMismatchErrorMessage;
   }
 
   @override
   int get hashCode {
     return serverVersion.hashCode ^
+        latestVersion.hashCode ^
         serverFeatures.hashCode ^
         serverConfig.hashCode ^
+        serverDiskInfo.hashCode ^
         isVersionMismatch.hashCode ^
-        versionMismatchErrorMessage.hashCode ^
-        serverDiskInfo.hashCode;
+        isNewReleaseAvailable.hashCode ^
+        versionMismatchErrorMessage.hashCode;
   }
 }
diff --git a/mobile/lib/shared/models/store.dart b/mobile/lib/shared/models/store.dart
@@ -153,7 +153,6 @@ enum StoreKey<T> {
   backupRequireWifi<bool>(6, type: bool),
   backupRequireCharging<bool>(7, type: bool),
   backupTriggerDelay<int>(8, type: int),
-  githubReleaseInfo<String>(9, type: String),
   serverUrl<String>(10, type: String),
   accessToken<String>(11, type: String),
   serverEndpoint<String>(12, type: String),

diff --git a/mobile/lib/shared/providers/app_state.provider.dart b/mobile/lib/shared/providers/app_state.provider.dart
@@ -11,7 +11,6 @@ import 'package:immich_mobile/modules/memories/providers/memory.provider.dart';
 import 'package:immich_mobile/modules/onboarding/providers/gallery_permission.provider.dart';
 import 'package:immich_mobile/modules/settings/providers/notification_permission.provider.dart';
 import 'package:immich_mobile/shared/providers/asset.provider.dart';
-import 'package:immich_mobile/shared/providers/release_info.provider.dart';
 import 'package:immich_mobile/shared/providers/server_info.provider.dart';
 import 'package:immich_mobile/shared/providers/tab.provider.dart';
 import 'package:immich_mobile/shared/providers/websocket.provider.dart';
@@ -70,8 +69,6 @@ class AppStateNotiifer extends StateNotifier<AppStateEnum> {
 
     _ref.read(websocketProvider.notifier).connect();
 
-    _ref.read(releaseInfoProvider.notifier).checkGithubReleaseInfo();
-
     _ref
         .read(notificationPermissionProvider.notifier)
         .getNotificationPermission();

diff --git a/mobile/lib/shared/providers/release_info.provider.dart b/mobile/lib/shared/providers/release_info.provider.dart
diff --git a/mobile/lib/shared/providers/server_info.provider.dart b/mobile/lib/shared/providers/server_info.provider.dart
@@ -18,6 +18,11 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
               minor: 0,
               patch: 0,
             ),
+            latestVersion: const ServerVersion(
+              major: 0,
+              minor: 0,
+              patch: 0,
+            ),
             serverFeatures: const ServerFeatures(
               map: true,
               trash: true,
@@ -32,6 +37,7 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
               diskUsagePercentage: 0,
             ),
             isVersionMismatch: false,
+            isNewReleaseAvailable: false,
             versionMismatchErrorMessage: "",
           ),
         );
@@ -55,6 +61,10 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
       return;
     }
 
+    await _checkServerVersionMismatch(serverVersion);
+  }
+
+  _checkServerVersionMismatch(ServerVersion serverVersion) async {
     state = state.copyWith(serverVersion: serverVersion);
 
     var packageInfo = await PackageInfo.fromPlatform();
@@ -67,17 +77,33 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
         versionMismatchErrorMessage:
             "Server is out of date. Please update to the latest major version.",
       );
+      return;
+    }
 
+    if (appVersion["major"]! < serverVersion.major) {
+      state = state.copyWith(
+        isVersionMismatch: true,
+        versionMismatchErrorMessage:
+            "Mobile App is out of date. Please update to the latest major version.",
+      );
       return;
     }
 
     if (appVersion["minor"]! > serverVersion.minor) {
       state = state.copyWith(
         isVersionMismatch: true,
         versionMismatchErrorMessage:
-            "Server is out of date. Consider updating to the latest minor version.",
+            "Server is out of date. Please update to the latest minor version.",
       );
+      return;
+    }
 
+    if (appVersion["minor"]! < serverVersion.minor) {
+      state = state.copyWith(
+        isVersionMismatch: true,
+        versionMismatchErrorMessage:
+            "Mobile App is out of date. Please update to the latest minor version.",
+      );
       return;
     }
 
@@ -87,6 +113,25 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
     );
   }
 
+  handleNewRelease(
+    ServerVersion serverVersion,
+    ServerVersion latestVersion,
+  ) {
+    // Update local server version
+    _checkServerVersionMismatch(serverVersion);
+
+    final majorEqual = latestVersion.major == serverVersion.major;
+    final minorEqual = majorEqual && latestVersion.minor == serverVersion.minor;
+    final newVersionAvailable = latestVersion.major > serverVersion.major ||
+        (majorEqual && latestVersion.minor > serverVersion.minor) ||
+        (minorEqual && latestVersion.patch > serverVersion.patch);
+
+    state = state.copyWith(
+      latestVersion: latestVersion,
+      isNewReleaseAvailable: newVersionAvailable,
+    );
+  }
+
   getServerFeatures() async {
     final serverFeatures = await _serverInfoService.getServerFeatures();
     if (serverFeatures == null) {
@@ -120,5 +165,5 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
 
 final serverInfoProvider =
     StateNotifierProvider<ServerInfoNotifier, ServerInfo>((ref) {
-  return ServerInfoNotifier(ref.watch(serverInfoServiceProvider));
+  return ServerInfoNotifier(ref.read(serverInfoServiceProvider));
 });
diff --git a/mobile/lib/shared/providers/websocket.provider.dart b/mobile/lib/shared/providers/websocket.provider.dart
@@ -2,6 +2,7 @@ import 'package:flutter/foundation.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/modules/login/providers/authentication.provider.dart';
 import 'package:immich_mobile/shared/models/asset.dart';
+import 'package:immich_mobile/shared/models/server_info/server_version.model.dart';
 import 'package:immich_mobile/shared/models/store.dart';
 import 'package:immich_mobile/shared/providers/asset.provider.dart';
 import 'package:immich_mobile/shared/providers/server_info.provider.dart';
@@ -130,6 +131,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
         socket.on('on_asset_trash', _handleServerUpdates);
         socket.on('on_asset_restore', _handleServerUpdates);
         socket.on('on_asset_update', _handleServerUpdates);
+        socket.on('on_new_release', _handleReleaseUpdates);
       } catch (e) {
         debugPrint("[WEBSOCKET] Catch Websocket Error - ${e.toString()}");
       }
@@ -204,6 +206,36 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
     addPendingChange(PendingAction.assetDelete, data);
     _debounce(handlePendingChanges);
   }
+
+  _handleReleaseUpdates(dynamic data) {
+    // Json guard
+    if (data is! Map) {
+      return;
+    }
+
+    final json = data.cast<String, dynamic>();
+    final serverVersionJson =
+        json.containsKey('serverVersion') ? json['serverVersion'] : null;
+    final releaseVersionJson =
+        json.containsKey('releaseVersion') ? json['releaseVersion'] : null;
+    if (serverVersionJson == null || releaseVersionJson == null) {
+      return;
+    }
+
+    final serverVersionDto =
+        ServerVersionResponseDto.fromJson(serverVersionJson);
+    final releaseVersionDto =
+        ServerVersionResponseDto.fromJson(releaseVersionJson);
+    if (serverVersionDto == null || releaseVersionDto == null) {
+      return;
+    }
+
+    final serverVersion = ServerVersion.fromDto(serverVersionDto);
+    final releaseVersion = ServerVersion.fromDto(releaseVersionDto);
+    _ref
+        .read(serverInfoProvider.notifier)
+        .handleNewRelease(serverVersion, releaseVersion);
+  }
 }
 
 final websocketProvider =