This repository was archived by the owner on May 21, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17
[RFC ] Errors handling #341
Open
andrzejewsky
wants to merge
1
commit into
master
Choose a base branch
from
errorsHandling
base: master
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Errors handling in composables | ||
|
|
||
| ## Motivation | ||
|
|
||
| We need to handle errors, that are caused by external api calls provided by factory params. | ||
| Furthermore, it must be something to recognize where that error comes from (which call). | ||
|
|
||
| We can solve it by introducing fields inside the errors object and the `AgnosticError`: | ||
|
|
||
| Factory | ||
| ```js | ||
| const useProductFactory = (factoryParams) => { | ||
| const useProduct = () => { | ||
| const products = ref([]); | ||
| const errors = ref({};) | ||
|
|
||
|
|
||
| const search = async (params) => { | ||
| try { | ||
| products.value = factoryParams.searchProducts(params); | ||
| } catch (err) { | ||
| errors.searchProducts = factoryParams.convertError(err); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. params should also be passed to the converError in order to supply additional information about context of this method used. If we execute one method multiple times we will lose all errors except the one from last execution |
||
| } | ||
| } | ||
|
|
||
|
|
||
| return { products, search } | ||
| } | ||
| } | ||
|
|
||
| export default useProductFactory | ||
| ``` | ||
|
|
||
| Usage: | ||
|
|
||
| ```js | ||
| import { useProductFactory } from '@vue-storefront/factories'; | ||
|
|
||
|
|
||
| const factoryParams = { | ||
| searchProducts: async (params) => { | ||
| return await getProductsFromApi(params); | ||
| }, | ||
| convertError: (error) => { | ||
| if ('this is search product error ?') { | ||
| return 'this is error message for searching products'; | ||
| } | ||
|
|
||
| return error; | ||
| } | ||
| }; | ||
|
|
||
| export default useProductFactory() | ||
|
|
||
| ``` | ||
|
|
||
| Summary: | ||
| - factory catches errors, and convert them to the readable message using `convertError` | ||
| - `convertError` is a new factory param, you have to provide it in order to handle and react on errors | ||
|
|
||
|
|
||
| ## Migration process | ||
| Transparent, `convertError` is optional, also you don't have to implement errors if you don't need now | ||
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.