feeat: feature flag, application instance

Author: gmorador-tribu

lms/models/application_instance.py

@@ -70,6 +70,7 @@ class Settings(StrEnum):
         HYPOTHESIS_MENTIONS = "hypothesis.mentions"
         HYPOTHESIS_PDF_IMAGE_ANNOTATION = "hypothesis.pdf_image_annotation"
         HYPOTHESIS_PROMPT_FOR_GRADABLE = "hypothesis.prompt_for_gradable"
+        HYPOTHESIS_HIDE_AND_REVEAL = "hypothesis.hide_and_reveal"
 
     fields: Mapping[Settings, JSONSetting] = {
         Settings.BLACKBOARD_FILES_ENABLED: JSONSetting(
@@ -182,6 +183,11 @@ class Settings(StrEnum):
             SettingFormat.TRI_STATE,
             default=True,
         ),
+        Settings.HYPOTHESIS_HIDE_AND_REVEAL: JSONSetting(
+            Settings.HYPOTHESIS_HIDE_AND_REVEAL,
+            SettingFormat.TRI_STATE,
+            default=False,
+        ),
     }
 
 

lms/resources/_js_config/__init__.py

@@ -402,6 +402,9 @@ def enable_file_picker_mode(  # noqa: PLR0913
                     "formFields": form_fields,
                     "promptForTitle": prompt_for_title,
                     "promptForGradable": prompt_for_gradable,
+                    # Assignment types the instructor can choose from. Gated by
+                    # the per-install "hide_and_reveal" feature flag.
+                    "assignmentTypes": self._get_assignment_types(),
                     # Enable auto grading everywhere except in Sakai
                     "autoGradingEnabled": self._application_instance.tool_consumer_info_product_family_code
                     != "sakai",
@@ -430,6 +433,23 @@ def enable_file_picker_mode(  # noqa: PLR0913
         )
         return self._config
 
+    def _get_assignment_types(self) -> list[str]:
+        """Return the assignment types the instructor can choose from.
+
+        `reading` is always available. The "Hide & Reveal" (Guided Social
+        annotation) type is gated by the per-install `hypothesis.hide_and_reveal`
+        feature flag.
+        """
+        settings = self._application_instance.settings
+        types = ["reading"]
+
+        if settings.get_setting(
+            settings.fields[settings.Settings.HYPOTHESIS_HIDE_AND_REVEAL]
+        ):
+            types.append("hide_and_reveal")
+
+        return types
+
     def add_deep_linking_api(self):
         """
         Add the details of the "DeepLinking API" in LMS where we support deep linking.

lms/templates/admin/application_instance/show.html.jinja2

@@ -130,6 +130,7 @@
                             {{ tri_state_settings_checkbox("Collect student emails", fields[Settings.HYPOTHESIS_COLLECT_STUDENT_EMAILS]) }}
                             {{ tri_state_settings_checkbox("Mentions", fields[Settings.HYPOTHESIS_MENTIONS]) }}
                             {{ tri_state_settings_checkbox("PDF image annotation", fields[Settings.HYPOTHESIS_PDF_IMAGE_ANNOTATION]) }}
+                            {{ tri_state_settings_checkbox("Hide & Reveal (Guided Social annotation)", fields[Settings.HYPOTHESIS_HIDE_AND_REVEAL]) }}
                         </fieldset>
                         <fieldset class="box">
                             <legend class="label has-text-centered">Grading settings</legend>

tests/unit/lms/models/application_instance_test.py

@@ -194,6 +194,12 @@ def test_it(self):
                 "hypothesis.pdf_image_annotation",
                 SettingFormat.TRI_STATE,
             ),
+            (
+                "hypothesis",
+                "hide_and_reveal",
+                "hypothesis.hide_and_reveal",
+                SettingFormat.TRI_STATE,
+            ),
         ]
 
 

tests/unit/lms/resources/_js_config/__init___test.py

@@ -66,6 +66,31 @@ def test_it(
             }
         )
 
+    @pytest.mark.parametrize(
+        "hide_and_reveal,expected_types",
+        [
+            # Flag explicitly on.
+            (True, ["reading", "hide_and_reveal"]),
+            # Flag explicitly off.
+            (False, ["reading"]),
+            # Flag unset: defaults to off.
+            (None, ["reading"]),
+        ],
+    )
+    def test_it_sets_assignment_types(
+        self, js_config, course, application_instance, hide_and_reveal, expected_types
+    ):
+        if hide_and_reveal is not None:
+            application_instance.settings.set(
+                "hypothesis", "hide_and_reveal", hide_and_reveal
+            )
+
+        js_config.enable_file_picker_mode(
+            sentinel.form_action, sentinel.form_fields, course
+        )
+
+        assert js_config.asdict()["filePicker"]["assignmentTypes"] == expected_types
+
     @pytest.mark.parametrize(
         "config_function,key",
         (