chore: remove deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE…

[wgu-ram-chandra]

Description

This PR refactors the code to replace the deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings with the more flexible and recommended STORAGES = {} pattern.

Key changes:

• Replaced DEFAULT_FILE_STORAGE with the new STORAGES['default'] setting.
• Replaced STATICFILES_STORAGE with the new STORAGES['staticfiles'] setting.
• Updated all relevant configurations and documentation to reflect these changes.

Settings Flow Diagram

To better illustrate how the settings flow between files and the changes made, I've created a diagram outlining the relationship between the key settings. Below is a visual representation of the flow:

Tests Performed

1. pytest: Ran tests across multiple modules, including lms, cms, openedx, common, and xmodule. No errors related to settings were encountered.

2. File Upload/Download:

   • Uploaded and downloaded course structures and various small files.
   • Verified that file persistence and integrity are maintained without issues.

3. Manage.py Commands:

   • Executed common Django management commands such as:

     • python3 manage.py lms runserver
     • python3 manage.py lms migrate
     • python3 manage.py lms print_setting STORAGES
     • python3 manage.py lms dump_settings

   • No issues or unexpected behavior were observed during command execution.

• Fixes: DEFAULT_FILE_STORAGE setting is deprecated #36744

Note:

Filed an issue in tutor-contrib-s3 to track updating the plugin for Django 4.2+ compatibility with the new STORAGES setting: link to issue

This PR does not block on that, but it’s good to have this documented for future reference.

[openedx-webhooks]

Thanks for the pull request, @wgu-ram-chandra!

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.

---

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[wgu-ram-chandra]

Since we are not expecting "STATICFILES_STORAGE" setting from the environment, this line can be removed. But little guidance on how to approach this greatly helps. Thanks!

[wgu-ram-chandra]

@holaontiveros, thanks for pointing that out! I realized that I mistakenly applied autopep8 to the .yml files as well, which caused the formatting issue. I'll fix it!

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[wgu-ram-chandra]

The patch that might be involved: https://github.com/hastexo/tutor-contrib-s3/blob/main/tutors3/patches/openedx-common-settings

I'm still seeing the same issue on the sandbox, I'll share an update once it's resolved!

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[feanil]

@wgu-ram-chandra what's the impact on downstream production systems, if someone has DEFAULT_FILE_STORAGE or STATICFILES_STORAGE settings defined in their YAML config, I believe those will now get ignored? Is that right?

[wgu-ram-chandra]

Hi @feanil, sorry for the delay getting back, I was tied up with other tasks.

To clarify your question, if someone has DEFAULT_FILE_STORAGE defined in their YAML config, it will still be honored in the LMS and CMS openstack.py and production.py environments. This is because those settings use a pattern like:

AUTH_TOKENS.get("DEFAULT_FILE_STORAGE")

Which is then used to populate:

STORAGES["default"]["BACKEND"]

So the config flow looks like:

YAML config → AUTH_TOKENS["DEFAULT_FILE_STORAGE"] → STORAGES["default"]["BACKEND"]

Therefore, those values will not be ignored, they’re still explicitly read and mapped to the new STORAGES setting, so backward compatibility is maintained in these cases.

However, outside of this pattern, will now be ignored

Do you think we should shift even the openstack.py / production.py usage to expect STORAGES["default"]["BACKEND"] directly from the YAML, rather than routing it through AUTH_TOKENS["DEFAULT_FILE_STORAGE"]?

Looking forward to your thoughts!

[feanil]

Thanks Ram, no I think that's great, not breaking existing config but updating the internal structure to be what Django 5.2 needs makes sense to me.

[wgu-ram-chandra]

Awesome! I’ll update the PR shortly.

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[awais786]

@wgu-ram-chandra https://github.com/WGU-Open-edX/edx-platform/blob/31a5ca4d8a8854a927355d5890321954521c7a8d/common/djangoapps/util/storage.py#L73 you need to change this also.

All occurances.

https://github.com/search?q=repo%3AWGU-Open-edX%2Fedx-platform%20settings.DEFAULT_FILE_STORAGE&type=code

[wgu-ram-chandra]

@awais786 sure thing, I’m already working on that. Thank you for pointing it out.

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements