feat(NODE-4892)!: error on bson types not from this version

mongodb · Dec 15, 2022 · 1be51f5 · 1be51f5
1 parent 95d5edf
commit 1be51f5
Show file tree

Hide file tree

Showing 24 changed files with 292 additions and 606 deletions.
diff --git a/src/binary.ts b/src/binary.ts
@@ -31,6 +31,10 @@ export class Binary {
   get _bsontype(): 'Binary' {
     return 'Binary';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   /**
    * Binary default subtype
@@ -305,6 +309,11 @@ const UUID_BYTE_LENGTH = 16;
  * @public
  */
 export class UUID extends Binary {
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
+
   static cacheHexString: boolean;
 
   /** UUID hexString cache @internal */

diff --git a/src/code.ts b/src/code.ts
@@ -15,6 +15,10 @@ export class Code {
   get _bsontype(): 'Code' {
     return 'Code';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   code: string;
 

diff --git a/src/db_ref.ts b/src/db_ref.ts
@@ -32,6 +32,10 @@ export class DBRef {
   get _bsontype(): 'DBRef' {
     return 'DBRef';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   collection!: string;
   oid!: ObjectId;

diff --git a/src/decimal128.ts b/src/decimal128.ts
@@ -130,6 +130,10 @@ export class Decimal128 {
   get _bsontype(): 'Decimal128' {
     return 'Decimal128';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   readonly bytes!: Uint8Array;
 

diff --git a/src/double.ts b/src/double.ts
@@ -14,6 +14,10 @@ export class Double {
   get _bsontype(): 'Double' {
     return 'Double';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   value!: number;
   /**

diff --git a/src/extended_json.ts b/src/extended_json.ts
@@ -275,13 +275,9 @@ const BSON_TYPE_MAPPINGS = {
     ),
   MaxKey: () => new MaxKey(),
   MinKey: () => new MinKey(),
-  ObjectID: (o: ObjectId) => new ObjectId(o),
-  // The _bsontype for ObjectId is spelled with a capital "D", to the mapping above will be used (most of the time)
-  // specifically BSON versions 4.0.0 and 4.0.1 the _bsontype was changed to "ObjectId" so we keep this mapping to support
-  // those version of BSON
   ObjectId: (o: ObjectId) => new ObjectId(o),
   BSONRegExp: (o: BSONRegExp) => new BSONRegExp(o.pattern, o.options),
-  Symbol: (o: BSONSymbol) => new BSONSymbol(o.value),
+  BSONSymbol: (o: BSONSymbol) => new BSONSymbol(o.value),
   Timestamp: (o: Timestamp) => Timestamp.fromBits(o.low, o.high)
 } as const;
 
@@ -312,6 +308,13 @@ function serializeDocument(doc: any, options: EJSONSerializeOptions) {
       }
     }
     return _doc;
+  } else if (
+    doc != null &&
+    typeof doc === 'object' &&
+    typeof doc._bsontype === 'string' &&
+    doc[Symbol.for('@@mdb.bson.version')] == null
+  ) {
+    throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
   } else if (isBSONType(doc)) {
     // the "document" is really just a BSON type object
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/src/int_32.ts b/src/int_32.ts
@@ -14,6 +14,10 @@ export class Int32 {
   get _bsontype(): 'Int32' {
     return 'Int32';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   value!: number;
   /**

diff --git a/src/long.ts b/src/long.ts
@@ -102,6 +102,10 @@ export class Long {
   get _bsontype(): 'Long' {
     return 'Long';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   /** An indicator used to reliably determine if an object is a Long or not. */
   get __isLong__(): boolean {

diff --git a/src/max_key.ts b/src/max_key.ts
@@ -12,6 +12,10 @@ export class MaxKey {
   get _bsontype(): 'MaxKey' {
     return 'MaxKey';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   /** @internal */
   toExtendedJSON(): MaxKeyExtended {

diff --git a/src/min_key.ts b/src/min_key.ts
@@ -12,6 +12,10 @@ export class MinKey {
   get _bsontype(): 'MinKey' {
     return 'MinKey';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   /** @internal */
   toExtendedJSON(): MinKeyExtended {

diff --git a/src/objectid.ts b/src/objectid.ts
@@ -28,8 +28,12 @@ const kId = Symbol('id');
  * @category BSONType
  */
 export class ObjectId {
-  get _bsontype(): 'ObjectID' {
-    return 'ObjectID';
+  get _bsontype(): 'ObjectId' {
+    return 'ObjectId';
+  }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
   }
 
   /** @internal */

diff --git a/src/parser/calculate_size.ts b/src/parser/calculate_size.ts
@@ -79,7 +79,7 @@ function calculateElement(
     case 'object':
       if (value == null || value['_bsontype'] === 'MinKey' || value['_bsontype'] === 'MaxKey') {
         return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + 1;
-      } else if (value['_bsontype'] === 'ObjectId' || value['_bsontype'] === 'ObjectID') {
+      } else if (value['_bsontype'] === 'ObjectId') {
         return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (12 + 1);
       } else if (value instanceof Date || isDate(value)) {
         return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (8 + 1);

diff --git a/src/parser/serializer.ts b/src/parser/serializer.ts
@@ -685,13 +685,11 @@ export function serializeInto(
         index = serializeNull(buffer, key, value, index);
       } else if (value === null) {
         index = serializeNull(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'ObjectId' || value['_bsontype'] === 'ObjectID') {
-        index = serializeObjectId(buffer, key, value, index);
       } else if (isUint8Array(value)) {
         index = serializeBuffer(buffer, key, value, index);
       } else if (value instanceof RegExp || isRegExp(value)) {
         index = serializeRegExp(buffer, key, value, index);
-      } else if (typeof value === 'object' && value['_bsontype'] == null) {
+      } else if (typeof value === 'object' && value._bsontype == null) {
         index = serializeObject(
           buffer,
           key,
@@ -703,19 +701,23 @@ export function serializeInto(
           ignoreUndefined,
           path
         );
+      } else if (typeof value === 'object' && value[Symbol.for('@@mdb.bson.version')] == null) {
+        throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+      } else if (value._bsontype === 'ObjectId') {
+        index = serializeObjectId(buffer, key, value, index);
       } else if (
         typeof value === 'object' &&
         isBSONType(value) &&
         value._bsontype === 'Decimal128'
       ) {
         index = serializeDecimal128(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Long' || value['_bsontype'] === 'Timestamp') {
+      } else if (value._bsontype === 'Long' || value._bsontype === 'Timestamp') {
         index = serializeLong(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Double') {
+      } else if (value._bsontype === 'Double') {
         index = serializeDouble(buffer, key, value, index);
       } else if (typeof value === 'function' && serializeFunctions) {
         index = serializeFunction(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Code') {
+      } else if (value._bsontype === 'Code') {
         index = serializeCode(
           buffer,
           key,
@@ -727,20 +729,20 @@ export function serializeInto(
           ignoreUndefined,
           path
         );
-      } else if (value['_bsontype'] === 'Binary') {
+      } else if (value._bsontype === 'Binary') {
         index = serializeBinary(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Symbol') {
+      } else if (value._bsontype === 'Symbol') {
         index = serializeSymbol(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'DBRef') {
+      } else if (value._bsontype === 'DBRef') {
         index = serializeDBRef(buffer, key, value, index, depth, serializeFunctions, path);
-      } else if (value['_bsontype'] === 'BSONRegExp') {
+      } else if (value._bsontype === 'BSONRegExp') {
         index = serializeBSONRegExp(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Int32') {
+      } else if (value._bsontype === 'Int32') {
         index = serializeInt32(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'MinKey' || value['_bsontype'] === 'MaxKey') {
+      } else if (value._bsontype === 'MinKey' || value._bsontype === 'MaxKey') {
         index = serializeMinMax(buffer, key, value, index);
-      } else if (typeof value['_bsontype'] !== 'undefined') {
-        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value['_bsontype'])}`);
+      } else if (typeof value._bsontype !== 'undefined') {
+        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value._bsontype)}`);
       }
     }
   } else if (object instanceof Map || isMap(object)) {
@@ -790,13 +792,11 @@ export function serializeInto(
         index = serializeDate(buffer, key, value, index);
       } else if (value === null || (value === undefined && ignoreUndefined === false)) {
         index = serializeNull(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'ObjectId' || value['_bsontype'] === 'ObjectID') {
-        index = serializeObjectId(buffer, key, value, index);
       } else if (isUint8Array(value)) {
         index = serializeBuffer(buffer, key, value, index);
       } else if (value instanceof RegExp || isRegExp(value)) {
         index = serializeRegExp(buffer, key, value, index);
-      } else if (type === 'object' && value['_bsontype'] == null) {
+      } else if (type === 'object' && value._bsontype == null) {
         index = serializeObject(
           buffer,
           key,
@@ -808,13 +808,17 @@ export function serializeInto(
           ignoreUndefined,
           path
         );
-      } else if (type === 'object' && value['_bsontype'] === 'Decimal128') {
+      } else if (typeof value === 'object' && value[Symbol.for('@@mdb.bson.version')] == null) {
+        throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+      } else if (value._bsontype === 'ObjectId') {
+        index = serializeObjectId(buffer, key, value, index);
+      } else if (type === 'object' && value._bsontype === 'Decimal128') {
         index = serializeDecimal128(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Long' || value['_bsontype'] === 'Timestamp') {
+      } else if (value._bsontype === 'Long' || value._bsontype === 'Timestamp') {
         index = serializeLong(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Double') {
+      } else if (value._bsontype === 'Double') {
         index = serializeDouble(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Code') {
+      } else if (value._bsontype === 'Code') {
         index = serializeCode(
           buffer,
           key,
@@ -828,20 +832,20 @@ export function serializeInto(
         );
       } else if (typeof value === 'function' && serializeFunctions) {
         index = serializeFunction(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Binary') {
+      } else if (value._bsontype === 'Binary') {
         index = serializeBinary(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Symbol') {
+      } else if (value._bsontype === 'Symbol') {
         index = serializeSymbol(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'DBRef') {
+      } else if (value._bsontype === 'DBRef') {
         index = serializeDBRef(buffer, key, value, index, depth, serializeFunctions, path);
-      } else if (value['_bsontype'] === 'BSONRegExp') {
+      } else if (value._bsontype === 'BSONRegExp') {
         index = serializeBSONRegExp(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Int32') {
+      } else if (value._bsontype === 'Int32') {
         index = serializeInt32(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'MinKey' || value['_bsontype'] === 'MaxKey') {
+      } else if (value._bsontype === 'MinKey' || value._bsontype === 'MaxKey') {
         index = serializeMinMax(buffer, key, value, index);
-      } else if (typeof value['_bsontype'] !== 'undefined') {
-        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value['_bsontype'])}`);
+      } else if (typeof value._bsontype !== 'undefined') {
+        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value._bsontype)}`);
       }
     }
   } else {
@@ -895,13 +899,11 @@ export function serializeInto(
         if (ignoreUndefined === false) index = serializeNull(buffer, key, value, index);
       } else if (value === null) {
         index = serializeNull(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'ObjectId' || value['_bsontype'] === 'ObjectID') {
-        index = serializeObjectId(buffer, key, value, index);
       } else if (isUint8Array(value)) {
         index = serializeBuffer(buffer, key, value, index);
       } else if (value instanceof RegExp || isRegExp(value)) {
         index = serializeRegExp(buffer, key, value, index);
-      } else if (type === 'object' && value['_bsontype'] == null) {
+      } else if (type === 'object' && value._bsontype == null) {
         index = serializeObject(
           buffer,
           key,
@@ -913,13 +915,17 @@ export function serializeInto(
           ignoreUndefined,
           path
         );
-      } else if (type === 'object' && value['_bsontype'] === 'Decimal128') {
+      } else if (typeof value === 'object' && value[Symbol.for('@@mdb.bson.version')] == null) {
+        throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+      } else if (value._bsontype === 'ObjectId') {
+        index = serializeObjectId(buffer, key, value, index);
+      } else if (type === 'object' && value._bsontype === 'Decimal128') {
         index = serializeDecimal128(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Long' || value['_bsontype'] === 'Timestamp') {
+      } else if (value._bsontype === 'Long' || value._bsontype === 'Timestamp') {
         index = serializeLong(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Double') {
+      } else if (value._bsontype === 'Double') {
         index = serializeDouble(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Code') {
+      } else if (value._bsontype === 'Code') {
         index = serializeCode(
           buffer,
           key,
@@ -933,20 +939,20 @@ export function serializeInto(
         );
       } else if (typeof value === 'function' && serializeFunctions) {
         index = serializeFunction(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Binary') {
+      } else if (value._bsontype === 'Binary') {
         index = serializeBinary(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Symbol') {
+      } else if (value._bsontype === 'Symbol') {
         index = serializeSymbol(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'DBRef') {
+      } else if (value._bsontype === 'DBRef') {
         index = serializeDBRef(buffer, key, value, index, depth, serializeFunctions, path);
-      } else if (value['_bsontype'] === 'BSONRegExp') {
+      } else if (value._bsontype === 'BSONRegExp') {
         index = serializeBSONRegExp(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'Int32') {
+      } else if (value._bsontype === 'Int32') {
         index = serializeInt32(buffer, key, value, index);
-      } else if (value['_bsontype'] === 'MinKey' || value['_bsontype'] === 'MaxKey') {
+      } else if (value._bsontype === 'MinKey' || value._bsontype === 'MaxKey') {
         index = serializeMinMax(buffer, key, value, index);
-      } else if (typeof value['_bsontype'] !== 'undefined') {
-        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value['_bsontype'])}`);
+      } else if (typeof value._bsontype !== 'undefined') {
+        throw new BSONTypeError(`Unrecognized or invalid _bsontype: ${String(value._bsontype)}`);
       }
     }
   }

diff --git a/src/regexp.ts b/src/regexp.ts
@@ -28,6 +28,10 @@ export class BSONRegExp {
   get _bsontype(): 'BSONRegExp' {
     return 'BSONRegExp';
   }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   pattern!: string;
   options!: string;
@@ -100,4 +104,13 @@ export class BSONRegExp {
     }
     throw new BSONTypeError(`Unexpected BSONRegExp EJSON object form: ${JSON.stringify(doc)}`);
   }
+
+  /** @internal */
+  [Symbol.for('nodejs.util.inspect.custom')](): string {
+    return this.inspect();
+  }
+
+  inspect(): string {
+    return `new BSONRegExp(${JSON.stringify(this.pattern)}, ${JSON.stringify(this.options)})`;
+  }
 }