aiohttp: Add patch function which adds sentry handler

This patch function automatically sends events to Sentry if
Sentry SDK client is installed and if either Sunset header,
sunset Link relation type or Deprecation-Usage header are
present in the response.

- Fix #10

kw/platform/aiohttp/__init__.py

@@ -10,17 +10,24 @@
 
 required_module = "aiohttp"
 if ensure_module_is_available(required_module):
-    from . import utils
+    from . import utils, monkey
     from .middlewares import user_agent_middleware
-    from .monkey import construct_user_agent, patch, patch_with_user_agent
+    from .monkey import (
+        construct_user_agent,
+        patch,
+        patch_with_sentry,
+        patch_with_user_agent,
+    )
     from .session import KiwiClientSession
 
     __all__ = [
-        "user_agent_middleware",
-        "KiwiClientSession",
         "construct_user_agent",
-        "patch_with_user_agent",
         "patch",
+        "patch_with_sentry",
+        "patch_with_user_agent",
+        "monkey",
+        "user_agent_middleware",
+        "KiwiClientSession",
         "utils",
     ]
 else:

kw/platform/aiohttp/monkey.py

@@ -7,7 +7,20 @@
 import wrapt
 
 from .. import wrappers
-from ..utils import construct_user_agent
+from ..utils import construct_user_agent, report_to_sentry
+
+
+def _add_sentry_handler(sunset_header=True, deprecated_usage_header=True):
+    async def _check_headers(func, instance, args, kwargs):
+        response = await func(*args, **kwargs)
+        report_to_sentry(
+            response,
+            sunset_header=sunset_header,
+            deprecated_usage_header=deprecated_usage_header,
+        )
+        return response
+
+    return _check_headers
 
 
 def patch_with_user_agent(user_agent=None):
@@ -28,17 +41,46 @@ def patch_with_user_agent(user_agent=None):
     )
 
 
+def patch_with_sentry(sunset_header=True, deprecated_usage_header=True):
+    """Patch :meth:`aiohttp.ClientSession._request` to create events in Sentry.
+
+    If the HTTP response contains, for example, the ``Sunset`` HTTP header,
+    an event is sent to Sentry containing details about the sunset.
+
+    .. info::
+
+        The patch takes effect only if
+        `Sentry SDK <https://github.com/getsentry/sentry-python>`_ is installed
+        and properly configured.
+
+    :param sunset_header: (optional) Whether to report the presence of the ``Sunset``
+        header, :obj:`True` by default.
+    :param deprecated_usage_header: (optional) Whether to report the presence of the
+        ``Deprecated-Usage`` header, :obj:`True` by default.
+    """
+    wrapt.wrap_function_wrapper(
+        "aiohttp",
+        "ClientSession._request",
+        _add_sentry_handler(
+            sunset_header=sunset_header, deprecated_usage_header=deprecated_usage_header
+        ),
+    )
+
+
 def patch():
     """Apply all patches for :mod:`aiohttp` module.
 
     This will automatically apply:
 
     * :func:`kw.platform.aiohttp.patch.patch_with_user_agent`
+    * :func:`kw.platform.aiohttp.patch.patch_with_sentry`
     """
     if getattr(aiohttp, "__kiwi_platform_patch", False):
         # Already patched, skip
         return
+
     patch_with_user_agent()
+    patch_with_sentry()
 
     # Mark module as patched
     setattr(aiohttp, "__kiwi_platform_patch", True)

kw/platform/aiohttp/session.py

@@ -7,7 +7,7 @@
 
 import aiohttp
 
-from ..utils import add_user_agent_header, construct_user_agent
+from ..utils import add_user_agent_header, construct_user_agent, report_to_sentry
 
 
 with warnings.catch_warnings():
@@ -22,12 +22,13 @@ class KiwiClientSession(aiohttp.ClientSession):
 
             from kw.platform.aiohttp import KiwiClientSession
 
-            async with KiwiClientSession() as c:
-                await c.get('https://kiwi.com')
+            async with KiwiClientSession() as client:
+                await client.get('https://kiwi.com')
         """
 
         async def _request(self, *args, **kwargs):
             headers = kwargs.setdefault("headers", {})
             add_user_agent_header(headers, construct_user_agent)
             response = await super()._request(*args, **kwargs)
+            report_to_sentry(response, sunset_header=True, deprecated_usage_header=True)
             return response

kw/platform/utils.py

@@ -120,6 +120,9 @@ def report_to_sentry(response, sunset_header=True, deprecated_usage_header=True)
 
     - ``Sunset`` or ``sunset`` relation type in ``Link`` header
     - ``Deprecated-Usage``
+
+    :param sunset_header: Whether to report the ``Sunset`` header.
+    :param deprecated_usage_header: Whether to report the ``Deprecated-Usage`` header.
     """
     if sunset_header:
         sunset_warning = ""

pyproject.toml

@@ -58,6 +58,7 @@ wrapt = "^1.11"
 requests = "^2.22"
 httpretty = "^0.9.6"
 pytest-mock = "^1.10"
+aioresponses = {version = "^0.6.0",python = "^3.5"}
 
 [tool.poetry.extras]
 docs = ["sphinx"]