bson 4.2.3 → 4.5.0

package/src/extended_json.ts

@@ -1,7 +1,7 @@
 import { Binary } from './binary';
 import type { Document } from './bson';
 import { Code } from './code';
-import { DBRef } from './db_ref';
+import { DBRef, isDBRefLike } from './db_ref';
 import { Decimal128 } from './decimal128';
 import { Double } from './double';
 import { Int32 } from './int_32';
@@ -9,7 +9,7 @@ import { Long } from './long';
 import { MaxKey } from './max_key';
 import { MinKey } from './min_key';
 import { ObjectId } from './objectid';
-import { isObjectLike } from './parser/utils';
+import { isDate, isObjectLike, isRegExp } from './parser/utils';
 import { BSONRegExp } from './regexp';
 import { BSONSymbol } from './symbol';
 import { Timestamp } from './timestamp';
@@ -120,7 +120,7 @@ function deserializeValue(value: any, options: EJSON.Options = {}) {
     return Code.fromExtendedJSON(value);
   }
 
-  if (value.$ref != null || value.$dbPointer != null) {
+  if (isDBRefLike(value) || value.$dbPointer) {
     const v = value.$ref ? value : value.$dbPointer;
 
     // we run into this in a "degenerate EJSON" case (with $id and $ref order flipped)
@@ -140,9 +140,20 @@ function deserializeValue(value: any, options: EJSON.Options = {}) {
   return value;
 }
 
+type EJSONSerializeOptions = EJSON.Options & {
+  seenObjects: { obj: unknown; propertyName: string }[];
+};
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function serializeArray(array: any[], options: EJSON.Options): any[] {
-  return array.map((v: unknown) => serializeValue(v, options));
+function serializeArray(array: any[], options: EJSONSerializeOptions): any[] {
+  return array.map((v: unknown, index: number) => {
+    options.seenObjects.push({ propertyName: `index ${index}`, obj: null });
+    try {
+      return serializeValue(v, options);
+    } finally {
+      options.seenObjects.pop();
+    }
+  });
 }
 
 function getISOString(date: Date) {
@@ -152,12 +163,42 @@ function getISOString(date: Date) {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function serializeValue(value: any, options: EJSON.Options): any {
+function serializeValue(value: any, options: EJSONSerializeOptions): any {
+  if ((typeof value === 'object' || typeof value === 'function') && value !== null) {
+    const index = options.seenObjects.findIndex(entry => entry.obj === value);
+    if (index !== -1) {
+      const props = options.seenObjects.map(entry => entry.propertyName);
+      const leadingPart = props
+        .slice(0, index)
+        .map(prop => `${prop} -> `)
+        .join('');
+      const alreadySeen = props[index];
+      const circularPart =
+        ' -> ' +
+        props
+          .slice(index + 1, props.length - 1)
+          .map(prop => `${prop} -> `)
+          .join('');
+      const current = props[props.length - 1];
+      const leadingSpace = ' '.repeat(leadingPart.length + alreadySeen.length / 2);
+      const dashes = '-'.repeat(
+        circularPart.length + (alreadySeen.length + current.length) / 2 - 1
+      );
+
+      throw new TypeError(
+        'Converting circular structure to EJSON:\n' +
+          `    ${leadingPart}${alreadySeen}${circularPart}${current}\n` +
+          `    ${leadingSpace}\\${dashes}/`
+      );
+    }
+    options.seenObjects[options.seenObjects.length - 1].obj = value;
+  }
+
   if (Array.isArray(value)) return serializeArray(value, options);
 
   if (value === undefined) return null;
 
-  if (value instanceof Date) {
+  if (value instanceof Date || isDate(value)) {
     const dateNum = value.getTime(),
       // is it in year range 1970-9999?
       inRange = dateNum > -1 && dateNum < 253402318800000;
@@ -172,7 +213,7 @@ function serializeValue(value: any, options: EJSON.Options): any {
       : { $date: { $numberLong: value.getTime().toString() } };
   }
 
-  if (typeof value === 'number' && !options.relaxed) {
+  if (typeof value === 'number' && (!options.relaxed || !isFinite(value))) {
     // it's an integer
     if (Math.floor(value) === value) {
       const int32Range = value >= BSON_INT32_MIN && value <= BSON_INT32_MAX,
@@ -185,7 +226,7 @@ function serializeValue(value: any, options: EJSON.Options): any {
     return { $numberDouble: value.toString() };
   }
 
-  if (value instanceof RegExp) {
+  if (value instanceof RegExp || isRegExp(value)) {
     let flags = value.flags;
     if (flags === undefined) {
       const match = value.toString().match(/[gimuy]*$/);
@@ -232,7 +273,7 @@ const BSON_TYPE_MAPPINGS = {
 } as const;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function serializeDocument(doc: any, options: EJSON.Options) {
+function serializeDocument(doc: any, options: EJSONSerializeOptions) {
   if (doc == null || typeof doc !== 'object') throw new Error('not an object instance');
 
   const bsontype: BSONType['_bsontype'] = doc._bsontype;
@@ -240,7 +281,12 @@ function serializeDocument(doc: any, options: EJSON.Options) {
     // It's a regular object. Recursively serialize its property values.
     const _doc: Document = {};
     for (const name in doc) {
-      _doc[name] = serializeValue(doc[name], options);
+      options.seenObjects.push({ propertyName: name, obj: null });
+      try {
+        _doc[name] = serializeValue(doc[name], options);
+      } finally {
+        options.seenObjects.pop();
+      }
     }
     return _doc;
   } else if (isBSONType(doc)) {
@@ -264,10 +310,10 @@ function serializeDocument(doc: any, options: EJSON.Options) {
       outDoc = new Code(outDoc.code, serializeValue(outDoc.scope, options));
     } else if (bsontype === 'DBRef' && outDoc.oid) {
       outDoc = new DBRef(
-        outDoc.collection,
+        serializeValue(outDoc.collection, options),
         serializeValue(outDoc.oid, options),
-        outDoc.db,
-        outDoc.fields
+        serializeValue(outDoc.db, options),
+        serializeValue(outDoc.fields, options)
       );
     }
 
@@ -365,9 +411,11 @@ export namespace EJSON {
       replacer = undefined;
       space = 0;
     }
-    options = Object.assign({}, { relaxed: true, legacy: false }, options);
+    const serializeOptions = Object.assign({ relaxed: true, legacy: false }, options, {
+      seenObjects: [{ propertyName: '(root)', obj: null }]
+    });
 
-    const doc = serializeValue(value, options);
+    const doc = serializeValue(value, serializeOptions);
     return JSON.stringify(doc, replacer as Parameters<JSON['stringify']>[1], space);
   }
 

package/src/long.ts

@@ -27,13 +27,13 @@ let wasm: LongWASMHelpers | undefined = undefined;
 declare const WebAssembly: any;
 
 try {
-  wasm = (new WebAssembly.Instance(
+  wasm = new WebAssembly.Instance(
     new WebAssembly.Module(
       // prettier-ignore
       new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0, 1, 13, 2, 96, 0, 1, 127, 96, 4, 127, 127, 127, 127, 1, 127, 3, 7, 6, 0, 1, 1, 1, 1, 1, 6, 6, 1, 127, 1, 65, 0, 11, 7, 50, 6, 3, 109, 117, 108, 0, 1, 5, 100, 105, 118, 95, 115, 0, 2, 5, 100, 105, 118, 95, 117, 0, 3, 5, 114, 101, 109, 95, 115, 0, 4, 5, 114, 101, 109, 95, 117, 0, 5, 8, 103, 101, 116, 95, 104, 105, 103, 104, 0, 0, 10, 191, 1, 6, 4, 0, 35, 0, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 126, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 127, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 128, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 129, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 130, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11])
     ),
     {}
-  ).exports as unknown) as LongWASMHelpers;
+  ).exports as unknown as LongWASMHelpers;
 } catch {
   // no wasm support
 }
@@ -97,16 +97,28 @@ export class Long {
   /**
    * Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers.
    *  See the from* functions below for more convenient ways of constructing Longs.
+   *
+   * Acceptable signatures are:
+   * - Long(low, high, unsigned?)
+   * - Long(bigint, unsigned?)
+   * - Long(string, unsigned?)
+   *
    * @param low - The low (signed) 32 bits of the long
    * @param high - The high (signed) 32 bits of the long
    * @param unsigned - Whether unsigned or not, defaults to signed
    */
-  constructor(low = 0, high = 0, unsigned?: boolean) {
+  constructor(low: number | bigint | string = 0, high?: number | boolean, unsigned?: boolean) {
     if (!(this instanceof Long)) return new Long(low, high, unsigned);
 
-    this.low = low | 0;
-    this.high = high | 0;
-    this.unsigned = !!unsigned;
+    if (typeof low === 'bigint') {
+      Object.assign(this, Long.fromBigInt(low, !!high));
+    } else if (typeof low === 'string') {
+      Object.assign(this, Long.fromString(low, !!high));
+    } else {
+      this.low = low | 0;
+      this.high = (high as number) | 0;
+      this.unsigned = !!unsigned;
+    }
 
     Object.defineProperty(this, '__isLong__', {
       value: true,
@@ -994,7 +1006,7 @@ export class Long {
   }
 
   inspect(): string {
-    return `new Long("${this.toString()}")`;
+    return `new Long("${this.toString()}"${this.unsigned ? ', true' : ''})`;
   }
 }
 

package/src/map.ts

@@ -1,37 +1,17 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 // We have an ES6 Map available, return the native instance
 
-/* We do not want to have to include DOM types just for this check */
-declare const window: unknown;
-declare const self: unknown;
-declare const global: unknown;
+import { getGlobal } from './utils/global';
 
 /** @public */
 let bsonMap: MapConstructor;
 
-const check = function (potentialGlobal: any) {
-  // eslint-disable-next-line eqeqeq
-  return potentialGlobal && potentialGlobal.Math == Math && potentialGlobal;
-};
-
-// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028
-function getGlobal() {
-  // eslint-disable-next-line no-undef
-  return (
-    check(typeof globalThis === 'object' && globalThis) ||
-    check(typeof window === 'object' && window) ||
-    check(typeof self === 'object' && self) ||
-    check(typeof global === 'object' && global) ||
-    Function('return this')()
-  );
-}
-
-const bsonGlobal = getGlobal();
-if (Object.prototype.hasOwnProperty.call(bsonGlobal, 'Map')) {
+const bsonGlobal = getGlobal<{ Map?: MapConstructor }>();
+if (bsonGlobal.Map) {
   bsonMap = bsonGlobal.Map;
 } else {
   // We will return a polyfill
-  bsonMap = (class Map {
+  bsonMap = class Map {
     private _keys: string[];
     private _values: Record<string, any>;
     constructor(array: [string, any][] = []) {
@@ -133,7 +113,7 @@ if (Object.prototype.hasOwnProperty.call(bsonGlobal, 'Map')) {
     get size() {
       return this._keys.length;
     }
-  } as unknown) as MapConstructor;
+  } as unknown as MapConstructor;
 }
 
 export { bsonMap as Map };

package/src/objectid.ts

@@ -1,24 +1,12 @@
 import { Buffer } from 'buffer';
 import { ensureBuffer } from './ensure_buffer';
-import { deprecate, randomBytes } from './parser/utils';
-
-// constants
-const PROCESS_UNIQUE = randomBytes(5);
+import { deprecate, isUint8Array, randomBytes } from './parser/utils';
 
 // Regular expression that checks for hex value
 const checkForHexRegExp = new RegExp('^[0-9a-fA-F]{24}$');
 
-// Precomputed hex table enables speedy hex string conversion
-const hexTable: string[] = [];
-for (let i = 0; i < 256; i++) {
-  hexTable[i] = (i <= 15 ? '0' : '') + i.toString(16);
-}
-
-// Lookup tables
-const decodeLookup: number[] = [];
-let i = 0;
-while (i < 10) decodeLookup[0x30 + i] = i++;
-while (i < 16) decodeLookup[0x41 - 10 + i] = decodeLookup[0x61 - 10 + i] = i++;
+// Unique sequence for the current process (initialized on first use)
+let PROCESS_UNIQUE: Uint8Array | null = null;
 
 /** @public */
 export interface ObjectIdLike {
@@ -176,6 +164,11 @@ export class ObjectId {
     // 4-byte timestamp
     buffer.writeUInt32BE(time, 0);
 
+    // set PROCESS_UNIQUE if yet not initialized
+    if (PROCESS_UNIQUE === null) {
+      PROCESS_UNIQUE = randomBytes(5);
+    }
+
     // 5-byte process unique
     buffer[4] = PROCESS_UNIQUE[0];
     buffer[5] = PROCESS_UNIQUE[1];
@@ -229,9 +222,9 @@ export class ObjectId {
       typeof otherId === 'string' &&
       ObjectId.isValid(otherId) &&
       otherId.length === 12 &&
-      this.id instanceof Buffer
+      isUint8Array(this.id)
     ) {
-      return otherId === this.id.toString('binary');
+      return otherId === Buffer.prototype.toString.call(this.id, 'latin1');
     }
 
     if (typeof otherId === 'string' && ObjectId.isValid(otherId) && otherId.length === 24) {
@@ -300,7 +293,7 @@ export class ObjectId {
    *
    * @param id - ObjectId instance to validate.
    */
-  static isValid(id: number | string | ObjectId | Buffer | ObjectIdLike): boolean {
+  static isValid(id: number | string | ObjectId | Uint8Array | ObjectIdLike): boolean {
     if (id == null) return false;
 
     if (typeof id === 'number') {
@@ -315,7 +308,7 @@ export class ObjectId {
       return true;
     }
 
-    if (id instanceof Buffer && id.length === 12) {
+    if (isUint8Array(id) && id.length === 12) {
       return true;
     }
 

package/src/parser/calculate_size.ts

@@ -2,7 +2,7 @@ import { Buffer } from 'buffer';
 import { Binary } from '../binary';
 import type { Document } from '../bson';
 import * as constants from '../constants';
-import { isDate, normalizedFunctionString } from './utils';
+import { isAnyArrayBuffer, isDate, isRegExp, normalizedFunctionString } from './utils';
 
 export function calculateObjectSize(
   object: Document,
@@ -83,7 +83,11 @@ function calculateElement(
         return (name != null ? Buffer.byteLength(name, 'utf8') + 1 : 0) + (12 + 1);
       } else if (value instanceof Date || isDate(value)) {
         return (name != null ? Buffer.byteLength(name, 'utf8') + 1 : 0) + (8 + 1);
-      } else if (ArrayBuffer.isView(value) || value instanceof ArrayBuffer) {
+      } else if (
+        ArrayBuffer.isView(value) ||
+        value instanceof ArrayBuffer ||
+        isAnyArrayBuffer(value)
+      ) {
         return (
           (name != null ? Buffer.byteLength(name, 'utf8') + 1 : 0) + (1 + 4 + 1) + value.byteLength
         );
@@ -156,10 +160,7 @@ function calculateElement(
           1 +
           calculateObjectSize(ordered_values, serializeFunctions, ignoreUndefined)
         );
-      } else if (
-        value instanceof RegExp ||
-        Object.prototype.toString.call(value) === '[object RegExp]'
-      ) {
+      } else if (value instanceof RegExp || isRegExp(value)) {
         return (
           (name != null ? Buffer.byteLength(name, 'utf8') + 1 : 0) +
           1 +
@@ -188,11 +189,7 @@ function calculateElement(
       }
     case 'function':
       // WTF for 0.4.X where typeof /someregexp/ === 'function'
-      if (
-        value instanceof RegExp ||
-        Object.prototype.toString.call(value) === '[object RegExp]' ||
-        String.call(value) === '[object RegExp]'
-      ) {
+      if (value instanceof RegExp || isRegExp(value) || String.call(value) === '[object RegExp]') {
         return (
           (name != null ? Buffer.byteLength(name, 'utf8') + 1 : 0) +
           1 +