Add cache on MirrorNodeClient.getBlock() (#1192) (#1230)

ebadiere · natanasow · web-flow · commit ea517194c92e · 2023-05-10T13:32:46.000-06:00
* Add caching



* Fix code smell



* Add test



---------

Signed-off-by: nikolay &lt;n.atanasow94@gmail.com&gt;
Signed-off-by: ebadiere &lt;ebadiere@gmail.com&gt;
Co-authored-by: Nikolay Atanasow &lt;n.atanasow94@gmail.com&gt;
diff --git a/packages/relay/src/lib/clients/mirrorNodeClient.ts b/packages/relay/src/lib/clients/mirrorNodeClient.ts
@@ -414,9 +414,18 @@ export class MirrorNodeClient {
     }
 
     public async getBlock(hashOrBlockNumber: string | number, requestId?: string) {
-        return this.get(`${MirrorNodeClient.GET_BLOCK_ENDPOINT}${hashOrBlockNumber}`,
-            MirrorNodeClient.GET_BLOCK_ENDPOINT,
-            requestId);
+        const cachedLabel = `${constants.CACHE_KEY.GET_BLOCK}.${hashOrBlockNumber}`;
+        const cachedResponse: any = this.cache.get(cachedLabel);
+        if (cachedResponse != undefined) {
+            return cachedResponse;
+        }
+
+        const block = await this.get(`${MirrorNodeClient.GET_BLOCK_ENDPOINT}${hashOrBlockNumber}`,
+          MirrorNodeClient.GET_BLOCK_ENDPOINT,
+          requestId);
+
+        this.cache.set(cachedLabel, block);
+        return block;
     }
 
     public async getBlocks(blockNumber?: number | string[], timestamp?: string, limitOrderParams?: ILimitOrderParams, requestId?: string) {
diff --git a/packages/relay/src/lib/constants.ts b/packages/relay/src/lib/constants.ts
@@ -23,7 +23,9 @@ enum CACHE_KEY {
     FEE_HISTORY = 'fee_history',
     GET_CONTRACT_RESULT = 'getContractResult',
     ETH_BLOCK_NUMBER = 'eth_block_number',
-    ETH_GET_BALANCE = 'eth_get_balance'
+    ETH_GET_BALANCE = 'eth_get_balance',
+    GET_TINYBAR_GAS_FEE = 'getTinyBarGasFee',
+    GET_BLOCK = 'getBlock'
 }
 
 enum CACHE_TTL {
diff --git a/packages/relay/tests/lib/eth.spec.ts b/packages/relay/tests/lib/eth.spec.ts
@@ -80,6 +80,7 @@ let restMock: MockAdapter, web3Mock: MockAdapter;
 let mirrorNodeInstance: MirrorNodeClient;
 let sdkClientStub;
 let cache;
+let mirrorNodeCache;
 
 describe('Eth calls using MirrorNode', async function () {
   this.timeout(10000);
@@ -91,6 +92,9 @@ describe('Eth calls using MirrorNode', async function () {
     // @ts-ignore
     mirrorNodeInstance = new MirrorNodeClient(process.env.MIRROR_NODE_URL, logger.child({ name: `mirror-node` }), registry);
 
+    // @ts-ignore
+    mirrorNodeCache = mirrorNodeInstance.cache;
+
     // @ts-ignore
     restMock = new MockAdapter(mirrorNodeInstance.getMirrorNodeRestInstance(), { onNoMatch: "throwException" });
 
@@ -792,6 +796,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByNumber with zero transactions', async function () {
+    mirrorNodeCache.clear();
     // mirror node request mocks
     restMock.onGet(`blocks/${blockNumber}`).reply(200, {...defaultBlock, gas_used: 0});
     restMock.onGet(`contracts/results?timestamp=gte:${defaultBlock.timestamp.from}&timestamp=lte:${defaultBlock.timestamp.to}&limit=100&order=asc`).reply(200, { 'results': [] });
@@ -814,6 +819,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByNumber with match and details', async function () {
+    mirrorNodeCache.clear();
     const resultWithNullGasUsed = {
       ...defaultDetailedContractResults,
       gas_used: null
@@ -844,6 +850,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByNumber with block match and contract revert', async function () {
+    mirrorNodeCache.clear();
     // mirror node request mocks
     restMock.onGet(`blocks/${blockNumber}`).reply(200, {...defaultBlock, gas_used: gasUsed1});
     restMock.onGet(`contracts/results?timestamp=gte:${defaultBlock.timestamp.from}&timestamp=lte:${defaultBlock.timestamp.to}&limit=100&order=asc`).reply(200, defaultContractResultsRevert);
@@ -866,6 +873,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByNumber with no match', async function () {
+    mirrorNodeCache.clear();
     restMock.onGet(`blocks/${blockNumber}`).reply(400, {
       '_status': {
         'messages': [
@@ -993,6 +1001,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByHash with block match and contract revert', async function () {
+    mirrorNodeCache.clear();
     // mirror node request mocks
     restMock.onGet(`blocks/${blockHash}`).reply(200, {...defaultBlock, gas_used: gasUsed1});
     restMock.onGet(`contracts/results?timestamp=gte:${defaultBlock.timestamp.from}&timestamp=lte:${defaultBlock.timestamp.to}&limit=100&order=asc`).reply(200, defaultContractResultsRevert);
@@ -1015,6 +1024,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockByHash with no match', async function () {
+    mirrorNodeCache.clear();
     // mirror node request mocks
     restMock.onGet(`blocks/${blockHash}`).reply(400, {
       '_status': {
@@ -1056,6 +1066,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockTransactionCountByNumber with no match', async function () {
+    mirrorNodeCache.clear();
     restMock.onGet(`blocks/${blockNumber}`).reply(400, {
       '_status': {
         'messages': [
@@ -1113,6 +1124,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_getBlockTransactionCountByHash with no match', async function () {
+    mirrorNodeCache.clear();
     // mirror node request mocks
     restMock.onGet(`blocks/${blockHash}`).reply(400, {
       '_status': {
@@ -1553,6 +1565,7 @@ describe('Eth calls using MirrorNode', async function () {
       });
 
       beforeEach(async () => {
+        mirrorNodeCache.clear();
         restMock.onGet(`blocks?limit=1&order=desc`).reply(200, { blocks: [latestBlock] });
         restMock.onGet(`blocks/3`).reply(200, defaultBlock);
         restMock.onGet(`blocks/0`).reply(200, blockZero);
@@ -2355,6 +2368,7 @@ describe('Eth calls using MirrorNode', async function () {
     });
 
     it('with non-existing toBlock filter', async function () {
+      mirrorNodeCache.clear();
       const filteredLogs = {
         logs: [defaultLogs.logs[0]]
       };
@@ -2493,6 +2507,7 @@ describe('Eth calls using MirrorNode', async function () {
     });
 
     it('with topics and blocks filter', async function () {
+      mirrorNodeCache.clear();
       const filteredLogs = {
         logs: [defaultLogs.logs[0], defaultLogs.logs[1]]
       };
@@ -3537,7 +3552,7 @@ describe('Eth calls using MirrorNode', async function () {
     });
 
     it('eth_getStorageAt should throw a predefined RESOURCE_NOT_FOUND when block not found', async function () {
-
+      mirrorNodeCache.clear();
       let hasError = false;
       try {
         restMock.onGet(`blocks/${blockNumber}`).reply(200, null);
diff --git a/packages/relay/tests/lib/mirrorNodeClient.spec.ts b/packages/relay/tests/lib/mirrorNodeClient.spec.ts
@@ -649,6 +649,21 @@ describe('MirrorNodeClient', async function () {
     expect(result.number).equal(block.number);
   });
 
+  it('`getBlocks` should hit the cache', async () => {
+    const hash = '0x3c08bbbee74d287b1dcd3f0ca6d1d2cb92c90883c4acf9747de9f3f3162ad25b999fc7e86699f60f2a3fb3ed9a646c6b';
+    mock.onGet(`blocks/${hash}`).replyOnce(200, {
+      'hash': '0x3c08bbbee74d287b1dcd3f0ca6d1d2cb92c90883c4acf9747de9f3f3162ad25b999fc7e86699f60f2a3fb3ed9a646c6b',
+      'number': 77
+    });
+
+    for (let i = 0; i < 3; i++) {
+      const result = await mirrorNodeInstance.getBlock(hash);
+      expect(result).to.exist;
+      expect(result.hash).equal(hash);
+      expect(result.number).equal(77);
+    }
+  });
+
   it('`getNetworkExchangeRate`', async () => {
     const exchangerate = {
       'current_rate': {
