How to disconnect Websocket on 4.x ?

[timbotro]

Previously you could disconnect your Websocket provider from the main web3 context via:

web3.currentProvider.disconnect()

However that is no longer possible as it isnt an exposed method. I haven't had any luck finding any static methods, anyone know what's the best way to close?
The dangling connections are interfering with my processes exiting nicely.

---

This is what's exposed to me:

WebSocketProvider {
  _eventEmitter: EventEmitter {
    _events: [Object: null prototype] {},
    _eventsCount: 0,
    _maxListeners: undefined,
    [Symbol(kCapture)]: false
  },
  _chainId: '0x504',
  _accounts: [],
  _onMessageHandler: [Function: bound _onMessage],
  _onOpenHandler: [Function: bound _onConnect],
  _onCloseHandler: [Function: bound _onCloseEvent],
  _onErrorHandler: [Function: bound _onError],
  _socketPath: 'wss://moonbeam.api.onfinality.io/public-ws',
  _providerOptions: undefined,
  _reconnectOptions: { autoReconnect: true, delay: 5000, maxAttempts: 5 },
  _pendingRequestsQueue: Map(0) {},
  _sentRequestsQueue: Map(0) {},
  _reconnectAttempts: 0,
  _socketConnection: <ref *1> WebSocket {
    _events: [Object: null prototype] {
      message: [Function],
      open: [Function],
      close: [Function],
      error: [Function]
    },
    _eventsCount: 4,
    _maxListeners: undefined,
    _binaryType: 'nodebuffer',
    _closeCode: 1006,
    _closeFrameReceived: false,
    _closeFrameSent: false,
    _closeMessage: <Buffer >,
    _closeTimer: null,
    _extensions: {},
    _paused: false,
    _protocol: '',
    _readyState: 1,
    _receiver: Receiver {
      _writableState: [WritableState],
      _events: [Object: null prototype],
      _eventsCount: 6,
      _maxListeners: undefined,
      _binaryType: 'nodebuffer',
      _extensions: {},
      _isServer: false,
      _maxPayload: 104857600,
      _skipUTF8Validation: false,
      _bufferedBytes: 0,
      _buffers: [],
      _compressed: false,
      _payloadLength: 567,
      _mask: undefined,
      _fragmented: 0,
      _masked: false,
      _fin: true,
      _opcode: 1,
      _totalPayloadLength: 0,
      _messageLength: 0,
      _fragments: [],
      _state: 0,
      _loop: false,
      [Symbol(kCapture)]: false,
      [Symbol(websocket)]: [Circular *1]
    },
    _sender: Sender {
      _extensions: {},
      _socket: [TLSSocket],
      _firstFragment: true,
      _compress: false,
      _bufferedBytes: 0,
      _deflating: false,
      _queue: []
    },
    _socket: TLSSocket {
      _tlsOptions: [Object],
      _secureEstablished: true,
      _securePending: false,
      _newSessionPending: false,
      _controlReleased: true,
      secureConnecting: false,
      _SNICallback: null,
      servername: 'moonbeam.api.onfinality.io',
      alpnProtocol: false,
      authorized: true,
      authorizationError: null,
      encrypted: true,
      _events: [Object: null prototype],
      _eventsCount: 6,
      connecting: false,
      _hadError: false,
      _parent: null,
      _host: 'moonbeam.api.onfinality.io',
      _closeAfterHandlingError: false,
      _readableState: [ReadableState],
      _maxListeners: undefined,
      _writableState: [WritableState],
      allowHalfOpen: false,
      _sockname: null,
      _pendingData: null,
      _pendingEncoding: '',
      server: undefined,
      _server: null,
      ssl: [TLSWrap],
      _requestCert: true,
      _rejectUnauthorized: true,
      parser: null,
      _httpMessage: null,
      timeout: 0,
      [Symbol(res)]: [TLSWrap],
      [Symbol(verified)]: true,
      [Symbol(pendingSession)]: null,
      [Symbol(async_id_symbol)]: 45,
      [Symbol(kHandle)]: [TLSWrap],
      [Symbol(lastWriteQueueSize)]: 0,
      [Symbol(timeout)]: null,
      [Symbol(kBuffer)]: null,
      [Symbol(kBufferCb)]: null,
      [Symbol(kBufferGen)]: null,
      [Symbol(kCapture)]: false,
      [Symbol(kSetNoDelay)]: true,
      [Symbol(kSetKeepAlive)]: false,
      [Symbol(kSetKeepAliveInitialDelay)]: 0,
      [Symbol(kBytesRead)]: 0,
      [Symbol(kBytesWritten)]: 0,
      [Symbol(connect-options)]: [Object],
      [Symbol(websocket)]: [Circular *1]
    },
    _bufferedAmount: 0,
    _isServer: false,
    _redirects: 0,
    _url: 'wss://moonbeam.api.onfinality.io/public-ws',
    _req: null,
    [Symbol(kCapture)]: false
  },
  chunkResponseParser: ChunkResponseParser {
    _clearQueues: [Function (anonymous)],
    lastChunk: undefined
  }
}

[avkos]

Thank you for your request.
Can you please check if disconnect function exists?

I've tried this code:

const Web3 = require('web3').default;
const web3 = new Web3('ws://127.0.0.1:8545')
console.log('web3.currentProvider',web3.currentProvider)
console.log('web3.currentProvider.disconnect',web3.currentProvider.disconnect)

and result was:

web3.currentProvider WebSocketProvider {
  _eventEmitter: EventEmitter {
    _events: [Object: null prototype] {},
    _eventsCount: 0,
    _maxListeners: undefined,
    [Symbol(kCapture)]: false
  },
  _chainId: '',
  _accounts: [],
  _connectionStatus: 'connecting',
  _onMessageHandler: [Function: bound _onMessage],
  _onOpenHandler: [Function: bound _onConnect],
  _onCloseHandler: [Function: bound _onCloseEvent],
  _onErrorHandler: [Function: bound _onError],
  _socketPath: 'ws://127.0.0.1:8545',
  _providerOptions: undefined,
  _reconnectOptions: { autoReconnect: true, delay: 5000, maxAttempts: 5 },
  _pendingRequestsQueue: Map(0) {},
  _sentRequestsQueue: Map(0) {},
  _reconnectAttempts: 0,
  _socketConnection: WebSocket {
    _events: [Object: null prototype] {
      message: [Function],
      open: [Function],
      close: [Function],
      error: [Function]
    },
    _eventsCount: 4,
    _maxListeners: undefined,
    _binaryType: 'nodebuffer',
    _closeCode: 1006,
    _closeFrameReceived: false,
    _closeFrameSent: false,
    _closeMessage: <Buffer >,
    _closeTimer: null,
    _extensions: {},
    _paused: false,
    _protocol: '',
    _readyState: 0,
    _receiver: null,
    _sender: null,
    _socket: null,
    _bufferedAmount: 0,
    _isServer: false,
    _redirects: 0,
    _url: 'ws://127.0.0.1:8545',
    _req: ClientRequest {
      _events: [Object: null prototype],
      _eventsCount: 3,
      _maxListeners: undefined,
      outputData: [Array],
      outputSize: 223,
      writable: true,
      destroyed: false,
      _last: true,
      chunkedEncoding: false,
      shouldKeepAlive: true,
      maxRequestsOnConnectionReached: false,
      _defaultKeepAlive: true,
      useChunkedEncodingByDefault: false,
      sendDate: false,
      _removedConnection: false,
      _removedContLen: false,
      _removedTE: false,
      strictContentLength: false,
      _contentLength: 0,
      _hasBody: true,
      _trailer: '',
      finished: true,
      _headerSent: true,
      _closed: false,
      socket: null,
      _header: 'GET / HTTP/1.1\r\n' +
        'Sec-WebSocket-Version: 13\r\n' +
        'Sec-WebSocket-Key: StrXnV+0aL5GCIupJnlkSA==\r\n' +
        'Connection: Upgrade\r\n' +
        'Upgrade: websocket\r\n' +
        'Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits\r\n' +
        'Host: 127.0.0.1:8545\r\n' +
        '\r\n',
      _keepAliveTimeout: 0,
      _onPendingData: [Function: nop],
      agent: undefined,
      socketPath: undefined,
      method: 'GET',
      maxHeaderSize: undefined,
      insecureHTTPParser: undefined,
      path: '/',
      _ended: false,
      res: null,
      aborted: false,
      timeoutCb: null,
      upgradeOrConnect: false,
      parser: null,
      maxHeadersCount: null,
      reusedSocket: false,
      host: '127.0.0.1',
      protocol: 'http:',
      [Symbol(kCapture)]: false,
      [Symbol(kBytesWritten)]: 0,
      [Symbol(kEndCalled)]: true,
      [Symbol(kNeedDrain)]: false,
      [Symbol(corked)]: 0,
      [Symbol(kOutHeaders)]: [Object: null prototype],
      [Symbol(kUniqueHeaders)]: null
    },
    [Symbol(kCapture)]: false
  },
  chunkResponseParser: ChunkResponseParser { _clearQueues: [Function (anonymous)] },
  isReconnecting: false
}
web3.currentProvider.disconnect [Function: disconnect]

So, the disconnect function exists

[avkos]

@timbotro you can use this function to see all methods

function getAllPropertyNames(obj) {
    var props = [];

    do {
        Object.getOwnPropertyNames(obj).forEach(function (prop) {
            if (props.indexOf(prop) === -1 && typeof obj[prop]==='function') {
                props.push( prop );
            }
        });
    } while (obj = Object.getPrototypeOf(obj));

    return props;
}
console.log(getAllPropertyNames(web3.currentProvider));

Or you can use our documentation https://docs.web3js.org/api/web3-providers-ws/class/WebSocketProvider

[timbotro]

Still not having any luck with 4.0.1-alpha.5

timbo.ts:4:68 - error TS2339: Property 'disconnect' does not exist on type 'string | SupportedProviders<EthExecutionAPI>'.
  Property 'disconnect' does not exist on type 'string'.

4 console.log('web3.currentProvider.disconnect',web3.currentProvider.disconnect)

Even when casting to any (in case this is just a type issue), calling .disconnect() doesn't do anything and connection stays open for a minimal example:

[avkos]

created an issue #5864

[timbotro]

Cheers @avkos !