create openedx envs common settings

[wgu-taylor-payne]

Description

Pull settings explicitly shared by the LMS and CMS into a common settings module at openedx/envs/common.py that lms/envs/common.py and cms/envs/common.py inherit from. For now, only settings explicitly shared settings (via import in cms/envs/common.py) were targeted to move up into the new shared module.

This is one of the initial steps in the effort to simplify Django settings in the edx-platform (see the related ADR: 0022-settings-simplification).

Documented settings in openedx/envs/common.py will be included on the settings reference page.

Supporting information

Resolves #36889.

Testing instructions

diff_settings.py

I've used the diff_settings.sh script as a foundation to create a diff_settings.py script that can be found here (documentation here). I've used this script to test the rendered settings for this branch against the rendered settings in the master branch.

Modification to cms/envs/production.py required

To get all runs of dump_settings to work (specifically running the command with DJANGO_SETTINGS_MODULE=cms.envs.production and CMS_CFG=cms/envs/mock.yml) I needed to make a small patch to cms/envs/production.py in both master and my branch:

-CSRF_TRUSTED_ORIGINS = _YAML_TOKENS.get("CSRF_TRUSTED_ORIGINS", [])
+CSRF_TRUSTED_ORIGINS = _YAML_TOKENS.get('CSRF_TRUSTED_ORIGINS_WITH_SCHEME', [])

Without this, the command would fail and output this error:

As of Django 4.0, the values in the CSRF_TRUSTED_ORIGINS setting must start with a scheme (usually http:// or https://) but found .localhost. See the release notes for details.

Results from running diff_settings.py

Running python diff_settings.py master tpayne/create-openedx-envs-common-settings in a tutor dev environment, I get the following results:

Starting Django settings dump comparison...
Comparing master -> tpayne/create-openedx-envs-common-settings
Output: main_settings_dump/ and feature_settings_dump/

Cleaning existing directory: main_settings_dump
Cleaning existing directory: feature_settings_dump
=== Processing branch: master ===
Processing configurations  [####################################]  100%
Completed processing branch: master

=== Processing branch: tpayne/create-openedx-envs-common-settings ===
Processing configurations  [####################################]  100%
Completed processing branch: tpayne/create-openedx-envs-common-settings

=== Running diff comparison ===
diff main_settings_dump/cms.envs.production__cms_envs_mock.json feature_settings_dump/cms.envs.production__cms_envs_mock.json
4360c4360
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
4889c4889
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff86001fd0>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff7e80bf90>"
5847a5848
>     "USAGE_ID_PATTERN": "(?P<usage_id>(?:i4x://?[^/]+/[^/]+/[^/]+/[^@]+(?:@[^/]+)?)|(?:[^/]+))",
diff main_settings_dump/cms.envs.tutor.development__openedx_config_cms.json feature_settings_dump/cms.envs.tutor.development__openedx_config_cms.json
2084c2084
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
2607c2607
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffa6389fd0>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff828d9fd0>"
3477a3478
>     "USAGE_ID_PATTERN": "(?P<usage_id>(?:i4x://?[^/]+/[^/]+/[^/]+/[^@]+(?:@[^/]+)?)|(?:[^/]+))",
diff main_settings_dump/cms.envs.tutor.production__openedx_config_cms.json feature_settings_dump/cms.envs.tutor.production__openedx_config_cms.json
2048c2048
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
2571c2571
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff7f8f9fd0>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffaa8f9fd0>"
3440a3441
>     "USAGE_ID_PATTERN": "(?P<usage_id>(?:i4x://?[^/]+/[^/]+/[^/]+/[^@]+(?:@[^/]+)?)|(?:[^/]+))",
diff main_settings_dump/lms.envs.production__lms_envs_minimal.json feature_settings_dump/lms.envs.production__lms_envs_minimal.json
2365c2365
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
2863c2863
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffa753af90>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff8c23dc90>"
diff main_settings_dump/lms.envs.production__lms_envs_mock.json feature_settings_dump/lms.envs.production__lms_envs_mock.json
5856c5856
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
6365c6365
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff91eadc50>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffbcef3910>"
diff main_settings_dump/lms.envs.tutor.development__openedx_config_lms.json feature_settings_dump/lms.envs.tutor.development__openedx_config_lms.json
2689c2689
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
3381c3381
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffba7d9e90>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffff9e9cdc50>"
diff main_settings_dump/lms.envs.tutor.production__openedx_config_lms.json feature_settings_dump/lms.envs.tutor.production__openedx_config_lms.json
2414c2414
<             "module": "lms.envs.common",
---
>             "module": "openedx.envs.common",
2914c2914
<                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffb61cafd0>"
---
>                 "stream": "<colorama.ansitowin32.StreamWrapper object at 0xffffa4a3ed50>"

Differences found between branches (shown above)

The "module" lines are describing where the lambda for the JWT_AUTH setting JWT_PAYLOAD_GET_USERNAME_HANDLER is being defined.

Also, I decided to bring USAGE_ID_PATTERN, which historically hasn't been imported in the CMS settings, into openedx/envs/common.py along with USAGE_KEY_PATTERN and ASSET_KEY_PATTERN, which have been imported into the CMS settings. These settings are similar and I thought it would make sense to declare them in the same place.

I also made a modification to HEARTBEAT_CELERY_ROUTING_KEY in cms/envs/common.py where it will contain 'cms' rather than 'lms' in the value, if SERVICE_VARIANT is not set (I don't know if this would be a common scenario or not). To test the difference with this setting I had to modify manage.py to not set SERVICE_VARIANT if unset. I also had to modify diff_settings.py to unset the SERVICE_VARIANT before running the dump_settings management command. With those changes in place these differences appeared:

diff main_settings_dump/cms.envs.production__cms_envs_mock.json feature_settings_dump/cms.envs.production__cms_envs_mock.json
4154c4154
<     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.lms.core.high",
---
>     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.cms.core.high",

diff main_settings_dump/cms.envs.tutor.development__openedx_config_cms.json feature_settings_dump/cms.envs.tutor.development__openedx_config_cms.json
1883c1883
<     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.lms.core.high",
---
>     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.cms.core.high",

diff main_settings_dump/cms.envs.tutor.production__openedx_config_cms.json feature_settings_dump/cms.envs.tutor.production__openedx_config_cms.json
1853c1853
<     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.lms.core.high",
---
>     "HEARTBEAT_CELERY_ROUTING_KEY": "edx.cms.core.high",

[openedx-webhooks]

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.

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:

• 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-taylor-payne]

I have left in 'DIRS': lms.envs.common.MAKO_TEMPLATE_DIRS_BASE, (see here) in cms/envs/common.py:664 because it is using a setting that is explicitly set for the LMS.

[kdmccormick]

Excellent work. I'm busy for the next couple days with conference preparation, so I'll see if any other CCs are available to review. If not, I'll review as soon as I'm able to.

[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 successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[kdmccormick]

Thank for you for the comprehensive testing report, new documentation, and explanatory comments. Just a few small changes, then this is good to go.

[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-taylor-payne looks like there are some conflicts that need to be resolved but then it looks like this can be merged.

The sandbox failures seem un-related so hopefully we can get one running after the conflicts have been resolved.

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

The issues that Kyle brought up have been resolved.

[kdmccormick]

Looks great! I smoke-tested on the PR sandbox, ensuring I could create a library, use its content in a course, publish that course, and enroll in that course.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.