Add logging to web

Author: zuczkows

livechat/agent/web/client.py

@@ -9,6 +9,7 @@
 import httpx
 
 from livechat.utils.helpers import prepare_payload
+from livechat.utils.httpx_logger import HttpxLogger
 
 
 # pylint: disable=R0903
@@ -50,9 +51,14 @@ class AgentWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
     def __init__(self, access_token: str, version: str, base_url: str,
                  http2: bool) -> AgentWebInterface:
+        logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/agent/action'
         self.session = httpx.Client(http2=http2,
-                                    headers={'Authorization': access_token})
+                                    headers={'Authorization': access_token},
+                                    event_hooks={
+                                        'request': [logger.log_request],
+                                        'response': [logger.log_response]
+                                    })
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/configuration/client.py

@@ -8,6 +8,7 @@
 import httpx
 
 from livechat.utils.helpers import prepare_payload
+from livechat.utils.httpx_logger import HttpxLogger
 
 
 class ConfigurationApi:
@@ -47,9 +48,14 @@ class ConfigurationApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
     def __init__(self, token: str, version: str, base_url: str,
                  http2: bool) -> ConfigurationApiInterface:
+        logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/configuration/action'
         self.session = httpx.Client(http2=http2,
-                                    headers={'Authorization': token})
+                                    headers={'Authorization': token},
+                                    event_hooks={
+                                        'request': [logger.log_request],
+                                        'response': [logger.log_response]
+                                    })
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/customer/web/client.py

@@ -9,6 +9,7 @@
 import httpx
 
 from livechat.utils.helpers import prepare_payload
+from livechat.utils.httpx_logger import HttpxLogger
 
 
 # pylint: disable=R0903
@@ -67,10 +68,16 @@ class CustomerWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
     def __init__(self, access_token: str, version: str, base_url: str,
                  http2: bool) -> CustomerWebInterface:
+        logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/customer/action'
         if all([access_token, isinstance(access_token, str)]):
             self.session = httpx.Client(
-                http2=http2, headers={'Authorization': access_token})
+                http2=http2,
+                headers={'Authorization': access_token},
+                event_hooks={
+                    'request': [logger.log_request],
+                    'response': [logger.log_response]
+                })
         else:
             raise ValueError(
                 'Incorrect or missing `access_token` argument (should be of type str.)'

livechat/reports/client.py

@@ -9,6 +9,7 @@
 import httpx
 
 from livechat.utils.helpers import prepare_payload
+from livechat.utils.httpx_logger import HttpxLogger
 
 
 class ReportsApi:
@@ -48,9 +49,14 @@ class ReportsApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
     def __init__(self, token: str, version: str, base_url: str,
                  http2: bool) -> ReportsApiInterface:
+        logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/reports'
         self.session = httpx.Client(http2=http2,
-                                    headers={'Authorization': token})
+                                    headers={'Authorization': token},
+                                    event_hooks={
+                                        'request': [logger.log_request],
+                                        'response': [logger.log_response]
+                                    })
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/utils/httpx_logger.py

@@ -0,0 +1,31 @@
+'''
+Logger for httpx requests.
+'''
+
+import json
+import logging
+from datetime import datetime
+
+
+class HttpxLogger:
+    ''' Logger for httpx requests. '''
+    def __init__(self):
+        logging.basicConfig()
+        self.logger = logging.getLogger()
+        self.logger.setLevel(logging.INFO)
+
+    def log_request(self, request):
+        ''' Log request details. '''
+        request_send_time = datetime.now().strftime('%Y-%m-%d, %H:%M:%S.%f')
+        self.logger.info(
+            f'\nREQUEST:\n {request.method} {request.url}\n SEND TIME: {request_send_time}\n PARAMS:\n {request.content.decode("utf-8")}'
+        )
+        self.logger.debug(f'\nHEADERS:\n {dict(request.headers.items())}')
+
+    def log_response(self, response):
+        ''' Log repsonse details. '''
+        request = response.request
+        response.read()
+        self.logger.info(
+            f'\nRESPONSE:\n {request.method} {request.url} - Status {response.status_code}\n Duration: {response.elapsed.total_seconds()} s \n {json.dumps(response.json(), indent=4)}'
+        )