fix: log warning when INSTRUCTOR_MICROFRONTEND_URL is unset (#37999)

Author: brianjbuck-wgu

lms/djangoapps/instructor/tests/test_api_v2.py

@@ -425,6 +425,25 @@ def test_course_errors_from_modulestore(self, mock_modulestore):
         self.assertIn('course_errors', response.data)
         self.assertIsInstance(response.data['course_errors'], list)
 
+    @patch('lms.djangoapps.instructor.views.serializers_v2.settings.INSTRUCTOR_MICROFRONTEND_URL', None)
+    def test_tabs_log_warning_when_mfe_url_not_set(self):
+        """
+        Test that a warning is logged when INSTRUCTOR_MICROFRONTEND_URL is not set.
+        """
+        with self.assertLogs('lms.djangoapps.instructor.views.serializers_v2', level='WARNING') as cm:
+            tabs = self._get_tabs_from_response(self.staff)
+
+        self.assertTrue(
+            any('INSTRUCTOR_MICROFRONTEND_URL is not set' in msg for msg in cm.output)
+        )
+        # Tab URLs should use empty string as base, not "None"
+        for tab in tabs:
+            self.assertFalse(tab['url'].startswith('None'), f"Tab URL should not start with 'None': {tab['url']}")
+            self.assertTrue(
+                tab['url'].startswith('/instructor/'),
+                f"Tab URL should start with '/instructor/': {tab['url']}"
+            )
+
     def test_pacing_self_for_self_paced_course(self):
         """
         Test that pacing is 'self' for self-paced courses.

lms/djangoapps/instructor/views/serializers_v2.py

@@ -5,6 +5,8 @@
 Following REST best practices, serializers encapsulate most of the data processing logic.
 """
 
+import logging
+
 from django.conf import settings
 from django.db.models import Count
 from django.utils.html import escape
@@ -33,6 +35,8 @@
 
 from .tools import get_student_from_identifier, parse_datetime, DashboardError
 
+log = logging.getLogger(__name__)
+
 
 class CourseInformationSerializerV2(serializers.Serializer):
     """
@@ -75,6 +79,10 @@ def get_tabs(self, data):
         course_key = course.id
         mfe_base_url = settings.INSTRUCTOR_MICROFRONTEND_URL
 
+        if not mfe_base_url:
+            log.warning('INSTRUCTOR_MICROFRONTEND_URL is not set.')
+            mfe_base_url = ''
+
         access = {
             'admin': request.user.is_staff,
             'instructor': bool(has_access(request.user, 'instructor', course)),

lms/envs/devstack.py

@@ -398,6 +398,7 @@ def should_show_debug_toolbar(request):  # lint-amnesty, pylint: disable=missing
 AUTHN_MICROFRONTEND_URL = 'http://localhost:1999'
 AUTHN_MICROFRONTEND_DOMAIN = 'localhost:1999'
 EXAMS_DASHBOARD_MICROFRONTEND_URL = 'http://localhost:2020'
+INSTRUCTOR_MICROFRONTEND_URL = 'http://localhost:2003'
 CATALOG_MICROFRONTEND_URL = 'http://localhost:1998/catalog'
 
 ################### FRONTEND APPLICATION DISCUSSIONS ###################