fix: print createFromBase64 regardless of position

mongodb · Apr 3, 2023 · 450dfca · 450dfca
1 parent 9e0a86b
commit 450dfca
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 17 deletions.
diff --git a/src/binary.ts b/src/binary.ts
@@ -302,11 +302,6 @@ export class Binary extends BSONValue {
   }
 
   inspect(): string {
-    if (this.position === 0) {
-      return this.sub_type !== Binary.BSON_BINARY_SUBTYPE_DEFAULT
-        ? `new Binary(undefined, ${this.sub_type})`
-        : 'new Binary()';
-    }
     const base64 = ByteUtils.toBase64(this.buffer.subarray(0, this.position));
     return `Binary.createFromBase64("${base64}", ${this.sub_type})`;
   }

diff --git a/test/node/binary.test.ts b/test/node/binary.test.ts
@@ -81,38 +81,53 @@ describe('class Binary', () => {
   });
 
   context('inspect()', () => {
-    it('when value is default returns "new Binary()"', () => {
-      expect(new Binary().inspect()).to.equal('new Binary()');
+    it('when value is default returns "Binary.createFromBase64("", 0)"', () => {
+      expect(new Binary().inspect()).to.equal('Binary.createFromBase64("", 0)');
     });
 
-    it('when value is empty returns "new Binary()"', () => {
-      expect(new Binary(new Uint8Array(0)).inspect()).to.equal('new Binary()');
+    it('when value is empty returns "Binary.createFromBase64("", 0)"', () => {
+      expect(new Binary(new Uint8Array(0)).inspect()).to.equal('Binary.createFromBase64("", 0)');
     });
 
-    it('when value is default with a subtype returns "new Binary()"', () => {
-      expect(new Binary(null, 0x23).inspect()).to.equal('new Binary(undefined, 35)');
+    it('when value is default with a subtype returns "Binary.createFromBase64("", 35)"', () => {
+      expect(new Binary(null, 0x23).inspect()).to.equal('Binary.createFromBase64("", 35)');
     });
 
-    it('when value is empty with a subtype returns "new Binary(undefined, 35)"', () => {
-      expect(new Binary(new Uint8Array(0), 0x23).inspect()).to.equal('new Binary(undefined, 35)');
+    it('when value is empty with a subtype returns "Binary.createFromBase64("", 35)"', () => {
+      expect(new Binary(new Uint8Array(0), 0x23).inspect()).to.equal(
+        'Binary.createFromBase64("", 35)'
+      );
     });
 
-    it('when value is empty returns "Binary.createFromBase64("", 0)"', () => {
+    it('when value has utf8 "abcdef" encoded returns "Binary.createFromBase64("YWJjZGVm", 0)"', () => {
       expect(new Binary(Buffer.from('abcdef', 'utf8')).inspect()).to.equal(
         'Binary.createFromBase64("YWJjZGVm", 0)'
       );
     });
 
     context('when result is executed', () => {
-      it('is deep equal with a Binary that has no data', () => {
+      it('has a position of zero when constructed with default space', () => {
         const bsonValue = new Binary();
         const ctx = { ...BSON, module: { exports: { result: null } } };
         vm.runInNewContext(`module.exports.result = ${bsonValue.inspect()}`, ctx);
+        expect(ctx.module.exports.result).to.have.property('position', 0);
+        expect(ctx.module.exports.result).to.have.property('sub_type', 0);
+
+        // While the default Binary has 256 bytes the newly constructed one will have 0
+        // both will have a position of zero so when serialized to BSON they are the equivalent.
+        expect(ctx.module.exports.result).to.have.nested.property('buffer.byteLength', 0);
+        expect(bsonValue).to.have.nested.property('buffer.byteLength', 256);
+      });
+
+      it('is deep equal with a Binary that has no data', () => {
+        const bsonValue = new Binary(new Uint8Array(0));
+        const ctx = { ...BSON, module: { exports: { result: null } } };
+        vm.runInNewContext(`module.exports.result = ${bsonValue.inspect()}`, ctx);
         expect(ctx.module.exports.result).to.deep.equal(bsonValue);
       });
 
       it('is deep equal with a Binary that has a subtype but no data', () => {
-        const bsonValue = new Binary(undefined, 0x23);
+        const bsonValue = new Binary(new Uint8Array(0), 0x23);
         const ctx = { ...BSON, module: { exports: { result: null } } };
         vm.runInNewContext(`module.exports.result = ${bsonValue.inspect()}`, ctx);
         expect(ctx.module.exports.result).to.deep.equal(bsonValue);

diff --git a/test/node/bson_type_classes.test.ts b/test/node/bson_type_classes.test.ts
@@ -37,7 +37,7 @@ const BSONTypeClasses = [
 ];
 
 const BSONTypeClassCtors = new Map<string, () => BSONValue>([
-  ['Binary', () => new Binary()],
+  ['Binary', () => new Binary(new Uint8Array(0), 0)],
   ['Code', () => new Code('function () {}')],
   ['DBRef', () => new DBRef('name', new ObjectId('00'.repeat(12)))],
   ['Decimal128', () => new Decimal128('1.23')],