feat: add library restore endpoint #37439

wgu-taylor-payne · 2025-10-07T15:38:33Z

Description

Adds a library restore endpoint to restore a learning package from a backup. The learning package can then be used to create a content library.

POST /api/libraries/v2/restore/

Requires a file field, which must be a .zip file.

A library restore task will be queued for execution, and a task id will be returned in the JSON response.

{
    "task_id": "29cd29cb-a963-427b-8aaa-675c999832a1"
}

GET /api/libraries/v2/restore/

Requires a task_id parameter to be provided. If given a valid task_id it will return the task status and data based on the result of the restore.

Success:

{
    "state": "Succeeded",
    "result": {
        "learning_package_id": 6,
        "title": "Library test",
        "org": "WGU",
        "slug": "LIB_C001",
        "key": "lib-restore:tpayne:WGU:LIB_C001:6",
        "original_key": "lib:WGU:LIB_C001",
        "created": "2025-10-07T00:29:38.692050+00:00",
        "components": 6
    }
}

Failure:

{
    "state": "Failed",
    "result": {
        "error": "Error restoring learning package",
        "log_file": "/media/user_tasks/2025/10/06/00d8363d-5e24-48db-bfd5-24e66acde361-error.log"
    }
}

Supporting information

Resolves openedx/openedx-learning#388.

Depends on functionality in openedx/openedx-learning#406.

Testing instructions

TODO

Deadline

Ulmo release

openedx-webhooks · 2025-10-07T15:38:39Z

Thanks for the pull request, @wgu-taylor-payne!

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.

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

openedx/core/djangoapps/content_libraries/tasks.py

openedx/core/djangoapps/content_libraries/rest_api/libraries.py

dwong2708 · 2025-10-07T20:25:50Z

openedx/core/djangoapps/content_libraries/tasks.py

+        TASK_LOGGER.info('Restoring learning package from temporary file %s', tmp_path)
+
+        try:
+            result = authoring_api.load_dump_zip_file(tmp_path)


@ormsbee In the scenario where LibraryPackage.key already exists, should we assign a unique temporary key to stage this library package? Currently, the staged_key is built later using the LP.id

In my comment about this, I suggested making the LearningPackage.key be a combination of the learning key of the archive, the username of the person uploading, and a primary key (though really, anything that's unique will work--like a simple random hash value). So it would look like: lib-restore:dave:Axim:problem-bank:1002

(Okay, thinking on that more, I guess we'd want to construct the key in this bit of code and pass it to load_dump_zip_file as an argument, so that would favor having a random hash instead of a pkey at the end.

The goals of the key would be:

easily look up the user's uploads

reconstruct the original key of the archive without having to open the archive up

namespace it so that the key entries never collide

Passing the staged LP sounds good to me, but @wgu-taylor-payne suggested passing only the User object, since the organization name (e.g., Axim in the example above) is already included in the zip file, and extracting it at the endpoint level wouldn’t make sense.

Recap: We talked about this at our sync-up today, where @dwong2708 brought me up to speed on what he and @wgu-taylor-payne were discussing.

I think the idea of having Learning Core decide what the temporary key is makes sense, and it also makes sense that we'd have to pass in the user object, since that is how Learning Core would namespace things. Overall, this gives LC the flexibility to determine how it wants to manage this specific kind of staged LearningPackage for a given user. In terms of the last part of the key--anything uniquely identifying will do. We could use a timestamp with sufficient precision, for instance.

In all cases, we shouldn't rely on parsing the key when displaying information to the frontend. The frontend should still get all its information from specific fields in the JSON artifact that is produced during the upload process.

Currently in this PR, along with creating and updating the restored LP with the "staged" key, the code also validates the key format, extracts the username from the key to see if the user is authorized to create a library from the LP, and then changes the key back to the standard version after the LP is tied to a content library.

It would be nice to have Learning Core provide an interface for this functionality as well.

Sounds good to me, Just to clarify, @ormsbee , we don’t need to check that the uploaded user matches the backup user, right?

Right. Anyone could upload an archive created by anyone else.

In a nutshell:

The staged key generation happens on the LC side (PR
, pending review). Based on that, I believe the logic here can be simplified:

In this line, we pass the user and True value to generate the staged key:
authoring_api.load_dump_zip_file(tmp_path, user=user, use_staged_lp_key=True)

The user task returns the Learning Package (LP) ID.

When creating the Content Library, the frontend will send the LP ID, and the endpoint will update the key based on the slug and org provided by the frontend. At this point, the ContentLibrary model has already been created, and you can use its library_key property to pass it to the update_library_package API.

dwong2708

Nice job, Tylor, and thank you for addressing this. I left some comments, but please note that they depend on the merge of this PR
.

dwong2708 · 2025-10-11T00:32:14Z

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

    slug = serializers.CharField(source="key.slug", validators=(validate_unicode_slug, ))
    title = serializers.CharField()
    description = serializers.CharField(allow_blank=True)
+    learning_package_key = serializers.CharField(required=False)


Since the new learning package key will be generated by the ContentLibrary model, I think passing the learning_package_key is unnecessary.

dwong2708 · 2025-10-11T00:34:21Z

openedx/core/djangoapps/content_libraries/tasks.py

+    # staged key format: lib-restore:user:org:slug:id, where user is the username of the user
+    # performing the restore, and id is the id of the learning package
+    user = User.objects.get(id=user_id)
+    staged_key = f"{namespace}-restore:{user.username}:{org}:{slug}:{learning_package.id}"


No longer needed once this PR is merged.

dwong2708 · 2025-10-11T00:36:50Z

openedx/core/djangoapps/content_libraries/rest_api/libraries.py

+        learning_package = None
+        if learning_package_key := data.pop("learning_package_key", None):
+            username = learning_package_key.split(':')[1]
+            if request.user.username != username:


Not necessary — please remove it

dwong2708 · 2025-10-11T00:39:31Z

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

+                namespace = namespace.split('-')[0]  # Remove "-restore" suffix
+                authoring_api.update_learning_package(
+                    learning_package.id,
+                    key=f'{namespace}:{lp_org}:{lp_slug}',


You could use ref.library_key and pass it here, since the new LP key is generated from the org and slug provided by the new ContentLibrary.

dwong2708 · 2025-10-11T00:40:41Z

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


+            if provided_learning_package:
+                # Convert "staged" key to normal key
+                namespace, _, lp_org, lp_slug, _ = learning_package.key.split(':')


Won’t be necessary once this PR
is merged.

feat: add library restore endpoint

b884064

wgu-taylor-payne requested review from dwong2708, ormsbee and rodmgwgu October 7, 2025 15:38

wgu-taylor-payne self-assigned this Oct 7, 2025

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 Oct 7, 2025

openedx-webhooks added this to Contributions Oct 7, 2025

github-project-automation bot moved this to Needs Triage in Contributions Oct 7, 2025

wgu-taylor-payne marked this pull request as draft October 7, 2025 15:38

rodmgwgu reviewed Oct 7, 2025

View reviewed changes

openedx/core/djangoapps/content_libraries/tasks.py Show resolved Hide resolved

rodmgwgu reviewed Oct 7, 2025

View reviewed changes

openedx/core/djangoapps/content_libraries/rest_api/libraries.py Show resolved Hide resolved

rodmgwgu reviewed Oct 7, 2025

View reviewed changes

openedx/core/djangoapps/content_libraries/rest_api/libraries.py Outdated Show resolved Hide resolved

dwong2708 suggested changes Oct 7, 2025

View reviewed changes

fixup! feat: add library restore endpoint

ef9e400

mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Oct 8, 2025

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Oct 8, 2025

feat: add ability to create library from restored learning package

27c450c

dwong2708 mentioned this pull request Oct 11, 2025

Backup and Restore Final Adjustments openedx/openedx-learning#406

Open

dwong2708 suggested changes Oct 11, 2025

View reviewed changes

feat: add library restore endpoint #37439

Are you sure you want to change the base?

feat: add library restore endpoint #37439

Conversation

wgu-taylor-payne commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

POST /api/libraries/v2/restore/

GET /api/libraries/v2/restore/

Supporting information

Testing instructions

Deadline

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

ormsbee Oct 9, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

dwong2708 Oct 10, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dwong2708 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!

Choose a reason for hiding this comment

Uh oh!

dwong2708 Oct 11, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

wgu-taylor-payne commented Oct 7, 2025 •

edited

Loading

openedx-webhooks commented Oct 7, 2025 •

edited

Loading

ormsbee Oct 9, 2025 •

edited

Loading

dwong2708 Oct 10, 2025 •

edited

Loading

dwong2708 Oct 11, 2025 •

edited

Loading