PYTHON-4662 - Capture Async PyMongo metadata (mongodb#1814)

Author: NoahStapp

pymongo/asynchronous/mongo_client.py

@@ -830,7 +830,7 @@ def __init__(
         # Username and password passed as kwargs override user info in URI.
         username = opts.get("username", username)
         password = opts.get("password", password)
-        self._options = options = ClientOptions(username, password, dbase, opts)
+        self._options = options = ClientOptions(username, password, dbase, opts, _IS_SYNC)
 
         self._default_database_name = dbase
         self._lock = _ALock(_create_lock())

pymongo/client_options.py

@@ -144,7 +144,11 @@ def _parse_ssl_options(options: Mapping[str, Any]) -> tuple[Optional[SSLContext]
 
 
 def _parse_pool_options(
-    username: str, password: str, database: Optional[str], options: Mapping[str, Any]
+    username: str,
+    password: str,
+    database: Optional[str],
+    options: Mapping[str, Any],
+    is_sync: bool,
 ) -> PoolOptions:
     """Parse connection pool options."""
     credentials = _parse_credentials(username, password, database, options)
@@ -183,6 +187,7 @@ def _parse_pool_options(
         server_api=server_api,
         load_balanced=load_balanced,
         credentials=credentials,
+        is_sync=is_sync,
     )
 
 
@@ -195,7 +200,12 @@ class ClientOptions:
     """
 
     def __init__(
-        self, username: str, password: str, database: Optional[str], options: Mapping[str, Any]
+        self,
+        username: str,
+        password: str,
+        database: Optional[str],
+        options: Mapping[str, Any],
+        is_sync: bool = True,
     ):
         self.__options = options
         self.__codec_options = _parse_codec_options(options)
@@ -206,7 +216,7 @@ def __init__(
         self.__server_selection_timeout = options.get(
             "serverselectiontimeoutms", common.SERVER_SELECTION_TIMEOUT
         )
-        self.__pool_options = _parse_pool_options(username, password, database, options)
+        self.__pool_options = _parse_pool_options(username, password, database, options, is_sync)
         self.__read_preference = _parse_read_preference(options)
         self.__replica_set_name = options.get("replicaset")
         self.__write_concern = _parse_write_concern(options)

pymongo/pool_options.py

@@ -331,6 +331,7 @@ def __init__(
         server_api: Optional[ServerApi] = None,
         load_balanced: Optional[bool] = None,
         credentials: Optional[MongoCredential] = None,
+        is_sync: Optional[bool] = True,
     ):
         self.__max_pool_size = max_pool_size
         self.__min_pool_size = min_pool_size
@@ -350,6 +351,7 @@ def __init__(
         self.__load_balanced = load_balanced
         self.__credentials = credentials
         self.__metadata = copy.deepcopy(_METADATA)
+
         if appname:
             self.__metadata["application"] = {"name": appname}
 
@@ -361,10 +363,15 @@ def __init__(
         #    },
         #    'platform': 'CPython 3.8.0|MyPlatform'
         # }
+        if not is_sync:
+            self.__metadata["driver"]["name"] = "{}|{}".format(
+                self.__metadata["driver"]["name"],
+                "async",
+            )
         if driver:
             if driver.name:
                 self.__metadata["driver"]["name"] = "{}|{}".format(
-                    _METADATA["driver"]["name"],
+                    self.__metadata["driver"]["name"],
                     driver.name,
                 )
             if driver.version:

pymongo/synchronous/mongo_client.py

@@ -829,7 +829,7 @@ def __init__(
         # Username and password passed as kwargs override user info in URI.
         username = opts.get("username", username)
         password = opts.get("password", password)
-        self._options = options = ClientOptions(username, password, dbase, opts)
+        self._options = options = ClientOptions(username, password, dbase, opts, _IS_SYNC)
 
         self._default_database_name = dbase
         self._lock = _create_lock()

test/asynchronous/test_client.py

@@ -341,6 +341,7 @@ async def test_read_preference(self):
 
     def test_metadata(self):
         metadata = copy.deepcopy(_METADATA)
+        metadata["driver"]["name"] = "PyMongo|async"
         metadata["application"] = {"name": "foobar"}
         client = AsyncMongoClient("mongodb://foo:27017/?appname=foobar&connect=false")
         options = client.options
@@ -359,7 +360,7 @@ def test_metadata(self):
         self.assertRaises(TypeError, AsyncMongoClient, driver="abc")
         self.assertRaises(TypeError, AsyncMongoClient, driver=("Foo", "1", "a"))
         # Test appending to driver info.
-        metadata["driver"]["name"] = "PyMongo|FooDriver"
+        metadata["driver"]["name"] = "PyMongo|async|FooDriver"
         metadata["driver"]["version"] = "{}|1.2.3".format(_METADATA["driver"]["version"])
         client = AsyncMongoClient(
             "foo",
@@ -403,6 +404,7 @@ def test_metadata(self):
     @mock.patch.dict("os.environ", {ENV_VAR_K8S: "1"})
     def test_container_metadata(self):
         metadata = copy.deepcopy(_METADATA)
+        metadata["driver"]["name"] = "PyMongo|async"
         metadata["env"] = {}
         metadata["env"]["container"] = {"orchestrator": "kubernetes"}
         client = AsyncMongoClient("mongodb://foo:27017/?appname=foobar&connect=false")
@@ -1938,6 +1940,7 @@ def test_sigstop_sigcont(self):
     async def _test_handshake(self, env_vars, expected_env):
         with patch.dict("os.environ", env_vars):
             metadata = copy.deepcopy(_METADATA)
+            metadata["driver"]["name"] = "PyMongo|async"
             if expected_env is not None:
                 metadata["env"] = expected_env
 

test/test_client.py

@@ -337,6 +337,7 @@ def test_read_preference(self):
 
     def test_metadata(self):
         metadata = copy.deepcopy(_METADATA)
+        metadata["driver"]["name"] = "PyMongo"
         metadata["application"] = {"name": "foobar"}
         client = MongoClient("mongodb://foo:27017/?appname=foobar&connect=false")
         options = client.options
@@ -399,6 +400,7 @@ def test_metadata(self):
     @mock.patch.dict("os.environ", {ENV_VAR_K8S: "1"})
     def test_container_metadata(self):
         metadata = copy.deepcopy(_METADATA)
+        metadata["driver"]["name"] = "PyMongo"
         metadata["env"] = {}
         metadata["env"]["container"] = {"orchestrator": "kubernetes"}
         client = MongoClient("mongodb://foo:27017/?appname=foobar&connect=false")
@@ -1894,6 +1896,7 @@ def test_sigstop_sigcont(self):
     def _test_handshake(self, env_vars, expected_env):
         with patch.dict("os.environ", env_vars):
             metadata = copy.deepcopy(_METADATA)
+            metadata["driver"]["name"] = "PyMongo"
             if expected_env is not None:
                 metadata["env"] = expected_env
 

tools/synchro.py

@@ -96,6 +96,7 @@
     "async-transactions-ref": "transactions-ref",
     "async-snapshot-reads-ref": "snapshot-reads-ref",
     "default_async": "default",
+    "PyMongo|async": "PyMongo",
 }
 
 docstring_replacements: dict[tuple[str, str], str] = {