feat: add http_cookie to WebsocketSession and UserSession (#1653)

Co-authored-by: Willy Douhard <willy.douhard@gmail.com>

backend/chainlit/session.py

@@ -64,6 +64,8 @@ def __init__(
         chat_profile: Optional[str] = None,
         # Origin of the request
         http_referer: Optional[str] = None,
+        # Cookie
+        http_cookie: Optional[str] = None,
     ):
         if thread_id:
             self.thread_id_to_resume = thread_id
@@ -75,6 +77,7 @@ def __init__(
         self.user_env = user_env or {}
         self.chat_profile = chat_profile
         self.http_referer = http_referer
+        self.http_cookie = http_cookie
 
         self.files: Dict[str, FileDict] = {}
 
@@ -167,6 +170,8 @@ def __init__(
         user_env: Optional[Dict[str, str]] = None,
         # Origin of the request
         http_referer: Optional[str] = None,
+        # Cookie
+        http_cookie: Optional[str] = None,
     ):
         super().__init__(
             id=id,
@@ -176,6 +181,7 @@ def __init__(
             client_type=client_type,
             user_env=user_env,
             http_referer=http_referer,
+            http_cookie=http_cookie,
         )
 
     def delete(self):
@@ -226,6 +232,8 @@ def __init__(
         languages: Optional[str] = None,
         # Origin of the request
         http_referer: Optional[str] = None,
+        # Cookie
+        http_cookie: Optional[str] = None,
     ):
         super().__init__(
             id=id,
@@ -236,6 +244,7 @@ def __init__(
             client_type=client_type,
             chat_profile=chat_profile,
             http_referer=http_referer,
+            http_cookie=http_cookie,
         )
 
         self.socket_id = socket_id

backend/chainlit/socket.py

@@ -136,6 +136,7 @@ def emit_call_fn(event: Literal["ask", "call_fn"], data, timeout):
 
     client_type = auth.get("clientType")
     http_referer = environ.get("HTTP_REFERER")
+    http_cookie = environ.get("HTTP_COOKIE")
     url_encoded_chat_profile = auth.get("chatProfile")
     chat_profile = (
         unquote(url_encoded_chat_profile) if url_encoded_chat_profile else None
@@ -154,6 +155,7 @@ def emit_call_fn(event: Literal["ask", "call_fn"], data, timeout):
         thread_id=auth.get("threadId"),
         languages=environ.get("HTTP_ACCEPT_LANGUAGE"),
         http_referer=http_referer,
+        http_cookie=http_cookie,
     )
 
     trace_event("connection_successful")

backend/chainlit/user_session.py

@@ -29,6 +29,7 @@ def get(self, key, default=None):
         user_session["chat_profile"] = context.session.chat_profile
         user_session["http_referer"] = context.session.http_referer
         user_session["client_type"] = context.session.client_type
+        user_session["http_cookie"] = context.session.http_cookie
 
         if isinstance(context.session, WebsocketSession):
             user_session["languages"] = context.session.languages

backend/tests/conftest.py

@@ -35,6 +35,7 @@ def create_mock_session(**kwargs) -> Mock:
         mock.chat_settings = kwargs.get("chat_settings", {})
         mock.chat_profile = kwargs.get("chat_profile", None)
         mock.http_referer = kwargs.get("http_referer", None)
+        mock.http_cookie = kwargs.get("http_cookie", None)
         mock.client_type = kwargs.get("client_type", "webapp")
         mock.languages = kwargs.get("languages", ["en"])
         mock.thread_id = kwargs.get("thread_id", "test_thread_id")

backend/tests/test_user_session.py

@@ -13,3 +13,4 @@ async def test_user_session_set_get(mock_chainlit_context, user_session):
         assert user_session.get("id") == context.session.id
         assert user_session.get("env") == context.session.user_env
         assert user_session.get("languages") == context.session.languages
+        assert user_session.get("http_cookie") == context.session.http_cookie