Skip to content

Mark assetmanager + trashcan as deprecated, replace existing usages [FC-0138] - #39261

Merged
kdmccormick merged 5 commits into
openedx:masterfrom
open-craft:braden/deprecate-assetmanager
Nov 14, 2026
Merged

kdmccormick merged 5 commits into
openedx:masterfrom
open-craft:braden/deprecate-assetmanager

Conversation

@bradenmacdonald

@bradenmacdonald bradenmacdonald commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Description

This PR implements the DEPR assetstore and trashcan proposal by marking the assetmanager and trashcan APIs as deprecated, and replacing all non-test usages of those APIs within the platform with contentstore API calls.

Functionality related to import/export of assets.xml is simplified to the minimum possible version (write <assets/> on export, ignore on import) to reflect the fact that this file has been vestigial/unused for years. (Actual asset data is stored in policies/assets.json)

Supporting information

See the DEPR proposal for some info and this contentstore documentation PR for much more detail.

Testing instructions

Check:

  1. That the course "Files" page works unchanged (e.g. upload an asset)
  2. That course import/export roundtrips are working unchanged.
  3. Turn on thumbnails at http://local.openedx.io:8000/admin/course_overviews/courseoverviewimageconfig/ , change a course card image via "Schedule & Details", then go to the Learner Dashboard and make sure the thumbnail image is used.
  4. Use an image in a Text or Problem component, then copy-paste it into a different course. Make sure it's working.
  5. Run ~/Documents/tutor-devstack/.venv/bin/tutor dev exec cms ./manage.py cms empty_asset_trashcan <optional_course_ID>. Press 'Y' and enter to confirm. You should see a deprecation warning, and then it will "empty the trash". (The functionality still works.)

Deadline

No rush.

Other information

Private ref FAL-4430

@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 Oct 19, 2026
@openedx-webhooks

openedx-webhooks commented Oct 19, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Oct 19, 2026
@bradenmacdonald
bradenmacdonald force-pushed the braden/deprecate-assetmanager branch from 0794cbd to 5f3db07 Compare October 19, 2026 22:38
@bradenmacdonald
bradenmacdonald marked this pull request as draft October 19, 2026 22:38
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 22, 2026
@bradenmacdonald
bradenmacdonald marked this pull request as ready for review November 3, 2026 00:25
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 4, 2026
@mphilbrick211 mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Nov 4, 2026
@bradenmacdonald
bradenmacdonald requested review from ChrisChV and kdmccormick and removed request for farhan, irtazaakram and salman2013 November 6, 2026 23:15
@ChrisChV

ChrisChV commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

I think you need to add the DEPRECATED warning to the help messages in empty_asset_trashcan.py and restore_asset_from_trashcan.py

@ChrisChV ChrisChV 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.

Looks good 👍

  • I tested this: I followed the testing instructions
  • I read through the code and considered the security, stability and performance implications of the changes.
  • Includes tests for bugfixes and/or features added.
  • Includes documentation

@bradenmacdonald
bradenmacdonald force-pushed the braden/deprecate-assetmanager branch from 5f3db07 to f3c37d6 Compare November 10, 2026 00:37
@bradenmacdonald

Copy link
Copy Markdown
Contributor Author

I think you need to add the DEPRECATED warning to the help messages in empty_asset_trashcan.py and restore_asset_from_trashcan.py

Sure, done.

bradenmacdonald and others added 5 commits November 13, 2026 13:00
AssetManager.find() has been a plain pass-through to contentstore().find()
for many years.

This commit:
- replaces `AssetManager.find` with `contentstore().find()` everywhere
- marks `AssetManager` as deprecated

Co-Authored-By: Claude Opus 5.5 <[email protected]>
(In practice, every export going back many years contains an empty
assets.xml file that only contains "<assets/>". The only way to put data
into this file was importing a course that already contained such
metadata, and even then it wouldn't affect anything.)

Course export now always writes an empty assets/assets.xml (for backwards
compatibility), and course import ignores that file.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
… API

Nothing uses asset metadata in the modulestore any more: Studio never
populated it, and course import/export no longer read or write it. Mark
AssetMetadata, CourseAssetsFromStorage, and the asset metadata methods of
the modulestore interface and MixedModuleStore as deprecated, so that they
can be removed in a future release.

Also add xmodule.util.deprecation.deprecated, which provides
warnings.deprecated on Python 3.13+ and the typing_extensions backport on
older versions, and simplify the Old Mongo modulestore's
delete_all_asset_metadata() (still used when deleting a course) so that it
doesn't use the deprecated classes.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@bradenmacdonald
bradenmacdonald force-pushed the braden/deprecate-assetmanager branch from f3c37d6 to a217866 Compare November 13, 2026 20:00

@kdmccormick kdmccormick left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔥

@kdmccormick
kdmccormick merged commit 5939206 into openedx:master Nov 14, 2026
42 of 43 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 14, 2026
@bradenmacdonald
bradenmacdonald deleted the braden/deprecate-assetmanager branch November 16, 2026 18:24
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). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants