removal: Remove the deprecated LegacyWebSocketProvider

- As promised, we should remove the `LegacyWebSocketProvider` class in
  `v8`. This commit removes the class and all test cases for it.

Author: fselmo

.circleci/config.yml

@@ -240,7 +240,6 @@ workflows:
                 "integration-goethereum-ipc_async",
                 "integration-goethereum-http",
                 "integration-goethereum-http_async",
-                "integration-goethereum-legacy_ws",
                 "integration-goethereum-ws",
                 "integration-ethtester"
               ]

docs/overview.rst

@@ -22,7 +22,6 @@ following built-in providers:
 
 - :class:`~web3.providers.rpc.HTTPProvider` for connecting to http and https based JSON-RPC servers.
 - :class:`~web3.providers.ipc.IPCProvider` for connecting to ipc socket based JSON-RPC servers.
-- :class:`~web3.providers.legacy_websocket.LegacyWebSocketProvider` (deprecated) for connecting to websocket based JSON-RPC servers.
 - :class:`~web3.providers.async_rpc.AsyncHTTPProvider` for connecting to http and https based JSON-RPC servers asynchronously.
 - :class:`~web3.providers.persistent.AsyncIPCProvider` for connecting to ipc socket based JSON-RPC servers asynchronously via a persistent connection.
 - :class:`~web3.providers.persistent.WebSocketProvider` for connecting to websocket based JSON-RPC servers asynchronously via a persistent connection.

docs/providers.rst

@@ -527,48 +527,6 @@ Interacting with the Persistent Connection
         For example, use ``w3.eth.get_block("latest")`` instead of
         ``w3.socket.make_request("eth_getBlockByNumber", ["latest", True])``.
 
-
-LegacyWebSocketProvider
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. warning::
-
-        ``LegacyWebSocketProvider`` is deprecated and is likely to be removed in a
-        future major release. Please use ``WebSocketProvider`` instead.
-
-.. py:class:: web3.providers.legacy_websocket.LegacyWebSocketProvider(endpoint_uri[, websocket_timeout, websocket_kwargs])
-
-    This provider handles interactions with an WS or WSS based JSON-RPC server.
-
-    * ``endpoint_uri`` should be the full URI to the RPC endpoint such as
-      ``'ws://localhost:8546'``.
-    * ``websocket_timeout`` is the timeout in seconds, used when receiving or
-      sending data over the connection. Defaults to 10.
-    * ``websocket_kwargs`` this should be a dictionary of keyword arguments which
-      will be passed onto the ws/wss websocket connection.
-
-    .. code-block:: python
-
-        >>> from web3 import Web3
-        >>> w3 = Web3(Web3.LegacyWebSocketProvider("ws://127.0.0.1:8546"))
-
-    Under the hood, ``LegacyWebSocketProvider`` uses the python ``websockets`` library for
-    making requests.  If you would like to modify how requests are made, you can
-    use the ``websocket_kwargs`` to do so.  See the `websockets documentation`_ for
-    available arguments.
-
-    .. _`websockets documentation`: https://websockets.readthedocs.io/en/stable/reference/asyncio/client.html#websockets.client.WebSocketClientProtocol
-
-    Unlike HTTP connections, the timeout for WS connections is controlled by a
-    separate ``websocket_timeout`` argument, as shown below.
-
-
-    .. code-block:: python
-
-        >>> from web3 import Web3
-        >>> w3 = Web3(Web3.LegacyWebSocketProvider("ws://127.0.0.1:8546", websocket_timeout=60))
-
-
 AutoProvider
 ~~~~~~~~~~~~
 

tests/core/caching-utils/test_request_caching.py

@@ -16,7 +16,6 @@
     AsyncWeb3,
     HTTPProvider,
     IPCProvider,
-    LegacyWebSocketProvider,
     PersistentConnectionProvider,
     Web3,
     WebSocketProvider,
@@ -48,7 +47,6 @@
 SYNC_PROVIDERS = [
     HTTPProvider,
     IPCProvider,
-    LegacyWebSocketProvider,  # deprecated
 ]
 ASYNC_PROVIDERS = [
     AsyncHTTPProvider,

tests/core/providers/test_auto_provider.py

@@ -4,7 +4,6 @@
 from web3.providers import (
     HTTPProvider,
     IPCProvider,
-    LegacyWebSocketProvider,
 )
 from web3.providers.auto import (
     load_provider_from_environment,
@@ -39,11 +38,6 @@ def delete_environment_variables(monkeypatch):
             IPCProvider,
             {"ipc_path": "/root/path/to/file.ipc"},
         ),
-        (
-            "ws://1.2.3.4:5679",
-            LegacyWebSocketProvider,
-            {"endpoint_uri": "ws://1.2.3.4:5679"},
-        ),
     ),
 )
 def test_load_provider_from_env(monkeypatch, uri, expected_type, expected_attrs):

tests/core/providers/test_legacy_websocket_provider.py

@@ -10,7 +10,6 @@
     EthereumTesterProvider,
     HTTPProvider,
     IPCProvider,
-    LegacyWebSocketProvider,
     Web3,
     WebSocketProvider,
 )
@@ -49,7 +48,6 @@ def test_init_web3_with_async_provider(provider_class):
         BaseProvider,
         ExtendsBaseProvider,
         HTTPProvider,
-        LegacyWebSocketProvider,
         IPCProvider,
         EthereumTesterProvider,
     ),

tests/core/providers/test_provider_init.py

@@ -1,23 +1,2 @@
-import pytest
-
-from websockets.exceptions import (
-    ConnectionClosed,
-)
-
-from web3 import (
-    Web3,
-)
-
 # use same coinbase value as in `web3.py/tests/integration/generate_fixtures/common.py`
 COINBASE = "0xdc544d1aa88ff8bbd2f2aec754b1f1e99e1812fd"
-
-
-class MiscWebSocketTest:
-    def test_websocket_max_size_error(self, w3):
-        w3_ = Web3(
-            Web3.LegacyWebSocketProvider(
-                endpoint_uri=w3.provider.endpoint_uri, websocket_kwargs={"max_size": 1}
-            )
-        )
-        with pytest.raises((OSError, ConnectionClosed)):
-            w3_.eth.get_block(0)

tests/integration/common.py

@@ -1,13 +1,5 @@
 import asyncio
 import socket
-import time
-
-from websockets import (
-    WebSocketException,
-)
-from websockets.legacy.client import (
-    connect,
-)
 
 from web3._utils.threads import (
     Timeout,
@@ -44,30 +36,6 @@ def get_open_port():
     return str(port)
 
 
-async def wait_for_ws(endpoint_uri, timeout=10):
-    start = time.time()
-    while time.time() < start + timeout:
-        try:
-            async with connect(uri=endpoint_uri) as ws:
-                await ws.send(
-                    '{"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":1}'
-                )
-                r = await ws.recv()
-                if isinstance(r, bytes):
-                    r = r.decode("utf-8")
-
-                if "geth" in r.lower():
-                    return
-        except (OSError, WebSocketException):
-            pass
-        except Exception:
-            raise
-        await asyncio.sleep(0.01)
-    raise TimeoutError(
-        f"Geth WebSocket did not respond on {endpoint_uri} within {timeout} seconds."
-    )
-
-
 async def _async_wait_for_block_fixture_logic(async_w3, block_number=1, timeout=None):
     if not timeout:
         current_block_number = await async_w3.eth.block_number  # type:ignore