Refactor the Ajax mixin into HTMXFormMixin

Signed-off-by: tdruez <[email protected]>

Author: tdruez

scanpipe/views.py

@@ -561,23 +561,21 @@ def get(self, request, *args, **kwargs):
         return response
 
 
-class FormAjaxMixin:
-    def is_xhr(self):
-        return self.request.META.get("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest"
-
+class HTMXFormMixin:
     def form_valid(self, form):
         response = super().form_valid(form)
 
-        if self.is_xhr():
-            return JsonResponse({"redirect_url": self.get_success_url()}, status=201)
+        if self.request.htmx:
+            return HttpResponseClientRedirect(self.get_success_url())
 
         return response
 
     def form_invalid(self, form):
         response = super().form_invalid(form)
 
-        if self.is_xhr():
-            return JsonResponse({"errors": str(form.errors)}, status=400)
+        if self.request.htmx:
+            # Re-render the form with errors
+            return self.render_to_response(self.get_context_data(form=form))
 
         return response
 
@@ -697,7 +695,7 @@ def get_queryset(self):
         )
 
 
-class ProjectCreateView(ConditionalLoginRequired, FormAjaxMixin, generic.CreateView):
+class ProjectCreateView(ConditionalLoginRequired, generic.CreateView):
     model = Project
     form_class = ProjectForm
     template_name = "scanpipe/project_form.html"
@@ -716,6 +714,23 @@ def get_context_data(self, **kwargs):
         context["pipelines_available_groups"] = pipelines_available_groups
         return context
 
+    @property
+    def is_xhr(self):
+        # The request is XMLHttpRequest when using the input upload progress
+        return self.request.META.get("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest"
+
+    def form_valid(self, form):
+        response = super().form_valid(form)
+        if self.is_xhr:
+            return JsonResponse({"redirect_url": self.get_success_url()}, status=201)
+        return response
+
+    def form_invalid(self, form):
+        response = super().form_invalid(form)
+        if self.is_xhr:
+            return JsonResponse({"errors": str(form.errors)}, status=400)
+        return response
+
 
 class ProjectDetailView(ConditionalLoginRequired, generic.DetailView):
     model = Project
@@ -958,7 +973,7 @@ def download_config_file(project):
 
 
 class ProjectSettingsWebhookCreateView(
-    ConditionalLoginRequired, FormAjaxMixin, UpdateView
+    ConditionalLoginRequired, HTMXFormMixin, UpdateView
 ):
     model = Project
     form_class = WebhookSubscriptionForm
@@ -1466,15 +1481,11 @@ def xlsx_report_response(project_qs, action_form):
         )
 
 
-class ProjectCloneView(ConditionalLoginRequired, FormAjaxMixin, UpdateView):
+class ProjectCloneView(ConditionalLoginRequired, HTMXFormMixin, UpdateView):
     model = Project
     form_class = ProjectCloneForm
     template_name = "scanpipe/forms/project_clone_form.html"
 
-    def form_valid(self, form):
-        super().form_valid(form)
-        return HttpResponseClientRedirect(self.get_success_url())
-
 
 @conditional_login_required
 def execute_pipelines_view(request, slug):