pat inject: Allow configurable error pages. Can be disabled by adding pat-inject-errorhandler.off to the URL's query string.

thet · thet · commit 46dee877e247 · 2020-12-16T12:33:52.000+01:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -54,7 +54,7 @@
 -   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.
+-   pat inject: Allow configurable error pages. Can be disabled by adding ``pat-inject-errorhandler.off`` to the URL's query string.
 
 ### Technical
 
diff --git a/src/pat/inject/documentation.md b/src/pat/inject/documentation.md
@@ -335,6 +335,9 @@ The code looks for a meta tag with the name ``pat-inject-`` plus the HTTP status
 
 Another example: You can present the user with a login page in case the session has expired (``401`` error).
 
+You can disable this behavior for debugging by adding the following parameter to the query string:
+``pat-inject-errorhandler.off``.
+
 ### Options reference
 
 You can customise the behaviour of injection through options in the `data-pat-inject` attribute.
diff --git a/src/pat/inject/inject.js b/src/pat/inject/inject.js
@@ -677,10 +677,15 @@ const inject = {
                 "It seems, the server is down. Please make a screenshot and contact support. Thank you!";
         }
 
+        const url_params = new URLSearchParams(window.location.search);
+
         const fallback_url = document
             .querySelector(`meta[name=pat-inject-${status}]`)
             ?.getAttribute("content", false);
-        if (fallback_url) {
+        if (
+            fallback_url &&
+            url_params.get("pat-inject-errorhandler.off") === null
+        ) {
             try {
                 const fallback_response = await fetch(fallback_url, {
                     method: "GET",
diff --git a/src/pat/inject/inject.test.js b/src/pat/inject/inject.test.js
@@ -973,5 +973,50 @@ describe("pat-inject", function () {
 
             done();
         });
+
+        it("Doesnt get error page from meta tags if query string present", async (done) => {
+            delete global.window.location;
+            global.window.location = {
+                search: "?something=nothing&pat-inject-errorhandler.off",
+            };
+
+            global.fetch = jest.fn().mockImplementation(
+                mockFetch(`
+                        <!DOCTYPE html>
+                        <html>
+                          <head>
+                            <title>404</title>
+                          </head>
+                          <body>
+                            <h1>oh-nose!</h1>
+                          </body>
+                        </html>
+                    `)
+            );
+
+            // apparently <head> is empty if we do not set it.
+            document.head.innerHTML = `
+                <meta name="pat-inject-404" content="/404.html" />
+            `;
+
+            pattern.init($a);
+
+            // Invoke error case
+            pattern._onInjectError($a, [], {
+                jqxhr: { status: 404 },
+            });
+            await utils.timeout(1); // wait a tick for async to settle.
+
+            expect(document.body.querySelector("#lab")).toBeTruthy();
+            // In this case, the normal error reporting is used
+            expect(
+                document.body.hasAttribute("data-error-message")
+            ).toBeTruthy();
+
+            global.fetch.mockClear();
+            delete global.fetch;
+
+            done();
+        });
     });
 });
