test: added e2e test for batch requests feature

Signed-off-by: Logan Nguyen <[email protected]>

packages/ws-server/tests/acceptance/batchRequest.spec.ts

@@ -0,0 +1,127 @@
+/*-
+ *
+ * Hedera JSON RPC Relay
+ *
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// external resources
+import { expect } from 'chai';
+import { ethers, WebSocketProvider } from 'ethers';
+import { WsTestConstant, WsTestHelper } from '../helper';
+import { predefined } from '@hashgraph/json-rpc-relay/src';
+
+describe('@web-socket-batch-3 Batch Requests', async function () {
+  let ethersWsProvider: WebSocketProvider;
+  let batchRequests: any = [];
+
+  before(async () => {
+    batchRequests = [
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        method: 'eth_chainId',
+        params: [],
+      },
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        method: 'eth_gasPrice',
+        params: [],
+      },
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        method: 'eth_getBalance',
+        params: [global.accounts[0].address, 'latest'],
+      },
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        method: 'eth_getBalance',
+        params: ['0xhedera', 'latest'], // invalid param
+      },
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        method: 'getLogs', // invalid method
+        params: [],
+      },
+    ];
+  });
+
+  beforeEach(async () => {
+    process.env.WS_BATCH_REQUESTS_ENABLED = 'true';
+    ethersWsProvider = new ethers.WebSocketProvider(WsTestConstant.WS_RELAY_URL);
+  });
+
+  afterEach(async () => {
+    if (ethersWsProvider) await ethersWsProvider.destroy();
+    delete process.env.WS_BATCH_REQUESTS_ENABLED;
+  });
+
+  after(async () => {
+    // expect all the connections to the WS server to be closed after all
+    expect(global.socketServer._connections).to.eq(0);
+  });
+
+  it(`Should submit batch requests to WS server using Standard Web Socket and retrieve batch responses`, async () => {
+    // call batch request
+    const batchResponses = await WsTestHelper.sendRequestToStandardWebSocket(
+      WsTestConstant.BATCH_REQUEST_METHOD_NAME,
+      batchRequests,
+    );
+
+    // individually process each request
+    let promises: any = [];
+    batchRequests.forEach((request: any) => {
+      promises.push(WsTestHelper.sendRequestToStandardWebSocket(request.method, request.params));
+    });
+    const individualResponses = await Promise.all(promises);
+
+    expect(batchResponses).to.deep.eq(individualResponses);
+  });
+
+  it('Should submit batch requests to WS server and get batchRequestDisabledError if WS_BATCH_REQUESTS_DISABLED=false ', async () => {
+    process.env.WS_BATCH_REQUESTS_ENABLED = 'false';
+    const batchResponses = await WsTestHelper.sendRequestToStandardWebSocket(
+      WsTestConstant.BATCH_REQUEST_METHOD_NAME,
+      batchRequests,
+    );
+
+    const expectedError = predefined.WS_BATCH_REQUESTS_DISABLED;
+    delete expectedError.data;
+
+    expect(batchResponses[0].error).to.deep.eq(expectedError);
+  });
+
+  it('Should submit batch requests to WS server and get batchRequestAmountMaxExceed if requests size exceeds WS_BATCH_REQUESTS_MAX_SIZE', async () => {
+    process.env.WS_BATCH_REQUESTS_MAX_SIZE = '1';
+
+    const batchResponses = await WsTestHelper.sendRequestToStandardWebSocket(
+      WsTestConstant.BATCH_REQUEST_METHOD_NAME,
+      batchRequests,
+    );
+
+    const expectedError = predefined.BATCH_REQUESTS_AMOUNT_MAX_EXCEEDED(
+      batchRequests.length,
+      Number(process.env.WS_BATCH_REQUESTS_MAX_SIZE),
+    );
+    delete expectedError.data;
+
+    expect(batchResponses[0].error).to.deep.eq(expectedError);
+  });
+});

packages/ws-server/tests/helper/index.ts

@@ -43,9 +43,15 @@ export class WsTestHelper {
 
     let response: any;
 
-    webSocket.on('open', () => {
-      webSocket.send(JSON.stringify(WsTestHelper.prepareJsonRpcObject(method, params)));
-    });
+    if (method === WsTestConstant.BATCH_REQUEST_METHOD_NAME) {
+      webSocket.on('open', () => {
+        webSocket.send(JSON.stringify(params));
+      });
+    } else {
+      webSocket.on('open', () => {
+        webSocket.send(JSON.stringify(WsTestHelper.prepareJsonRpcObject(method, params)));
+      });
+    }
 
     webSocket.on('message', (data: string) => {
       response = JSON.parse(data);
@@ -88,4 +94,5 @@ export class WsTestConstant {
   static STANDARD_WEB_SOCKET = 'Standard Web Socket';
   static ETHERS_WS_PROVIDER = 'Ethers Web Socket Provider';
   static WS_RELAY_URL = process.env.WS_RELAY_URL || `ws://127.0.0.1:8546`;
+  static BATCH_REQUEST_METHOD_NAME: 'batch_request';
 }