add getPendingRequestQueueSize

web3 · Oct 4, 2023 · 715cfe2 · 715cfe2
1 parent 90d78c1
commit 715cfe2
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/packages/web3-utils/CHANGELOG.md b/packages/web3-utils/CHANGELOG.md
@@ -158,4 +158,8 @@ Documentation:
 
 - `soliditySha3()` with BigInt support
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+- `SocketProvider` now contains public function `getPendingRequestQueueSize` (#6451)
diff --git a/packages/web3-utils/src/socket_provider.ts b/packages/web3-utils/src/socket_provider.ts
@@ -188,6 +188,15 @@ export abstract class SocketProvider<
  protected _validateProviderPath(path: string): boolean {
  return !!path;
  }
+
+ /**
+ *
+ * @returns the pendingRequestQueue size
+ */
+ // eslint-disable-next-line class-methods-use-this
+ public getPendingRequestQueueSize() {
+ return this._pendingRequestsQueue.size;
+ }
 
  /**
  *

diff --git a/packages/web3-utils/test/unit/socket_provider.test.ts b/packages/web3-utils/test/unit/socket_provider.test.ts
@@ -312,7 +312,7 @@ describe('SocketProvider', () => {
  });
  // @ts-expect-error run protected method
  expect(provider._pendingRequestsQueue.size).toBe(1);
-
+ expect(provider.getPendingRequestQueueSize()).toBe(1);
  const payload2 = { id: 2, method: 'some_rpc_method' };
  provider.setStatus('connected');
  const req2 = provider.request(payload2);
@@ -331,6 +331,7 @@ describe('SocketProvider', () => {
  provider._clearQueues();
  // @ts-expect-error run protected method
  expect(provider._pendingRequestsQueue.size).toBe(0);
+ expect(provider.getPendingRequestQueueSize()).toBe(0);
  // @ts-expect-error run protected method
  expect(provider._sentRequestsQueue.size).toBe(0);
  });