[feat] connection state (#23)

Author: Gr1N

.github/workflows/default.yml

@@ -19,7 +19,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: Gr1N/setup-poetry@v1
         with:
-          poetry-version: 1.0.0
+          poetry-version: 1.0.5
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pypoetry/virtualenvs

.github/workflows/release-created.yml

@@ -15,7 +15,7 @@ jobs:
           python-version: 3.8
       - uses: Gr1N/setup-poetry@v1
         with:
-          poetry-version: 1.0.0
+          poetry-version: 1.0.5
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pypoetry/virtualenvs
@@ -40,7 +40,7 @@ jobs:
           python-version: 3.8
       - uses: Gr1N/setup-poetry@v1
         with:
-          poetry-version: 1.0.0
+          poetry-version: 1.0.5
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pypoetry/virtualenvs

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 0.12.0 (20XX-XX-XX)
 
+- Added `connected`, `closing` and `disconnected` client properties. Can be used to check connection state of client, #23
+- Bumped minimum required `Sanic` version, #23
+
 ## 0.11.0 (2020-02-21)
 
 - Updated documentation: described why 9125 port used by default, #16

aiodogstatsd/client.py

@@ -16,7 +16,7 @@ class Client:
         "_port",
         "_namespace",
         "_constant_tags",
-        "_closing",
+        "_state",
         "_protocol",
         "_queue",
         "_listen_future",
@@ -26,6 +26,18 @@ class Client:
         "_sample_rate",
     )
 
+    @property
+    def connected(self) -> bool:
+        return self._state == typedefs.CState.CONNECTED
+
+    @property
+    def closing(self) -> bool:
+        return self._state == typedefs.CState.CLOSING
+
+    @property
+    def disconnected(self) -> bool:
+        return self._state == typedefs.CState.DISCONNECTED
+
     def __init__(
         self,
         *,
@@ -52,7 +64,7 @@ def __init__(
         self._namespace = namespace
         self._constant_tags = constant_tags or {}
 
-        self._closing = False
+        self._state = typedefs.CState.DISCONNECTED
 
         self._protocol = DatagramProtocol()
 
@@ -81,14 +93,18 @@ async def connect(self) -> None:
         self._listen_future = asyncio.ensure_future(self._listen())
         self._listen_future_join = asyncio.Future()
 
+        self._state = typedefs.CState.CONNECTED
+
     async def close(self) -> None:
-        self._closing = True
+        self._state = typedefs.CState.CLOSING
 
         try:
             await asyncio.wait_for(self._close(), timeout=self._close_timeout)
         except asyncio.TimeoutError:
             pass
 
+        self._state = typedefs.CState.DISCONNECTED
+
     async def _close(self) -> None:
         await self._listen_future_join
         self._listen_future.cancel()
@@ -176,7 +192,7 @@ def timing(
 
     async def _listen(self) -> None:
         try:
-            while not self._closing:
+            while self.connected:
                 await self._listen_and_send()
         finally:
             # Note that `asyncio.CancelledError` raised on app clean up
@@ -203,8 +219,8 @@ def _report(
         tags: Optional[typedefs.MTags] = None,
         sample_rate: Optional[typedefs.MSampleRate] = None,
     ) -> None:
-        # If client in closing state, then ignore any new incoming metric
-        if self._closing:
+        # Ignore any new incoming metric if client in closing or disconnected state
+        if self.closing or self.disconnected:
             return
 
         sample_rate = sample_rate or self._sample_rate

aiodogstatsd/contrib/sanic.py

@@ -66,14 +66,14 @@ def middlewares_factory(
     collect_not_found: bool = False,
 ) -> Tuple[MiddlewareCallable, MiddlewareCallable]:
     async def middleware_request(request: Request) -> None:
-        request["_statsd_request_started_at"] = get_event_loop().time()
+        request.ctx._statsd_request_started_at = get_event_loop().time()
 
     async def middleware_response(request: Request, response: HTTPResponse) -> None:
         if _proceed_collecting(
             request, response, collect_not_allowed, collect_not_found
         ):
             request_duration = (
-                get_event_loop().time() - request["_statsd_request_started_at"]
+                get_event_loop().time() - request.ctx._statsd_request_started_at
             ) * 1000
             getattr(request.app, client_app_key).timing(
                 request_duration_metric_name,

aiodogstatsd/typedefs.py

@@ -2,6 +2,7 @@
 from typing import Mapping, Union
 
 __all__ = (
+    "CState",
     "MName",
     "MNamespace",
     "MType",
@@ -30,3 +31,10 @@ class MType(enum.Enum):
     GAUGE = "g"
     HISTOGRAM = "h"
     TIMING = "ms"
+
+
+@enum.unique
+class CState(enum.IntEnum):
+    CONNECTED = enum.auto()
+    CLOSING = enum.auto()
+    DISCONNECTED = enum.auto()

pyproject.toml

@@ -77,7 +77,7 @@ classifiers = [
 python = "^3.6"
 
 aiohttp = { version = ">=3.0.0", optional = true }
-sanic = { version = ">=19.3.0", optional = true }
+sanic = { version = ">=20.3.0", optional = true }
 starlette = { version = ">=0.13.0", optional = true }
 
 [tool.poetry.dev-dependencies]