Skip to content

refactor: read the course outline from authoring v2 (FC-0118) - #3373

Draft
taimoor-ahmed-1 wants to merge 1 commit into
openedx:masterfrom
taimoor-ahmed-1:taimoor-ahmed/fc0118-course-outline
Draft

taimoor-ahmed-1 wants to merge 1 commit into
openedx:masterfrom
taimoor-ahmed-1:taimoor-ahmed/fc0118-course-outline

Conversation

@taimoor-ahmed-1

Copy link
Copy Markdown
Contributor

Description

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

Draft until openedx/openedx-platform#39229 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).

GET /api/contentstore/v1/course_index/{course_id} → GET /api/authoring/v2/courses/{course_key}/outline/?view=full.

The default v2 view is a thin tree of block names. view=full returns the v1 payload under the v1 field names, built by the same server code, so no reshaping is needed. The only top-level field it drops is initial_user_clipboard, which the MFE never read; it is removed from the CourseOutline type. The competency-management screens use the same query, so they move too.

User roles impacted: Course Author (course outline; competency management). No visible change expected.

Supporting information

Testing instructions

  1. Open a course outline in Studio: sections, subsections, units, dates, highlights, the discussions and proctoring notices, and the reindex link all render.
  2. Add, move and delete a section; the outline refreshes.
  3. npm test -- src/course-outline src/taxonomy/competency-management

Other information

  • Blocks dated before 1900 now show their stored date. v1 replaced such dates on read and showed "Set Date". The platform PR declares this difference.
  • 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'

The course outline page read GET /api/contentstore/v1/course_index/{course_id},
which openedx-platform#39229 supersedes with
GET /api/authoring/v2/courses/{course_key}/outline/.

getCourseOutlineIndex now requests that address with view=full, which
returns the v1 payload under the same field names. The default view is a
thin tree of block names and does not carry the block settings or page
data the outline and the competency-management course browser read.
Components, hooks and selectors are unchanged.

The full view drops initial_user_clipboard, which nothing read; the
clipboard comes from the content-staging API. It is removed from the
CourseOutline type and the test outline builder.
@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.38%. Comparing base (f2dab4e) to head (31bf970).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3373      +/-   ##
==========================================
+ Coverage   96.36%   96.38%   +0.02%     
==========================================
  Files        1467     1472       +5     
  Lines       36182    36465     +283     
  Branches     8692     8813     +121     
==========================================
+ Hits        34867    35148     +281     
- Misses       1272     1275       +3     
+ Partials       43       42       -1     

☔ 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