5066 - fault tolerance websocket integration tests (#5876)

* add ganache tests

* update ganache tests

* update tests

* updating tests

* update tests

* update changelog for past issue

* remove settimeouts

* update

* delete unneccesary files

* debug

* debuggin

* update

* update tests

* updating tests

* fix lint errors

* fix test

* unskip test

* update onmessage

* update mock unit test

* refactor tests

* fix int test

* fix up integration tests

* update

* remove unneccesary comment

* update docs and changelog

* address feedback

* update provider tests

* add conditional

* address feedback

* address feedback

* add deferredPromise catch and tests

* create mock method for ipc unit test

---------

Co-authored-by: Oleksii Kosynskyi <oleksii.kosynskyi@gmail.com>
Co-authored-by: Wyatt Barnes <me@wyatt.email>

Author: 3 people

docs/docs/guides/web3_migration_guide/providers_migration_guide.md

@@ -199,6 +199,35 @@ const provider = new WebSocketProvider(
 );
 ```
 
+#### Legacy Event `close` has been deprecated
+
+Following EIP-1193, the `close` event has been deprecated and is superceded by `disconnect`.
+In 1.x, we listen for a `close` event:
+
+```ts
+const provider = new WebSocketProvider(host + port);
+// we would use close to listen to the disconnect function
+provider.on('close', function (err) {
+	console.log('closed');
+	resolve();
+});
+provider.disconnect(1012);
+// would eventually log closed
+```
+
+In 4.x, we listen for a `disconnect` event:
+
+```ts
+const provider = new WebSocketProvider(host + port);
+// we would use disconnect to listen to the disconnect function
+provider.on('disconnect', function (err) {
+	console.log('closed');
+	resolve();
+});
+provider.disconnect(1012);
+// would eventually log 'closed'
+```
+
 #### IpcProvider
 
 The IPC provider is used in node.js dapps when running a local node. And it provide the most secure connection.
@@ -313,3 +342,32 @@ provider.on('error', error => {
 	}
 });
 ```
+
+#### Legacy Event `close` has been deprecated
+
+Following EIP-1193, the `close` event has been deprecated and is superceded by `disconnect`.
+In 1.x, we listen for a `close` event:
+
+```ts
+const provider = new IpcProvider(host + port);
+// we would use close to listen to the disconnect function
+provider.on('close', function (err) {
+	console.log('closed');
+	resolve();
+});
+provider.disconnect(1012);
+// would eventually log closed
+```
+
+In 4.x, we listen for a `disconnect` event:
+
+```ts
+const provider = new IpcProvider(host + port);
+// we would use disconnect to listen to the disconnect function
+provider.on('disconnect', function (err) {
+	console.log('closed');
+	resolve();
+});
+provider.disconnect(1012);
+// would eventually log 'closed'
+```

packages/web3-providers-ipc/CHANGELOG.md

@@ -59,6 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   `tsc` compiled files moved to `lib/` directory from `dist/` (#5739)
 -   Refactor to use common SocketProvider class (#5683)
+-   Legacy Event `close` has been deprecated, superseded by `disconnect` (#5683)
 
 ## [4.0.1-alpha.5]
 

packages/web3-providers-ipc/src/index.ts

@@ -129,20 +129,7 @@ export default class IpcProvider<API extends Web3APISpec = EthExecutionAPI> exte
 		this._socketConnection?.on('connect', this._onOpenHandler);
 		this._socketConnection?.on('close', this._onClose.bind(this));
 		this._socketConnection?.on('end', this._onCloseHandler);
-		let errorListeners: unknown[] | undefined;
-		try {
-			errorListeners = (this._socketConnection as Socket)?.listeners('error');
-		} catch (error) {
-			// At some cases (at GitHub pipeline) there is an error raised when trying to access the listeners
-			//	However, no need to do take any specific action in this case beside try adding the event listener for `error`
-			this._socketConnection?.on('error', this._onErrorHandler);
-			return;
-		}
-		// The error event listener may be already there because we do not remove it like the others
-		// 	So we add it only if it was not already added
-		if (!errorListeners || errorListeners.length === 0) {
-			this._socketConnection?.on('error', this._onErrorHandler);
-		}
+		this._socketConnection?.on('error', this._onErrorHandler);
 	}
 
 	protected _removeSocketListeners(): void {
@@ -163,6 +150,8 @@ export default class IpcProvider<API extends Web3APISpec = EthExecutionAPI> exte
 		this._clearQueues(event);
 		this._removeSocketListeners();
 		this._onDisconnect(event?.code, event?.reason);
+		// disconnect was successful and can safely remove error listener
+		this._socketConnection?.removeAllListeners('error');
 	}
 
 	protected _onClose(event: CloseEvent): void {

packages/web3-providers-ipc/test/unit/check_implementation.test.ts

@@ -150,7 +150,9 @@ describe('IPCProvider', () => {
 		it('listeners', () => {
 			const ipc = new IpcProvider(socketPath, undefined, { autoReconnect: false });
 			// @ts-expect-error mock method
-			ipc.chunkResponseParser.parseResponse = jest.fn();
+			ipc.chunkResponseParser.parseResponse = jest.fn(() => {
+				return [];
+			});
 			// @ts-expect-error mock method
 			ipc._socketConnection.listeners = () => {
 				throw new Error('error');
@@ -170,7 +172,8 @@ describe('IPCProvider', () => {
 			ipc.isReconnecting = true;
 			// @ts-expect-error mock method
 			ipc._reconnect = jest.fn();
-
+			// @ts-expect-error mock method
+			ipc._clearQueues = jest.fn();
 			// @ts-expect-error mock method
 			ipc._addSocketListeners();
 			// @ts-expect-error mock method

packages/web3-providers-ws/CHANGELOG.md

@@ -53,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   `main` and `files` entries in `package.json` changed to `lib/` directory from `dist/` (#5739)
 -   Refactor to use common SocketProvider class (#5683)
+-   Legacy Event `close` has been deprecated, superseded by `disconnect` (#5683)
 
 ## [4.0.1-alpha.5]
 

packages/web3-providers-ws/package.json

@@ -41,6 +41,7 @@
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.26.0",
 		"express": "^4.18.1",
+		"ganache": "^7.7.6",
 		"http-proxy-middleware": "^2.0.6",
 		"jest": "^28.1.3",
 		"jest-extended": "^3.0.1",

packages/web3-providers-ws/src/index.ts

@@ -139,23 +139,10 @@ export default class WebSocketProvider<
 	}
 
 	protected _addSocketListeners(): void {
-		this._socketConnection?.addEventListener('message', this._onMessageHandler);
 		this._socketConnection?.addEventListener('open', this._onOpenHandler);
+		this._socketConnection?.addEventListener('message', this._onMessageHandler);
 		this._socketConnection?.addEventListener('close', e => this._onCloseHandler(e));
-		let errorListeners: unknown[] | undefined;
-		try {
-			errorListeners = this._socketConnection?.listeners('error');
-		} catch (error) {
-			// At some cases (at GitHub pipeline) there is an error raised when trying to access the listeners
-			//	However, no need to do take any specific action in this case beside try adding the event listener for `error`
-			this._socketConnection?.addEventListener('error', this._onErrorHandler);
-			return;
-		}
-		// The error event listener may be already there because we do not remove it like the others
-		// 	So we add it only if it was not already added
-		if (!errorListeners || errorListeners.length === 0) {
-			this._socketConnection?.addEventListener('error', this._onErrorHandler);
-		}
+		this._socketConnection?.addEventListener('error', this._onErrorHandler);
 	}
 
 	protected _removeSocketListeners(): void {
@@ -173,10 +160,11 @@ export default class WebSocketProvider<
 			this._reconnect();
 			return;
 		}
-
 		this._clearQueues(event);
 		this._removeSocketListeners();
 		this._onDisconnect(event.code, event.reason);
+		// disconnect was successful and can safely remove error listener
+		this._socketConnection?.removeEventListener('error', this._onErrorHandler);
 	}
 }