Skip to content

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

Draft
bradenmacdonald wants to merge 4 commits into
openedx:masterfrom
open-craft:braden/deprecate-assetmanager
Draft

bradenmacdonald wants to merge 4 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 is blocked until/unless DEPR #39260 is accepted.

This PR implements that DEPR 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 that the course "Files" page as well as import/export rountrips are working unchanged.

Deadline

No rush.

Other information

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

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

bradenmacdonald and others added 3 commits October 19, 2026 15:37
(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 <noreply@anthropic.com>
… 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 <noreply@anthropic.com>
@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

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

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

Development

Successfully merging this pull request may close these issues.

3 participants