🚩(backend) add feature flags to enable/disable core resources

wilbrdt · wilbrdt · commit 361c7e6dd4d8 · 2025-05-26T17:45:08.000+02:00
Currently, it is not possible to disable the core resources for the whole site.
Introducing three settings flags (DOCUMENT_ENABLED, VIDEO_ENABLED and
WEBINAR_ENABLED) selectively disabling these resources.
These flags apply to both the standalone site and the LTI site.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- Add feature flags to enable/disable core resources for the whole site
 - Add support for storing markdown images on Scaleway S3
 - Add support for storing deposited files on Scaleway S3
 - Add support for storing classroom documents on Scaleway S3
diff --git a/env.d/development.dist b/env.d/development.dist
@@ -31,6 +31,11 @@ DJANGO_LTI_CONFIG_DESCRIPTION=marsha_32x32_blue.png
 DJANGO_LTI_CONFIG_URL=https://github.com/openfun/marsha
 DJANGO_LTI_CONFIG_CONTACT_EMAIL=fun.dev@fun-mooc.fr
 
+# Core applications
+DJANGO_DOCUMENT_ENABLED=True
+DJANGO_VIDEO_ENABLED=True
+DJANGO_WEBINAR_ENABLED=True
+
 # BBB server credentials
 DJANGO_BBB_ENABLED=False
 DJANGO_BBB_API_ENDPOINT=https://example.com/bbb/api
diff --git a/env.d/test b/env.d/test
@@ -18,6 +18,11 @@ DJANGO_CLOUDFRONT_DOMAIN=abc.cloudfront.net
 DJANGO_SCW_EDGE_SERVICE_DOMAIN=abc.svc.edge.scw.cloud
 DJANGO_UPDATE_STATE_SHARED_SECRETS=dummy,secret
 
+# Core applications
+DJANGO_DOCUMENT_ENABLED=True
+DJANGO_VIDEO_ENABLED=True
+DJANGO_WEBINAR_ENABLED=True
+
 # BBB
 DJANGO_BBB_ENABLED=False
 DJANGO_BBB_API_SECRET=ThisIsAnExampleKeyForDevPurposeOnly
diff --git a/src/backend/marsha/core/api/base.py b/src/backend/marsha/core/api/base.py
@@ -10,7 +10,15 @@
 from waffle import switch_is_active
 
 from marsha.core import serializers
-from marsha.core.defaults import READY, SENTRY, TRANSCRIPTION, VOD_CONVERT
+from marsha.core.defaults import (
+    DOCUMENT,
+    READY,
+    SENTRY,
+    TRANSCRIPTION,
+    VIDEO,
+    VOD_CONVERT,
+    WEBINAR,
+)
 from marsha.core.models import SiteConfig, Video
 from marsha.core.signals import signal_object_uploaded
 from marsha.core.simple_jwt.tokens import PlaylistAccessToken
@@ -219,6 +227,14 @@ def get_frontend_configuration(request):
 
     domain = request.get_host()
     inactive_resources = []
+
+    if not settings.DOCUMENT_ENABLED:
+        inactive_resources.append(DOCUMENT)
+    if not settings.VIDEO_ENABLED:
+        inactive_resources.append(VIDEO)
+    if not settings.WEBINAR_ENABLED:
+        inactive_resources.append(WEBINAR)
+
     vod_conversion_enabled = True
 
     is_default_site = domain in settings.FRONTEND_HOME_URL
diff --git a/src/backend/marsha/core/lti_select.py b/src/backend/marsha/core/lti_select.py
@@ -1,5 +1,6 @@
 """Module dedicated to lti select feature for core."""
 
+from django.conf import settings
 from django.db.models import Q
 
 from marsha.core.defaults import ENDED, LTI_DOCUMENT_ROUTE, LTI_VIDEO_ROUTE
@@ -12,29 +13,40 @@
 
 def get_lti_select_config():
     """return config for lti select."""
-    return [
-        {
-            "name": "document",
-            "serializer": DocumentSelectLTISerializer,
-            "model": Document,
-            "route": LTI_DOCUMENT_ROUTE,
-        },
-        {
-            "name": "video",
-            "serializer": VideoSelectLTISerializer,
-            "model": Video,
-            "route": LTI_VIDEO_ROUTE,
-            "extra_filter": lambda queryset: queryset.filter(
-                Q(live_type__isnull=True) | Q(live_state=ENDED)
-            ),
-        },
-        {
-            "name": "webinar",
-            "serializer": VideoSelectLTISerializer,
-            "model": Video,
-            "route": LTI_VIDEO_ROUTE,
-            "extra_filter": lambda queryset: queryset.filter(
-                live_type__isnull=False
-            ).exclude(live_state=ENDED),
-        },
-    ]
+    lti_config = []
+
+    if settings.DOCUMENT_ENABLED:
+        lti_config.append(
+            {
+                "name": "document",
+                "serializer": DocumentSelectLTISerializer,
+                "model": Document,
+                "route": LTI_DOCUMENT_ROUTE,
+            }
+        )
+    if settings.VIDEO_ENABLED:
+        lti_config.append(
+            {
+                "name": "video",
+                "serializer": VideoSelectLTISerializer,
+                "model": Video,
+                "route": LTI_VIDEO_ROUTE,
+                "extra_filter": lambda queryset: queryset.filter(
+                    Q(live_type__isnull=True) | Q(live_state=ENDED)
+                ),
+            }
+        )
+    if settings.WEBINAR_ENABLED:
+        lti_config.append(
+            {
+                "name": "webinar",
+                "serializer": VideoSelectLTISerializer,
+                "model": Video,
+                "route": LTI_VIDEO_ROUTE,
+                "extra_filter": lambda queryset: queryset.filter(
+                    live_type__isnull=False
+                ).exclude(live_state=ENDED),
+            }
+        )
+
+    return lti_config
diff --git a/src/backend/marsha/core/tests/views/test_lti_select.py b/src/backend/marsha/core/tests/views/test_lti_select.py
@@ -149,6 +149,74 @@ def test_views_lti_select(self):
             {"can_access_dashboard": False, "can_update": True},
         )
 
+    @override_settings(
+        DOCUMENT_ENABLED=False, VIDEO_ENABLED=False, WEBINAR_ENABLED=False
+    )
+    def test_views_lti_select_disabled(self):
+        """Frontend context flags should be disabled when flags are disabled."""
+        lti_consumer_parameters = {
+            "roles": random.choice(["instructor", "administrator"]),
+            "content_item_return_url": "https://lti-consumer.site/lti",
+            "context_id": "sent_lti_context_id",
+            "title": "Sent LMS activity title",
+            "text": "Sent LMS activity text",
+        }
+        lti_parameters, passport = generate_passport_and_signed_lti_parameters(
+            url="http://testserver/lti/select/",
+            lti_parameters=lti_consumer_parameters,
+        )
+
+        resolutions = [144]
+        playlist = PlaylistFactory(
+            lti_id=lti_parameters.get("context_id"),
+            consumer_site=passport.consumer_site,
+        )
+        VideoFactory(
+            playlist=playlist,
+            uploaded_on=timezone.now(),
+            resolutions=resolutions,
+            position=1,
+        )
+        DocumentFactory(
+            playlist=playlist,
+            uploaded_on=timezone.now(),
+        )
+        VideoFactory(
+            playlist=playlist,
+            live_state=IDLE,
+            live_type=JITSI,
+            position=2,
+        )
+        VideoFactory(
+            playlist=playlist,
+            live_state=ENDED,
+            live_type=JITSI,
+            position=3,
+        )
+
+        response = self.client.post(
+            "/lti/select/",
+            lti_parameters,
+            HTTP_REFERER="http://testserver",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "<html>")
+
+        match = re.search(
+            '<div id="marsha-frontend-data" data-context="(.*)">',
+            response.content.decode("utf-8"),
+        )
+        context = json.loads(unescape(match.group(1)))
+
+        self.assertFalse(context.get("flags").get("document"))
+        self.assertIsNone(context.get("document"))
+
+        self.assertFalse(context.get("flags").get("video"))
+        self.assertIsNone(context.get("video"))
+
+        self.assertFalse(context.get("flags").get("webinar"))
+        self.assertIsNone(context.get("webinar"))
+
     def test_views_lti_select_video(self):
         """
         Validate the context passed to the frontend app for an LTI Content selection targeting
@@ -242,6 +310,60 @@ def test_views_lti_select_video(self):
             {"can_access_dashboard": False, "can_update": True},
         )
 
+    @override_settings(VIDEO_ENABLED=False)
+    def test_views_lti_select_video_disabled(self):
+        """
+        Frontend context flag should be disabled when flag is disabled."""
+        lti_consumer_parameters = {
+            "roles": random.choice(["instructor", "administrator"]),
+            "content_item_return_url": "https://lti-consumer.site/lti",
+            "context_id": "sent_lti_context_id",
+            "title": "Sent LMS activity title",
+            "text": "Sent LMS activity text",
+        }
+        lti_parameters, passport = generate_passport_and_signed_lti_parameters(
+            url="http://testserver/lti/select/video/",
+            lti_parameters=lti_consumer_parameters,
+        )
+
+        playlist = PlaylistFactory(
+            lti_id=lti_parameters.get("context_id"),
+            consumer_site=passport.consumer_site,
+        )
+        VideoFactory(
+            playlist=playlist,
+            uploaded_on=timezone.now(),
+            resolutions=[144],
+            position=1,
+        )
+        DocumentFactory(
+            playlist=playlist,
+            uploaded_on=timezone.now(),
+        )
+        VideoFactory(
+            playlist=playlist,
+            live_state=IDLE,
+            live_type=JITSI,
+            position=2,
+        )
+
+        response = self.client.post(
+            "/lti/select/video/",
+            lti_parameters,
+            HTTP_REFERER="http://testserver",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "<html>")
+
+        match = re.search(
+            '<div id="marsha-frontend-data" data-context="(.*)">',
+            response.content.decode("utf-8"),
+        )
+        context = json.loads(unescape(match.group(1)))
+
+        self.assertFalse(context.get("flags").get("video"))
+        self.assertIsNone(context.get("video"))
+
     @override_settings(LTI_CONFIG_TITLE="Marsha")
     def test_views_lti_select_default_title(self):
         """Validate the context passed to the frontend app for an LTI Content selection."""
diff --git a/src/backend/marsha/core/views.py b/src/backend/marsha/core/views.py
@@ -133,9 +133,9 @@ def _get_base_app_data(self):
                 DEPOSIT: settings.DEPOSIT_ENABLED,
                 LIVE_RAW: settings.LIVE_RAW_ENABLED,
                 MARKDOWN: settings.MARKDOWN_ENABLED,
-                VIDEO: True,
-                WEBINAR: True,
-                DOCUMENT: True,
+                VIDEO: settings.VIDEO_ENABLED,
+                WEBINAR: settings.WEBINAR_ENABLED,
+                DOCUMENT: settings.DOCUMENT_ENABLED,
                 TRANSCRIPTION: switch_is_active(TRANSCRIPTION),
             },
             "release": settings.RELEASE,
diff --git a/src/backend/marsha/settings.py b/src/backend/marsha/settings.py
@@ -416,6 +416,11 @@ class Base(Configuration):
     LTI_REPLAY_PROTECTION_CACHE_DURATION = values.PositiveIntegerValue(3600)  # 1 hour
     LTI_REPLAY_PROTECTION_ENABLED = values.BooleanValue(True)
 
+    # Core applications
+    DOCUMENT_ENABLED = values.BooleanValue(True)
+    VIDEO_ENABLED = values.BooleanValue(True)
+    WEBINAR_ENABLED = values.BooleanValue(True)
+
     # BBB
     BBB_ENABLED = values.BooleanValue(False)
     BBB_API_ENDPOINT = values.Value()
