-
Notifications
You must be signed in to change notification settings - Fork 9
feat: Improve error handling from 3P requests on interceptor #238
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
Open
atilafassina
wants to merge
7
commits into
main
Choose a base branch
from
req-error-handling
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f08af8d
refactor: replace undefined return with ExecutionResult in execute()
atilafassina 8b520ba
test: update execute() tests for ExecutionResult and add AppKitError …
atilafassina 1f5d80d
chore: docs update
atilafassina 3a0adad
chore: preserve upstream HTTP status codes in execute() for non-AppKi…
atilafassina d3ac0cf
docs: regenerate ExecutionResult API docs with error handling details
atilafassina 8be15c7
refactor: use HTTP status code descriptions in files plugin (#258)
atilafassina 7032f72
fix: correct test assertions for 404/409 status text in files plugin
atilafassina File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Type Alias: ExecutionResult\<T\> | ||
|
|
||
| ```ts | ||
| type ExecutionResult<T> = | ||
| | { | ||
| data: T; | ||
| ok: true; | ||
| } | ||
| | { | ||
| message: string; | ||
| ok: false; | ||
| status: number; | ||
| }; | ||
| ``` | ||
|
|
||
| Discriminated union for plugin execution results. | ||
|
|
||
| Replaces the previous `T | undefined` return type on `execute()`. | ||
|
|
||
| On failure, the HTTP status code is preserved from: | ||
| - `AppKitError` subclasses (via `statusCode`) | ||
| - Any `Error` with a numeric `statusCode` property (e.g. `ApiError`) | ||
| - All other errors default to status 500 | ||
|
|
||
| In production, error messages from non-AppKitError sources are handled as: | ||
| - 4xx errors: original message is preserved (client-facing by design) | ||
| - 5xx errors: replaced with "Server error" to prevent information leakage | ||
|
|
||
| ## Type Parameters | ||
|
|
||
| | Type Parameter | | ||
| | ------ | | ||
| | `T` | |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /** | ||
| * Discriminated union for plugin execution results. | ||
| * | ||
| * Replaces the previous `T | undefined` return type on `execute()`. | ||
| * | ||
| * On failure, the HTTP status code is preserved from: | ||
| * - `AppKitError` subclasses (via `statusCode`) | ||
| * - Any `Error` with a numeric `statusCode` property (e.g. `ApiError`) | ||
| * - All other errors default to status 500 | ||
| * | ||
| * In production, error messages from non-AppKitError sources are handled as: | ||
| * - 4xx errors: original message is preserved (client-facing by design) | ||
| * - 5xx errors: replaced with "Server error" to prevent information leakage | ||
| */ | ||
| export type ExecutionResult<T> = | ||
| | { ok: true; data: T } | ||
| | { ok: false; status: number; message: string }; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| export type { ToPlugin } from "shared"; | ||
| export type { ExecutionResult } from "./execution-result"; | ||
| export { Plugin } from "./plugin"; | ||
| export { toPlugin } from "./to-plugin"; |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.