feat(pat ajax): Allow caching of ajax requests by using the option cache which can be set to caching or no-caching.

Author: thet

src/pat/ajax/ajax.js

@@ -18,11 +18,7 @@ parser.addArgument("url", function ($el) {
         $el.is("a") ? $el.attr("href") : $el.is("form") ? $el.attr("action") : ""
     ).split("#")[0];
 });
-
-$.ajaxSetup({
-    // Disable caching of AJAX responses
-    cache: false,
-});
+parser.addArgument("browser-cache", "no-cache", ["cache", "no-cache"]); // Cache ajax requests
 
 const xhrCount = {};
 xhrCount.get = function (a) {
@@ -104,6 +100,7 @@ const _ = {
             headers: {},
             url: cfg.url,
             method: $el.attr("method") ? $el.attr("method") : "GET",
+            cache: cfg.browserCache === "cache" ? true : false,
         };
 
         if (cfg.accept) {

src/pat/ajax/ajax.test.js

@@ -154,4 +154,62 @@ describe("pat-ajax", function () {
             expect(ajaxargs.headers).toEqual({ Accept: "*/*" });
         });
     });
+
+    describe("caching", () => {
+        afterEach(function () {
+            document.body.innerHTML = "";
+        });
+
+        it("does not cache by default", function () {
+            const spy_ajax = jest.spyOn($, "ajax");
+            document.body.innerHTML = `<a
+                class="pat-ajax"
+                />`;
+            registry.scan(document.body);
+            document.body.querySelector(".pat-ajax").click();
+            const ajaxargs = spy_ajax.mock.calls[spy_ajax.mock.calls.length - 1][0];
+            expect(ajaxargs.cache).toBe(false);
+            spy_ajax.mockRestore();
+        });
+
+        it("does not cache when explicitly set", function () {
+            const spy_ajax = jest.spyOn($, "ajax");
+            document.body.innerHTML = `<a
+                class="pat-ajax"
+                data-pat-ajax="browser-cache: no-cache"
+                />`;
+            registry.scan(document.body);
+            document.body.querySelector(".pat-ajax").click();
+            const ajaxargs = spy_ajax.mock.calls[spy_ajax.mock.calls.length - 1][0];
+            expect(ajaxargs.cache).toBe(false);
+            spy_ajax.mockRestore();
+        });
+
+        it("does cache when explicitly set", function () {
+            const spy_ajax = jest.spyOn($, "ajax");
+            document.body.innerHTML = `<a
+                class="pat-ajax"
+                data-pat-ajax="browser-cache: cache"
+                />`;
+            registry.scan(document.body);
+            document.body.querySelector(".pat-ajax").click();
+            const ajaxargs = spy_ajax.mock.calls[spy_ajax.mock.calls.length - 1][0];
+            expect(ajaxargs.cache).toBe(true);
+            spy_ajax.mockRestore();
+        });
+
+        it("does not cache on POST forms, regardless of the setting", function () {
+            const spy_ajax = jest.spyOn($, "ajax");
+            document.body.innerHTML = `<form
+                class="pat-ajax"
+                method="POST"
+                data-pat-ajax="browser-cache: cache"
+                />`;
+            registry.scan(document.body);
+            $(".pat-ajax").submit(); // need jquery submit here
+            const ajaxargs = spy_ajax.mock.calls[spy_ajax.mock.calls.length - 1][0];
+            expect(ajaxargs.cache).toBe(false);
+            spy_ajax.mockRestore();
+        });
+    });
 });