NODE-2253: Support for v1 Extended JSON (#339)

* NODE-2253: Serialize v1 Extended JSON:

- Adds a legacy: true option to serialize and stringify
- Adds tests for cases where v1 and v2 extjson differ.

* NODE-2253: Deserialisation support sans dbref/regex

* NODE-2253: Support Regex and DBRef as legacy

* Remove console log

* Add legacy option in the README

* add options default assignment

* add options defasult guard on fromExtendedJSON too

* chore(extjson): add legacy top-level default option assignment and doc strings

Co-authored-by: Lucas Hrabovsky <[email protected]>

Author: 2 people

README.md

@@ -215,6 +215,7 @@ console.log(EJSON.parse(text));
 | [space] | <code>string</code> \| <code>number</code> |  | A String or Number object that's used to insert white space into the output JSON string for readability purposes. |
 | [options] | <code>object</code> |  | Optional settings |
 | [options.relaxed] | <code>boolean</code> | <code>true</code> | Enabled Extended JSON's `relaxed` mode |
+| [options.legacy] | <code>boolean</code> | <code>true</code> | Output in Extended JSON v1 |
 
 Converts a BSON document to an Extended JSON string, optionally replacing values if a replacer
 function is specified or optionally including only the specified properties if a replacer array

lib/binary.js

@@ -280,12 +280,19 @@ class Binary {
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(options) {
+    options = options || {};
     const base64String = Buffer.isBuffer(this.buffer)
       ? this.buffer.toString('base64')
       : Buffer.from(this.buffer).toString('base64');
 
     const subType = Number(this.sub_type).toString(16);
+    if (options.legacy) {
+      return {
+        $binary: base64String,
+        $type: subType.length === 1 ? '0' + subType : subType
+      };
+    }
     return {
       $binary: {
         base64: base64String,
@@ -297,9 +304,16 @@ class Binary {
   /**
    * @ignore
    */
-  static fromExtendedJSON(doc) {
-    const type = doc.$binary.subType ? parseInt(doc.$binary.subType, 16) : 0;
-    const data = Buffer.from(doc.$binary.base64, 'base64');
+  static fromExtendedJSON(doc, options) {
+    options = options || {};
+    let data, type;
+    if (options.legacy) {
+      type = doc.$type ? parseInt(doc.$type, 16) : 0;
+      data = Buffer.from(doc.$binary, 'base64');
+    } else {
+      type = doc.$binary.subType ? parseInt(doc.$binary.subType, 16) : 0;
+      data = Buffer.from(doc.$binary.base64, 'base64');
+    }
     return new Binary(data, type);
   }
 }

lib/db_ref.js

@@ -46,12 +46,17 @@ class DBRef {
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(options) {
+    options = options || {};
     let o = {
       $ref: this.collection,
       $id: this.oid
     };
 
+    if (options.legacy) {
+      return o;
+    }
+
     if (this.db) o.$db = this.db;
     o = Object.assign(o, this.fields);
     return o;

lib/double.js

@@ -34,7 +34,9 @@ class Double {
    * @ignore
    */
   toExtendedJSON(options) {
-    if (options && options.relaxed && isFinite(this.value)) return this.value;
+    if (options && (options.legacy || (options.relaxed && isFinite(this.value)))) {
+      return this.value;
+    }
     return { $numberDouble: this.value.toString() };
   }
 

lib/extended_json.js

@@ -32,13 +32,14 @@ const keysToCodecs = {
   $numberLong: Long,
   $minKey: MinKey,
   $maxKey: MaxKey,
+  $regex: BSONRegExp,
   $regularExpression: BSONRegExp,
   $timestamp: Timestamp
 };
 
 function deserializeValue(self, key, value, options) {
   if (typeof value === 'number') {
-    if (options.relaxed) {
+    if (options.relaxed || options.legacy) {
       return value;
     }
 
@@ -69,9 +70,14 @@ function deserializeValue(self, key, value, options) {
     const d = value.$date;
     const date = new Date();
 
-    if (typeof d === 'string') date.setTime(Date.parse(d));
-    else if (Long.isLong(d)) date.setTime(d.toNumber());
-    else if (typeof d === 'number' && options.relaxed) date.setTime(d);
+    if (options.legacy) {
+      if (typeof d === 'number') date.setTime(d);
+      else if (typeof d === 'string') date.setTime(Date.parse(d));
+    } else {
+      if (typeof d === 'string') date.setTime(Date.parse(d));
+      else if (Long.isLong(d)) date.setTime(d.toNumber());
+      else if (typeof d === 'number' && options.relaxed) date.setTime(d);
+    }
     return date;
   }
 
@@ -125,7 +131,7 @@ function deserializeValue(self, key, value, options) {
  * console.log(EJSON.parse(text));
  */
 function parse(text, options) {
-  options = Object.assign({}, { relaxed: true }, options);
+  options = Object.assign({}, { relaxed: true, legacy: false }, options);
 
   // relaxed implies not strict
   if (typeof options.relaxed === 'boolean') options.strict = !options.relaxed;
@@ -155,6 +161,7 @@ const BSON_INT32_MAX = 0x7fffffff,
  * @param {string|number} [space] A String or Number object that's used to insert white space into the output JSON string for readability purposes.
  * @param {object} [options] Optional settings
  * @param {boolean} [options.relaxed=true] Enabled Extended JSON's `relaxed` mode
+ * @param {boolean} [options.legacy=false] Output using the Extended JSON v1 spec
  * @returns {string}
  *
  * @example
@@ -178,7 +185,7 @@ function stringify(value, replacer, space, options) {
     replacer = null;
     space = 0;
   }
-  options = Object.assign({}, { relaxed: true }, options);
+  options = Object.assign({}, { relaxed: true, legacy: false }, options);
 
   const doc = Array.isArray(value)
     ? serializeArray(value, options)
@@ -233,6 +240,11 @@ function serializeValue(value, options) {
       // is it in year range 1970-9999?
       inRange = dateNum > -1 && dateNum < 253402318800000;
 
+    if (options.legacy) {
+      return options.relaxed && inRange
+        ? { $date: value.getTime() }
+        : { $date: getISOString(value) };
+    }
     return options.relaxed && inRange
       ? { $date: getISOString(value) }
       : { $date: { $numberLong: value.getTime().toString() } };
@@ -258,7 +270,7 @@ function serializeValue(value, options) {
     }
 
     const rx = new BSONRegExp(value.source, flags);
-    return rx.toExtendedJSON();
+    return rx.toExtendedJSON(options);
   }
 
   if (value != null && typeof value === 'object') return serializeDocument(value, options);

lib/int_32.js

@@ -34,7 +34,7 @@ class Int32 {
    * @ignore
    */
   toExtendedJSON(options) {
-    if (options && options.relaxed) return this.value;
+    if (options && (options.relaxed || options.legacy)) return this.value;
     return { $numberInt: this.value.toString() };
   }
 

lib/regexp.js

@@ -39,23 +39,40 @@ class BSONRegExp {
     }
   }
 
+  static parseOptions(options) {
+    return options
+      ? options
+          .split('')
+          .sort()
+          .join('')
+      : '';
+  }
+
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(options) {
+    options = options || {};
+    if (options.legacy) {
+      return { $regex: this.pattern, $options: this.options };
+    }
     return { $regularExpression: { pattern: this.pattern, options: this.options } };
   }
 
   /**
    * @ignore
    */
   static fromExtendedJSON(doc) {
+    if (doc.$regex) {
+      // This is for $regex query operators that have extended json values.
+      if (doc.$regex._bsontype === 'BSONRegExp') {
+        return doc;
+      }
+      return new BSONRegExp(doc.$regex, BSONRegExp.parseOptions(doc.$options));
+    }
     return new BSONRegExp(
       doc.$regularExpression.pattern,
-      doc.$regularExpression.options
-        .split('')
-        .sort()
-        .join('')
+      BSONRegExp.parseOptions(doc.$regularExpression.options)
     );
   }
 }