feat(NODE-3517): improve index spec handling and type definitions (#3315)

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

Author: aditi-khare-mongoDB

src/cmap/connection.ts

@@ -594,11 +594,33 @@ export class CryptoConnection extends Connection {
       return;
     }
 
+    // Save sort or indexKeys based on the command being run
+    // the encrypt API serializes our JS objects to BSON to pass to the native code layer
+    // and then deserializes the encrypted result, the protocol level components
+    // of the command (ex. sort) are then converted to JS objects potentially losing
+    // import key order information. These fields are never encrypted so we can save the values
+    // from before the encryption and replace them after encryption has been performed
+    const sort: Map<string, number> | null = cmd.find || cmd.findAndModify ? cmd.sort : null;
+    const indexKeys: Map<string, number>[] | null = cmd.createIndexes
+      ? cmd.indexes.map((index: { key: Map<string, number> }) => index.key)
+      : null;
+
     autoEncrypter.encrypt(ns.toString(), cmd, options, (err, encrypted) => {
       if (err || encrypted == null) {
         callback(err, null);
         return;
       }
+
+      // Replace the saved values
+      if (sort != null && (cmd.find || cmd.findAndModify)) {
+        encrypted.sort = sort;
+      }
+      if (indexKeys != null && cmd.createIndexes) {
+        for (const [offset, index] of indexKeys.entries()) {
+          encrypted.indexes[offset].key = index;
+        }
+      }
+
       super.command(ns, encrypted, options, (err, response) => {
         if (err || response == null) {
           callback(err, response);

src/operations/indexes.ts

@@ -6,7 +6,7 @@ import type { OneOrMore } from '../mongo_types';
 import { ReadPreference } from '../read_preference';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
-import { Callback, maxWireVersion, MongoDBNamespace, parseIndexOptions } from '../utils';
+import { Callback, isObject, maxWireVersion, MongoDBNamespace } from '../utils';
 import {
   CollationOptions,
   CommandOperation,
@@ -51,14 +51,17 @@ const VALID_INDEX_OPTIONS = new Set([
 
 /** @public */
 export type IndexDirection = -1 | 1 | '2d' | '2dsphere' | 'text' | 'geoHaystack' | number;
-
+function isIndexDirection(x: unknown): x is IndexDirection {
+  return (
+    typeof x === 'number' || x === '2d' || x === '2dsphere' || x === 'text' || x === 'geoHaystack'
+  );
+}
 /** @public */
 export type IndexSpecification = OneOrMore<
   | string
   | [string, IndexDirection]
   | { [key: string]: IndexDirection }
-  | [string, IndexDirection][]
-  | { [key: string]: IndexDirection }[]
+  | Map<string, IndexDirection>
 >;
 
 /** @public */
@@ -86,7 +89,7 @@ export interface IndexDescription
   > {
   collation?: CollationOptions;
   name?: string;
-  key: Document;
+  key: { [key: string]: IndexDirection } | Map<string, IndexDirection>;
 }
 
 /** @public */
@@ -130,23 +133,37 @@ export interface CreateIndexesOptions extends CommandOperationOptions {
   hidden?: boolean;
 }
 
-function makeIndexSpec(indexSpec: IndexSpecification, options: any): IndexDescription {
-  const indexParameters = parseIndexOptions(indexSpec);
-
-  // Generate the index name
-  const name = typeof options.name === 'string' ? options.name : indexParameters.name;
-
-  // Set up the index
-  const finalIndexSpec: Document = { name, key: indexParameters.fieldHash };
+function isSingleIndexTuple(t: unknown): t is [string, IndexDirection] {
+  return Array.isArray(t) && t.length === 2 && isIndexDirection(t[1]);
+}
 
-  // merge valid index options into the index spec
-  for (const optionName in options) {
-    if (VALID_INDEX_OPTIONS.has(optionName)) {
-      finalIndexSpec[optionName] = options[optionName];
+function makeIndexSpec(
+  indexSpec: IndexSpecification,
+  options?: CreateIndexesOptions
+): IndexDescription {
+  const key: Map<string, IndexDirection> = new Map();
+
+  const indexSpecs =
+    !Array.isArray(indexSpec) || isSingleIndexTuple(indexSpec) ? [indexSpec] : indexSpec;
+
+  // Iterate through array and handle different types
+  for (const spec of indexSpecs) {
+    if (typeof spec === 'string') {
+      key.set(spec, 1);
+    } else if (Array.isArray(spec)) {
+      key.set(spec[0], spec[1] ?? 1);
+    } else if (spec instanceof Map) {
+      for (const [property, value] of spec) {
+        key.set(property, value);
+      }
+    } else if (isObject(spec)) {
+      for (const [property, value] of Object.entries(spec)) {
+        key.set(property, value);
+      }
     }
   }
 
-  return finalIndexSpec as IndexDescription;
+  return { ...options, key };
 }
 
 /** @internal */
@@ -183,7 +200,7 @@ export class CreateIndexesOperation<
 > extends CommandOperation<T> {
   override options: CreateIndexesOptions;
   collectionName: string;
-  indexes: IndexDescription[];
+  indexes: ReadonlyArray<Omit<IndexDescription, 'key'> & { key: Map<string, IndexDirection> }>;
 
   constructor(
     parent: OperationParent,
@@ -195,8 +212,22 @@ export class CreateIndexesOperation<
 
     this.options = options ?? {};
     this.collectionName = collectionName;
-
-    this.indexes = indexes;
+    this.indexes = indexes.map(userIndex => {
+      // Ensure the key is a Map to preserve index key ordering
+      const key =
+        userIndex.key instanceof Map ? userIndex.key : new Map(Object.entries(userIndex.key));
+      const name = userIndex.name != null ? userIndex.name : Array.from(key).flat().join('_');
+      const validIndexOptions = Object.fromEntries(
+        Object.entries({ ...userIndex }).filter(([optionName]) =>
+          VALID_INDEX_OPTIONS.has(optionName)
+        )
+      );
+      return {
+        ...validIndexOptions,
+        name,
+        key
+      };
+    });
   }
 
   override execute(
@@ -209,31 +240,6 @@ export class CreateIndexesOperation<
 
     const serverWireVersion = maxWireVersion(server);
 
-    // Ensure we generate the correct name if the parameter is not set
-    for (let i = 0; i < indexes.length; i++) {
-      // Did the user pass in a collation, check if our write server supports it
-      if (indexes[i].collation && serverWireVersion < 5) {
-        callback(
-          new MongoCompatibilityError(
-            `Server ${server.name}, which reports wire version ${serverWireVersion}, ` +
-              'does not support collation'
-          )
-        );
-        return;
-      }
-
-      if (indexes[i].name == null) {
-        const keys = [];
-
-        for (const name in indexes[i].key) {
-          keys.push(`${name}_${indexes[i].key[name]}`);
-        }
-
-        // Set the name
-        indexes[i].name = keys.join('_');
-      }
-    }
-
     const cmd: Document = { createIndexes: this.collectionName, indexes };
 
     if (options.commitQuorum != null) {
@@ -271,12 +277,6 @@ export class CreateIndexOperation extends CreateIndexesOperation<string> {
     indexSpec: IndexSpecification,
     options?: CreateIndexesOptions
   ) {
-    // createIndex can be called with a variety of styles:
-    //   coll.createIndex('a');
-    //   coll.createIndex({ a: 1 });
-    //   coll.createIndex([['a', 1]]);
-    // createIndexes is always called with an array of index spec objects
-
     super(parent, collectionName, [makeIndexSpec(indexSpec, options)], options);
   }
   override execute(

src/utils.ts

@@ -23,7 +23,6 @@ import {
 import type { Explain } from './explain';
 import type { MongoClient } from './mongo_client';
 import type { CommandOperationOptions, OperationParent } from './operations/command';
-import type { IndexDirection, IndexSpecification } from './operations/indexes';
 import type { Hint, OperationOptions } from './operations/operation';
 import { PromiseProvider } from './promise_provider';
 import { ReadConcern } from './read_concern';
@@ -104,63 +103,6 @@ export function normalizeHintField(hint?: Hint): Hint | undefined {
   return finalHint;
 }
 
-interface IndexOptions {
-  name: string;
-  keys?: string[];
-  fieldHash: Document;
-}
-
-/**
- * Create an index specifier based on
- * @internal
- */
-export function parseIndexOptions(indexSpec: IndexSpecification): IndexOptions {
-  const fieldHash: { [key: string]: IndexDirection } = {};
-  const indexes = [];
-  let keys;
-
-  // Get all the fields accordingly
-  if ('string' === typeof indexSpec) {
-    // 'type'
-    indexes.push(indexSpec + '_' + 1);
-    fieldHash[indexSpec] = 1;
-  } else if (Array.isArray(indexSpec)) {
-    indexSpec.forEach((f: any) => {
-      if ('string' === typeof f) {
-        // [{location:'2d'}, 'type']
-        indexes.push(f + '_' + 1);
-        fieldHash[f] = 1;
-      } else if (Array.isArray(f)) {
-        // [['location', '2d'],['type', 1]]
-        indexes.push(f[0] + '_' + (f[1] || 1));
-        fieldHash[f[0]] = f[1] || 1;
-      } else if (isObject(f)) {
-        // [{location:'2d'}, {type:1}]
-        keys = Object.keys(f);
-        keys.forEach(k => {
-          indexes.push(k + '_' + (f as AnyOptions)[k]);
-          fieldHash[k] = (f as AnyOptions)[k];
-        });
-      } else {
-        // undefined (ignore)
-      }
-    });
-  } else if (isObject(indexSpec)) {
-    // {location:'2d', type:1}
-    keys = Object.keys(indexSpec);
-    Object.entries(indexSpec).forEach(([key, value]) => {
-      indexes.push(key + '_' + value);
-      fieldHash[key] = value;
-    });
-  }
-
-  return {
-    name: indexes.join('_'),
-    keys: keys,
-    fieldHash: fieldHash
-  };
-}
-
 const TO_STRING = (object: unknown) => Object.prototype.toString.call(object);
 /**
  * Checks if arg is an Object: