Merge pull request #13 from thavelick/environment_aware_caching

Implement environment-aware PWA caching

Author: thavelick

CLAUDE.md

@@ -119,5 +119,11 @@ Before any commit:
 ### CSS Guidelines
 - Always put styles in style.css, never inline
 
+### PWA Caching Control
+Development caching behavior can be controlled via URL parameters:
+- Default: No caching on localhost/127.0.0.1/192.168.x (dev-friendly)
+- `?cache=force` - Enable caching on local development
+- `?cache=disable` - Disable caching in production (for testing)
+
 ### Implementation Planning Process
 When asked to plan an implementation, follow the standardized process documented in `PLANNING.md`.

public_html/search.js

@@ -187,8 +187,25 @@ async function registerServiceWorker(windowObj = window) {
   }
 }
 
+function shouldEnableCaching(windowObj = window) {
+  const urlParams = new URLSearchParams(windowObj.location.search);
+  const cacheParam = urlParams.get("cache");
+
+  // Explicit override via URL parameter
+  if (cacheParam === "force") return true;
+  if (cacheParam === "disable") return false;
+
+  // Default: disable caching on local development
+  const isLocal =
+    windowObj.location.hostname === "localhost" ||
+    windowObj.location.hostname === "127.0.0.1" ||
+    windowObj.location.hostname.startsWith("192.168.");
+
+  return !isLocal;
+}
+
 function initializePWA(windowObj = window) {
-  if (isServiceWorkerSupported(windowObj)) {
+  if (isServiceWorkerSupported(windowObj) && shouldEnableCaching(windowObj)) {
     registerServiceWorker(windowObj);
   }
 }
@@ -310,5 +327,6 @@ if (typeof module !== "undefined" && module.exports) {
     showSaveMessage,
     setupSettingsEventListeners,
     initializeSettings,
+    shouldEnableCaching,
   };
 }

public_html/service-worker-lib.js

@@ -1,4 +1,4 @@
-const STATIC_CACHE_NAME = "just-bangs-static-v6";
+const STATIC_CACHE_NAME = "just-bangs-static-v7";
 
 const STATIC_ASSETS = [
   "./",

tests/search.spec.js

@@ -18,6 +18,7 @@ const {
   showSaveMessage,
   setupSettingsEventListeners,
   initializeSettings,
+  shouldEnableCaching,
 } = require("../public_html/search.js");
 
 describe("buildSearchUrl", () => {
@@ -532,6 +533,10 @@ describe("PWA Functions", () => {
             register: mockRegister,
           },
         },
+        location: {
+          search: "",
+          hostname: "example.com",
+        },
       };
 
       initializePWA(mockWindow);
@@ -804,4 +809,32 @@ describe("Settings Functions", () => {
       expect(() => initializeSettings(mockWindow)).not.toThrow();
     });
   });
+
+  describe("shouldEnableCaching", () => {
+    const testCases = [
+      // [hostname, queryString, expected, description]
+      ["localhost", "?cache=force", true, "cache=force parameter returns true"],
+      [
+        "example.com",
+        "?cache=disable",
+        false,
+        "cache=disable parameter returns false",
+      ],
+      ["localhost", "", false, "localhost hostname returns false"],
+      ["127.0.0.1", "", false, "127.0.0.1 hostname returns false"],
+      ["192.168.1.100", "", false, "192.168.x hostname returns false"],
+      ["example.com", "", true, "production hostname returns true"],
+    ];
+
+    test.each(testCases)(
+      "hostname: %s, query: %s -> %s (%s)",
+      (hostname, search, expected, _description) => {
+        const mockWindow = {
+          location: { hostname, search },
+        };
+
+        expect(shouldEnableCaching(mockWindow)).toBe(expected);
+      },
+    );
+  });
 });