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

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

@@ -881,6 +881,113 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
     }
   }
 
+  @override
+  Future<void> isSecondaryReset() async {
+    _logger.finer('Performing Remote Secondary reset check');
+    var localPublicKey =
+        await getLocalSecondary()?.getEncryptionPublicKey(getCurrentAtSign()!);
+
+    LookupVerbBuilder lookupBuilder = LookupVerbBuilder()
+      ..atKey = 'publickey' //AT_ENCRYPTION_PUBLIC_KEY
+      ..sharedBy = getCurrentAtSign();
+    String? remotePublicKey =
+        await getRemoteSecondary()?.executeVerb(lookupBuilder);
+    // secondary response is in format 'data:publickey'. Removing 'data:' from response
+    remotePublicKey = remotePublicKey?.replaceFirst('data:', '');
+
+    if (localPublicKey.isNull) {
+      _logger.info('Could not fetch EncryptionPublicKey from LocalSecondary.'
+          ' Unable to complete reset check');
+      return;
+    }
+
+    // TODO should there be a check for remote enc_key being null ?
+
+    if (localPublicKey != remotePublicKey) {
+      _logger.info('EncryptionPublicKey on LocalSecondary: $localPublicKey');
+      _logger.info('EncryptionPublicKey on RemoteSecondary: $remotePublicKey');
+      _logger.shout(
+          'AtEncryptionPublicKey on local secondary and remote secondary are different.'
+          '\nThis indicates remote secondary has been reset.'
+          '\nPlease delete localStorage and restart the client');
+      _logger.info('To delete localSecondary,'
+          ' call AtClientImpl.deleteLocalSecondary() with user consent');
+      throw AtResetException('Remote secondary has been reset');
+    }
+    _logger.finer('Secondary is not reset. Status ok');
+  }
+
+  void deleteLocalSecondaryStorageWithConsent(
+      String commitLogDirectoryPath, String hiveStorageDirectoryPath,
+      {required bool userConsentToDeleteLocalSecondaryStorage}) {
+    _logger.shout(
+        'Consent to delete LocalSecondary storage received: $userConsentToDeleteLocalSecondaryStorage');
+    if (userConsentToDeleteLocalSecondaryStorage) {
+      _logger
+          .info('Deleting CommitLog local storage at: $commitLogDirectoryPath');
+      _deleteLocalCommitLog(commitLogDirectoryPath);
+      _logger.info('Deleting hive local storage at: $hiveStorageDirectoryPath');
+      _deleteLocalHiveStorage(hiveStorageDirectoryPath);
+    }
+  }
+
+  void _deleteLocalCommitLog(String commitLogDirectoryPath) {
+    String fileName =
+        'commit_log_${AtUtils.getShaForAtSign(getCurrentAtSign()!)}.hive';
+    String lockFileName =
+        'commit_log_${AtUtils.getShaForAtSign(getCurrentAtSign()!)}.lock';
+
+    File commitLogFile = File('$commitLogDirectoryPath/$fileName');
+
+    // Todo: Do windows/mac have lock files ?
+    File lockFile = File('$commitLogDirectoryPath/$lockFileName');
+
+    if (commitLogFile.existsSync()) {
+      commitLogFile.deleteSync();
+      lockFile.deleteSync();
+      _logger.info('Successfully deleted commitLog storage');
+      // Since recursive delete is false by default, If the directory is empty
+      // the directory will also be deleted
+      Directory(commitLogDirectoryPath).deleteSync();
+      return;
+    }
+    throw AtClientException.message(
+        'CommitLog storage not found at path: $commitLogFile.'
+        ' Please provide a valid CommitLog directory path');
+  }
+
+  void _deleteLocalHiveStorage(String hiveStorageDirectoryPath) {
+    String hashFileName =
+        '${AtUtils.getShaForAtSign(getCurrentAtSign()!)}.hash';
+    String hiveFileName =
+        '${AtUtils.getShaForAtSign(getCurrentAtSign()!)}.hive';
+    String hiveLockFileName =
+        '${AtUtils.getShaForAtSign(getCurrentAtSign()!)}.lock';
+
+    File hiveFile = File('$hiveStorageDirectoryPath/$hiveFileName');
+    File hiveLockFile = File('$hiveStorageDirectoryPath/$hiveLockFileName');
+    File hashFile = File('$hiveStorageDirectoryPath/$hashFileName');
+
+    if (hashFile.existsSync() && hiveFile.existsSync()) {
+      hashFile.deleteSync();
+      hiveFile.deleteSync();
+      hiveLockFile.deleteSync();
+      _logger.info('Successfully deleted hive storage');
+      // Since recursive delete is true by default, If the directory is empty
+      // the directory will be deleted too
+      Directory(hiveStorageDirectoryPath).deleteSync();
+    } else {
+      if (!hiveFile.existsSync()) {
+        throw AtClientException.message(
+            'hive file not found at path: $hiveFile.'
+            ' Please provide a valid hive storage directory path');
+      }
+      throw AtClientException.message(
+          'hive hash file not found at path: $hiveFile.'
+          ' Please provide a valid hive storage directory path');
+    }
+  }
+
   // TODO v4 - remove the follow methods in version 4 of at_client package
 
   @override

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

@@ -529,6 +529,10 @@ abstract class AtClient {
       Function streamCompletionCallBack,
       Function streamReceiveCallBack);
 
+  /// Performs a check to see if RemoteSecondary has been reset
+  /// throws [AtResetException] if the RemoteSecondary has been reset
+  Future<void> isSecondaryReset();
+
   /// Uploads list of [files] to filebin and shares the file download url with [sharedWithAtSigns]
   /// returns map containing key of each sharedWithAtSign and value of [FileTransferObject]
   @Deprecated(

packages/at_client/pubspec.yaml

@@ -39,6 +39,14 @@ dependencies:
   meta: ^1.8.0
   version: ^3.0.2
 
+dependency_overrides:
+  at_commons:
+    git:
+      url: https://github.com/atsign-foundation/at_libraries
+      path: packages/at_commons
+      ref: at_reset_exception
+
+
 dev_dependencies:
   lints: ^2.0.0
   test: ^1.21.4

packages/at_client/test/at_client_impl_test.dart

@@ -2,6 +2,7 @@ import 'package:at_client/at_client.dart';
 import 'package:at_client/src/compaction/at_commit_log_compaction.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';
@@ -20,6 +21,10 @@ 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';
@@ -250,4 +255,44 @@ void main() {
       expect(key.key, 'uppercase'); //key should be converted to lower case
     });
   });
+
+  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(client.isSecondaryReset(),
+          throwsA(predicate((dynamic e) => e is AtResetException)));
+    });
+
+    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);
+      // errorless execution test
+      // if the method call below triggers any errors/exceptions this test will fail
+      await client.isSecondaryReset();
+    });
+  });
 }

tests/at_end2end_test/pubspec.yaml

@@ -12,6 +12,13 @@ dependencies:
   at_client:
     path: ../../packages/at_client
 
+dependency_overrides:
+  at_commons:
+    git:
+      url: https://github.com/atsign-foundation/at_libraries
+      path: packages/at_commons
+      ref: at_reset_exception
+
 dev_dependencies:
   pedantic: ^1.11.1
   test: ^1.21.4

tests/at_functional_test/pubspec.yaml

@@ -11,6 +11,13 @@ dependencies:
   at_client:
     path: ../../packages/at_client
 
+dependency_overrides:
+  at_commons:
+    git:
+      url: https://github.com/atsign-foundation/at_libraries
+      path: packages/at_commons
+      ref: at_reset_exception
+
 dev_dependencies:
   test: ^1.24.3
   lints: ^2.0.0