stream: move legacy to lib/internal dir #8197

yorkie · 2016-08-20T12:12:47Z

Checklist

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

Affected core subsystem(s)

stream

Description of change

This won't fix anything problem or adds any new feature, it just makes the "lib/stream.js" clear to read in my opinion, I'm unsure if this makes any sense, if the feedback from anyone in @nodejs/collaborators is negative, feel free to close :-)

seishun · 2016-08-20T13:49:45Z

I don't feel qualified to judge the implementation, but +1 on the idea.

brendanashworth · 2016-08-20T19:14:50Z

lib/_stream_legacy.js

@@ -0,0 +1,91 @@
+'use strict';


Perhaps this belongs in lib/internal/streams/ instead?

The reason is? IMO the legacy stream class should not be internal class, it's exposed to user-land, right?

That makes sense, especially since everything in the file is exported. Nevermind! :)

Fishrock123 · 2016-08-21T14:03:39Z

I think it would be better to put it in an internal file and have _stream_legacy export it as deprecated.

yorkie · 2016-08-21T18:34:32Z

@Fishrock123 what do you mean by "have _stream_legacy" export it as deprecated"? Could you explain more, thanks :-)

yorkie · 2016-08-21T18:35:35Z

And I will try to put the legacy file to internal dir as @Fishrock123 and @brendanashworth expected.

jasnell · 2016-08-21T22:08:16Z

@nodejs/streams ... please take a look at this. Would moving this to internal have a detrimental impact on the readable-streams module?

mcollina · 2016-08-22T07:00:02Z

@yorkie we have 3 major versions of streams: 1, 2 and 3. "legacy" is version 1, and it is used by modules such as through, split, serial-port and the like. It comes from the 0.8 era. Since 0.10 we had streams 2, and streams 3. Streams 3 are fairly stable, with their own quirks.

I think we should deprecate streams 1 as semver-major, and maybe remove it in a year or two.

I'll leave the question about readable-stream to @calvinmetcalf

mcollina · 2016-12-22T13:36:00Z

@calvinmetcalf ping?

mcollina · 2016-12-22T13:37:26Z

@jasnell @yorkie no it would not. We can move to internal without issues: there is no difference for us the moment it's on another file.

calvinmetcalf · 2016-12-22T14:15:53Z

I mean yes this would involve a bit of work to upgrade readable-stream, but it wouldn't be a big deal, honestly a drop in the bucket compared to other stuff so don't worry about it on my account.

mcollina · 2016-12-22T14:21:44Z

@yorkie can you please rebase/update this PR on top of master, we can land this.

yorkie · 2017-01-06T06:29:57Z

@mcollina does this PR necessary to land, current master seems not have the internal dir?

mcollina · 2017-01-06T11:10:17Z

@yorkie it seems it has it: https://github.com/nodejs/node/tree/master/lib/internal.

yorkie · 2017-01-06T13:51:24Z

Rebased done @mcollina :)

mcollina · 2017-01-06T19:31:17Z

@yorkie I've re-read this PR, and the majority idea is to move the legacy file into the internal folder. Can you do that as well?

yorkie · 2017-01-07T07:13:30Z

@mcollina Done and running a new CI: https://ci.nodejs.org/job/node-test-pull-request/5748 :)

MylesBorins · 2017-01-07T07:18:59Z

citgm: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/510/

edit: now with windows :D 🎉

yorkie · 2017-01-17T02:18:20Z

Ping, and any reviews? Thanks :)

mscdex · 2017-01-17T08:12:07Z

lib/stream.js

@@ -1,11 +1,18 @@
 'use strict';

-module.exports = Stream;
-
-const EE = require('events');
 const util = require('util');


mscdex · 2017-01-17T08:12:48Z

lib/stream.js

-util.inherits(Stream, EE);
+function Stream() {
+  EE.call(this);
+}


What I meant previously is why can't we just move this into the new internal module and export it into this file?

mcollina · 2017-01-17T09:08:39Z

lib/stream.js

+var Stream = require('internal/streams/stream').Stream;
+
+// wrap the old-style stream
+require('internal/streams/legacy')(Stream);


This is not clear to me. Basically the definition of Stream is divided into two files, whicn is not easy to understand in my opinion. If we also move the definition of Stream, I think internal/streams/stream should also include the 'legacy' bits.

How about we move all _stream prefixed files into internal/streams? That might be a better solution overall.
cc @nodejs/streams.

You couldn't just move those files because that would break someone trying to require() them? Unless you mean leave behind similarly-named files that simple re-export?

Also, I think the point of this PR was to separate the actual old Stream implementation from the other things, like the re-exporting of the various stream types.

Yes, but then why split the definition of it in one file, and the legacy part in another?
Either we just move the legacy bits, we move the full definition, or we move all the streams parts.

I'm 👎 in having both internal/streams/stream and internal/streams/legacy, if we are not moving along readable, writable, etc.

mscdex · 2017-01-17T09:13:47Z

lib/internal/streams/stream.js

+}
+util.inherits(Stream, EE);
+
+exports.Stream = Stream;


This whole file should be merged with lib/internal/streams/legacy.js

The legacy.js file should then just module.exports = Stream; and lib/stream.js should just require() that.

Just saw this, I think we agree.

yorkie · 2017-01-17T15:22:08Z

Done :)

mcollina · 2017-01-26T09:57:57Z

LGTM if CI and CITGM are green.

italoacasas · 2017-01-31T21:30:11Z

Can we land this @mcollina ?

mcollina · 2017-02-01T07:57:15Z

CI: https://ci.nodejs.org/job/node-test-pull-request/6144/
CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/555/

mcollina · 2017-02-01T08:52:52Z

CITGM has some unrelated failures.

mcollina · 2017-02-01T09:00:38Z

Landed as 1b30df1.

Improve readability of lib/stream.js by moving the legacy abstract Stream into lib/internal/streams/legacy.js. PR-URL: #8197 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

Improve readability of lib/stream.js by moving the legacy abstract Stream into lib/internal/streams/legacy.js. PR-URL: nodejs#8197 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

jasnell · 2017-03-07T22:43:12Z

Requires a backport PR to land on v4

Improve readability of lib/stream.js by moving the legacy abstract Stream into lib/internal/streams/legacy.js. PR-URL: #8197 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

nodejs-github-bot added stream Issues and PRs related to the stream subsystem. build Issues and PRs related to build files or the CI. labels Aug 20, 2016

brendanashworth reviewed Aug 20, 2016
View reviewed changes

Trott force-pushed the master branch from b0df363 to c5ce7f4 Compare September 21, 2016 00:09

rvagg force-pushed the master branch 2 times, most recently from c133999 to 83c7a88 Compare October 18, 2016 17:02

stream: move legacy to sep file

625bf71

yorkie force-pushed the refine/stream branch from 94e56a3 to 625bf71 Compare January 6, 2017 13:50

nodejs-github-bot added lts-watch-v6.x labels Jan 6, 2017

stream: move legacy to lib/internal dir

876c3ad

nodejs-github-bot added the lts-watch-v6.x label Jan 7, 2017

yorkie changed the title ~~stream: move legacy to sep file~~ stream: move legacy to lib/internal dir Jan 7, 2017

fix nit

1005ccb

nodejs-github-bot added the lts-watch-v6.x label Jan 17, 2017

mscdex reviewed Jan 17, 2017

View reviewed changes

fix nits

ece3060

mcollina requested changes Jan 17, 2017

View reviewed changes

mscdex reviewed Jan 17, 2017

View reviewed changes

fix nit

4e14f31

nodejs-github-bot added the lts-watch-v6.x label Jan 17, 2017

mcollina approved these changes Jan 26, 2017

View reviewed changes

mcollina closed this Feb 1, 2017

yorkie deleted the refine/stream branch February 4, 2017 01:48

italoacasas mentioned this pull request Feb 5, 2017

Proposal - 7.6.0 (Current) #11185

Merged

jasnell added the dont-land-on-v4.x label Mar 7, 2017

MylesBorins mentioned this pull request Mar 9, 2017

v6.10.1 proposal #11759

Merged

joyeecheung mentioned this pull request Mar 28, 2017

Suspect memory leak in v6.10.1 #12033

Closed

MylesBorins removed lts-watch-v4.x labels Nov 14, 2017

stream: move legacy to lib/internal dir #8197

stream: move legacy to lib/internal dir #8197

Conversation

yorkie commented Aug 20, 2016 • edited Loading

Checklist

Affected core subsystem(s)

Description of change

seishun commented Aug 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fishrock123 commented Aug 21, 2016

yorkie commented Aug 21, 2016

yorkie commented Aug 21, 2016

jasnell commented Aug 21, 2016

mcollina commented Aug 22, 2016

mcollina commented Dec 22, 2016

mcollina commented Dec 22, 2016

calvinmetcalf commented Dec 22, 2016

mcollina commented Dec 22, 2016

yorkie commented Jan 6, 2017

mcollina commented Jan 6, 2017

yorkie commented Jan 6, 2017

mcollina commented Jan 6, 2017

yorkie commented Jan 7, 2017

MylesBorins commented Jan 7, 2017 • edited Loading

yorkie commented Jan 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcollina Jan 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mscdex Jan 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yorkie commented Jan 17, 2017

mcollina commented Jan 26, 2017

italoacasas commented Jan 31, 2017

mcollina commented Feb 1, 2017

mcollina commented Feb 1, 2017

mcollina commented Feb 1, 2017

jasnell commented Mar 7, 2017

yorkie commented Aug 20, 2016 •

edited

Loading

MylesBorins commented Jan 7, 2017 •

edited

Loading

mcollina Jan 17, 2017 •

edited

Loading

mscdex Jan 17, 2017 •

edited

Loading