adds raw cookie parser

Author: David Erb

src/dls_servbase_api/aiohttp_client.py

@@ -93,7 +93,12 @@ async def client_get_info(self):
             return await response.json()
 
     # ----------------------------------------------------------------------------------------
-    async def client_protocolj(self, request_object, cookies=None):
+    async def client_protocolj(
+        self,
+        request_object,
+        cookies=None,
+        headers=None,
+    ):
         """"""
         await self._establish_client_session()
 
@@ -104,6 +109,7 @@ async def client_protocolj(self, request_object, cookies=None):
                 f"{self.__client_netloc}/protocolj",
                 json=request_object,
                 cookies=cookies,
+                headers=headers,
             ) as response:
                 if response.status == 200:
                     response_json = await response.json()

src/dls_servbase_lib/base_aiohttp.py

@@ -17,6 +17,7 @@
 from dls_mainiac_lib.mainiac import Mainiac
 from dls_multiconf_lib.multiconfs import multiconfs_get_default, multiconfs_has_default
 from dls_utilpack.callsign import callsign
+from dls_utilpack.describe import describe
 from dls_utilpack.explain import explain
 from dls_utilpack.global_signals import global_sigint
 from dls_utilpack.modify_process_title import modify_process_title
@@ -25,6 +26,7 @@
 
 from dls_servbase_api.aiohttp_client import AiohttpClient  # noqa: I001
 from dls_servbase_api.constants import Keywords  # noqa: I001
+from dls_servbase_lib.cookies.cookie_parser import CookieParser
 from dls_servbase_lib.cookies.cookies import Cookies
 
 logger = logging.getLogger(__name__)
@@ -507,11 +509,30 @@ async def register_cookies(self, opaque, web_request, cookie_names):
 
         logger.debug(f"[COOKOFF] registering cookies {cookie_names}")
 
+        # We have to parse the Cookie header ourselves from the raw
+        # since web_request.cookies uses SimpleCookie which doesn't work for
+        # Chrome's ill-formed: CookieControl={"necessaryCookies":[]
+        raw_header_cookie = web_request.headers.get("Cookie")
+        parsed_cookies = CookieParser().parse_raw(raw_header_cookie)
+        logger.debug(describe("[COOKOFF] parsed_cookies are", parsed_cookies))
+
+        # from http import cookies
+
+        # http_cookies = cookies.SimpleCookie()
+        # http_cookies.load(web_request.headers["Cookie"])
+        # logger.debug(
+        #     describe(
+        #         "[COOKOFF] http_cookies keys",
+        #         list(http_cookies.keys()),
+        #     )
+        # )
+
         # The caller gives the list of cookies that are interesting.
         for cookie_name in cookie_names:
             # We have a uuid for this cookie name already?
-            if cookie_name in web_request.cookies:
-                _uuid = web_request.cookies[cookie_name]
+            _uuid = parsed_cookies.get(cookie_name)
+
+            if _uuid is not None:
                 logger.debug(
                     f"[COOKOFF] registering cookie {cookie_name} from existing uuid {_uuid}"
                 )
@@ -731,10 +752,17 @@ def client_url(self):
         return self.__callsign_url
 
     # ----------------------------------------------------------------------------------------
-    async def client_protocolj(self, request_object, cookies=None):
+    async def client_protocolj(
+        self,
+        request_object,
+        cookies=None,
+        headers=None,
+    ):
         """"""
         return await self.__aiohttp_client.client_protocolj(
-            request_object, cookies=cookies
+            request_object,
+            cookies=cookies,
+            headers=headers,
         )
 
     # ----------------------------------------------------------------------------------------

src/dls_servbase_lib/cookies/cookie_parser.py

@@ -0,0 +1,40 @@
+import logging
+from http import cookies
+from typing import Dict, Optional
+
+logger = logging.getLogger(__name__)
+
+
+class CookieParser:
+
+    # ----------------------------------------------------------------------------------------
+    def parse_raw(self, raw: Optional[str]) -> Dict:
+        """ """
+
+        cookie_dict = {}
+        if raw is not None:
+            items = raw.split(";")
+
+            for item in items:
+                parts = item.split("=", 1)
+
+                if len(parts) == 2:
+                    cookie_dict[parts[0].strip()] = parts[1].strip()
+
+        return cookie_dict
+
+    # ----------------------------------------------------------------------------------------
+    def __parse_raw_WITH_HTTP_COOKIES(self, raw: str) -> Dict:
+        """
+        This doesn't work when raw is like: 'Something="{something}"; X=Y;'
+        """
+
+        http_cookies: cookies.SimpleCookie = cookies.SimpleCookie()
+
+        http_cookies.load(raw)
+
+        cookie_dict = {}
+        for key, morsel in http_cookies.items():
+            cookie_dict[key] = morsel.value
+
+        return cookie_dict

src/dls_servbase_lib/guis/constants.py

@@ -10,4 +10,4 @@ class Commands:
 
 
 class Cookies:
-    TABS_MANAGER = "dls_servbase_guis::cookies::tabs_manager"
+    TABS_MANAGER = "DLS_SERVBASE_TABS_MANAGER"

tests/configurations/sqlite.yaml

@@ -5,7 +5,7 @@ logging_settings:
         enabled: True
         verbose: True
         filters:
-            markers:
+            Xmarkers:
                 - "[RELCOOK]"
                 - "[COOKSEL]"
                 - "[COOKOFF]"

tests/conftest.py

@@ -43,7 +43,7 @@ def logging_setup():
     logging.getLogger("dls_servbase_lib.things").setLevel("INFO")
 
     # Messages about starting and stopping services.
-    logging.getLogger("dls_servbase_lib.base_aiohttp").setLevel("INFO")
+    # logging.getLogger("dls_servbase_lib.base_aiohttp").setLevel("INFO")
 
     # All dls_servbase database sql commands.
     # logging.getLogger("dls_servbase_lib.databases.aiosqlite").setLevel("INFO")

tests/test_gui.py

@@ -71,6 +71,7 @@ async def _main_coroutine(self, constants, output_directory):
                 ProtocoljKeywords.ENABLE_COOKIES: [Cookies.TABS_MANAGER],
             }
 
+            logger.debug("---------------------- making request 1 --------------------")
             response = await dls_servbase_guis_get_default().client_protocolj(
                 load_tabs_request, cookies={}
             )
@@ -84,8 +85,8 @@ async def _main_coroutine(self, constants, output_directory):
             cookies = response["__cookies"]
             assert Cookies.TABS_MANAGER in cookies
 
-            # Use the cookie name in the next requests.
-            cookie_uuid = cookies[Cookies.TABS_MANAGER]
+            # Use the tabs manager cookie value in the next requests.
+            cookie_uuid = cookies[Cookies.TABS_MANAGER].value
 
             # --------------------------------------------------------------------
             # Select a tab.
@@ -97,15 +98,22 @@ async def _main_coroutine(self, constants, output_directory):
                 Keywords.TAB_ID: "123",
             }
 
+            logger.debug("---------------------- making request 2 --------------------")
             response = await dls_servbase_guis_get_default().client_protocolj(
                 select_tab_request, cookies={Cookies.TABS_MANAGER: cookie_uuid}
             )
 
             # --------------------------------------------------------------------
             # Load tabs again, this time we should get the saved tab_id.
 
+            logger.debug("---------------------- making request 3 --------------------")
+            # Put a deliberately funky cookie string into the header.
+            raw_cookie_header = (
+                'BadCookie={"something"}; ' + f"{Cookies.TABS_MANAGER} = {cookie_uuid};"
+            )
             response = await dls_servbase_guis_get_default().client_protocolj(
-                load_tabs_request, cookies={Cookies.TABS_MANAGER: cookie_uuid}
+                load_tabs_request,
+                headers={"Cookie": raw_cookie_header},
             )
 
             logger.debug(describe("second load_tabs response", response))
@@ -122,16 +130,34 @@ async def _main_coroutine(self, constants, output_directory):
                 Keywords.TAB_ID: "456",
             }
 
+            logger.debug("---------------------- making request 4 --------------------")
             response = await dls_servbase_guis_get_default().client_protocolj(
-                select_tab_request, cookies={Cookies.TABS_MANAGER: cookie_uuid}
+                select_tab_request,
+                cookies={Cookies.TABS_MANAGER: cookie_uuid},
+            )
+
+            # --------------------------------------------------------------------
+            # Load tabs again, this time we should get the updated tab_id.
+
+            logger.debug("---------------------- making request 5 --------------------")
+            response = await dls_servbase_guis_get_default().client_protocolj(
+                load_tabs_request,
+                cookies={Cookies.TABS_MANAGER: cookie_uuid},
             )
 
+            logger.debug(describe("third load_tabs response", response))
+            assert Keywords.TAB_ID in response
+            assert response[Keywords.TAB_ID] == "456"
+
             # --------------------------------------------------------------------
             # Write a text file and fetch it through the http server.
             filename = "test.html"
             contents = "some test html"
             with open(f"{output_directory}/{filename}", "wt") as file:
                 file.write(contents)
+            logger.debug(
+                "---------------------- making request 6 (html file) --------------------"
+            )
             text = await dls_servbase_guis_get_default().client_get_file(filename)
             # assert text == contents
 

tests/test_parse_cookie.py

@@ -0,0 +1,30 @@
+import logging
+
+# Utilities.
+from dls_utilpack.describe import describe
+
+from dls_servbase_lib.cookies.cookie_parser import CookieParser
+
+logger = logging.getLogger(__name__)
+
+
+class TestParseCookie:
+    """
+    Test parsing a raw cookie value.
+    """
+
+    # ----------------------------------------------------------------------------------------
+    def test(
+        self,
+        constants,
+        logging_setup,
+        output_directory,
+    ):
+        """ """
+
+        part1 = 'CookieControl={"necessaryCookies":[],"optionalCookies":{"analytics":"accepted"},"statement":{"shown":true,"updated":"20/02/2019"},"consentDate":1684481396049,"consentExpiry":90,"interactedWith":true,"user":"6621E582-416C-4069-9604-A9A9C1EC3D1C"};'
+        part2 = "_ga=GA1.3.145778769.1684481396; BXFLOW_RECENT_JOBS_UX=1975b4df-8d91-4e09-ab26-3f47aabe984d; BXFLOW_JOB_SUBMIT_UX=775a8760-7a81-4f2d-824c-067b89bf4561; BXFLOW_JOB_NEWS_UX=37bdfb1b-ceba-43e8-b108-9fb5ffb29186; BXFLOW_JOB_VARIABLES_UX=58c35196-47a0-4a82-9ecc-e96ec488899a; BXFLOW_JOB_DETAILS_UX=eb72189d-481d-4d9d-af81-4c900073e10d; BXFLOW_JOB_DATA_GRID_UX=a43220f9-c997-42dd-aee5-cd44048f5f20; BXFLOW_TABS_MANAGER=89353ec2-59e8-4d73-bbfc-2d249859227a"
+
+        cookies = CookieParser().parse_raw(part1 + " " + part2)
+
+        logger.debug(describe("[COOKOFF] cookies", cookies))