Ensure survey radio button ID uniqueness across surveys (#57)

* Ensure survey radio IDs are unique across surveys, to avoid ID clashes with two surveys on the same page.
* Version bump.

poll/poll.py

@@ -1251,7 +1251,22 @@ def workbench_scenarios():
                  answers='[["sa", "Strongly Agree"], ["a", "Agree"], ["n", "Neutral"],
                            ["d", "Disagree"], ["sd", "Strongly Disagree"]]'
                  feedback="### Thank you

for running the tests."/>
-             """)
+             """),
+            ("Survey Multiple",
+             """
+             <vertical_demo>
+                 <survey tally='{"q1": {"sa": 5, "a": 5, "n": 3, "d": 2, "sd": 5}}'
+                     questions='[["q1", {"label": "I feel like this test will pass.", "img": null, "img_alt": null}]]'
+                     answers='[["sa", "Strongly Agree"], ["a", "Agree"], ["n", "Neutral"],
+                               ["d", "Disagree"], ["sd", "Strongly Disagree"]]'
+                     feedback="### Thank you&#10;&#10;for running the tests."/>
+                 <survey tally='{"q1": {"sa": 5, "a": 5, "n": 3, "d": 2, "sd": 5}}'
+                     questions='[["q1", {"label": "Most likely to win the World Cup.", "img": null, "img_alt": null}]]'
+                     answers='[["sa", "South Africa"], ["a", "Angola"], ["n", "Netherlands"],
+                               ["d", "Deutschland"], ["sd", "Someone different"]]'
+                     feedback="### Thank you&#10;&#10;for running the tests."/>
+             </vertical_demo>
+             """),
         ]
 
     def get_filename(self):

poll/public/html/survey.html

@@ -29,10 +29,10 @@ <h3 class="poll-header">{{block_name}}</h3>
                         {% with answer_count=forloop.counter %}
                             {% for answer, label in answers %}
                                 {% if forloop.counter == answer_count %}
-                                    <label for="{{key}}-{{answer_count}}">
+                                    <label for="{{block_id}}-{{key}}-{{answer_count}}">
                                         <input type="radio"
                                                name="{{key}}"
-                                               id="{{key}}-{{forloop.counter}}"
+                                               id="{{block_id}}-{{key}}-{{forloop.counter}}"
                                                value="{{answer}}"{% if question.choice == answer %} checked{% endif %}
                                                {% if question.img_alt %}
                                                aria-label="{{question.img_alt}} {{label}}"

setup.py

@@ -45,7 +45,7 @@ def package_data(pkg, roots):
 
 setup(
     name='xblock-poll',
-    version='1.8.4',
+    version='1.8.5',
     description='An XBlock for polling users.',
     packages=[
         'poll',

tests/integration/test_functions.py

@@ -265,3 +265,14 @@ def test_submit_not_enabled_on_revisit(self):
 
         self.go_to_page('Poll Functions')
         self.assertFalse(self.get_submit().is_enabled())
+
+    def test_survey_radio_ids_unique(self):
+        """
+        Verify that multiple surveys on the same page with the same question
+        IDs still produce unique HTML radio button IDs.
+        """
+        self.go_to_page('Survey Multiple')
+        elements = self.browser.find_elements_by_css_selector('.survey-option input[type=radio]')
+        all_ids = sorted([element.get_attribute('id') for element in elements])
+        unique_ids = sorted(list(set(all_ids)))
+        self.assertSequenceEqual(all_ids, unique_ids)

tests/integration/xml/survey_multiple.xml

@@ -0,0 +1,12 @@
+<vertical_demo>
+    <survey tally='{"q1": {"sa": 5, "a": 5, "n": 3, "d": 2, "sd": 5}}'
+        questions='[["q1", {"label": "I feel like this test will pass.", "img": null, "img_alt": null}]]'
+        answers='[["sa", "Strongly Agree"], ["a", "Agree"], ["n", "Neutral"],
+                  ["d", "Disagree"], ["sd", "Strongly Disagree"]]'
+        feedback="### Thank you&#10;&#10;for running the tests."/>
+    <survey tally='{"q1": {"sa": 5, "a": 5, "n": 3, "d": 2, "sd": 5}}'
+        questions='[["q1", {"label": "Country most likely to win the World Cup.", "img": null, "img_alt": null}]]'
+        answers='[["sa", "South Africa"], ["a", "Angola"], ["n", "Netherlands"],
+                  ["d", "Deutschland"], ["sd", "Someone different"]]'
+        feedback="### Thank you&#10;&#10;for running the tests."/>
+</vertical_demo>