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.

Author: durran

lib/binary.js

@@ -280,12 +280,18 @@ class Binary {
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(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,

lib/db_ref.js

@@ -46,12 +46,16 @@ class DBRef {
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(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

@@ -233,6 +233,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().toString() }
+        : { $date: getISOString(value) };
+    }
     return options.relaxed && inRange
       ? { $date: getISOString(value) }
       : { $date: { $numberLong: value.getTime().toString() } };
@@ -258,7 +263,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

@@ -42,7 +42,10 @@ class BSONRegExp {
   /**
    * @ignore
    */
-  toExtendedJSON() {
+  toExtendedJSON(options) {
+    if (options.legacy) {
+      return { $regex: this.pattern, $options: this.options };
+    }
     return { $regularExpression: { pattern: this.pattern, options: this.options } };
   }
 

package-lock.json

@@ -498,4 +498,82 @@ describe('Extended JSON', function() {
     expect(() => EJSON.serialize(badArray)).to.throw();
     // expect(() => EJSON.serialize(badMap)).to.throw(); // uncomment when EJSON supports ES6 Map
   });
+
+  context('when dealing with legacy extended json', function() {
+    describe('.stringify', function() {
+      context('when serializing binary', function() {
+        it('stringifies $binary and $type', function() {
+          const binary = new Binary(new Uint8Array([1, 2, 3, 4, 5]));
+          const doc = { field: binary };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":{"$binary":"AQIDBAU=","$type":"00"}}');
+        });
+      });
+
+      context('when serializing date', function() {
+        context('when using strict mode', function() {
+          it('stringifies $date with with ISO-8601 string', function() {
+            const date = new Date(1452124800000);
+            const doc = { field: date };
+            const json = EJSON.stringify(doc, { legacy: true, relaxed: false });
+            expect(json).to.equal('{"field":{"$date":"2016-01-07T00:00:00Z"}}');
+          });
+        });
+
+        context('when using relaxed mode', function() {
+          it('stringifies $date with with millis since epoch', function() {
+            const date = new Date(1452124800000);
+            const doc = { field: date };
+            const json = EJSON.stringify(doc, { legacy: true, relaxed: true });
+            expect(json).to.equal('{"field":{"$date":"1452124800000"}}');
+          });
+        });
+      });
+
+      context('when serializing regex', function() {
+        it('stringifies $regex and $options', function() {
+          const regexp = new BSONRegExp('hello world', 'i');
+          const doc = { field: regexp };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":{"$regex":"hello world","$options":"i"}}');
+        });
+      });
+
+      context('when serializing dbref', function() {
+        it('stringifies $ref and $id', function() {
+          const dbRef = new DBRef('tests', new Int32(1));
+          const doc = { field: dbRef };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":{"$ref":"tests","$id":1}}');
+        });
+      });
+
+      context('when serializing dbref', function() {
+        it('stringifies $ref and $id', function() {
+          const dbRef = new DBRef('tests', new Int32(1));
+          const doc = { field: dbRef };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":{"$ref":"tests","$id":1}}');
+        });
+      });
+
+      context('when serializing int32', function() {
+        it('stringifies the number', function() {
+          const int32 = new Int32(1);
+          const doc = { field: int32 };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":1}');
+        });
+      });
+
+      context('when serializing double', function() {
+        it('stringifies the number', function() {
+          const doub = new Double(1.1);
+          const doc = { field: doub };
+          const json = EJSON.stringify(doc, { legacy: true });
+          expect(json).to.equal('{"field":1.1}');
+        });
+      });
+    });
+  });
 });