repl: deprecate unused function convertToContext by princejwesley · Pull Request #7829 · nodejs/node

princejwesley · 2016-07-21T22:46:42Z

Checklist

make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

repl

Description of change

Remove unused function convertToContext

thefourtheye · 2016-07-21T22:55:54Z

cc @ChALkeR Can you please search for this function in the npm modules?

addaleax · 2016-07-21T22:59:15Z

Good idea, LGTM if nothing too relevant comes up (I’d be surprised if it did, this code is unused since 2010).

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

Trott · 2016-07-21T23:08:18Z

LGTM. Probably worth a CITGM run too, just to flush out anything obvious early on:

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

Hopefully I did that correctly....

EDIT: CITGM isn't working because of a breaking change on master. If #7846 lands, it will revert the commit that caused the regression and we can try CITGM again then.

cjihrig · 2016-07-21T23:23:22Z

LGTM if it's not in use.

Fishrock123 · 2016-07-22T19:13:58Z

Is this supposed to be a user API?

princejwesley · 2016-07-23T04:23:00Z

@Fishrock123 No.

History

Introduced here as convertToScope and used inside readline function (Sep 25, 2009)
New context is used instead of convertToScope (May 10, 2010)
Renamed convertToScope -> convertToContext (Jun 24, 2010)

ChALkeR · 2016-07-24T07:18:34Z

@thefourtheye Does not seem to be used anywhere (based on the old data from 2016-01-28, new data will be ready a bit later). As always, I checked only @latest versions.

jasnell · 2016-07-26T14:07:46Z

Even tho this doesn't appear to be used, I would still recommend (and would be more comfortable with) a proper deprecation cycle before removing outright.

thefourtheye · 2016-07-26T14:10:13Z

Considering my recent attempts with fs, I am inclined to go with @jasnell's comment.

princejwesley · 2016-07-26T16:11:33Z

... a proper deprecation cycle before removing outright

@jasnell Using util#deprecation ?

jasnell · 2016-07-26T17:26:01Z

We have two methods: soft deprecation (docs only) or util.deprecation. We
should likely start with soft deprecation in v7.

On Tuesday, July 26, 2016, Prince John Wesley notifications@github.com
wrote:

... a proper deprecation cycle before removing outright
@jasnell https://github.com/jasnell Using util#deprecation
https://nodejs.org/api/util.html#util_util_deprecate_function_string ?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#7829 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAa2eTYlUF2uNPYwwtRiIyKQjNzB5ED2ks5qZjG8gaJpZM4JSSl3
.

princejwesley · 2016-07-26T18:01:50Z

@jasnell FYI, convertToContext method is not currently documented in repl.md.

addaleax · 2016-07-26T22:13:48Z

Yeah, soft deprecation isn’t really applicable here, and util.deprecate seems like the way to go.

princejwesley · 2016-07-28T03:21:47Z

@addaleax @jasnell We need a clean up/todo label for v8.x. Do we have one?

thefourtheye · 2016-07-28T04:01:53Z

@princejwesley Just a leave a to-do like this TODO(princejwesley): followed by the note.

yorkie · 2016-07-28T10:43:28Z


 return cmd;
-};
+}, 'replServer.convertToContext will be removed in v8.0.0');


use "after", that represents a range, instead of the precise word "in" would be better?

@yorkieremoved after v7 ?

Exactly what I mean :-) @princejwesley

yorkie · 2016-07-28T11:37:43Z

LGTM

addaleax · 2016-07-28T11:55:28Z

LGTM, CI: https://ci.nodejs.org/job/node-test-commit/4305/

jasnell · 2016-07-28T13:24:01Z


 return cmd;
-};
+}, 'replServer.convertToContext will be removed after v7');


Our deprecation messages typically take a form like, 'replServer.convertToContext() is deprecated', without committing to a specific version when it may be removed. The message should also indicate if there is an alternative that the developer should use.

yorkie · 2016-07-28T15:34:11Z

Oops, it might need a test case, though.

jasnell · 2016-07-28T16:38:00Z

@nodejs/ctc
LGTM

princejwesley · 2016-07-30T17:41:54Z

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

yorkie · 2016-07-30T17:50:46Z

LGTM if CI is green :-)

jasnell · 2016-08-01T18:06:19Z

@nodejs/ctc ... putting out a last call for comments on this. If there are no objections to adding this deprecation I will land tomorrow.

PR-URL: #7829 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

jasnell · 2016-08-04T20:09:15Z

Ok, it took longer than a day but landed in 488d28d! :-)

refack · 2017-06-01T03:08:30Z

Just found this. Can we remove it?

nodejs-github-bot added the repl Issues and PRs related to the REPL subsystem. label Jul 21, 2016

addaleax added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jul 21, 2016

princejwesley added 2 commits July 27, 2016 22:09

repl: remove unused function convertToContext
d4ecbd8

Add deprecate warning for convertToContext
a096f00

princejwesley force-pushed the repl.cleanup branch from 1369ad9 to a096f00Compare July 27, 2016 17:23

yorkie reviewed Jul 28, 2016
View reviewed changes

Add todo and update deprecate text
326757e

princejwesley changed the title ~~repl: remove unused function convertToContext~~repl: deprecate unused function convertToContextJul 28, 2016

jasnell reviewed Jul 28, 2016
View reviewed changes

Update deprecate message
60f4a9f

Add test
05ba902

princejwesley force-pushed the repl.cleanup branch from 0647595 to 05ba902Compare July 30, 2016 17:39

ChALkeR mentioned this pull request Jul 31, 2016
repl: Undocumented public methods on REPLServer.prototype #7619
Closed

jasnell closed this Aug 4, 2016

mysticatea mentioned this pull request Oct 26, 2016
update no-deprecated-api rule for Node 7 mysticatea/eslint-plugin-node#54
Closed

seishun mentioned this pull request Jun 3, 2017
repl: remove unused function convertToContext #13434
Merged
2 tasks

gibfahn mentioned this pull request Jun 15, 2017
Auditing for 6.11.1 nodejs/Release#230
Closed
3 tasks

tniessen added the deprecations Issues and PRs related to deprecations. label Sep 7, 2018

Uh oh!

Uh oh!

Conversation

princejwesley commented Jul 21, 2016

Checklist

Affected core subsystem(s)

Description of change

Uh oh!

thefourtheye commented Jul 21, 2016

Uh oh!

addaleax commented Jul 21, 2016

Uh oh!

Trott commented Jul 21, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cjihrig commented Jul 21, 2016

Uh oh!

Fishrock123 commented Jul 22, 2016

Uh oh!

princejwesley commented Jul 23, 2016

History

Uh oh!

ChALkeR commented Jul 24, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell commented Jul 26, 2016

Uh oh!

thefourtheye commented Jul 26, 2016

Uh oh!

princejwesley commented Jul 26, 2016

Uh oh!

jasnell commented Jul 26, 2016

Uh oh!

princejwesley commented Jul 26, 2016

Uh oh!

addaleax commented Jul 26, 2016

Uh oh!

princejwesley commented Jul 28, 2016

Uh oh!

thefourtheye commented Jul 28, 2016

Uh oh!

yorkieJul 28, 2016

Choose a reason for hiding this comment

Uh oh!

princejwesleyJul 28, 2016

Choose a reason for hiding this comment

Uh oh!

yorkieJul 28, 2016

Choose a reason for hiding this comment

Uh oh!

yorkie commented Jul 28, 2016

Uh oh!

addaleax commented Jul 28, 2016

Uh oh!

jasnellJul 28, 2016

Choose a reason for hiding this comment

Uh oh!

yorkie commented Jul 28, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell commented Jul 28, 2016

Uh oh!

princejwesley commented Jul 30, 2016

Uh oh!

yorkie commented Jul 30, 2016

Uh oh!

jasnell commented Aug 1, 2016

Uh oh!

jasnell commented Aug 4, 2016

Uh oh!

refack commented Jun 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Trott commented Jul 21, 2016•
edited
Loading

ChALkeR commented Jul 24, 2016•
edited
Loading

yorkie commented Jul 28, 2016•
edited
Loading