Double precision EJSON fix and Spec update

Author: nbbeeken

etc/update-spec-tests.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# This script is used to fetch the latest JSON tests for the BSON spec.
+# It puts the tests in the direcory $spec_root It should be run from the root of the repository.
+
+set -o errexit
+set -o nounset
+
+if [ ! -d ".git" ]; then
+    echo "$0: This script must be run from the root of the repository" >&2
+    exit 1
+fi
+
+spec_root="test"
+
+tmpdir=$(mktemp -d -t spec_testsXXXX)
+curl -sL https://github.com/mongodb/specifications/archive/master.zip -o "$tmpdir/specs.zip"
+unzip -d "$tmpdir" "$tmpdir/specs.zip" > /dev/null
+
+mkdir -p "$spec_root/bson-corpus"
+rsync -ah "$tmpdir/specifications-master/source/bson-corpus/tests/" "$spec_root/bson-corpus" --delete
+
+rm -rf "$tmpdir"

lib/bson/double.js

@@ -1,8 +1,26 @@
 'use strict';
 
 function toExtendedJSON(obj, options) {
-  if (options && options.relaxed && isFinite(obj.value)) return obj.value;
-  return { $numberDouble: obj.value.toString() };
+  if (options && (options.legacy || (options.relaxed && isFinite(obj.value)))) {
+    return obj.value;
+  }
+  // NOTE: JavaScript has +0 and -0, apparently to model limit calculations. If a user
+  // explicitly provided `-0` then we need to ensure the sign makes it into the output
+  if (Object.is(Math.sign(obj.value), -0)) {
+    return { $numberDouble: `-${obj.value.toFixed(1)}` };
+  }
+
+  var numberDouble;
+  if (Number.isInteger(obj.value)) {
+    numberDouble = obj.value.toFixed(1);
+    if (numberDouble.length >= 13) {
+      numberDouble = obj.value.toExponential(13).toUpperCase();
+    }
+  } else {
+    numberDouble = obj.value.toString();
+  }
+
+  return { $numberDouble: numberDouble };
 }
 
 function fromExtendedJSON(BSON, doc, options) {

test/bson-corpus/array.json

@@ -14,16 +14,22 @@
             "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
         },
         {
-            "description": "Single Element Array with index set incorrectly",
+            "description": "Single Element Array with index set incorrectly to empty string",
             "degenerate_bson": "130000000461000B00000010000A0000000000",
             "canonical_bson": "140000000461000C0000001030000A0000000000",
             "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
         },
         {
-            "description": "Single Element Array with index set incorrectly",
+            "description": "Single Element Array with index set incorrectly to ab",
             "degenerate_bson": "150000000461000D000000106162000A0000000000",
             "canonical_bson": "140000000461000C0000001030000A0000000000",
             "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
+        },
+        {
+            "description": "Multi Element Array with duplicate indexes",
+            "degenerate_bson": "1b000000046100130000001030000a000000103000140000000000",
+            "canonical_bson": "1b000000046100130000001030000a000000103100140000000000",
+            "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}, {\"$numberInt\": \"20\"}]}"
         }
     ],
     "decodeErrors": [

test/bson-corpus/binary.json

@@ -25,6 +25,12 @@
             "description" : "Y10K",
             "canonical_bson" : "1000000009610000DC1FD277E6000000",
             "canonical_extjson" : "{\"a\":{\"$date\":{\"$numberLong\":\"253402300800000\"}}}"
+        },
+        {
+            "description": "leading zero ms",
+            "canonical_bson": "10000000096100D1D6D6CC3B01000000",
+            "relaxed_extjson": "{\"a\" : {\"$date\" : \"2012-12-24T12:15:30.001Z\"}}",
+            "canonical_extjson": "{\"a\" : {\"$date\" : {\"$numberLong\" : \"1356351330001\"}}}"
         }
     ],
     "decodeErrors": [

test/bson-corpus/boolean.json

@@ -28,16 +28,16 @@
             "relaxed_extjson": "{\"d\" : -1.0001220703125}"
         },
         {
-            "description": "1.23456789012345677E+18",
-            "canonical_bson": "1000000001640081E97DF41022B14300",
-            "canonical_extjson": "{\"d\" : {\"$numberDouble\": \"1.23456789012345677E+18\"}}",
-            "relaxed_extjson": "{\"d\" : 1.23456789012345677E+18}"
+            "description": "1.2345678921232E+18",
+            "canonical_bson": "100000000164002a1bf5f41022b14300",
+            "canonical_extjson": "{\"d\" : {\"$numberDouble\": \"1.2345678921232E+18\"}}",
+            "relaxed_extjson": "{\"d\" : 1.2345678921232E+18}"
         },
         {
-            "description": "-1.23456789012345677E+18",
-            "canonical_bson": "1000000001640081E97DF41022B1C300",
-            "canonical_extjson": "{\"d\" : {\"$numberDouble\": \"-1.23456789012345677E+18\"}}",
-            "relaxed_extjson": "{\"d\" : -1.23456789012345677E+18}"
+            "description": "-1.2345678921232E+18",
+            "canonical_bson": "100000000164002a1bf5f41022b1c300",
+            "canonical_extjson": "{\"d\" : {\"$numberDouble\": \"-1.2345678921232E+18\"}}",
+            "relaxed_extjson": "{\"d\" : -1.2345678921232E+18}"
         },
         {
             "description": "0.0",

test/bson-corpus/code.json

@@ -69,11 +69,11 @@
     "parseErrors": [
         {
             "description" : "Bad $regularExpression (extra field)",
-            "string" : "{\"a\" : \"$regularExpression\": {\"pattern\": \"abc\", \"options\": \"\", \"unrelated\": true}}}"
+            "string" : "{\"a\" : {\"$regularExpression\": {\"pattern\": \"abc\", \"options\": \"\", \"unrelated\": true}}}"
         },
         {
             "description" : "Bad $regularExpression (missing options field)",
-            "string" : "{\"a\" : \"$regularExpression\": {\"pattern\": \"abc\"}}}"
+            "string" : "{\"a\" : {\"$regularExpression\": {\"pattern\": \"abc\"}}}"
         },
         {
             "description": "Bad $regularExpression (pattern is number, not string)",
@@ -85,7 +85,7 @@
         },
         {
             "description" : "Bad $regularExpression (missing pattern field)",
-            "string" : "{\"a\" : \"$regularExpression\": {\"options\":\"ix\"}}}"
+            "string" : "{\"a\" : {\"$regularExpression\": {\"options\":\"ix\"}}}"
         },
         {
             "description": "Bad $oid (number, not string)",
@@ -151,6 +151,10 @@
             "description": "Bad $code (type is number, not string)",
             "string": "{\"a\" : {\"$code\" : 42}}"
         },
+        {
+            "description": "Bad $code (type is number, not string) when $scope is also present",
+            "string": "{\"a\" : {\"$code\" : 42, \"$scope\" : {}}}"
+        },
         {
             "description": "Bad $code (extra field)",
             "string": "{\"a\" : {\"$code\" : \"\", \"unrelated\": true}}"

test/bson-corpus/code_w_scope.json

@@ -54,56 +54,13 @@ var skip = {
     'Current BSON implementation of timestamp/long cannot hold these values - 1 too large.'
 };
 
-var modifiedDoubles = {
-  '+1.0': { canonical_extjson: '{"d":{"$numberDouble":"1"}}' },
-  '-1.0': { canonical_extjson: '{"d":{"$numberDouble":"-1"}}' },
-  '1.23456789012345677E+18': { canonical_extjson: '{"d":{"$numberDouble":"1234567890123456800"}}' },
-  '-1.23456789012345677E+18': {
-    canonical_extjson: '{"d":{"$numberDouble":"-1234567890123456800"}}'
-  },
-  '0.0': { canonical_extjson: '{"d":{"$numberDouble":"0"}}' },
-  '-0.0': {
-    canonical_extjson: '{"d":{"$numberDouble":"0"}}',
-    canonical_bson: '10000000016400000000000000000000'
-  }
-};
-
-var modifiedMultitype = {
-  'All BSON types': {
-    canonical_extjson:
-      '{"_id":{"$oid":"57e193d7a9cc81b4027498b5"},"Symbol":"symbol","String":"string","Int32":{"$numberInt":"42"},"Int64":{"$numberLong":"42"},"Double":{"$numberDouble":"-1"},"Binary":{"$binary":{"base64":"o0w498Or7cijeBSpkquNtg==","subType":"03"}},"BinaryUserDefined":{"$binary":{"base64":"AQIDBAU=","subType":"80"}},"Code":{"$code":"function() {}"},"CodeWithScope":{"$code":"function() {}","$scope":{}},"Subdocument":{"foo":"bar"},"Array":[{"$numberInt":"1"},{"$numberInt":"2"},{"$numberInt":"3"},{"$numberInt":"4"},{"$numberInt":"5"}],"Timestamp":{"$timestamp":{"t":42,"i":1}},"Regex":{"$regularExpression":{"pattern":"pattern","options":""}},"DatetimeEpoch":{"$date":{"$numberLong":"0"}},"DatetimePositive":{"$date":{"$numberLong":"2147483647"}},"DatetimeNegative":{"$date":{"$numberLong":"-2147483648"}},"True":true,"False":false,"DBPointer":{"$ref":"collection","$id":{"$oid":"57e193d7a9cc81b4027498b1"}},"DBRef":{"$ref":"collection","$id":{"$oid":"57fd71e96e32ab4225b723fb"},"$db":"database"},"Minkey":{"$minKey":1},"Maxkey":{"$maxKey":1},"Null":null,"Undefined":null}',
-    canonical_bson:
-      '48020000075f69640057e193d7a9cc81b4027498b50253796d626f6c000700000073796d626f6c0002537472696e670007000000737472696e670010496e743332002a00000012496e743634002a0000000000000001446f75626c6500000000000000f0bf0542696e617279001000000003a34c38f7c3abedc8a37814a992ab8db60542696e61727955736572446566696e656400050000008001020304050d436f6465000e00000066756e6374696f6e2829207b7d000f436f64655769746853636f7065001b0000000e00000066756e6374696f6e2829207b7d00050000000003537562646f63756d656e74001200000002666f6f0004000000626172000004417272617900280000001030000100000010310002000000103200030000001033000400000010340005000000001154696d657374616d7000010000002a0000000b5265676578007061747465726e0000094461746574696d6545706f6368000000000000000000094461746574696d65506f73697469766500ffffff7f00000000094461746574696d654e656761746976650000000080ffffffff085472756500010846616c73650000034442506f696e746572002b0000000224726566000b000000636f6c6c656374696f6e00072469640057e193d7a9cc81b4027498b100034442526566003d0000000224726566000b000000636f6c6c656374696f6e00072469640057fd71e96e32ab4225b723fb02246462000900000064617461626173650000ff4d696e6b6579007f4d61786b6579000a4e756c6c000a556e646566696e65640000',
-    converted_extjson:
-      '{"_id":{"$oid":"57e193d7a9cc81b4027498b5"},"Symbol":"symbol","String":"string","Int32":{"$numberInt":"42"},"Int64":{"$numberLong":"42"},"Double":{"$numberDouble":"-1"},"Binary":{"$binary":{"base64":"o0w498Or7cijeBSpkquNtg==","subType":"03"}},"BinaryUserDefined":{"$binary":{"base64":"AQIDBAU=","subType":"80"}},"Code":{"$code":"function() {}"},"CodeWithScope":{"$code":"function() {}","$scope":{}},"Subdocument":{"foo":"bar"},"Array":[{"$numberInt":"1"},{"$numberInt":"2"},{"$numberInt":"3"},{"$numberInt":"4"},{"$numberInt":"5"}],"Timestamp":{"$timestamp":{"t":42,"i":1}},"Regex":{"$regularExpression":{"pattern":"pattern","options":""}},"DatetimeEpoch":{"$date":{"$numberLong":"0"}},"DatetimePositive":{"$date":{"$numberLong":"2147483647"}},"DatetimeNegative":{"$date":{"$numberLong":"-2147483648"}},"True":true,"False":false,"DBPointer":{"$ref":"collection","$id":{"$oid":"57e193d7a9cc81b4027498b1"}},"DBRef":{"$ref":"collection","$id":{"$oid":"57fd71e96e32ab4225b723fb"},"$db":"database"},"Minkey":{"$minKey":1},"Maxkey":{"$maxKey":1},"Null":null,"Undefined":null}',
-    converted_bson:
-      '48020000075f69640057e193d7a9cc81b4027498b50253796d626f6c000700000073796d626f6c0002537472696e670007000000737472696e670010496e743332002a00000012496e743634002a0000000000000001446f75626c6500000000000000f0bf0542696e617279001000000003a34c38f7c3abedc8a37814a992ab8db60542696e61727955736572446566696e656400050000008001020304050d436f6465000e00000066756e6374696f6e2829207b7d000f436f64655769746853636f7065001b0000000e00000066756e6374696f6e2829207b7d00050000000003537562646f63756d656e74001200000002666f6f0004000000626172000004417272617900280000001030000100000010310002000000103200030000001033000400000010340005000000001154696d657374616d7000010000002a0000000b5265676578007061747465726e0000094461746574696d6545706f6368000000000000000000094461746574696d65506f73697469766500ffffff7f00000000094461746574696d654e656761746976650000000080ffffffff085472756500010846616c73650000034442506f696e746572002b0000000224726566000b000000636f6c6c656374696f6e00072469640057e193d7a9cc81b4027498b100034442526566003d0000000224726566000b000000636f6c6c656374696f6e00072469640057fd71e96e32ab4225b723fb02246462000900000064617461626173650000ff4d696e6b6579007f4d61786b6579000a4e756c6c000a556e646566696e65640000'
-  }
-};
-
 describe('BSON Corpus Tests:', function() {
   findScenarios().forEach(scenario => {
     var scenarioData = scenario[1],
       deprecated = scenarioData.deprecated,
       description = scenarioData.description,
       valid = scenarioData.valid || [];
 
-    // since doubles are formatted differently in JS than in corpus, overwrite expected results
-    if (description === 'Double type') {
-      valid.forEach(v => {
-        if (modifiedDoubles[v.description]) {
-          Object.assign(v, modifiedDoubles[v.description]);
-        }
-      });
-      // multitype test has a double nested in object, so change those expected values too
-    } else if (description === 'Multiple types within the same document') {
-      valid.forEach(v => {
-        if (modifiedMultitype[v.description]) {
-          Object.assign(v, modifiedMultitype[v.description]);
-        }
-      });
-    }
-
     valid.forEach(v => {
       // tests we need to skip for various reasons
       if (skip.hasOwnProperty(v.description)) {