feat: Use openedx_catalog app, backfill its CourseRuns [FC-0117] by bradenmacdonald · Pull Request #38023 · openedx/openedx-platform

bradenmacdonald · 2026-02-19T01:57:38Z

Description

This is the openedx-platform companion PR to openedx/openedx-core#479 . Please see that PR for more information.

openedx-webhooks · 2026-02-19T01:57:43Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

Details

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.

openedx-webhooks · 2026-02-19T01:57:43Z

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

kdmccormick

(still reviewing)

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py

bradenmacdonald · 2026-03-02T22:38:02Z

openedx/core/djangoapps/content/course_overviews/tests/test_sync_with_openedx_catalog.py

+from openedx_catalog import api as catalog_api
+from openedx_catalog.models_api import CatalogCourse, CourseRun


I'm following our existing convention here, but it seems a tiny bit annoying to import some things from models_api and everything else from api when it's all part of the public API.

yeah I'd be up to revisiting the models_api vs api conversation soon, but for this PR I'd vote keep it like this

…og course

kdmccormick

Nice!

…alog

ormsbee · 2026-03-06T20:06:07Z

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py

+    CourseRun = apps.get_model("openedx_catalog", "CourseRun")
+
+    created_catalog_course_ids: set[int] = set()
+    all_course_runs = CourseIndex.objects.filter(base_store="mongodb", library_version="").order_by("-pk")


Lobotomized Old Mongo courses still exist for the purposes of displaying in the Learner Dashboard, reporting enrollments, etc. That's unlikely to change because there are grades and credentials associated with that user data.

I think we should derive the list of course runs only from CourseOverview.

(I mean, I guess we could do it from the mixed modulestore interface, but I assume you wanted to use the model because it's fast.)

Yeah, I'll change it to just use CourseOverview.

Updated.

Lobotomized Old Mongo courses still exist for the purposes of displaying in the Learner Dashboard, reporting enrollments, etc.

We really need to fix our devstack to include useful default courses including something like this, if we're expected to support it indefinitely.

…urses

ormsbee

Aside from the for-testing-purposes github requirements thing, LGTM. Thank you!

ormsbee · 2026-03-07T20:32:24Z

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py

+NORMALIZE_LANGUAGE_CODES = {
+    "zh-hans": "zh-cn",
+    "zh-hant": "zh-hk",
+    "ca@valencia": "ca-es-valencia",


ormsbee · 2026-03-07T20:53:35Z

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py

+            raise ValueError(
+                f'The organization short code "{org_code}" exists in modulestore ({course_key}) but '
+                "not the Organizations table, and auto-creating organizations is disabled. You can resolve this by "
+                "creating the Organization manually (e.g. from the Django admin) or turning on auto-creation. "
+                "You can set active=False to prevent this Organization from being used other than for historical data. "
+            ) from exc


This is a great error message, thank you.

bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Feb 19, 2026

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 Feb 19, 2026

openedx-webhooks added this to Contributions Feb 19, 2026

github-project-automation bot moved this to Needs Triage in Contributions Feb 19, 2026

bradenmacdonald mentioned this pull request Feb 19, 2026

An openedx_catalog app with a representation for CourseRuns [FC-0117] openedx/openedx-core#479

Merged

6 tasks

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 24, 2026

bradenmacdonald force-pushed the braden/openedx-catalog branch from c17ed68 to 08950bf Compare February 25, 2026 17:14

bradenmacdonald added 7 commits February 25, 2026 09:57

temp: use WIP version of openedx-core

97e1631

feat: Use openedx_catalog app, backfill it with all known courses

73f2ad1

feat: properly set "created" timestamp on course runs during backfill

133d4b0

docs: correct field name of "short_name"

24c5120

fix: better normalization of language codes

1970173

feat: keep courses in sync with CourseRun/CatalogCourse

953637d

test: tests to confirm courses stay in sync with CatalogCourse/CourseRun

c569920

bradenmacdonald force-pushed the braden/openedx-catalog branch from 21f3493 to c569920 Compare February 25, 2026 17:58

bradenmacdonald added 3 commits February 25, 2026 17:59

feat: delete CourseRun/CatalogCourse when deleting a course

84e3acf

test: update import linter

2902fe8

test: fix issue with the tests running on CI

be726d3

bradenmacdonald force-pushed the braden/openedx-catalog branch from 2e97a3f to be726d3 Compare February 27, 2026 00:50

test: remove duplicate test

a54bbaa

bradenmacdonald marked this pull request as ready for review February 27, 2026 01:05

refactor: course_id -> course_key, run -> run_code

8c0e9e0

kdmccormick reviewed Mar 2, 2026

View reviewed changes

.../core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py Outdated Show resolved Hide resolved

kdmccormick self-requested a review March 2, 2026 17:57

bradenmacdonald commented Mar 2, 2026

View reviewed changes

bradenmacdonald added 2 commits March 4, 2026 11:30

chore: merge branch 'master' into braden/openedx-catalog

92d6b20

feat: backfill the newest run's display_name as the name of the catal…

d0e557c

…og course

kdmccormick approved these changes Mar 5, 2026

View reviewed changes

bradenmacdonald force-pushed the braden/openedx-catalog branch from 4cc7ab6 to b1a10b7 Compare March 5, 2026 18:05

chore: update to use 'title' instead of 'display_name' in openedx_cat…

5d2ec4b

…alog

bradenmacdonald force-pushed the braden/openedx-catalog branch from b1a10b7 to 5d2ec4b Compare March 5, 2026 18:10

bradenmacdonald requested a review from ormsbee March 5, 2026 22:25

ormsbee reviewed Mar 6, 2026

View reviewed changes

fix: don't use SplitModulestoreCourseIndex for getting list of all co…

972d09b

…urses

ormsbee approved these changes Mar 7, 2026

View reviewed changes

		from openedx_catalog import api as catalog_api
		from openedx_catalog.models_api import CatalogCourse, CourseRun

Conversation

bradenmacdonald commented Feb 19, 2026

Description

Uh oh!

openedx-webhooks commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented Feb 19, 2026

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bradenmacdonald Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdmccormick Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

ormsbee Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee left a comment

Choose a reason for hiding this comment

Uh oh!

ormsbee Mar 7, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee Mar 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openedx-webhooks commented Feb 19, 2026 •

edited

Loading

bradenmacdonald Mar 2, 2026 •

edited

Loading