Add preferences migration

hiddify · Dec 9, 2023 · ce8b261 · ce8b261
1 parent 1cb108e
commit ce8b261
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 0 deletions.
diff --git a/lib/bootstrap.dart b/lib/bootstrap.dart
@@ -7,6 +7,7 @@ import 'package:flutter_native_splash/flutter_native_splash.dart';
 import 'package:hiddify/core/app_info/app_info_provider.dart';
 import 'package:hiddify/core/model/environment.dart';
 import 'package:hiddify/core/preferences/general_preferences.dart';
+import 'package:hiddify/core/preferences/preferences_migration.dart';
 import 'package:hiddify/core/preferences/preferences_provider.dart';
 import 'package:hiddify/features/app/widget/app.dart';
 import 'package:hiddify/features/common/window/window_controller.dart';
@@ -47,7 +48,12 @@ Future<void> lazyBootstrap(
   );
 
   final appInfo = await container.read(appInfoProvider.future);
+
   await container.read(sharedPreferencesProvider.future);
+  await PreferencesMigration(
+    sharedPreferences: container.read(sharedPreferencesProvider).requireValue,
+  ).migrate();
+
   final enableAnalytics = container.read(enableAnalyticsProvider);
 
   await SentryFlutter.init(

diff --git a/lib/core/preferences/preferences_migration.dart b/lib/core/preferences/preferences_migration.dart
@@ -0,0 +1,121 @@
+import 'package:hiddify/utils/utils.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+class PreferencesMigration with InfraLogger {
+  PreferencesMigration({required this.sharedPreferences});
+
+  final SharedPreferences sharedPreferences;
+
+  static const versionKey = "preferences_version";
+
+  Future<void> migrate() async {
+    final currentVersion = sharedPreferences.getInt(versionKey) ?? 0;
+
+    final migrationSteps = [
+      PreferencesVersion1Migration(sharedPreferences),
+    ];
+
+    if (currentVersion == migrationSteps.length) {
+      loggy.debug("already using the latest version (v$currentVersion)");
+      return;
+    }
+
+    final stopWatch = Stopwatch()..start();
+    loggy.debug(
+      "migrating from v[$currentVersion] to v[${migrationSteps.length}]",
+    );
+    for (int i = currentVersion; i < migrationSteps.length; i++) {
+      loggy.debug("step [$i](v${i + 1})");
+      await migrationSteps[i].migrate();
+      await sharedPreferences.setInt(versionKey, i + 1);
+    }
+    stopWatch.stop();
+    loggy.debug("migration took [${stopWatch.elapsedMilliseconds}]ms");
+  }
+}
+
+abstract interface class PreferencesMigrationStep {
+  PreferencesMigrationStep(this.sharedPreferences);
+
+  final SharedPreferences sharedPreferences;
+
+  Future<void> migrate();
+}
+
+class PreferencesVersion1Migration extends PreferencesMigrationStep
+    with InfraLogger {
+  PreferencesVersion1Migration(super.sharedPreferences);
+
+  @override
+  Future<void> migrate() async {
+    if (sharedPreferences.getString("ipv6-mode") case final String ipv6Mode) {
+      loggy.debug(
+        "changing ipv6-mode from [$ipv6Mode] to [${_ipv6Mapper(ipv6Mode)}]",
+      );
+      await sharedPreferences.setString("ipv6-mode", _ipv6Mapper(ipv6Mode));
+    }
+
+    if (sharedPreferences.getString("remote-domain-dns-strategy")
+        case final String remoteDomainStrategy) {
+      loggy.debug(
+        "changing [remote-domain-dns-strategy] = [$remoteDomainStrategy] to [remote-dns-domain-strategy] = [${_domainStrategyMapper(remoteDomainStrategy)}]",
+      );
+      await sharedPreferences.remove("remote-domain-dns-strategy");
+      await sharedPreferences.setString(
+        "remote-dns-domain-strategy",
+        _domainStrategyMapper(remoteDomainStrategy),
+      );
+    }
+
+    if (sharedPreferences.getString("direct-domain-dns-strategy")
+        case final String directDomainStrategy) {
+      loggy.debug(
+        "changing [direct-domain-dns-strategy] = [$directDomainStrategy] to [direct-dns-domain-strategy] = [${_domainStrategyMapper(directDomainStrategy)}]",
+      );
+      await sharedPreferences.remove("direct-domain-dns-strategy");
+      await sharedPreferences.setString(
+        "direct-dns-domain-strategy",
+        _domainStrategyMapper(directDomainStrategy),
+      );
+    }
+
+    if (sharedPreferences.getInt("localDns-port") case final int localDnsPort) {
+      loggy.debug("changing [localDns-port] to [local-dns-port]");
+      await sharedPreferences.remove("localDns-port");
+      await sharedPreferences.setInt("local-dns-port", localDnsPort);
+    }
+
+    await sharedPreferences.remove("execute-config-as-is");
+    await sharedPreferences.remove("enable-tun");
+    await sharedPreferences.remove("set-system-proxy");
+
+    await sharedPreferences.remove("cron_profiles_update");
+  }
+
+  String _ipv6Mapper(String persisted) => switch (persisted) {
+        "ipv4_only" ||
+        "prefer_ipv4" ||
+        "prefer_ipv4" ||
+        "ipv6_only" =>
+          persisted,
+        "disable" => "ipv4_only",
+        "enable" => "prefer_ipv4",
+        "prefer" => "prefer_ipv6",
+        "only" => "ipv6_only",
+        _ => "ipv4_only",
+      };
+
+  String _domainStrategyMapper(String persisted) => switch (persisted) {
+        "ipv4_only" ||
+        "prefer_ipv4" ||
+        "prefer_ipv4" ||
+        "ipv6_only" =>
+          persisted,
+        "auto" => "",
+        "preferIpv6" => "prefer_ipv6",
+        "preferIpv4" => "prefer_ipv4",
+        "ipv4Only" => "ipv4_only",
+        "ipv6Only" => "ipv6_only",
+        _ => "",
+      };
+}