publish form via htmx

caktus · Feb 5, 2025 · 9a32a10 · 9a32a10
1 parent 65a8d62
commit 9a32a10
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 79 deletions.
diff --git a/apps/odk_publish/consumers.py b/apps/odk_publish/consumers.py
@@ -14,46 +14,58 @@
 
 
 class PublishTemplateEvent(BaseModel):
+    """Model to parse and validate the publish WebSocket message payload."""
+
     form_template: int
     app_users: list[str]
 
     @field_validator("app_users", mode="before")
     @classmethod
     def split_comma_separated_app_users(cls, v):
+        """Split comma-separated app users into a list."""
         if isinstance(v, str):
             return v.split(",")
         return v
 
 
 class PublishTemplateConsumer(WebsocketConsumer):
+    """Websocket consumer for publishing form templates to ODK Central."""
+
     def connect(self):
         logger.debug(f"New connection: {self.channel_layer}")
         super().connect()
 
-    def send_message(self, message: str, error: bool = False):
+    def send_message(self, message: str, error: bool = False, complete: bool = False):
+        """Send a message to the browser."""
         if not error:
             logger.debug(f"Sending message: {message}")
         message = render_to_string(
-            "odk_publish/ws/message.html", {"message_text": message, "error": error}
+            "odk_publish/ws/message.html",
+            {"message_text": message, "error": error, "complete": complete},
         )
         self.send(text_data=message)
 
     def receive(self, text_data):
+        """Receive a message from the browser."""
         logger.debug("Received message", text_data=f"{text_data[:50]}...")
-        event_data = json.loads(text_data)
         try:
+            event_data = json.loads(text_data)
             self.publish_form_template(event_data=event_data)
         except Exception as e:
-            logger.exception(f"Error publishing form: {e}")
-            self.send_message(traceback.format_exc(), error=True)
+            logger.exception("Error publishing form")
+            tbe = traceback.TracebackException.from_exception(exc=e, capture_locals=True)
+            self.send_message("".join(tbe.format()), error=True)
 
     def publish_form_template(self, event_data: dict):
+        """Publish a form template to ODK Central and stream progress to the browser."""
+        user = self.scope["user"]
+        # Parse the event data and raise an error if it's invalid
         publish_event = PublishTemplateEvent(**event_data)
-        self.send_message(f"Received event: {publish_event}")
+        self.send_message(f"New {repr(publish_event)}")
+        # Get the form template
         form_template = FormTemplate.objects.select_related().get(id=publish_event.form_template)
-        app_users = form_template.project.app_users.filter(name__in=publish_event.app_users)
-        self.send_message(f'Publishing form template "{form_template.title_base}"')
-        user = self.scope["user"]
+        self.send_message(f"Publishing next version of {repr(form_template)}")
+        # Get the next version by querying ODK Central
         client = ODKPublishClient(
             base_url=form_template.project.central_server.base_url,
             project_id=form_template.project.central_id,
@@ -62,20 +74,26 @@ def publish_form_template(self, event_data: dict):
             xml_form_id_base=form_template.form_id_base
         )
         self.send_message(f"Generated version: {version}")
-        name = f"{form_template.form_id_base}-{version}.xlsx"
-        file = form_template.download_google_sheet(user=user, name=name)
+        # Download the template from Google Sheets
+        file = form_template.download_google_sheet(
+            user=user, name=f"{form_template.form_id_base}-{version}.xlsx"
+        )
         self.send_message(f"Downloaded template: {file}")
         with transaction.atomic():
-            version = FormTemplateVersion.objects.create(
+            # Create the next version
+            template_version = FormTemplateVersion.objects.create(
                 form_template=form_template, user=user, file=file, version=version
             )
-            app_user_versions = version.create_app_user_versions(
+            # Create a version for each app user
+            app_users = form_template.project.app_users.filter(name__in=publish_event.app_users)
+            app_user_versions = template_version.create_app_user_versions(
                 app_users=app_users, send_message=self.send_message
             )
+            # Publish each app user version to ODK Central
             for app_user_version in app_user_versions:
                 form = client.odk_publish.create_or_update_form(
                     xml_form_id=app_user_version.app_user_form_template.xml_form_id,
                     definition=app_user_version.file.read(),
                 )
                 self.send_message(f"Published form: {form.xmlFormId}")
-        self.send_message("Publish complete!")
+        self.send_message(f"Successfully published {version}", complete=True)
diff --git a/apps/odk_publish/forms.py b/apps/odk_publish/forms.py
@@ -65,7 +65,7 @@ class PublishTemplateForm(PlatformFormMixin, forms.Form):
         required=False,
         label="Limit App Users",
         help_text="Publish to a limited set of app users by entering a comma-separated list.",
-        widget=TextInput(attrs={"placeholder": "e.g., 10001, 10002, 10003"}),
+        widget=TextInput(attrs={"placeholder": "e.g., 10001, 10002, 10003", "autofocus": True}),
     )
 
     def __init__(self, request: HttpRequest, form_template: FormTemplate, *args, **kwargs):

diff --git a/apps/odk_publish/views.py b/apps/odk_publish/views.py
@@ -123,8 +123,11 @@ def form_template_publish(request: HttpRequest, odk_project_pk: int, form_templa
     form = PublishTemplateForm(
         request=request, form_template=form_template, data=request.POST or None
     )
+    template = "odk_publish/form_template_publish.html"
     if request.method == "POST" and form.is_valid():
         pass
+    if request.htmx:
+        template = f"{template}#publish-partial"
     context = {
         "form": form,
         "form_template": form_template,
@@ -137,7 +140,7 @@ def form_template_publish(request: HttpRequest, odk_project_pk: int, form_templa
             ],
         ),
     }
-    return render(request, "odk_publish/form_template_publish.html", context)
+    return render(request, template, context)
 
 
 @login_required

diff --git a/config/templates/odk_publish/form_template_publish.html b/config/templates/odk_publish/form_template_publish.html
@@ -4,64 +4,86 @@
     Publish next version of {{ form_template.title_base }}
 {% endblock page_header %}
 {% block content %}
-    <form method="post"
-          class="max-w-2xl"
-          x-data="{ submitting: false }"
-          x-on:submit="submitting = true">
-        {% csrf_token %}
-        {{ form.form_template.as_hidden }}
-        <div class="grid gap-4 sm:grid-cols-1 sm:gap-6">
-            <div id="id_form_container">
-                {{ form.app_users.label_tag }}
-                {{ form.app_users }}
-                {{ form.app_users.errors }}
-            </div>
-            <div class="flex items-center space-x-4">
-                <button type="submit"
-                        :disabled="submitting"
-                        :class="{'btn-disabled': submitting}"
-                        class="btn btn-outline btn-primary">
-                    <svg class="inline-flex items-center w-4.5 h-4.5 mr-1.5 -ml-1 -mt-0.5 text-gray-800 dark:text-white"
-                         aria-hidden="true"
-                         xmlns="http://www.w3.org/2000/svg"
-                         width="24"
-                         height="24"
-                         fill="none"
-                         viewBox="0 0 24 24">
-                        <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 15v2a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3v-2M12 4v12m0-12 4 4m-4-4L8 8" />
-                    </svg>
-                    Publish next version
-                    <svg aria-hidden="true"
-                         role="status"
-                         x-cloak
-                         x-show="submitting"
-                         class="inline-flex items-center w-4.5 h-4.5 ml-1.5 -mr-1 -mt-0.5 me-3 text-gray-200 animate-spin dark:text-gray-600"
-                         viewBox="0 0 100 101"
-                         fill="none"
-                         xmlns="http://www.w3.org/2000/svg">
-                        <path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor" />
-                        <path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="#1C64F2" />
-                    </svg>
-                </button>
-                <a type="button"
-                   class="btn btn-outline"
-                   href="{% url 'odk_publish:form-template-detail' request.odk_project.id form_template.id %}"
-                   :disabled="submitting">Cancel</a>
-            </div>
+    <script>
+        document.addEventListener('alpine:init', () => {
+            Alpine.store('publishing', false)
+        })
+    </script>
+    <div class="gap-8 md:flex">
+        <!-- Sidenav -->
+        <aside id="sidebar"
+               class="mb-6 h-full shrink-0 overflow-y-auto border border-gray-200 bg-white p-3 shadow-sm dark:border-gray-700 dark:bg-gray-800 lg:block lg:rounded-lg md:w-80">
+            {% partialdef publish-form-partial inline %}
+                <span x-data
+                      x-init="$store.publishing = {% if form.is_valid %}true{% else %}false{% endif %}"></span>
+                <form method="post" class="max-w-2xl" hx-target="this" hx-swap="outerHTML">
+                    {% csrf_token %}
+                    {{ form.form_template.as_hidden }}
+                    <div class="grid gap-4 sm:grid-cols-1 sm:gap-6">
+                        <div id="id_form_container">
+                            {{ form.app_users.label_tag }}
+                            {{ form.app_users }}
+                            {{ form.app_users.errors }}
+                        </div>
+                        <div class="flex items-center space-x-4">
+                            <button type="submit"
+                                    hx-post="{% url 'odk_publish:form-template-publish' request.odk_project.id form_template.id %}"
+                                    :disabled="$store.publishing"
+                                    :class="{'btn-disabled': $store.publishing}"
+                                    class="btn btn-outline btn-primary w-full">
+                                <svg class="inline-flex items-center w-4.5 h-4.5 mr-1.5 -ml-1 -mt-0.5 text-gray-800 dark:text-white"
+                                     aria-hidden="true"
+                                     xmlns="http://www.w3.org/2000/svg"
+                                     width="24"
+                                     height="24"
+                                     fill="none"
+                                     viewBox="0 0 24 24">
+                                    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 15v2a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3v-2M12 4v12m0-12 4 4m-4-4L8 8" />
+                                </svg>
+                                Publish next version
+                                <svg aria-hidden="true"
+                                     role="status"
+                                     x-cloak
+                                     x-show="$store.publishing"
+                                     class="inline-flex items-center w-4.5 h-4.5 ml-1.5 -mr-1 -mt-0.5 me-3 text-gray-200 animate-spin dark:text-gray-600"
+                                     viewBox="0 0 100 101"
+                                     fill="none"
+                                     xmlns="http://www.w3.org/2000/svg">
+                                    <path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor" />
+                                    <path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="#1C64F2" />
+                                </svg>
+                            </button>
+                        </div>
+                    </div>
+                </form>
+            {% endpartialdef publish-form-partial %}
+        </aside>
+        <div class="grid w-full gap-4">
+            {% partialdef publish-ws-init-partial inline %}
+                <div id="publish-ws-init-partial" hx-swap-oob="true" class="">
+                    {% if form.is_valid %}
+                        <h3 class="flex items-center text-xl font-semibold leading-none text-gray-900 dark:text-white">Publish Events</h3>
+                        <div class="my-4 grid gap-4 md:my-6 md:gap-12">
+                            <div id="message-list-wrapper"
+                                 hx-ext="ws"
+                                 ws-connect="/ws/publish-template/"
+                                 class="border-r-2 border-primary-400 dark:border-gray-700">
+                                <form hx-ws="send" hx-trigger="load delay:1ms">
+                                    {{ form.form_template.as_hidden }}
+                                    {{ form.app_users.as_hidden }}
+                                </form>
+                                <div id="message-list"
+                                     class="max-h-screen overflow-y-auto grid grid-cols-5"
+                                     hx-swap-oob="afterbegin"></div>
+                            </div>
+                        {% endif %}
+                    </div>
+                </div>
+            {% endpartialdef publish-ws-init-partial %}
         </div>
-    </form>
-    {% if form.is_valid %}
-        <h3 class="text-l mt-5 mb-3 font-bold dark:text-white">Publishing...</h3>
-        <div id="message-list-wrapper"
-             hx-ext="ws"
-             ws-connect="/ws/publish-template/">
-            <form hx-ws="send" hx-trigger="load delay:1ms">
-                {{ form.form_template.as_hidden }}
-                {{ form.app_users.as_hidden }}
-            </form>
-            <div id="message-list"
-                 class="h-[50rem] overflow-y-auto"
-                 hx-swap-oob="beforeend"></div>
-        </div>
-    {% endif %}
+    </div>
 {% endblock content %}
+{% partialdef publish-partial %}
+    {% partial publish-form-partial %}
+    {% partial publish-ws-init-partial %}
+{% endpartialdef publish-partial %}
diff --git a/config/templates/odk_publish/ws/message.html b/config/templates/odk_publish/ws/message.html
@@ -1,6 +1,10 @@
-<div id="message-list" hx-swap-oob="beforeend">
-    <div class="p-4 mb-4 text-sm rounded-lg {% if not error %}text-primary-700 bg-primary-100 dark:bg-gray-800 dark:text-primary-300{% else %} font-mono text-red-700 bg-red-50 dark:bg-gray-800 dark:text-red-400{% endif %}">
-        {% if error %}<pre>{% endif %}{{ message_text|safe }}{% if error %}</pre>
+<div id="message-list" hx-swap-oob="afterbegin">
+    <div class="text-xs flex justify-end items-start p-3 {% if not error %}text-primary-700 bg-primary-100 dark:bg-gray-800 dark:text-primary-300{% else %} text-red-700 bg-red-50 dark:bg-gray-800 dark:text-red-400{% endif %}">
+        {% now "n/j G:i:s.u" %}
+    </div>
+    <div class="col-span-4 text-sm p-3 {% if complete %}font-bold{% endif %}{% if not error %}text-black dark:bg-gray-800 dark:text-primary-300{% else %} overflow-auto font-mono text-red-700 bg-red-50 dark:bg-gray-800 dark:text-red-400{% endif %}">
+        {% if error %}<pre class="text-xs">{% endif %}{{ message_text|escape }}{% if error %}</pre>
         {% endif %}
+        {% if complete or error %}<span x-data x-init="$store.publishing = false"></span>{% endif %}
     </div>
 </div>
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,7 +39,7 @@ known_first_party = [ "apps", "config" ]
 # H031 - Consider adding meta keywords.
 ignore="H030,H031"
 profile = "django"
-custom_blocks="switch"
+custom_blocks="switch,partialdef"
 
 [tool.pytest.ini_options]
 addopts = "--ds=config.settings.test --cov=apps --cov-report=html"