Merge pull request #328 from RSE-Sheffield/feat/survey-read-only

Prevent survey changes after responses received

Author: Joe-Heffer-Shef

home/templates/projects/project.html

@@ -55,7 +55,7 @@ <h2 class="text-2xl font-bold d-inline-block">Surveys</h2>
                 <div class="card-body">
                     <h3 class="card-title" title="Survey identifier {{ survey.pk }}">{{ survey.name }}</h3>
                     <div class="card-text">
-                        <span>Responses: {{ survey.survey_response.count | default:0 }}</span>
+                        <span>Responses: {{ survey.responses_count }}</span>
                     </div>
                     <div class="mt-2 w-100 d-flex flex-wrap justify-content-end gap-2">
                         {% if can_edit|get_item:survey.id %}

survey/models.py

@@ -134,6 +134,20 @@ def _generate_random_field_value(cls, field_config):
     def accept_response(self, answers: list):
         return SurveyResponse.objects.create(survey=self, answers=answers)
 
+    @property
+    def responses_count(self) -> int:
+        """
+        The number of submitted questionnaires.
+        """
+        return self.survey_response.count()
+
+    @property
+    def has_responses(self) -> bool:
+        """
+        Does this survey have any responses?
+        """
+        return self.survey_response.exists()
+
 
 class SurveyEvidenceSection(models.Model):
     """

survey/services/survey.py

@@ -97,6 +97,13 @@ def update_consent_demography_config(
             demography_config,
             survey_body_path,
     ) -> Survey:
+        """
+        Modify demographics fields on this survey
+        """
+
+        if survey.has_responses:
+            raise PermissionDenied("Cannot modify survey with responses")
+
         survey.consent_config = consent_config
         survey.demography_config = demography_config
         survey.survey_body_path = survey_body_path

survey/templates/survey/survey.html

@@ -51,7 +51,9 @@ <h1 title="Reference number {{ survey.reference_number }}">{{ survey.name }}</h1
                 </div>
                 <div class="d-flex justify-content-end mt-3">
                     <div>
-                        <a href="{% url 'survey_duplicate_config' survey.pk %}" class="btn btn-primary"><i class='bx bxs-copy' ></i> Create a new survey using current configurations.</a>
+                        <a href="{% url 'survey_duplicate_config' survey.pk %}" class="btn btn-primary"
+                        title="Create a new survey using current configurations.">
+                            <i class='bx bxs-copy' ></i> Duplicate</a>
                     </div>
                 </div>
             </div>
@@ -68,10 +70,24 @@ <h2>1. Configure Your Survey</h2>
             </div>
             <div class="card-body">
                 <div class="mb-3 mt-3">
+                    {% if survey.has_responses %}
+                    <div class="alert alert-warning">
+                        <p>
+                            ⚠️ The survey cannot be modified after responses have been collected.
+                            Consider duplicating the survey instead.
+                        </p>
+                    </div>
+                    {% endif %}
                     <p>First, configure you survey here. You are able to add and customise demographic questions asked
                         in the survey.</p>
+                    <p>After the survey receives any responses you will no longer be able to modify the questions.</p>
+                    {% if survey.has_responses %}
+                    <button class="btn btn-secondary" title="Surveys that have been responded to cannot be modified">
+                        <i class="bx bxs-cog"></i> Configure the survey</button>
+                    {% else %}
                     <a href="{% url 'survey_configure' survey.id %}" class="btn btn-primary"><i class="bx bxs-cog"></i>
                         Configure the survey</a>
+                    {% endif %}
                 </div>
             </div>
         </div>

survey/views.py

@@ -134,6 +134,9 @@ def get_success_url(self):
 
 
 class SurveyConfigureView(LoginRequiredMixin, View):
+    """
+    Modify the questions in a survey.
+    """
 
     def get(self, request: HttpRequest, pk: int):
         return self.render_survey_config_view(request, pk, is_post=False)
@@ -142,9 +145,13 @@ def post(self, request: HttpRequest, pk: int):
         return self.render_survey_config_view(request, pk, is_post=True)
 
     def render_survey_config_view(self, request: HttpRequest, pk: int, is_post: bool):
-        context = {}
+        context = dict()
         # TODO: Error handling when object not found
         survey = get_object_or_404(Survey, pk=pk)
+        if survey.has_responses:
+            raise PermissionDenied(
+                "Surveys cannot be modified after receiving responses."
+            )
         context["survey"] = survey
         context["csrf"] = str(csrf(self.request)["csrf_token"])
         context["can_edit"] = {survey.id: survey_service.can_edit(request.user, survey)}