Use/create a more intuitive errcode

[wemeetagain]

Current usage of errcode is not intuitive.
example:

throw new errcode(new Error('error in foo'), ERR_FOO, { foo: bar })

Prefer an implementation like:

export class CodeError<T extends Record<string, any>> extends Error {
  code: string
  props: T

  constructor(message: string, code: string, props?: T) {
    super(message)

    this.code = code
    this.props = props ?? {} as T
  }
}

with usage then like:

throw new CodeError('error in foo', ERR_FOO, { foo: bar })

[achingbrain]

This is a great first issue that would suit someone looking to get started helping build libp2p!

To complete this:

1. Create a new repo
2. Export CodeError class (defined in OP)
3. Write tests
4. Open PRs to @libp2p/* repos replacing use of the err-code module with the new class

[tabcat]

Will look at completing this week now that CodeError is available.

[tabcat]

Tracking PRs needed to close this issue.
Have started by adding all relevant @libp2p/* packages like requested.
If changes to the list are needed let me know.

libp2p direct deps

• fix: replace err-code with CodeError #1532
• chore: replace err-code with CodeError js-libp2p-crypto#293
• chore: replace err-code with CodeError js-libp2p-daemon#172
• fix: replace err-code with CodeError js-libp2p-interfaces#334
• chore: replace err-code with CodeError js-libp2p-kad-dht#413
• fix: replace err-code with CodeError js-libp2p-keychain#57
• chore: replace err-code with CodeError js-libp2p-record#71
• chore: replace err-code with CodeError js-libp2p-mplex#242
• chore: replace err-code with CodeError js-libp2p-multistream-select#36
• fix: replace err-code with CodeError js-libp2p-peer-id#45
• chore: replace err-code with CodeError js-libp2p-peer-record#42
• chore: replace err-code with CodeError js-libp2p-peer-store#53
• chore: replace err-code with CodeError js-libp2p-pubsub#116
• chore: replace err-code with CodeError js-libp2p-tcp#240
• deps: remove err-code js-libp2p-topology#18
• chore: replace err-code with CodeError js-libp2p-utils#70
• js-libp2p-webrtc-star archived
• js-libp2p-webrtc-peer archived
• js-libp2p-webrtc-direct archived
• js-libp2p-switch archived
• js-libp2p-stardust archived
• js-libp2p-components archived
• deps: remove err-code js-libp2p-websockets#202
• js-libp2p-webtransport doesn't use err-code
• fix: replace err-code with CodeError multiformats/js-multiaddr#317
• fix: replace err-code with CodeError achingbrain/nat-port-mapper#31

additional packages

• chore: replace err-code with CodeError ChainSafe/js-libp2p-gossipsub#397
• chainsafe/js-libp2p-noise doesn't use err-code
• chore: replace err-code with CodeError ChainSafe/js-libp2p-yamux#21
• chore: replace err-code with CodeError js-libp2p-webrtc#82
• fix: replace err-code with CodeError js-libp2p-delegated-peer-routing#122
• fix: replace err-code with CodeError js-libp2p-daemon-client#194
• fix!: replace err-code with CodeError js-libp2p-cms#13

[tabcat]

Replacing the imports is very easy.

Here is some naive regex I'm using to replace the implementations for anyone looking to do this in their own projects. Works for most of the ways errCode is being used currently.

find: errcode(\(\n?\s*)new .*Error\((.*)\)(,\n?\s*.*\n?\s*\)\n?)
replace: new CodeError$1$2$3

[tabcat]

Have crossed out webrtc- star and peer from list above. These packages look like they will be deprecated; can add them back if necessary.

There is also an issue with replacing err-code with CodeError in the libp2p pr. It has to do with the supplied props being exposed by CodeError from error.props object instead of the error object directly. This could affect code relying on how err-code exposes the props, see more in the pr to the main libp2p repo in the list above.

[p-shahi]

@tabcat looks like all but a few prs remain for this effort. Need some help shepherding those along?

Another module that we likely need this change in is https://github.com/libp2p/js-libp2p-webtransport

[tabcat]

I meant to update this thread.

libp2p/js-libp2p-interfaces#334 needs attention. I'm not sure how to bump the js-libp2p-interfaces package in js-libp2p-interfaces/packages/interface-mocks.

#1532 just needs the proper breaking change notice to be added by me

Another module that we likely need this change in is https://github.com/libp2p/js-libp2

I'll add it to the list

[tabcat]

Adding js-libp2p-keychain to the todo list

[tabcat]

It looks like src/keychain/cms.ts was completely removed from the keychain as a result of the move from the js-libp2p repo. That was the only part resulting in breaking changes to any libp2p repos.

[tabcat]

Do you think this can be closed now? @wemeetagain

[maschad]

Thanks for all the great work @tabcat! There are some deps which were missing from the list, I updated the comment to include them as well as to highlight why some repos were unaffected. Almost there!

[p-shahi]

@tabcat thank you for driving this! It's been shipped so we'll close this.