|
| 1 | +/*- |
| 2 | + * |
| 3 | + * Hedera JSON RPC Relay |
| 4 | + * |
| 5 | + * Copyright (C) 2024 Hedera Hashgraph, LLC |
| 6 | + * |
| 7 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | + * you may not use this file except in compliance with the License. |
| 9 | + * You may obtain a copy of the License at |
| 10 | + * |
| 11 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | + * |
| 13 | + * Unless required by applicable law or agreed to in writing, software |
| 14 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | + * See the License for the specific language governing permissions and |
| 17 | + * limitations under the License. |
| 18 | + * |
| 19 | + */ |
| 20 | + |
| 21 | +// external resources |
| 22 | +import { expect } from 'chai'; |
| 23 | +import { WsTestHelper } from '../helper'; |
| 24 | +import relayConstants from '@hashgraph/json-rpc-relay/src/lib/constants'; |
| 25 | +import { AliasAccount } from '@hashgraph/json-rpc-server/tests/types/AliasAccount'; |
| 26 | +import { IPRateLimitExceeded } from '@hashgraph/json-rpc-server/dist/koaJsonRpc/lib/RpcError'; |
| 27 | + |
| 28 | +describe('@web-socket-ratelimiter Rate Limit Tests', async function () { |
| 29 | + const rateLimitTier1 = Number(process.env.TIER_1_RATE_LIMIT || relayConstants.DEFAULT_RATE_LIMIT.TIER_1); |
| 30 | + const rateLimitTier2 = Number(process.env.TIER_2_RATE_LIMIT || relayConstants.DEFAULT_RATE_LIMIT.TIER_2); |
| 31 | + const limitDuration = Number(process.env.LIMIT_DURATION) || relayConstants.DEFAULT_RATE_LIMIT.DURATION; |
| 32 | + |
| 33 | + const batchRequests = [ |
| 34 | + { |
| 35 | + id: 1, |
| 36 | + jsonrpc: '2.0', |
| 37 | + method: 'eth_chainId', |
| 38 | + params: [], |
| 39 | + }, |
| 40 | + { |
| 41 | + id: 1, |
| 42 | + jsonrpc: '2.0', |
| 43 | + method: 'eth_blockNumber', |
| 44 | + params: [], |
| 45 | + }, |
| 46 | + ]; |
| 47 | + |
| 48 | + after(async () => { |
| 49 | + // expect all the connections to the WS server to be closed after all |
| 50 | + expect(global.socketServer._connections).to.eq(0); |
| 51 | + }); |
| 52 | + |
| 53 | + it(`Should submit single requests to WS server and receive IPRateLimitExceeded error until rate limit is reached`, async () => { |
| 54 | + const SINGLE_REQUEST_METHOD_NAME = 'eth_gasPrice'; |
| 55 | + for (let i = 0; i < rateLimitTier2; i++) { |
| 56 | + await WsTestHelper.sendRequestToStandardWebSocket(SINGLE_REQUEST_METHOD_NAME, []); |
| 57 | + } |
| 58 | + |
| 59 | + // exceed rate limit |
| 60 | + const response = await WsTestHelper.sendRequestToStandardWebSocket(SINGLE_REQUEST_METHOD_NAME, []); |
| 61 | + const ipRateLimitError = new IPRateLimitExceeded(SINGLE_REQUEST_METHOD_NAME); |
| 62 | + expect(response.error.code).to.deep.eq(ipRateLimitError.code); |
| 63 | + expect(response.error.message).to.deep.eq(ipRateLimitError.message); |
| 64 | + |
| 65 | + // wait until rate limit is reset |
| 66 | + await new Promise((r) => setTimeout(r, limitDuration)); |
| 67 | + }); |
| 68 | + |
| 69 | + it(`Should submit batch requests to WS server and receive IPRateLimitExceeded error until rate limit is reached`, async () => { |
| 70 | + const BATCH_REQUEST_METHOD_NAME = 'batch_request'; |
| 71 | + |
| 72 | + // call batch request multitime to reach limit |
| 73 | + for (let i = 0; i < rateLimitTier1; i++) { |
| 74 | + await WsTestHelper.sendRequestToStandardWebSocket(BATCH_REQUEST_METHOD_NAME, batchRequests); |
| 75 | + } |
| 76 | + |
| 77 | + // exceed rate limit |
| 78 | + const batchResponses = await WsTestHelper.sendRequestToStandardWebSocket(BATCH_REQUEST_METHOD_NAME, batchRequests); |
| 79 | + const ipRateLimitError = new IPRateLimitExceeded(BATCH_REQUEST_METHOD_NAME); |
| 80 | + |
| 81 | + expect(batchResponses[0].error.code).to.deep.eq(ipRateLimitError.code); |
| 82 | + expect(batchResponses[0].error.message).to.deep.eq(ipRateLimitError.message); |
| 83 | + |
| 84 | + // wait until rate limit is reset |
| 85 | + await new Promise((r) => setTimeout(r, limitDuration)); |
| 86 | + }); |
| 87 | + |
| 88 | + it(`Should reset limit for requests`, async () => { |
| 89 | + const SINGLE_REQUEST_METHOD_NAME = 'eth_getBalance'; |
| 90 | + const account: AliasAccount = global.accounts[0]; |
| 91 | + |
| 92 | + for (let i = 0; i < rateLimitTier2; i++) { |
| 93 | + await WsTestHelper.sendRequestToStandardWebSocket(SINGLE_REQUEST_METHOD_NAME, [account.address, 'latest']); |
| 94 | + } |
| 95 | + // exceed rate limit |
| 96 | + const rateLimitResponse = await WsTestHelper.sendRequestToStandardWebSocket(SINGLE_REQUEST_METHOD_NAME, [ |
| 97 | + account.address, |
| 98 | + 'latest', |
| 99 | + ]); |
| 100 | + const ipRateLimitError = new IPRateLimitExceeded(SINGLE_REQUEST_METHOD_NAME); |
| 101 | + expect(rateLimitResponse.error.code).to.deep.eq(ipRateLimitError.code); |
| 102 | + expect(rateLimitResponse.error.message).to.deep.eq(ipRateLimitError.message); |
| 103 | + |
| 104 | + // wait until rate limit is reset |
| 105 | + await new Promise((r) => setTimeout(r, limitDuration)); |
| 106 | + const response = await WsTestHelper.sendRequestToStandardWebSocket(SINGLE_REQUEST_METHOD_NAME, [ |
| 107 | + account.address, |
| 108 | + 'latest', |
| 109 | + ]); |
| 110 | + const expectedResult = await global.relay.call(SINGLE_REQUEST_METHOD_NAME, [account.address, 'latest']); |
| 111 | + expect(response.result).to.eq(expectedResult); |
| 112 | + }); |
| 113 | +}); |
0 commit comments