mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-5488 append_metadata should not add duplicates (#2461)

Browse Source
This commit is contained in:
Iris 2025-08-18 11:12:48 -07:00 committed by GitHub
parent de332c553c
commit 2a1523fa85
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 57 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pymongo/pool_options.py
View File

@ -386,8 +386,13 @@ class PoolOptions:
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(
"|"
):
return
metadata = copy.deepcopy(self.__metadata)
if driver.name:
metadata["driver"]["name"] = "{}|{}".format(
metadata["driver"]["name"],

35
test/asynchronous/test_client_metadata.py
View File

@ -107,15 +107,20 @@ class TestClientMetadataProse(AsyncIntegrationTest):
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 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,
)
metadata.pop("driver")
metadata.pop("platform")
@ -210,6 +215,18 @@ class TestClientMetadataProse(AsyncIntegrationTest):
self.assertIsNone(self.handshake_req)
self.assertEqual(listener.event_count(ConnectionClosedEvent), 0)
async def test_duplicate_driver_name_no_op(self):
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()

35
test/test_client_metadata.py
View File

@ -107,15 +107,20 @@ class TestClientMetadataProse(IntegrationTest):
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 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,
)
metadata.pop("driver")
metadata.pop("platform")
@ -210,6 +215,18 @@ class TestClientMetadataProse(IntegrationTest):
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()