api: throttle API calls initiated by stream events

Author: jamaljsr

app/package.json

@@ -30,6 +30,7 @@
     "http-proxy-middleware": "1.0.4",
     "i18next": "19.4.4",
     "i18next-browser-languagedetector": "4.1.1",
+    "lodash": "4.17.15",
     "lottie-web": "5.6.8",
     "mobx": "5.15.4",
     "mobx-react-lite": "2.0.6",
@@ -55,6 +56,7 @@
     "@types/debug": "4.1.5",
     "@types/google-protobuf": "3.7.2",
     "@types/jest": "^25.2.1",
+    "@types/lodash": "4.14.155",
     "@types/node": "^13.13.5",
     "@types/react": "^16.9.34",
     "@types/react-dom": "^16.9.7",

app/src/store/stores/channelStore.ts

@@ -9,6 +9,7 @@ import {
 } from 'mobx';
 import { ChannelEventUpdate, ChannelPoint } from 'types/generated/lnd_pb';
 import Big from 'big.js';
+import debounce from 'lodash/debounce';
 import { Store } from 'store';
 import { Channel } from '../models';
 
@@ -98,6 +99,9 @@ export default class ChannelStore {
     }
   }
 
+  /** fetch channels at most once every 2 seconds when using this func  */
+  fetchChannelsThrottled = debounce(this.fetchChannels, 2000);
+
   /** update the channel list based on events from the API */
   @action.bound
   onChannelEvent(event: ChannelEventUpdate.AsObject) {
@@ -125,11 +129,13 @@ export default class ChannelStore {
       const channel = this.channels.get(event.closedChannel.chanId);
       this.channels.delete(event.closedChannel.chanId);
       this._store.log.info('removed closed channel', toJS(channel));
+      this._store.nodeStore.fetchBalancesThrottled();
     } else if (event.type === OPEN_CHANNEL && event.openChannel) {
       // add the new opened channel
       const channel = new Channel(this._store, event.openChannel);
       this.channels.set(channel.chanId, channel);
       this._store.log.info('added new open channel', toJS(channel));
+      this._store.nodeStore.fetchBalancesThrottled();
     }
   }
 

app/src/store/stores/nodeStore.ts

@@ -1,6 +1,7 @@
 import { action, observable, runInAction, toJS } from 'mobx';
 import { Transaction } from 'types/generated/lnd_pb';
 import Big from 'big.js';
+import debounce from 'lodash/debounce';
 import { Store } from 'store';
 import { Wallet } from '../models';
 
@@ -71,6 +72,9 @@ export default class NodeStore {
     }
   }
 
+  /** fetch balances at most once every 2 seconds when using this func  */
+  fetchBalancesThrottled = debounce(this.fetchBalances, 2000);
+
   /**
    * updates the wallet balance from the transaction provided
    */

app/src/store/stores/swapStore.ts

@@ -100,7 +100,10 @@ export default class SwapStore {
   @action.bound
   onSwapUpdate(loopSwap: SwapStatus.AsObject) {
     this.addOrUpdateSwap(loopSwap);
-    this._store.channelStore.fetchChannels();
+    // the swap update likely caused a change in onchain/offchain balances
+    // so fetch updated data from the server
+    this._store.channelStore.fetchChannelsThrottled();
+    this._store.nodeStore.fetchBalancesThrottled();
   }
 
   /** exports the sorted list of swaps to CSV file */

app/yarn.lock

@@ -2310,6 +2310,11 @@
   resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.4.tgz#38fd73ddfd9b55abb1e1b2ed578cb55bd7b7d339"
   integrity sha512-8+KAKzEvSUdeo+kmqnKrqgeE+LcA0tjYWFY7RPProVYwnqDjukzO+3b6dLD56rYX5TdWejnEOLJYOIeh4CXKuA==
 
+"@types/[email protected]":
+  version "4.14.155"
+  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.155.tgz#e2b4514f46a261fd11542e47519c20ebce7bc23a"
+  integrity sha512-vEcX7S7aPhsBCivxMwAANQburHBtfN9RdyXFk84IJmu2Z4Hkg1tOFgaslRiEqqvoLtbCBi6ika1EMspE+NZ9Lg==
+
 "@types/minimatch@*":
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
@@ -9288,7 +9293,7 @@ [email protected], lodash.uniq@^4.5.0:
   resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773"
   integrity sha1-0CJTc662Uq3BvILklFM5qEJ1R3M=
 
-"lodash@>=3.5 <5", lodash@^4.0.0, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.4, lodash@^4.17.5, lodash@~4.17.12:
+[email protected], "lodash@>=3.5 <5", lodash@^4.0.0, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.4, lodash@^4.17.5, lodash@~4.17.12:
   version "4.17.15"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
   integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==