Display LoaderSyncing view while syncing filter headers

Author: tanx

src/action/info.js

@@ -20,6 +20,9 @@ class InfoAction {
    * Fetches the current details of the lnd node and sets the corresponding
    * store parameters. This api is polled at the beginning of app initialization
    * until lnd has finished syncing the chain to the connected bitcoin full node.
+   * Since fetching filter headers can take a long time during initial sync, we
+   * use the number of nodes from the network info api as a proxy if filter
+   * headers are finished syncing and autopilot has enough nodes to start.
    * @return {Promise<undefined>}
    */
   async getInfo() {
@@ -28,22 +31,28 @@ class InfoAction {
       this._store.pubKey = response.identity_pubkey;
       this._store.syncedToChain = response.synced_to_chain;
       this._store.blockHeight = response.block_height;
+      const netRes = await this._grpc.sendCommand('getNetworkInfo');
+      this._store.isSyncing = !response.synced_to_chain || netRes.num_nodes < 2;
       if (this.startingSyncTimestamp === undefined) {
         this.startingSyncTimestamp = response.best_header_timestamp || 0;
       }
-      if (!response.synced_to_chain) {
+      if (this._store.isSyncing) {
         this._notification.display({ msg: 'Syncing to chain', wait: true });
-        log.info(`Syncing to chain ... block height: ${response.block_height}`);
+        log.info(
+          `Syncing to chain ...`,
+          `block height: ${response.block_height}`,
+          `num nodes: ${netRes.num_nodes}`
+        );
         this._store.percentSynced = this.calcPercentSynced(response);
       }
-      return response.synced_to_chain;
+      return !this._store.isSyncing;
     } catch (err) {
       log.error('Getting node info failed', err);
     }
   }
 
   /**
-   * Poll the getInfo api until synced_to_chain is true.
+   * Poll the getInfo api until isSyncing is false.
    * @return {Promise<undefined>}
    */
   async pollInfo() {
@@ -62,7 +71,7 @@ class InfoAction {
       this._nav.goHome();
     } else {
       this._nav.goLoaderSyncing();
-      observe(this._store, 'syncedToChain', () => this._nav.goHome());
+      observe(this._store, 'isSyncing', () => this._nav.goHome());
     }
   }
 
@@ -80,7 +89,8 @@ class InfoAction {
       : 0;
     const totalProgress = currTimestamp - this.startingSyncTimestamp || 0.001;
     const percentSynced = progressSoFar * 1.0 / totalProgress;
-    return percentSynced;
+    // TODO: display max 0.9 until we have progress for fetching filter headers
+    return percentSynced * 0.9;
   }
 }
 

src/store.js

@@ -25,6 +25,7 @@ export class Store {
       walletUnlocked: false, // Is the wallet unlocked
       lndReady: false, // Is lnd process running
       syncedToChain: false, // Is lnd synced to blockchain
+      isSyncing: false, // Is lnd syncing to chain or filter headers
       percentSynced: 0, // Expects 0-1 range
       route: DEFAULT_ROUTE,
       blockHeight: null,

test/unit/action/info.spec.js

@@ -33,41 +33,65 @@ describe('Action Info Unit Tests', () => {
     it('should get public key, synced to chain, and block height', async () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
         identity_pubkey: 'some-pubkey',
-        synced_to_chain: 'true/false',
+        synced_to_chain: true,
         block_height: 'some-height',
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
       await info.getInfo();
       expect(store.pubKey, 'to equal', 'some-pubkey');
-      expect(store.syncedToChain, 'to equal', 'true/false');
+      expect(store.syncedToChain, 'to be', true);
+      expect(store.isSyncing, 'to be', false);
       expect(store.blockHeight, 'to equal', 'some-height');
     });
 
-    it('should return true if chain is synced', async () => {
+    it('should return true if chain and filter headers are synced', async () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
         synced_to_chain: true,
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
       const synced = await info.getInfo();
       expect(synced, 'to be', true);
     });
 
-    it('should set percentSynced', async () => {
-      const testTimestamp = new Date().getTime();
+    it('should return false if chain is synced but not filter headers', async () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
-        synced_to_chain: false,
-        best_header_timestamp: testTimestamp / 1000,
+        synced_to_chain: true,
       });
-      await info.getInfo();
-      expect(store.percentSynced, 'to be within', 0, 1);
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 1,
+      });
+      const synced = await info.getInfo();
+      expect(synced, 'to be', false);
     });
 
-    it('should return false if chain is not synced', async () => {
+    it('should return false if chain is not synced but filter headers are', async () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
         synced_to_chain: false,
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
       const synced = await info.getInfo();
       expect(synced, 'to be', false);
     });
 
+    it('should set percentSynced', async () => {
+      const testTimestamp = new Date().getTime();
+      grpc.sendCommand.withArgs('getInfo').resolves({
+        synced_to_chain: false,
+        best_header_timestamp: testTimestamp / 1000,
+      });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
+      await info.getInfo();
+      expect(store.percentSynced, 'to be within', 0, 1);
+    });
+
     it('should log error on failure', async () => {
       grpc.sendCommand.rejects();
       await info.getInfo();
@@ -89,6 +113,9 @@ describe('Action Info Unit Tests', () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
         synced_to_chain: 'true',
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
       await info.getInfo();
       info.initLoaderSyncing();
       expect(nav.goHome, 'was called once');
@@ -98,12 +125,18 @@ describe('Action Info Unit Tests', () => {
       grpc.sendCommand.withArgs('getInfo').resolves({
         synced_to_chain: false,
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 1,
+      });
       await info.getInfo();
       info.initLoaderSyncing();
       expect(nav.goLoaderSyncing, 'was called once');
       grpc.sendCommand.withArgs('getInfo').resolves({
         synced_to_chain: true,
       });
+      grpc.sendCommand.withArgs('getNetworkInfo').resolves({
+        num_nodes: 2,
+      });
       await info.getInfo();
       expect(nav.goHome, 'was called once');
     });