refactor: BOMS-200 contract features dict settings into top level settings by Akanshu-2u · Pull Request #179 · edx/devstack

Akanshu-2u · 2025-09-22T12:46:35Z

Description:

This PR approaches the contraction of the FEATURES dict and moving the settings within devstack into top level settings.

Solution:

Contracted FEATURES dict within:
- lms.py
- cms.py
- lms.yml

Related PRs

configuration
sandbox-internal
edx-internal
edge-internal

JIRA Ticket:

BOMS-200

Copilot

Pull Request Overview

Refactors configuration by deprecating the centralized FEATURES dict and promoting individual feature flags to top‑level settings across LMS/CMS Python config files and the LMS YAML config. This flattens feature flag definitions and updates in‑file references accordingly.

Replace FEATURES[...] assignments with top-level constants in lms.py and cms.py
Update conditionals to reference new constants (e.g., enterprise & third-party auth)
Remove FEATURES: namespace from lms.yml, flattening former nested keys

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
py_configuration_files/lms.py	Converts multiple feature flag assignments from FEATURES dict entries to standalone constants and adjusts conditional checks.
py_configuration_files/cms.py	Mirrors refactor for Studio feature flags to standalone constants.
configuration_files/lms.yml	Removes FEATURES: mapping key and promotes its child keys to top-level YAML entries.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-22T12:49:05Z

py_configuration_files/lms.py

 ########################## Third Party Auth #######################

-if FEATURES.get('ENABLE_THIRD_PARTY_AUTH') and (
+if ENABLE_THIRD_PARTY_AUTH and (


Previously this conditional used FEATURES.get('ENABLE_THIRD_PARTY_AUTH'), which safely returned None/False if the flag was absent; switching to a bare variable introduces a potential NameError if ENABLE_THIRD_PARTY_AUTH is not defined earlier. Define ENABLE_THIRD_PARTY_AUTH above (e.g., ENABLE_THIRD_PARTY_AUTH = False) or guard with globals().get('ENABLE_THIRD_PARTY_AUTH') to preserve prior fallback behavior.

Suggested change

if ENABLE_THIRD_PARTY_AUTH and (

if globals().get('ENABLE_THIRD_PARTY_AUTH') and (

Copilot · 2025-09-22T12:49:05Z

configuration_files/lms.yml

-    SHOW_FOOTER_LANGUAGE_SELECTOR: false
-    SHOW_HEADER_LANGUAGE_SELECTOR: false
+AUTH_USE_OPENID_PROVIDER: true
+AUTOMATIC_AUTH_FOR_TESTING: false


Removing the parent FEATURES: key and promoting these entries to top-level is a breaking shape change for any loader logic expecting a FEATURES mapping. Confirm and update any configuration parsing code (or provide a migration path); if compatibility is required, consider keeping an empty FEATURES node or duplicating keys during a transition period.

Suggested change

AUTOMATIC_AUTH_FOR_TESTING: false

AUTOMATIC_AUTH_FOR_TESTING: false

FEATURES:

CUSTOM_COURSES_EDX: false

ENABLE_BULK_ENROLLMENT_VIEW: false

ENABLE_COMBINED_LOGIN_REGISTRATION: true

ENABLE_CORS_HEADERS: false

ENABLE_COUNTRY_ACCESS: false

ENABLE_CREDIT_API: false

ENABLE_CREDIT_ELIGIBILITY: false

ENABLE_CROSS_DOMAIN_CSRF_COOKIE: false

ENABLE_CSMH_EXTENDED: true

ENABLE_DISCUSSION_HOME_PANEL: true

ENABLE_DISCUSSION_SERVICE: true

ENABLE_EDXNOTES: true

ENABLE_ENROLLMENT_RESET: false

ENABLE_EXPORT_GIT: false

Copilot · 2025-09-22T12:49:06Z

py_configuration_files/lms.py

+SHOW_HEADER_LANGUAGE_SELECTOR = True



[nitpick] With the removal of the shared FEATURES container, related feature flags are now standalone constants; consider adding a brief comment block or a consistent prefix (e.g., FEATURE_) to retain logical grouping and make future bulk operations (search, tooling) easier.

Suggested change

SHOW_HEADER_LANGUAGE_SELECTOR = True

# Feature flags (for devstack and development purposes)

FEATURE_SHOW_HEADER_LANGUAGE_SELECTOR = True

Copilot · 2025-09-22T12:49:06Z

py_configuration_files/lms.py

+AUTOMATIC_AUTH_FOR_TESTING = True
+ENABLE_DISCUSSION_SERVICE = True
+SHOW_HEADER_LANGUAGE_SELECTOR = True

-    # Enable enterprise integration by default.
-    # See https://github.com/openedx/edx-enterprise/blob/master/docs/development.rst for
-    # more background on edx-enterprise.
-    # Toggle this off if you don't want anything to do with enterprise in devstack.
-    'ENABLE_ENTERPRISE_INTEGRATION': True,
-})
+# Enable enterprise integration by default.
+# See https://github.com/openedx/edx-enterprise/blob/master/docs/development.rst for
+# more background on edx-enterprise.
+# Toggle this off if you don't want anything to do with enterprise in devstack.
+ENABLE_ENTERPRISE_INTEGRATION = True


[nitpick] With the removal of the shared FEATURES container, related feature flags are now standalone constants; consider adding a brief comment block or a consistent prefix (e.g., FEATURE_) to retain logical grouping and make future bulk operations (search, tooling) easier.

jcapphelix

Is cms.yml file missed in making the changes are we leaving it out on purpose ?

Akanshu-2u · 2025-10-01T15:58:05Z

Is cms.yml file missed in making the changes are we leaving it out on purpose ?

Added cms.yml file, it was missed out. Thank you for the reminder.

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

jcapphelix

Approved,

A CI check is failing though.

Akanshu-2u added 2 commits September 22, 2025 10:52

refactor: contract features dict settings into top level settings

4c171e5

fix: removed inverted commas

d94bc39

Copilot AI review requested due to automatic review settings September 22, 2025 12:46

Copilot AI reviewed Sep 22, 2025

View reviewed changes

Akanshu-2u changed the title ~~refactor: Boms-200 handle features setting dict depr~~ refactor: BOMS-200 contract features dict settings into top level settings Sep 22, 2025

Akanshu-2u mentioned this pull request Sep 22, 2025

refactor: BOMS-200 contract features dict settings into top level settings edx/configuration#258

Merged

jcapphelix requested changes Oct 1, 2025

View reviewed changes

fix: contracted features dict in cms.yml

ed1debd

Merge branch 'master' into BOMS-200-handle-features-setting-dict-depr

c69ec94

Copilot AI review requested due to automatic review settings November 5, 2025 10:21

Copilot AI reviewed Nov 5, 2025

View reviewed changes

ttak-apphelix approved these changes Nov 11, 2025

View reviewed changes

jcapphelix approved these changes Nov 11, 2025

View reviewed changes

Akanshu-2u merged commit 40dfec5 into master Nov 11, 2025
24 of 25 checks passed

Akanshu-2u deleted the BOMS-200-handle-features-setting-dict-depr branch November 11, 2025 09:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: BOMS-200 contract features dict settings into top level settings#179

refactor: BOMS-200 contract features dict settings into top level settings#179
Akanshu-2u merged 4 commits intomasterfrom
BOMS-200-handle-features-setting-dict-depr

Akanshu-2u commented Sep 22, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 22, 2025

Uh oh!

Copilot AI Sep 22, 2025

Uh oh!

Copilot AI Sep 22, 2025

Uh oh!

Copilot AI Sep 22, 2025

Uh oh!

jcapphelix left a comment

Uh oh!

Akanshu-2u commented Oct 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

jcapphelix left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	if ENABLE_THIRD_PARTY_AUTH and (
	if globals().get('ENABLE_THIRD_PARTY_AUTH') and (

-AUTOMATIC_AUTH_FOR_TESTING: false
+AUTOMATIC_AUTH_FOR_TESTING: false
+FEATURES:
+  CUSTOM_COURSES_EDX: false
+  ENABLE_BULK_ENROLLMENT_VIEW: false
+  ENABLE_COMBINED_LOGIN_REGISTRATION: true
+  ENABLE_CORS_HEADERS: false
+  ENABLE_COUNTRY_ACCESS: false
+  ENABLE_CREDIT_API: false
+  ENABLE_CREDIT_ELIGIBILITY: false
+  ENABLE_CROSS_DOMAIN_CSRF_COOKIE: false
+  ENABLE_CSMH_EXTENDED: true
+  ENABLE_DISCUSSION_HOME_PANEL: true
+  ENABLE_DISCUSSION_SERVICE: true
+  ENABLE_EDXNOTES: true
+  ENABLE_ENROLLMENT_RESET: false
+  ENABLE_EXPORT_GIT: false

-SHOW_HEADER_LANGUAGE_SELECTOR = True
+# Feature flags (for devstack and development purposes)
+FEATURE_SHOW_HEADER_LANGUAGE_SELECTOR = True

Conversation

Akanshu-2u commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Solution:

Related PRs

JIRA Ticket:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

jcapphelix left a comment

Choose a reason for hiding this comment

Uh oh!

Akanshu-2u commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

jcapphelix left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Akanshu-2u commented Sep 22, 2025 •

edited

Loading

Akanshu-2u commented Oct 1, 2025 •

edited

Loading