Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use named error instead of CodeError #385

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,6 @@
"dependencies": {
"@chainsafe/is-ip": "^2.0.1",
"@chainsafe/netmask": "^2.0.0",
"@libp2p/interface": "^1.0.0",
"@multiformats/dns": "^1.0.3",
"multiformats": "^13.0.0",
"uint8-varint": "^2.0.1",
Expand Down
10 changes: 8 additions & 2 deletions src/multiaddr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
* ```
*/

import { CodeError } from '@libp2p/interface'
import { base58btc } from 'multiformats/bases/base58'
import { CID } from 'multiformats/cid'
import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
Expand All @@ -32,6 +31,13 @@ const DNS_CODES = [
getProtocol('dnsaddr').code
]

class NoAvailableResolverError extends Error {
constructor (message = 'No available resolver') {
super(message)
this.name = 'NoAvailableResolverError'
}
}

/**
* Creates a {@link Multiaddr} from a {@link MultiaddrInput}
*/
Expand Down Expand Up @@ -232,7 +238,7 @@ export class Multiaddr implements MultiaddrInterface {

const resolver = resolvers.get(resolvableProto.name)
if (resolver == null) {
throw new CodeError(`no available resolver for ${resolvableProto.name}`, 'ERR_NO_AVAILABLE_RESOLVER')
throw new NoAvailableResolverError(`no available resolver for ${resolvableProto.name}`)
}

const result = await resolver(this, options)
Expand Down
10 changes: 8 additions & 2 deletions src/resolvers/dnsaddr.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { CodeError } from '@libp2p/interface'
import { dns, RecordType } from '@multiformats/dns'
import { multiaddr } from '../index.js'
import { getProtocol } from '../protocols-table.js'
Expand All @@ -9,6 +8,13 @@ import type { DNS } from '@multiformats/dns'
const MAX_RECURSIVE_DEPTH = 32
const { code: dnsaddrCode } = getProtocol('dnsaddr')

class RecursionLimitError extends Error {
constructor (message = 'Max recursive depth reached') {
super(message)
this.name = 'RecursionLimitError'
}
}

export interface DNSADDROptions extends AbortOptions {
/**
* An optional DNS resolver
Expand All @@ -28,7 +34,7 @@ export const dnsaddrResolver: Resolver<DNSADDROptions> = async function dnsaddrR
const recursionLimit = options.maxRecursiveDepth ?? MAX_RECURSIVE_DEPTH

if (recursionLimit === 0) {
throw new CodeError('Max recursive depth reached', 'ERR_MAX_RECURSIVE_DEPTH_REACHED')
throw new RecursionLimitError('Max recursive depth reached')
}

const [, hostname] = ma.stringTuples().find(([proto]) => proto === dnsaddrCode) ?? []
Expand Down
6 changes: 3 additions & 3 deletions test/resolvers.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ describe('multiaddr resolve', () => {

// Resolve
await expect(ma.resolve()).to.eventually.be.rejected()
.and.to.have.property('code', 'ERR_NO_AVAILABLE_RESOLVER')
.and.to.have.property('name', 'NoAvailableResolverError')
})

describe('dnsaddr', () => {
Expand Down Expand Up @@ -153,7 +153,7 @@ describe('multiaddr resolve', () => {
maxRecursiveDepth: 1
})

await expect(resolvePromise).to.eventually.be.rejected().with.property('code', 'ERR_MAX_RECURSIVE_DEPTH_REACHED')
await expect(resolvePromise).to.eventually.be.rejected().with.property('name', 'RecursionLimitError')
})

it('should handle recursive loops', async () => {
Expand All @@ -165,7 +165,7 @@ describe('multiaddr resolve', () => {
maxRecursiveDepth: 1
})

await expect(resolvePromise).to.eventually.be.rejected().with.property('code', 'ERR_MAX_RECURSIVE_DEPTH_REACHED')
await expect(resolvePromise).to.eventually.be.rejected().with.property('name', 'RecursionLimitError')
})

it('should handle double quotes', async () => {
Expand Down
Loading