-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add error handling page for Storage & Auth #8288
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
Draft
AllanZhengYP
wants to merge
2
commits into
main
Choose a base branch
from
auth-sto-errors
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.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
66 changes: 66 additions & 0 deletions
66
.../[platform]/build-a-backend/auth/connect-your-frontend/error-handling/index.mdx
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,66 @@ | ||
import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; | ||
|
||
export const meta = { | ||
title: 'Error handling', | ||
description: | ||
'Handling errors from Amplify Auth', | ||
platforms: [ | ||
'angular', | ||
'javascript', | ||
'nextjs', | ||
'react', | ||
'vue', | ||
'react-native' | ||
] | ||
}; | ||
|
||
export const getStaticPaths = async () => { | ||
return getCustomStaticPath(meta.platforms); | ||
}; | ||
|
||
export function getStaticProps(context) { | ||
return { | ||
props: { | ||
platform: context.params.platform, | ||
meta | ||
} | ||
}; | ||
} | ||
|
||
The runtime errors thrown by the Amplify Auth APIs may contain additional information helpful with identifying root-causes of problems. This information is available if the error is an instance of `AuthError`. | ||
|
||
```javascript | ||
import { AuthError, confirmSignUp } from 'aws-amplify/auth'; | ||
|
||
try { | ||
const result = await confirmSignUp({ | ||
username: "[email protected]", | ||
confirmationCode: "123456" | ||
}); | ||
} catch (error) { | ||
if (error instanceof AuthError) { | ||
console.error('Auth error', error.name); | ||
if (error.metadata) { | ||
console.error('request ID: ', error.metadata.requestId); | ||
} | ||
} | ||
// Further error handling... | ||
} | ||
``` | ||
|
||
`AuthError` may also be thrown by the Storage APIs. | ||
|
||
## All `AuthError` properties | ||
|
||
Property | Type | Required | Description | | ||
| -- | -- | -- | ----------- | | ||
| name | String | Required | Client-side error name or server-side error code. | | ||
| message | String | Required | Error message. | | ||
| stack | String | Optional | Stack trace. | | ||
| recoverySuggestion | String | Optional | Common cause of the error and human-readable recommendation to fix the error.| | ||
| metadata | Object | Optional | Bag of additional error information. | | ||
| metadata.httpStatusCode | number | Optional | The response HTTP status code if the error is caused by erroneous HTTP response. | | ||
| metadata.requestId | String | Optional | The request ID used by AWS when [contacting AWS Support](https://docs.aws.amazon.com/AmazonS3/latest/API/get-request-ids.html). | | ||
| metadata.extendedRequestId | String | Optional | The extended request ID used by AWS when [contacting AWS Support](https://docs.aws.amazon.com/AmazonS3/latest/API/get-request-ids.html). | | ||
|
||
|
67 changes: 67 additions & 0 deletions
67
src/pages/[platform]/build-a-backend/storage/error-handling/index.mdx
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,67 @@ | ||
import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; | ||
|
||
export const meta = { | ||
title: 'Error handling', | ||
description: | ||
'Handling errors from Amplify Storage', | ||
platforms: [ | ||
'angular', | ||
'javascript', | ||
'nextjs', | ||
'react', | ||
'vue', | ||
'react-native' | ||
] | ||
}; | ||
|
||
export const getStaticPaths = async () => { | ||
return getCustomStaticPath(meta.platforms); | ||
}; | ||
|
||
export function getStaticProps(context) { | ||
return { | ||
props: { | ||
platform: context.params.platform, | ||
meta | ||
} | ||
}; | ||
} | ||
|
||
The runtime errors thrown by the Amplify Storage APIs may contain additional information helpful with identifying root-causes of problems. This information is available if the error is an instance of `StorageError`. | ||
|
||
```javascript | ||
import { StorageError, uploadData } from 'aws-amplify/storage'; | ||
|
||
try { | ||
const result = await uploadData({ | ||
path: "album/2024/1.jpg", | ||
data: file, | ||
}).result; | ||
console.log('Succeeded: ', result); | ||
} catch (error) { | ||
if (error instanceof StorageError) { | ||
console.error('Storage error', error.name); | ||
if (error.metadata) { | ||
console.error('request ID: ', error.metadata.requestId); | ||
} | ||
} | ||
// Further error handling... | ||
} | ||
``` | ||
|
||
`AuthError` may also be thrown by the Storage APIs. | ||
|
||
## All `StorageError` properties | ||
|
||
Property | Type | Required | Description | | ||
| -- | -- | -- | ----------- | | ||
| name | String | Required | Client-side error name or server-side error code. | | ||
| message | String | Required | Error message. | | ||
| stack | String | Optional | Stack trace. | | ||
| recoverySuggestion | String | Optional | Common cause of the error and human-readable recommendation to fix the error.| | ||
| metadata | Object | Optional | Bag of additional error information. | | ||
| metadata.httpStatusCode | number | Optional | The response HTTP status code if the error is caused by erroneous HTTP response. | | ||
| metadata.requestId | String | Optional | The request ID used by AWS when [contacting AWS Support](https://docs.aws.amazon.com/AmazonS3/latest/API/get-request-ids.html). | | ||
| metadata.extendedRequestId | String | Optional | The extended request ID used by AWS when [contacting AWS Support](https://docs.aws.amazon.com/AmazonS3/latest/API/get-request-ids.html). | | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a bit more detail here. Feels weird to say this and then show a table of the StorageError properties.