test: add tests for stream3 buffering using cork #6493

alexjeffburke · 2016-04-30T21:36:19Z

Checklist

tests and code linting passes
a test and/or benchmark is included
the commit message follows commit guidelines

Description of change

Add tests of stream3 the buffering behaviour of cork() followed by uncork()/end(). Opening a PR for review per request of the streams-wg.

cc @nodejs/readable-stream

calvinmetcalf · 2016-04-30T21:59:56Z

@nodejs/streams

mcollina · 2016-05-01T10:57:20Z

Thanks!!! You might want to check this runs on node v4, just in case.

I think we should start the habit of explaining the tests in plain English first, because otherwise they imply a lot of knowledge around the stream state machine and they might scare newcomers. Most of it is already explained in the comments, it's probably just a matter of putting a paragraph to describe it at the beginning.

Use const instead of var for the non-changing variables. I will also argue that we should stick to use function () {} instead of the fat arrows when we attach methods to prototypes.

How about you add a test also for _writev?

alexjeffburke · 2016-05-01T19:14:04Z

Thanks for the feedback @mcollina - so I've just pushed an update with the following changes:

set _write using a full function (having looked kinda like it too)
used const for includes and expectedChunks
tightened up a couple of the comments

Regarding _writev, it appeared to me test-stream-writev.js does some of that but I don't think its the most approachable code. What I'd be tempted to do in that case is separate out a test for all the different encodings from the buffering behaviour using it.

Finally, happy to add a paragraph but the question would be where and using /* */ or multiple // ? Could you perhaps point me to another file where this is done, keen to follow not set any precedents for now :)

calvinmetcalf · 2016-05-01T19:58:51Z

What I'd be tempted to do in that case is separate out a test for all the different encodings from the buffering behaviour using it.

that would be amazing

as for comment style I believe they tend to be // but I don't believe there are hard and fast rules

jasnell · 2016-05-01T20:14:22Z

test/parallel/test-stream3-cork-end.js

+    // there was a chunk
+    assert.ok(seen);
+
+    var expected = new Buffer(expectedChunks[i]);


Buffer.from(expectedChunks[i])

jasnell · 2016-05-01T20:18:27Z

Left a couple nits pointing where Buffer.from() can be used instead of new Buffer(). That would obviously only apply to master/v6/v5 tho so if this test also needs to run in v4, feel free to ignore!

alexjeffburke · 2016-05-01T20:35:09Z

@jasnell appreciate you taking a look!

I'm happy to do that, but per discussions of @nodejs/streams it may be preferable to allow these to run against all versions of node that implement streams3. What could be worth an explicit decision is if that should be evident within 'in-tree' files or if any necessary glue be added in ports to readable-stream repo.

jasnell · 2016-05-01T21:00:51Z

Works for me... as I said, feel free to ignore ;-) That's actually the main reason why I didn't go through all of the existing tests and change them to use Buffer.from (or the other ones).

Come to think of it, as a best practice it might be a good idea to explicitly indicate (using code comments) in the tests themselves which node.js versions the test needs to be able to run on.

Trott · 2016-05-02T03:56:27Z

Come to think of it, as a best practice it might be a good idea to explicitly indicate (using code comments) in the tests themselves which node.js versions the test needs to be able to run on.

Yes, please. My dream is to eventually have that information as metadata in test comments so that an automated process can confirm that changes to tests don't suddenly make them pass in versions where they are supposed to fail. But that is way beyond the scope of this PR. :-)

mcollina · 2016-05-02T06:47:38Z

👍 on writing a comment stating on which node version this belongs to.

alexjeffburke · 2016-05-06T10:45:58Z

I'll look at adding those descriptive paragraphs - as for versioning, any objection to the following:

// node version target: 0.12

alexjeffburke · 2016-05-08T18:29:53Z

Just updated these two tests to address comments:

added a couple of lines explaining the test
included some info about the node version targeted

I also renamed consumeChunks() -> writeChunks() to better its behaviour.

mcollina · 2016-05-09T06:32:21Z

Apart for the two Buffer.from nits, LGTM.

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

calvinmetcalf · 2016-05-09T11:31:00Z

fyi I've got a shim working so I can run the readable streams (including the Buffer.from) against old node

alexjeffburke · 2016-05-09T11:58:10Z

@mcollina @calvinmetcalf re Buffer.from() - I understand the objection, but that's why I previously asked which version of node in-tree tests should target hence the exchange with @jasnell above :)

It's easy enough to conditionally check for the Buffer method etc, but it's still unclear whether the in-tree tests should target the lowest version of node (thus compat glue be added in test) or if it is ok for this to be handled in the readable-streams repo.

jasnell · 2016-05-09T15:35:12Z

Given the requirement that readable-stream has to support older versions of Node I think not going with the Buffer.from() here is appropriate.

calvinmetcalf · 2016-05-09T17:00:54Z

sorry, to clarify this is handled in readable-stream already

alexjeffburke · 2016-05-11T08:44:41Z

Seems like I can leave the files as is with 'new Buffer()'. Given previous LGTMs, is there anything else I should do before these can be landed?

jasnell · 2016-05-11T15:27:00Z

LGTM if @nodejs/streams is good with it.

calvinmetcalf · 2016-05-12T22:09:49Z

yup it's good, merged

alexjeffburke · 2016-05-13T18:50:09Z

Awesome, thanks! Very glad this was useful.

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins · 2016-06-02T00:34:33Z

@nodejs/streams should this be backported to v4?

mcollina · 2016-06-03T06:58:52Z

@thealphanerd Ideally yes, if it is not passing ping us.

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added the test Issues and PRs related to the tests. label Apr 30, 2016

alexjeffburke changed the title ~~Cork tests~~ test: add tests for stream3 buffering using cork Apr 30, 2016

alexjeffburke mentioned this pull request Apr 30, 2016

Streams tests guidance nodejs/readable-stream#204

Closed

mscdex added the stream Issues and PRs related to the stream subsystem. label Apr 30, 2016

jasnell reviewed May 1, 2016
View reviewed changes

alexjeffburke added 2 commits May 8, 2016 19:18

test: add streams3 cork then uncork test

91fd3f3

test: add streams3 cork then end test

f0fe696

calvinmetcalf merged commit 9d0b7d8 into nodejs:master May 12, 2016

evanlucas pushed a commit that referenced this pull request May 17, 2016

test: add tests for stream3 buffering using cork

71c9174

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

evanlucas mentioned this pull request May 17, 2016

2016-05-17, Version 6.2.0 (Stable) #6810

Merged

MylesBorins added the lts-watch-v4.x label Jun 2, 2016

MylesBorins pushed a commit that referenced this pull request Jul 11, 2016

test: add tests for stream3 buffering using cork

8a8a268

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Jul 11, 2016

MylesBorins pushed a commit that referenced this pull request Jul 11, 2016

test: add tests for stream3 buffering using cork

caf8869

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins pushed a commit that referenced this pull request Jul 12, 2016

test: add tests for stream3 buffering using cork

bf7c904

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins pushed a commit that referenced this pull request Jul 12, 2016

test: add tests for stream3 buffering using cork

dd26b97

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins mentioned this pull request Jul 12, 2016

v4.5.0 proposal #7688

Merged

MylesBorins pushed a commit that referenced this pull request Jul 14, 2016

test: add tests for stream3 buffering using cork

944ac54

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

MylesBorins pushed a commit that referenced this pull request Jul 14, 2016

test: add tests for stream3 buffering using cork

5f444ed

adds 2 new tests for streams3 cork behavior, cork then uncork and cork then end PR-URL: #6493 Reviewed-By: James M Snell <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add tests for stream3 buffering using cork #6493

test: add tests for stream3 buffering using cork #6493

alexjeffburke commented Apr 30, 2016 •

edited

Loading

calvinmetcalf commented Apr 30, 2016

mcollina commented May 1, 2016

alexjeffburke commented May 1, 2016

calvinmetcalf commented May 1, 2016

jasnell May 1, 2016

jasnell commented May 1, 2016 •

edited

Loading

alexjeffburke commented May 1, 2016

jasnell commented May 1, 2016

Trott commented May 2, 2016

mcollina commented May 2, 2016

alexjeffburke commented May 6, 2016

alexjeffburke commented May 8, 2016

mcollina commented May 9, 2016

calvinmetcalf commented May 9, 2016

alexjeffburke commented May 9, 2016 •

edited

Loading

jasnell commented May 9, 2016

calvinmetcalf commented May 9, 2016

alexjeffburke commented May 11, 2016

jasnell commented May 11, 2016

calvinmetcalf commented May 12, 2016 •

edited

Loading

alexjeffburke commented May 13, 2016

MylesBorins commented Jun 2, 2016

mcollina commented Jun 3, 2016 •

edited

Loading

test: add tests for stream3 buffering using cork #6493

test: add tests for stream3 buffering using cork #6493

Conversation

alexjeffburke commented Apr 30, 2016 • edited Loading

Checklist

Description of change

calvinmetcalf commented Apr 30, 2016

mcollina commented May 1, 2016

alexjeffburke commented May 1, 2016

calvinmetcalf commented May 1, 2016

jasnell May 1, 2016

Choose a reason for hiding this comment

jasnell commented May 1, 2016 • edited Loading

alexjeffburke commented May 1, 2016

jasnell commented May 1, 2016

Trott commented May 2, 2016

mcollina commented May 2, 2016

alexjeffburke commented May 6, 2016

alexjeffburke commented May 8, 2016

mcollina commented May 9, 2016

calvinmetcalf commented May 9, 2016

alexjeffburke commented May 9, 2016 • edited Loading

jasnell commented May 9, 2016

calvinmetcalf commented May 9, 2016

alexjeffburke commented May 11, 2016

jasnell commented May 11, 2016

calvinmetcalf commented May 12, 2016 • edited Loading

alexjeffburke commented May 13, 2016

MylesBorins commented Jun 2, 2016

mcollina commented Jun 3, 2016 • edited Loading

alexjeffburke commented Apr 30, 2016 •

edited

Loading

jasnell commented May 1, 2016 •

edited

Loading

alexjeffburke commented May 9, 2016 •

edited

Loading

calvinmetcalf commented May 12, 2016 •

edited

Loading

mcollina commented Jun 3, 2016 •

edited

Loading