uhttp-workers 1.6.0__tar.gz → 1.7.0__tar.gz

{uhttp_workers-1.6.0/uhttp_workers.egg-info → uhttp_workers-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uhttp-workers
-Version: 1.6.0
+Version: 1.7.0
 Summary: Multi-process worker dispatcher built on uhttp-server
 Author-email: Pavel Revak <pavelrevak@gmail.com>
 License-Expression: MIT
@@ -277,15 +277,18 @@ Workers send heartbeats automatically via the shared response queue. When a work
 ```python
 @_workers.api('/process/{id:int}', 'POST')
 def process(self, request):
-    # request.request_id  — internal ID for dispatcher pairing
-    # request.method       — 'POST'
-    # request.path         — '/process/42'
-    # request.path_params  — {'id': 42}
-    # request.query        — {'page': '1'} or None
-    # request.data         — dict (JSON), bytes (binary), or None
-    # request.headers      — dict
-    # request.cookies      — dict (lazy-parsed from Cookie header)
-    # request.content_type — 'application/json'
+    # request.request_id     — internal ID for dispatcher pairing
+    # request.method          — 'POST'
+    # request.path            — '/process/42'
+    # request.path_params     — {'id': 42}
+    # request.query           — {'page': '1'} or None
+    # request.data            — dict (JSON), bytes (binary), or None
+    # request.headers         — dict
+    # request.cookies         — dict (lazy-parsed from Cookie header)
+    # request.content_type    — 'application/json'
+    # request.remote_address  — 'host:port' string (honors X-Forwarded-For
+    #                            from trusted proxies; configured on the
+    #                            HTTP server side)
 
     # return data (status 200)
     return {'result': 'ok'}

{uhttp_workers-1.6.0 → uhttp_workers-1.7.0}/README.md

@@ -263,15 +263,18 @@ Workers send heartbeats automatically via the shared response queue. When a work
 ```python
 @_workers.api('/process/{id:int}', 'POST')
 def process(self, request):
-    # request.request_id  — internal ID for dispatcher pairing
-    # request.method       — 'POST'
-    # request.path         — '/process/42'
-    # request.path_params  — {'id': 42}
-    # request.query        — {'page': '1'} or None
-    # request.data         — dict (JSON), bytes (binary), or None
-    # request.headers      — dict
-    # request.cookies      — dict (lazy-parsed from Cookie header)
-    # request.content_type — 'application/json'
+    # request.request_id     — internal ID for dispatcher pairing
+    # request.method          — 'POST'
+    # request.path            — '/process/42'
+    # request.path_params     — {'id': 42}
+    # request.query           — {'page': '1'} or None
+    # request.data            — dict (JSON), bytes (binary), or None
+    # request.headers         — dict
+    # request.cookies         — dict (lazy-parsed from Cookie header)
+    # request.content_type    — 'application/json'
+    # request.remote_address  — 'host:port' string (honors X-Forwarded-For
+    #                            from trusted proxies; configured on the
+    #                            HTTP server side)
 
     # return data (status 200)
     return {'result': 'ok'}

{uhttp_workers-1.6.0 → uhttp_workers-1.7.0}/tests/test_dispatcher.py

@@ -30,7 +30,7 @@ class MockClient:
 
     def __init__(self, method='GET', path='/', query=None, data=None,
             headers=None, content_type=None, body=None,
-            address='127.0.0.1'):
+            remote_address='127.0.0.1:0'):
         self.method = method
         self.path = path
         self.query = query
@@ -38,7 +38,7 @@ class MockClient:
         self.headers = headers or {}
         self.content_type = content_type
         self.body = body
-        self.address = address
+        self.remote_address = remote_address
         self.responded = False
         self.response_data = None
         self.response_status = None
@@ -364,6 +364,26 @@ class TestDispatcherPoolRouting(unittest.TestCase):
         self.assertEqual(
             client.response_data['error'], 'No workers available')
 
+    def test_dispatch_forwards_remote_address(self):
+        """Request enqueued to worker carries client.remote_address."""
+        # fake an alive worker so dispatch reaches enqueue
+        self.pool_default.workers = [
+            type('W', (), {'is_alive': lambda self: True})()]
+        d = Dispatcher.__new__(Dispatcher)
+        d._sync_routes = []
+        d._static_routes = {}
+        d._pools = [self.pool_default]
+        d._pending = {}
+        d._max_pending = 1000
+        d._next_request_id = 0
+
+        client = MockClient(
+            'GET', '/test', remote_address='198.51.100.7:33421')
+        d._dispatch_to_pool(client)
+        # request was enqueued
+        req = self.pool_default.request_queue.get(timeout=1)
+        self.assertEqual(req.remote_address, '198.51.100.7:33421')
+
 
 class TestDispatcherProcessResponse(unittest.TestCase):
 
@@ -851,7 +871,8 @@ class TestDispatcherWorkerDied(unittest.TestCase):
 
         d, pool = self._make_dispatcher(RecordingDispatcher)
         client = MockClient(
-            'POST', '/api/scan', body=b'\x00\x01bad', address='10.0.0.7')
+            'POST', '/api/scan', body=b'\x00\x01bad',
+            remote_address='10.0.0.7:42')
         pending = _PendingRequest(client, pool)
         pending.worker_id = 0
         d._pending[42] = pending
@@ -869,9 +890,9 @@ class TestDispatcherWorkerDied(unittest.TestCase):
 
     def test_multiple_victims_all_handled(self):
         d, pool = self._make_dispatcher()
-        c1 = MockClient('GET', '/api/a', address='1.1.1.1')
-        c2 = MockClient('GET', '/api/b', address='2.2.2.2')
-        c3 = MockClient('GET', '/api/c', address='3.3.3.3')
+        c1 = MockClient('GET', '/api/a', remote_address='1.1.1.1:42')
+        c2 = MockClient('GET', '/api/b', remote_address='2.2.2.2:42')
+        c3 = MockClient('GET', '/api/c', remote_address='3.3.3.3:42')
         for rid, c in [(1, c1), (2, c2), (3, c3)]:
             p = _PendingRequest(c, pool)
             p.worker_id = 0
@@ -978,7 +999,7 @@ class TestDispatcherWorkerDied(unittest.TestCase):
                 for rid, pending in victims:
                     captured.append({
                         'rid': rid,
-                        'address': pending.client.address,
+                        'remote_address': pending.client.remote_address,
                         'body': pending.client.body,
                         'reason': reason,
                         'exitcode': exitcode})
@@ -988,14 +1009,14 @@ class TestDispatcherWorkerDied(unittest.TestCase):
         d, pool = self._make_dispatcher(ForensicDispatcher)
         client = MockClient(
             'POST', '/api/process',
-            body=b'\xff\xfecorrupted', address='9.9.9.9')
+            body=b'\xff\xfecorrupted', remote_address='9.9.9.9:42')
         pending = _PendingRequest(client, pool)
         pending.worker_id = 0
         d._pending[7] = pending
         pool._fake_restarted = [(0, 'died exit=-11', -11)]
         d._check_all_workers()
         self.assertEqual(len(captured), 1)
-        self.assertEqual(captured[0]['address'], '9.9.9.9')
+        self.assertEqual(captured[0]['remote_address'], '9.9.9.9:42')
         self.assertEqual(captured[0]['body'], b'\xff\xfecorrupted')
         self.assertEqual(captured[0]['exitcode'], -11)
         # super() still ran

{uhttp_workers-1.6.0 → uhttp_workers-1.7.0}/tests/test_request_response.py

@@ -18,6 +18,17 @@ class TestRequest(unittest.TestCase):
         self.assertEqual(req.headers, {})
         self.assertIsNone(req.content_type)
         self.assertEqual(req.path_params, {})
+        self.assertIsNone(req.remote_address)
+
+    def test_remote_address(self):
+        req = Request(1, 'GET', '/', remote_address='10.0.0.1:54321')
+        self.assertEqual(req.remote_address, '10.0.0.1:54321')
+
+    def test_pickle_remote_address(self):
+        req = Request(
+            1, 'GET', '/', remote_address='2001:db8::1:54321')
+        restored = pickle.loads(pickle.dumps(req))
+        self.assertEqual(restored.remote_address, '2001:db8::1:54321')
 
     def test_full_creation(self):
         req = Request(

{uhttp_workers-1.6.0 → uhttp_workers-1.7.0}/uhttp/workers.py

@@ -215,16 +215,22 @@ class Request:
         headers: Request headers dict.
         content_type: Content-Type header value, or None.
         path_params: Path parameters filled by worker router.
+        remote_address: Client address as "host:port" string. Honors
+            X-Forwarded-For when the connection comes from a trusted
+            proxy (uhttp-server's trusted_proxies setting). None if the
+            dispatcher could not resolve the address (e.g., in tests).
     """
 
     __slots__ = (
         'request_id', 'method', 'path', 'query',
         'data', 'headers', 'content_type', 'path_params',
+        'remote_address',
         '_cookies', '_response_queue')
 
     def __init__(
             self, request_id, method, path, query=None,
-            data=None, headers=None, content_type=None):
+            data=None, headers=None, content_type=None,
+            remote_address=None):
         self.request_id = request_id
         self.method = method
         self.path = path
@@ -233,6 +239,7 @@ class Request:
         self.headers = headers or {}
         self.content_type = content_type
         self.path_params = {}
+        self.remote_address = remote_address
         self._cookies = None
         self._response_queue = None
 
@@ -1235,7 +1242,8 @@ class Dispatcher:
             query=client.query,
             data=client.data,
             headers=dict(client.headers),
-            content_type=client.content_type))
+            content_type=client.content_type,
+            remote_address=client.remote_address))
 
     def _http_request(self, client):
         """Process incoming HTTP request."""
@@ -1453,7 +1461,7 @@ class Dispatcher:
             body_len = len(c.body) if c.body is not None else 0
             self.on_log(
                 pool.name, LOG_ERROR,
-                f"  victim rid={request_id} from={c.address} "
+                f"  victim rid={request_id} from={c.remote_address} "
                 f"{c.method} {c.path} body={body_len}B")
             del self._pending[request_id]
             if pending.streaming:

{uhttp_workers-1.6.0 → uhttp_workers-1.7.0/uhttp_workers.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uhttp-workers
-Version: 1.6.0
+Version: 1.7.0
 Summary: Multi-process worker dispatcher built on uhttp-server
 Author-email: Pavel Revak <pavelrevak@gmail.com>
 License-Expression: MIT
@@ -277,15 +277,18 @@ Workers send heartbeats automatically via the shared response queue. When a work
 ```python
 @_workers.api('/process/{id:int}', 'POST')
 def process(self, request):
-    # request.request_id  — internal ID for dispatcher pairing
-    # request.method       — 'POST'
-    # request.path         — '/process/42'
-    # request.path_params  — {'id': 42}
-    # request.query        — {'page': '1'} or None
-    # request.data         — dict (JSON), bytes (binary), or None
-    # request.headers      — dict
-    # request.cookies      — dict (lazy-parsed from Cookie header)
-    # request.content_type — 'application/json'
+    # request.request_id     — internal ID for dispatcher pairing
+    # request.method          — 'POST'
+    # request.path            — '/process/42'
+    # request.path_params     — {'id': 42}
+    # request.query           — {'page': '1'} or None
+    # request.data            — dict (JSON), bytes (binary), or None
+    # request.headers         — dict
+    # request.cookies         — dict (lazy-parsed from Cookie header)
+    # request.content_type    — 'application/json'
+    # request.remote_address  — 'host:port' string (honors X-Forwarded-For
+    #                            from trusted proxies; configured on the
+    #                            HTTP server side)
 
     # return data (status 200)
     return {'result': 'ok'}