Skip to content

fix(examples/react/algolia): compute the next page from 'lastPageParam' and the optional 'nbPages' - #11967

Merged
sukvvon merged 1 commit into
mainfrom
fix/examples-react-algolia-next-page-param
Oct 11, 2026
Merged

sukvvon merged 1 commit into
mainfrom
fix/examples-react-algolia-next-page-param

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

In @algolia/client-search 5.59.0, page and nbPages on the search response are optional, so search() computing page + 1 < nbPages fails type-checking in the algolia example.

  • search() returns { hits, nbPages }, with nbPages falling back to 0 when it is missing.
  • useAlgolia computes the next page in getNextPageParam from lastPageParam and nbPages, as described in "What if my API doesn't return a cursor?" in the infinite queries guide, instead of reading it from the response's page.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Bug Fixes
    • Improved pagination in the React Algolia example: search results now continue to the next page only when more pages are available, and stop at the end of the results.
    • Searches with no reported page count now safely show no additional pages.

@sukvvon sukvvon self-assigned this Oct 11, 2026
@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3b80de3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: f71b7b82-ffb4-45b8-a142-f2b58ccb6f0d

📥 Commits

Reviewing files that changed from the base of the PR and between 4e21da7 and 3b80de3.


📒 Files selected for processing (2)
  • examples/react/algolia/src/algolia.ts
  • examples/react/algolia/src/useAlgolia.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The Algolia search function now returns the page count with its hits. The pagination hook uses the current page and page count to determine whether to return another page parameter.

Changes

Algolia Pagination

Layer / File(s) Summary
Return page count and calculate the next page
examples/react/algolia/src/algolia.ts, examples/react/algolia/src/useAlgolia.ts
search returns nbPages, defaulting to 0 when the response omits it. getNextPageParam increments the current page when it is below nbPages; otherwise, it returns undefined.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix


Merge Risk: ⚪ Minimal · up to 3b80d

Pagination stops at the last available page, and no actionable merge risk remains.

Pre-merge checks | Passed 4 | Failed 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check Passed The title clearly describes the main change: computing the next page from lastPageParam and optional nbPages in the Algolia example.
Description check Passed The description explains the motivation and implementation, and it includes all template sections with the checklist completed and release impact identified as docs/CI/dev-only.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR


🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nx-cloud

nx-cloud Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 3b80de3

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 2m 35s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-11 14:38:17 UTC

@pkg-pr-new

pkg-pr-new Bot commented Oct 11, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@11967

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@11967

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11967

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11967

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@11967

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11967

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@11967

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@11967

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@11967

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@11967

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@11967

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@11967

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@11967

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@11967

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@11967

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@11967

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@11967

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@11967

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@11967

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@11967

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@11967

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@11967

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@11967

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@11967

commit: 3b80de3

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.73 KB (0%)
react minimal 8.58 KB (0%)

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/query-core 5.104.1 → 5.104.2 Changeset
@tanstack/vue-query 5.104.1 → 5.104.2 Changeset
@tanstack/angular-query-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/angular-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/eslint-plugin-query 5.104.1 → 5.104.2 Dependent
@tanstack/lit-query 0.2.26 → 0.2.27 Dependent
@tanstack/preact-query 5.104.1 → 5.104.2 Dependent
@tanstack/preact-query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/preact-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/query-async-storage-persister 5.104.1 → 5.104.2 Dependent
@tanstack/query-broadcast-client-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/query-persist-client-core 5.104.1 → 5.104.2 Dependent
@tanstack/query-sync-storage-persister 5.104.1 → 5.104.2 Dependent
@tanstack/react-query 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-next-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/svelte-query 6.3.1 → 6.3.2 Dependent
@tanstack/svelte-query-devtools 6.3.1 → 6.3.2 Dependent
@tanstack/svelte-query-persist-client 6.3.1 → 6.3.2 Dependent
@tanstack/vue-query-devtools 6.3.1 → 6.3.2 Dependent

@sukvvon
sukvvon merged commit 3ae9fb0 into main Oct 11, 2026
9 checks passed
@sukvvon
sukvvon deleted the fix/examples-react-algolia-next-page-param branch October 11, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant