Bugfix/preloaded resource not used (#2207)

tvdijen · web-flow · commit 5b8fea3defac · 2024-08-20T20:35:04.000+02:00
* Add possibility to remove the tag from assets

* Preloaded files cannot have request parameters; remove tag

* Change order: preloading must be done after referencing the resource (in the stylesheet in this case)

* Add comment

* coding style

* phpcs
diff --git a/src/SimpleSAML/XHTML/Template.php b/src/SimpleSAML/XHTML/Template.php
@@ -170,9 +170,10 @@ class_exists($controller)
      * the original file.
      * @param string $asset
      * @param string|null $module
+     * @param bool $tag
      * @return string
      */
-    public function asset(string $asset, string $module = null): string
+    public function asset(string $asset, string $module = null, bool $tag = true): string
     {
         $baseDir = $this->configuration->getBaseDir();
         $basePath = $this->configuration->getBasePath();
@@ -191,6 +192,12 @@ public function asset(string $asset, string $module = null): string
             // don't be too harsh if an asset is missing, just pretend it's there...
             return $path;
         }
+
+        if ($tag === false) {
+            // The asset is requested without a tag
+            return $path;
+        }
+
         $file = new File($file);
 
         $tag = $this->configuration->getVersion();
diff --git a/templates/base.twig b/templates/base.twig
@@ -6,9 +6,10 @@
     <meta name="viewport" content="initial-scale=1.0">
     <meta http-equiv="X-UA-Compatible" content="IE=Edge">
     <title>{{ pagetitle }}</title>
-    <link rel="preload" href="{{ asset('fonts/fa-solid-900.woff2') }}" as="font" type="font/woff2" crossorigin>
     <link rel="stylesheet" href="{{ asset("css/stylesheet.css") }}">
     <link rel="icon" href="{{ asset("icons/favicon.ico") }}">
+    {# Preloading must be done after referencing the resource #}
+    <link rel="preload" href="{{ asset('fonts/fa-solid-900.woff2', null, false) }}" as="font" type="font/woff2" crossorigin>
     <meta name="robots" content="noindex, nofollow">
     {{ include('_head.twig', ignore_missing = true) }}
     {% block preload %}{% endblock %}
