Refs #29992 - pass stopInterval as callback also on API success #7842
Conversation
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
|
Issues: #29992 |
amirfefer
suggested changes
Aug 2, 2020
| @@ -131,3 +131,6 @@ dispatch( | |||
| ``` | |||
|
|
|||
| The success handling function will receive the response object from the API request. | |||
|
|
|||
| In case you are also using the interval middleware with the same `KEY`, | |||
There was a problem hiding this comment.
can you also add a mention in the Interval Middleware story?
| @@ -36,6 +36,21 @@ Array [ | |||
| `; | |||
|
|
|||
| exports[`API get should dispatch request and success actions on resolve 1`] = ` | |||
| Array [ | |||
There was a problem hiding this comment.
what this extra snap gives us?
There was a problem hiding this comment.
it captures the handleSuccess callback args as the API response,
and the second arg is a Function - the stopInterval / warning callbacks
| @@ -22,6 +22,10 @@ export const apiRequest = async ( | |||
| ) => { | |||
| const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(key, actionTypes); | |||
| const modifiedPayload = { ...payload, url }; | |||
| const stopIntervalCallback = selectDoesIntervalExist(getState(), key) | |||
| ? () => dispatch(stopInterval(key)) | |||
| : noop; | |||
There was a problem hiding this comment.
how about making a function that prints to the console a warning if a user consumes it?
Ron-Lavi
force-pushed
the
feat/success_stop_interval_cb
branch
from
7e0d456
to
f181bb8
Compare
amirfefer
reviewed
Sep 8, 2020
| @@ -25,6 +26,9 @@ export const apiRequest = async ( | |||
| ) => { | |||
| const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(key, actionTypes); | |||
| const modifiedPayload = { ...payload, url }; | |||
| const stopIntervalCallback = selectDoesIntervalExist(getState(), key) | |||
| ? () => dispatch(stopInterval(key)) | |||
| : () => console.warn(`There's no interval API request for the key: ${key}`); | |||
There was a problem hiding this comment.
is this warning needed in production?
There was a problem hiding this comment.
Yes I think so, it will be easier for debugging
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 are many scenarios where we would like to stop the API interval after receiving some information from the server,
in order to do it easily, the
stopIntervalfor the specific key would be passed as a second param in thehandleSuccesscallback.