Over engineer ElementOnce web components

club/templates/club/club_members.jinja

@@ -1,11 +1,7 @@
 {% extends "core/base.jinja" %}
 {% from 'core/macros.jinja' import user_profile_link, select_all_checkbox %}
 
-{% block additional_js %}
-  <script type="module" src="{{ static("bundled/core/components/ajax-select-index.ts") }}"></script>
-{% endblock %}
 {% block additional_css %}
-  <link rel="stylesheet" href="{{ static("bundled/core/components/ajax-select-index.css") }}">
   <link rel="stylesheet" href="{{ static("club/members.scss") }}">
 {% endblock %}
 

core/static/bundled/core/components/include-index.ts

@@ -1,18 +1,106 @@
 import { inheritHtmlElement, registerComponent } from "#core:utils/web-components.ts";
 
+/**
+ * Create an abstract class for ElementOnce types Web Components
+ *
+ * Those class aren't really abstract because that would be complicated with the
+ * multiple inheritance involved
+ * Instead, we just raise an unimplemented error
+ **/
+function elementOnce<K extends keyof HTMLElementTagNameMap>(tagName: K) {
+  return class ElementOnce extends inheritHtmlElement(tagName) {
+    getElementQuerySelector(): string {
+      throw new Error("Unimplemented");
+    }
+
+    clearNode() {
+      while (this.firstChild) {
+        this.removeChild(this.lastChild);
+      }
+    }
+
+    refresh() {
+      this.clearNode();
+      if (document.querySelectorAll(this.getElementQuerySelector()).length === 0) {
+        this.appendChild(this.node);
+      }
+    }
+
+    connectedCallback() {
+      super.connectedCallback(false);
+      this.refresh();
+    }
+
+    disconnectedCallback() {
+      // The MutationObserver can't see web components being removed
+      // It also can't see if something is removed inside after the component gets deleted
+      // We need to manually clear the containing node to trigger the observer
+      this.clearNode();
+    }
+  };
+}
+
+// Set of ElementOnce type components to refresh with the observer
+const registeredComponents: Set<string> = new Set();
+
+/**
+ * Helper to register ElementOnce types Web Components
+ * It's a wrapper around registerComponent that registers that component on
+ * a MutationObserver that activates a refresh on them when elements are removed
+ **/
+function registerElementOnce(name: string, options?: ElementDefinitionOptions) {
+  registeredComponents.add(name);
+  return registerComponent(name, options);
+}
+
+const startObserver = (observer: MutationObserver) => {
+  observer.observe(document, {
+    // We want to also listen for elements contained in the header (eg: link)
+    subtree: true,
+    childList: true,
+  });
+};
+
+// Refresh *-once components when changes happens
+const observer = new MutationObserver((mutations: MutationRecord[]) => {
+  observer.disconnect();
+  for (const mutation of mutations) {
+    for (const node of mutation.removedNodes) {
+      if (node.nodeType !== node.ELEMENT_NODE) {
+        continue;
+      }
+      const refreshElement = (componentName: string, tagName: string) => {
+        for (const element of document.getElementsByTagName(componentName)) {
+          // We can't guess if an element is compatible before we get one
+          // We exit the function completely if it's not compatible
+          if (
+            (element as any).inheritedTagName.toUpperCase() !== tagName.toUpperCase()
+          ) {
+            return;
+          }
+
+          (element as any).refresh();
+        }
+      };
+      for (const registered of registeredComponents) {
+        refreshElement(registered, (node as HTMLElement).tagName);
+      }
+    }
+  }
+  startObserver(observer);
+});
+
+startObserver(observer);
+
 /**
  * Web component used to import css files only once
  * If called multiple times or the file was already imported, it does nothing
  **/
-@registerComponent("link-once")
-export class LinkOnce extends inheritHtmlElement("link") {
-  connectedCallback() {
-    super.connectedCallback(false);
+@registerElementOnce("link-once")
+export class LinkOnce extends elementOnce("link") {
+  getElementQuerySelector(): string {
     // We get href from node.attributes instead of node.href to avoid getting the domain part
-    const href = this.node.attributes.getNamedItem("href").nodeValue;
-    if (document.querySelectorAll(`link[href='${href}']`).length === 0) {
-      this.appendChild(this.node);
-    }
+    return `link[href='${this.node.attributes.getNamedItem("href").nodeValue}']`;
   }
 }
 
@@ -20,14 +108,10 @@ export class LinkOnce extends inheritHtmlElement("link") {
  * Web component used to import javascript files only once
  * If called multiple times or the file was already imported, it does nothing
  **/
-@registerComponent("script-once")
+@registerElementOnce("script-once")
 export class ScriptOnce extends inheritHtmlElement("script") {
-  connectedCallback() {
-    super.connectedCallback(false);
-    // We get src from node.attributes instead of node.src to avoid getting the domain part
-    const src = this.node.attributes.getNamedItem("src").nodeValue;
-    if (document.querySelectorAll(`script[src='${src}']`).length === 0) {
-      this.appendChild(this.node);
-    }
+  getElementQuerySelector(): string {
+    // We get href from node.attributes instead of node.src to avoid getting the domain part
+    return `script[src='${this.node.attributes.getNamedItem("src").nodeValue}']`;
   }
 }

core/static/bundled/utils/web-components.ts

@@ -36,6 +36,7 @@ export function registerComponent(name: string, options?: ElementDefinitionOptio
  **/
 export function inheritHtmlElement<K extends keyof HTMLElementTagNameMap>(tagName: K) {
   return class Inherited extends HTMLElement {
+    readonly inheritedTagName = tagName;
     protected node: HTMLElementTagNameMap[K];
 
     connectedCallback(autoAddNode?: boolean) {

core/templates/core/file_moderation.jinja

@@ -48,6 +48,6 @@
           >{% trans %}Delete{% endtrans %}</button></p>
       </div>
     {% endfor %}
-    {{ paginate_htmx(request, page_obj, paginator) }}
+    {{ paginate_htmx(page_obj, paginator) }}
   </div>
 {% endblock %}

core/templates/core/macros.jinja

@@ -118,21 +118,20 @@
   </nav>
 {% endmacro %}
 
-{% macro paginate_jinja(request, current_page, paginator) %}
+{% macro paginate_jinja(current_page, paginator) %}
     {# Add pagination buttons for pages without Alpine.
 
     This must be coupled with a view that handles pagination
     with the Django Paginator object.
 
     Parameters:
-        request (django.http.request.HttpRequest): the current django request
         current_page (django.core.paginator.Page): the current page object
         paginator (django.core.paginator.Paginator): the paginator object
     #}
-  {{ paginate_server_side(request, current_page, paginator, False) }}
+  {{ paginate_server_side(current_page, paginator, False) }}
 {% endmacro %}
 
-{% macro paginate_htmx(request, current_page, paginator) %}
+{% macro paginate_htmx(current_page, paginator) %}
     {# Add pagination buttons for pages without Alpine but supporting fragments.
 
     This must be coupled with a view that handles pagination
@@ -141,25 +140,24 @@
     The replaced fragment will be #content so make sure you are calling this macro inside your content block.
 
     Parameters:
-        request (django.http.request.HttpRequest): the current django request
         current_page (django.core.paginator.Page): the current page object
         paginator (django.core.paginator.Paginator): the paginator object
     #}
-  {{ paginate_server_side(request, current_page, paginator, True) }}
+  {{ paginate_server_side(current_page, paginator, True) }}
 {% endmacro %}
 
-{% macro paginate_server_side(request, current_page, paginator, use_htmx) %}
+{% macro paginate_server_side(current_page, paginator, use_htmx) %}
   <nav class="pagination">
     {% if current_page.has_previous() %}
       <a
         {% if use_htmx -%}
-          hx-get="?{{ querystring(request, page=current_page.previous_page_number()) }}"
+          hx-get="?{{ querystring(page=current_page.previous_page_number()) }}"
           hx-swap="innerHTML"
           hx-target="#content"
           hx-push-url="true"
           hx-trigger="click, keyup[key=='ArrowLeft'] from:body"
         {%- else -%}
-          href="?{{ querystring(request, page=current_page.previous_page_number()) }}"
+          href="?{{ querystring(page=current_page.previous_page_number()) }}"
         {%- endif -%}
       >
         <button>
@@ -177,12 +175,12 @@
       {% else %}
         <a
           {% if use_htmx -%}
-            hx-get="?{{ querystring(request, page=i) }}"
+            hx-get="?{{ querystring(page=i) }}"
             hx-swap="innerHTML"
             hx-target="#content"
             hx-push-url="true"
           {%- else -%}
-            href="?{{ querystring(request, page=i) }}"
+            href="?{{ querystring(page=i) }}"
           {%- endif -%}
         >
           <button>{{ i }}</button>
@@ -192,13 +190,13 @@
     {% if current_page.has_next() %}
       <a
         {% if use_htmx -%}
-          hx-get="?{{querystring(request, page=current_page.next_page_number())}}"
+          hx-get="?{{querystring(page=current_page.next_page_number())}}"
           hx-swap="innerHTML"
           hx-target="#content"
           hx-push-url="true"
           hx-trigger="click, keyup[key=='ArrowRight'] from:body"
         {%- else -%}
-          href="?{{querystring(request, page=current_page.next_page_number())}}"
+          href="?{{querystring(page=current_page.next_page_number())}}"
         {%- endif -%}
       ><button>
         <i class="fa fa-caret-right"></i>
@@ -249,8 +247,15 @@
 {% endmacro %}
 
 
-{% macro querystring(request) %}
-  {%- set qs = request.GET.copy() -%}
-  {%- do qs.update(kwargs) -%}
-  {{- qs | urlencode -}}
+{% macro querystring() %}
+  {%- for key, values in request.GET.lists() -%}
+    {%- if key not in kwargs -%}
+      {%- for value in values -%}
+        {{ key }}={{ value }}&amp;
+      {%- endfor -%}
+    {%- endif -%}
+  {%- endfor -%}
+  {%- for key, value in kwargs.items() -%}
+    {{ key }}={{ value }}&amp;
+  {%- endfor -%}
 {% endmacro %}

core/templates/core/user_preferences.jinja

@@ -1,14 +1,7 @@
 {% extends "core/base.jinja" %}
 
-{%- block additional_js -%}
-  <script type="module" src="{{ static("bundled/core/components/ajax-select-index.ts") }}"></script>
-{%- endblock -%}
-
 {%- block additional_css -%}
   <link rel="stylesheet" href="{{ static('user/user_preferences.scss') }}">
-  {# importing ajax-select-index is necessary for it to be applied after HTMX reload #}
-  <link rel="stylesheet" href="{{ static("bundled/core/components/ajax-select-index.css") }}">
-  <link rel="stylesheet" href="{{ static("core/components/ajax-select.scss") }}">
 {%- endblock -%}
 
 {% block title %}

counter/templates/counter/cash_summary_list.jinja

@@ -57,7 +57,7 @@
     </table>
     <br>
     {% if is_paginated %}
-      {{ paginate_jinja(request, page_obj, paginator) }}
+      {{ paginate_jinja(page_obj, paginator) }}
     {% endif %}
   {% else %}
     {% trans %}There is no cash register summary in this website.{% endtrans %}

counter/templates/counter/refilling_list.jinja

@@ -28,7 +28,7 @@
       {%- endfor %}
     </table>
     {% if is_paginated %}
-      {{ paginate_jinja(request, page_obj, paginator) }}
+      {{ paginate_jinja(page_obj, paginator) }}
     {% endif %}
 {%- endblock %}
 

election/templates/election/election_list.jinja

@@ -46,7 +46,7 @@
     </section>
   {%- endfor %}
   {% if is_paginated %}
-    {{ paginate_jinja(request, page_obj, paginator) }}
+    {{ paginate_jinja(page_obj, paginator) }}
   {% endif %}
 {%- endblock %}
 

forum/templates/forum/topic.jinja

@@ -27,7 +27,7 @@
     </p>
 
     {{ display_search_bar(request) }}
-    {{ paginate_jinja(request, msgs, msgs.paginator) }}
+    {{ paginate_jinja(msgs, msgs.paginator) }}
 
     <main class="message-list">
       {% for m in msgs %}
@@ -44,9 +44,7 @@
 
     <p><a class="ib button" href="{{ url('forum:new_message', topic_id=topic.id) }}">{% trans %}Reply{% endtrans %}</a></p>
 
-    {% if is_paginated %}
-      {{ paginate_jinja(request, msgs, msgs.paginator) }}
-    {% endif %}
+    {{ paginate_jinja(msgs, msgs.paginator) }}
   </div>
 {% endblock %}
 

rootplace/templates/rootplace/logs.jinja

@@ -28,7 +28,5 @@
   </table>
 
   <br>
-  {% if is_paginated %}
-    {{ paginate_jinja(request, page_obj, paginator) }}
-  {% endif %}
+  {{ paginate_jinja(page_obj, paginator) }}
 {% endblock content %}

subscription/templates/subscription/subscription.jinja

@@ -6,14 +6,8 @@
   {% trans %}New subscription{% endtrans %}
 {% endblock %}
 
-{# The following statics are bundled with our autocomplete select.
-   However, if one tries to swap a form by another, then the urls in script-once
-   and link-once disappear.
-   So we give them here.
-   If the aforementioned bug is resolved, you can remove this. #}
 {% block additional_js %}
   <script type="module" src="{{ static('bundled/core/components/tabs-index.ts') }}"></script>
-  <script type="module" src="{{ static("bundled/core/components/ajax-select-index.ts") }}"></script>
   <script
     type="module"
     src="{{ static("bundled/subscription/creation-form-existing-user-index.ts") }}"
@@ -21,8 +15,6 @@
 {% endblock %}
 {% block additional_css %}
   <link rel="stylesheet" href="{{ static("core/components/tabs.scss") }}">
-  <link rel="stylesheet" href="{{ static("bundled/core/components/ajax-select-index.css") }}">
-  <link rel="stylesheet" href="{{ static("core/components/ajax-select.scss") }}">
   <link rel="stylesheet" href="{{ static("subscription/css/subscription.scss") }}">
 {% endblock %}