-
-
Notifications
You must be signed in to change notification settings - Fork 289
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Wrapper around native fetch to improve error handling
- Loading branch information
Showing
11 changed files
with
145 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,128 @@ | ||
| export type FetchError = Error & { | ||
| /** | ||
| * Wrapper around native fetch to improve error handling | ||
| */ | ||
| async function wrappedFetch(url: string | URL, init?: RequestInit): Promise<Response> { | ||
| try { | ||
| return await fetch(url, init); | ||
| } catch (e) { | ||
| throw new FetchError(e, url); | ||
| } | ||
| } | ||
|
|
||
| export {wrappedFetch as fetch}; | ||
|
|
||
| export function isFetchError(e: unknown): e is FetchError { | ||
| return e instanceof FetchError; | ||
| } | ||
|
|
||
| export function isFetchAbortError(e: unknown): e is FetchError { | ||
| return e instanceof FetchError && e.type === "aborted"; | ||
| } | ||
|
|
||
| export type FetchErrorType = "system" | "input" | "aborted" | "unknown"; | ||
|
|
||
| export type FetchErrorCause = NativeFetchSystemError["cause"] | NativeFetchInputError["cause"]; | ||
|
|
||
| export class FetchError extends Error { | ||
| type: FetchErrorType; | ||
| code: string; | ||
| cause?: FetchErrorCause; | ||
|
|
||
| constructor(e: unknown, url: string | URL) { | ||
| if (isNativeSystemFetchError(e)) { | ||
| super(`Request to ${url.toString()} failed, reason: ${e.cause.message}`); | ||
| this.type = "system"; | ||
| this.code = e.cause.code; | ||
| this.cause = e.cause; | ||
| } else if (isNativeFetchInputError(e)) { | ||
| super(e.message); | ||
| this.type = "input"; | ||
| this.code = e.cause.code; | ||
| this.cause = e.cause; | ||
| } else if (isNativeFetchAbortError(e)) { | ||
| super(`Request to ${url.toString()} was aborted`); | ||
| this.type = "aborted"; | ||
| this.code = "ERR_ABORTED"; | ||
| } else { | ||
| super((e as Error).message); | ||
| this.type = "unknown"; | ||
| this.code = "ERR_UNKNOWN"; | ||
| } | ||
| this.name = this.constructor.name; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * ``` | ||
| * TypeError: fetch failed | ||
| * cause: Error: connect ECONNREFUSED 127.0.0.1:9596 | ||
| * errno: -111, | ||
| * code: 'ECONNREFUSED', | ||
| * syscall: 'connect', | ||
| * address: '127.0.0.1', | ||
| * port: 9596 | ||
| * | ||
| * TypeError: fetch failed | ||
| * cause: Error: getaddrinfo ENOTFOUND non-existent-domain | ||
| * errno: -3008, | ||
| * code: 'ENOTFOUND', | ||
| * syscall: 'getaddrinfo', | ||
| * hostname: 'non-existent-domain' | ||
| * ``` | ||
| */ | ||
| type NativeFetchSystemError = Error & { | ||
| cause: Error & { | ||
| errno: string; | ||
| code: string; | ||
| syscall: string; | ||
| address?: string; | ||
| port?: string; | ||
| hostname?: string; | ||
| }; | ||
| }; | ||
|
|
||
| export function isFetchError(error: unknown): error is FetchError { | ||
| /** | ||
| * ``` | ||
| * TypeError: Failed to parse URL from invalid-url | ||
| * [cause]: TypeError [ERR_INVALID_URL]: Invalid URL | ||
| * input: 'invalid-url', | ||
| * code: 'ERR_INVALID_URL' | ||
| * ``` | ||
| */ | ||
| type NativeFetchInputError = Error & { | ||
| cause: Error & { | ||
| input: unknown; | ||
| code: string; | ||
| }; | ||
| }; | ||
|
|
||
| /** | ||
| * ``` | ||
| * DOMException [AbortError]: This operation was aborted | ||
| * ``` | ||
| */ | ||
| type NativeFetchAbortError = DOMException & { | ||
| name: "AbortError"; | ||
| }; | ||
|
|
||
| function isNativeSystemFetchError(e: unknown): e is NativeFetchSystemError { | ||
| return ( | ||
| error instanceof Error && | ||
| (error as FetchError).cause instanceof Error && | ||
| (error as FetchError).cause.errno !== undefined && | ||
| (error as FetchError).cause.code !== undefined | ||
| e instanceof Error && | ||
| (e as NativeFetchSystemError).cause instanceof Error && | ||
| (e as NativeFetchSystemError).cause.code !== undefined && | ||
| (e as NativeFetchSystemError).cause.syscall !== undefined | ||
| ); | ||
| } | ||
|
|
||
| export function enhanceFetchErrors(error: unknown): void { | ||
| if (isFetchError(error)) { | ||
| // Override message with cause.message to get more detailed errors | ||
| error.message = error.cause.message; | ||
| } | ||
| function isNativeFetchInputError(e: unknown): e is NativeFetchInputError { | ||
| return ( | ||
| e instanceof Error && | ||
| (e as NativeFetchInputError).cause instanceof Error && | ||
| (e as NativeFetchInputError).cause.code !== undefined && | ||
| (e as NativeFetchInputError).cause.input !== undefined | ||
| ); | ||
| } | ||
|
|
||
| function isNativeFetchAbortError(e: unknown): e is NativeFetchAbortError { | ||
| return e instanceof DOMException && e.name === "AbortError"; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters