Add pagination query parameters to Dataset&File Version Summaries use case #395
Conversation
github-actions
bot
added
FY26 Sprint 9
ChengShi-1
moved this from In Progress 💻
to Ready for Review ⏩
in IQSS Dataverse Project
There was a problem hiding this comment.
Pull Request Overview
This PR adds pagination support to the Dataset and File Version Summaries use cases by introducing optional limit and offset query parameters. This allows clients to retrieve version summaries in paginated chunks rather than loading all versions at once.
Key Changes:
- Added optional
limitandoffsetparameters toGetDatasetVersionsSummariesandGetFileVersionSummariesuse cases and their corresponding repository methods - Updated documentation to reflect the new pagination parameters
- Added comprehensive integration tests to verify pagination functionality
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/datasets/domain/useCases/GetDatasetVersionsSummaries.ts | Added optional limit and offset parameters to the execute method |
| src/datasets/domain/repositories/IDatasetsRepository.ts | Updated interface signature to include pagination parameters |
| src/datasets/infra/repositories/DatasetsRepository.ts | Implemented query parameter building and passing to API endpoint |
| src/files/domain/useCases/GetFileVersionSummaries.ts | Added optional limit and offset parameters to the execute method |
| src/files/domain/repositories/IFilesRepository.ts | Updated interface signature to include pagination parameters |
| src/files/infra/repositories/FilesRepository.ts | Implemented query parameter building and passing to API endpoint |
| test/unit/datasets/GetDatasetVersionsSummaries.test.ts | Updated test to verify undefined pagination parameters are passed correctly |
| test/integration/datasets/DatasetsRepository.test.ts | Added comprehensive pagination test with 22 versions across multiple pages |
| test/integration/files/FilesRepository.test.ts | Added comprehensive pagination test and updated existing test expectations |
| docs/useCases.md | Updated documentation to describe the new pagination parameters |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…tasetfile-version-summaries-use-case
g-saracca
left a comment
g-saracca
left a comment
There was a problem hiding this comment.
Just one comment about how to handle query params and one question, are we returning the total count from these use cases, similar how we do for the GetCollectionItems?
You will need the total count to know when to keep asking or when you reach the final page.
| const queryParams: { limit?: string; offset?: string } = { | ||
| limit: limit?.toString(), | ||
| offset: offset?.toString() | ||
| } |
There was a problem hiding this comment.
You can follow same approach as here for limit and offset, using URLSearchParams
There was a problem hiding this comment.
Yes, the api returns totalCount but I didn't add it to use case. I modified the code to apply totalCount, please review again. Thank you! @g-saracca
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
|
@ChengShi-1 approved, note that this is a breaking change, you will need a frontend change to avoid things breaking 👍🏼 |
|
awesome - merging! |
github-project-automation
bot
moved this from Ready for QA ⏩
to Merged 🚀
in IQSS Dataverse Project
ofahimIQSS
deleted the
394-add-pagination-query-parameters-to-datasetfile-version-summaries-use-case
branch
What this PR does / why we need it:
Add pagination query parameters to Dataset&File Version Summaries use case
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
Suggestions on how to test this:
Is there a release notes or changelog update needed for this change?:
yes
Additional documentation: