From 860bf6b2a67a2c28b849d4f7140de93daeda935e Mon Sep 17 00:00:00 2001
From: agneszitte <agnes@platform.uno>
Date: Tue, 9 Jul 2024 00:27:48 -0400
Subject: [PATCH] fix: Replace deprecated DOMNodeInserted with MutationObserver
 for Algolia DocSearch initialization

- Removed deprecated DOMNodeInserted event listener
- Implemented MutationObserver to monitor changes in the DOM
- Added error handling for better debugging
- Ensured observation starts only after DOM is fully loaded
- Included comments for better code understanding and future updates
---
 .../uno/partials/scripts.tmpl.partial         | 122 +++++++++++++++---
 1 file changed, 106 insertions(+), 16 deletions(-)

diff --git a/doc/templates/uno/partials/scripts.tmpl.partial b/doc/templates/uno/partials/scripts.tmpl.partial
index b7f6f98babf0..1732f89b5510 100644
--- a/doc/templates/uno/partials/scripts.tmpl.partial
+++ b/doc/templates/uno/partials/scripts.tmpl.partial
@@ -16,30 +16,120 @@ startOnLoad: false
 });
 mermaid.init(undefined, ".lang-mermaid");
 </script>
+
 <!-- Algolia DocSearch -->
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
 <script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
 <script>
-    function handleCreateSearchBox(){
-      if (document.getElementById("docsearch")){
-        if (document.getElementById("docsearch").children.length>0)
-        {
-          document.removeEventListener('DOMNodeInserted', handleCreateSearchBox);
+    /**
+     * Initialize Algolia DocSearch
+     * This function initializes DocSearch for the element with id 'docsearch'.
+     */
+    function initializeDocSearch() {
+        console.log("initializeDocSearch called");
+        try {
+            const searchBox = document.getElementById("docsearch");
+
+            if (searchBox) {
+                console.log("Found 'docsearch' element");
+                // Check if the search box is already initialized
+                if (searchBox.children.length > 0) {
+                    console.log("Search box already initialized.");
+                    // Disconnect the observer if search box is already initialized
+                    if (observer) {
+                        observer.disconnect();
+                        console.log("MutationObserver disconnected.");
+                    }
+                } else {
+                    // Initialize DocSearch if not already initialized
+                    console.log("Initializing DocSearch...");
+                    docsearch({
+                        container: '#docsearch',
+                        appId: 'PHB9D8WS99',
+                        indexName: 'platform',
+                        apiKey: '7877394996f96cde1a9b795dce3f7787',
+                        placeholder: 'Search Docs...'
+                    });
+                    console.log("DocSearch initialized.");
+                    // Disconnect the observer after initialization
+                    if (observer) {
+                        observer.disconnect();
+                        console.log("MutationObserver disconnected.");
+                    }
+                }
+            } else {
+                console.warn("'docsearch' element not found.");
+            }
+        } catch (error) {
+            console.error("Error initializing DocSearch:", error);
         }
-        else {
-          docsearch({
-            container: '#docsearch',
-            appId: 'PHB9D8WS99',
-            indexName: 'platform',
-            apiKey: '7877394996f96cde1a9b795dce3f7787',
-            placeholder: 'Search Docs...'
-          });
-          console.log(docsearch);
+    }
+
+    /**
+     * Set up MutationObserver to watch for additions to the DOM
+     * This function sets up a MutationObserver to monitor the entire document for added nodes.
+     * If the 'docsearch' element is added, it will call initializeDocSearch().
+     */
+    let observer;
+    function observeDocSearch() {
+        observer = new MutationObserver((mutations) => {
+            mutations.forEach((mutation) => {
+                if (mutation.addedNodes.length) {
+                    mutation.addedNodes.forEach((node) => {
+                        // Check if the added node is the 'docsearch' element
+                        if (node.id === 'docsearch') {
+                            console.log("'docsearch' element added to DOM");
+                            initializeDocSearch();
+                        }
+                    });
+                }
+            });
+        });
+
+        // Observe the entire document for child additions
+        observer.observe(document.body, {
+            childList: true,
+            subtree: true
+        });
+
+        console.log("MutationObserver set up to observe 'docsearch' element");
+    }
+
+    /**
+     * Retry initialization using requestAnimationFrame
+     * This function tries to initialize DocSearch using requestAnimationFrame for better timing handling for some browsers like Firefox.
+     */
+    function retryInitialization() {
+        if (!document.getElementById('docsearch')) {
+            console.log("Retrying DocSearch initialization using requestAnimationFrame");
+            requestAnimationFrame(retryInitialization);
+        } else {
+            initializeDocSearch();
         }
-      }
     }
-    window.addEventListener('DOMNodeInserted', handleCreateSearchBox);
+
+    /**
+     * Load event handler
+     * This function handles the load event to ensure the entire page is fully loaded.
+     * It then checks if the 'docsearch' element is present and initializes DocSearch.
+     * If the element is not present, it sets up the MutationObserver and starts the retry mechanism.
+     */
+    window.addEventListener('load', () => {
+        console.log("Load event fired");
+
+        // Check if the 'docsearch' element already exists in the DOM
+        if (document.getElementById('docsearch')) {
+            console.log("'docsearch' element already present in DOM");
+            initializeDocSearch();
+        } else {
+            console.log("'docsearch' element not present in DOM, setting up MutationObserver");
+            observeDocSearch();
+            // Start retrying using requestAnimationFrame
+            retryInitialization();
+        }
+    });
 </script>
+
 <!-- Easy-copy-code -->
 <script>
 $(function() {