fix: TypeError - requests.Session.request() got an unexpected keyword argument 'user_agent_overwrite' (#45653)

* fix - TypeError: Session.request() got an unexpected word argument 'user_agent_overwrite

* fix - updating changelog

---------

Co-authored-by: Simon Moreno <30335873+simorenoh@users.noreply.github.com>

Author: dibahlfi

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -10,6 +10,7 @@
 #### Breaking Changes
 
 #### Bugs Fixed
+* Fixed regression where `user_agent_overwrite` kwarg was not cleaned up properly, causing `TypeError` crash on sync client construction. See [PR 45653](https://github.com/Azure/azure-sdk-for-python/pull/45653)
 
 #### Other Changes
 

sdk/cosmos/azure-cosmos/azure/cosmos/_cosmos_client_connection.py

@@ -1,4 +1,4 @@
-# The MIT License (MIT)
+# The MIT License (MIT)
 # Copyright (c) 2014 Microsoft Corporation
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -248,6 +248,7 @@ def __init__( # pylint: disable=too-many-statements
         ]
         # after passing in the user_agent into the user agent policy the user_agent is no longer needed
         kwargs.pop("user_agent", None)
+        kwargs.pop("user_agent_overwrite", None)
 
         transport = kwargs.pop("transport", None)
         self.pipeline_client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient(

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_cosmos_client_connection_async.py

@@ -245,6 +245,7 @@ def __init__( # pylint: disable=too-many-statements
         ]
         # after passing in the user_agent into the user agent policy the user_agent is no longer needed
         kwargs.pop("user_agent", None)
+        kwargs.pop("user_agent_overwrite", None)
 
         transport = kwargs.pop("transport", None)
         self.pipeline_client: AsyncPipelineClient[HttpRequest, AsyncHttpResponse] = AsyncPipelineClient(

sdk/cosmos/azure-cosmos/tests/test_user_agent.py

@@ -95,6 +95,22 @@ def _run_case(use_suffix: bool) -> None:
         _run_case(False)  # prefix scenario
         _run_case(True)   # suffix scenario
 
+    def test_user_agent_overwrite_does_not_leak_sync(self):
+        """Regression test: user_agent_overwrite must not leak into the HTTP transport kwargs.
+        """
+        # user_agent + user_agent_overwrite=True at client level
+        self._check({'user_agent': 'MyApp/1.0', 'user_agent_overwrite': True})
+        # user_agent + user_agent_overwrite=False at client level
+        self._check({'user_agent': 'MyApp/1.0', 'user_agent_overwrite': False})
+        # user_agent_suffix + user_agent_overwrite=True at client level
+        self._check({'user_agent_suffix': 'MyApp/1.0', 'user_agent_overwrite': True})
+        # user_agent_suffix + user_agent_overwrite=False at client level
+        self._check({'user_agent_suffix': 'MyApp/1.0', 'user_agent_overwrite': False})
+        # user_agent_overwrite=True alone (no custom user_agent string)
+        self._check({'user_agent_overwrite': True})
+        # user_agent_overwrite=False alone
+        self._check({'user_agent_overwrite': False})
+
 
 if __name__ == '__main__':
     unittest.main()

sdk/cosmos/azure-cosmos/tests/test_user_agent_async.py

@@ -84,7 +84,22 @@ async def _run_case(use_suffix: bool):
         await _run_case(False)
         await _run_case(True)
 
+    async def test_user_agent_overwrite_does_not_leak_async(self):
+        """Regression test: user_agent_overwrite must not leak into the HTTP transport kwargs.
+        """
+        # user_agent + user_agent_overwrite=True at client level
+        await self._check({'user_agent': 'MyApp/1.0', 'user_agent_overwrite': True})
+        # user_agent + user_agent_overwrite=False at client level
+        await self._check({'user_agent': 'MyApp/1.0', 'user_agent_overwrite': False})
+        # user_agent_suffix + user_agent_overwrite=True at client level
+        await self._check({'user_agent_suffix': 'MyApp/1.0', 'user_agent_overwrite': True})
+        # user_agent_suffix + user_agent_overwrite=False at client level
+        await self._check({'user_agent_suffix': 'MyApp/1.0', 'user_agent_overwrite': False})
+        # user_agent_overwrite=True alone (no custom user_agent string)
+        await self._check({'user_agent_overwrite': True})
+        # user_agent_overwrite=False alone
+        await self._check({'user_agent_overwrite': False})
+
 
 if __name__ == "__main__":
     unittest.main()
-