Skip to content

Remove urllib3 info from useragent string #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025
Merged

Remove urllib3 info from useragent string #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions pinecone/utils/user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import urllib3

from .version import __version__
from .constants import SOURCE_TAG
import re
Expand All @@ -19,11 +17,11 @@ def _build_source_tag_field(source_tag):


def _get_user_agent(client_id, config):
user_agent_details = {"urllib3": urllib3.__version__}
user_agent = "{} ({})".format(
client_id, ", ".join([f"{k}:{v}" for k, v in user_agent_details.items()])
user_agent = (
f"{client_id}; {_build_source_tag_field(config.source_tag)}"
if config.source_tag
else client_id
)
user_agent += f"; {_build_source_tag_field(config.source_tag)}" if config.source_tag else ""
return user_agent


Expand Down
6 changes: 3 additions & 3 deletions tests/unit/utils/test_setup_openapi_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_setup_openapi_client(self):
openapi_config=openapi_config,
pool_threads=2,
)
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+ \(urllib3\:\d+\.\d+\.\d+\)")
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+")
assert re.match(user_agent_regex, control_plane_client.api_client.user_agent)
assert re.match(
user_agent_regex, control_plane_client.api_client.default_headers["User-Agent"]
Expand All @@ -38,7 +38,7 @@ def test_setup_openapi_client_with_api_version(self):
pool_threads=2,
api_version="2024-04",
)
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+ \(urllib3\:\d+\.\d+\.\d+\)")
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+")
assert re.match(user_agent_regex, control_plane_client.api_client.user_agent)
assert re.match(
user_agent_regex, control_plane_client.api_client.default_headers["User-Agent"]
Expand Down Expand Up @@ -102,7 +102,7 @@ def test_setup_openapi_client_with_host_override(self, plugin_api_version, plugi
assert isinstance(plugin_client, plugin_api)

# We want requests from plugins to have a user-agent matching the host SDK.
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+ \(urllib3\:\d+\.\d+\.\d+\)")
user_agent_regex = re.compile(r"python-client-\d+\.\d+\.\d+")
assert re.match(user_agent_regex, plugin_client.api_client.user_agent)
assert re.match(user_agent_regex, plugin_client.api_client.default_headers["User-Agent"])

Expand Down
40 changes: 27 additions & 13 deletions tests/unit/utils/test_user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,38 @@ class TestUserAgent:
def test_user_agent(self):
config = ConfigBuilder.build(api_key="my-api-key", host="https://my-controller-host")
useragent = get_user_agent(config)
assert re.search(r"python-client-\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"urllib3:\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"^python-client-\d+\.\d+\.\d+$", useragent) is not None

def test_user_agent_with_source_tag(self):
config = ConfigBuilder.build(
api_key="my-api-key", host="https://my-controller-host", source_tag="my_source_tag"
)
useragent = get_user_agent(config)
assert re.search(r"python-client-\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"urllib3:\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"source_tag=my_source_tag", useragent) is not None
assert (
re.search(r"^python-client-\d+\.\d+\.\d+; source_tag=my_source_tag$", useragent)
is not None
)

def test_source_tag_is_normalized(self):
config = ConfigBuilder.build(
api_key="my-api-key", host="https://my-controller-host", source_tag="my source tag!!!!"
)
useragent = get_user_agent(config)
assert re.search(r"source_tag=my_source_tag", useragent) is not None
assert (
re.search(r"^python-client-\d+\.\d+\.\d+; source_tag=my_source_tag$", useragent)
is not None
)
assert "!!!!" not in useragent

config = ConfigBuilder.build(
api_key="my-api-key", host="https://my-controller-host", source_tag="My Source Tag"
)
useragent = get_user_agent(config)
assert re.search(r"source_tag=my_source_tag", useragent) is not None
assert (
re.search(r"^python-client-\d+\.\d+\.\d+; source_tag=my_source_tag$", useragent)
is not None
)
assert "My Source Tag" not in useragent

config = ConfigBuilder.build(
api_key="my-api-key",
Expand All @@ -46,25 +54,31 @@ def test_source_tag_is_normalized(self):
source_tag=" My Source Tag 123 #### !! ",
)
useragent = get_user_agent(config)
assert re.search(r"source_tag=my_source_tag_123", useragent) is not None
assert (
re.search(r"^python-client-\d+\.\d+\.\d+; source_tag=my_source_tag_123$", useragent)
is not None
)

config = ConfigBuilder.build(
api_key="my-api-key", host="https://my-controller-host", source_tag="colon:allowed"
)
useragent = get_user_agent(config)
assert re.search(r"source_tag=colon:allowed", useragent) is not None
assert (
re.search(r"^python-client-\d+\.\d+\.\d+; source_tag=colon:allowed$", useragent)
is not None
)

def test_user_agent_grpc(self):
config = ConfigBuilder.build(api_key="my-api-key", host="https://my-controller-host")
useragent = get_user_agent_grpc(config)
assert re.search(r"python-client\[grpc\]-\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"urllib3:\d+\.\d+\.\d+", useragent) is not None

def test_user_agent_grpc_with_source_tag(self):
config = ConfigBuilder.build(
api_key="my-api-key", host="https://my-controller-host", source_tag="my_source_tag"
)
useragent = get_user_agent_grpc(config)
assert re.search(r"python-client\[grpc\]-\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"urllib3:\d+\.\d+\.\d+", useragent) is not None
assert re.search(r"source_tag=my_source_tag", useragent) is not None
assert (
re.search(r"^python-client\[grpc\]-\d+\.\d+\.\d+; source_tag=my_source_tag$", useragent)
is not None
)
Loading