Websocket provider reconnecting timeout and reconnection event added

CHANGELOG.md

@@ -83,3 +83,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Provider timeout fixed and Maps are used now to handle subscriptions (#2955)
 - stripHexPrefix fixed (#2989)
 - BatchRequest error handling fixed for callbacks (#2993)
+- ``reconnected`` event and reconnection timeout option added to WebsocketProvider (#2994)

packages/web3-providers/src/factories/ProvidersModuleFactory.js

@@ -138,7 +138,7 @@ export default class ProvidersModuleFactory {
             connection = new window.WebSocket(url, options.protocol);
         }
 
-        return new WebsocketProvider(connection, options.timeout);
+        return new WebsocketProvider(connection, options.timeout, options.reconnectionTimeout);
     }
 
     /**

packages/web3-providers/src/providers/WebsocketProvider.js

@@ -26,13 +26,31 @@ import isArray from 'lodash/isArray';
 export default class WebsocketProvider extends AbstractSocketProvider {
     /**
      * @param {WebSocket} connection
-     * @param {Number} timeout
+     * @param {Number} responseTimeout
+     * @param {Number} reconnectionTimeout
      *
      * @constructor
      */
-    constructor(connection, timeout) {
-        super(connection, timeout);
+    constructor(connection, responseTimeout, reconnectionTimeout = 5000) {
+        super(connection, responseTimeout);
         this.host = this.connection.url;
+        this.reconnectionTimeout = reconnectionTimeout;
+        this.reconnecting = false;
+    }
+
+    /**
+     * Emits the connect event and checks if there are subscriptions defined that should be resubscribed.
+     *
+     * @method onConnect
+     */
+    async onConnect() {
+        if (this.reconnecting) {
+            this.emit('reconnected');
+        }
+
+        await super.onConnect()
+
+        this.reconnecting = false;
     }
 
     /**
@@ -86,6 +104,8 @@ export default class WebsocketProvider extends AbstractSocketProvider {
      * @method reconnect
      */
     reconnect() {
+        this.reconnecting = true;
+
         setTimeout(() => {
             this.removeAllSocketListeners();
 
@@ -106,7 +126,7 @@ export default class WebsocketProvider extends AbstractSocketProvider {
 
             this.connection = connection;
             this.registerEventListeners();
-        }, 5000);
+        }, this.reconnectionTimeout);
     }
 
     /**

packages/web3-providers/tests/src/providers/WebsocketProviderTest.js

@@ -13,7 +13,7 @@ describe('WebsocketProviderTest', () => {
         socketMock.addEventListener = jest.fn();
         socketMock.removeEventListener = jest.fn();
 
-        websocketProvider = new WebsocketProvider(socketMock, 1);
+        websocketProvider = new WebsocketProvider(socketMock, 1, 1);
     });
 
     it('constructor check', () => {
@@ -22,6 +22,8 @@ describe('WebsocketProviderTest', () => {
         expect(websocketProvider.connection).toEqual(socketMock);
 
         expect(websocketProvider.timeout).toEqual(1);
+
+        expect(websocketProvider.reconnectionTimeout).toEqual(1);
 
         expect(socketMock.addEventListener.mock.calls[0][0]).toEqual('message');
         expect(socketMock.addEventListener.mock.calls[0][1]).toBeInstanceOf(Function);
@@ -445,4 +447,14 @@ describe('WebsocketProviderTest', () => {
 
         expect(websocketProvider.listenerCount('connect')).toEqual(0);
     });
+
+    it('calls onConnect after the connection got lost', (done) => {
+        websocketProvider.on('reconnected', () => {
+
+            done();
+        });
+
+        websocketProvider.reconnecting = true;
+        websocketProvider.onConnect();
+    });
 });