tests: add unit tests for streaming event handlers

jamaljsr · jamaljsr · commit df3c97827753 · 2020-06-04T01:49:33.000-04:00
diff --git a/app/package.json b/app/package.json
@@ -90,6 +90,7 @@
       "!src/types/**/*.{js,ts}",
       "!src/i18n/**/*.{js,ts}",
       "!src/util/tests/**/*.{ts,tsx}",
+      "!src/setupProxy.js",
       "!src/index.tsx"
     ]
   },
diff --git a/app/src/__mocks__/@improbable-eng/grpc-web.ts b/app/src/__mocks__/@improbable-eng/grpc-web.ts
@@ -9,6 +9,7 @@ export const grpc = {
     OK: 0,
     Canceled: 1,
   },
+  WebsocketTransport: jest.fn(),
   // mock unary function to simulate GRPC requests
   unary: jest
     .fn()
@@ -32,5 +33,13 @@ export const grpc = {
       },
     ),
   // mock client function to simulate server-side streaming
-  client: jest.fn(),
+  client: jest.fn().mockImplementation(() => {
+    return {
+      onHeaders: jest.fn(func => func()),
+      onMessage: jest.fn(func => func({ toObject: jest.fn() })),
+      onEnd: jest.fn(func => func()),
+      start: jest.fn(),
+      send: jest.fn(),
+    };
+  }),
 };
diff --git a/app/src/__stories__/ChannelBalance.stories.tsx b/app/src/__stories__/ChannelBalance.stories.tsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { lndListChannelsOne } from 'util/tests/sampleData';
+import { lndChannel } from 'util/tests/sampleData';
 import { Store, useStore } from 'store';
 import { Channel } from 'store/models';
 import ChannelBalance from 'components/loop/ChannelBalance';
@@ -11,7 +11,7 @@ export default {
 };
 
 const getChannel = (store: Store, ratio: number) => {
-  const channel = new Channel(store, lndListChannelsOne.channelsList[0]);
+  const channel = new Channel(store, lndChannel);
   channel.localBalance = channel.capacity.mul(ratio);
   channel.remoteBalance = channel.capacity.mul(1 - ratio);
   return channel;
diff --git a/app/src/__tests__/components/loop/ChannelBalance.spec.tsx b/app/src/__tests__/components/loop/ChannelBalance.spec.tsx
@@ -1,6 +1,6 @@
 import React from 'react';
 import { renderWithProviders } from 'util/tests';
-import { lndListChannelsOne } from 'util/tests/sampleData';
+import { lndChannel } from 'util/tests/sampleData';
 import { createStore } from 'store';
 import { Channel } from 'store/models';
 import ChannelBalance from 'components/loop/ChannelBalance';
@@ -13,7 +13,7 @@ describe('ChannelBalance component', () => {
 
   const render = (ratio: number, active = true) => {
     const store = createStore();
-    channel = new Channel(store, lndListChannelsOne.channelsList[0]);
+    channel = new Channel(store, lndChannel);
     channel.localBalance = channel.capacity.mul(ratio);
     channel.remoteBalance = channel.capacity.mul(1 - ratio);
     channel.active = active;
diff --git a/app/src/__tests__/store/authStore.spec.ts b/app/src/__tests__/store/authStore.spec.ts
@@ -1,5 +1,7 @@
 import { grpc } from '@improbable-eng/grpc-web';
+import { waitFor } from '@testing-library/react';
 import AppStorage from 'util/appStorage';
+import { lndListChannels } from 'util/tests/sampleData';
 import { AuthStore, createStore, Store } from 'store';
 import { PersistentSettings } from 'store/stores/settingsStore';
 
@@ -65,4 +67,16 @@ describe('AuthStore', () => {
     await store.init();
     expect(store.credentials).toBe('');
   });
+
+  it('should fetch data after authentication succeeds', async () => {
+    await rootStore.init();
+    expect(rootStore.channelStore.channels.size).toBe(0);
+    await store.login('test-pw');
+    expect(store.authenticated).toBe(true);
+    await waitFor(() => {
+      expect(rootStore.channelStore.channels.size).toBe(
+        lndListChannels.channelsList.length,
+      );
+    });
+  });
 });
diff --git a/app/src/__tests__/store/channelStore.spec.ts b/app/src/__tests__/store/channelStore.spec.ts
@@ -1,9 +1,10 @@
 import { observable, ObservableMap, values } from 'mobx';
+import * as LND from 'types/generated/lnd_pb';
 import { grpc } from '@improbable-eng/grpc-web';
 import { waitFor } from '@testing-library/react';
 import Big from 'big.js';
 import { BalanceMode } from 'util/constants';
-import { lndListChannels } from 'util/tests/sampleData';
+import { lndChannelEvent, lndListChannels } from 'util/tests/sampleData';
 import { createStore, Store } from 'store';
 import Channel from 'store/models/channel';
 import ChannelStore from 'store/stores/channelStore';
@@ -118,4 +119,60 @@ describe('ChannelStore', () => {
 
     expect(+store.totalOutbound).toBe(outbound);
   });
+
+  describe('onChannelEvent', () => {
+    const {
+      OPEN_CHANNEL,
+      CLOSED_CHANNEL,
+      ACTIVE_CHANNEL,
+      INACTIVE_CHANNEL,
+    } = LND.ChannelEventUpdate.UpdateType;
+
+    beforeEach(async () => {
+      await store.fetchChannels();
+    });
+
+    it('should handle inactive channel event', async () => {
+      const event = { ...lndChannelEvent, type: INACTIVE_CHANNEL };
+      const len = lndListChannels.channelsList.length;
+      expect(store.activeChannels).toHaveLength(len);
+      store.onChannelEvent(event);
+      expect(store.activeChannels).toHaveLength(len - 1);
+    });
+
+    it('should handle active channel event', async () => {
+      await store.fetchChannels();
+      const chan = store.channels.get(lndListChannels.channelsList[0].chanId) as Channel;
+      chan.active = false;
+      const event = { ...lndChannelEvent, type: ACTIVE_CHANNEL };
+      const len = lndListChannels.channelsList.length;
+      expect(store.activeChannels).toHaveLength(len - 1);
+      store.onChannelEvent(event);
+      expect(store.activeChannels).toHaveLength(len);
+    });
+
+    it('should handle open channel event', async () => {
+      const event = { ...lndChannelEvent, type: OPEN_CHANNEL };
+      event.openChannel.chanId = '12345';
+      expect(store.channels.get('12345')).toBeUndefined();
+      store.onChannelEvent(event);
+      expect(store.channels.get('12345')).toBeDefined();
+    });
+
+    it('should handle close channel event', async () => {
+      const event = { ...lndChannelEvent, type: CLOSED_CHANNEL };
+      const chanId = event.closedChannel.chanId;
+      expect(store.channels.get(chanId)).toBeDefined();
+      store.onChannelEvent(event);
+      expect(store.channels.get(chanId)).toBeUndefined();
+    });
+
+    it('should do nothing for unknown channel event type', async () => {
+      const event = { ...lndChannelEvent, type: 99 };
+      const len = lndListChannels.channelsList.length;
+      expect(store.activeChannels).toHaveLength(len);
+      store.onChannelEvent(event as any);
+      expect(store.activeChannels).toHaveLength(len);
+    });
+  });
 });
diff --git a/app/src/__tests__/store/nodeStore.spec.ts b/app/src/__tests__/store/nodeStore.spec.ts
@@ -1,7 +1,12 @@
 import { values } from 'mobx';
 import { grpc } from '@improbable-eng/grpc-web';
 import { waitFor } from '@testing-library/react';
-import { lndChannelBalance, lndGetInfo, lndWalletBalance } from 'util/tests/sampleData';
+import {
+  lndChannelBalance,
+  lndGetInfo,
+  lndTransaction,
+  lndWalletBalance,
+} from 'util/tests/sampleData';
 import { createStore, NodeStore, Store } from 'store';
 
 const grpcMock = grpc as jest.Mocked<typeof grpc>;
@@ -60,4 +65,18 @@ describe('NodeStore', () => {
       expect(values(rootStore.uiStore.alerts)[0].message).toBe('test-err');
     });
   });
+
+  it('should handle a transaction event', () => {
+    expect(+store.wallet.walletBalance).toBe(0);
+    store.onTransaction(lndTransaction);
+    expect(+store.wallet.walletBalance).toBe(lndTransaction.amount);
+  });
+
+  it('should handle duplicate transaction events', () => {
+    expect(+store.wallet.walletBalance).toBe(0);
+    store.onTransaction(lndTransaction);
+    expect(+store.wallet.walletBalance).toBe(lndTransaction.amount);
+    store.onTransaction(lndTransaction);
+    expect(+store.wallet.walletBalance).toBe(lndTransaction.amount);
+  });
 });
diff --git a/app/src/__tests__/store/swapStore.spec.ts b/app/src/__tests__/store/swapStore.spec.ts
@@ -75,4 +75,12 @@ describe('SwapStore', () => {
     swap.type = type;
     expect(swap.typeName).toEqual(label);
   });
+
+  it('should handle swap events', () => {
+    const swap = loopListSwaps.swapsList[0];
+    swap.id += 'test';
+    expect(store.sortedSwaps).toHaveLength(0);
+    store.onSwapUpdate(swap);
+    expect(store.sortedSwaps).toHaveLength(1);
+  });
 });
diff --git a/app/src/store/stores/swapStore.ts b/app/src/store/stores/swapStore.ts
@@ -42,11 +42,6 @@ export default class SwapStore {
     );
   }
 
-  /** swaps that are currently pending */
-  @computed get pendingSwaps() {
-    return this.sortedSwaps.filter(s => s.isPending);
-  }
-
   @action.bound
   dismissSwap(swapId: string) {
     this.dismissedSwapIds.push(swapId);
diff --git a/app/src/util/tests/sampleData.ts b/app/src/util/tests/sampleData.ts
@@ -47,55 +47,54 @@ export const lndWalletBalance: LND.WalletBalanceResponse.AsObject = {
   unconfirmedBalance: 0,
 };
 
-export const lndListChannelsOne: LND.ListChannelsResponse.AsObject = {
-  channelsList: [
+const txId = '6ee4e45870ac6191e25173f29804851e9f4bcf10f65f8b63100f488989e1e7a8';
+const outIndex = 0;
+export const lndChannel: LND.Channel.AsObject = {
+  active: true,
+  remotePubkey: '037136742c67e24681f36542f7c8916aa6f6fdf665c1dca2a107425503cff94501',
+  channelPoint: `${txId}:${outIndex}`,
+  chanId: '124244814004224',
+  capacity: 15000000,
+  localBalance: 9988660,
+  remoteBalance: 4501409,
+  commitFee: 11201,
+  commitWeight: 896,
+  feePerKw: 12500,
+  unsettledBalance: 498730,
+  totalSatoshisSent: 1338,
+  totalSatoshisReceived: 499929,
+  numUpdates: 6,
+  pendingHtlcsList: [
     {
-      active: true,
-      remotePubkey: '037136742c67e24681f36542f7c8916aa6f6fdf665c1dca2a107425503cff94501',
-      channelPoint: '0ef6a4ae3d8f800f4eb736f0776f5d3a72571615a1b7218ab17c9a43f85d8949:0',
-      chanId: '124244814004224',
-      capacity: 15000000,
-      localBalance: 9988660,
-      remoteBalance: 4501409,
-      commitFee: 11201,
-      commitWeight: 896,
-      feePerKw: 12500,
-      unsettledBalance: 498730,
-      totalSatoshisSent: 1338,
-      totalSatoshisReceived: 499929,
-      numUpdates: 6,
-      pendingHtlcsList: [
-        {
-          incoming: false,
-          amount: 498730,
-          hashLock: 'pl8fmsyoSqEQFQCw6Zu9e1aIlFnMz5H+hW2mmh3kRlI=',
-          expirationHeight: 285,
-        },
-      ],
-      csvDelay: 1802,
-      pb_private: false,
-      initiator: true,
-      chanStatusFlags: 'ChanStatusDefault',
-      localChanReserveSat: 150000,
-      remoteChanReserveSat: 150000,
-      staticRemoteKey: true,
-      lifetime: 21802,
-      uptime: 21802,
-      closeAddress: '',
+      incoming: false,
+      amount: 498730,
+      hashLock: 'pl8fmsyoSqEQFQCw6Zu9e1aIlFnMz5H+hW2mmh3kRlI=',
+      expirationHeight: 285,
     },
   ],
+  csvDelay: 1802,
+  pb_private: false,
+  initiator: true,
+  chanStatusFlags: 'ChanStatusDefault',
+  localChanReserveSat: 150000,
+  remoteChanReserveSat: 150000,
+  staticRemoteKey: true,
+  lifetime: 21802,
+  uptime: 21802,
+  closeAddress: '',
 };
 
 export const lndListChannels: LND.ListChannelsResponse.AsObject = {
   channelsList: [...Array(500)].map((_, i) => {
-    const c = lndListChannelsOne.channelsList[0];
+    const c = lndChannel;
     // pick a random capacity between 0.5 and 1 BTC
     const cap = Math.floor(Math.random() * 50000000) + 50000000;
     // pick a local balance that is at least 100K sats
     const local = Math.max(100000, Math.floor(Math.random() * cap - 100000));
     return {
       ...c,
-      chanId: `${i}${c.chanId}`,
+      chanId: `${i || ''}${c.chanId}`,
+      channelPoint: `${c.channelPoint.substring(0, c.channelPoint.length - 2)}:${i}`,
       remotePubkey: `${i}${c.remotePubkey}`,
       localBalance: local,
       remoteBalance: cap - local,
@@ -105,6 +104,50 @@ export const lndListChannels: LND.ListChannelsResponse.AsObject = {
   }),
 };
 
+const txIdBytes = Buffer.from(txId, 'hex').reverse().toString('base64');
+export const lndChannelEvent: Required<LND.ChannelEventUpdate.AsObject> = {
+  type: LND.ChannelEventUpdate.UpdateType.OPEN_CHANNEL,
+  openChannel: lndChannel,
+  closedChannel: {
+    capacity: 15000000,
+    chainHash: '0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206',
+    chanId: lndChannel.chanId,
+    channelPoint: lndChannel.channelPoint,
+    closeHeight: 191,
+    closeType: 0,
+    closingTxHash: '1f765f45f2a6d33837a203e3fc911915c891e9b86f9c9d91a1931b92efdedf5b',
+    remotePubkey: '030e98fdacf2464bdfb027b866a018d6cdc5108514208988873abea7eff59afd91',
+    settledBalance: 12990950,
+    timeLockedBalance: 0,
+  },
+  activeChannel: {
+    fundingTxidBytes: txIdBytes,
+    fundingTxidStr: '',
+    outputIndex: outIndex,
+  },
+  inactiveChannel: {
+    fundingTxidBytes: txIdBytes,
+    fundingTxidStr: '',
+    outputIndex: outIndex,
+  },
+};
+
+export const lndTransaction: LND.Transaction.AsObject = {
+  amount: 12990950,
+  blockHash: '',
+  blockHeight: 0,
+  destAddressesList: [
+    'bcrt1qgrvqm263gra5t02cvvkxmp9520rkann0cedzz8',
+    'bcrt1qkggx6pzd768hn6psc5tmwuvv4c2nzvpd3ax9a9',
+  ],
+  numConfirmations: 0,
+  rawTxHex:
+    '02000000000101a8e7e18989480f10638b5ff610cf4b9f1e850498f27351e29161ac7058e4e46e0000000000ffffffff0280841e000000000016001440d80dab5140fb45bd58632c6d84b453c76ece6fe639c60000000000160014b2106d044df68f79e830c517b7718cae1531302d040047304402207e17f9938f04a2379300a5c0f37305c902855fa000726bb7f0ad78d084acfcee02206d3da5edd73624d6ecfa27ae61e994e75bd0ad8cca6c9b7dda087bcf34b2bbbc0148304502210086d0b7e77b1d81f210d55bc13f9eef975774ac1509a22ff649bd2baac85b3fd702203bb272d6372450159b89ca41d97efbf6bdac076bc271696a1bd556efc31b5cda01475221028d084ada5554c83421bfac35bc78332f3c1f6ae980dea1e0eb3220411b7b83972103c60b39c8558f280fe2f0dfa7cb6a04f016470c4670e631458b400774a667610052ae00000000',
+  timeStamp: 1591226124,
+  totalFees: 0,
+  txHash: '1f765f45f2a6d33837a203e3fc911915c891e9b86f9c9d91a1931b92efdedf5b',
+};
+
 //
 // Loop API Responses
 //

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@`
`90`	`90`	`"!src/types/*/.{js,ts}",`
`91`	`91`	`"!src/i18n/*/.{js,ts}",`
`92`	`92`	`"!src/util/tests/*/.{ts,tsx}",`
	`93`	`+ "!src/setupProxy.js",`
`93`	`94`	`"!src/index.tsx"`
`94`	`95`	`]`
`95`	`96`	`},`