Integrated logger directly into HttpAdapter.

Author: todofixthis

examples/shell.py

@@ -7,7 +7,7 @@
 
 from argparse import ArgumentParser
 from getpass import getpass as secure_input
-from logging import INFO, basicConfig, getLogger
+from logging import DEBUG, basicConfig, getLogger
 from sys import argv, stderr
 
 from six import text_type
@@ -18,10 +18,10 @@
 
 from iota import __version__
 from iota.adapter import resolve_adapter
-from iota.adapter.wrappers import LogWrapper, RoutingWrapper
+from iota.adapter.wrappers import RoutingWrapper
 
 
-basicConfig(level=INFO, stream=stderr)
+basicConfig(level=DEBUG, stream=stderr)
 
 
 def main(uri, testnet, pow_uri, debug_requests):
@@ -47,7 +47,9 @@ def main(uri, testnet, pow_uri, debug_requests):
 
   # If ``debug_requests`` is specified, log HTTP requests/responses.
   if debug_requests:
-    adapter_ = LogWrapper(adapter_, getLogger(__name__), INFO)
+    logger = getLogger(__name__)
+    logger.setLevel(DEBUG)
+    adapter_.set_logger(logger)
 
   iota = Iota(adapter_, seed=seed, testnet=testnet)
 

src/iota/adapter/__init__.py

@@ -6,6 +6,7 @@
 from abc import ABCMeta, abstractmethod as abstract_method
 from collections import deque
 from inspect import isabstract as is_abstract
+from logging import DEBUG, Logger
 from socket import getdefaulttimeout as get_default_timeout
 from typing import Container, Dict, List, Optional, Text, Tuple, Union
 
@@ -136,6 +137,12 @@ class BaseAdapter(with_metaclass(AdapterMeta)):
   Protocols that ``resolve_adapter`` can use to identify this adapter
   type.
   """
+
+  def __init__(self):
+    super(BaseAdapter, self).__init__()
+
+    self._logger = None # type: Logger
+
   @abstract_method
   def send_request(self, payload, **kwargs):
     # type: (dict, dict) -> dict
@@ -159,6 +166,24 @@ def send_request(self, payload, **kwargs):
       'Not implemented in {cls}.'.format(cls=type(self).__name__),
     )
 
+  def set_logger(self, logger):
+    # type: (Logger) -> BaseAdapter
+    """
+    Attaches a logger instance to the adapter.
+    The adapter will send information about API requests/responses to
+    the logger.
+    """
+    self._logger = logger
+    return self
+
+  def _log(self, level, message, context=None):
+    # type: (int, Text, Optional[dict]) -> None
+    """
+    Sends a message to the instance's logger, if configured.
+    """
+    if self._logger:
+      self._logger.log(level, message, extra={'context': context or {}})
+
 
 class HttpAdapter(BaseAdapter):
   """
@@ -225,6 +250,9 @@ def node_url(self):
 
   def send_request(self, payload, **kwargs):
     # type: (dict, dict) -> dict
+    kwargs.setdefault('headers', {})
+    kwargs['headers']['Content-type'] = 'application/json'
+
     response = self._send_http_request(
       # Use a custom JSON encoder that knows how to convert Tryte values.
       payload = JsonEncoder().encode(payload),
@@ -235,8 +263,7 @@ def send_request(self, payload, **kwargs):
 
     return self._interpret_response(response, payload, {codes['ok']})
 
-  @staticmethod
-  def _send_http_request(url, payload, method='post', **kwargs):
+  def _send_http_request(self, url, payload, method='post', **kwargs):
     # type: (Text, Optional[Text], Text, dict) -> Response
     """
     Sends the actual HTTP request.
@@ -245,7 +272,47 @@ def _send_http_request(url, payload, method='post', **kwargs):
     tests.
     """
     kwargs.setdefault('timeout', get_default_timeout())
-    return request(method=method, url=url, data=payload, **kwargs)
+
+    self._log(
+      level = DEBUG,
+
+      message = 'Sending {method} to {url}: {payload!r}'.format(
+        method  = method,
+        payload = payload,
+        url     = url,
+      ),
+
+      context = {
+        'request_method':   method,
+        'request_kwargs':   kwargs,
+        'request_payload':  payload,
+        'request_url':      url,
+      },
+    )
+
+    response = request(method=method, url=url, data=payload, **kwargs)
+
+    self._log(
+      level = DEBUG,
+
+      message = 'Receiving {method} from {url}: {response!r}'.format(
+        method    = method,
+        response  = response.content,
+        url       = url,
+      ),
+
+      context = {
+        'request_method':   method,
+        'request_kwargs':   kwargs,
+        'request_payload':  payload,
+        'request_url':      url,
+
+        'response_headers': response.headers,
+        'response_content': response.content,
+      },
+    )
+
+    return response
 
   def _interpret_response(self, response, payload, expected_status):
     # type: (Response, dict, Container[int]) -> dict

src/iota/adapter/wrappers.py

@@ -3,15 +3,12 @@
   unicode_literals
 
 from abc import ABCMeta, abstractmethod as abstract_method
-from logging import INFO, Logger
 from typing import Dict, Text
 
-from six import with_metaclass
-
 from iota.adapter import AdapterSpec, BaseAdapter, resolve_adapter
+from six import with_metaclass
 
 __all__ = [
-  'LogWrapper',
   'RoutingWrapper',
 ]
 
@@ -38,41 +35,6 @@ def send_request(self, payload, **kwargs):
     )
 
 
-class LogWrapper(BaseWrapper):
-  """
-  Wrapper that sends all adapter requests and responses to a logger.
-
-  To use it, "wrap" the real adapter instance/spec::
-
-     logger = getLogger('...')
-     api    = Iota(LogWrapper('http://localhost:14265', logger))
-  """
-  def __init__(self, adapter, logger, level=INFO):
-    # type: (AdapterSpec, Logger, int) -> None
-    super(LogWrapper, self).__init__(adapter)
-
-    self.logger   = logger
-    self.level    = level
-
-  def send_request(self, payload, **kwargs):
-    # type: (dict, dict) -> dict
-    command = payload.get('command') or 'command'
-
-    self.logger.log(self.level, 'Sending {command}: {request!r}'.format(
-      command = command,
-      request = payload,
-    ))
-
-    response = self.adapter.send_request(payload, **kwargs)
-
-    self.logger.log(self.level, 'Receiving {command}: {response!r}'.format(
-      command   = command,
-      response  = response,
-    ))
-
-    return response
-
-
 class RoutingWrapper(BaseWrapper):
   """
   Routes commands to different nodes.

test/adapter/sandbox_test.py

@@ -42,7 +42,8 @@ def test_regular_command(self):
 
       # Auth token automatically added to the HTTP request.
       headers = {
-        'Authorization': 'token ACCESS-TOKEN',
+        'Authorization':  'token ACCESS-TOKEN',
+        'Content-type':   'application/json',
       },
     )
 
@@ -229,10 +230,11 @@ def test_regular_command_null_token(self):
       payload = json.dumps(payload),
       url     = adapter.node_url,
 
-      # No auth token, so no Authorization header.
-      # headers = {
-      #   'Authorization': 'token ACCESS-TOKEN',
-      # },
+      headers = {
+        # No auth token, so no Authorization header.
+        # 'Authorization':  'token ACCESS-TOKEN',
+        'Content-type':   'application/json',
+      },
     )
 
   def test_error_non_200_response(self):

test/adapter_test.py

@@ -26,14 +26,14 @@ def test_adapter_instance(self):
 
   def test_http(self):
     """
-    Resolving a valid `http://` URI.
+    Resolving a valid ``http://`` URI.
     """
     adapter = resolve_adapter('http://localhost:14265/')
     self.assertIsInstance(adapter, HttpAdapter)
 
   def test_https(self):
     """
-    Resolving a valid `https://` URI.
+    Resolving a valid ``https://`` URI.
     """
     adapter = resolve_adapter('https://localhost:14265/')
     self.assertIsInstance(adapter, HttpAdapter)
@@ -73,7 +73,7 @@ def create_http_response(content, status=200):
 class HttpAdapterTestCase(TestCase):
   def test_http(self):
     """
-    Configuring HttpAdapter using a valid http:// URI.
+    Configuring HttpAdapter using a valid ``http://`` URI.
     """
     uri     = 'http://localhost:14265/'
     adapter = HttpAdapter(uri)
@@ -82,7 +82,7 @@ def test_http(self):
 
   def test_https(self):
     """
-    Configuring HttpAdapter using a valid https:// URI.
+    Configuring HttpAdapter using a valid ``https://`` URI.
     """
     uri     = 'https://localhost:14265/'
     adapter = HttpAdapter(uri)
@@ -338,4 +338,8 @@ def test_trytes_in_request():
           'CCPCBDVC9DTCEAKDXC9D9DEARCWCPCBDVCTCEAHDWCTCEAKDCDFD9DSCSA',
         ],
       }),
+
+      headers = {
+        'Content-type': 'application/json',
+      },
     )