Update signature of identifyServerName to take and options object and only adminCommand

Author: kraenhansen

packages/mongodb-build-info/src/index.ts

@@ -143,12 +143,20 @@ export function getGenuineMongoDB(uri: string): {
   };
 }
 
-export async function identifyServerName(
-  uri: string,
-  runCommand: (command: Document) => Promise<Document>,
-  adminCommand: (command: Document) => Promise<Document>,
-): Promise<string> {
-  const hostname = getHostnameFromUrl(uri);
+type IdentifyServerNameOptions = {
+  connectionString: string;
+  adminCommand: (command: Document) => Promise<Document>;
+};
+
+/**
+ * Identify the server name based on connection string and server responses.
+ * @returns A name of the server, "unknown" if we fail to identify it.
+ */
+export async function identifyServerName({
+  connectionString,
+  adminCommand,
+}: IdentifyServerNameOptions): Promise<string> {
+  const hostname = getHostnameFromUrl(connectionString);
   if (hostname.match(COSMOS_DB_REGEX)) {
     return 'cosmosdb';
   }

packages/mongodb-build-info/test/index.spec.ts

@@ -437,30 +437,39 @@ describe('mongodb-build-info', function () {
     }
 
     it('reports CosmosDB', async function () {
-      for (const uri of fixtures.COSMOS_DB_URI) {
-        const result = await identifyServerName(uri, fail, fail);
+      for (const connectionString of fixtures.COSMOS_DB_URI) {
+        const result = await identifyServerName({
+          connectionString,
+          adminCommand: fail,
+        });
         expect(result).to.equal('cosmosdb');
       }
     });
 
     it('reports DocumentDB', async function () {
-      for (const uri of fixtures.DOCUMENT_DB_URIS) {
-        const result = await identifyServerName(uri, fail, fail);
+      for (const connectionString of fixtures.DOCUMENT_DB_URIS) {
+        const result = await identifyServerName({
+          connectionString,
+          adminCommand: fail,
+        });
         expect(result).to.equal('documentdb');
       }
     });
 
     it('reports Firestore', async function () {
-      for (const uri of fixtures.FIRESTORE_URIS) {
-        const result = await identifyServerName(uri, fail, fail);
+      for (const connectionString of fixtures.FIRESTORE_URIS) {
+        const result = await identifyServerName({
+          connectionString,
+          adminCommand: fail,
+        });
         expect(result).to.equal('firestore');
       }
     });
 
     it('reports FerretDB', async function () {
-      const result = await identifyServerName(
-        '',
-        (req) => {
+      const result = await identifyServerName({
+        connectionString: '',
+        adminCommand(req) {
           if ('buildInfo' in req) {
             return Promise.resolve({
               ferretdb: {},
@@ -469,16 +478,14 @@ describe('mongodb-build-info', function () {
             return Promise.resolve({});
           }
         },
-        fail,
-      );
+      });
       expect(result).to.equal('ferretdb');
     });
 
     it('reports PG DocumentDB', async function () {
-      const result = await identifyServerName(
-        '',
-        () => Promise.resolve({}),
-        (req) => {
+      const result = await identifyServerName({
+        connectionString: '',
+        adminCommand(req) {
           if ('getParameter' in req) {
             return Promise.reject(
               new Error(
@@ -489,7 +496,7 @@ describe('mongodb-build-info', function () {
             return Promise.resolve({});
           }
         },
-      );
+      });
       expect(result).to.equal('pg_documentdb');
     });
   });