More fix up and aligning with spec

Author: nbbeeken

src/sdam/topology_description.ts

@@ -201,6 +201,7 @@ export class TopologyDescription {
     let { type: topologyType, setName, maxSetVersion, maxElectionId, commonWireVersion } = this;
 
     if (serverDescription.setName && setName && serverDescription.setName !== setName) {
+      // TODO(NODE-XXXX): servers with an incorrect setName should be removed not marked Unknown
       serverDescription = new ServerDescription(address, undefined);
     }
 

test/spec/server-discovery-and-monitoring/rs/secondary_ignore_ok_0.json

@@ -1,5 +1,5 @@
 {
-  "description": "New primary",
+  "description": "Secondary ignored when ok is zero",
   "uri": "mongodb://a,b/?replicaSet=rs",
   "phases": [
     {

test/spec/server-discovery-and-monitoring/rs/secondary_ignore_ok_0.yml

@@ -1,4 +1,4 @@
-description: "New primary"
+description: "Secondary ignored when ok is zero"
 
 uri: "mongodb://a,b/?replicaSet=rs"
 

test/tools/utils.ts

@@ -1,9 +1,9 @@
 import { EJSON } from 'bson';
 import { expect } from 'chai';
-import util from 'util';
+import { inspect } from 'util';
 
 import { Logger } from '../../src/logger';
-import { deprecateOptions, DeprecateOptionsConfig } from '../../src/utils';
+import { deprecateOptions, DeprecateOptionsConfig, setDifference } from '../../src/utils';
 
 export function makeTestFunction(config: DeprecateOptionsConfig) {
   const fn = (options: any) => {
@@ -189,15 +189,15 @@ export function shouldRunServerlessTest(testRequirement: any, isServerless: any)
  * Attempts to use EJSON (to make type information obvious)
  * falls back to util.inspect if there's an error (circular reference)
  */
-export function ejson(strings: any[], ...values: any[]) {
+export function ejson(strings: TemplateStringsArray, ...values: any[]) {
   const stringParts = [strings[0]];
   for (const [idx, value] of values.entries()) {
     if (typeof value === 'object') {
       let stringifiedObject: string;
       try {
         stringifiedObject = EJSON.stringify(value, { relaxed: false });
       } catch (error) {
-        stringifiedObject = util.inspect(value, {
+        stringifiedObject = inspect(value, {
           depth: Infinity,
           showHidden: true,
           compact: true
@@ -270,6 +270,31 @@ export function extractAuthFromConnectionString(connectionString: string | any[]
   return connectionString.slice(indices.start, indices.end);
 }
 
+/**
+ * Ensures no extra keys are provided on an object
+ * @param knownKeys - the super set of keys allowed to exist on objectWithKeys
+ * @param objectWithKeys - An object (usually from JSON) that has an unknown amount of keys
+ *
+ * Users should combine the usage of this helper with an interface
+ * ```ts
+ * interface Pet { name: string }
+ * const maybePet: any = { name: 'spot', age: number };
+ * assertSubsetOfKeys<Pet>(['name'], maybePet); // throws!
+ * assertSubsetOfKeys<Pet>(['name', 'age'], maybePet); // compiler error! (age not defined)
+ * assertSubsetOfKeys<Pet>([], maybePet); // compiler error! (missing keys)
+ * ```
+ */
+export function assertNoExtraKeys<T extends { [k: string]: any }>(
+  knownKeys: Array<keyof Required<T>>,
+  objectWithKeys: Partial<T>
+): asserts objectWithKeys is { [P in keyof T]-?: T[P] } {
+  expect(knownKeys).to.have.lengthOf(knownKeys.length);
+  const subsetKeys = Object.keys(objectWithKeys);
+  const difference = Array.from(setDifference(subsetKeys, knownKeys));
+  const message = `Expected no extra keys. Found: [${difference.join(', ')}]`;
+  expect(difference, message).to.be.empty;
+}
+
 export interface FailPoint {
   configureFailPoint: 'failCommand';
   mode: { activationProbability: number } | { times: number } | 'alwaysOn' | 'off';