feat(core): migrate preferences storage to basic storage (#484)

* feat: add func migrate preferences storage to basic storage

* fix: unittest

* chore: fix error unittest

* chore: add unittest for biametry cache and indentifier view type cache

* chore: change location function createOrUpdate and some unittest

* chore: change misc record id name

* chore: change misc record name

* chore: change use biometryCacheCache

* chore: rm state and fix unittest

package.json

@@ -25,7 +25,6 @@
     "@capacitor/core": "^5.0.0",
     "@capacitor/ios": "^5.0.0",
     "@capacitor/keyboard": "^5.0.0",
-    "@capacitor/preferences": "^5.0.0",
     "@capacitor/screen-orientation": "^5.0.7",
     "@capacitor/share": "^5.0.0",
     "@capacitor/splash-screen": "^5.0.0",

src/core/agent/agent.types.ts

@@ -19,7 +19,16 @@ interface ConnectionHistoryItem {
 }
 
 enum MiscRecordId {
-  OP_PASS_HINT = "app-op-password-hint",
+  OP_PASS_HINT = "op-password-hint",
+  APP_ALREADY_INIT = "app-already-init",
+  APP_STATE_FLAGS = "app-state-flags",
+  APP_LANGUAGE = "app-language",
+  IDENTIFIERS_FAVOURITES = "identifiers-favourites",
+  CREDS_FAVOURITES = "creds-favourites",
+  USER_NAME = "user-name",
+  APP_BIOMETRY = "app-biometry",
+  KERIA_NOTIFICATION_MARKER = "keria-notification-marker",
+  APP_IDENTIFIER_VIEW_TYPE = "app-identifier-view-type",
 }
 
 interface ConnectionShortDetails {

src/core/agent/records/basicStorage.ts

@@ -7,6 +7,9 @@ import {
 import { BasicRecord } from "./basicRecord";
 
 class BasicStorage implements StorageApi {
+  static readonly RECORD_DOES_NOT_EXIST_ERROR_MSG =
+    "Record does not exist with id";
+
   private storageService: StorageService<BasicRecord>;
 
   constructor(storageService: StorageService<BasicRecord>) {
@@ -39,6 +42,21 @@ class BasicStorage implements StorageApi {
   getAll(): Promise<BasicRecord[]> {
     return this.storageService.getAll(BasicRecord);
   }
+  async createOrUpdateBasicRecord(record: BasicRecord): Promise<void> {
+    try {
+      await this.update(record);
+    } catch (error) {
+      if (
+        error instanceof Error &&
+        error.message ===
+          `${BasicStorage.RECORD_DOES_NOT_EXIST_ERROR_MSG} ${record.id}`
+      ) {
+        await this.save(record);
+      } else {
+        throw error;
+      }
+    }
+  }
 }
 
 export { BasicStorage };

src/core/agent/services/signifyNotificationService.ts

@@ -3,11 +3,11 @@ import {
   AgentServicesProps,
   KeriaNotification,
   KeriaNotificationMarker,
+  MiscRecordId,
   NotificationRoute,
 } from "../agent.types";
 import { Notification } from "./credentialService.types";
-import { PreferencesKeys, PreferencesStorage } from "../../storage";
-import { NotificationStorage } from "../records";
+import { BasicRecord, NotificationStorage } from "../records";
 import { Agent } from "../agent";
 
 class SignifyNotificationService extends AgentService {
@@ -31,27 +31,17 @@ class SignifyNotificationService extends AgentService {
       nextIndex: 0,
       lastNotificationId: "",
     };
-    try {
-      notificationQuery = (await PreferencesStorage.get(
-        PreferencesKeys.APP_KERIA_NOTIFICATION_MARKER
-      )) as unknown as KeriaNotificationMarker;
-    } catch (error) {
-      if (
-        (error as Error).message ==
-        `${PreferencesStorage.KEY_NOT_FOUND} ${PreferencesKeys.APP_KERIA_NOTIFICATION_MARKER}`
-      ) {
-        // Set the preference key
-        await PreferencesStorage.set(
-          PreferencesKeys.APP_KERIA_NOTIFICATION_MARKER,
-          {
-            nextIndex: 0,
-            lastNotificationId: "",
-          }
-        );
-      } else {
-        throw error;
-      }
-    }
+    const notificationQueryRecord = await Agent.agent.basicStorage.findById(
+      MiscRecordId.KERIA_NOTIFICATION_MARKER
+    );
+    if (!notificationQueryRecord) {
+      await Agent.agent.basicStorage.save({
+        id: MiscRecordId.KERIA_NOTIFICATION_MARKER,
+        content: notificationQuery,
+      });
+    } else
+      notificationQuery =
+        notificationQueryRecord.content as unknown as KeriaNotificationMarker;
     // eslint-disable-next-line no-constant-condition
     while (true) {
       if (!Agent.agent.getKeriaOnlineStatus()) {
@@ -91,9 +81,11 @@ class SignifyNotificationService extends AgentService {
           nextIndex: 0,
           lastNotificationId: "",
         };
-        await PreferencesStorage.set(
-          PreferencesKeys.APP_KERIA_NOTIFICATION_MARKER,
-          notificationQuery
+        await Agent.agent.basicStorage.createOrUpdateBasicRecord(
+          new BasicRecord({
+            id: MiscRecordId.KERIA_NOTIFICATION_MARKER,
+            content: notificationQuery,
+          })
         );
         continue;
       }
@@ -112,9 +104,11 @@ class SignifyNotificationService extends AgentService {
           lastNotificationId:
             notifications.notes[notifications.notes.length - 1].i,
         };
-        await PreferencesStorage.set(
-          PreferencesKeys.APP_KERIA_NOTIFICATION_MARKER,
-          notificationQuery
+        await Agent.agent.basicStorage.createOrUpdateBasicRecord(
+          new BasicRecord({
+            id: MiscRecordId.KERIA_NOTIFICATION_MARKER,
+            content: notificationQuery,
+          })
         );
       } else {
         await new Promise((rs) =>

src/core/storage/index.ts

@@ -1,2 +1 @@
 export * from "./secureStorage";
-export * from "./preferences";

src/routes/backRoute/backRoute.test.ts

@@ -60,6 +60,12 @@ describe("getBackRoute", () => {
         connectedWallet: null,
         pendingConnection: null,
       },
+      identifierViewTypeCacheCache: {
+        viewType: null,
+      },
+      biometryCache: {
+        enabled: false,
+      },
     };
   });
 
@@ -176,6 +182,12 @@ describe("getPreviousRoute", () => {
         connectedWallet: null,
         pendingConnection: null,
       },
+      identifierViewTypeCacheCache: {
+        viewType: null,
+      },
+      biometryCache: {
+        enabled: false,
+      },
     };
   });
 

src/routes/nextRoute/nextRoute.test.ts

@@ -62,6 +62,12 @@ describe("NextRoute", () => {
         connectedWallet: null,
         pendingConnection: null,
       },
+      identifierViewTypeCacheCache: {
+        viewType: null,
+      },
+      biometryCache: {
+        enabled: false,
+      },
     };
     data = {
       store: storeMock,
@@ -176,6 +182,12 @@ describe("getNextRoute", () => {
       connectedWallet: null,
       pendingConnection: null,
     },
+    identifierViewTypeCacheCache: {
+      viewType: null,
+    },
+    biometryCache: {
+      enabled: false,
+    },
   };
   const state = {};
   const payload = {};

src/store/index.ts

@@ -5,6 +5,11 @@ import { identifiersCacheSlice } from "./reducers/identifiersCache";
 import { credsCacheSlice } from "./reducers/credsCache";
 import { connectionsCacheSlice } from "./reducers/connectionsCache";
 import { walletConnectionsCacheSlice } from "./reducers/walletConnectionsCache";
+import {
+  getIdentifierViewTypeCacheCache,
+  identifierViewTypeCacheSlice,
+} from "./reducers/identifierViewTypeCache";
+import { biometryCacheSlice } from "./reducers/biometryCache";
 
 const store = configureStore({
   reducer: {
@@ -14,6 +19,8 @@ const store = configureStore({
     credsCache: credsCacheSlice.reducer,
     connectionsCache: connectionsCacheSlice.reducer,
     walletConnectionsCache: walletConnectionsCacheSlice.reducer,
+    identifierViewTypeCacheCache: identifierViewTypeCacheSlice.reducer,
+    biometryCache: biometryCacheSlice.reducer,
   },
 });
 

src/store/reducers/biometryCache/biometryCache.test.ts

@@ -0,0 +1,21 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+import { biometryCacheSlice, setEnableBiometryCache } from "./biometryCache";
+
+describe("biometryCache", () => {
+  const initialState = {
+    enabled: false,
+  };
+  it("should return the initial state", () => {
+    expect(biometryCacheSlice.reducer(undefined, {} as PayloadAction)).toEqual(
+      initialState
+    );
+  });
+
+  it("should handle setEnableBiometryCache", () => {
+    const newState = biometryCacheSlice.reducer(
+      initialState,
+      setEnableBiometryCache(true)
+    );
+    expect(newState.enabled).toEqual(true);
+  });
+});