repl: fix error message #13733

BridgeAR · 2017-06-17T01:00:46Z

While looking at the ERR_INVALID_ARG_TYPE errors, I stumbled across this one. The property name should be passed to the internal error instead of the type.

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)

repl

tniessen · 2017-06-17T10:35:10Z

Side note: There is an error code ERR_INVALID_REPL_HISTORY which appears to be unused but would apply here. Is this correct?

BridgeAR · 2017-06-17T16:39:49Z

Good catch. It is indeed not used and it is very similar to the ERR_INVALID_ARG_TYPE error, so I went ahead and removed the ERR_INVALID_REPL_HISTORY error.

tniessen · 2017-06-18T10:13:28Z

I am actually not too sure whether this is correct as it is. Considering that repl.history is not an argument or option of any kind but rather constructed from the contents of a file, ERR_INVALID_REPL_HISTORY might be the better option. I traced its introduction to #13299.

/cc @addaleax @Fishrock123

addaleax · 2017-06-18T10:46:15Z

I think what @tniessen says makes sense (but tbh I’ve never actually seen this error happen in the wild)

BridgeAR · 2017-06-21T00:46:04Z

I changed the error to ERR_INVALID_REPL_HISTORY as suggested.

tniessen · 2017-06-21T16:46:27Z

I think this should be semver-major due to the changed error code.

@jasnell Are you okay with this? Gonna land it then.

BridgeAR · 2017-06-21T17:20:56Z

Wait, this should not be merged as is. The error is actually completely obsolete and it does not matter what is thrown as the catch block is going to catch the error and return a new and different one that has nothing to do with this error.
It's also not semver major at the moment because the error was never exposed to the user.

I'm thinking about fixing it like this:

try {
  // Pre-v3.0, repl history was stored as JSON.
  // Try and convert it to line separated history.
  const oldReplJSONHistory = fs.readFileSync(oldHistoryPath, 'utf8');

  // Only attempt to use the history if there was any.
  if (oldReplJSONHistory) repl.history = JSON.parse(oldReplJSONHistory);
} catch (err) {
  return ready(
    new errors.Error('ERR_PARSE_HISTORY_DATA', oldHistoryPath));
}

if (!Array.isArray(repl.history)) {
  return ready(new errors.TypeError('ERR_INVALID_REPL_HISTORY',
                                    typeof repl.history));
}
repl.history = repl.history.slice(0, repl.historySize);

This also needs tests as they are missing and lead to the error in the first place.

What do you all think?

Note to myself: check #2449

tniessen · 2017-06-21T17:52:39Z

You are right, I did not even look at that before. Knowing this it makes even less sense why there is ERR_PARSE_HISTORY_DATA and ERR_PARSE_HISTORY_DATA. I am okay with your suggestion, even though I kind of dislike having two different error codes for more or less the same problem. Still, I think your solution might be the closest to what the original authors were trying to achieve.

BridgeAR · 2017-06-22T17:00:54Z

I fixed the error handling in a way that I expect was originally meant. I am not a big fan of it though and while working on it I thought it might be worth thinking about simple removing the old history file, so I opened an alternative: #13876

BridgeAR · 2017-06-26T08:25:42Z

As suggested in #13876 the way would be to make a end of life deprecation and then remove this part overall. But until then this fix could go into the code base and I think it could even be backported as well and is a semver-patch.

So PTAL

tniessen · 2017-06-28T13:06:29Z

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

@jasnell @lpinca @cjihrig There have been some major changes since your approvals, could you PTAL and just give me a thumb up if you are okay with landing this as it is?

cjihrig · 2017-06-28T18:23:41Z

This has conflicts.

BridgeAR · 2017-06-29T07:35:27Z

Rebased

lpinca · 2017-06-29T07:46:28Z

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

lpinca · 2017-06-29T07:55:28Z

lib/internal/repl.js

@@ -124,6 +125,7 @@ function setupHistory(repl, historyPath, oldHistoryPath, ready) {
  }

  function onread(err, data) {
+    var threw;


Nit: why not putting this in the if branch where the try...catch is defined?

lpinca · 2017-06-29T08:04:39Z

lib/internal/repl.js

+        // Grab data from the older pre-v3.0 JSON NODE_REPL_HISTORY_FILE format.
+        _writeToOutput(
+          repl,
+          '\nConverting old JSON repl history to line-separated history.\n' +


Nit: I don't think this is a problem but this message is now displayed after the conversion is actually done.

This was intentional as the message would otherwise be visible even though the conversion did not occur due to e.g. ENOENT or a parsing error etc.

Yes, I'm fine with this it's just that "converting" suggests that conversion is still happening so it makes sense to display it even if there is a parse error.

I would use "Converted" now.

BridgeAR · 2017-06-29T10:00:03Z

By the way: IMHO this should not be semver-major (if by any means, then because of the change from converting to converted and in that case I'd rather revert that change). The former handling did not work as expected and this is a patch for that.

tniessen · 2017-06-30T10:40:21Z

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

Please fix CI failures.

BridgeAR · 2017-06-30T12:03:19Z

Fixed

tniessen · 2017-06-30T12:22:30Z

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

I will land this after giving @nodejs/ctc some time to review and decide semver-ity (even though - technically - two CTC members have already approved).

addaleax · 2017-06-30T12:25:48Z

As far as I can tell this only affects the REPL, as in, the application built into Node, not the public repl module, so semver-patch seems fine.

PR-URL: nodejs#13733 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

tniessen · 2017-06-30T17:23:26Z

Landed in e6b69b9. Thank you for your contribution!

CIs on master: LinuxOne, Windows

addaleax · 2017-07-03T20:11:36Z

This doesn’t land cleanly on 8.x; if you can, please follow the guide and raise a backport PR, if you don’t think it’s worth it (or wrong) let me know and we’ll add the dont-land-on label.

addaleax · 2017-07-11T18:27:02Z

@lpinca @jasnell @cjihrig @tniessen Do any of you have the time to backport?

PR-URL: nodejs#13733 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

BridgeAR · 2017-07-20T14:48:46Z

@addaleax I opened a backport to 8.x

Backport-PR-URL: #14392 Backport-Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #13733 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

MylesBorins · 2017-08-16T07:33:25Z

Should this be backported to v6.x-staging? If yes please follow the guide and raise a backport PR, if no let me know or add the dont-land-on label.

BridgeAR · 2017-12-11T06:17:11Z

I do not think that it is worth backporting. So I changed the label accordingly.

nodejs-github-bot added the repl Issues and PRs related to the REPL subsystem. label Jun 17, 2017

tniessen added the errors Issues and PRs related to JavaScript errors originated in Node.js core. label Jun 17, 2017

lpinca approved these changes Jun 18, 2017

View reviewed changes

tniessen mentioned this pull request Jun 18, 2017

errors,repl: migrate to use internal/errors.js #13299

Closed

2 tasks

jasnell approved these changes Jun 19, 2017

View reviewed changes

BridgeAR mentioned this pull request Jun 21, 2017

errors: improve invalid arg type #13834

Merged

3 tasks

cjihrig approved these changes Jun 21, 2017

View reviewed changes

tniessen self-assigned this Jun 21, 2017

tniessen approved these changes Jun 21, 2017

View reviewed changes

tniessen added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jun 21, 2017

BridgeAR force-pushed the fix-error-msg branch from 4d00c0e to e2bce0e Compare June 22, 2017 16:48

BridgeAR mentioned this pull request Jun 22, 2017

repl: remove NODE_REPL_HISTORY_FILE #13876

Closed

4 tasks

BridgeAR force-pushed the fix-error-msg branch from e2bce0e to a98a2a0 Compare June 29, 2017 07:35

lpinca reviewed Jun 29, 2017

View reviewed changes

fix test

b77ef48

tniessen removed the semver-major PRs that contain breaking changes and should be released in the next major version. label Jun 30, 2017

jasnell approved these changes Jun 30, 2017

View reviewed changes

tniessen closed this Jun 30, 2017

addaleax added the backport-requested-v8.x label Jul 11, 2017

BridgeAR mentioned this pull request Jul 20, 2017

[v8.x backport] repl: fix old history error handling #14392

Closed

4 tasks

addaleax added backported-to-v8.x and removed backport-requested-v8.x labels Jul 21, 2017

addaleax mentioned this pull request Jul 24, 2017

v8.3.0 proposal #14452

Closed

addaleax mentioned this pull request Aug 2, 2017

v8.3.0 proposal #14594

Merged

MylesBorins added the lts-watch-v6.x label Aug 16, 2017

BridgeAR added dont-land-on-v6.x and removed lts-watch-v6.x labels Dec 11, 2017

BridgeAR deleted the fix-error-msg branch April 1, 2019 23:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

repl: fix error message #13733

repl: fix error message #13733

BridgeAR commented Jun 17, 2017 •

edited

Loading

tniessen commented Jun 17, 2017 •

edited

Loading

BridgeAR commented Jun 17, 2017

tniessen commented Jun 18, 2017

addaleax commented Jun 18, 2017 •

edited

Loading

BridgeAR commented Jun 21, 2017

tniessen commented Jun 21, 2017

BridgeAR commented Jun 21, 2017 •

edited

Loading

tniessen commented Jun 21, 2017

BridgeAR commented Jun 22, 2017

BridgeAR commented Jun 26, 2017

tniessen commented Jun 28, 2017

cjihrig commented Jun 28, 2017

BridgeAR commented Jun 29, 2017

lpinca commented Jun 29, 2017

lpinca Jun 29, 2017

BridgeAR Jun 29, 2017

lpinca Jun 29, 2017

BridgeAR Jun 29, 2017

lpinca Jun 29, 2017

BridgeAR Jun 29, 2017 •

edited

Loading

BridgeAR commented Jun 29, 2017

tniessen commented Jun 30, 2017

BridgeAR commented Jun 30, 2017

tniessen commented Jun 30, 2017 •

edited

Loading

addaleax commented Jun 30, 2017 •

edited

Loading

tniessen commented Jun 30, 2017 •

edited

Loading

addaleax commented Jul 3, 2017

addaleax commented Jul 11, 2017

BridgeAR commented Jul 20, 2017

MylesBorins commented Aug 16, 2017

BridgeAR commented Dec 11, 2017

repl: fix error message #13733

repl: fix error message #13733

Conversation

BridgeAR commented Jun 17, 2017 • edited Loading

Checklist

Affected core subsystem(s)

tniessen commented Jun 17, 2017 • edited Loading

BridgeAR commented Jun 17, 2017

tniessen commented Jun 18, 2017

addaleax commented Jun 18, 2017 • edited Loading

BridgeAR commented Jun 21, 2017

tniessen commented Jun 21, 2017

BridgeAR commented Jun 21, 2017 • edited Loading

tniessen commented Jun 21, 2017

BridgeAR commented Jun 22, 2017

BridgeAR commented Jun 26, 2017

tniessen commented Jun 28, 2017

cjihrig commented Jun 28, 2017

BridgeAR commented Jun 29, 2017

lpinca commented Jun 29, 2017

lpinca Jun 29, 2017

Choose a reason for hiding this comment

BridgeAR Jun 29, 2017

Choose a reason for hiding this comment

lpinca Jun 29, 2017

Choose a reason for hiding this comment

BridgeAR Jun 29, 2017

Choose a reason for hiding this comment

lpinca Jun 29, 2017

Choose a reason for hiding this comment

BridgeAR Jun 29, 2017 • edited Loading

Choose a reason for hiding this comment

BridgeAR commented Jun 29, 2017

tniessen commented Jun 30, 2017

BridgeAR commented Jun 30, 2017

tniessen commented Jun 30, 2017 • edited Loading

addaleax commented Jun 30, 2017 • edited Loading

tniessen commented Jun 30, 2017 • edited Loading

addaleax commented Jul 3, 2017

addaleax commented Jul 11, 2017

BridgeAR commented Jul 20, 2017

MylesBorins commented Aug 16, 2017

BridgeAR commented Dec 11, 2017

BridgeAR commented Jun 17, 2017 •

edited

Loading

tniessen commented Jun 17, 2017 •

edited

Loading

addaleax commented Jun 18, 2017 •

edited

Loading

BridgeAR commented Jun 21, 2017 •

edited

Loading

BridgeAR Jun 29, 2017 •

edited

Loading

tniessen commented Jun 30, 2017 •

edited

Loading

addaleax commented Jun 30, 2017 •

edited

Loading

tniessen commented Jun 30, 2017 •

edited

Loading