Add timeout to payLightning so we go to PaymentFailed on timeout.

The timeout needs to be in the sendPayment promise to ensure that we resolve the promise on timeout, otherwise it might resolve/reject later on. This could cause undesirable side effects such as navigating to the success screen or showing an unexpected notification.

Author: valentinewallace

src/action/payment.js

@@ -3,7 +3,7 @@
  * call the corresponding GRPC apis for payment management.
  */
 
-import { PREFIX_URI } from '../config';
+import { PREFIX_URI, PAYMENT_TIMEOUT } from '../config';
 import {
   toSatoshis,
   toAmount,
@@ -174,17 +174,26 @@ class PaymentAction {
       this._nav.goWait();
       const invoice = this._store.payment.address.replace(PREFIX_URI, '');
       const stream = this._grpc.sendStreamCommand('sendPayment');
-      await new Promise((resolve, reject) => {
+      const success = await new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => resolve(false), PAYMENT_TIMEOUT);
         stream.on('data', data => {
           if (data.payment_error) {
+            clearTimeout(timeout);
             reject(new Error(`Lightning payment error: ${data.payment_error}`));
           } else {
-            resolve();
+            clearTimeout(timeout);
+            resolve(true);
           }
         });
-        stream.on('error', reject);
+        stream.on('error', () => {
+          clearTimeout(timeout);
+          reject();
+        });
         stream.write(JSON.stringify({ payment_request: invoice }), 'utf8');
       });
+      if (!success) {
+        this._nav.goPaymentFailed();
+      }
       this._nav.goPayLightningDone();
     } catch (err) {
       this._nav.goPayLightningConfirm();

src/config.js

@@ -6,6 +6,7 @@ module.exports.RETRY_DELAY = 1000;
 module.exports.LND_INIT_DELAY = 5000;
 module.exports.NOTIFICATION_DELAY = 5000;
 module.exports.RATE_DELAY = 15 * 60 * 1000;
+module.exports.PAYMENT_TIMEOUT = 60 * 1000;
 
 module.exports.LND_PORT = 10006;
 module.exports.LND_PEER_PORT = 10016;

test/unit/action/payment.spec.js

@@ -22,6 +22,7 @@ describe('Action Payments Unit Tests', () => {
     store = new Store();
     store.settings.displayFiat = false;
     require('../../../src/config').RETRY_DELAY = 1;
+    require('../../../src/config').PAYMENT_TIMEOUT = 500;
     grpc = sinon.createStubInstance(GrpcAction);
     notification = sinon.createStubInstance(NotificationAction);
     nav = sinon.createStubInstance(NavAction);
@@ -240,5 +241,11 @@ describe('Action Payments Unit Tests', () => {
       expect(nav.goPayLightningConfirm, 'was called once');
       expect(notification.display, 'was called once');
     });
+
+    it('should go to error page on timeout', async () => {
+      await payment.payLightning({ invoice: 'some-invoice' });
+      expect(nav.goPaymentFailed, 'was called once');
+      expect(nav.goPayLightningConfirm, 'was not called');
+    });
   });
 });