Renaming TransportConnectionClosed to TransportConnectionFailed

Author: leszekhanusz

gql/transport/common/adapters/aiohttp.py

@@ -8,7 +8,7 @@
 from aiohttp.typedefs import LooseHeaders, StrOrURL
 from multidict import CIMultiDictProxy
 
-from ...exceptions import TransportConnectionClosed, TransportProtocolError
+from ...exceptions import TransportConnectionFailed, TransportProtocolError
 from ..aiohttp_closed_event import create_aiohttp_closed_event
 from .connection import AdapterConnection
 
@@ -160,7 +160,7 @@ async def connect(self) -> None:
                 **connect_args,
             )
         except Exception as e:
-            raise TransportConnectionClosed("Connect failed") from e
+            raise TransportConnectionFailed("Connect failed") from e
 
         self._response_headers = self.websocket._response.headers
 
@@ -171,15 +171,15 @@ async def send(self, message: str) -> None:
             message: String message to send
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
         """
         if self.websocket is None:
-            raise TransportConnectionClosed("Connection is already closed")
+            raise TransportConnectionFailed("Connection is already closed")
 
         try:
             await self.websocket.send_str(message)
         except ConnectionResetError as e:
-            raise TransportConnectionClosed("Connection was closed") from e
+            raise TransportConnectionFailed("Connection was closed") from e
 
     async def receive(self) -> str:
         """Receive message from the WebSocket server.
@@ -188,12 +188,12 @@ async def receive(self) -> str:
             String message received
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
             TransportProtocolError: If protocol error or binary data received
         """
         # It is possible that the websocket has been already closed in another task
         if self.websocket is None:
-            raise TransportConnectionClosed("Connection is already closed")
+            raise TransportConnectionFailed("Connection is already closed")
 
         while True:
             ws_message = await self.websocket.receive()
@@ -208,7 +208,7 @@ async def receive(self) -> str:
             WSMsgType.CLOSING,
             WSMsgType.ERROR,
         ):
-            raise TransportConnectionClosed("Connection was closed")
+            raise TransportConnectionFailed("Connection was closed")
         elif ws_message.type is WSMsgType.BINARY:
             raise TransportProtocolError("Binary data received in the websocket")
 

gql/transport/common/adapters/connection.py

@@ -35,7 +35,7 @@ async def send(self, message: str) -> None:
             message: String message to send
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
         """
         pass  # pragma: no cover
 
@@ -47,7 +47,7 @@ async def receive(self) -> str:
             String message received
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
             TransportProtocolError: If protocol error or binary data received
         """
         pass  # pragma: no cover

gql/transport/common/adapters/websockets.py

@@ -6,7 +6,7 @@
 from websockets.client import WebSocketClientProtocol
 from websockets.datastructures import Headers, HeadersLike
 
-from ...exceptions import TransportConnectionClosed, TransportProtocolError
+from ...exceptions import TransportConnectionFailed, TransportProtocolError
 from .connection import AdapterConnection
 
 log = logging.getLogger("gql.transport.common.adapters.websockets")
@@ -70,7 +70,7 @@ async def connect(self) -> None:
         try:
             self.websocket = await websockets.client.connect(self.url, **connect_args)
         except Exception as e:
-            raise TransportConnectionClosed("Connect failed") from e
+            raise TransportConnectionFailed("Connect failed") from e
 
         self._response_headers = self.websocket.response_headers
 
@@ -81,15 +81,15 @@ async def send(self, message: str) -> None:
             message: String message to send
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
         """
         if self.websocket is None:
-            raise TransportConnectionClosed("Connection is already closed")
+            raise TransportConnectionFailed("Connection is already closed")
 
         try:
             await self.websocket.send(message)
         except Exception as e:
-            raise TransportConnectionClosed("Connection was closed") from e
+            raise TransportConnectionFailed("Connection was closed") from e
 
     async def receive(self) -> str:
         """Receive message from the WebSocket server.
@@ -98,18 +98,18 @@ async def receive(self) -> str:
             String message received
 
         Raises:
-            TransportConnectionClosed: If connection closed
+            TransportConnectionFailed: If connection closed
             TransportProtocolError: If protocol error or binary data received
         """
         # It is possible that the websocket has been already closed in another task
         if self.websocket is None:
-            raise TransportConnectionClosed("Connection is already closed")
+            raise TransportConnectionFailed("Connection is already closed")
 
         # Wait for the next websocket frame. Can raise ConnectionClosed
         try:
             data = await self.websocket.recv()
         except Exception as e:
-            raise TransportConnectionClosed("Connection was closed") from e
+            raise TransportConnectionFailed("Connection was closed") from e
 
         # websocket.recv() can return either str or bytes
         # In our case, we should receive only str here

gql/transport/common/base.py

@@ -11,7 +11,7 @@
 from ..exceptions import (
     TransportAlreadyConnected,
     TransportClosed,
-    TransportConnectionClosed,
+    TransportConnectionFailed,
     TransportProtocolError,
     TransportQueryError,
     TransportServerError,
@@ -134,7 +134,7 @@ async def _send(self, message: str) -> None:
         try:
             await self.adapter.send(message)
             log.info(">>> %s", message)
-        except TransportConnectionClosed as e:
+        except TransportConnectionFailed as e:
             await self._fail(e, clean_close=False)
             raise e
 
@@ -146,7 +146,7 @@ async def _receive(self) -> str:
             raise TransportClosed("Transport is already closed")
 
         # Wait for the next frame.
-        # Can raise TransportConnectionClosed or TransportProtocolError
+        # Can raise TransportConnectionFailed or TransportProtocolError
         answer: str = await self.adapter.receive()
 
         log.info("<<< %s", answer)
@@ -211,7 +211,7 @@ async def _receive_data_loop(self) -> None:
                 # Wait the next answer from the server
                 try:
                     answer = await self._receive()
-                except (TransportConnectionClosed, TransportProtocolError) as e:
+                except (TransportConnectionFailed, TransportProtocolError) as e:
                     await self._fail(e, clean_close=False)
                     break
                 except TransportClosed:
@@ -296,7 +296,7 @@ async def subscribe(
             while True:
 
                 # Wait for the answer from the queue of this query_id
-                # This can raise TransportError or TransportConnectionClosed
+                # This can raise TransportError or TransportConnectionFailed
                 answer_type, execution_result = await listener.get()
 
                 # If the received answer contains data,
@@ -402,7 +402,7 @@ async def connect(self) -> None:
             # if no ACKs are received within the ack_timeout
             try:
                 await self._initialize()
-            except TransportConnectionClosed as e:
+            except TransportConnectionFailed as e:
                 raise e
             except (
                 TransportProtocolError,

gql/transport/exceptions.py

@@ -61,7 +61,7 @@ class TransportClosed(TransportError):
     """
 
 
-class TransportConnectionClosed(TransportError):
+class TransportConnectionFailed(TransportError):
     """Transport adapter connection closed.
 
     This exception is by the connection adapter code when a connection closed.

gql/transport/phoenix_channel_websockets.py

@@ -8,7 +8,7 @@
 from .common.adapters.websockets import WebSocketsAdapter
 from .common.base import SubscriptionTransportBase
 from .exceptions import (
-    TransportConnectionClosed,
+    TransportConnectionFailed,
     TransportProtocolError,
     TransportQueryError,
     TransportServerError,
@@ -127,7 +127,7 @@ async def heartbeat_coro():
                             }
                         )
                     )
-                except TransportConnectionClosed:  # pragma: no cover
+                except TransportConnectionFailed:  # pragma: no cover
                     return
 
         self.heartbeat_task = asyncio.ensure_future(heartbeat_coro())

gql/transport/websockets_protocol.py

@@ -9,7 +9,7 @@
 from .common.adapters.connection import AdapterConnection
 from .common.base import SubscriptionTransportBase
 from .exceptions import (
-    TransportConnectionClosed,
+    TransportConnectionFailed,
     TransportProtocolError,
     TransportQueryError,
     TransportServerError,
@@ -508,7 +508,7 @@ async def _close_hook(self):
         if self.send_ping_task is not None:
             log.debug("_close_hook: cancelling send_ping_task")
             self.send_ping_task.cancel()
-            with suppress(asyncio.CancelledError, TransportConnectionClosed):
+            with suppress(asyncio.CancelledError, TransportConnectionFailed):
                 log.debug("_close_hook: awaiting send_ping_task")
                 await self.send_ping_task
             self.send_ping_task = None

tests/test_aiohttp_websocket_exceptions.py

@@ -7,7 +7,7 @@
 
 from gql import Client, gql
 from gql.transport.exceptions import (
-    TransportConnectionClosed,
+    TransportConnectionFailed,
     TransportProtocolError,
     TransportQueryError,
 )
@@ -289,7 +289,7 @@ async def test_aiohttp_websocket_server_closing_directly(event_loop, server):
 
     sample_transport = AIOHTTPWebsocketsTransport(url=url)
 
-    with pytest.raises(TransportConnectionClosed):
+    with pytest.raises(TransportConnectionFailed):
         async with Client(transport=sample_transport):
             pass
 
@@ -309,7 +309,7 @@ async def test_aiohttp_websocket_server_closing_after_ack(
 
     query = gql("query { hello }")
 
-    with pytest.raises(TransportConnectionClosed):
+    with pytest.raises(TransportConnectionFailed):
         await session.execute(query)
 
 

tests/test_aiohttp_websocket_graphqlws_exceptions.py

@@ -6,7 +6,7 @@
 from gql import Client, gql
 from gql.transport.exceptions import (
     TransportClosed,
-    TransportConnectionClosed,
+    TransportConnectionFailed,
     TransportProtocolError,
     TransportQueryError,
 )
@@ -248,7 +248,7 @@ async def test_aiohttp_websocket_graphqlws_server_closing_directly(
 
     transport = AIOHTTPWebsocketsTransport(url=url)
 
-    with pytest.raises(TransportConnectionClosed):
+    with pytest.raises(TransportConnectionFailed):
         async with Client(transport=transport):
             pass
 
@@ -268,7 +268,7 @@ async def test_aiohttp_websocket_graphqlws_server_closing_after_ack(
 
     query = gql("query { hello }")
 
-    with pytest.raises(TransportConnectionClosed):
+    with pytest.raises(TransportConnectionFailed):
         await session.execute(query)
 
     await session.transport.wait_closed()

tests/test_aiohttp_websocket_graphqlws_subscription.py

@@ -8,7 +8,7 @@
 from parse import search
 
 from gql import Client, gql
-from gql.transport.exceptions import TransportConnectionClosed, TransportServerError
+from gql.transport.exceptions import TransportConnectionFailed, TransportServerError
 
 from .conftest import MS, PyPy, WebSocketServerHelper
 
@@ -394,7 +394,7 @@ async def test_aiohttp_websocket_graphqlws_subscription_server_connection_closed
     count = 10
     subscription = gql(subscription_str.format(count=count))
 
-    with pytest.raises(TransportConnectionClosed):
+    with pytest.raises(TransportConnectionFailed):
         async for result in session.subscribe(subscription):
             number = result["number"]
             print(f"Number received: {number}")
@@ -843,7 +843,7 @@ async def test_aiohttp_websocket_graphqlws_subscription_reconnecting_session(
         print("\nSUBSCRIPTION_1_WITH_DISCONNECT\n")
         async for result in session.subscribe(subscription_with_disconnect):
             pass
-    except TransportConnectionClosed:
+    except TransportConnectionFailed:
         pass
 
     await asyncio.sleep(50 * MS)
@@ -861,7 +861,7 @@ async def test_aiohttp_websocket_graphqlws_subscription_reconnecting_session(
             generator = session.subscribe(subscription)
             async for result in generator:
                 pass
-    except (TransportClosed, TransportConnectionClosed):
+    except (TransportClosed, TransportConnectionFailed):
         if generator:
             await generator.aclose()
         pass