Skip to content

feat: migrates Course Optimizer from Redux to React Query. - #3204

Draft
navinkarkera wants to merge 3 commits into
openedx:masterfrom
open-craft:navin/migrate-course-optimizer
Draft

feat: migrates Course Optimizer from Redux to React Query.#3204
navinkarkera wants to merge 3 commits into
openedx:masterfrom
open-craft:navin/migrate-course-optimizer

Conversation

@navinkarkera

@navinkarkera navinkarkera commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Description

This removes the old Redux slice, selectors, and thunks. It also improves scan status polling and stale-result handling.

This affects Course Authors and Instructors who can edit course content. There is no intended UI change.

Supporting information

Testing instructions

  1. Open a course in Studio with course-content edit access.
  2. Open Course Optimizer; add /optimizer to url from outline.
  3. Add a html xblock with some broken links
  4. Start a link check and confirm the scan status updates.
  5. Review the scan results.
  6. Rerun the scan and confirm new results replace old results.
  7. Update all broken links and update an individual link.
  8. Refresh the page during and after an operation.
  9. Confirm errors are shown if an API request fails.

Best Practices Checklist

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests use the helpers in src/testUtils.tsx.
  • No new fields were added to Redux.
  • React Query is used for REST API data.
  • New i18n messages have translator descriptions.
  • Avoid using ../ in import paths.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 24, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @navinkarkera!

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 Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 96.21849% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.93%. Comparing base (91d76aa) to head (dc573ba).

Files with missing lines Patch % Lines
src/optimizer-page/scan-results/ScanResults.tsx 90.72% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3204      +/-   ##
==========================================
- Coverage   95.93%   95.93%   -0.01%     
==========================================
  Files        1397     1395       -2     
  Lines       33622    33506     -116     
  Branches     7700     7696       -4     
==========================================
- Hits        32256    32144     -112     
+ Misses       1323     1319       -4     
  Partials       43       43              

☔ 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.

@bradenmacdonald

Copy link
Copy Markdown
Contributor

I'm not super familiar with the course optimizer code. When this is ready, could you please check the PRs or git blame to see if one of the main authors may want to review it? If they decline and/or in any case, me or Chris can give the necessary ✅ though.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Aug 26, 2026
@navinkarkera
navinkarkera force-pushed the navin/migrate-course-optimizer branch from 8c10778 to 2f5c30e Compare September 3, 2026 13:16
Replace the optimizer page's Redux state (slice, thunks, selectors) with
React Query hooks for all data fetching, polling, and mutation state.
Migrate the page and ScanResults components to the new hooks, convert the
optimizer test suite to TypeScript, handle stale-operation detection in
the hooks layer, and remove the Redux wiring.
After starting a rerun update, poll until the status endpoint reflects
the new operation before accepting a terminal result. The backend commits
the new operation's status before the POST response returns, so with no
cached previous status an immediately terminal response is accepted; a
terminal response equal to the cached previous one is rejected until a
new status is observed.
@navinkarkera
navinkarkera force-pushed the navin/migrate-course-optimizer branch from 2b473b8 to dc573ba Compare September 3, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

4 participants