fix: option to delete local secondary when remote has been reset

packages/at_client/lib/src/client/at_client_impl.dart

@@ -52,6 +52,7 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
   RemoteSecondary? _remoteSecondary;
   AtClientCommitLogCompaction? _atClientCommitLogCompaction;
   AtClientConfig? _atClientConfig;
+  StorageManager? _storageManager;
   static final upperCaseRegex = RegExp(r'[A-Z]');
 
   PutRequestTransformer putRequestTransformer = PutRequestTransformer();
@@ -197,8 +198,8 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
   Future<void> _init() async {
     if (_preference!.isLocalStoreRequired) {
       if (_localSecondaryKeyStore == null) {
-        var storageManager = StorageManager(preference);
-        await storageManager.init(_atSign, preference!.keyStoreSecret);
+        _storageManager = StorageManager(preference);
+        await _storageManager?.init(_atSign, preference!.keyStoreSecret);
       }
 
       _localSecondary = LocalSecondary(this, keyStore: _localSecondaryKeyStore);
@@ -548,7 +549,9 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
     // will not be null.
     if (verbBuilder.value.length > _preference!.maxDataSize) {
       throw BufferOverFlowException(
-          'The length of value exceeds the maximum allowed length. Maximum buffer size is ${_preference!.maxDataSize} bytes. Found ${value.toString().length} bytes');
+          'The length of value exceeds the maximum allowed length.'
+          ' Maximum buffer size is ${_preference!.maxDataSize} bytes.'
+          ' Found ${value.toString().length} bytes');
     }
 
     Secondary secondary = SecondaryManager.getSecondary(this, verbBuilder);
@@ -966,6 +969,111 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
     }
   }
 
+  @override
+  Future<bool> isSecondaryReset() async {
+    String? localPublicKey, remotePublicKey;
+    _logger.finer('Performing Remote Secondary reset check');
+    // Fetch EncryptionPublicKey from LocalSecondary
+    try {
+      localPublicKey = await getLocalSecondary()
+          ?.getEncryptionPublicKey(getCurrentAtSign()!);
+    } on Exception catch (e) {
+      _logger.severe(
+          'Exception caused fetch EncryptionPublicKey from LocalSecondary.'
+          ' Unable to complete reset check | Cause $e');
+      return false;
+    }
+    // Fetch EncryptionPublicKey from RemoteSecondary
+    AtKey encPublicKey = AtKey.fromString('publickey$getCurrentAtSign()');
+    try {
+      PLookupVerbBuilder plookup = PLookupVerbBuilder()
+        ..atKey = encPublicKey;
+      remotePublicKey = await getRemoteSecondary()?.executeVerb(plookup);
+    } on Exception catch (e) {
+      _logger.info('Caught exception during public key lookup | $e');
+      _logger.info('Retrying fetch public key');
+      // try fetching the ENCRYPTION_PUB_KEY using lookup verb
+      // this fallback is for when reset status check is performed on an
+      //unauthenticated connection
+      LookupVerbBuilder lookup = LookupVerbBuilder()
+        ..atKey = encPublicKey;
+      remotePublicKey = await getRemoteSecondary()?.executeVerb(lookup);
+    }
+
+    // secondary response is in format 'data:publickey'. Removing 'data:' from response
+    if (remotePublicKey!.contains('data:')) {
+      remotePublicKey = remotePublicKey.replaceFirst('data:', '');
+    } else {
+      _logger.info(
+          'Fetched potential invalid remote Public encryption key: $remotePublicKey');
+      remotePublicKey = null;
+    }
+
+    if (localPublicKey.isNull) {
+      _logger.severe('Could not fetch EncryptionPublicKey from LocalSecondary.'
+          ' Unable to complete reset check');
+      return false;
+    } else if (remotePublicKey.isNull) {
+      _logger.severe('Could not fetch EncryptionPublicKey from RemoteSecondary.'
+          ' Unable to complete reset check');
+      return false;
+    }
+
+    if (localPublicKey != remotePublicKey) {
+      _logger.shout(
+          'AtEncryptionPublicKey on local secondary and remote secondary are different.'
+          'This indicates remote secondary has been reset.'
+          'Please delete localStorage and restart the client');
+      _logger.info('To delete localSecondary, call '
+          'AtClientImpl.deleteLocalSecondaryStorageWithConsent() with user consent');
+      _logger.finer('EncryptionPublicKey on LocalSecondary: $localPublicKey');
+      _logger.finer('EncryptionPublicKey on RemoteSecondary: $remotePublicKey');
+      return true;
+    }
+    _logger.info('Remote Secondary is NOT reset. Status ok');
+    return false;
+  }
+
+  @override
+  Future<void> deleteLocalSecondaryStorageWithConsent(
+      {required bool userConsentToDeleteLocalStorage}) async {
+    _logger.shout(
+        'Consent to delete LocalSecondary storage received: $userConsentToDeleteLocalStorage');
+    if (!userConsentToDeleteLocalStorage) {
+      throw AtClientException.message(
+          'User consent not provided. Unable to delete local storage without consent');
+    }
+    await StorageManager(_preference).close(_atSign);
+    try {
+      _deleteLocalStorage(_preference!.commitLogPath!, isHiveStorage: false);
+    } on Exception catch (e) {
+      _logger.finer('Unable to delete CommitLog storage | Cause: $e');
+      throw AtIOException(e.toString());
+    }
+    // Delete hive storage
+    try {
+      _deleteLocalStorage(_preference!.hiveStoragePath!, isHiveStorage: true);
+    } on Exception catch (e) {
+      _logger.finer('Unable to delete hive storage | Cause: $e');
+      throw AtIOException(e.toString());
+    }
+  }
+
+  void _deleteLocalStorage(String storageDirectory,
+      {required bool isHiveStorage}) {
+    String storageType = isHiveStorage ? 'hive' : 'commitLog';
+    _logger.info('Deleting $storageType storage at path: $storageDirectory');
+
+    Directory storageDir = Directory(storageDirectory);
+    if (!storageDir.existsSync()) {
+      throw AtClientException.message(
+          '$storageType storage not found at path: $storageDirectory.'
+          ' Please provide a valid $storageType storage directory path');
+    }
+    Directory(storageDirectory).deleteSync(recursive: true);
+    _logger.info('Successfully deleted $storageType storage');
+  }
+
   // TODO v4 - remove the follow methods in version 4 of at_client package
 
   @override

packages/at_client/lib/src/client/at_client_spec.dart

@@ -535,6 +535,20 @@ abstract class AtClient {
       Function streamCompletionCallBack,
       Function streamReceiveCallBack);
 
+  /// Performs a check to see if RemoteSecondary has been reset
+  /// returns true if the RemoteSecondary has been reset, false otherwise
+  Future<bool> isSecondaryReset();
+
+  /// Deletes a client's local secondary storage
+  ///
+  /// [To be used when remote secondary has been reset]
+  ///
+  /// Requires user consent passed as a method parameter.
+  ///
+  /// Performs deletion only if consent is true
+  void deleteLocalSecondaryStorageWithConsent(
+      {required bool userConsentToDeleteLocalStorage});
+
   /// Sets a Semi Permanent Passcode(SPP) in the secondary server key-store.
   /// A Semi Permanent Passcode (SPP) is 6 character alpha-numeric for submitting
   /// an enrollment request. Only the connections which have access to manage

packages/at_client/lib/src/manager/storage_manager.dart

@@ -45,4 +45,41 @@ class StorageManager {
         .scheduleKeyExpireTask(preferences?.expiryCheckTimeInterval.inMinutes);
     isStorageInitialized = true;
   }
+
+  Future<void> stopInstances(String currentAtSign) async {
+    AtCommitLog? atCommitLog = await AtCommitLogManagerImpl.getInstance()
+        .getCommitLog(currentAtSign,
+            commitLogPath: preferences?.commitLogPath, enableCommitId: false);
+
+    HivePersistenceManager hiveManager =
+        SecondaryPersistenceStoreFactory.getInstance()
+            .getSecondaryPersistenceStore(currentAtSign)!
+            .getHivePersistenceManager()!;
+
+    SecondaryKeyStore hiveKeyStore =
+        SecondaryPersistenceStoreFactory.getInstance()
+            .getSecondaryPersistenceStore(currentAtSign)!
+            .getSecondaryKeyStore()!;
+
+    await (hiveKeyStore.commitLog as AtCommitLog).close();
+    await hiveManager.close();
+    await atCommitLog?.close();
+  }
+
+  Future<void> close(String currentAtSign) async {
+    var commitLogPath = preferences!.commitLogPath;
+
+    var atCommitLog = await AtCommitLogManagerImpl.getInstance().getCommitLog(
+        currentAtSign,
+        commitLogPath: commitLogPath,
+        enableCommitId: false);
+
+    // ignore: await_only_futures
+    await atCommitLog?.close;
+
+    var manager = SecondaryPersistenceStoreFactory.getInstance()
+        .getSecondaryPersistenceStore(currentAtSign)!
+        .getHivePersistenceManager()!;
+    await manager.close();
+  }
 }

packages/at_client/pubspec.yaml

@@ -41,6 +41,7 @@ dependencies:
   meta: ^1.8.0
   version: ^3.0.2
 
+
 dev_dependencies:
   lints: ^4.0.0
   test: ^1.21.4

packages/at_client/test/at_client_impl_test.dart

@@ -7,6 +7,7 @@ import 'package:at_client/src/response/response.dart';
 import 'package:at_client/src/service/enrollment_service_impl.dart';
 import 'package:at_client/src/service/notification_service_impl.dart';
 import 'package:at_client/src/service/sync_service_impl.dart';
+import 'package:at_commons/at_builders.dart';
 import 'package:at_persistence_secondary_server/at_persistence_secondary_server.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
@@ -29,6 +30,9 @@ class MockAtCompactionJob extends Mock implements AtCompactionJob {
 
 class MockRemoteSecondary extends Mock implements RemoteSecondary {}
 
+class MockSecondaryKeystore extends Mock implements SecondaryKeyStore {}
+
+
 void main() {
   group('A group of at client impl create tests', () {
     final String atSign = '@alice';
@@ -260,6 +264,48 @@ void main() {
     });
   });
 
+  group('Group of tests verify client behaviour on remote secondary reset', () {
+    registerFallbackValue(MockRemoteSecondary());
+    registerFallbackValue(LookupVerbBuilder());
+
+    RemoteSecondary mockRemoteSecondary = MockRemoteSecondary();
+    SecondaryKeyStore mockKeystore = MockSecondaryKeystore();
+    AtClient client;
+
+    test('Verify isSecondaryReset() functionality - negative case', () async {
+      AtData responseObj = AtData()
+        ..data = 'incorrectLocalEncPublicKey';
+      when(() => mockRemoteSecondary.executeVerb(any())).thenAnswer(
+              (invocation) => Future.value('data:incorrectRemoteEncPublicKey'));
+      when(() => mockKeystore.get(any()))
+          .thenAnswer((invocation) => Future.value(responseObj));
+
+      client = await AtClientImpl.create('@alice47', 'resetLocalTest',
+          AtClientPreference()
+            ..isLocalStoreRequired = true,
+          remoteSecondary: mockRemoteSecondary,
+          localSecondaryKeyStore: mockKeystore);
+      expect(await client.isSecondaryReset(), true);
+    });
+
+    test('Verify isSecondaryReset() functionality - positive case', () async {
+      AtData responseObj = AtData()
+        ..data = 'correctEncPublicKey';
+      when(() => mockRemoteSecondary.executeVerb(any()))
+          .thenAnswer((invocation) => Future.value('data:correctEncPublicKey'));
+      when(() => mockKeystore.get(any()))
+          .thenAnswer((invocation) => Future.value(responseObj));
+
+      client = await AtClientImpl.create('@alice47', 'resetLocalTest',
+          AtClientPreference()
+            ..isLocalStoreRequired = true,
+          remoteSecondary: mockRemoteSecondary,
+          localSecondaryKeyStore: mockKeystore);
+      expect(await client.isSecondaryReset(), false);
+    });
+  });
+
+
   group('A group of tests related to apkam/enrollments', () {
     test(
         'A test to verify enrollmentId is set in atClient after calling setCurrentAtSign',

tests/at_functional_test/pubspec.yaml

@@ -17,4 +17,5 @@ dependencies:
 dev_dependencies:
   test: ^1.24.3
   lints: ^2.0.0
-  coverage: ^1.5.0
+  at_demo_data: ^1.0.1
+  coverage: ^1.5.0