Repository navigation
Mark assetmanager + trashcan as deprecated, replace existing usages [FC-0138] - #39261
Conversation
|
Thanks for the pull request, @bradenmacdonald! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
0794cbd to
5f3db07
Compare
|
I think you need to add the |
ChrisChV
left a comment
There was a problem hiding this comment.
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
5f3db07 to
f3c37d6
Compare
Sure, done. |
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]>
f3c37d6 to
a217866
Compare
Description
This PR implements the DEPR
assetstoreandtrashcanproposal by marking theassetmanagerandtrashcanAPIs as deprecated, and replacing all non-test usages of those APIs within the platform withcontentstoreAPI calls.Functionality related to import/export of
assets.xmlis 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 inpolicies/assets.json)Supporting information
See the DEPR proposal for some info and this contentstore documentation PR for much more detail.
Testing instructions
Check:
~/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