Skip to content

PYTHON-5488 append_metadata should not add duplicates #2461

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+72 −30
Open

PYTHON-5488 append_metadata should not add duplicates #2461

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ba6d700
PYTHON-5488 `append_metadata` should not add duplicates
sleepyStick Aug 6, 2025
69f5a6a
make it case insensitive
sleepyStick Aug 7, 2025
5e47df3
add none check and refactor test
sleepyStick Aug 8, 2025
30f4ac1
always add |
sleepyStick Aug 11, 2025
a6f43ff
Merge branch 'master' into PYTHON-5488
sleepyStick Aug 11, 2025
c469174
fix test
sleepyStick Aug 11, 2025
a2f0caa
Merge branch 'PYTHON-5488' of https://github.com/sleepyStick/mongo-py…
sleepyStick Aug 11, 2025
b5314ab
simplify logic
sleepyStick Aug 11, 2025
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
30 changes: 18 additions & 12 deletions pymongo/pool_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,20 +386,26 @@ def __init__(

def _update_metadata(self, driver: DriverInfo) -> None:
"""Updates the client's metadata"""
if driver.name and driver.name.lower() in self.__metadata["driver"]["name"].lower().split(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit: we don't need the split() call here. Does having it improve readability?

Copy link
Contributor Author

@sleepyStick sleepyStick Aug 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was mainly worried about potential substrings? like if driver.name is a substring of an existing name, its not the same and therefore still should be added?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah good point! Great find on that edge case, better to be safe here and use the split!

"|"
):
return

metadata = copy.deepcopy(self.__metadata)
if driver.name:
metadata["driver"]["name"] = "{}|{}".format(
metadata["driver"]["name"],
driver.name,
)
if driver.version:
metadata["driver"]["version"] = "{}|{}".format(
metadata["driver"]["version"],
driver.version,
)
if driver.platform:
metadata["platform"] = "{}|{}".format(metadata["platform"], driver.platform)

name = driver.name if driver.name else ""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These can be simplified to driver.xxx or ""

version = driver.version if driver.version else ""
platform = driver.platform if driver.platform else ""

metadata["driver"]["name"] = "{}|{}".format(
metadata["driver"]["name"],
name,
)
metadata["driver"]["version"] = "{}|{}".format(
metadata["driver"]["version"],
version,
)
metadata["platform"] = "{}|{}".format(metadata["platform"], platform)

self.__metadata = metadata

Expand Down
1 change: 1 addition & 0 deletions test/asynchronous/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,7 @@ async def test_metadata(self):
else:
metadata["driver"]["name"] = "PyMongo|async|FooDriver"
metadata["driver"]["version"] = "{}|1.2.3".format(_METADATA["driver"]["version"])
metadata["platform"] = "{}|".format(_METADATA["platform"])
client = self.simple_client(
"foo",
27017,
Expand Down
35 changes: 26 additions & 9 deletions test/asynchronous/test_client_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,20 @@ async def check_metadata_added(
new_name, new_version, new_platform, new_metadata = await self.send_ping_and_get_metadata(
client, True
)
self.assertEqual(new_name, f"{name}|{add_name}" if add_name is not None else name)
self.assertEqual(
new_version,
f"{version}|{add_version}" if add_version is not None else version,
)
self.assertEqual(
new_platform,
f"{platform}|{add_platform}" if add_platform is not None else platform,
)
if add_name is not None and add_name.lower() in name.lower().split("|"):
self.assertEqual(name, new_name)
self.assertEqual(version, new_version)
self.assertEqual(platform, new_platform)
else:
self.assertEqual(new_name, f"{name}|{add_name}" if add_name is not None else f"{name}|")
self.assertEqual(
new_version,
f"{version}|{add_version}" if add_version is not None else f"{version}|",
)
self.assertEqual(
new_platform,
f"{platform}|{add_platform}" if add_platform is not None else f"{platform}|",
)

metadata.pop("driver")
metadata.pop("platform")
Expand Down Expand Up @@ -210,6 +215,18 @@ async def test_doesnt_update_established_connections(self):
self.assertIsNone(self.handshake_req)
self.assertEqual(listener.event_count(ConnectionClosedEvent), 0)

async def test_duplicate_driver_name_no_op(self):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we refactor check_metadata_added to support checking that the new metadata is the same as the old metadata? Most of this method is just duplicate code from check_metadata_added.

client = await self.async_rs_or_single_client(
"mongodb://" + self.server.address_string,
maxIdleTimeMS=1,
)
client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
await self.check_metadata_added(client, "framework", None, None)
# wait for connection to become idle
await asyncio.sleep(0.005)
# add same metadata again
await self.check_metadata_added(client, "Framework", None, None)


if __name__ == "__main__":
unittest.main()
1 change: 1 addition & 0 deletions test/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,7 @@ def test_metadata(self):
else:
metadata["driver"]["name"] = "PyMongo|FooDriver"
metadata["driver"]["version"] = "{}|1.2.3".format(_METADATA["driver"]["version"])
metadata["platform"] = "{}|".format(_METADATA["platform"])
client = self.simple_client(
"foo",
27017,
Expand Down
35 changes: 26 additions & 9 deletions test/test_client_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,20 @@ def check_metadata_added(
new_name, new_version, new_platform, new_metadata = self.send_ping_and_get_metadata(
client, True
)
self.assertEqual(new_name, f"{name}|{add_name}" if add_name is not None else name)
self.assertEqual(
new_version,
f"{version}|{add_version}" if add_version is not None else version,
)
self.assertEqual(
new_platform,
f"{platform}|{add_platform}" if add_platform is not None else platform,
)
if add_name is not None and add_name.lower() in name.lower().split("|"):
self.assertEqual(name, new_name)
self.assertEqual(version, new_version)
self.assertEqual(platform, new_platform)
else:
self.assertEqual(new_name, f"{name}|{add_name}" if add_name is not None else f"{name}|")
self.assertEqual(
new_version,
f"{version}|{add_version}" if add_version is not None else f"{version}|",
)
self.assertEqual(
new_platform,
f"{platform}|{add_platform}" if add_platform is not None else f"{platform}|",
)

metadata.pop("driver")
metadata.pop("platform")
Expand Down Expand Up @@ -210,6 +215,18 @@ def test_doesnt_update_established_connections(self):
self.assertIsNone(self.handshake_req)
self.assertEqual(listener.event_count(ConnectionClosedEvent), 0)

def test_duplicate_driver_name_no_op(self):
client = self.rs_or_single_client(
"mongodb://" + self.server.address_string,
maxIdleTimeMS=1,
)
client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
self.check_metadata_added(client, "framework", None, None)
# wait for connection to become idle
time.sleep(0.005)
# add same metadata again
self.check_metadata_added(client, "Framework", None, None)


if __name__ == "__main__":
unittest.main()
Loading