revert(NODE-3784): Add enableUtf8Validation option" (#3073)

mongodb · Dec 9, 2021 · 3c041f4 · 3c041f4
1 parent 9237d72
commit 3c041f4
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 222 deletions.
diff --git a/src/bson.ts b/src/bson.ts
@@ -55,9 +55,6 @@ export interface BSONSerializeOptions
     > {
   /** Return BSON filled buffers from operations */
   raw?: boolean;
-
-  /** Enable utf8 validation when deserializing BSON documents.  Defaults to true. */
-  enableUtf8Validation?: boolean;
 }
 
 export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSerializeOptions {
@@ -69,8 +66,7 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
     serializeFunctions,
     ignoreUndefined,
     bsonRegExp,
-    raw,
-    enableUtf8Validation
+    raw
   } = options;
   return {
     fieldsAsRaw,
@@ -80,8 +76,7 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
     serializeFunctions,
     ignoreUndefined,
     bsonRegExp,
-    raw,
-    enableUtf8Validation
+    raw
   };
 }
 
@@ -104,8 +99,6 @@ export function resolveBSONOptions(
     ignoreUndefined: options?.ignoreUndefined ?? parentOptions?.ignoreUndefined ?? false,
     bsonRegExp: options?.bsonRegExp ?? parentOptions?.bsonRegExp ?? false,
     serializeFunctions: options?.serializeFunctions ?? parentOptions?.serializeFunctions ?? false,
-    fieldsAsRaw: options?.fieldsAsRaw ?? parentOptions?.fieldsAsRaw ?? {},
-    enableUtf8Validation:
-      options?.enableUtf8Validation ?? parentOptions?.enableUtf8Validation ?? true
+    fieldsAsRaw: options?.fieldsAsRaw ?? parentOptions?.fieldsAsRaw ?? {}
   };
 }
diff --git a/src/cmap/commands.ts b/src/cmap/commands.ts
@@ -469,6 +469,8 @@ export interface MessageHeader {
 export interface OpResponseOptions extends BSONSerializeOptions {
   raw?: boolean;
   documentsReturnedIn?: string | null;
+  // For now we use this internally to only prevent writeErrors from crashing the driver
+  validation?: { utf8: { writeErrors: boolean } };
 }
 
 /** @internal */
@@ -837,7 +839,7 @@ export class BinMsg {
     const promoteValues = options.promoteValues ?? this.opts.promoteValues;
     const promoteBuffers = options.promoteBuffers ?? this.opts.promoteBuffers;
     const bsonRegExp = options.bsonRegExp ?? this.opts.bsonRegExp;
-    const validation = this.parseBsonSerializationOptions(options);
+    const validation = options.validation ?? { utf8: { writeErrors: false } };
 
     // Set up the options
     const bsonOptions: BSONSerializeOptions = {
@@ -874,14 +876,4 @@ export class BinMsg {
 
     this.parsed = true;
   }
-
-  parseBsonSerializationOptions({ enableUtf8Validation }: BSONSerializeOptions): {
-    utf8: { writeErrors: false } | false;
-  } {
-    if (enableUtf8Validation === false) {
-      return { utf8: false };
-    }
-
-    return { utf8: { writeErrors: false } };
-  }
 }
diff --git a/src/cmap/connection.ts b/src/cmap/connection.ts
@@ -787,8 +787,6 @@ function write(
     promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
     promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
     bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false,
-    enableUtf8Validation:
-      typeof options.enableUtf8Validation === 'boolean' ? options.enableUtf8Validation : true,
     raw: typeof options.raw === 'boolean' ? options.raw : false,
     started: 0
   };

diff --git a/src/cmap/wire_protocol/shared.ts b/src/cmap/wire_protocol/shared.ts
@@ -45,9 +45,7 @@ export function applyCommonQueryOptions(
     promoteLongs: typeof options.promoteLongs === 'boolean' ? options.promoteLongs : true,
     promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
     promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
-    bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false,
-    enableUtf8Validation:
-      typeof options.enableUtf8Validation === 'boolean' ? options.enableUtf8Validation : true
+    bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false
   });
 
   if (options.session) {

diff --git a/src/connection_string.ts b/src/connection_string.ts
@@ -688,7 +688,6 @@ export const OPTIONS = {
       });
     }
   },
-  enableUtf8Validation: { type: 'boolean', default: true },
   family: {
     transform({ name, values: [value] }): 4 | 6 {
       const transformValue = getInt(name, value);

diff --git a/src/db.ts b/src/db.ts
@@ -73,7 +73,6 @@ const DB_OPTIONS_ALLOW_LIST = [
   'promoteBuffers',
   'promoteLongs',
   'bsonRegExp',
-  'enableUtf8Validation',
   'promoteValues',
   'compression',
   'retryWrites'

diff --git a/src/operations/create_collection.ts b/src/operations/create_collection.ts
@@ -27,8 +27,7 @@ const ILLEGAL_COMMAND_FIELDS = new Set([
   'promoteBuffers',
   'bsonRegExp',
   'serializeFunctions',
-  'ignoreUndefined',
-  'enableUtf8Validation'
+  'ignoreUndefined'
 ]);
 
 /** @public

diff --git a/src/operations/map_reduce.ts b/src/operations/map_reduce.ts
@@ -33,7 +33,6 @@ const exclusionList = [
   'bsonRegExp',
   'serializeFunctions',
   'ignoreUndefined',
-  'enableUtf8Validation',
   'scope' // this option is reformatted thus exclude the original
 ];
 

diff --git a/test/functional/cmap/commands.test.ts b/test/functional/cmap/commands.test.ts
diff --git a/test/types/bson.test-d.ts b/test/types/bson.test-d.ts
@@ -21,7 +21,6 @@ type PermittedBSONOptionKeys =
   | 'promoteValues'
   | 'bsonRegExp'
   | 'fieldsAsRaw'
-  | 'enableUtf8Validation'
   | 'raw';
 
 const keys = null as unknown as PermittedBSONOptionKeys;