Request child pages using pagination #61
Merged
Conversation
This file contains hidden or 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
markdown-confluence-sync v2.1.0
|
Check SPDX headers ✅ 242 files have valid headers. |
|
Check License Compliance ✅ There are 1437 dependencies with allowed licenses.
✅ Result: Valid licenses |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a manual pagination workaround for retrieving child pages from Confluence when their number exceeds the default API limit, and updates mocks, tests, and versioning accordingly.
- Introduces a
_getChildPagesmethod inCustomConfluenceClientthat uses Axios and recursion to fetch all child pages. - Adds
getPageChildrenMiddlewareand related route/collection entries in mocks for both repositories. - Updates unit and component tests to cover paginated child page retrieval and error scenarios, plus version bumps and CHANGELOG entries.
Reviewed Changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| components/markdown-confluence-sync/package.json | Bumped version to 2.1.1 |
| components/markdown-confluence-sync/mocks/routes/Confluence.ts | Added getPageChildrenMiddleware and new route variants for pagination |
| components/markdown-confluence-sync/mocks/collections.ts | Included child-page routes in mock collections |
| components/markdown-confluence-sync/CHANGELOG.md | Added entry for fixing pages with >25 children |
| components/confluence-sync/test/unit/specs/confluence/CustomConfluenceClient.test.ts | Added tests for recursive child-page fetching and error handling |
| components/confluence-sync/test/component/specs/Sync.spec.ts | Updated component tests to assert paginated child-page requests |
| components/confluence-sync/src/confluence/CustomConfluenceClient.ts | Implemented _getChildPages for recursive pagination |
| components/confluence-sync/package.json | Bumped version to 2.0.2 |
| components/confluence-sync/mocks/routes/Confluence.ts | Added getPageChildrenMiddleware and pagination route variants |
| components/confluence-sync/mocks/collections.ts | Updated mock collections to include child-page variants |
| components/confluence-sync/CHANGELOG.md | Documented fix for child pages >25 issue |
| .github/workflows/publish.yml | Removed trailing whitespace |
| .github/ISSUE_TEMPLATE/BUG.yml | Updated bug template to allow selecting versions 1.x or 2.x |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
components/confluence-sync/src/confluence/CustomConfluenceClient.ts
Outdated
Show resolved
Hide resolved
components/confluence-sync/src/confluence/CustomConfluenceClient.ts
Outdated
Show resolved
Hide resolved
javierbrea
requested review from
JavierIbanezSoloaga,
MiguelJMC7,
ismtabo and
rnowm
MiguelJMC7
approved these changes
Jul 11, 2025
ismtabo
approved these changes
Jul 11, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Request child pages using pagination
Description
This PR implements a temporary workaround to retrieve all child pages from Confluence when their number exceeds the default API limit (25).
The current confluence.js library does not support pagination in the getContentChildren method, so this solution uses Axios to query the Confluence API directly with manual pagination.
closes #60
Agreement
Please check the following boxes after you have read and understood each item.
In case this is your first contribution to this project, you will also have to add a comment with the following text: "I have read the CLA Document and I hereby sign the CLA", otherwise the PR status will fail and our bot will request you to add it. Once you have signed it in a PR, you will not have to sign it again for future contributions.