Skip to content

fix: update modulestore migrator to not publish in draft context#38508

Open
bradenmacdonald wants to merge 1 commit intoopenedx:masterfrom
open-craft:braden/fix-modulestore-migrator
Open

fix: update modulestore migrator to not publish in draft context#38508
bradenmacdonald wants to merge 1 commit intoopenedx:masterfrom
open-craft:braden/fix-modulestore-migrator

Conversation

@bradenmacdonald
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald commented May 1, 2026

Description

This fixes a few issues:

Issue 1: importing a course or legacy library using modulestore_migrator currently creates a single draft changelog, but many separate publish logs - one for each component or container. It should only create a single publish log per import.

Issue 2: modulestore_migrator is doing a weird call to save() the draft change log, which doesn't seem to make any sense, and is expressly forbidden by openedx-core's API conventions.

Issue 3: We have considered changing openedx-core so that it doesn't allow publishing entities within a "bulk draft changes" context, which would help ensure the integrity of both our draft and published change logs / data. However, modulestore_migrator currently publishes things within a bulk draft changes context.

Testing instructions

Needs some careful thought to know if publishing the entities in this different way is going to cause any issues.

Deadline

None

Co-Authored-By: Claude <noreply@anthropic.com>
@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 May 1, 2026
@openedx-webhooks
Copy link
Copy Markdown

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.

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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants