Move script blocks into separate JavaScript files

Author: TheSyscall

library/Pdfexport/Backend/Chromedriver.php

@@ -6,6 +6,7 @@
 namespace Icinga\Module\Pdfexport\Backend;
 
 use Exception;
+use Icinga\Application\Icinga;
 use Icinga\Module\Pdfexport\ChromeDevTools\ChromeDevTools;
 use Icinga\Module\Pdfexport\ChromeDevTools\Command as DevToolsCommand;
 use Icinga\Module\Pdfexport\WebDriver\Command;
@@ -17,38 +18,6 @@ class Chromedriver extends WebdriverBackend
 {
     protected ?ChromeDevTools $dcp = null;
 
-    public const ACTIVATE_SCRIPTS = <<<JS
-function activateScripts(node) {
-    if (isScript(node) === true) {
-        node.parentNode.replaceChild(cloneScript(node) , node);
-    } else {
-        var i = -1, children = node.childNodes;
-        while (++i < children.length) {
-              activateScripts(children[i]);
-        }
-    }
-
-    return node;
-}
-
-function cloneScript(node) {
-    var script  = document.createElement("script");
-    script.text = node.innerHTML;
-
-    var i = -1, attrs = node.attributes, attr;
-    while (++i < attrs.length) {                                    
-          script.setAttribute((attr = attrs[i]).name, attr.value);
-    }
-    return script;
-}
-
-function isScript(node) {
-    return node.tagName === 'SCRIPT';
-}
-
-activateScripts(document.documentElement);
-JS;
-
     public function __construct(string $url)
     {
         parent::__construct($url, Capabilities::chrome());
@@ -58,8 +27,17 @@ protected function setContent(PrintableHtmlDocument $document): void
     {
         parent::setContent($document);
 
+        $module = Icinga::app()->getModuleManager()->getModule('pdfexport');
+        if (! method_exists($module, 'getJsDir')) {
+            $jsPath = join(DIRECTORY_SEPARATOR, [$module->getBaseDir(), 'public', 'js']);
+        } else {
+            $jsPath = $module->getJsDir();
+        }
+
+        $activeScripts = file_get_contents($jsPath . '/activate-scripts.js');
+
         $this->driver->execute(
-            Command::executeScript(self::ACTIVATE_SCRIPTS),
+            Command::executeScript($activeScripts),
         );
         $this->driver->execute(
             Command::executeScript('new Layout().apply();'),

library/Pdfexport/Backend/HeadlessChromeBackend.php

@@ -8,6 +8,7 @@
 use Exception;
 use GuzzleHttp\Client as HttpClient;
 use GuzzleHttp\Exception\ServerException;
+use Icinga\Application\Icinga;
 use Icinga\Application\Logger;
 use Icinga\Application\Platform;
 use Icinga\File\Storage\StorageInterface;
@@ -47,26 +48,6 @@ class HeadlessChromeBackend implements PfdPrintBackend
     /** @var string */
     public const WAIT_FOR_NETWORK = 'wait-for-network';
 
-    /** @var string Javascript Promise to wait for layout initialization */
-    public const WAIT_FOR_LAYOUT = <<<JS
-new Promise((fulfill, reject) => {
-    let timeoutId = setTimeout(() => reject('fail'), 10000);
-
-    if (document.documentElement.dataset.layoutReady === 'yes') {
-        clearTimeout(timeoutId);
-        fulfill(null);
-        return;
-    }
-
-    document.addEventListener('layout-ready', e => {
-        clearTimeout(timeoutId);
-        fulfill(e.detail);
-    }, {
-        once: true
-    });
-})
-JS;
-
     protected ?StorageInterface $fileStorage = null;
 
     protected bool $useFilesystemTransfer = false;
@@ -469,11 +450,20 @@ protected function setContent(PrintableHtmlDocument $document): void
                 'expression' => 'setTimeout(() => new Layout().apply(), 0)',
             ]);
 
+            $module = Icinga::app()->getModuleManager()->getModule('pdfexport');
+            if (! method_exists($module, 'getJsDir')) {
+                $jsPath = join(DIRECTORY_SEPARATOR, [$module->getBaseDir(), 'public', 'js']);
+            } else {
+                $jsPath = $module->getJsDir();
+            }
+
+            $waitForLayout = file_get_contents($jsPath . '/wait-for-layout.js');
+
             $promisedResult = $this->communicate($page, 'Runtime.evaluate', [
                 'awaitPromise'  => true,
                 'returnByValue' => true,
                 'timeout'       => 1000, // Failsafe: doesn't apply to `await` it seems
-                'expression'    => static::WAIT_FOR_LAYOUT,
+                'expression'    => $waitForLayout,
             ]);
             if (isset($promisedResult['exceptionDetails'])) {
                 if (isset($promisedResult['exceptionDetails']['exception']['description'])) {

public/js/activate-scripts.js

@@ -0,0 +1,32 @@
+// SPDX-FileCopyrightText: 2026 Icinga GmbH <https://icinga.com>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+function activateScripts(node) {
+    if (isScript(node) === true) {
+        node.parentNode.replaceChild(cloneScript(node) , node);
+    } else {
+        var i = -1, children = node.childNodes;
+        while (++i < children.length) {
+            activateScripts(children[i]);
+        }
+    }
+
+    return node;
+}
+
+function cloneScript(node) {
+    var script  = document.createElement("script");
+    script.text = node.innerHTML;
+
+    var i = -1, attrs = node.attributes, attr;
+    while (++i < attrs.length) {
+        script.setAttribute((attr = attrs[i]).name, attr.value);
+    }
+    return script;
+}
+
+function isScript(node) {
+    return node.tagName === 'SCRIPT';
+}
+
+activateScripts(document.documentElement);

public/js/wait-for-layout.js

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: 2026 Icinga GmbH <https://icinga.com>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+new Promise((fulfill, reject) => {
+    let timeoutId = setTimeout(() => reject('fail'), 10000);
+
+    if (document.documentElement.dataset.layoutReady === 'yes') {
+        clearTimeout(timeoutId);
+        fulfill(null);
+        return;
+    }
+
+    document.addEventListener('layout-ready', e => {
+        clearTimeout(timeoutId);
+        fulfill(e.detail);
+    }, {
+        once: true
+    });
+})