Merge pull request #1571 from input-output-hk/feat/poll-controller

feat(wallet): add optional pollController$ dependency LW-12174

Author: rhyslbw

packages/wallet/src/Wallets/BaseWallet.ts

@@ -189,6 +189,8 @@ export interface BaseWalletDependencies {
   readonly connectionStatusTracker$?: ConnectionStatusTracker;
   readonly publicCredentialsManager: PublicCredentialsManager;
   readonly inputResolver?: Cardano.InputResolver;
+  /** control whether tip tracker should be polling */
+  readonly pollController$?: Observable<boolean>;
 }
 
 export interface SubmitTxOptions {
@@ -327,7 +329,8 @@ export class BaseWallet implements ObservableWallet {
       publicCredentialsManager,
       stores = createInMemoryWalletStores(),
       connectionStatusTracker$ = createSimpleConnectionStatusTracker(),
-      inputResolver
+      inputResolver,
+      pollController$ = of(true)
     }: BaseWalletDependencies
   ) {
     this.#logger = contextLogger(logger, name);
@@ -397,6 +400,7 @@ export class BaseWallet implements ObservableWallet {
       logger: contextLogger(this.#logger, 'tip$'),
       maxPollInterval: maxInterval,
       minPollInterval: pollInterval,
+      pollController$,
       provider$: pollProvider({
         cancel$,
         logger: contextLogger(this.#logger, 'tip$'),

packages/wallet/src/services/TipTracker.ts

@@ -27,6 +27,8 @@ export interface TipTrackerProps {
   provider$: Observable<Cardano.Tip>;
   syncStatus: SyncStatus;
   connectionStatus$: Observable<ConnectionStatus>;
+  /** control whether tip tracker should be polling */
+  pollController$: Observable<boolean>;
   store: DocumentStore<Cardano.Tip>;
   /** Once */
   minPollInterval: Milliseconds;
@@ -46,7 +48,16 @@ export class TipTracker extends PersistentDocumentTrackerSubject<Cardano.Tip> {
   #logger: Logger;
 
   constructor(
-    { provider$, minPollInterval, maxPollInterval, store, syncStatus, connectionStatus$, logger }: TipTrackerProps,
+    {
+      provider$,
+      pollController$,
+      minPollInterval,
+      maxPollInterval,
+      store,
+      syncStatus,
+      connectionStatus$,
+      logger
+    }: TipTrackerProps,
     { externalTrigger$ = new Subject() }: TipTrackerInternals = {}
   ) {
     super(
@@ -63,14 +74,17 @@ export class TipTracker extends PersistentDocumentTrackerSubject<Cardano.Tip> {
             // trigger fetch on start
             startWith(null)
           ),
-          connectionStatus$
+          connectionStatus$,
+          pollController$
         ]).pipe(
-          tap(([, connectionStatus]) => {
-            logger.debug(connectionStatus === ConnectionStatus.down ? 'Skipping fetch tip' : 'Fetching tip...');
+          tap(([, connectionStatus, poll]) => {
+            logger.debug(
+              connectionStatus === ConnectionStatus.down || !poll ? 'Skipping fetch tip' : 'Fetching tip...'
+            );
           }),
           // Throttle syncing by interval, cancel ongoing request on external trigger
-          exhaustMap(([, connectionStatus]) =>
-            connectionStatus === ConnectionStatus.down
+          exhaustMap(([, connectionStatus, poll]) =>
+            connectionStatus === ConnectionStatus.down || !poll
               ? EMPTY
               : provider$.pipe(takeUntil(externalTrigger$.pipe(tap(() => logger.debug('Tip fetch canceled')))))
           ),

packages/wallet/test/services/TipTracker.test.ts

@@ -36,6 +36,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: pollInterval,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: { isSettled$: NEVER } as unknown as SyncStatus
@@ -62,6 +63,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: poll,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -84,6 +86,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: pollInterval,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -105,6 +108,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: pollInterval,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -131,6 +135,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: pollInterval,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -154,6 +159,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: 6,
         minPollInterval: pollInterval,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -177,6 +183,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: Number.MAX_VALUE,
         minPollInterval: 0,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus
@@ -185,6 +192,29 @@ describe('TipTracker', () => {
     });
   });
 
+  it('is not polling while last poll$ emission is false', () => {
+    createTestScheduler().run(({ cold, hot, expectObservable }) => {
+      const poll$ = hot('t----f----t|', trueFalse);
+      const syncStatus: Partial<SyncStatus> = { isSettled$: cold('tftft', trueFalse) };
+      const provider$ = createStubObservable<Cardano.Tip>(
+        cold('a|', mockTips),
+        cold('b|', mockTips),
+        cold('c|', mockTips)
+      );
+      const tracker$ = new TipTracker({
+        connectionStatus$,
+        logger,
+        maxPollInterval: Number.MAX_VALUE,
+        minPollInterval: pollInterval,
+        pollController$: poll$,
+        provider$,
+        store,
+        syncStatus: syncStatus as SyncStatus
+      });
+      expectObservable(tracker$, '^-----------!').toBe('a--b------c', mockTips);
+    });
+  });
+
   it('syncStatus timeout while connection is down does not emit tip updates', () => {
     createTestScheduler().run(({ cold, hot, expectObservable, expectSubscriptions }) => {
       const syncStatus: Partial<SyncStatus> = { isSettled$: hot('10ms |') };
@@ -195,6 +225,7 @@ describe('TipTracker', () => {
         logger,
         maxPollInterval: 6,
         minPollInterval: 0,
+        pollController$: of(true),
         provider$,
         store,
         syncStatus: syncStatus as SyncStatus