Skip to content

fix(NODE-6043): Binary.toString and Binary.toJSON output with respect to position #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 8, 2024
Merged

fix(NODE-6043): Binary.toString and Binary.toJSON output with respect to position #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ac1376
revisions from 6.x transfer
aditi-khare-mongoDB Apr 2, 2024
320c74e
Merge branch '5.x' into fix-binary-toString-5.x
W-A-James Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/binary.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,15 @@ export class Binary extends BSONValue {
}

toJSON(): string {
return ByteUtils.toBase64(this.buffer);
return ByteUtils.toBase64(this.buffer.subarray(0, this.position));
}

toString(encoding?: 'hex' | 'base64' | 'utf8' | 'utf-8'): string {
if (encoding === 'hex') return ByteUtils.toHex(this.buffer);
if (encoding === 'base64') return ByteUtils.toBase64(this.buffer);
if (encoding === 'hex') return ByteUtils.toHex(this.buffer.subarray(0, this.position));
if (encoding === 'base64') return ByteUtils.toBase64(this.buffer.subarray(0, this.position));
if (encoding === 'utf8' || encoding === 'utf-8')
return ByteUtils.toUTF8(this.buffer, 0, this.buffer.byteLength);
return ByteUtils.toUTF8(this.buffer, 0, this.buffer.byteLength);
return ByteUtils.toUTF8(this.buffer, 0, this.position);
return ByteUtils.toUTF8(this.buffer, 0, this.position);
}

/** @internal */
Expand Down
64 changes: 64 additions & 0 deletions test/node/binary.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,68 @@ describe('class Binary', () => {
});
});
});

context('toString()', () => {
context('when case is UTF8 (default)', () => {
it('should respect position when converting to string', () => {
const bin = new Binary();
expect(bin.toString()).to.equal('');
bin.put(1);
expect(bin.toString()).to.equal('\u0001');
});
it('should remain same after round trip', () => {
const bin = new BSON.Binary();
const serializedBin = BSON.serialize({ bin });
const roundTrippedBin = BSON.deserialize(serializedBin);
expect(roundTrippedBin.bin.toString()).to.equal(bin.toString());
});
});

context('when case is hex', () => {
it('should respect position when converting to string', () => {
const bin = new Binary();
expect(bin.toString('hex')).to.equal('');
bin.put(1);
expect(bin.toString('hex')).to.equal('01');
});
it('should remain same after round trip', () => {
const bin = new BSON.Binary();
const serializedBin = BSON.serialize({ bin });
const roundTrippedBin = BSON.deserialize(serializedBin);
expect(roundTrippedBin.bin.toString('hex')).to.equal(bin.toString('hex'));
});
});

context('when case is base64', () => {
it('should respect position when converting to string', () => {
const bin = new Binary();
expect(bin.toString('base64')).to.equal('');
bin.put(1);
expect(bin.toString('base64')).to.equal('AQ==');
});
it('should remain same after round trip', () => {
const bin = new BSON.Binary();
const serializedBin = BSON.serialize({ bin });
const roundTrippedBin = BSON.deserialize(serializedBin);
expect(roundTrippedBin.bin.toString('base64')).to.equal(bin.toString());
});
});
});

context('toJSON()', () => {
it('should respect position when converting to JSON', () => {
const bin = new Binary();
expect(bin.toJSON()).to.equal('');
bin.put(1);
// toJSON uses base64
expect(bin.toJSON()).to.equal('AQ==');
});

it('should remain same after round trip', () => {
const bin = new BSON.Binary();
const serializedBin = BSON.serialize({ bin });
const roundTrippedBin = BSON.deserialize(serializedBin);
expect(roundTrippedBin.bin.toJSON()).to.equal(bin.toJSON());
});
});
});