test: Http2Stream redundant call to shutdown and call passing only callback #15612

trivikr · 2017-09-25T16:32:14Z

This PR includes test cases for the handling of:

redundant call of stream.session.shutdown()
calling stream.session.shutdown() with only callback (no options)

Refs: #14985

Checklist

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

Affected core subsystem(s)

test, http2

apapirovski

Thanks for the work @trivikr! I think in general it's better to do these as one test since the 1st test is strictly a subset of the 2nd test. If the first mustCall doesn't fire in the 2nd test then the results are equivalent.

I would also suggest expanding this to cover this[kState].destroyed || this[kState].destroying behaviour (throws). (Feel free to add comments to annotate the different steps.)

apapirovski · 2017-09-25T16:52:11Z

test/parallel/test-http2-server-shutdown-redundant.js

+  stream.session.shutdown(common.mustCall(() => {
+    assert.strictEqual(
+      stream.session.shutdown(),
+      undefined


I think it's better if this also checks that it doesNotThrow.

assert.strictEqual will ensure that no error is thrown
Tested on repl

apapirovski · 2017-09-25T16:56:51Z

test/parallel/test-http2-server-shutdown-redundant.js

+server.on('stream', common.mustCall((stream) => {
+  stream.session.shutdown(common.mustCall(() => {
+    assert.strictEqual(
+      stream.session.shutdown(),


I would suggest adding common.mustNotCall() so that it's clear that the callback only executes once.

apapirovski · 2017-09-25T16:58:06Z

test/parallel/test-http2-server-shutdown-redundant.js

+
+// Test blank return when a stream.session.shutdown is called twice
+server.on('stream', common.mustCall((stream) => {
+  stream.session.shutdown(common.mustCall(() => {


I would also run another stream.session.shutdown(common.mustNotCall()) outside of the callback. If there are two calls in a row, it shouldn't throw or execute a callback a 2nd time. (This would cover a case where someone moves the shuttingDown setting into a nextTick or event or something, or just removes it period.)

trivikr · 2017-09-25T17:58:32Z

I agree to comment by @apapirovski #15612 (review) that the test test-http2-server-shutdown-redundant.js is a subset of test in test-http2-server-shutdown-only-callback.js
I've kept them separate as they serve specific purpose.

The test to cover this[kState].destroyed || this[kState].destroying was added in my first PR with NodeJS at #15597

apapirovski · 2017-09-25T18:04:22Z

Yeah, my bad re: the 2nd point. Should've realized, haha. :)

I'm still not sure I understand what test-http2-server-shutdown-only-callback.js does that the other test doesn't. It seems to me like a naming and comment problem rather than a distinct test. I could be misunderstanding though...

trivikr · 2017-09-25T18:16:58Z

I've removed the test test-http2-server-shutdown-only-callback.js and added a comment in test-http2-server-shutdown-redundant.js that it also tests only callback use case.

trivikr · 2017-09-25T18:20:26Z

When the commits are squashed before merge, the commit message should be:

test: Http2Stream redundant shutdown and single callback

Refs: #14985

apapirovski · 2017-09-25T18:33:16Z

Thanks @trivikr! 👍 I realize these were sort of nits but just to explain my reasoning:

There are currently over 1200+ tests and it's growing all the time, so as much as possible it's good to avoid highly specialized test cases if the same can be accomplished by a single slightly longer test case that goes through a few stages (as long as it doesn't compromise the test result). That way we can avoid having duplicate code and unnecessary amount of buildup and teardown of tests. (If you look at the node CI, it runs all the tests on some truly ancient/slow systems.)

See some of these other http2 tests:
https://github.com/nodejs/node/blob/master/test/parallel/test-http2-compat-serverresponse-end.js
https://github.com/nodejs/node/blob/master/test/parallel/test-http2-compat-serverresponse-destroy.js

trivikr · 2017-09-25T19:01:52Z

I completely agree with @apapirovski
The command make test takes around 20 minutes to run on MacBook Pro (Retina, 13-inch, Early 2015)

It's difficult to run single test also. I went through Makefile and came up with a python command to runs single test

node/Makefile

Line 204 in 4f4d55d

$(PYTHON) tools/test.py --mode=release -J \

Questions:

Is easing development by providing an ability to debug/run single tests being tracked somewhere? If the support is already available, can it be updated in writing tests guide
Does NodeJS plan to move a easier/faster test framework like Jest?

The above issues weren't blocking me for this task, so I didn't create issues.
We can create issues/tasks and follow up to get more developers onboard.

bnoordhuis · 2017-09-25T20:07:33Z

Is easing development by providing an ability to debug/run single tests being tracked somewhere?

It's documented in CONTRIBUTING.md, if that is what you mean. You are welcome to add it to the 'writing tests' guide though.

Does NodeJS plan to move a easier/faster test framework like Jest?

No.

trivikr · 2017-09-25T21:30:20Z

Squashed all commits into a single one, and force pushed it my private branch.

trivikr · 2017-09-28T02:57:01Z

What's the procedure to merge these changes to master? Do we have wait for certain time for approvals before merging?

BridgeAR · 2017-09-28T06:02:07Z

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

trivikr · 2017-09-29T03:11:05Z

@BridgeAR rebased with https://github.com/nodejs/node/tree/master

jasnell · 2017-09-29T16:48:48Z

@trivikr ... yes, PRs generally must sit for at least 48 hours during the week and 72 hours over the weekend before they can be landed. Exception is given only to trivial doc updates. Also, things must go through a CI test run.

jasnell · 2017-09-29T16:49:46Z

Oh, and I see you added a merge commit. Generally, we always use rebase and avoid using merge commits. Before I get this landed, can I ask you to drop the merge commit and rebase from master?

Refs: nodejs#14985

trivikr · 2017-09-30T07:56:46Z

Dropped the merge commit and performed git rebase as suggested by @jasnell and documentation

jasnell · 2017-10-01T05:29:46Z

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

BridgeAR · 2017-10-01T23:19:43Z

Landed in 27d8202

PR-URL: #15612 Refs: #14985 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

trivikr · 2017-10-01T23:44:45Z

Thanks @BridgeAR
This is my first PR to NodeJS - a small step to contribute more to this awesome project :-)

apapirovski · 2017-10-01T23:49:39Z

Congrats @trivikr! Thanks for contributing 🎉

PR-URL: #15612 Refs: #14985 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

PR-URL: nodejs/node#15612 Refs: nodejs/node#14985 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

PR-URL: #15612 Refs: #14985 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

nodejs-github-bot added the test Issues and PRs related to the tests. label Sep 25, 2017

mscdex added the http2 Issues or PRs related to the http2 subsystem. label Sep 25, 2017

apapirovski reviewed Sep 25, 2017

View reviewed changes

jasnell approved these changes Sep 25, 2017

View reviewed changes

trivikr force-pushed the http2-test-stream-shutdown branch from 328081e to e853dc4 Compare September 25, 2017 21:28

hiroppy approved these changes Sep 26, 2017

View reviewed changes

lpinca approved these changes Sep 26, 2017

View reviewed changes

BridgeAR approved these changes Sep 28, 2017

View reviewed changes

trivikr force-pushed the http2-test-stream-shutdown branch from e853dc4 to 1498dbb Compare September 29, 2017 03:09

test: Http2Stream redundant shutdown and single callback

63c865c

Refs: nodejs#14985

trivikr force-pushed the http2-test-stream-shutdown branch from 695540e to 63c865c Compare September 30, 2017 07:55

BridgeAR closed this Oct 1, 2017

trivikr deleted the http2-test-stream-shutdown branch October 1, 2017 23:44

MylesBorins mentioned this pull request Oct 3, 2017

v8.7.0 proposal #15762

Merged

MylesBorins added the dont-land-on-v6.x label Oct 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: Http2Stream redundant call to shutdown and call passing only callback #15612

test: Http2Stream redundant call to shutdown and call passing only callback #15612

trivikr commented Sep 25, 2017

apapirovski left a comment •

edited

Loading

apapirovski Sep 25, 2017

trivikr Sep 25, 2017

apapirovski Sep 25, 2017

trivikr Sep 25, 2017

apapirovski Sep 25, 2017 •

edited

Loading

trivikr Sep 25, 2017

trivikr commented Sep 25, 2017

apapirovski commented Sep 25, 2017 •

edited

Loading

trivikr commented Sep 25, 2017

trivikr commented Sep 25, 2017

apapirovski commented Sep 25, 2017

trivikr commented Sep 25, 2017

bnoordhuis commented Sep 25, 2017

trivikr commented Sep 25, 2017

trivikr commented Sep 28, 2017

BridgeAR commented Sep 28, 2017

trivikr commented Sep 29, 2017

jasnell commented Sep 29, 2017

jasnell commented Sep 29, 2017

trivikr commented Sep 30, 2017

jasnell commented Oct 1, 2017

BridgeAR commented Oct 1, 2017

trivikr commented Oct 1, 2017

apapirovski commented Oct 1, 2017

test: Http2Stream redundant call to shutdown and call passing only callback #15612

test: Http2Stream redundant call to shutdown and call passing only callback #15612

Conversation

trivikr commented Sep 25, 2017

Checklist

Affected core subsystem(s)

apapirovski left a comment • edited Loading

Choose a reason for hiding this comment

apapirovski Sep 25, 2017

Choose a reason for hiding this comment

trivikr Sep 25, 2017

Choose a reason for hiding this comment

apapirovski Sep 25, 2017

Choose a reason for hiding this comment

trivikr Sep 25, 2017

Choose a reason for hiding this comment

apapirovski Sep 25, 2017 • edited Loading

Choose a reason for hiding this comment

trivikr Sep 25, 2017

Choose a reason for hiding this comment

trivikr commented Sep 25, 2017

apapirovski commented Sep 25, 2017 • edited Loading

trivikr commented Sep 25, 2017

trivikr commented Sep 25, 2017

apapirovski commented Sep 25, 2017

trivikr commented Sep 25, 2017

bnoordhuis commented Sep 25, 2017

trivikr commented Sep 25, 2017

trivikr commented Sep 28, 2017

BridgeAR commented Sep 28, 2017

trivikr commented Sep 29, 2017

jasnell commented Sep 29, 2017

jasnell commented Sep 29, 2017

trivikr commented Sep 30, 2017

jasnell commented Oct 1, 2017

BridgeAR commented Oct 1, 2017

trivikr commented Oct 1, 2017

apapirovski commented Oct 1, 2017

apapirovski left a comment •

edited

Loading

apapirovski Sep 25, 2017 •

edited

Loading

apapirovski commented Sep 25, 2017 •

edited

Loading