feat: add pluggable override for learner home enterprise customer lookup by pwnage101 · Pull Request #2554 · openedx/edx-enterprise

pwnage101 · 2026-03-05T00:16:46Z

Migrates functionality from openedx-platform to look up a user's enterprise status and populate
enterpriseDashboard in /api/learner_home/init/ endpoint.

feat: replace enterprise imports in learner_home/views.py with pluggable_override edx/edx-platform#383
feat: add pluggable override for learner home enterprise customer lookup #2554
feat: replace enterprise imports in learner_home/views.py with pluggable_override openedx-platform#38107

pwnage101 · 2026-03-05T01:02:18Z

+        dict or None: enterprise customer data dict, or None if the user is not an
+        enterprise customer user.
+    """
+    # Deferred imports — will be replaced with internal paths in epic 17.


Clarify comment that this defensive import is only here temporarily because the plan is ultimately to migrate the entire enterprise_support app into edx-enterprise.

codecov · 2026-07-02T20:55:05Z

Codecov Report

❌ Patch coverage is 77.27273% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.67%. Comparing base (a045f9c) to head (65c1663).

Files with missing lines	Patch %	Lines
enterprise/overrides/learner_home.py	77.27%	4 Missing and 1 partial ⚠️

❌ Your patch check has failed because the patch coverage (77.27%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2554      +/-   ##
==========================================
- Coverage   86.68%   86.67%   -0.02%     
==========================================
  Files         258      259       +1     
  Lines       16995    17017      +22     
  Branches     1680     1682       +2     
==========================================
+ Hits        14732    14749      +17     
- Misses       1927     1931       +4     
- Partials      336      337       +1

Flag	Coverage Δ
unittests	`86.67% <77.27%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ENT-11571

pwnage101 · 2026-07-10T17:05:51Z

+    if enterprise_customer_from_session_or_learner_data is None:
+        return prev_fn(user, request, is_masquerading)


I think we can just have this fail fatally. Eventually this function will get migrated to edx-enterprise anyway.

Suggested change

if enterprise_customer_from_session_or_learner_data is None:

return prev_fn(user, request, is_masquerading)

pwnage101 · 2026-07-10T17:37:15Z

+log = logging.getLogger(__name__)
+
+
+def enterprise_get_enterprise_customer(prev_fn, user, request, is_masquerading):


See edx/edx-platform#383 (comment)

We could do the same on this side:

Suggested change

def enterprise_get_enterprise_customer(prev_fn, user, request, is_masquerading):

class EnterpriseCustomerData(TypedDict):

"""

Required keys for the learner home enterprise dashboard.

Mirrors ``lms.djangoapps.learner_home.views.EnterpriseCustomerData``

"""

name: str

uuid: str

slug: str

auth_org_id: Optional[str]

enable_learner_portal: bool

def enterprise_get_enterprise_customer(

prev_fn,

user: "User",

request: Request,

is_masquerading: bool,

) -> Optional[EnterpriseCustomerData]:

pwnage101 · 2026-07-10T17:51:43Z

+.. note::
+    TODO: Wire this up to OVERRIDE_LEARNER_HOME_GET_ENTERPRISE_CUSTOMER once
+    edx-enterprise is a plugin (ENT-11584), before the plugin becomes optional.
+
+    This override is **not yet wired up** to the
+    ``OVERRIDE_LEARNER_HOME_GET_ENTERPRISE_CUSTOMER`` setting. Registering it requires
+    edx-enterprise to be installable/importable as an openedx plugin, which is not yet
+    the case.


This is oudated. You should wire up the override in settings as part of this PR. See for inspiration:

edx-enterprise/enterprise/settings/common.py

Lines 86 to 88 in a045f9c

settings.OVERRIDE_COURSE_HOME_PROGRESS_USERNAME = (

'enterprise.overrides.course_home_progress.enterprise_obfuscated_username'

)

pwnage101 · 2026-07-10T17:52:57Z

+"""
+import logging
+
+# Will be replaced with an internal path in epic 17.


epic 17 has no meaning outside my local environment. Refer to it as ENT-11576.

Suggested change

# Will be replaced with an internal path in epic 17.

# Will be replaced with an internal path in ENT-11576.

pwnage101 · 2026-07-10T17:58:54Z

+    def _call(self, user=None, request=None, is_masquerading=False):
+        """Import and call the override function."""
+        # pylint: disable=import-outside-toplevel
+        from enterprise.overrides.learner_home import enterprise_get_enterprise_customer
+        prev_fn = MagicMock()
+        return enterprise_get_enterprise_customer(prev_fn, user, request, is_masquerading)


I don't think this needs to be abstracted. Just do this in the tests directly:

enterprise_get_enterprise_customer(MagicMock(), user, request, is_masquerading)

pwnage101 · 2026-07-10T18:05:01Z

+        mock_api = MagicMock()
+        mock_api.enterprise_customer_from_session_or_learner_data.return_value = expected
+        mock_api.get_enterprise_learner_data_from_db.return_value = []
+
+        with patch.dict('sys.modules', {ENTERPRISE_SUPPORT_API_PATH: mock_api}):
+            result = self._call(user=user, request=request, is_masquerading=False)


I think this was just how Claude Sonnet decided to mock an API, but it's extremely weird and indirect.

I'd rather just see us patch the paths directly and do away with ENTERPRISE_SUPPORT_API_PATH:

@patch('enterprise.overrides.learner_home.enterprise_customer_from_session_or_learner_data') @patch('enterprise.overrides.learner_home.get_enterprise_learner_data_from_db') def test_blah( self, mock_get_enterprise_learner_data_from_db, mock_enterprise_customer_from_session_or_learner_data ): ... mock_get_enterprise_learner_data_from_db.return_value = [] mock_enterprise_customer_from_session_or_learner_data.return_value = expected

pwnage101 mentioned this pull request Mar 5, 2026

feat: replace enterprise imports in learner_home/views.py with pluggable_override openedx/openedx-platform#38107

Draft

pwnage101 commented Mar 5, 2026

View reviewed changes

Comment thread enterprise/overrides/learner_home.py Outdated

pwnage101 commented Mar 5, 2026

View reviewed changes

This was referenced Mar 25, 2026

feat: register enterprise and consent as openedx LMS plugins #2575

Merged

feat: remove enterprise and consent from OPTIONAL_APPS openedx/openedx-platform#38209

Merged

pwnage101 and others added 3 commits July 10, 2026 13:51

feat: add pluggable override for learner home enterprise customer lookup

ddba068

ENT-11571

chore: quality fixes

968432a

docs: OVERRIDE_LEARNER_HOME_GET_ENTERPRISE_CUSTOMER TODO

588a5f4

marlonkeating force-pushed the pwnage101/ENT-11571 branch from 335315e to 588a5f4 Compare July 10, 2026 13:51

chore: bump version

aad269e

marlonkeating mentioned this pull request Jul 10, 2026

feat: replace enterprise imports in learner_home/views.py with pluggable_override edx/edx-platform#383

Draft

marlonkeating marked this pull request as ready for review July 10, 2026 14:33

pwnage101 commented Jul 10, 2026

View reviewed changes

docs: Add type contract for get_enterprise_customer

65c1663

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add pluggable override for learner home enterprise customer lookup#2554

feat: add pluggable override for learner home enterprise customer lookup#2554
pwnage101 wants to merge 5 commits into
masterfrom
pwnage101/ENT-11571

pwnage101 commented Mar 5, 2026 •

edited by marlonkeating

Loading

Uh oh!

Uh oh!

pwnage101 Mar 5, 2026

Uh oh!

codecov Bot commented Jul 2, 2026 •

edited

Loading

Uh oh!

pwnage101 Jul 10, 2026

Uh oh!

pwnage101 Jul 10, 2026

Uh oh!

pwnage101 Jul 10, 2026

Uh oh!

pwnage101 Jul 10, 2026

Uh oh!

pwnage101 Jul 10, 2026

Uh oh!

pwnage101 Jul 10, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		if enterprise_customer_from_session_or_learner_data is None:
		return prev_fn(user, request, is_masquerading)

		log = logging.getLogger(__name__)


		def enterprise_get_enterprise_customer(prev_fn, user, request, is_masquerading):

-def enterprise_get_enterprise_customer(prev_fn, user, request, is_masquerading):
+class EnterpriseCustomerData(TypedDict):
+    """
+    Required keys for the learner home enterprise dashboard.
+    Mirrors ``lms.djangoapps.learner_home.views.EnterpriseCustomerData``
+    """
+    name: str
+    uuid: str
+    slug: str
+    auth_org_id: Optional[str]
+    enable_learner_portal: bool
+def enterprise_get_enterprise_customer(
+    prev_fn,
+    user: "User",
+    request: Request,
+    is_masquerading: bool,
+) -> Optional[EnterpriseCustomerData]:

	settings.OVERRIDE_COURSE_HOME_PROGRESS_USERNAME = (
	'enterprise.overrides.course_home_progress.enterprise_obfuscated_username'
	)

	# Will be replaced with an internal path in epic 17.
	# Will be replaced with an internal path in ENT-11576.

Uh oh!

Conversation

pwnage101 commented Mar 5, 2026 • edited by marlonkeating Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pwnage101 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pwnage101 Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

pwnage101 Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

pwnage101 Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

pwnage101 Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

pwnage101 Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

pwnage101 Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pwnage101 commented Mar 5, 2026 •

edited by marlonkeating

Loading

codecov Bot commented Jul 2, 2026 •

edited

Loading

pwnage101 Jul 10, 2026 •

edited

Loading