From 7ad71544d7eb3b9b8e70c427e1a5124d0dc9de56 Mon Sep 17 00:00:00 2001 From: shreeraj Date: Fri, 20 Nov 2026 13:57:33 +0530 Subject: [PATCH] fix(web, webhook, scim, audit_logs): copy the headers dict passed to the client constructors The clients stored the headers / default_headers dict they were given and then wrote the generated User-Agent into it. That changed the caller's dict, and two clients created from the same dict shared one headers object, so the second client's user_agent_prefix replaced the first client's. Copy the dict in WebClient, AsyncWebClient, LegacyWebClient, WebhookClient, AsyncWebhookClient, AuditLogsClient, AsyncAuditLogsClient, SCIMClient and AsyncSCIMClient. Add a test that covers all of them. --- slack_sdk/audit_logs/v1/async_client.py | 2 +- slack_sdk/audit_logs/v1/client.py | 2 +- slack_sdk/scim/v1/async_client.py | 2 +- slack_sdk/scim/v1/client.py | 2 +- slack_sdk/web/async_base_client.py | 2 +- slack_sdk/web/base_client.py | 2 +- slack_sdk/web/legacy_base_client.py | 2 +- slack_sdk/webhook/async_client.py | 2 +- slack_sdk/webhook/client.py | 2 +- tests/slack_sdk/test_client_headers_copy.py | 63 +++++++++++++++++++++ 10 files changed, 72 insertions(+), 9 deletions(-) create mode 100644 tests/slack_sdk/test_client_headers_copy.py diff --git a/slack_sdk/audit_logs/v1/async_client.py b/slack_sdk/audit_logs/v1/async_client.py index 06e0e9fe4..a53d882ee 100644 --- a/slack_sdk/audit_logs/v1/async_client.py +++ b/slack_sdk/audit_logs/v1/async_client.py @@ -85,7 +85,7 @@ def __init__( self.session = session self.trust_env_in_session = trust_env_in_session self.auth = auth - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers() diff --git a/slack_sdk/audit_logs/v1/client.py b/slack_sdk/audit_logs/v1/client.py index 73859a60f..ba731381b 100644 --- a/slack_sdk/audit_logs/v1/client.py +++ b/slack_sdk/audit_logs/v1/client.py @@ -74,7 +74,7 @@ def __init__( self.ssl = ssl self.proxy = proxy self.base_url = base_url - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else default_retry_handlers() diff --git a/slack_sdk/scim/v1/async_client.py b/slack_sdk/scim/v1/async_client.py index fb7d35345..29b1e70ab 100644 --- a/slack_sdk/scim/v1/async_client.py +++ b/slack_sdk/scim/v1/async_client.py @@ -99,7 +99,7 @@ def __init__( self.session = session self.trust_env_in_session = trust_env_in_session self.auth = auth - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers() diff --git a/slack_sdk/scim/v1/client.py b/slack_sdk/scim/v1/client.py index 93131233c..c3f4afe64 100644 --- a/slack_sdk/scim/v1/client.py +++ b/slack_sdk/scim/v1/client.py @@ -97,7 +97,7 @@ def __init__( self.ssl = ssl self.proxy = proxy self.base_url = base_url - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else default_retry_handlers() diff --git a/slack_sdk/web/async_base_client.py b/slack_sdk/web/async_base_client.py index e4275f685..f234c450e 100644 --- a/slack_sdk/web/async_base_client.py +++ b/slack_sdk/web/async_base_client.py @@ -74,7 +74,7 @@ def __init__( are allowed to read environment variables. Commonly used in conjunction with proxy support via the `HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY` and `http_proxy` environment variables.""" - self.headers = headers or {} + self.headers = dict(headers) if headers else {} """`dict` representing additional request headers to attach to all requests.""" self.headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.default_params = {} diff --git a/slack_sdk/web/base_client.py b/slack_sdk/web/base_client.py index 7be28dacf..0ddb59ffb 100644 --- a/slack_sdk/web/base_client.py +++ b/slack_sdk/web/base_client.py @@ -77,7 +77,7 @@ def __init__( is not specified, if any of the following environment variables are present, they will be loaded into this parameter: `HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY` or `http_proxy`.""" - self.headers = headers or {} + self.headers = dict(headers) if headers else {} """`dict` representing additional request headers to attach to all requests.""" self.headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.default_params = {} diff --git a/slack_sdk/web/legacy_base_client.py b/slack_sdk/web/legacy_base_client.py index 2cf1f1089..ddcf4de89 100644 --- a/slack_sdk/web/legacy_base_client.py +++ b/slack_sdk/web/legacy_base_client.py @@ -86,7 +86,7 @@ def __init__( self.run_async = run_async self.use_sync_aiohttp = use_sync_aiohttp self.session = session - self.headers = headers or {} + self.headers = dict(headers) if headers else {} """`dict` representing additional request headers to attach to all requests.""" self.headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.default_params = {} diff --git a/slack_sdk/webhook/async_client.py b/slack_sdk/webhook/async_client.py index 86207c476..9c3a4b879 100644 --- a/slack_sdk/webhook/async_client.py +++ b/slack_sdk/webhook/async_client.py @@ -75,7 +75,7 @@ def __init__( self.trust_env_in_session = trust_env_in_session self.session = session self.auth = auth - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers() diff --git a/slack_sdk/webhook/client.py b/slack_sdk/webhook/client.py index 49fd15230..4446ffeaf 100644 --- a/slack_sdk/webhook/client.py +++ b/slack_sdk/webhook/client.py @@ -65,7 +65,7 @@ def __init__( self.timeout = timeout self.ssl = ssl self.proxy = proxy - self.default_headers = default_headers if default_headers else {} + self.default_headers = dict(default_headers) if default_headers else {} self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix) self.logger = logger if logger is not None else logging.getLogger(__name__) self.retry_handlers = retry_handlers if retry_handlers is not None else default_retry_handlers() diff --git a/tests/slack_sdk/test_client_headers_copy.py b/tests/slack_sdk/test_client_headers_copy.py new file mode 100644 index 000000000..df4ff756b --- /dev/null +++ b/tests/slack_sdk/test_client_headers_copy.py @@ -0,0 +1,63 @@ +import unittest + +from slack_sdk.audit_logs import AuditLogsClient +from slack_sdk.audit_logs.v1.async_client import AsyncAuditLogsClient +from slack_sdk.scim import SCIMClient +from slack_sdk.scim.v1.async_client import AsyncSCIMClient +from slack_sdk.web import WebClient +from slack_sdk.web.async_client import AsyncWebClient +from slack_sdk.web.legacy_client import LegacyWebClient +from slack_sdk.webhook import WebhookClient +from slack_sdk.webhook.async_client import AsyncWebhookClient + + +class TestClientHeadersCopy(unittest.TestCase): + """The headers dict given to a client constructor must not be shared with, or changed by, the client.""" + + def _clients(self, headers: dict, user_agent_prefix: str) -> dict: + return { + "WebClient": WebClient(token="xoxb-valid", headers=headers, user_agent_prefix=user_agent_prefix), + "AsyncWebClient": AsyncWebClient(token="xoxb-valid", headers=headers, user_agent_prefix=user_agent_prefix), + "LegacyWebClient": LegacyWebClient(token="xoxb-valid", headers=headers, user_agent_prefix=user_agent_prefix), + "WebhookClient": WebhookClient( + "https://hooks.slack.com/services/T111/B111/xxx", + default_headers=headers, + user_agent_prefix=user_agent_prefix, + ), + "AsyncWebhookClient": AsyncWebhookClient( + "https://hooks.slack.com/services/T111/B111/xxx", + default_headers=headers, + user_agent_prefix=user_agent_prefix, + ), + "AuditLogsClient": AuditLogsClient( + token="xoxp-valid", default_headers=headers, user_agent_prefix=user_agent_prefix + ), + "AsyncAuditLogsClient": AsyncAuditLogsClient( + token="xoxp-valid", default_headers=headers, user_agent_prefix=user_agent_prefix + ), + "SCIMClient": SCIMClient(token="xoxp-valid", default_headers=headers, user_agent_prefix=user_agent_prefix), + "AsyncSCIMClient": AsyncSCIMClient( + token="xoxp-valid", default_headers=headers, user_agent_prefix=user_agent_prefix + ), + } + + @staticmethod + def _sent_headers(client) -> dict: + return client.default_headers if hasattr(client, "default_headers") else client.headers + + def test_caller_headers_are_not_modified(self): + headers = {"X-Trace": "1"} + for name, client in self._clients(headers, "app-a").items(): + with self.subTest(client=name): + self.assertEqual(headers, {"X-Trace": "1"}) + self.assertEqual(self._sent_headers(client)["X-Trace"], "1") + self.assertTrue(self._sent_headers(client)["User-Agent"].startswith("app-a ")) + + def test_clients_built_from_the_same_headers_keep_their_own_user_agent(self): + headers = {"X-Trace": "1"} + first = self._clients(headers, "app-a") + second = self._clients(headers, "app-b") + for name in first: + with self.subTest(client=name): + self.assertTrue(self._sent_headers(first[name])["User-Agent"].startswith("app-a ")) + self.assertTrue(self._sent_headers(second[name])["User-Agent"].startswith("app-b "))