Tracking Issue: Migrate errors to internal/errors.js

[jasnell]

Now that #11220 has landed, we need to begin the process of migrating errors in the */lib.js source over to use it. A basic guide is provided here.

Note that moving existing errors over to this mechanism should, in general, be considered semver-major.

Please use the following list to track which files have been migrated over to using the new errors and provide a link back to this issue in the relevant PRs

• Internal
  • cluster (No changes required here)
    • child.js
    • master.js
    • round_robin_handle.js
    • shared_handle.js
    • utils.js
    • worker.js
  • process
    • next_tick.js - process: use internal/errors in internalNextTick #13982
    • promises.js - errors, process: port internal/process errors to internal/errors #11294
    • stdio.js - errors, process: port internal/process errors to internal/errors #11294
    • warning.js - errors, process: port internal/process errors to internal/errors #11294
  • streams (No changes required here)
    • BufferList.js
    • lazy_transform.js
    • legacy.js
  • bootstrap_node.js - errors: assign error code to bootstrap_node created error #11298
  • buffer.js - errors: port internal/buffer errors to internal/errors #11341
  • child_process.js - errors, child_process: migrate to using internal/errors #11300 + child_process: use internal/errors #14009
  • errors.js (No need to migrate itself)
  • freelist.js (No changes required here)
  • fs.js - errors: port internal/fs errors to internal/errors #11317, internal: use internal/errors #13829,
  • linkedlist.js (No changes required here)
  • module.js (No changes required here)
  • net.js - errors,net: change internal/net.js to use internal/errors.js #11302
  • process.js
  • readline.js
  • repl.js
  • socket_list.js - errors socket_list : Migrate errors to internal/errors.js #11356
  • url.js - url: port WHATWG URL API to internal/errors #12574
  • util.js - internal/util: use internal/errors.js #11301, internal: use internal/errors #13829
  • v8_prof_polyfill.js (No changes required here)
  • v8_prof_processor.js (No changes required here)
• _debug_agent.js (removed in 549e81bfa1)
• _debugger.js - debugger, errors: migrate to use internal/errors.js #11380 (File removed from master)
• _http_agent.js
• _http_client.js - http_client, errors: migrate to use internal/errors #14423
• _http_common.js
• _http_incoming.js
• _http_outgoing.js _http_outgoing: migrate to use internal/errors #14735
• _http_server.js
• _linklist.js
• _tls_common.js (No changes needed here)
• _tls_legacy.js (No changes needed here)
• _tls_wrap.js - errors,tls_wrap: migrate to use internal/errors.js #13476
• assert.js
• async_hooks.js async_hooks,async_wrap: fixups and fewer aborts #14722
• buffer.js #13976
• child_process.js lib/child_process: convert to using internal/errors #15090
• cluster.js (No changes required here)
• console.js - errors, console: migrate to use internal/errors.js #11308
• constants.js (No changes required here)
• crypto.js
• dgram.js - #12926
• dns.js - dns, errors: Migrate to use internal/errors #14212
• domain.js
• events.js - events: migrate to internal/errors #15623
• fs.js - lib/fs: convert to using internal/errors #15043
• http.js (No changes required here)
• https.js - lib/https: convert to using internal/errors #15603
• inspector.js inspector: migrate to internal/errors #15619
• module.js
• net.js - lib/net: Convert to using internal/errors #14782
• os.js (No changes required here)
• path.js - errors, path: migrate to use internal/errors.js #11319
• process.js (No changes required here)
• punycode.js (may not need to do this one)
• querystring.js - lib/querystring: convert to using internal/errors #15565
• readline.js - errors, readline: migrate to use internal/errors.js #11390
• repl.js - errors, repl: migrate to use internal/errors.js #11347
• timers.js - timers: Migrate to use internal/errors #14659
• tls.js - tls: migrate tls.js to use internal/errors.js #13994
• tty.js
• url.js - errors, url: port url errors to internal/errors #13963
• util.js
• v8.js (no changes required here)
• vm.js
• zlib.js - zlib: migrate to internal/errors #15618

stream related (blocked)

• _stream_duplex.js
• _stream_passthrough.js
• _stream_readable.js
• _stream_transform.js
• _stream_wrap.js - errors,_stream_wrap: change _stream_wrap.js to use internal/errors.js #13291
• _stream_writable.js
• string_decoder.js - string_decoder: Migrate to use internal/errors #14682
• stream.js

_{@refack: removed GFC label and commented out sentence in description + split off stream stuff
@BridgeAR: updated the list}

[fl0w]

Am I wrong in thinking this could be a "good first contribution"? Would love to give it a try in that case.
Also, I'm assuming */lib.js is a typo for lib/*.js?

[joyeecheung]

I think this could be a good first contribution in general, though some of the errors could be more complicated(the ones that are more frequently getting parsed in userland).

Also, I'm assuming /lib.js is a typo for lib/.js?

Probably lib/**/*.js :)

[joyeecheung]

@jasnell I've added links to those files, hope I am doing this right..

[jasnell]

@fl0w ... yes, this can be a good first contribution. Please use my PR #11294 as a model. New error codes are added to internal/errors.js. Please reuse existing codes as possible. For instance, my PR #11294 introduces the ERR_INVALID_ARG_TYPE error code. If you're going through and making changes before #11294 lands, and you need ERR_INVALID_ARG_TYPE, duplicate it from #11294 as a separate commit in your PR. Then, if #11294 lands first, you can rebase and drop that commit, but if your PR lands first, then I can rebase and drop it from mine, etc. (hopefully that makes sense).

Also please make sure that descriptions for the error codes are added to docs/api/errors.md the way I've illustrated in #11294.

Really appreciate your willingness to jump in! Let me know if you have any questions or issues!

[seppevs]

@jasnell: can we modify the error messages of existing errors to more generic and reusable error messages? Or should the error message be completely backwards compatible?

[jasnell]

Modifying the error message is certainly possible. The biggest thing is to avoid duplicating error codes so make sure you check the other PRs for codes that may be reusable.