diff --git a/src/extended_json.ts b/src/extended_json.ts index e3f07c61..4490c958 100644 --- a/src/extended_json.ts +++ b/src/extended_json.ts @@ -240,6 +240,13 @@ function serializeValue(value: any, options: EJSONSerializeOptions): any { return { $numberDouble: Object.is(value, -0) ? '-0.0' : value.toString() }; } + if (typeof value === 'bigint') { + if (!options.relaxed) { + return { $numberLong: BigInt.asIntN(64, value).toString() }; + } + return Number(BigInt.asIntN(64, value)); + } + if (value instanceof RegExp || isRegExp(value)) { let flags = value.flags; if (flags === undefined) { diff --git a/test/node/bigint.test.ts b/test/node/bigint.test.ts index fcc95790..a1a071b6 100644 --- a/test/node/bigint.test.ts +++ b/test/node/bigint.test.ts @@ -1,4 +1,4 @@ -import { BSON, BSONError } from '../register-bson'; +import { BSON, EJSON, BSONError } from '../register-bson'; import { bufferFromHexArray } from './tools/utils'; import { expect } from 'chai'; import { BSON_DATA_LONG } from '../../src/constants'; @@ -263,4 +263,103 @@ describe('BSON BigInt support', function () { expect(serializedMap).to.deep.equal(expectedSerialization); }); }); + + describe('EJSON.stringify()', function () { + context('canonical mode (relaxed=false)', function () { + it('truncates bigint values when they are outside the range [BSON_INT64_MIN, BSON_INT64_MAX]', function () { + const numbers = { a: 2n ** 64n + 1n, b: -(2n ** 64n) - 1n }; + const serialized = EJSON.stringify(numbers, { relaxed: false }); + expect(serialized).to.equal('{"a":{"$numberLong":"1"},"b":{"$numberLong":"-1"}}'); + }); + + it('truncates bigint values in the same way as BSON.serialize', function () { + const number = { a: 0x1234_5678_1234_5678_9999n }; + const stringified = EJSON.stringify(number, { relaxed: false }); + const serialized = BSON.serialize(number); + + const VALUE_OFFSET = 7; + const dataView = BSONDataView.fromUint8Array(serialized); + const serializedValue = dataView.getBigInt64(VALUE_OFFSET, true); + const parsed = JSON.parse(stringified); + + expect(parsed).to.have.property('a'); + expect(parsed['a']).to.have.property('$numberLong'); + expect(parsed.a.$numberLong).to.equal(0x5678_1234_5678_9999n.toString()); + + expect(parsed.a.$numberLong).to.equal(serializedValue.toString()); + }); + it('serializes bigint values to numberLong in canonical mode', function () { + const number = { a: 2n }; + const serialized = EJSON.stringify(number, { relaxed: false }); + expect(serialized).to.equal('{"a":{"$numberLong":"2"}}'); + }); + }); + + context('relaxed mode (relaxed=true)', function () { + it('truncates bigint values in the same way as BSON.serialize', function () { + const number = { a: 0x1234_0000_1234_5678_9999n }; // Ensure that the truncated number can be exactly represented as a JS number + const stringified = EJSON.stringify(number, { relaxed: true }); + const serializedDoc = BSON.serialize(number); + + const VALUE_OFFSET = 7; + const dataView = BSONDataView.fromUint8Array(serializedDoc); + const parsed = JSON.parse(stringified); + + expect(parsed).to.have.property('a'); + expect(parsed.a).to.equal(0x0000_1234_5678_9999); + + expect(parsed.a).to.equal(Number(dataView.getBigInt64(VALUE_OFFSET, true))); + }); + + it('serializes bigint values to Number', function () { + const number = { a: 10000n }; + const serialized = EJSON.stringify(number, { relaxed: true }); + expect(serialized).to.equal('{"a":10000}'); + }); + + it('loses precision when serializing bigint values outside of range [Number.MIN_SAFE_INTEGER, Number.MAX_SAFE_INTEGER]', function () { + const numbers = { a: -(2n ** 53n) - 1n, b: 2n ** 53n + 2n }; + const serialized = EJSON.stringify(numbers, { relaxed: true }); + expect(serialized).to.equal('{"a":-9007199254740992,"b":9007199254740994}'); + }); + }); + + context('when passed bigint values that are 64 bits wide or less', function () { + let parsed; + + before(function () { + const number = { a: 12345n }; + const serialized = EJSON.stringify(number, { relaxed: false }); + parsed = JSON.parse(serialized); + }); + + it('passes loose equality checks with native bigint values', function () { + // eslint-disable-next-line eqeqeq + expect(parsed.a.$numberLong == 12345n).true; + }); + + it('equals the result of BigInt.toString', function () { + expect(parsed.a.$numberLong).to.equal(12345n.toString()); + }); + }); + + context('when passed bigint values that are more than 64 bits wide', function () { + let parsed; + + before(function () { + const number = { a: 0x1234_5678_1234_5678_9999n }; + const serialized = EJSON.stringify(number, { relaxed: false }); + parsed = JSON.parse(serialized); + }); + + it('fails loose equality checks with native bigint values', function () { + // eslint-disable-next-line eqeqeq + expect(parsed.a.$numberLong == 0x1234_5678_1234_5678_9999n).false; + }); + + it('not equal to results of BigInt.toString', function () { + expect(parsed.a.$numberLong).to.not.equal(0x1234_5678_1234_5678_9999n.toString()); + }); + }); + }); });