feat: respect cancelRefetch flag for infinite queries (fetchNextPage, fetchPreviousPage)

[lgenzelis]

closes #2617

Changes

• Added cancelRefetch to FetchNextPageOptions and FetchPreviousPageOptions interfaces
• Pass cancelRefetch flag down to this.fetch, defaulting it to true
• Added .idea folder to .gitignore (Webstorm project config folder)

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/tannerlinsley/react-query/6CW2HtrMoySqhpNm8ByJWWDMGSmQ
✅ Preview: https://react-query-git-fork-lgenzelis-feat-respec-cf9eb3-tannerlinsley.vercel.app

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 4c1194d:

Sandbox	Source
tannerlinsley/react-query: basic	Configuration
tannerlinsley/react-query: basic-typescript	Configuration
react-query-infiniteQuery-bug	Issue #2617

[TkDodo]

awesome. could you please

• update the api docs (https://react-query.tanstack.com/reference/useInfiniteQuery), as options.pageParam is also mentioned for fetchNextPage / fetchPreviousPage)
• add a test for passing cancelRefetch: false

[lgenzelis]

@TkDodo I'm sorry, I feel a bit lost about the testing part. Could you please point me to an example where cancelRefetch is being tested? (for regular non-infinite queries, I mean)

[TkDodo]

I would probably just test if cancel on the query itself has been called:

https://github.com/tannerlinsley/react-query/blob/e6da990703482cff8ea99f5a254975cb57463ed5/src/core/query.ts#L362-L364

[lgenzelis]

@TkDodo I addressed your points 😃

• updated documentation
• added tests for the cases where cancelRefetch is omitted (so, it's true) and when cancelRefetch: false is passed to fetchNextPage

[TkDodo]

👍

[TkDodo]

Would you consider this a feature rather than a bugfix ?

[tannerlinsley]

🎉 This PR is included in version 3.26.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[lgenzelis]

Would you consider this a feature rather than a bugfix ?

@TkDodo I guess so. Mainly because we didn't agree that the previous behavior was a bug on the first place 🤷‍♀️