feat: copy/paste containers #37008

rpenido · 2025-07-11T14:39:01Z

Description

This PR adds support for copying (any container) and pasting (for now, only units) on a course.

Which edX user roles will this change impact? "Developer"

Supporting information

Part of Backend API to link section/subsection to course frontend-app-authoring#2225

Testing instructions

To copy a container, you need to make a POST call to http://studio.local.openedx.io:8001/api/libraries/v2/containers/{key}/copy/. You could use a Unit with an HTML component containing some images to test the static file copy.
Tip: To get it right from your browser, you can rename a container and edit the PATCH URL, changing the method to POST and appending copy/ to the end of the URL.
Open the content staging admin and check the generated OLX (http://studio.local.openedx.io:8001/admin/content_staging/stagedcontent/)
Currently, the paste UI is only supported for Units. Try to paste a copied unit into a section using the current UI
The paste feature sections/subsections works, but you need to edit the paste call to change the parent manually.

Deadline

None

Private ref: FAL-4221

openedx-webhooks · 2025-07-11T14:39:07Z

Thanks for the pull request, @rpenido!

This repository is currently maintained by @openedx/wg-maintenance-edx-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/core/djangoapps/content_staging/models.py

navinkarkera

@rpenido Nice work! It mostly works with some issues like

I had to remove these two lines to make copy work with units containing html blocks.
And we need to handle static content while copying.

openedx/core/djangoapps/content_staging/api.py

navinkarkera · 2025-07-22T10:02:47Z

openedx/core/djangoapps/content_staging/views.py

+                from openedx.core.djangoapps.content_libraries import api as lib_api
+


Any reason for moving this here.

https://github.com/openedx/edx-platform/blob/47d253a1fee52b76b7dd583e63c0bc8074fb8a7e/openedx/core/djangoapps/content_staging/views.py#L85-L90

We should stop importing the content_libraries here in the future, but we probably need to import the other way around. I moved it here to avoid circular imports.

openedx/core/lib/xblock_serializer/block_serializer.py

bradenmacdonald

Great work! I think this is almost ready.

cms/djangoapps/contentstore/helpers.py

openedx/core/lib/xblock_serializer/test_api.py

Co-authored-by: Braden MacDonald <mail@bradenm.com>

…ublic

rpenido · 2025-08-08T19:48:51Z

Hi @bradenmacdonald @kdmccormick!

https://github.com/openedx/edx-platform/blob/7c2acdca8416a77b704cdb01da3144a2e1e282fe/openedx/core/djangoapps/content_libraries/tests/test_runtime.py#L110-L113

Adding the source_version to the OLX is breaking #2, as we are publishing a new version, even if the content doesn't change.
Do you think this is a problem?

bradenmacdonald · 2025-08-08T23:55:55Z

@rpenido If you set write_source_key=False, then that test should continue to pass unchanged, right? I think we should just do that.

kdmccormick · 2025-08-11T16:23:33Z

openedx/core/djangoapps/content_libraries/api/serializers.py

+        olx.attrib["source_key"] = str(container_key)
+        olx.attrib["source_version"] = str(container_metadata.draft_version_num)


Sorry for the drive-by comment, but is there a reason not to use the established attributes copied_from_block{_version} and/or upstream{_version} which we use for components that are copy-pasted or linked?

Oh wait, source_key is for the container itself, not for the container it was copied from, right? Sorry, I'm out of the loop, if there's a thread or something where source_key was discussed I'm happy to read through that and catch myself up.

Sorry for the drive-by comment, but is there a reason not to use the established attributes copied_from_block{_version}

It could use copied_from_block (instead of souce_key). While working on this, I don't remember finding a copy_from_block in the OLX, but it makes sense since we are using it on the (pasted) XBlock. I was trying to avoid referencing as blocks since these are Containers from libraries.

and/or upstream{_version}, which we use for components that are copy-pasted or linked?
Oh wait, source_key is for the container itself, not for the container it was copied from, right?

Exactly. This serializer is used when copying items from the library, so we probably won't have the upstream field here. But, if we expand the current code that copies from courses to use it, we will probably have both upstream (meaning that the source item is linked to an upstream library item) and souce_key, referencing the items that is being copied.

Sorry, I'm out of the loop, if there's a thread or something where source_key was discussed

I don't think we have had a thorough discussion beyond what we've included in this PR. Please let me know if you have any concerns!

It could use copied_from_block (instead of souce_key). While working on this, I don't remember finding a copy_from_block in the OLX, but it makes sense since we are using it on the (pasted) XBlock. I was trying to avoid referencing as blocks since these are Containers from libraries.

Ah, I see. Currently, copied_from_block is mixed into CMS xblocks, and it is set when pasting an xblock. I agree that it'd be ideal if the field didn't include the word "block" (I wish it were just copied_from) but IMO consistency beats semantic correctness here. So, personally I'd prefer copied_from_block over source_key, but let me know if you disagree.

Exactly. This serializer is used when copying items from the library, so we probably won't have the upstream field here. But, if we expand the current code that copies from courses to use it, we will probably have both upstream (meaning that the source item is linked to an upstream library item) and souce_key, referencing the items that is being copied.

Yes, I think that matches the current behavior, which is:

upstream is set iff it's linked to the library

copied_from_block is set iff it was pasted without link OR linked and then unlinked.

I don't think we need to set both upstream and copied_from_block at the same time.

rpenido · 2025-08-13T18:48:16Z

Hi @bradenmacdonald! Do you think we are ready to merge now?

bradenmacdonald

Yep, I think this looks good. Thanks!

bradenmacdonald · 2025-08-13T22:08:06Z

cms/djangoapps/contentstore/helpers.py

+    if node_copied_from:
+        _fetch_and_set_upstream_link(node_copied_from, node_copied_version, temp_xblock, user)
+    elif copied_from_block:
+        # Use the copied_from_block param only if the copied_from_block from the OLX is not set.


Should we explain this slightly more? This says what we're doing but not why.

Removed this fallback elif here 4f3e0bc

edx-pipeline-bot · 2025-08-14T16:21:43Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-08-14T16:42:19Z

2U Release Notice: This PR has been deployed to the edX production environment.

…penedx#37008) * feat: copy endpoint for Library Containers * fix: make source_usage_key optional and removing upstram info for xblock olx * test: add tests * refactor: remove unecessary changes to reduce diff * fix: change assert * feat: add `write_upstream` field to ContainerSerializer * fix: remove comment * refactor: change `source_usage_key` type and more * fix: try to infer the source version * fix: InvalidKeyError while copying container with assets * fix: read source_version from OLX * fix: remove store check * fix: change ident Co-authored-by: Braden MacDonald <mail@bradenm.com> * feat: fill source_version and make get_component_version_from_block public * refactor: rename `source_key` to `copied_from_block` * test: add test to `write_copied_from=false` * fix: removing unused fallback elif * fix: remove `copied_from_block` param --------- Co-authored-by: Braden MacDonald <mail@bradenm.com>

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 11, 2025

openedx-webhooks added this to Contributions Jul 11, 2025

github-project-automation bot moved this to Needs Triage in Contributions Jul 11, 2025

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch 5 times, most recently from ae3c3dd to 8da2d48 Compare July 11, 2025 16:07

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jul 15, 2025

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch 16 times, most recently from 6fdce69 to e61a47e Compare July 21, 2025 20:42

rpenido commented Jul 21, 2025

View reviewed changes

openedx/core/djangoapps/content_staging/models.py Outdated Show resolved Hide resolved

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from e61a47e to 4ee9ce7 Compare July 21, 2025 21:20

navinkarkera reviewed Jul 22, 2025

View reviewed changes

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from 4e705eb to 50de6b0 Compare July 24, 2025 19:28

bradenmacdonald reviewed Aug 7, 2025

View reviewed changes

cms/djangoapps/contentstore/helpers.py Outdated Show resolved Hide resolved

cms/djangoapps/contentstore/helpers.py Outdated Show resolved Hide resolved

openedx/core/lib/xblock_serializer/test_api.py Outdated Show resolved Hide resolved

rpenido and others added 2 commits August 8, 2025 14:59

fix: remove store check

8b3660e

fix: change ident

2cdafb2

Co-authored-by: Braden MacDonald <mail@bradenm.com>

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from 07ec126 to 78fca3b Compare August 8, 2025 18:34

feat: fill source_version and make get_component_version_from_block p…

9b4efbd

…ublic

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from 78fca3b to 9b4efbd Compare August 8, 2025 19:40

kdmccormick reviewed Aug 11, 2025

View reviewed changes

Merge branch 'master' into rpenido/fal-4221/copy-paste-containers

fe653c8

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch 3 times, most recently from 9eabb47 to 9a267ec Compare August 12, 2025 19:16

refactor: rename source_key to copied_from_block

2a6a1f1

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from 9a267ec to 0754d08 Compare August 12, 2025 19:25

test: add test to write_copied_from=false

6f1fecc

rpenido force-pushed the rpenido/fal-4221/copy-paste-containers branch from 0754d08 to 6f1fecc Compare August 12, 2025 19:43

Merge branch 'master' into rpenido/fal-4221/copy-paste-containers

30d5248

bradenmacdonald approved these changes Aug 13, 2025

View reviewed changes

rpenido added 3 commits August 13, 2025 19:33

fix: removing unused fallback elif

4f3e0bc

Merge branch 'master' into rpenido/fal-4221/copy-paste-containers

70980c8

fix: remove copied_from_block param

4e21349

bradenmacdonald merged commit 1a9f6e1 into openedx:master Aug 14, 2025
49 checks passed

bradenmacdonald deleted the rpenido/fal-4221/copy-paste-containers branch August 14, 2025 15:06

github-project-automation bot moved this from Waiting on Author to Done in Contributions Aug 14, 2025

ormsbee mentioned this pull request Nov 7, 2025

fix: bump learning-core to 0.30.0 #37614

Merged

		from openedx.core.djangoapps.content_libraries import api as lib_api

		olx.attrib["source_key"] = str(container_key)
		olx.attrib["source_version"] = str(container_metadata.draft_version_num)

feat: copy/paste containers #37008

feat: copy/paste containers #37008

Uh oh!

Conversation

rpenido commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Uh oh!

openedx-webhooks commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

navinkarkera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rpenido commented Aug 8, 2025

Uh oh!

bradenmacdonald commented Aug 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpenido commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

edx-pipeline-bot commented Aug 14, 2025

Uh oh!

edx-pipeline-bot commented Aug 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

rpenido commented Jul 11, 2025 •

edited

Loading

openedx-webhooks commented Jul 11, 2025 •

edited

Loading

rpenido commented Aug 13, 2025 •

edited

Loading