repl: deprecate REPLServer.prototype.memory #16242
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cjihrig
approved these changes
Oct 17, 2017
lpinca
approved these changes
Oct 17, 2017
lib/repl.js
Outdated
| REPLServer.prototype.memory = function memory(cmd) { | ||
| var self = this; | ||
| REPLServer.prototype.memory = util.deprecate( | ||
| function(cmd) { _memory(this, cmd); }, |
There was a problem hiding this comment.
Nit: I'd use _memory directly to remove yet another wrapper.
There was a problem hiding this comment.
@lpinca If I deprecate like so
REPLServer.prototype.memory = util.deprecate(
_memory,
'REPLServer.memory() is deprecated',
'DEP00XX');then I will need to set self = this in _memory. E.g.
function _memory(cmd) {
self = this;
self.lines = self.lines || [];
self.lines.level = self.lines.level || [];
// ... etc
}
With the current implementation, all internal calls go directly to `_memory()`, bypassing the wrapper altogether. Only those calls to `REPLServer.prototype.memory()` will hit it, and the idea is for this to go away anyway.
**EDIT** Never mind all that. I'll take care of the nit.
| const warn = 'REPLServer.memory() is deprecated'; | ||
|
|
||
| common.expectWarning('DeprecationWarning', warn); | ||
| assert.ok(server.memory() === undefined); |
There was a problem hiding this comment.
I will address this when landing.
This method is only useful for the internal mechanics of the REPLServer and does not need to be exposed in user space. It was previously not documented, so I believe a Runtime deprecation makes sense.
|
@cjihrig there is this from @ChALkeR from over a year ago. #7619 (comment) So it seems like ecosystem usage is small, but it's hard to know for sure. It's hard for me to understand exactly what users in the ecosystem would be using this method for. It really is an internal implementation detail. |
BridgeAR
approved these changes
Oct 18, 2017
BridgeAR
added
the
semver-major
jasnell
approved these changes
Oct 18, 2017
|
Running a second CI since lots of flakey tests failed on the first: https://ci.nodejs.org/job/node-test-pull-request/10812/ |
|
Still several unrelated failed tests in CI. I'm not going to detail them here because it's quite tedious. But I wonder if CI flakiness is this getting worse. I see this a lot lately. Unless anyone objects, I'm going to go ahead and land this tomorrow in spite of CI failures. |
Fishrock123
approved these changes
Oct 19, 2017
lance
added a commit
that referenced
this pull request
Oct 19, 2017
This method is only useful for the internal mechanics of the REPLServer and does not need to be exposed in user space. It was previously not documented, so I believe a Runtime deprecation makes sense. PR-URL: #16242 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
Landed in: 7a29f44 |
addaleax
pushed a commit
to ayojs/ayo
that referenced
this pull request
Oct 26, 2017
This method is only useful for the internal mechanics of the REPLServer and does not need to be exposed in user space. It was previously not documented, so I believe a Runtime deprecation makes sense. PR-URL: nodejs/node#16242 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Jeremiah Senkpiel <fishrock123@rocketmail.com>
addaleax
pushed a commit
to ayojs/ayo
that referenced
this pull request
Dec 7, 2017
This method is only useful for the internal mechanics of the REPLServer and does not need to be exposed in user space. It was previously not documented, so I believe a Runtime deprecation makes sense. PR-URL: nodejs/node#16242 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This method is only useful for the internal mechanics of the REPLServer
and does not need to be exposed in user space. It was previously not
documented, so I believe a Runtime deprecation makes sense.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
repl, doc