Add AsyncInterval class (#423)

* Add an async alternative to setInterval()

* Use AsyncInterval for shield progress bar progress

* Use AsyncInterval for the global chain data handler

* Simplify recursion with a while loop

* Do not wait before clearing interval

* Add mock function to PIVXShield getTxStatus

* test that getTxStatus gets called during a shielded tx

scripts/async_interval.js

@@ -0,0 +1,23 @@
+import { sleep } from './utils.js';
+
+/**
+ * Async alternative to setInterval() and clearInterval().
+ */
+export class AsyncInterval {
+    #active = true;
+
+    constructor(cb, timeOut) {
+        this.#setInterval(cb, timeOut);
+    }
+    async #setInterval(cb, timeOut) {
+        while (this.#active) {
+            await cb();
+            await sleep(timeOut);
+        }
+    }
+    clearInterval(timeOut) {
+        setTimeout(() => {
+            this.#active = false;
+        }, timeOut);
+    }
+}

scripts/global.js

@@ -29,6 +29,7 @@ import { cOracle } from './prices.js';
 import pIconCopy from '../assets/icons/icon-copy.svg';
 import pIconCheck from '../assets/icons/icon-check.svg';
 import SideNavbar from './SideNavbar.vue';
+import { AsyncInterval } from './async_interval.js';
 
 /** A flag showing if base MPW is fully loaded or not */
 export let fIsLoaded = false;
@@ -261,13 +262,12 @@ export async function start() {
     await refreshChainData();
     // Load the price manager
     cOracle.load();
-
-    setInterval(() => {
+    new AsyncInterval(async () => {
         // Refresh blockchain data
-        refreshChainData();
+        await refreshChainData();
 
         // Fetch the PIVX prices
-        refreshPriceDisplay();
+        await refreshPriceDisplay();
     }, 15000);
 
     // Check for recent upgrades, display the changelog

scripts/wallet.js

@@ -32,7 +32,7 @@ import {
 import { PIVXShield } from 'pivx-shield';
 import { guiToggleReceiveType } from './contacts-book.js';
 import { TransactionBuilder } from './transaction_builder.js';
-
+import { AsyncInterval } from './async_interval.js';
 /**
  * Class Wallet, at the moment it is just a "realization" of Masterkey with a given nAccount
  * it also remembers which addresses we generated.
@@ -1060,8 +1060,7 @@ export class Wallet {
                 'trying to create a shield transaction without having shield enable'
             );
         }
-
-        const periodicFunction = setInterval(async () => {
+        const periodicFunction = new AsyncInterval(async () => {
             const percentage = (await this.#shield.getTxStatus()) * 100;
             getEventEmitter().emit(
                 'shield-transaction-creation-update',
@@ -1090,7 +1089,7 @@ export class Wallet {
             await sleep(500);
             throw e;
         } finally {
-            clearInterval(periodicFunction);
+            await periodicFunction.clearInterval();
             getEventEmitter().emit(
                 'shield-transaction-creation-update',
                 0.0,

tests/unit/wallet/signature.spec.js

@@ -93,6 +93,7 @@ describe('Wallet signature tests', () => {
                 },
             ],
         });
+        expect(PIVXShield.prototype.getTxStatus).toHaveBeenCalled();
     });
     it('signs a s->t tx correctly', async () => {
         const tx = new Transaction({
@@ -127,6 +128,7 @@ describe('Wallet signature tests', () => {
                 },
             ],
         });
+        expect(PIVXShield.prototype.getTxStatus).toHaveBeenCalled();
     });
     it('signs a t->s tx correctly', async () => {
         const tx = new Transaction({
@@ -169,5 +171,6 @@ describe('Wallet signature tests', () => {
                 },
             ],
         });
+        expect(PIVXShield.prototype.getTxStatus).toHaveBeenCalled();
     });
 });

tests/utils/test_utils.js

@@ -29,6 +29,7 @@ PIVXShield.prototype.getLastSyncedBlock = vi.fn(() => {
 });
 PIVXShield.prototype.getBalance = vi.fn(() => 40 * 10 ** 8);
 
+PIVXShield.prototype.getTxStatus = vi.fn(() => 1.0);
 /**
  * set up and sync a wallet
  * @param {MasterKey} masterKey - masterKey of the wallet