Migrated to Hive

.github/workflows/analyze-format.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Analyze and format
+name: CI
 
 on:
     # Trigger the workflow on pushes to the main and feature branches as well as PRs targeting them.
@@ -14,7 +14,7 @@ env:
     flutter_version: 3.13.6
 
 jobs:
-    analyze-format:
+    analyze-format-test:
         runs-on: ubuntu-22.04
         steps:
             - name: Checkout repository
@@ -31,3 +31,6 @@ jobs:
 
             - name: Check format
               run: dart format --output=none --set-exit-if-changed . -l 150
+
+            - name: Test
+              run: flutter test

.gitignore

@@ -40,3 +40,6 @@ app.*.map.json
 /android/app/debug
 /android/app/profile
 /android/app/release
+
+# Hive testing
+/test/hive_storage_test

lib/entities/accepted_terms_and_conditions.dart

@@ -0,0 +1,26 @@
+import 'package:concordium_wallet/services/wallet_proxy/model.dart';
+import 'package:hive_flutter/hive_flutter.dart';
+
+part 'accepted_terms_and_conditions.g.dart';
+
+/// Version of the Terms & Conditions accepted by the user.
+@HiveType(typeId: 1)
+class AcceptedTermsAndConditions {
+  static const table = "accepted_terms_and_conditions";
+
+  @HiveField(1)
+  final String acceptedVersion;
+  @HiveField(2)
+  final DateTime acceptedAt;
+
+  AcceptedTermsAndConditions({required this.acceptedVersion, required this.acceptedAt});
+
+  factory AcceptedTermsAndConditions.acceptNow(String acceptedVersion) {
+    return AcceptedTermsAndConditions(acceptedVersion: acceptedVersion, acceptedAt: DateTime.now());
+  }
+
+  /// Whether the accepted version is valid with respect to the provided valid version.
+  bool isValid(TermsAndConditions tac) {
+    return acceptedVersion == tac.version;
+  }
+}

lib/main.dart

@@ -1,6 +1,6 @@
 import 'package:concordium_wallet/screens/routes.dart';
 import 'package:concordium_wallet/services/http.dart';
-import 'package:concordium_wallet/services/shared_preferences/service.dart';
+import 'package:concordium_wallet/providers/storage.dart';
 import 'package:concordium_wallet/services/wallet_proxy/service.dart';
 import 'package:concordium_wallet/state/config.dart';
 import 'package:concordium_wallet/state/network.dart';
@@ -9,7 +9,6 @@ import 'package:concordium_wallet/state/terms_and_conditions.dart';
 import 'package:concordium_wallet/theme.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
-import 'package:shared_preferences/shared_preferences.dart';
 
 void main() {
   runApp(const App());
@@ -33,13 +32,13 @@ Future<Config> loadConfig(HttpService http) async {
 Future<ServiceRepository> bootstrap() async {
   const http = HttpService();
   final configFuture = loadConfig(http);
-  final prefsFuture = SharedPreferences.getInstance();
+  final storageFuture = StorageProvider.init();
   final config = await configFuture;
-  final prefs = await prefsFuture;
+  final storageService = await storageFuture;
   return ServiceRepository(
     config: config,
     http: http,
-    sharedPreferences: SharedPreferencesService(prefs),
+    storage: storageService,
   );
 }
 
@@ -85,8 +84,8 @@ class App extends StatelessWidget {
                   BlocProvider(
                     create: (context) {
                       // Initialize T&C by loading the currently accepted version from shared preferences.
-                      final prefs = context.read<ServiceRepository>().sharedPreferences;
-                      return TermsAndConditionAcceptance(prefs);
+                      final prefs = context.read<ServiceRepository>().storage;
+                      return TermsAndConditionAcceptance(prefs, networkServices.network.name);
                     },
                   ),
                 ],

lib/providers/storage.dart

@@ -0,0 +1,44 @@
+import 'package:concordium_wallet/entities/accepted_terms_and_conditions.dart';
+import 'package:concordium_wallet/state/network.dart';
+import 'package:hive_flutter/hive_flutter.dart';
+
+/// Service for interacting with [Hive].
+class StorageProvider {
+  final Box<AcceptedTermsAndConditions> _acceptedTermsAndConditionBox;
+
+  const StorageProvider._(this._acceptedTermsAndConditionBox);
+
+  static Future<StorageProvider> init() async {
+    await Hive.initFlutter();
+    _registerAdapters();
+    await _openBoxes();
+
+    return StorageProvider._(await Hive.openBox<AcceptedTermsAndConditions>(AcceptedTermsAndConditions.table));
+  }
+
+  /// Register all adapters needed for typed boxes.
+  static void _registerAdapters() {
+    Hive.registerAdapter(AcceptedTermsAndConditionsAdapter());
+  }
+
+  /// Opens all boxes asynchronously.
+  static Future<void> _openBoxes() async {
+    final atcFuture = Hive.openBox<AcceptedTermsAndConditions>(AcceptedTermsAndConditions.table);
+    await Future.wait([atcFuture]);
+  }
+
+  /// Reads the currently accepted T&C version.
+  AcceptedTermsAndConditions? getAcceptedTermsAndConditions(NetworkName networkName) {
+    return _acceptedTermsAndConditionBox.get(networkName.name);
+  }
+
+  /// Writes the currently accepted T&C version.
+  Future<void> writeAcceptedTermsAndConditions(NetworkName networkName, AcceptedTermsAndConditions acceptedTermsAndConditions) {
+    return _acceptedTermsAndConditionBox.put(networkName.name, acceptedTermsAndConditions);
+  }
+
+  /// Deletes the currently accepted T&C version.
+  Future<void> deleteTermsAndConditionsAcceptedVersion(NetworkName networkName) {
+    return _acceptedTermsAndConditionBox.delete(networkName.name);
+  }
+}

lib/screens/home/screen.dart

@@ -1,3 +1,4 @@
+import 'package:concordium_wallet/entities/accepted_terms_and_conditions.dart';
 import 'package:concordium_wallet/screens/terms_and_conditions/screen.dart';
 import 'package:concordium_wallet/services/url_launcher.dart';
 import 'package:concordium_wallet/services/wallet_proxy/service.dart';
@@ -65,7 +66,7 @@ class _HomeScreenState extends State<HomeScreen> {
             if (acceptedTac == null || !acceptedTac.isValid(validTac.termsAndConditions)) {
               return TermsAndConditionsScreen(
                 validTermsAndConditions: validTac.termsAndConditions,
-                acceptedTermsAndConditionsVersion: acceptedTac?.version,
+                acceptedTermsAndConditionsVersion: acceptedTac?.acceptedVersion,
                 urlLauncher: UrlLauncher(),
               );
             }
@@ -74,7 +75,7 @@ class _HomeScreenState extends State<HomeScreen> {
                 Expanded(
                   child: Column(
                     children: [
-                      Text('Accepted T&C version: ${tacState.accepted?.version}'),
+                      Text('Accepted T&C version: ${tacState.accepted?.acceptedVersion}'),
                       Text('Valid T&C last refreshed at ${tacState.valid?.refreshedAt}.'),
                     ],
                   ),
@@ -92,7 +93,7 @@ class _HomeScreenState extends State<HomeScreen> {
                 const SizedBox(height: 8),
                 ElevatedButton(
                   onPressed: () {
-                    const tac = AcceptedTermsAndConditions(version: '1.2.3');
+                    final tac = AcceptedTermsAndConditions.acceptNow('1.2.3');
                     context.read<TermsAndConditionAcceptance>().userAccepted(tac);
                   },
                   child: const Text('Set accepted T&C version to 1.2.3'),

lib/screens/terms_and_conditions/screen.dart

@@ -1,3 +1,4 @@
+import 'package:concordium_wallet/entities/accepted_terms_and_conditions.dart';
 import 'package:concordium_wallet/screens/terms_and_conditions/widget.dart';
 import 'package:concordium_wallet/services/url_launcher.dart';
 import 'package:concordium_wallet/services/wallet_proxy/model.dart';
@@ -124,9 +125,7 @@ class _TermsAndConditionsScreenState extends State<TermsAndConditionsScreen> {
   Function()? _onAcceptButtonPressed(BuildContext context) {
     if (isAccepted) {
       return () {
-        final tac = AcceptedTermsAndConditions(
-          version: widget.validTermsAndConditions.version,
-        );
+        final tac = AcceptedTermsAndConditions.acceptNow(widget.validTermsAndConditions.version);
         context.read<TermsAndConditionAcceptance>().userAccepted(tac);
       };
     }

lib/state/services.dart

@@ -1,5 +1,5 @@
 import 'package:concordium_wallet/services/http.dart';
-import 'package:concordium_wallet/services/shared_preferences/service.dart';
+import 'package:concordium_wallet/providers/storage.dart';
 import 'package:concordium_wallet/services/wallet_proxy/service.dart';
 import 'package:concordium_wallet/state/config.dart';
 import 'package:concordium_wallet/state/network.dart';
@@ -36,10 +36,10 @@ class ServiceRepository {
   /// Global service for performing HTTP calls.
   final HttpService http;
 
-  /// Global service for interacting with shared preferences.
-  final SharedPreferencesService sharedPreferences;
+  /// Global service for interacting with storage.
+  final StorageProvider storage;
 
-  ServiceRepository({required this.config, required this.http, required this.sharedPreferences});
+  ServiceRepository({required this.config, required this.http, required this.storage});
 
   /// Activate the network with the provided name.
   ///

lib/state/terms_and_conditions.dart

@@ -1,20 +1,9 @@
-import 'package:concordium_wallet/services/shared_preferences/service.dart';
+import 'package:concordium_wallet/entities/accepted_terms_and_conditions.dart';
+import 'package:concordium_wallet/providers/storage.dart';
 import 'package:concordium_wallet/services/wallet_proxy/model.dart';
+import 'package:concordium_wallet/state/network.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 
-/// Version of the Terms & Conditions accepted by the user.
-class AcceptedTermsAndConditions {
-  /// Accepted version.
-  final String version;
-
-  const AcceptedTermsAndConditions({required this.version});
-
-  /// Whether the accepted version is valid with respect to the provided valid version.
-  bool isValid(TermsAndConditions tac) {
-    return version == tac.version;
-  }
-}
-
 /// Version of the Terms & Conditions that is considered valid.
 ///
 /// The user has to have accepted this version (or more generally, a compatible version)
@@ -49,12 +38,13 @@ class TermsAndConditionsAcceptanceState {
 /// State component of the currently accepted and valid Terms & Conditions.
 class TermsAndConditionAcceptance extends Cubit<TermsAndConditionsAcceptanceState> {
   /// Service used to persist the accepted T&C version.
-  final SharedPreferencesService _prefs;
+  final StorageProvider _storage;
+  final NetworkName networkName;
 
-  TermsAndConditionAcceptance(this._prefs) : super(const TermsAndConditionsAcceptanceState(accepted: null, valid: null)) {
-    final acceptedVersion = _prefs.termsAndConditionsAcceptedVersion;
+  TermsAndConditionAcceptance(this._storage, this.networkName) : super(const TermsAndConditionsAcceptanceState(accepted: null, valid: null)) {
+    final acceptedVersion = _storage.getAcceptedTermsAndConditions(networkName);
     if (acceptedVersion != null) {
-      userAccepted(AcceptedTermsAndConditions(version: acceptedVersion));
+      userAccepted(acceptedVersion);
     }
   }
 
@@ -101,17 +91,17 @@ class TermsAndConditionAcceptance extends Cubit<TermsAndConditionsAcceptanceStat
   void onChange(Change<TermsAndConditionsAcceptanceState> change) {
     super.onChange(change);
 
+    if (change.currentState == change.nextState) {
+      return;
+    }
     // TODO: Pass success/failure status to notification service.
-    _persistAcceptedVersionIfChanged(change.nextState.accepted?.version, change.currentState.accepted?.version);
+    _persistAcceptedVersionIfChanged(change.nextState.accepted);
   }
 
-  Future<void> _persistAcceptedVersionIfChanged(String? nextAcceptedVersion, String? currentAcceptedVersion) {
-    if (nextAcceptedVersion == currentAcceptedVersion) {
-      return Future.value();
-    }
+  Future<void> _persistAcceptedVersionIfChanged(AcceptedTermsAndConditions? nextAcceptedVersion) {
     if (nextAcceptedVersion == null) {
-      return _prefs.deleteTermsAndConditionsAcceptedVersion();
+      return _storage.deleteTermsAndConditionsAcceptedVersion(networkName);
     }
-    return _prefs.writeTermsAndConditionsAcceptedVersion(nextAcceptedVersion);
+    return _storage.writeAcceptedTermsAndConditions(networkName, nextAcceptedVersion);
   }
 }