internal/errors: improve ERR_INVALID_ARG_TYPE

[BridgeAR]

The error message might be misleading if a object property
was the issue and not the argument itself.

Fix this by checking if a argument or a property is passed
to the handler function.

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)

internal/errors

[refack]

👍 FWIW
(need 2 CTC members' approval for semver-majors)

[TimothyGu]

+1 for semver-patch. IIRC the point of these new error objects is that changes in the error message can be done without semver-major because of the existence of code.

[refack]

+1 for semver-patch. IIRC the point of these new error objects is that changes in the error message can be done without semver-major because of the existence of code.

Anyone with more experience then me, feel free to downgrade semver level.

[lpinca]

I think this is still misleading.

[tniessen]

Using the word argument here was correct. Please wait for a decision to #13739, but this should not be changed.

[tniessen]

Effectively blocked by #13739, see #13730 (comment)

[tniessen]

I would like to merge #13739 in about 48 hours. In order to start CI for your PR afterwards, I need you to revert your modifications to test/parallel/test-process-hrtime.js. Take your time, there is no need to hurry (we cannot merge this before #13739 is landed and two @nodejs/ctc members still need to approve this as long as it is semver-major).

[tniessen]

This change should be reverted, see above.

[mscdex]

@tniessen I believe we still try to give 72 hours for review during weekends instead of the 48 hours given during the week.

[tniessen]

@mscdex My bad, I scheduled it for Tuesday... You are right, that's 72 hours, not 48.

[BridgeAR]

In addition to the current change I would like to also check if the provided type is actually a primitive or a class (either with a whitelist of primitives or by checking if the first letter is upper case) and change the error message accordingly. If it's a class we could write instance of instead of type of and also print the provided constructor name in case the value was provided and it is of type object. The one in "one of" could also be removed if I'm not mistaken.

functiontest(opts){if(!isUint8Array(opts.prop))thrownewerrors.TypeError('ERR_INVALID_ARG_TYPE','opts.prop'['Buffer','Uint8Array'],opts.prop)}test({prop: []})// TypeError [ERR_INVALID_ARG_TYPE]: The "opts.prop" property must be instance of Buffer or Uint8Array. Received instance of Array.// instead of// TypeError [ERR_INVALID_ARG_TYPE]: The "opts.prop" property must be one of type Buffer or Uint8Array. Received type objecttest({prop: 'string'})// TypeError [ERR_INVALID_ARG_TYPE]: The "opts.prop" property must be instance of Buffer or Uint8Array. Received type string.// instead of// TypeError [ERR_INVALID_ARG_TYPE]: The "opts.prop" property must be one of type Buffer or Uint8Array. Received type string

Should I just update the PR or open another one for that?

Neither the current change nor the proposed one should be semver major though as the error codes do not change and the messages are meant to change.

[jasnell]

This does not need to be semver-major.

[tniessen]

@BridgeAR I would prefer a separate PR to discuss such changes.

Please rebase this on master and remove any modifications to test/parallel/test-process-hrtime.js (basically squash the second commit). CI won't run cleanly as it cannot automaticall merge the first commit.

[refack]

Learned a new thing about error message semverity.
Ping @tniessen should this be un-blocked?

[BridgeAR]

@tniessen done

[refack]

Pre land CI: https://ci.nodejs.org/job/node-test-commit/10693/

[refack]

Landed in 3e17884

[mscdex]

@jasnell Can you explain why it's not semver-major?

[jasnell]

It does not change any error types or the error code. The changes are limited to the error message and only in certain cases. Per the guidelines for the new internal/errors, changes to the message are not semver-major once the error has been migrated to use codes.

[mscdex]

@jasnell Why treat the error type specially (assuming you're referring to use of Error, TypeError, RangeError, etc.) and not the message? I would think users could be explicitly checking both?

Also, I'm kind of surprised we're not giving any grace period for users to switch after the new errors system is rolled out (everywhere).

[refack]

Also, I'm kind of surprised we're not giving any grace period for users to switch after the new errors system is rolled out (everywhere).

I'm assuming since this changed only internal errors, and the change over to internal errors is semver-major the impact is mitigated.

[mscdex]

I'm assuming since this changed only internal errors

@refack I don't understand what you mean by 'internal' errors. This PR changes error messages received by end users of node.

[refack]

I don't understand what you mean by 'internal' errors

The new errors that must include .code as tracked by #11273. Those errors' messages were already changed in a semver-major way.

[mscdex]

@refack Typically the messages aren't changed (initially) but what I said is still relevant:

Also, I'm kind of surprised we're not giving any grace period for users to switch after the new errors system is rolled out (everywhere).

[refack]

Temporarily "don't land"ing this until semverity is decided.