zlib: add ArrayBuffer support #16042

jemjam · 2017-10-06T19:37:52Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

zlib, src

TimothyGu

We'll have to run this through CI before landing, but CI is currently busy with the 220+ code+learn PRs... so let's wait a bit.

TimothyGu · 2017-10-07T06:00:33Z

doc/api/zlib.md

@@ -308,7 +311,7 @@ ignored by the decompression classes.
 * `level` {integer} (compression only)
 * `memLevel` {integer} (compression only)
 * `strategy` {integer} (compression only)
-* `dictionary` {Buffer|TypedArray|DataView} (deflate/inflate only, empty dictionary by
+* `dictionary` {Buffer|TypedArray|DataView|ArrayBuffer} (deflate/inflate only, empty dictionary by


Looks like this line might exceed 80 characters... either you can re-wrap, or we can do it while landing this.

TimothyGu · 2017-10-07T06:01:19Z

src/util.h

+    v8::ArrayBuffer::Contents name##_c = name->GetContents();                 \
+    name##_length = name##_c.ByteLength();                                    \
+    name##_data =                                                             \
+        static_cast<char*>(name##_c.Data());                                  \


These two lines can be joined into one. Again, it would be great if you could fix that, but if not we can fix that while landing.

cjihrig · 2017-10-07T13:40:24Z

lib/zlib.js

@@ -238,7 +241,7 @@ function Zlib(opts, mode) {
    }

    dictionary = opts.dictionary;
-    if (dictionary !== undefined && !isArrayBufferView(dictionary)) {
+    if (dictionary !== undefined && !isArrayBufferView(dictionary) && !isAnyArrayBuffer(dictionary)) {


This line needs to be wrapped at 80 characters as well.

addaleax

LGTM

I know this is tricky, but can we actually split the non-zlib changes into its own commit? Can happen while landing as well :)

addaleax · 2017-10-07T17:31:01Z

CI: https://ci.nodejs.org/job/node-test-commit/12848/

jemjam · 2017-10-07T19:51:57Z

I addressed those couple of line length issues. Is there a code style guide somewhere that I should reference in the future? (I just ran my changes through eslint to get an idea of what to change.)

@addaleax did you link to some CI issues there? Looks like some failures. I had a glance but am not certain about the output there.

Also: when you suggested splitting were you talking the C++ code for the ArrayBuffers? Big thanks to @TimothyGu for holding my hand during my updating those; however I thought the work was pretty interrelated? If you want that part split, can it happen "during landing" as you suggested.

addaleax · 2017-10-07T20:40:25Z

@JemBijoux I started CI jobs for this, yes. The failures look like this:

    assert.js:45
      throw new errors.AssertionError({
      ^
    
    AssertionError [ERR_ASSERTION]: 'The "buffer" argument must be one of type string, Buffer, TypedArray, DataView, or ArrayBuffer' === 'The "buffer" argument must be one of type string, Buffer, TypedArray, or DataView'
        at Object.<anonymous> (/home/iojs/build/workspace/node-test-commit-linux/nodes/ubuntu1610-x64/test/common/index.js:723:16)
        at Object.<anonymous> (/home/iojs/build/workspace/node-test-commit-linux/nodes/ubuntu1610-x64/test/common/index.js:517:15)
        at expectedException (assert.js:651:19)
        at innerThrows (assert.js:685:21)
        at Function.throws (assert.js:702:3)
        at Object.expectsError (/home/iojs/build/workspace/node-test-commit-linux/nodes/ubuntu1610-x64/test/common/index.js:745:12)
        at __dirname.forEach (/home/iojs/build/workspace/node-test-commit-linux/nodes/ubuntu1610-x64/test/parallel/test-zlib-not-string-or-buffer.js:10:10)
        at Array.forEach (<anonymous>)
        at Object.<anonymous> (/home/iojs/build/workspace/node-test-commit-linux/nodes/ubuntu1610-x64/test/parallel/test-zlib-not-string-or-buffer.js:9:65)
        at Module._compile (module.js:600:30)

Can you reproduce those by running make test?

And, what I’m basically thinking is that the changes to src/node_buffer.cc could be in their own commit, because they are worth calling out explicitly in the changelog: They change the API for all native addon authors, and that’s not really obvious if the commit is referring only to zlib. That’s basically all. :)

jemjam · 2017-10-09T23:26:50Z

Hey! So I was able to confirm the issue with the test and make that fix no problem. All tests passing again.

I also moved that node_buffer.cc file into it's own commit now (#16111). However, when I did that, one of the changes to a test I had here started to fail also in test/parallel/test-zlib-convenience-methods.js so I've removed that change for now.

lpinca · 2017-10-14T08:17:11Z

CI: https://ci.nodejs.org/job/node-test-pull-request/10711/

BridgeAR · 2017-10-18T20:33:53Z

I think this is ready to land. Ping @TimothyGu

addaleax · 2017-10-18T20:38:36Z

@BridgeAR See also the discussion in #16111 … I am not quite at the point where I think extending the Buffer code for this is necessarily a great idea …

I think for now it might be nicer to let this be a zlib-only thing and create an Uint8Array for passed ArrayBuffers, then work with that, if we want support?

BridgeAR · 2017-10-18T20:55:55Z

I see. In that case I just mark this accordingly for now. Thanks for the heads up!

Trott · 2017-10-27T17:12:00Z

I'm a little unsure what the situation is here. What would have to happen for this to get unblocked?

Trott · 2017-10-29T02:04:07Z

I'm a little unsure what the situation is here. What would have to happen for this to get unblocked?

Ping @BridgeAR @addaleax

gireeshpunathil · 2017-10-31T06:32:05Z

ping @BridgeAR and @addaleax again to have another look ( one of 3 remaining code-and-learn PRs!)

addaleax · 2017-10-31T18:00:27Z

This is blocked on #16111, that’s all.

I think for zlib this might make more sense than for the general case of all Buffer-taking APIs (although “compress a chunk of memory” is still going to be exceedingly rare compared to “compress a chunk of data”, conceptually).

It might be a nicer approach to create a Uint8Array over it when an ArrayBuffer is passed to the API? @TimothyGu ?

TimothyGu · 2017-12-06T18:54:47Z

I've rebased this patch to be minimally invasive with regards to public APIs. @addaleax, @jasnell, @joyeecheung, @lpinca, @BridgeAR, @cjihrig, PTAL.

CI: https://ci.nodejs.org/job/node-test-pull-request/11917/

PR-URL: nodejs#16042 Refs: nodejs#1826 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

addaleax · 2017-12-13T05:44:58Z

Landed in 2848718 🎉

PR-URL: #16042 Refs: #1826 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Notable change: * async_hooks: - deprecate AsyncHooks Sensitive API and runInAsyncIdScope. Neither API were documented. (Andreas Madsen) #16972 * deps: - update nghttp2 to 1.29.0 (James M Snell) #17908 - upgrade npm to 5.6.0 (Kat Marchán) #17535 - cherry-pick 50f7455 from upstream V8 (Michaël Zasso) #16591 * events: - remove reaches into _events internals (Anatoli Papirovski) #17440 * http: - add rawPacket in err of `clientError` event (XadillaX) #17672 * http2: - implement maxSessionMemory (James M Snell) #17967 - add initial support for originSet (James M Snell) #17935 - add altsvc support (James M Snell) #17917 - perf_hooks integration (James M Snell) #17906 * net: - remove Socket.prototype.write (Anna Henningsen) #17644 - remove Socket.prototype.listen (Ruben Bridgewater) #13735 * repl: - show lexically scoped vars in tab completion (Michaël Zasso) #16591 * stream: - rm {writeable/readable}State.length (Calvin Metcalf) #12857 - add flow and buffer properties to streams (Calvin Metcalf) #12855 * util: - allow wildcards in NODE_DEBUG variable (Tyler) #17609 * zlib: - add ArrayBuffer support (Jem Bezooyen) #16042 * Addedew collaborator** - [starkwang](https://github.com/starkwang) Weijia Wang * Addedew TSC member** - [danbev](https://github.com/danbev) Daniel Bevenius PR-URL: #18069

Notable change: * async_hooks: - deprecate AsyncHooks Sensitive API and runInAsyncIdScope. Neither API were documented. (Andreas Madsen) #16972 * deps: - update nghttp2 to 1.29.0 (James M Snell) #17908 - upgrade npm to 5.6.0 (Kat Marchán) #17535 - cherry-pick 50f7455 from upstream V8 (Michaël Zasso) #16591 * events: - remove reaches into _events internals (Anatoli Papirovski) #17440 * http: - add rawPacket in err of `clientError` event (XadillaX) #17672 * http2: - implement maxSessionMemory (James M Snell) #17967 - add initial support for originSet (James M Snell) #17935 - add altsvc support (James M Snell) #17917 - perf_hooks integration (James M Snell) #17906 - Refactoring and cleanup of Http2Session and Http2Stream destroy (James M Snell) #17406 * net: - remove Socket.prototype.write (Anna Henningsen) #17644 - remove Socket.prototype.listen (Ruben Bridgewater) #13735 * repl: - show lexically scoped vars in tab completion (Michaël Zasso) #16591 * stream: - rm {writeable/readable}State.length (Calvin Metcalf) #12857 - add flow and buffer properties to streams (Calvin Metcalf) #12855 * util: - allow wildcards in NODE_DEBUG variable (Tyler) #17609 * zlib: - add ArrayBuffer support (Jem Bezooyen) #16042 * Addedew collaborator** - [starkwang](https://github.com/starkwang) Weijia Wang * Addedew TSC member** - [danbev](https://github.com/danbev) Daniel Bevenius PR-URL: #18069

MylesBorins · 2018-08-02T14:37:15Z

Would we want to backport to v8.x? If so this will need a manual backport

nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. c++ Issues and PRs that require attention from people who are familiar with C++. zlib Issues and PRs related to the zlib subsystem. labels Oct 6, 2017

Trott added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Oct 6, 2017

TimothyGu approved these changes Oct 7, 2017

View reviewed changes

cjihrig reviewed Oct 7, 2017

View reviewed changes

addaleax approved these changes Oct 7, 2017

View reviewed changes

addaleax added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 7, 2017

jemjam mentioned this pull request Oct 9, 2017

Change node_buffer to accept ArrayBuffer #16111

Closed

3 tasks

lpinca approved these changes Oct 14, 2017

View reviewed changes

joyeecheung approved these changes Oct 14, 2017

View reviewed changes

TimothyGu self-assigned this Oct 14, 2017

jasnell approved these changes Oct 15, 2017

View reviewed changes

BridgeAR approved these changes Oct 18, 2017

View reviewed changes

BridgeAR added discuss Issues opened for discussions and feedbacks. blocked PRs that are blocked by other issues or PRs. labels Oct 18, 2017

Trott added code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. and removed code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. labels Oct 27, 2017

TimothyGu removed c++ Issues and PRs that require attention from people who are familiar with C++. discuss Issues opened for discussions and feedbacks. labels Dec 6, 2017

MylesBorins force-pushed the master branch from b7405ab to 7f086dd Compare December 8, 2017 16:37

joyeecheung approved these changes Dec 11, 2017

View reviewed changes

jasnell approved these changes Dec 12, 2017

View reviewed changes

addaleax approved these changes Dec 13, 2017

View reviewed changes

addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 13, 2017

addaleax closed this Dec 13, 2017

addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 13, 2017

MylesBorins mentioned this pull request Jan 10, 2018

v9.4.0 proposal #18069

Merged

MylesBorins added the backport-requested-v8.x label Aug 2, 2018

BeniCheni mentioned this pull request Oct 2, 2018

Accept ArrayBuffer (and typed array/data view?) anywhere Buffer is allowed in the API #1826

Closed

vsemozhetbyt mentioned this pull request Dec 21, 2018

doc: fix links in test/common/README.md #25172

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zlib: add ArrayBuffer support #16042

zlib: add ArrayBuffer support #16042

jemjam commented Oct 6, 2017 •

edited

Loading

TimothyGu left a comment

TimothyGu Oct 7, 2017

TimothyGu Oct 7, 2017

cjihrig Oct 7, 2017

addaleax left a comment

addaleax commented Oct 7, 2017

jemjam commented Oct 7, 2017

addaleax commented Oct 7, 2017

jemjam commented Oct 9, 2017

lpinca commented Oct 14, 2017

BridgeAR commented Oct 18, 2017

addaleax commented Oct 18, 2017

BridgeAR commented Oct 18, 2017 •

edited

Loading

Trott commented Oct 27, 2017

Trott commented Oct 29, 2017

gireeshpunathil commented Oct 31, 2017

addaleax commented Oct 31, 2017

TimothyGu commented Dec 6, 2017

addaleax commented Dec 13, 2017

MylesBorins commented Aug 2, 2018

zlib: add ArrayBuffer support #16042

zlib: add ArrayBuffer support #16042

Conversation

jemjam commented Oct 6, 2017 • edited Loading

Checklist

Affected core subsystem(s)

TimothyGu left a comment

Choose a reason for hiding this comment

TimothyGu Oct 7, 2017

Choose a reason for hiding this comment

TimothyGu Oct 7, 2017

Choose a reason for hiding this comment

cjihrig Oct 7, 2017

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

addaleax commented Oct 7, 2017

jemjam commented Oct 7, 2017

addaleax commented Oct 7, 2017

jemjam commented Oct 9, 2017

lpinca commented Oct 14, 2017

BridgeAR commented Oct 18, 2017

addaleax commented Oct 18, 2017

BridgeAR commented Oct 18, 2017 • edited Loading

Trott commented Oct 27, 2017

Trott commented Oct 29, 2017

gireeshpunathil commented Oct 31, 2017

addaleax commented Oct 31, 2017

TimothyGu commented Dec 6, 2017

addaleax commented Dec 13, 2017

MylesBorins commented Aug 2, 2018

jemjam commented Oct 6, 2017 •

edited

Loading

BridgeAR commented Oct 18, 2017 •

edited

Loading