fix: do not enable the eventManager by default + add close method (#331)

apps/angular-wallet/src/app/services/wallet.service.ts

@@ -31,13 +31,19 @@ export class WalletService {
         walletAbstraction: new WalletApiClient('mainnet', core, {
           apiURL,
         }),
+        eventManagerParams: {
+          pullInterval: 5000,
+        },
       }),
       testnet: new Wallet({
         chainType: 'testnet',
         auth: { mnemonic },
         walletAbstraction: new WalletApiClient('testnet', core, {
           apiURL,
         }),
+        eventManagerParams: {
+          pullInterval: 5000,
+        },
       }),
     };
 

apps/arianee-react-wallet/src/app/utils/wallet.ts

@@ -31,6 +31,9 @@ export const getWallet = (chainType: ChainType, walletApiUrl: string) => {
     chainType,
     arianeeAccessToken,
     arianeeAccessTokenPrefix: prefix,
+    eventManagerParams: {
+      pullInterval: 5000,
+    },
   });
 
   return wallet;

packages/wallet/README.md

@@ -176,7 +176,8 @@ wallet.authenticate(); // force generate a wallet scoped arianee access token, u
 
 The wallet emits events that can be listened to. It uses a pull mechanism under the hood, the pull interval can be passed to the constructor under the `eventManagerParams.pullInterval` key. Events will be pulled every `pullInterval` milliseconds if and only if there is at least one listener.
 
-Default pull interval is 5 seconds.
+Default pull interval is -1 (disabled), to enable it, pass any value above 0 (e.g. 5000 for 5 seconds).
+If you use this feature, make sure to call `wallet.close()` when you are done with the wallet to stop the event manager and associated interval / listeners.
 
 ```typescript
 // pull events every 2 seconds
@@ -197,6 +198,9 @@ wallet.smartAsset.received.removeListener(listener);
 
 // remove all listeners
 wallet.smartAsset.received.removeAllListeners();
+
+// once you are done with the wallet, make sure to close it to stop the event manager (if you enabled it / set pull interval > 0)
+wallet.close();
 ```
 
 ### Proofs

packages/wallet/src/lib/services/eventManager/eventManager.spec.ts

@@ -47,16 +47,12 @@ describe('EventManager', () => {
         caseName: 'parameterized interval',
         interval: 2000,
       },
-      {
-        caseName: 'default interval (5000)',
-        interval: undefined,
-      },
     ])(
       'should call setInterval with the pull method (interval: $caseName)',
       ({ interval }) => {
         jest.clearAllMocks();
 
-        const expectedInterval = interval ?? 5000;
+        const expectedInterval = interval ?? -1;
 
         expect(setIntervalSpy).not.toHaveBeenCalled();
 
@@ -70,6 +66,18 @@ describe('EventManager', () => {
         );
       }
     );
+
+    it('should not call setInterval with the pull method (interval: default interval (-1))', () => {
+      jest.clearAllMocks();
+
+      expect(setIntervalSpy).not.toHaveBeenCalled();
+
+      new EventManager(chainType, walletApiClient, userAddress, jest.fn(), {
+        pullInterval: -1,
+      });
+
+      expect(setIntervalSpy).not.toHaveBeenCalled();
+    });
   });
 
   describe('pull', () => {

packages/wallet/src/lib/services/eventManager/eventManager.ts

@@ -20,8 +20,8 @@ type WrappedEventEmitters = {
 
 export type EventManagerParams = {
   /**
-   * Interval between each pull in ms
-   * @default 5000
+   * Interval between each pull in ms, -1 to disable (default), any value > 0 to enable
+   * @default -1
    */
   pullInterval?: number;
   arianeeApiUrl?: string;
@@ -34,6 +34,8 @@ export default class EventManager<T extends ChainType>
   private pullAfter!: Date;
   private arianeeApiClient: ArianeeApiClient;
 
+  private timer: ReturnType<typeof setInterval> | null = null;
+
   private userTokenIds: SmartAsset['certificateId'][] = [];
   private userTokenIssuers: BrandIdentity['address'][] = [];
 
@@ -46,7 +48,10 @@ export default class EventManager<T extends ChainType>
     private fetchLike: typeof fetch,
     params?: EventManagerParams
   ) {
-    this.pullInterval = params?.pullInterval ?? 5000;
+    this.pullInterval = params?.pullInterval ?? -1;
+
+    if (this.pullInterval === 0)
+      throw new Error('Pull interval must be greater than 0, or -1 to disable');
 
     this.arianeeApiClient = new ArianeeApiClient(
       params?.arianeeApiUrl ?? 'https://api.arianee.com',
@@ -56,7 +61,16 @@ export default class EventManager<T extends ChainType>
     this.updatePullAfter();
 
     if (this.pullInterval > 0)
-      setInterval(this.pull.bind(this), this.pullInterval);
+      this.timer = setInterval(this.pull.bind(this), this.pullInterval);
+  }
+
+  /** Remove all listeners and interval */
+  public kill() {
+    if (this.timer) clearInterval(this.timer);
+
+    this.arianee.removeAllListeners();
+
+    this.timer = null;
   }
 
   private readonly arianee: EventEmitter = new EventEmitter();

packages/wallet/src/lib/wallet.ts

@@ -204,6 +204,13 @@ export default class Wallet<
     return this.core.getAddress();
   }
 
+  /**
+   * Close all connections and stop all listeners should be called when the wallet instance won't be used anymore
+   */
+  public close() {
+    this.eventManager.kill();
+  }
+
   /**
    * Use this to force trigger an authentication signature if
    * you use a wallet provider such as Metamask or WalletConnect