Fix: useQuery returns called value based on skip option. #9798
Conversation
|
@KucharskiPiotr: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/ |
| it('should set called to false when skip option is true', async () => { | ||
| const query = gql`{ hello }`; | ||
| const mocks = [ | ||
| { | ||
| request: { query }, | ||
| result: { data: { hello: "world" } }, | ||
| }, | ||
| ]; | ||
|
|
||
| const cache = new InMemoryCache(); | ||
| const wrapper = ({ children }: any) => ( | ||
| <MockedProvider mocks={mocks} cache={cache}>{children}</MockedProvider> | ||
| ); | ||
|
|
||
| const { result, unmount } = renderHook( | ||
| () => useQuery(query, { skip: true }), | ||
| { wrapper }, | ||
| ); | ||
|
|
||
| expect(result.current.called).toBe(false); | ||
| unmount(); | ||
| }); |
There was a problem hiding this comment.
The following test is copy-paste of the test above (should set called to true by default) with added { skip: true } parameter to useQuery and changed expected value to be false.
There was a problem hiding this comment.
Makes sense to me, and thanks for adding tests @KucharskiPiotr!
Changed returned `called` value of `QueryResult` to be false, when the `skip` parameter of `QueryHookOptions` is set to true. Otherwise, `called` value should return true like it used to do by default.
benjamn
force-pushed
the
useQuery-called-logic
branch
from
1951015 to
f9e8b35
Compare
|
@KucharskiPiotr These changes have been soft-published in |
Changed returned
calledvalue ofQueryResultto be false, whenthe
skipparameter ofQueryHookOptionsis set to true. Otherwise,calledvalue should return true like it used to do by default.Checklist:
Reason to change:
useQueryresult documentation states thatcalledvalue should betrueonly if the query has been executed. Currently, whenuseQueryis called with option{ skip: true }, the value ofcalledremainstrue, even though the network request hasn't been done. This was discussed in #7931.This Pull Request changes value of
calledto be based on theskipoption - if the option was set totrue, thecalledvalue will be set tofalse, which should work as expected.