Skip to content

feat: copy content tags and competency criteria on course rerun - #39372

Open
alezconsultant wants to merge 1 commit into
openedx:masterfrom
alezconsultant:alezconsultant/694-rerun-copy-criteria
Open

alezconsultant wants to merge 1 commit into
openedx:masterfrom
alezconsultant:alezconsultant/694-rerun-copy-criteria

Conversation

@alezconsultant

Copy link
Copy Markdown
Contributor

Description

Adds the openedx-platform half of openedx/openedx-core#694: a new run of a course gets its own copy of the source run's content tags and competency criteria.

rerun_course calls the new content_tagging.api.copy_course_tags_and_criteria(source_course_key, destination_course_key) after it sets the initial permissions and before it marks the rerun as succeeded. The author therefore sees the new run only after the copy has finished. If the copy raises, the existing failure handling in rerun_course marks the rerun as failed and deletes the cloned course, so the author can retry with the same run.

Behavior

  • Tags of every taxonomy on the course and its blocks are copied with tag_object, so they are editable on the new run and the source run's tags are unchanged.
  • A taxonomy that is not enabled for the new run's organization is left out, together with the criteria that depend on it, and one warning per taxonomy is logged. The rerun still succeeds.
  • The competency criteria are copied by copy_competency_criteria_for_course_rerun from openedx-core.
  • The catalog CourseRun row for the new run is created if it is missing, because criteria groups reference that row. The course publish handler creates the row when it has run, so this creation covers a rerun in which it has not. The row gets the cloned course's display name, cut to the 255 characters the title column holds, and the course's language when it is one of ALL_LANGUAGES. In a test with the course-published signal enabled the row already existed when the copy ran; a live rerun was not observed.
  • The copy takes no user and consults no permission, so the author needs no permission beyond the one to create the run.
  • The tag copy and the criteria copy share one transaction, so a failure leaves neither behind.

Dependencies

This needs an openedx-core release that contains copy_competency_criteria_for_course_rerun. The requirements bump is added to this PR once that release exists.

Testing

pytest openedx/core/djangoapps/content_tagging/tests/test_api.py -k CopyCourseTagsAndCriteria and pytest cms/djangoapps/contentstore/tests/test_tasks.py -k RerunCourseTaskTestCase.

Manual testing

  1. In Studio, open a course, tag a subsection with a competency from a competency taxonomy, and tag another block with a tag from a regular taxonomy.
  2. On the Competency Management page, add a mastery rule for that competency on the tagged subsection.
  3. From the Studio home page, create a rerun of the course and wait for it to finish.
  4. Open the new run. Its blocks carry the same tags, and the tags can be edited.
  5. On the Competency Management page, the competency shows a second course-level group for the new run with the same rule, and the source run's group is unchanged.
  6. Remove a tag or archive a rule on the new run, and check that the source run still has it.

Known limits

  • If a rerun fails after the copy has been saved (for example while copying videos), deleting the cloned course also deletes its CourseRun row, and the copied criteria groups and criteria are deleted with that row. The copied tags remain, as they do after any course deletion. A retry with the same run creates the CourseRun row and the criteria again and applies the same tags, so it ends with one copy.
  • tag_object sends its tag-changed events inside the transaction, so a copy that rolls back has already sent events for the new run's blocks. The cloned course is deleted in that case.
  • Tags of a free-text taxonomy are not copied. Such a tag is text typed by an author on one block and has no Tag row, and the copy reads tags with get_all_object_tags, which returns only tags that have one. Copy and paste, duplicate, and export already behave the same way.
  • If a source block carries several tags from a taxonomy that now allows one tag per object, the rerun fails and is marked failed, as duplicate and copy and paste do on the same block. The source block's tags have to be corrected before the course can be rerun.

Related to openedx/openedx-core#694

🤖 Generated with Claude Code

rerun_course now calls copy_course_tags_and_criteria() before it marks
the rerun as succeeded. The function copies the source run's content
tags to the new run as editable tags and then copies its competency
criteria, in one transaction. A failure reaches the existing rerun
failure handling, which marks the rerun as failed and deletes the
cloned course.

A taxonomy that is not enabled for the new run's organization is left
out, together with its criteria, and a warning is logged. The catalog
CourseRun row for the new run is created when it is missing, because
criteria groups reference it and the publish handler may not have
created it.

Related to openedx/openedx-core#694

Co-Authored-By: Claude Fable 5.2 <[email protected]>
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 12, 2026
@openedx-webhooks

openedx-webhooks commented Nov 12, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @alezconsultant!

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

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.

@jesperhodge

Copy link
Copy Markdown
Contributor

@coderabbitai full review

@jesperhodge
jesperhodge marked this pull request as ready for review November 16, 2026 15:45
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Nov 16, 2026

@jesperhodge jesperhodge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!
I found a possible issue with a side effect that creates a catalog course run. I don't see any of that in the acceptance criteria. Is it possible that the course and course run vocabulary made the acceptance criteria confusing?
The idea here if I understand it correctly is: when a course author creates a new course run for an existing course - the new course run is simply a copy of an existing course - , then the new course's objects get tagged correctly. This is not about publishing a course run to the catalog.

Copy the source course run's tags, as editable tags, and its competency criteria onto the destination run.

Taxonomies not enabled for the destination org are skipped, along with their criteria.
It also creates the destination run's catalog CourseRun when the source run has one and the destination does not.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would we want to create a catalog CourseRun here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like a quite serious side effect in a function that's only there to add tags during the copy process and not responsible to create or publish courses.

return skipped_taxonomy_ids


def _map_object_id_into_course(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe _map_object_id_from_one_course_to_another?

This branch has not been deployed

No deployments
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: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants