'data' argument on callback of Transform._flush() #3708

piranna · 2015-11-07T19:21:22Z

This fixes issue #3707

JungMinu · 2015-11-08T03:53:43Z

@piranna If you are submitting a pull request that adds new functionality, please include one or more tests for the new functionality.

Fishrock123 · 2015-11-08T14:53:10Z

cc @nodejs/streams

domenic · 2015-11-08T15:01:31Z

-1 personally, at least until the use case is explained. The linked issue does not give any reason why this would be a good API change.

calvinmetcalf · 2015-11-08T15:05:27Z

@domenic consistency it's a bit of a footgun that the callback takes the second argument one place and not another, I'm frankly surprised I haven't run into it myself, does need a test though

@piranna take a look at the tests marked stream in this folder which would be where a test for this would go.

piranna · 2015-11-08T15:53:49Z

As @calvinmetcalf says, consistency is the main reason. Yesterday I was doing a Transform and found that _transform() accept to give an optional chunk but _flush() don't, requiring to use push() if you need to send one last data chunk.

I'm currently connected on my cell phone, I'll do the tests tomorrow when I get home.

ChALkeR · 2015-11-08T17:12:02Z

Ah, ignore my previous comment, I see it now.
Still, I don't see why would flush method need to pass data. Do you have a use-case?

piranna · 2015-11-08T19:39:23Z

Still, I don't see why would flush method need to pass data.

As said before, consistency. This transform do nothing for each chunk, but the docs says you can pass data for it on this callback inside _transform(), so someone would think intuitively that it's also possible on this callback inside _flush() but the fact is that's currently not possible. Why I need to call to push() on _flush() but not on _transform()? Don't make sense...

jasnell · 2015-11-14T17:20:37Z

Hmm.. technically there's nothing wrong with the change and I'm not going to give it a -1, but I'm in agreement that consistency in this case does not seem to be a strong enough argument. As far as I can tell, the reason _flush does not take a data parameter is because there's no actual use case justifying passing or using that data. It likely doesn't hurt to have it there, but would anyone actually use it?

piranna · 2015-11-14T17:59:06Z

It likely doesn't hurt to have it there, but would anyone actually use it?

Well, I was going to because intuitively it should work, until I get to the fact that it was not implemented... :-/

(sorry for not adding the tests yet, I'm really busy lately, but didn't forgot about this)

jasnell · 2015-11-14T18:00:20Z

OK that's fair :) out of curiosity, are you able to share the details of
the use case?
On Nov 14, 2015 9:59 AM, "Jesús Leganés Combarro" notifications@github.com
wrote:

It likely doesn't hurt to have it there, but would anyone actually use it?

Well, I was going to because intuitively it should work, until I get to
the fact that it was not implemented... :-/

(sorry for not adding the tests yet, I'm really busy lately, but didn't
forgot about this)

—
Reply to this email directly or view it on GitHub
#3708 (comment).

piranna · 2015-11-14T18:12:09Z

out of curiosity, are you able to share the details of the use case?

Yes, as you can see these two lines would be implemented as only one. Not too much an issue, but you would expect that's possible to do...

jasnell · 2015-11-15T00:07:25Z

Ok. I don't have time to do a technical review at the moment, but could I ask that you please take a moment to expand on the reasons for the change in the commit log message itself? It would be helpful. Thank you!

calvinmetcalf · 2015-11-15T13:06:48Z

see here for the commit message format

jasnell · 2016-03-22T05:49:05Z

@piranna ... still interested in pursuing this?

piranna · 2016-03-22T08:33:25Z

Hi @jasnell, I'm still interested on this, only that I got attention on other issues. I'll try to do the pull-request this afternoon.

piranna · 2016-03-22T19:35:43Z

I've just added the missing test and also added a reference to the new data argument on the docs.

jasnell · 2016-03-22T19:38:00Z

@nodejs/ctc ... thoughts?

trevnorris · 2016-03-23T07:41:12Z

test/parallel/test-stream-transform-flush-data.js

+
+t.end(Buffer.from('blerg'));
+t.on('data', function(data)
+{


mind not dropping the { to the next line?

Sorry, I'm used to Allman style here :-P Fixed :-)

trevnorris · 2016-03-23T07:42:34Z

Adding for API consistency sounds good. Besides the comment I'd also like the commits squashed and a description of the issue in the commit message body. Then add the metadata:

Fixes: https://github.com/nodejs/node/issues/3707

at the bottom of the message body.

Those things addressed, LGTM

piranna · 2016-03-23T21:11:11Z

Commits squashed, and description and commit metadata added :-)

jasnell · 2016-03-23T21:59:15Z

test/parallel/test-stream-transform-flush-data.js

@@ -0,0 +1,24 @@
+'use strict';
+var assert = require('assert');
+var Transform = require('stream').Transform;


please add const common = require('../common') as the first require, and make these const

Done... although common is not used anywhere :-/

jasnell · 2016-03-23T22:01:42Z

Left some comments. With those addressed LGTM

piranna · 2016-06-07T20:55:57Z

@piranna yes please

Done. I've seen that there are conflicts, should I rebase with master too?

mcollina · 2016-06-07T21:01:55Z

Great and yes :).
I'll merge tomorrow (I'm in EU), if nobody objects.

Add a `data` argument on Transform._flush() callback to be API consistent with Transform._transform(). Fixes: nodejs#3707

piranna · 2016-06-07T21:12:15Z

Great and yes :).

Done :-)

I'll merge tomorrow (I'm in EU), if nobody objects.

Me too! I'm from Spain :-) Are you from Italy, maybe? ;-)

mcollina · 2016-06-08T06:54:08Z

@piranna I'm merging now, but I see deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
changed.

If it's ok for you, I'll just avoid that change in this case.


--- a/deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
+++ b/deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
@@ -1146,7 +1146,7 @@ has been called.
 #### transform.\_flush(callback)

 * `callback` {Function} Call this function (optionally with an error
-  argument) when you are done flushing any remaining data.
+  argument and data) when you are done flushing any remaining data.

piranna · 2016-06-08T06:58:13Z

As you see it fits, I did that change to update the API docs, no more.
El 8/6/2016 8:55, "Matteo Collina" notifications@github.com escribió:

@piranna https://github.com/piranna I'm merging now, but I see
deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
changed.

If it's ok for you, I'll just avoid that change in this case.

--- a/deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
+++ b/deps/npm/node_modules/npm-registry-client/node_modules/concat-stream/node_modules/readable-stream/doc/stream.markdown
@@ -1146,7 +1146,7 @@ has been called.

transform._flush(callback)

callback {Function} Call this function (optionally with an error

argument) when you are done flushing any remaining data.

argument and data) when you are done flushing any remaining data.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#3708 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AAgfvv2k-iagAhVAwViCxOSoTNIVMwpjks5qJmdRgaJpZM4GeBEx
.

mcollina · 2016-06-08T07:03:52Z

I don't think that's the right file to change, https://github.com/nodejs/node/blob/master/doc/api/stream.md is.

mcollina · 2016-06-09T09:10:55Z

Landed as 0cd0118.

Add a `data` argument on Transform._flush() callback to be API consistent with Transform._transform(). Fixes: #3707 PR-URL: #3708 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

piranna mentioned this pull request Nov 7, 2015

Allow 'data' argument on callback of Transform._flush() #3707

Closed

mscdex added the stream Issues and PRs related to the stream subsystem. label Nov 8, 2015

Fishrock123 added the semver-minor PRs that contain new features and should be released in the next minor version. label Nov 8, 2015

Trott force-pushed the master branch from 1e896a6 to 082cc8d Compare December 27, 2015 02:01

jasnell added the stalled Issues and PRs that are stalled. label Mar 22, 2016

piranna force-pushed the patch-1 branch from caaf05a to 059b8ee Compare March 22, 2016 19:34

trevnorris reviewed Mar 23, 2016
View reviewed changes

piranna force-pushed the patch-1 branch from 059b8ee to e4f8f37 Compare March 23, 2016 21:09

jasnell reviewed Mar 23, 2016
View reviewed changes

piranna force-pushed the patch-1 branch from 082d5c0 to c6f6ea0 Compare June 7, 2016 20:55

stream: 'data' argument on callback of Transform._flush()

1f238f6

Add a `data` argument on Transform._flush() callback to be API consistent with Transform._transform(). Fixes: nodejs#3707

piranna force-pushed the patch-1 branch from c6f6ea0 to 1f238f6 Compare June 7, 2016 21:11

mcollina closed this Jun 9, 2016

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

aliscco mentioned this pull request Dec 3, 2023

[Snyk] Security upgrade lerna from 3.22.1 to 7.0.0 aliscco/alisco-node#1113

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

'data' argument on callback of Transform._flush() #3708

'data' argument on callback of Transform._flush() #3708

piranna commented Nov 7, 2015

JungMinu commented Nov 8, 2015

Fishrock123 commented Nov 8, 2015

domenic commented Nov 8, 2015

calvinmetcalf commented Nov 8, 2015

piranna commented Nov 8, 2015

ChALkeR commented Nov 8, 2015

piranna commented Nov 8, 2015

jasnell commented Nov 14, 2015

piranna commented Nov 14, 2015

jasnell commented Nov 14, 2015

piranna commented Nov 14, 2015

jasnell commented Nov 15, 2015

calvinmetcalf commented Nov 15, 2015

jasnell commented Mar 22, 2016

piranna commented Mar 22, 2016

piranna commented Mar 22, 2016

jasnell commented Mar 22, 2016

trevnorris Mar 23, 2016

piranna Mar 23, 2016

trevnorris commented Mar 23, 2016

piranna commented Mar 23, 2016

jasnell Mar 23, 2016

piranna Mar 23, 2016

jasnell commented Mar 23, 2016

piranna commented Jun 7, 2016

mcollina commented Jun 7, 2016

piranna commented Jun 7, 2016

mcollina commented Jun 8, 2016

piranna commented Jun 8, 2016

transform._flush(callback)

mcollina commented Jun 8, 2016

mcollina commented Jun 9, 2016

'data' argument on callback of Transform._flush() #3708

'data' argument on callback of Transform._flush() #3708

Conversation

piranna commented Nov 7, 2015

JungMinu commented Nov 8, 2015

Fishrock123 commented Nov 8, 2015

domenic commented Nov 8, 2015

calvinmetcalf commented Nov 8, 2015

piranna commented Nov 8, 2015

ChALkeR commented Nov 8, 2015

piranna commented Nov 8, 2015

jasnell commented Nov 14, 2015

piranna commented Nov 14, 2015

jasnell commented Nov 14, 2015

piranna commented Nov 14, 2015

jasnell commented Nov 15, 2015

calvinmetcalf commented Nov 15, 2015

jasnell commented Mar 22, 2016

piranna commented Mar 22, 2016

piranna commented Mar 22, 2016

jasnell commented Mar 22, 2016

trevnorris Mar 23, 2016

Choose a reason for hiding this comment

piranna Mar 23, 2016

Choose a reason for hiding this comment

trevnorris commented Mar 23, 2016

piranna commented Mar 23, 2016

jasnell Mar 23, 2016

Choose a reason for hiding this comment

piranna Mar 23, 2016

Choose a reason for hiding this comment

jasnell commented Mar 23, 2016

piranna commented Jun 7, 2016

mcollina commented Jun 7, 2016

piranna commented Jun 7, 2016

mcollina commented Jun 8, 2016

piranna commented Jun 8, 2016

transform._flush(callback)

mcollina commented Jun 8, 2016

mcollina commented Jun 9, 2016