mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
49fd9c63d2
The introduction of `.bytesRead` to zlib streams was unfortunate, because other streams in Node.js core use the exact opposite naming of `.bytesRead` and `.bytesWritten`. While one could see how the original naming makes sense in a `Transform` stream context, we should try to work towards more consistent APIs in core for these things. This introduces `zlib.bytesWritten` and documentation-only deprecates `zlib.bytesRead`. PR-URL: https://github.com/nodejs/node/pull/19414 Refs: https://github.com/nodejs/node/issues/8874 Refs: https://github.com/nodejs/node/pull/13088 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
96 lines
3.4 KiB
JavaScript
96 lines
3.4 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const zlib = require('zlib');
|
|
|
|
const expectStr = 'abcdefghijklmnopqrstuvwxyz'.repeat(2);
|
|
const expectBuf = Buffer.from(expectStr);
|
|
|
|
function createWriter(target, buffer) {
|
|
const writer = { size: 0 };
|
|
const write = () => {
|
|
target.write(Buffer.from([buffer[writer.size++]]), () => {
|
|
if (writer.size < buffer.length) {
|
|
target.flush(write);
|
|
} else {
|
|
target.end();
|
|
}
|
|
});
|
|
};
|
|
write();
|
|
return writer;
|
|
}
|
|
|
|
for (const method of [
|
|
['createGzip', 'createGunzip', false],
|
|
['createGzip', 'createUnzip', false],
|
|
['createDeflate', 'createInflate', true],
|
|
['createDeflateRaw', 'createInflateRaw', true]
|
|
]) {
|
|
let compWriter;
|
|
let compData = Buffer.alloc(0);
|
|
|
|
const comp = zlib[method[0]]();
|
|
comp.on('data', function(d) {
|
|
compData = Buffer.concat([compData, d]);
|
|
assert.strictEqual(this.bytesWritten, compWriter.size,
|
|
`Should get write size on ${method[0]} data.`);
|
|
});
|
|
comp.on('end', common.mustCall(function() {
|
|
assert.strictEqual(this.bytesWritten, compWriter.size,
|
|
`Should get write size on ${method[0]} end.`);
|
|
assert.strictEqual(this.bytesWritten, expectStr.length,
|
|
`Should get data size on ${method[0]} end.`);
|
|
|
|
{
|
|
let decompWriter;
|
|
let decompData = Buffer.alloc(0);
|
|
|
|
const decomp = zlib[method[1]]();
|
|
decomp.on('data', function(d) {
|
|
decompData = Buffer.concat([decompData, d]);
|
|
assert.strictEqual(this.bytesWritten, decompWriter.size,
|
|
`Should get write size on ${method[0]}/` +
|
|
`${method[1]} data.`);
|
|
});
|
|
decomp.on('end', common.mustCall(function() {
|
|
assert.strictEqual(this.bytesWritten, compData.length,
|
|
`Should get compressed size on ${method[0]}/` +
|
|
`${method[1]} end.`);
|
|
assert.strictEqual(decompData.toString(), expectStr,
|
|
`Should get original string on ${method[0]}/` +
|
|
`${method[1]} end.`);
|
|
}));
|
|
decompWriter = createWriter(decomp, compData);
|
|
}
|
|
|
|
// Some methods should allow extra data after the compressed data
|
|
if (method[2]) {
|
|
const compDataExtra = Buffer.concat([compData, Buffer.from('extra')]);
|
|
|
|
let decompWriter;
|
|
let decompData = Buffer.alloc(0);
|
|
|
|
const decomp = zlib[method[1]]();
|
|
decomp.on('data', function(d) {
|
|
decompData = Buffer.concat([decompData, d]);
|
|
assert.strictEqual(this.bytesWritten, decompWriter.size,
|
|
`Should get write size on ${method[0]}/` +
|
|
`${method[1]} data.`);
|
|
});
|
|
decomp.on('end', common.mustCall(function() {
|
|
assert.strictEqual(this.bytesWritten, compData.length,
|
|
`Should get compressed size on ${method[0]}/` +
|
|
`${method[1]} end.`);
|
|
// Checking legacy name.
|
|
assert.strictEqual(this.bytesWritten, this.bytesRead);
|
|
assert.strictEqual(decompData.toString(), expectStr,
|
|
`Should get original string on ${method[0]}/` +
|
|
`${method[1]} end.`);
|
|
}));
|
|
decompWriter = createWriter(decomp, compDataExtra);
|
|
}
|
|
}));
|
|
compWriter = createWriter(comp, expectBuf);
|
|
}
|