test(NODE-3461): refactor lb manual to full test run (#2933)

Co-authored-by: Neal Beeken <[email protected]>

Author: durran

.evergreen/config.yml

@@ -169,7 +169,6 @@ functions:
           TOPOLOGY="${TOPOLOGY}" \
           SKIP_DEPS=${SKIP_DEPS|1} \
           NO_EXIT=${NO_EXIT|1} \
-          TEST_NPM_SCRIPT="check:load-balancer" \
           FAKE_MONGODB_SERVICE_ID="true" \
             bash ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
   run checks:

.evergreen/config.yml.in

@@ -192,7 +192,6 @@ functions:
           TOPOLOGY="${TOPOLOGY}" \
           SKIP_DEPS=${SKIP_DEPS|1} \
           NO_EXIT=${NO_EXIT|1} \
-          TEST_NPM_SCRIPT="check:load-balancer" \
           FAKE_MONGODB_SERVICE_ID="true" \
             bash ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
 

package.json

@@ -121,7 +121,6 @@
     "check:ts": "tsc -v && tsc --noEmit",
     "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",
     "check:adl": "mocha test/manual/data_lake.test.js",
-    "check:load-balancer": "mocha test/manual/load-balancer.test.js",
     "check:ocsp": "mocha --config \"test/manual/mocharc.json\" test/manual/ocsp_support.test.js",
     "check:kerberos": "mocha --config \"test/manual/mocharc.json\" test/manual/kerberos.test.js",
     "check:tls": "mocha --config \"test/manual/mocharc.json\" test/manual/tls_support.test.js",

src/db.ts

@@ -319,14 +319,11 @@ export class Db {
    * @param name - the collection name we wish to access.
    * @returns return the new Collection instance
    */
-  collection<TSchema extends Document = Document>(name: string): Collection<TSchema>;
   collection<TSchema extends Document = Document>(
     name: string,
-    options?: CollectionOptions
+    options: CollectionOptions = {}
   ): Collection<TSchema> {
-    if (!options) {
-      options = {};
-    } else if (typeof options === 'function') {
+    if (typeof options === 'function') {
       // TODO(NODE-3485): Replace this with MongoDeprecationError
       throw new MongoDriverError('The callback form of this helper has been removed.');
     }

test/manual/load-balancer.test.js renamed to test/functional/load-balancer-spec.test.js

@@ -15,17 +15,14 @@ const SKIP = [
   //       in sub-optimal pinning.
   'pinned connections are not returned after an network error during getMore',
   'pinned connections are not returned to the pool after a non-network error on getMore',
-  'stale errors are ignored'
+  'stale errors are ignored',
+  // NOTE: The driver correctly fails these 2 tests in non LB mode for server versions greater than 3.4.
+  // In versions that are 3.4 or less an error still occurs but a different one (connection closes).
+  // TODO(NODE-3543): fix the path-ing that will produce errors for older servers
+  'operations against non-load balanced clusters fail if URI contains loadBalanced=true',
+  'operations against non-load balanced clusters succeed if URI contains loadBalanced=false'
 ];
 
-require('../functional/retryable_reads.test');
-require('../functional/retryable_writes.test');
-require('../functional/uri_options_spec.test');
-require('../functional/change_stream_spec.test');
-require('../functional/versioned-api.test');
-require('../unit/core/mongodb_srv.test');
-require('../unit/sdam/server_selection/spec.test');
-
 describe('Load Balancer Unified Tests', function () {
   this.timeout(10000);
   runUnifiedSuite(loadSpecTests(path.join('load-balancers')), SKIP);

test/functional/unified-spec-runner/entities.ts

@@ -4,7 +4,8 @@ import {
   Collection,
   GridFSBucket,
   Document,
-  HostAddress
+  HostAddress,
+  ServerApiVersion
 } from '../../../src/index';
 import { ReadConcern } from '../../../src/read_concern';
 import { WriteConcern } from '../../../src/write_concern';
@@ -30,7 +31,7 @@ import type {
   CommandStartedEvent,
   CommandSucceededEvent
 } from '../../../src/cmap/command_monitoring_events';
-import { patchCollectionOptions, patchDbOptions } from './unified-utils';
+import { makeConnectionString, patchCollectionOptions, patchDbOptions } from './unified-utils';
 import { expect } from 'chai';
 import { TestConfiguration, trace } from './runner';
 
@@ -53,7 +54,7 @@ export type CmapEvent =
 
 function serverApiConfig() {
   if (process.env.MONGODB_API_VERSION) {
-    return { version: process.env.MONGODB_API_VERSION };
+    return { version: process.env.MONGODB_API_VERSION as ServerApiVersion };
   }
 }
 
@@ -102,12 +103,12 @@ export class UnifiedMongoClient extends MongoClient {
     connectionCheckedInEvent: 'connectionCheckedIn'
   } as const;
 
-  constructor(url: string, description: ClientEntity) {
-    super(url, {
+  constructor(uri: string, description: ClientEntity) {
+    super(uri, {
       monitorCommands: true,
-      ...description.uriOptions,
       serverApi: description.serverApi ? description.serverApi : serverApiConfig()
     });
+
     this.commandEvents = [];
     this.cmapEvents = [];
     this.failPoints = [];
@@ -329,7 +330,10 @@ export class EntitiesMap<E = Entity> extends Map<string, E> {
         const useMultipleMongoses =
           (config.topologyType === 'LoadBalanced' || config.topologyType === 'Sharded') &&
           entity.client.useMultipleMongoses;
-        const uri = config.url({ useMultipleMongoses });
+        const uri = makeConnectionString(
+          config.url({ useMultipleMongoses }),
+          entity.client.uriOptions
+        );
         const client = new UnifiedMongoClient(uri, entity.client);
         await client.connect();
         map.set(entity.client.id, client);

test/functional/unified-spec-runner/match.ts

@@ -326,29 +326,31 @@ export function expectErrorCheck(
     return;
   }
 
+  const expectMessage = `\n\nOriginal Error Stack:\n${error.stack}\n\n`;
+
   if (expected.errorContains != null) {
-    expect(error.message).to.include(expected.errorContains);
+    expect(error.message, expectMessage).to.include(expected.errorContains);
   }
 
   if (!(error instanceof MongoError)) {
     // if statement asserts type for TS, expect will always fail
-    expect(error).to.be.instanceOf(MongoError);
+    expect(error, expectMessage).to.be.instanceOf(MongoError);
     return;
   }
 
   if (expected.errorCode != null) {
-    expect(error).to.have.property('code', expected.errorCode);
+    expect(error, expectMessage).to.have.property('code', expected.errorCode);
   }
 
   if (expected.errorCodeName != null) {
-    expect(error).to.have.property('codeName', expected.errorCodeName);
+    expect(error, expectMessage).to.have.property('codeName', expected.errorCodeName);
   }
 
   if (expected.errorLabelsContain != null) {
     for (const errorLabel of expected.errorLabelsContain) {
       expect(
         error.hasErrorLabel(errorLabel),
-        `Error was supposed to have label ${errorLabel}, has [${error.errorLabels}]`
+        `Error was supposed to have label ${errorLabel}, has [${error.errorLabels}] -- ${expectMessage}`
       ).to.be.true;
     }
   }
@@ -357,7 +359,7 @@ export function expectErrorCheck(
     for (const errorLabel of expected.errorLabelsOmit) {
       expect(
         error.hasErrorLabel(errorLabel),
-        `Error was supposed to have label ${errorLabel}, has [${error.errorLabels}]`
+        `Error was supposed to have label ${errorLabel}, has [${error.errorLabels}] -- ${expectMessage}`
       ).to.be.false;
     }
   }

test/functional/unified-spec-runner/schema.ts

@@ -1,3 +1,4 @@
+import { ServerApiVersion } from '../../../src';
 import type { Document, ObjectId } from '../../../src/bson';
 import type { ReadConcernLevel } from '../../../src/read_concern';
 import type { ReadPreferenceMode } from '../../../src/read_preference';
@@ -96,7 +97,7 @@ export type EntityDescription =
   | { stream: StreamEntity }
   | { session: SessionEntity };
 export interface ServerApi {
-  version: string;
+  version: ServerApiVersion;
   strict?: boolean;
   deprecationErrors?: boolean;
 }

test/functional/unified-spec-runner/unified-utils.ts

@@ -5,6 +5,7 @@ import { gte as semverGte, lte as semverLte } from 'semver';
 import { CollectionOptions, DbOptions, MongoClient } from '../../../src';
 import { isDeepStrictEqual } from 'util';
 import { TestConfiguration } from './runner';
+import ConnectionString from 'mongodb-connection-string-url';
 
 const ENABLE_UNIFIED_TEST_LOGGING = false;
 export function log(message: unknown, ...optionalParameters: unknown[]): void {
@@ -98,3 +99,14 @@ export function translateOptions(options: Document): Document {
   }
   return translatedOptions as Document;
 }
+
+export function makeConnectionString(
+  uri: string,
+  uriOptions: Record<string, unknown> = {}
+): string {
+  const connectionString = new ConnectionString(uri);
+  for (const [name, value] of Object.entries(uriOptions ?? {})) {
+    connectionString.searchParams.set(name, String(value));
+  }
+  return connectionString.toString();
+}

test/tools/runner/index.js

@@ -1,5 +1,9 @@
 'use strict';
 
+require('source-map-support').install({
+  hookRequire: true
+});
+
 const path = require('path');
 const fs = require('fs');
 const { MongoClient } = require('../../../src');
@@ -66,7 +70,8 @@ before(function (_done) {
   // );
 
   const options = MONGODB_API_VERSION ? { serverApi: MONGODB_API_VERSION } : {};
-  const client = new MongoClient(MONGODB_URI, options);
+  const loadBalanced = SINGLE_MONGOS_LB_URI && MULTI_MONGOS_LB_URI;
+  const client = new MongoClient(loadBalanced ? SINGLE_MONGOS_LB_URI : MONGODB_URI, options);
   const done = err => client.close(err2 => _done(err || err2));
 
   client.connect(err => {