Add isAbortError to @solana/promises#1549
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: 6e1e66f The changes in this PR will be included in the next version bump. This PR includes changesets to release 46 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
BundleMonFiles updated (3)
Unchanged files (141)
Total files change +126B +0.02% Final result: ✅ View report in BundleMon website ➡️ |
Contributor
|
Documentation Preview: https://kit-docs-e7syjl5cf-anza-tech.vercel.app |
Member
Author
trevor-cortex
left a comment
trevor-cortex
left a comment
There was a problem hiding this comment.
Nice, tidy addition. Adds isAbortError(err) to @solana/promises as a narrow predicate — err instanceof Error && err.name === 'AbortError' — so callers don't have to instanceof-check each platform's error class. Pairs well with getAbortablePromise and standard fetch abort behavior.
What looks good
- Export is automatic via the existing
export * from './abortable'insrc/index.ts, no index change needed. minorchangeset is correct for a new public API.- JSDoc follows the repo's docblock skill (summary,
@example,@see {@link getAbortablePromise}). - README section mirrors the style of the adjacent
getAbortablePromiseentry. - Tests cover the happy path, a subclass, the real abort flow through
getAbortablePromise, and the main negative cases (regularError,TypeError, duck-typed object,undefined,null).expect.assertions(1)is correctly used only in the async test, per CLAUDE.md.
For subsequent reviewers
- The docblock specifically mentions
DOMExceptionas the real-world aborted-fetch rejection, but the tests simulate it withObject.assign(new Error(), { name: 'AbortError' })rather than a realnew DOMException('...', 'AbortError').DOMExceptionextendsErrorin all environments Kit targets (Node ≥17 current/lts, browsers, RN) so the predicate works, but a directDOMExceptiontest would tie the behavior more tightly to the documented use case. Non-blocking. - Worth sanity-checking that
@solana/promisesgenuinely isn't intended to be re-exported from the@solana/kitfacade — it currently isn't (neithergetAbortablePromisenor the newisAbortErrorwill be reachable from@solana/kit). That's pre-existing and out of scope for this PR, just flagging.
| it('returns `false` for a non-`Error` object whose `name` is `AbortError`', () => { | ||
| expect(isAbortError({ name: 'AbortError' })).toBe(false); | ||
| }); | ||
| it('returns `false` for `undefined`', () => { |
There was a problem hiding this comment.
Optional: since the docblock specifically calls out DOMException as the real-world aborted-fetch rejection shape, consider adding a case that uses the real thing:
it('returns `true` for a `DOMException` whose `name` is `AbortError`', () => {
expect(isAbortError(new DOMException('The operation was aborted.', 'AbortError'))).toBe(true);
});This exercises the instanceof Error branch against the actual platform class rather than a synthesized Error with a patched name, and guards against any future environment where DOMException stops extending Error. Non-blocking.
Member
Author
There was a problem hiding this comment.
Good idea - had to add this as a browser only test because of a limitation of Jest's node env.
mcintyre94
force-pushed
the
is-abort-error
branch
from
f5f38cb to
15de2e4
Compare
lorisleiva
approved these changes
Apr 21, 2026
Member
lorisleiva
left a comment
lorisleiva
left a comment
There was a problem hiding this comment.
Thanks! I double-checked and it also works when passing nothing to AbortController.abort (See playground). nit: Maybe we could add a test case like this.
Adds `isAbortError(err)` to `@solana/promises`. The helper narrows `unknown` to `Error` and returns `true` when the error's `name` is `'AbortError'` — the convention used by `DOMException` and by `AbortController`-aware APIs like `fetch`. Callers catching rejections from `getAbortablePromise`, superseded operations, or other abort-aware flows can use this to distinguish intentional cancellation from real failures without having to `instanceof`-check every platform-specific error class. Ships with test coverage across Node and browser environments and a README entry demonstrating the try/catch pattern alongside `getAbortablePromise`.
mcintyre94
force-pushed
the
is-abort-error
branch
from
15de2e4 to
6e1e66f
Compare
Member
Author
|
Nice, thanks! Added to the browser tests because it has the same quirk in Jest's Node environment. |
Contributor
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Solana Kit Docs' |
This was referenced Apr 21, 2026
Merged
Closed
Contributor
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
This PR adds a new function
isAbortErrorto@solana/promisesIt provides an easy way to filter for an abort error, in the same way we do with
isSolanaError. Pairs withgetAbortablePromise, but useful for anything throwing abort errors (like fetch) too.