test: second round of prose tests

Author: durran

src/cmap/handshake/client_metadata.ts

@@ -123,13 +123,14 @@ export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMe
   };
 
   // This is where we handle additional driver info added after client construction.
-  if (options.additionalDriverInfo) {
-    const { name: n = '', version: v = '' } = options.additionalDriverInfo;
-    if (n.length > 0) {
-      driverInfo.name = `${driverInfo.name}|${n}`;
-    }
-    if (v.length > 0) {
-      driverInfo.version = `${driverInfo.version}|${v}`;
+  if (options.additionalDriverInfo.length > 0) {
+    for (const { name: n = '', version: v = '' } of options.additionalDriverInfo) {
+      if (n.length > 0) {
+        driverInfo.name = `${driverInfo.name}|${n}`;
+      }
+      if (v.length > 0) {
+        driverInfo.version = `${driverInfo.version}|${v}`;
+      }
     }
   }
 
@@ -143,10 +144,12 @@ export function makeClientMetadata(options: MakeClientMetadataOptions): ClientMe
   if (platform.length > 0) {
     runtimeInfo = `${runtimeInfo}|${platform}`;
   }
-  if (options.additionalDriverInfo) {
-    const { platform: p = '' } = options.additionalDriverInfo;
-    if (p.length > 0) {
-      runtimeInfo = `${runtimeInfo}|${p}`;
+
+  if (options.additionalDriverInfo.length > 0) {
+    for (const { platform: p = '' } of options.additionalDriverInfo) {
+      if (p.length > 0) {
+        runtimeInfo = `${runtimeInfo}|${p}`;
+      }
     }
   }
 

src/connection_string.ts

@@ -540,6 +540,9 @@ export function parseOptions(
     }
   );
 
+  // Set the default for the additional driver info.
+  mongoOptions.additionalDriverInfo = [];
+
   mongoOptions.metadata = makeClientMetadata(mongoOptions);
 
   mongoOptions.extendedMetadata = addContainerMetadata(mongoOptions.metadata).then(

src/mongo_client.ts

@@ -405,6 +405,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
       | 'crl'
       | 'key'
       | 'cert'
+      | 'driverInfo'
       | 'additionalDriverInfo'
       | 'metadata'
       | 'extendedMetadata'
@@ -417,6 +418,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
       | 'crl'
       | 'key'
       | 'cert'
+      | 'driverInfo'
       | 'additionalDriverInfo'
       | 'metadata'
       | 'extendedMetadata'
@@ -484,7 +486,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * @param driverInfo - Information abou the application or libraary.
    */
   appendMetadata(driverInfo: DriverInfo) {
-    this.options.additionalDriverInfo = driverInfo;
+    this.options.additionalDriverInfo.push(driverInfo);
     this.options.metadata = makeClientMetadata(this.options);
     this.options.extendedMetadata = addContainerMetadata(this.options.metadata)
       .then(undefined, squashError)
@@ -1073,10 +1075,8 @@ export interface MongoOptions
   dbName: string;
   /** @deprecated - Will be made internal in a future major release. */
   metadata: ClientMetadata;
-  /** @internal */
   extendedMetadata: Promise<Document>;
-  /** @internal */
-  additionalDriverInfo: DriverInfo;
+  additionalDriverInfo: DriverInfo[];
   /** @internal */
   autoEncrypter?: AutoEncrypter;
   /** @internal */

test/integration/mongodb-handshake/mongodb-handshake.prose.test.ts

@@ -204,7 +204,7 @@ describe('Client Metadata Update Prose Tests', function () {
     sinon.restore();
   });
 
-  describe('Test 1: Test that the driver updates metadata', function () {
+  describe('Test 2: Multiple Successive Metadata Updates', function () {
     let initialClientMetadata;
     let updatedClientMetadata;
 
@@ -233,7 +233,6 @@ describe('Client Metadata Update Prose Tests', function () {
             {},
             {
               maxIdleTimeMS: 1,
-              monitorCommands: true,
               driverInfo: { name: 'library', version: '1.2', platform: 'Library Platform' }
             }
           );
@@ -285,4 +284,80 @@ describe('Client Metadata Update Prose Tests', function () {
       });
     }
   });
+
+  describe('Test 1: Test that the driver updates metadata', function () {
+    let initialClientMetadata;
+    let updatedClientMetadata;
+
+    const tests = [
+      { testCase: 1, name: 'framework', version: '2.0', platform: 'Framework Platform' },
+      { testCase: 2, name: 'framework', version: '2.0' },
+      { testCase: 3, name: 'framework', platform: 'Framework Platform' },
+      { testCase: 4, name: 'framework' }
+    ];
+
+    for (const { testCase, name, version, platform } of tests) {
+      context(`Case: ${testCase}`, function () {
+        // 1. Create a `MongoClient` instance with the following:
+        //     - `maxIdleTimeMS` set to `1ms`
+        // 2. Append the following `DriverInfoOptions` to the `MongoClient` metadata:
+        //         | Field    | Value            |
+        //         | -------- | ---------------- |
+        //         | name     | library          |
+        //         | version  | 1.2              |
+        //         | platform | Library Platform |
+        // 3. Send a `ping` command to the server and verify that the command succeeds.
+        // 4. Save intercepted `client` document as `updatedClientMetadata`.
+        // 5. Wait 5ms for the connection to become idle.
+        beforeEach(async function () {
+          client = this.configuration.newClient({}, { maxIdleTimeMS: 1 });
+          client.appendMetadata({ name: 'library', version: '1.2', platform: 'Library Platform' });
+
+          sinon.stub(Connection.prototype, 'command').callsFake(async function (ns, cmd, options) {
+            // @ts-expect-error: sinon will place wrappedMethod on the command method.
+            const command = Connection.prototype.command.wrappedMethod.bind(this);
+
+            if (cmd.hello || cmd[LEGACY_HELLO_COMMAND]) {
+              if (!initialClientMetadata) {
+                initialClientMetadata = cmd.client;
+              } else {
+                updatedClientMetadata = cmd.client;
+              }
+            }
+            return command(ns, cmd, options);
+          });
+
+          await client.db('test').command({ ping: 1 });
+          await sleep(5);
+        });
+
+        it('appends the metadata', async function () {
+          // 1. Append the `DriverInfoOptions` from the selected test case to the `MongoClient` metadata.
+          // 2. Send a `ping` command to the server and verify:
+          // - The command succeeds.
+          // - The framework metadata is appended to the existing `DriverInfoOptions` in the `client.driver` fields of the `hello`
+          // command, with values separated by a pipe `|`.
+          client.appendMetadata({ name, version, platform });
+          await client.db('test').command({ ping: 1 });
+
+          expect(updatedClientMetadata.driver.name).to.equal(
+            name
+              ? `${initialClientMetadata.driver.name}|${name}`
+              : initialClientMetadata.driver.name
+          );
+          expect(updatedClientMetadata.driver.version).to.equal(
+            version
+              ? `${initialClientMetadata.driver.version}|${version}`
+              : initialClientMetadata.driver.version
+          );
+          expect(updatedClientMetadata.platform).to.equal(
+            platform
+              ? `${initialClientMetadata.platform}|${platform}`
+              : initialClientMetadata.platform
+          );
+          expect(updatedClientMetadata.os).to.deep.equal(initialClientMetadata.os);
+        });
+      });
+    }
+  });
 });