PYTHON-4238 - Add Beanie version to handshake metadata

beanie/odm/utils/init.py

@@ -18,6 +18,7 @@
 
 import importlib
 import inspect
+from importlib.metadata import version
 from typing import (  # type: ignore
     List,
     Optional,
@@ -29,6 +30,7 @@
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
 from pymongo import AsyncMongoClient, IndexModel
+from pymongo.driver_info import DriverInfo
 
 from beanie.exceptions import Deprecation, MongoDBVersionError
 from beanie.odm.actions import ActionRegistry
@@ -49,6 +51,8 @@
 from beanie.odm.union_doc import UnionDoc, UnionDocType
 from beanie.odm.views import View
 
+_DRIVER_METADATA = DriverInfo(name="beanie", version=version("beanie"))
+
 
 class Output(BaseModel):
     class_name: str
@@ -102,9 +106,13 @@ def __init__(
             raise ValueError("document_models parameter must be set")
         if connection_string is not None:
             database = AsyncMongoClient(
-                connection_string
+                connection_string, driver=_DRIVER_METADATA
             ).get_default_database()
 
+        # append_metadata was added in PyMongo 4.14 and is a valid database name prior to that version
+        elif callable(database.client.append_metadata):
+            database.client.append_metadata(_DRIVER_METADATA)
+
         self.database: AsyncDatabase = database
 
         sort_order = {

tests/odm/documents/test_init.py

@@ -1,7 +1,10 @@
+from importlib.metadata import version
+
 import pytest
 from pymongo import IndexModel
 
 from beanie import Document, Indexed, init_beanie
+from beanie import __version__ as beanie_version
 from beanie.exceptions import CollectionWasNotInitialized
 from beanie.odm.utils.projection import get_projection
 from tests.odm.models import (
@@ -62,6 +65,38 @@ class NewDocumentCS(Document):
         await init_beanie(connection_string=settings.mongodb_dsn)
 
 
+async def test_metadata_connection_string(settings):
+    class NewDocument(Document):
+        test_str: str
+
+    await init_beanie(
+        connection_string=settings.mongodb_dsn, document_models=[NewDocument]
+    )
+
+    metadata = NewDocument.get_pymongo_collection().database.client.options.pool_options.metadata
+    assert (
+        "beanie" in metadata["driver"]["name"]
+        and beanie_version in metadata["driver"]["version"]
+    )
+
+
+@pytest.mark.skipif(
+    version("pymongo") < "4.14",
+    reason="append_metadata was added in PyMongo 4.14",
+)
+async def test_metadata_database(db):
+    class NewDocument(Document):
+        test_str: str
+
+    await init_beanie(database=db, document_models=[NewDocument])
+
+    metadata = NewDocument.get_pymongo_collection().database.client.options.pool_options.metadata
+    assert (
+        "beanie" in metadata["driver"]["name"]
+        and beanie_version in metadata["driver"]["version"]
+    )
+
+
 async def test_collection_with_custom_name():
     collection = (
         DocumentTestModelWithCustomCollectionName.get_pymongo_collection()