repl: fix error message

[BridgeAR]

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]

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

[BridgeAR]

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]

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]

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

[BridgeAR]

I changed the error to ERR_INVALID_REPL_HISTORY as suggested.

[tniessen]

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

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

[BridgeAR]

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.constoldReplJSONHistory=fs.readFileSync(oldHistoryPath,'utf8');// Only attempt to use the history if there was any.if(oldReplJSONHistory)repl.history=JSON.parse(oldReplJSONHistory);}catch(err){returnready(newerrors.Error('ERR_PARSE_HISTORY_DATA',oldHistoryPath));}if(!Array.isArray(repl.history)){returnready(newerrors.TypeError('ERR_INVALID_REPL_HISTORY',typeofrepl.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]

You are right, I did not even look at that before. Knowing this it makes even less sense why there is ERR_PARSE_HISTORY_DATAandERR_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]

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]

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]

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]

This has conflicts.

[BridgeAR]

Rebased

[lpinca]

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

[lpinca]

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

[BridgeAR]

Done

[lpinca]

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

[BridgeAR]

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.

[lpinca]

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]

Addressed

[BridgeAR]

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]

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

Please fix CI failures.

[BridgeAR]

Fixed

[tniessen]

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]

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.

[tniessen]

Landed in e6b69b9. Thank you for your contribution!

CIs on master: LinuxOne, Windows

[addaleax]

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]

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

[BridgeAR]

@addaleax I opened a backport to 8.x

[MylesBorins]

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]

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