Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #24634 from edx/jlajoie/enterprise-header-caching-fix

Browse Source 
Fixes session caching for enterprise portal links by only caching for auth'd learners
This commit is contained in:
Jeff LaJoie
2020-07-30 10:33:40 -04:00
committed by GitHub
parent 047414d776 4282530faf
commit a2d2646ee5
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
openedx/features/enterprise_support/tests/test_utils.py
View File

@@ -8,10 +8,10 @@ import ddt
from django.test import TestCase from django.test import TestCase
from django.test.utils import override_settings from django.test.utils import override_settings
from django.urls import reverse
from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.core.djangolib.testing.utils import skip_unless_lms
from openedx.features.enterprise_support.utils import get_enterprise_learner_portals from openedx.core.djangoapps.waffle_utils.testutils import override_waffle_flag
from openedx.features.enterprise_support.utils import ENTERPRISE_HEADER_LINKS, get_enterprise_learner_portals
from openedx.features.enterprise_support.tests import FEATURES_WITH_ENTERPRISE_ENABLED from openedx.features.enterprise_support.tests import FEATURES_WITH_ENTERPRISE_ENABLED
from openedx.features.enterprise_support.tests.factories import ( from openedx.features.enterprise_support.tests.factories import (
EnterpriseCustomerBrandingConfigurationFactory, EnterpriseCustomerUserFactory, EnterpriseCustomerBrandingConfigurationFactory, EnterpriseCustomerUserFactory,
@@ -48,6 +48,7 @@ class TestEnterpriseUtils(TestCase):
self.client.get(resource) self.client.get(resource)
self.assertEqual(mock_customer_request.call_count, expected_calls) self.assertEqual(mock_customer_request.call_count, expected_calls)
@override_waffle_flag(ENTERPRISE_HEADER_LINKS, True)
def test_get_enterprise_learner_portals_uncached(self): def test_get_enterprise_learner_portals_uncached(self):
""" """
Test that only enabled enterprise portals are returned Test that only enabled enterprise portals are returned
@@ -68,6 +69,7 @@ class TestEnterpriseUtils(TestCase):
'logo': enterprise_customer_user.enterprise_customer.branding_configuration.logo.url, 'logo': enterprise_customer_user.enterprise_customer.branding_configuration.logo.url,
}) })
@override_waffle_flag(ENTERPRISE_HEADER_LINKS, True)
def test_get_enterprise_learner_portals_cached(self): def test_get_enterprise_learner_portals_cached(self):
enterprise_customer_data = { enterprise_customer_data = {
'name': 'Enabled Customer', 'name': 'Enabled Customer',

12
openedx/features/enterprise_support/utils.py
View File

@@ -18,8 +18,11 @@ from lms.djangoapps.branding.api import get_privacy_url
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from openedx.core.djangoapps.user_authn.cookies import standard_cookie_settings from openedx.core.djangoapps.user_authn.cookies import standard_cookie_settings
from openedx.core.djangolib.markup import HTML, Text from openedx.core.djangolib.markup import HTML, Text
from openedx.core.djangoapps.waffle_utils import WaffleFlag
from student.helpers import get_next_url_for_login_page from student.helpers import get_next_url_for_login_page
ENTERPRISE_HEADER_LINKS = WaffleFlag('enterprise', 'enterprise_header_links')
def get_data_consent_share_cache_key(user_id, course_id): def get_data_consent_share_cache_key(user_id, course_id):
""" """
@@ -300,18 +303,19 @@ def get_enterprise_learner_portals(request):
# Prevent a circular import. # Prevent a circular import.
from openedx.features.enterprise_support.api import enterprise_enabled from openedx.features.enterprise_support.api import enterprise_enabled
if enterprise_enabled(): user = request.user
# Only cache this if a learner is authenticated (AnonymousUser exists and should not be tracked)
if enterprise_enabled() and ENTERPRISE_HEADER_LINKS.is_enabled() and user and user.id:
# If the key exists return that value # If the key exists return that value
if 'enterprise_learner_portals' in request.session: if 'enterprise_learner_portals' in request.session:
return json.loads(request.session['enterprise_learner_portals']) return json.loads(request.session['enterprise_learner_portals'])
user = request.user
# Ordering is important, this is consistent with how we decide on which # Ordering is important, this is consistent with how we decide on which
# enterprise_customer is the selected one for an enterprise_customer # enterprise_customer is the selected one for an enterprise_customer
enterprise_learner_portals = [{ enterprise_learner_portals = [{
'name': enterprise_customer_user.enterprise_customer.name, 'name': enterprise_customer_user.enterprise_customer.name,
'slug': enterprise_customer_user.enterprise_customer.slug, 'slug': enterprise_customer_user.enterprise_customer.slug,
'logo': enterprise_customer_user.enterprise_customer.branding_configuration.logo.url, 'logo': enterprise_customer_user.enterprise_customer.branding_configuration.logo.url if
enterprise_customer_user.enterprise_customer.branding_configuration else None,
} for enterprise_customer_user in EnterpriseCustomerUser.objects.filter( } for enterprise_customer_user in EnterpriseCustomerUser.objects.filter(
user_id=user.id, enterprise_customer__enable_learner_portal=True user_id=user.id, enterprise_customer__enable_learner_portal=True
).prefetch_related( ).prefetch_related(