feat: swappable http client (#102)

Author: peterdeme

stream_chat/async_chat/client.py

@@ -49,6 +49,14 @@ def __init__(
             connector=aiohttp.TCPConnector(keepalive_timeout=59.0),
         )
 
+    def set_http_session(self, session: aiohttp.ClientSession) -> None:
+        """
+        You can use your own `aiohttp.ClientSession` instance. This instance
+        will be used for underlying HTTP requests.
+        Make sure you set up a `base_url` for the session.
+        """
+        self.session = session
+
     async def _parse_response(self, response: aiohttp.ClientResponse) -> StreamResponse:
         text = await response.text()
         try:

stream_chat/client.py

@@ -36,6 +36,13 @@ def __init__(
         self.session.mount("http://", requests.adapters.HTTPAdapter(max_retries=1))
         self.session.mount("https://", requests.adapters.HTTPAdapter(max_retries=1))
 
+    def set_http_session(self, session: requests.Session) -> None:
+        """
+        You can use your own `requests.Session` instance. This instance
+        will be used for underlying HTTP requests.
+        """
+        self.session = session
+
     def _parse_response(self, response: requests.Response) -> StreamResponse:
         try:
             parsed_result = json.loads(response.text) if response.text else {}

stream_chat/tests/async_chat/test_client.py

@@ -1,4 +1,5 @@
 import json
+import os
 import sys
 import time
 import uuid
@@ -7,6 +8,7 @@
 from operator import itemgetter
 from typing import Dict, List
 
+import aiohttp
 import jwt
 import pytest
 
@@ -716,3 +718,18 @@ async def test_stream_response(self, client: StreamChatAsync):
         assert rate_limit.limit > 0
         assert rate_limit.remaining > 0
         assert type(rate_limit.reset) is datetime
+
+    async def test_swap_http_client(self):
+        client = StreamChatAsync(
+            api_key=os.environ["STREAM_KEY"], api_secret=os.environ["STREAM_SECRET"]
+        )
+
+        client.set_http_session(aiohttp.ClientSession(base_url="https://getstream.io"))
+        with pytest.raises(StreamAPIException):
+            await client.get_app_settings()
+
+        client.set_http_session(
+            aiohttp.ClientSession(base_url="https://chat.stream-io-api.com")
+        )
+        resp = await client.get_app_settings()
+        assert resp.status_code() == 200

stream_chat/tests/test_client.py

@@ -1,4 +1,5 @@
 import json
+import os
 import sys
 import time
 import uuid
@@ -9,6 +10,7 @@
 
 import jwt
 import pytest
+import requests
 
 from stream_chat import StreamChat
 from stream_chat.base.exceptions import StreamAPIException
@@ -689,3 +691,18 @@ def test_stream_response(self, client: StreamChat):
         assert rate_limit.limit > 0
         assert rate_limit.remaining > 0
         assert type(rate_limit.reset) is datetime
+
+    def test_swap_http_client(self):
+        client = StreamChat(
+            api_key=os.environ["STREAM_KEY"], api_secret=os.environ["STREAM_SECRET"]
+        )
+
+        session = requests.Session()
+        session.proxies = {"https": "https://getstream.io"}
+        client.set_http_session(session)
+        with pytest.raises(requests.exceptions.ProxyError):
+            client.get_app_settings()
+
+        client.set_http_session(requests.Session())
+        resp = client.get_app_settings()
+        assert resp.status_code() == 200