7.2.0: slim down default request context (#121)

Author: bartes

CHANGELOG.rst

@@ -1,6 +1,14 @@
 master
 ------
 
+7.2.0 (2026-06-09)
+------------------
+
+Housekeeping:
+~~~~~~~~~~~~~
+-  slim down the default request context to ``headers``, ``ip``, and ``library``; the client id is carried by ``headers`` (the ``X-Castle-Client-Id`` header / ``__cid`` cookie) and resolved server-side
+-  remove the internal ``ClientIdExtract`` service and the unused ``cookies`` plumbing in ``ContextGetDefault`` / ``ContextPrepare``
+
 7.1.0 (2026-05-29)
 ------------------
 

castle/client_id/__init__.py

@@ -1,52 +1,26 @@
 from castle.version import VERSION
 from castle.headers.filter import HeadersFilter
-from castle.client_id.extract import ClientIdExtract
 from castle.headers.extract import HeadersExtract
 from castle.ips.extract import IPsExtract
 
 __version__ = VERSION
 
 
 class ContextGetDefault(object):
-    def __init__(self, request, cookies):
-        self.cookies = self._fetch_cookies(request, cookies)
+    def __init__(self, request):
         self.pre_headers = HeadersFilter(request).call()
 
     def call(self):
-        context = dict(
+        return dict(
             {
-                'client_id': self._client_id(),
-                'active': True,
                 'headers': self._headers(),
                 'ip': self._ip(),
                 'library': {'name': 'castle-python', 'version': __version__},
             }
         )
-        context.update(self._optional_defaults())
-
-        return context
 
     def _ip(self):
         return IPsExtract(self.pre_headers).call()
 
-    def _client_id(self):
-        return ClientIdExtract(self.pre_headers, self.cookies).call()
-
     def _headers(self):
         return HeadersExtract(self.pre_headers).call()
-
-    def _optional_defaults(self):
-        context = dict()
-        if 'Accept-Language' in self.pre_headers:
-            context['locale'] = self.pre_headers.get('Accept-Language')
-        if 'User-Agent' in self.pre_headers:
-            context['user_agent'] = self.pre_headers.get('User-Agent')
-        return context
-
-    @staticmethod
-    def _fetch_cookies(request, cookies):
-        if cookies:
-            return cookies
-        if hasattr(request, 'COOKIES') and request.COOKIES:
-            return request.COOKIES
-        return None

castle/client_id/extract.py

@@ -7,5 +7,5 @@ class ContextPrepare(object):
     def call(request, options=None):
         if options is None:
             options = {}
-        default_context = ContextGetDefault(request, options.get('cookies')).call()
+        default_context = ContextGetDefault(request).call()
         return ContextMerge.call(default_context, options.get('context', {}))

castle/context/get_default.py

@@ -6,7 +6,6 @@
 
 TEST_MODULES = [
     'castle.test.api_request_test',
-    'castle.test.client_id.extract_test',
     'castle.test.client_test',
     'castle.test.command_test',
     'castle.test.commands.filter_test',

castle/context/prepare.py

@@ -30,16 +30,13 @@ def tearDown(self):
 
     def test_init(self):
         context = {
-            'active': True,
-            'client_id': '1234',
             'headers': {
                 'User-Agent': 'test',
                 'X-Forwarded-For': '217.144.192.112',
                 'X-Castle-Client-Id': '1234',
             },
             'ip': '217.144.192.112',
             'library': {'name': 'castle-python', 'version': VERSION},
-            'user_agent': 'test',
         }
         client = Client.from_request(request(), {})
         self.assertEqual(client.do_not_track, False)

castle/test/__init__.py

@@ -4,22 +4,14 @@
 from castle.context.get_default import ContextGetDefault
 
 
-def client_id():
-    return 'abcd'
-
-
-def cookies():
-    return {'__cid': client_id()}
-
-
 def request_ip():
     return '5.5.5.5'
 
 
 def environ():
     return {
         'HTTP_X_FORWARDED_FOR': request_ip(),
-        'HTTP_COOKIE': "__cid={client_id()};other=efgh",
+        'HTTP_COOKIE': "__cid=abcd;other=efgh",
         'HTTP-Accept-Language': 'en',
         'HTTP-User-Agent': 'test',
     }
@@ -34,9 +26,7 @@ def request(env):
 
 class ContextGetDefaultTestCase(unittest.TestCase):
     def test_default_context(self):
-        context = ContextGetDefault(request(environ()), cookies()).call()
-        self.assertEqual(context['client_id'], client_id())
-        self.assertEqual(context['active'], True)
+        context = ContextGetDefault(request(environ())).call()
         self.assertEqual(
             context['headers'],
             {
@@ -48,4 +38,6 @@ def test_default_context(self):
         )
         self.assertEqual(context['ip'], request_ip())
         self.assertDictEqual(context['library'], {'name': 'castle-python', 'version': __version__})
-        self.assertEqual(context['user_agent'], 'test')
+        self.assertNotIn('client_id', context)
+        self.assertNotIn('active', context)
+        self.assertNotIn('user_agent', context)

castle/test/client_id/extract_test.py

@@ -19,22 +19,13 @@ def request():
 class ContextPrepareTestCase(unittest.TestCase):
     def test_call(self):
         context = {
-            'active': True,
-            'client_id': '1234',
             'headers': {
                 'User-Agent': 'test',
                 'X-Forwarded-For': '217.144.192.112',
                 'X-Castle-Client-Id': '1234',
             },
             'ip': '217.144.192.112',
             'library': {'name': 'castle-python', 'version': VERSION},
-            'user_agent': 'test',
         }
         result_context = ContextPrepare.call(request(), {})
         self.assertEqual(result_context, context)
-
-    def test_setup_client_id_from_cookies(self):
-        cookies = {'__cid': '1234'}
-        options = {'cookies': cookies}
-        result_context = ContextPrepare.call(request(), options)
-        self.assertEqual(result_context['client_id'], '1234')