pat-inject - Better Error Reporting on inject

thet · thet · commit 4b398c7eebb7 · 2021-01-15T11:58:08.000+01:00
Change the meta tag name from ``pat-inject-STATUSCODE`` to ``pat-inject-status-STATUSCODE``.

pat inject: Allow configurable error pages by defining the error page URLs via meta tags with the name ``pat-inject-status-``.
Can be disabled by adding ``pat-inject-errorhandler.off`` to the URL's query string.
diff --git a/CHANGES.md b/CHANGES.md
@@ -54,7 +54,8 @@
 -   pat tabs: Refactor based on ``ResizeObserver`` and fix problems calculating the with with transitions.
 -   pat tabs: When clicking on the ``extra-tabs`` element, toggle between ``open`` and ``closed`` classes to allow opening/closing an extra-tabs menu via CSS.
 -   pat autofocus: Do not autofocus in iframes. Fixes: #761.
--   pat inject: Allow configurable error pages. Can be disabled by adding ``pat-inject-errorhandler.off`` to the URL's query string.
+-   pat inject: Allow configurable error pages by defining the error page URLs via meta tags with the name ``pat-inject-status-``.
+    Can be disabled by adding ``pat-inject-errorhandler.off`` to the URL's query string.
 -   core utils: Add ``jqToNode`` to return a DOM node if a jQuery node was passed.
 -   pat inject: Rebase URLs in pattern configuration attributes. This avoids URLs in pattern configuration to point to unreachable paths in the context where the result is injected into.
 
diff --git a/src/pat/inject/documentation.md b/src/pat/inject/documentation.md
@@ -328,10 +328,10 @@ After injection was triggered:
 In cases of AJAX errors, you can provide custom error pages by providing custom meta tags.
 For example, if you add this meta tag to the html ``<head>``:
 
-    <meta name="pat-inject-404" content="/test_404.html" />
+    <meta name="pat-inject-status-404" content="/test_404.html" />
 
 Then, in case of a ``404`` error, it will try to retrieve the error page and replace the document body contents with the body contents of the error page.
-The code looks for a meta tag with the name ``pat-inject-`` plus the HTTP status code.
+The code looks for a meta tag with the name ``pat-inject-status-`` plus the HTTP status code.
 
 Another example: You can present the user with a login page in case the session has expired (``401`` error).
 
diff --git a/src/pat/inject/index.html b/src/pat/inject/index.html
@@ -8,7 +8,7 @@
         <meta name="patterns-push-login" content="guest" />
         <meta name="patterns-push-password" content="guest" />
         <meta name="patterns-push-user-id" content="allan_neece" />
-        <meta name="pat-inject-404" content="./test_404.html" />
+        <meta name="pat-inject-status-404" content="./test_404.html" />
         <title>Injection pattern</title>
         <link rel="stylesheet" href="/style/common.css" type="text/css" />
         <script
diff --git a/src/pat/inject/inject.js b/src/pat/inject/inject.js
@@ -683,7 +683,7 @@ const inject = {
         const url_params = new URLSearchParams(window.location.search);
 
         const fallback_url = document
-            .querySelector(`meta[name=pat-inject-${status}]`)
+            .querySelector(`meta[name=pat-inject-status-${status}]`)
             ?.getAttribute("content", false);
         if (
             fallback_url &&
diff --git a/src/pat/inject/inject.test.js b/src/pat/inject/inject.test.js
@@ -994,7 +994,7 @@ describe("pat-inject", function () {
 
             // apparently <head> is empty if we do not set it.
             document.head.innerHTML = `
-                <meta name="pat-inject-404" content="/404.html" />
+                <meta name="pat-inject-status-404" content="/404.html" />
             `;
 
             pattern.init($a);
@@ -1035,7 +1035,7 @@ describe("pat-inject", function () {
 
             // apparently <head> is empty if we do not set it.
             document.head.innerHTML = `
-                <meta name="pat-inject-404" content="/404.html" />
+                <meta name="pat-inject-status-404" content="/404.html" />
             `;
 
             pattern.init($a);
