Merge pull request #67 from SunkenInTime/update/prerelease

Fix Windows desktop auto-updater and prerelease release flow

Author: SunkenInTime

.env.local

@@ -33,6 +33,7 @@ node_modules/
 .pub-cache/
 .pub/
 /build/
+/dist/
 release/out/
 
 # Symbolication related
@@ -48,3 +49,7 @@ app.*.map.json
 
 # FVM Version Cache
 .fvm/
+
+# Local environment files
+.env
+.env.local

.gitignore

@@ -4,6 +4,38 @@ import 'package:icarus/const/color_option.dart';
 import 'package:shadcn_ui/shadcn_ui.dart';
 import 'package:toastification/toastification.dart';
 
+const String kUpdateChannel = String.fromEnvironment(
+  'ICARUS_UPDATE_CHANNEL',
+  defaultValue: 'stable',
+);
+final String kResolvedUpdateChannel = normalizeUpdateChannel(kUpdateChannel);
+
+String normalizeUpdateChannel(String channel) {
+  switch (channel.trim().toLowerCase()) {
+    case 'prerelease':
+    case 'pre-release':
+    case 'pre_release':
+      return 'prerelease';
+    case 'stable':
+    default:
+      return 'stable';
+  }
+}
+
+String updateChannelLabel(String channel) {
+  return switch (normalizeUpdateChannel(channel)) {
+    'prerelease' => 'Pre-release',
+    _ => 'Stable',
+  };
+}
+
+Uri buildDesktopUpdaterArchiveUrl(String channel) {
+  final resolvedChannel = normalizeUpdateChannel(channel);
+  return Uri.parse(
+    "https://sunkenintime.github.io/icarus/updates/windows/$resolvedChannel/app-archive.json",
+  );
+}
+
 class Settings {
   static const double agentSize = 35;
   static const double agentSizeMin = 15;
@@ -50,11 +82,10 @@ class Settings {
   static final Uri dicordLink = Uri.parse("https://discord.gg/PN2uKwCqYB");
 
   static const Duration autoSaveOffset = Duration(seconds: 15);
-  static const int versionNumber = 64;
-  static const String versionName = "4.2.1";
-  static final Uri desktopUpdaterArchiveUrl = Uri.parse(
-    "https://sunkenintime.github.io/icarus/updates/windows/stable/app-archive.json",
-  );
+  static const int versionNumber = 84;
+  static const String versionName = "4.3.0";
+  static final Uri desktopUpdaterArchiveUrl =
+      buildDesktopUpdaterArchiveUrl(kResolvedUpdateChannel);
 
   static const double sideBarContentWidth = 325;
   static const double sideBarPanelWidth = sideBarContentWidth + 20;

lib/const/settings.dart

@@ -172,6 +172,12 @@ class AppErrorReporter {
     final buffer = StringBuffer()
       ..writeln('Icarus Debug Report')
       ..writeln('Generated: ${formatDebugLogTimestamp(DateTime.now())}')
+      ..writeln(
+        'Update channel: '
+        '${updateChannelLabel(kResolvedUpdateChannel)} ($kResolvedUpdateChannel)',
+      )
+      ..writeln(
+          'Desktop updater manifest: ${Settings.desktopUpdaterArchiveUrl}')
       ..writeln(
         'Application support directory: '
         '${_applicationSupportDirectoryPath ?? 'Unavailable'}',

lib/services/app_error_reporter.dart

@@ -8,6 +8,7 @@ import 'package:flutter/material.dart';
 import 'package:http/http.dart' as http;
 import 'package:path/path.dart' as path;
 
+import 'package:icarus/services/app_error_reporter.dart';
 import 'package:icarus/services/windows_desktop_update_restart_service.dart';
 
 class WindowsDesktopUpdateController extends ChangeNotifier {
@@ -22,8 +23,8 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
         _updater = updater ?? DesktopUpdater(),
         _httpClient = httpClient ?? http.Client(),
         _ownsHttpClient = httpClient == null,
-        _restartService =
-            restartService ?? WindowsDesktopUpdateRestartService(updater: updater) {
+        _restartService = restartService ??
+            WindowsDesktopUpdateRestartService(updater: updater) {
     if (autoCheck) {
       unawaited(checkVersion());
     }
@@ -107,6 +108,16 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
         0,
         (int total, FileHashModel file) => total + file.length,
       );
+      _reportInfoSafely(
+        'Desktop update detected.',
+        source: 'WindowsDesktopUpdateController.checkVersion',
+        error: <String, Object?>{
+          'version': versionResponse.version,
+          'changedFileCount': files.length,
+          'downloadSizeBytes': _downloadSizeBytes,
+          'updateUrl': versionResponse.url,
+        },
+      );
       notifyListeners();
     } catch (_) {
       // Leave the direct installer updater silent if the remote metadata fails.
@@ -131,6 +142,16 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
     final installDirectory = await _resolveInstallDirectory();
     final updateDirectory = Directory(path.join(installDirectory, 'update'));
     await _resetUpdateDirectory(updateDirectory);
+    _reportInfoSafely(
+      'Starting desktop update download.',
+      source: 'WindowsDesktopUpdateController.downloadUpdate',
+      error: <String, Object?>{
+        'installDirectory': installDirectory,
+        'updateDirectory': updateDirectory.path,
+        'changedFileCount': files.length,
+        'downloadSizeBytes': _downloadSizeBytes,
+      },
+    );
 
     _skipUpdate = false;
     _isDownloading = true;
@@ -151,7 +172,8 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
         );
         completedBytes += file.length;
         _downloadedBytes = completedBytes;
-        _downloadProgress = _calculateProgress(_downloadedBytes, _downloadSizeBytes);
+        _downloadProgress =
+            _calculateProgress(_downloadedBytes, _downloadSizeBytes);
         notifyListeners();
       }
 
@@ -161,10 +183,32 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
       );
 
       _isDownloaded = true;
-    } catch (_) {
+      _reportInfoSafely(
+        'Desktop update download completed and verified.',
+        source: 'WindowsDesktopUpdateController.downloadUpdate',
+        error: <String, Object?>{
+          'updateDirectory': updateDirectory.path,
+          'changedFileCount': files.length,
+          'downloadSizeBytes': _downloadSizeBytes,
+        },
+      );
+    } catch (error, stackTrace) {
       _isDownloaded = false;
-      await _cleanupPartialDownload(updateDirectory);
-      rethrow;
+      try {
+        await _cleanupPartialDownload(updateDirectory);
+      } catch (cleanupError, cleanupStackTrace) {
+        _reportInfoSafely(
+          'Failed to clean up a partial desktop update download.',
+          source: 'WindowsDesktopUpdateController.downloadUpdate',
+          error: <String, Object?>{
+            'updateDirectory': updateDirectory.path,
+            'downloadError': error.toString(),
+            'cleanupError': cleanupError.toString(),
+            'cleanupStackTrace': cleanupStackTrace.toString(),
+          },
+        );
+      }
+      Error.throwWithStackTrace(error, stackTrace);
     } finally {
       _isDownloading = false;
       notifyListeners();
@@ -177,6 +221,16 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
       throw StateError('No desktop update is available to apply.');
     }
 
+    _reportInfoSafely(
+      'Restart requested to apply downloaded desktop update.',
+      source: 'WindowsDesktopUpdateController.restartApp',
+      error: <String, Object?>{
+        'version': update.version,
+        'changedFileCount': _requiredChangedFiles(update).length,
+        'updaterLogPath':
+            WindowsDesktopUpdateRestartService.resolveUpdaterLogPath(),
+      },
+    );
     await _restartService.restartIntoDownloadedUpdate(
       expectedFiles: _requiredChangedFiles(update),
     );
@@ -211,7 +265,8 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
           await destination.delete();
         }
         if (attempt < 2) {
-          await Future<void>.delayed(Duration(milliseconds: 400 * (attempt + 1)));
+          await Future<void>.delayed(
+              Duration(milliseconds: 400 * (attempt + 1)));
         }
       }
     }
@@ -242,27 +297,15 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
     var fileBytesReceived = 0;
 
     try {
-      await response.stream.listen(
-        (List<int> chunk) {
-          sink.add(chunk);
-          fileBytesReceived += chunk.length;
-          _downloadedBytes = completedBytes + fileBytesReceived;
-          _downloadProgress =
-              _calculateProgress(_downloadedBytes, totalBytes);
-          notifyListeners();
-        },
-        onDone: () async {
-          await sink.close();
-        },
-        onError: (Object error) async {
-          await sink.close();
-          throw error;
-        },
-        cancelOnError: true,
-      ).asFuture<void>();
-    } catch (_) {
+      await for (final List<int> chunk in response.stream) {
+        sink.add(chunk);
+        fileBytesReceived += chunk.length;
+        _downloadedBytes = completedBytes + fileBytesReceived;
+        _downloadProgress = _calculateProgress(_downloadedBytes, totalBytes);
+        notifyListeners();
+      }
+    } finally {
       await sink.close();
-      rethrow;
     }
   }
 
@@ -307,7 +350,9 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
   }
 
   Future<String> _resolveInstallDirectory() async {
-    final executablePath = (await _updater.getExecutablePath())?.trim();
+    final executablePath =
+        WindowsDesktopUpdateRestartService.normalizeExecutablePath(
+            await _updater.getExecutablePath());
     if (executablePath == null || executablePath.isEmpty) {
       throw const FileSystemException(
         'Unable to resolve the installed executable path.',
@@ -318,18 +363,25 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
   }
 
   Future<void> _resetUpdateDirectory(Directory updateDirectory) async {
-    if (await updateDirectory.exists()) {
-      await updateDirectory.delete(recursive: true);
-    }
+    await _deleteDirectoryIfExistsWithRetry(
+      updateDirectory,
+      source: 'WindowsDesktopUpdateController._resetUpdateDirectory',
+      bestEffort: false,
+    );
     await updateDirectory.create(recursive: true);
   }
 
   Future<void> _cleanupPartialDownload(Directory updateDirectory) async {
-    if (await updateDirectory.exists()) {
-      await updateDirectory.delete(recursive: true);
+    try {
+      await _deleteDirectoryIfExistsWithRetry(
+        updateDirectory,
+        source: 'WindowsDesktopUpdateController._cleanupPartialDownload',
+        bestEffort: true,
+      );
+    } finally {
+      _downloadedBytes = 0;
+      _downloadProgress = 0;
     }
-    _downloadedBytes = 0;
-    _downloadProgress = 0;
   }
 
   List<FileHashModel> _requiredChangedFiles(ItemModel update) {
@@ -380,4 +432,65 @@ class WindowsDesktopUpdateController extends ChangeNotifier {
     final hash = await Blake2b().hash(bytes);
     return base64Encode(hash.bytes);
   }
+
+  Future<void> _deleteDirectoryIfExistsWithRetry(
+    Directory directory, {
+    required String source,
+    required bool bestEffort,
+  }) async {
+    if (!await directory.exists()) {
+      return;
+    }
+
+    Object? lastError;
+    StackTrace? lastStackTrace;
+
+    for (var attempt = 0; attempt < 5; attempt++) {
+      try {
+        await directory.delete(recursive: true);
+        return;
+      } catch (error, stackTrace) {
+        lastError = error;
+        lastStackTrace = stackTrace;
+        if (attempt == 4) {
+          break;
+        }
+
+        await Future<void>.delayed(
+          Duration(milliseconds: 150 * (attempt + 1)),
+        );
+      }
+    }
+
+    if (bestEffort) {
+      _reportInfoSafely(
+        'Unable to delete the staged desktop update directory after retries.',
+        source: source,
+        error: <String, Object?>{
+          'directory': directory.path,
+          'error': lastError.toString(),
+          'stackTrace': lastStackTrace.toString(),
+        },
+      );
+      return;
+    }
+
+    Error.throwWithStackTrace(lastError!, lastStackTrace!);
+  }
+
+  void _reportInfoSafely(
+    String message, {
+    required String source,
+    Object? error,
+  }) {
+    try {
+      AppErrorReporter.reportInfo(
+        message,
+        source: source,
+        error: error,
+      );
+    } catch (_) {
+      // Logging must never interrupt the update flow.
+    }
+  }
 }