Skip to content

refactor: read and reorder custom pages from authoring v1 (FC-0118) - #3368

Draft
taimoor-ahmed-1 wants to merge 2 commits into
openedx:masterfrom
taimoor-ahmed-1:taimoor-ahmed/fc0118-custom-pages
Draft

taimoor-ahmed-1 wants to merge 2 commits into
openedx:masterfrom
taimoor-ahmed-1:taimoor-ahmed/fc0118-custom-pages

Conversation

@taimoor-ahmed-1

Copy link
Copy Markdown
Contributor

Stacked on #3362 (textbooks), which adds getAllPages for paginated lists. Until #3362 merges, this PR also shows its commit; only the last commit belongs here.

Description

Part of #3361 (FC-0118 Phase 3, parent openedx/openedx-platform#39349).

Draft until openedx/openedx-platform#39305 merges: it adds the endpoint this PR calls. The old address stays live until it is removed through the DEPR process (openedx/openedx-platform#39128).

  • List: GET /api/contentstore/v0/tabs/{course_id} → GET /api/authoring/v1/custom_pages/?course_key={course_key}, read page by page with getAllPages. The course key is sent as a query parameter so its + is percent-encoded. The items have the same fields; v0 and v1 both return only static tabs.
  • Reorder: POST /api/contentstore/v0/tabs/{course_id}/reorder with [{tab_locator}] → PUT /api/authoring/v1/courses/{course_key}/custom_page_order/ with {"custom_pages": [<usage key>, …]}. updateCustomPageOrder now takes the ids; its only caller is useReorderCustomPages.
  • Adding, editing and deleting a page stay on /xblock/. The tab-settings endpoint has no caller in this MFE.

User roles impacted: Course Author (Content → Pages & Resources → Custom pages). No visible change expected.

Supporting information

Testing instructions

  1. Studio → Content → Pages & Resources → Custom pages: the list loads. Drag a page to a new position and reload: the order is kept.
  2. npm test -- src/custom-pages

Other information

  • getTabHandlerUrl is replaced by getCustomPagesApiUrl and getCustomPageOrderApiUrl; only this area's tests used it.
  • Tested against mocks shaped from the platform PR's serializers; the platform PR is not merged yet.
  • No migrations, no accessibility impact.

Best Practices Checklist

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use. (None added.)
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

Taimoor Ahmed added 2 commits November 16, 2026 18:56
The textbooks page read GET /api/contentstore/v1/textbooks/{course_id},
which openedx-platform#39157 superseded with the paginated
GET /api/authoring/v2/courses/{course_key}/textbooks/.

getTextbooks now reads every page of the v2 list and returns the same
{ textbooks } shape as before, so the page and hooks are unchanged.
Creating, editing and deleting a textbook stay on the Studio route.

Adds getAllPages, which requests the largest page size and then any
remaining pages by number, for the other Studio lists that are moving
to paginated endpoints.
The custom pages screen read GET /api/contentstore/v0/tabs/{course_id}
and reordered with POST /api/contentstore/v0/tabs/{course_id}/reorder,
which openedx-platform#39305 supersedes with the paginated
GET /api/authoring/v1/custom_pages/?course_key={course_key} and
PUT /api/authoring/v1/courses/{course_key}/custom_page_order/.

getCustomPages now reads every page of the v1 list, sending the course
key as a query parameter so it is percent-encoded, and returns the same
array of pages as before. Like v0, the list holds only custom pages,
with the same members per page.

updateCustomPageOrder now takes the page ids (usage keys) in their new
order and sends them as {"custom_pages": [...]}, instead of v0's list of
{tab_locator} objects; useReorderCustomPages passes the ids.
getTabHandlerUrl is replaced by getCustomPagesApiUrl and
getCustomPageOrderApiUrl.

Adding, editing and deleting a page stay on the Studio xblock route.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 17, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @taimoor-ahmed-1!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov

codecov Bot commented Nov 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.39%. Comparing base (f2dab4e) to head (b12cb72).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3368      +/-   ##
==========================================
+ Coverage   96.36%   96.39%   +0.02%     
==========================================
  Files        1467     1473       +6     
  Lines       36182    36485     +303     
  Branches     8692     8807     +115     
==========================================
+ Hits        34867    35168     +301     
+ Misses       1272     1261      -11     
- Partials       43       56      +13     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants