web-wallet: Resetting the wallet store should also abort the sync

- The store update after the sync now checks if the sync is aborted
- Streamlined wallet store tests

Resolves #2156

web-wallet/src/lib/navigation/__tests__/logout.spec.js

@@ -11,7 +11,6 @@ describe("logout", () => {
 
   afterEach(() => {
     gotoSpy.mockClear();
-    vi.mocked(walletStore.abortSync).mockClear();
     vi.mocked(walletStore.reset).mockClear();
   });
 
@@ -23,7 +22,6 @@ describe("logout", () => {
   it("should reset the wallet store and redirect the user to the homepage, if the logout is not forced", async () => {
     await navigation.logout(false);
 
-    expect(walletStore.abortSync).toHaveBeenCalledTimes(1);
     expect(walletStore.reset).toHaveBeenCalledTimes(1);
     expect(gotoSpy).toHaveBeenCalledTimes(1);
     expect(gotoSpy).toHaveBeenCalledWith("/");
@@ -32,7 +30,6 @@ describe("logout", () => {
   it("should redirect to `/forced-logout` if the logout is forced", async () => {
     await navigation.logout(true);
 
-    expect(walletStore.abortSync).toHaveBeenCalledTimes(1);
     expect(walletStore.reset).toHaveBeenCalledTimes(1);
     expect(gotoSpy).toHaveBeenCalledTimes(1);
     expect(gotoSpy).toHaveBeenCalledWith("/forced-logout");

web-wallet/src/lib/navigation/logout.js

@@ -11,7 +11,6 @@ import { walletStore } from "$lib/stores";
  * @returns {ReturnType<goto>}
  */
 const logout = (isForced) => {
-  walletStore.abortSync();
   walletStore.reset();
 
   return goto(`/${isForced ? "forced-logout" : ""}`);

web-wallet/src/lib/stores/__tests__/walletStore.spec.js

@@ -1,12 +1,4 @@
-import {
-  afterAll,
-  afterEach,
-  beforeEach,
-  describe,
-  expect,
-  it,
-  vi,
-} from "vitest";
+import { afterAll, beforeEach, describe, expect, it, vi } from "vitest";
 import { get } from "svelte/store";
 import { keys } from "lamb";
 import { Wallet } from "@dusk-network/dusk-wallet-js";
@@ -15,6 +7,7 @@ import { addresses, transactions } from "$lib/mock-data";
 import { rejectAfter, resolveAfter } from "$lib/dusk/test-helpers";
 
 import { walletStore } from "..";
+import { waitFor } from "@testing-library/svelte";
 
 const settleTime = 1000;
 
@@ -24,6 +17,7 @@ describe("walletStore", async () => {
   const balance = { maximum: 100, value: 1 };
   const wallet = new Wallet([]);
 
+  const abortControllerSpy = vi.spyOn(AbortController.prototype, "abort");
   const getBalanceSpy = vi
     .spyOn(Wallet.prototype, "getBalance")
     .mockResolvedValue(balance);
@@ -76,7 +70,8 @@ describe("walletStore", async () => {
     price: 1,
   };
 
-  afterEach(() => {
+  beforeEach(() => {
+    abortControllerSpy.mockClear();
     getBalanceSpy.mockClear();
     getPsksSpy.mockClear();
     historySpy.mockClear();
@@ -87,9 +82,13 @@ describe("walletStore", async () => {
     transferSpy.mockClear();
     unstakeSpy.mockClear();
     withdrawRewardSpy.mockClear();
+    vi.runAllTimers();
+    walletStore.reset();
+    vi.clearAllTimers();
   });
 
   afterAll(() => {
+    abortControllerSpy.mockRestore();
     getBalanceSpy.mockRestore();
     getPsksSpy.mockRestore();
     historySpy.mockRestore();
@@ -105,6 +104,9 @@ describe("walletStore", async () => {
   describe("Initialization and sync", () => {
     it("should expose a `reset` method to bring back the store to its initial state", async () => {
       await walletStore.init(wallet);
+
+      expect(syncSpy).toHaveBeenCalledTimes(1);
+
       await vi.advanceTimersToNextTimerAsync();
 
       expect(get(walletStore)).toStrictEqual(initializedStore);
@@ -114,6 +116,25 @@ describe("walletStore", async () => {
       expect(get(walletStore)).toStrictEqual(initialState);
     });
 
+    it("should abort a sync in progress during the reset and set an error in the store", async () => {
+      walletStore.init(wallet);
+
+      await waitFor(() => syncSpy.mock.calls.length === 1);
+
+      walletStore.reset();
+
+      expect(abortControllerSpy).toHaveBeenCalledOnce();
+      expect(get(walletStore)).toStrictEqual(initialState);
+
+      await vi.advanceTimersToNextTimerAsync();
+
+      expect(get(walletStore)).toStrictEqual({
+        ...initializedStore,
+        balance: initialState.balance,
+        error: new Error("Synchronization aborted"),
+      });
+    });
+
     it("should expose a method to initialize the store with a Wallet instance", async () => {
       await walletStore.init(wallet);
 
@@ -129,6 +150,9 @@ describe("walletStore", async () => {
       expect(getPsksSpy).toHaveBeenCalledTimes(1);
       expect(syncSpy).toHaveBeenCalledTimes(1);
       expect(syncSpy).toHaveBeenCalledWith({ signal: expect.any(AbortSignal) });
+
+      await vi.advanceTimersToNextTimerAsync();
+
       expect(getBalanceSpy).toHaveBeenCalledTimes(1);
       expect(getBalanceSpy).toHaveBeenCalledWith(addresses[0]);
 
@@ -138,8 +162,6 @@ describe("walletStore", async () => {
     });
 
     it("should set the sync error in the store if the sync fails", async () => {
-      walletStore.reset();
-
       const storeWhileLoading = {
         ...initialState,
         addresses: addresses,
@@ -168,19 +190,13 @@ describe("walletStore", async () => {
         error,
         isSyncing: false,
       });
-
-      walletStore.reset();
     });
 
     it("should throw an error when the synchronization is called without initializing the store first", async () => {
-      walletStore.reset();
-
       expect(() => walletStore.sync()).toThrow();
     });
 
     it("should return the pending sync promise if a sync is called while another one is in progress", async () => {
-      walletStore.reset();
-
       await walletStore.init(wallet);
       await vi.advanceTimersToNextTimerAsync();
 
@@ -207,22 +223,10 @@ describe("walletStore", async () => {
       expect(syncSpy).toHaveBeenCalledTimes(2);
 
       await syncPromise4;
-
-      walletStore.reset();
     });
   });
 
   describe("Abort sync", () => {
-    const abortControllerSpy = vi.spyOn(AbortController.prototype, "abort");
-
-    afterEach(() => {
-      abortControllerSpy.mockClear();
-    });
-
-    afterAll(() => {
-      abortControllerSpy.mockRestore();
-    });
-
     it("should expose a method to abort a sync that is in progress", async () => {
       await walletStore.init(wallet);
 
@@ -251,15 +255,15 @@ describe("walletStore", async () => {
     });
 
     it("should do nothing if there is no sync in progress", async () => {
-      walletStore.reset();
-
       await walletStore.init(wallet);
 
       expect(syncSpy).toHaveBeenCalledTimes(1);
       expect(syncSpy).toHaveBeenCalledWith({ signal: expect.any(AbortSignal) });
 
       await vi.advanceTimersToNextTimerAsync();
 
+      expect(get(walletStore)).toStrictEqual(initializedStore);
+
       walletStore.abortSync();
 
       expect(abortControllerSpy).not.toHaveBeenCalled();
@@ -269,10 +273,6 @@ describe("walletStore", async () => {
   describe("Wallet store services", () => {
     const currentAddress = addresses[0];
 
-    afterEach(() => {
-      walletStore.reset();
-    });
-
     beforeEach(async () => {
       await walletStore.init(wallet);
       await vi.advanceTimersToNextTimerAsync();
@@ -287,7 +287,6 @@ describe("walletStore", async () => {
     });
 
     it("should expose a method to clear local data and then init the wallet", async () => {
-      walletStore.reset();
       getPsksSpy.mockClear();
       getBalanceSpy.mockClear();
       syncSpy
@@ -518,8 +517,6 @@ describe("walletStore", async () => {
         await vi.advanceTimersToNextTimerAsync();
 
         expect(get(walletStore).error).toBe(fakeSyncError);
-
-        walletStore.reset();
       });
     });
   });

web-wallet/src/lib/stores/walletStore.js

@@ -83,6 +83,7 @@ const getTransactionsHistory = async () =>
     .then(uniquesById);
 
 function reset() {
+  abortSync();
   walletInstance = null;
   set(initialState);
 }
@@ -153,7 +154,13 @@ function sync() {
     syncController = new AbortController();
     syncPromise = walletInstance
       .sync({ signal: syncController.signal })
-      .then(updateAfterSync, (error) => {
+      .then(() => {
+        if (syncController.signal.aborted) {
+          throw new Error("Synchronization aborted");
+        }
+      })
+      .then(updateAfterSync)
+      .catch((error) => {
         set({ ...store, error, isSyncing: false });
       })
       .finally(() => {