Skip to content
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.

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

feat(perMessageDeflate): Allow 'level' option #1199

Merged
merged 1 commit into from Sep 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/ws.md
Expand Up @@ -72,7 +72,8 @@ provided then that is extension parameters:
- `serverMaxWindowBits` {Number} The value of windowBits.
- `clientMaxWindowBits` {Number} The value of max windowBits to be requested
to clients.
- `memLevel` {Number} The value of memLevel.
- `level` {Number} The value of zlib's `level` param (0-9, default 8).
- `memLevel` {Number} The value of zlib's `memLevel` param (1-9, default 8).
- `threshold` {Number} Payloads smaller than this will not be compressed.
Defaults to 1024 bytes.

Expand Down
1 change: 1 addition & 0 deletions lib/PerMessageDeflate.js
Expand Up @@ -340,6 +340,7 @@ class PerMessageDeflate {

this._deflate = zlib.createDeflateRaw({
memLevel: this._options.memLevel,
level: this._options.level,
flush: zlib.Z_SYNC_FLUSH,
windowBits
});
Expand Down
55 changes: 52 additions & 3 deletions test/PerMessageDeflate.test.js
Expand Up @@ -257,28 +257,77 @@ describe('PerMessageDeflate', function () {
it('should compress/decompress data with parameters', function (done) {
const perMessageDeflate = new PerMessageDeflate({
threshold: 0,
memLevel: 5
memLevel: 5,
level: 9
});
const extensions = Extensions.parse(
'permessage-deflate; server_no_context_takeover; ' +
'client_no_context_takeover; server_max_window_bits=10; ' +
'client_max_window_bits=11'
);
const srcData = 'Some compressible data, it\'s compressible.';

perMessageDeflate.accept(extensions['permessage-deflate']);

perMessageDeflate.compress(Buffer.from([1, 2, 3]), true, (err, compressed) => {
perMessageDeflate.compress(Buffer.from(srcData, 'utf8'), true, (err, compressed) => {
if (err) return done(err);

perMessageDeflate.decompress(compressed, true, (err, data) => {
if (err) return done(err);

assert.ok(data.equals(Buffer.from([1, 2, 3])));
assert.ok(data.equals(Buffer.from(srcData, 'utf8')));
done();
});
});
});

it('should compress/decompress with level parameter', function (done) {
const perMessageDeflateLev9 = new PerMessageDeflate({
threshold: 0,
level: 9
});
const perMessageDeflateLev0 = new PerMessageDeflate({
threshold: 0,
level: 0
});
const extensionStr = (
'permessage-deflate; server_no_context_takeover; ' +
'client_no_context_takeover; server_max_window_bits=10; ' +
'client_max_window_bits=11'
);
const srcData = 'Some compressible data, it\'s compressible.';
const srcDataBuffer = Buffer.from(srcData, 'utf8');

perMessageDeflateLev0.accept(Extensions.parse(extensionStr)['permessage-deflate']);
perMessageDeflateLev9.accept(Extensions.parse(extensionStr)['permessage-deflate']);

perMessageDeflateLev0.compress(srcDataBuffer, true, (err, compressed1) => {
if (err) return done(err);

perMessageDeflateLev0.decompress(compressed1, true, (err, data1) => {
if (err) return done(err);

perMessageDeflateLev9.compress(srcDataBuffer, true, (err, compressed2) => {
if (err) return done(err);

perMessageDeflateLev9.decompress(compressed2, true, (err, data2) => {
if (err) return done(err);

// Level 0 compression actually adds a few bytes due to headers
assert.ok(compressed1.length > srcDataBuffer.length);
// Level 9 should not, of course.
assert.ok(compressed2.length < compressed1.length);
assert.ok(compressed2.length < srcDataBuffer.length);
// Ensure they both decompress back properly.
assert.ok(data1.equals(srcDataBuffer));
assert.ok(data2.equals(srcDataBuffer));
done();
});
});
});
});
});

it('should compress/decompress data with no context takeover', function (done) {
const perMessageDeflate = new PerMessageDeflate({ threshold: 0 });
const extensions = Extensions.parse(
Expand Down