@valentinkolb/ssr 0.11.0 → 0.11.1

package/README.md

@@ -21,8 +21,8 @@ Current source size in this repo (`packages/ssr-core/src`):
 | Component | Lines | Raw | Gzipped |
 | --- | ---: | ---: | ---: |
 | Core (`index`, `transform`, `build`, island ID + resolver) | ~689 | 23.8 KB | 7.2 KB |
-| Dev client (overlay + reload, dev only) | ~211 | 6.1 KB | 2.0 KB |
-| Adapters (`bun`, `hono`, `elysia`, shared utils) | ~355 | 10.4 KB | 3.3 KB |
+| Dev client (overlay + reload, dev only) | ~421 | 11.9 KB | 3.5 KB |
+| Adapters (`bun`, `hono`, `elysia`, shared utils) | ~465 | 14.4 KB | 4.8 KB |
 
 Important: these sizes describe framework source code that runs at build time and on the server.
 The browser receives only:
@@ -358,6 +358,12 @@ It can:
 - highlight island/client boundaries
 - show source filenames for wrapped components
 
+In browsers with Web Locks support, auto-reload elects one visible tab per
+origin and SSR path to hold the SSE connection. Hidden tabs suspend reload work,
+leadership transfers automatically, and cached pages resume safely after a
+back-forward cache restore. Browsers without Web Locks retain visibility-scoped
+per-tab connections as a compatibility fallback.
+
 ## Limitations
 
 - islands must use default export

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valentinkolb/ssr",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Minimal SSR framework for SolidJS and Bun",
   "type": "module",
   "main": "src/index.ts",

package/src/adapter/bun.ts

@@ -5,6 +5,7 @@
 import type { SsrConfig } from "../index";
 import {
   createAssetResponse,
+  createPingResponse,
   getSsrDir,
   createReloadResponse,
 } from "./utils";
@@ -32,8 +33,8 @@ export const routes = (config: SsrConfig): Routes => {
 
   const devRoutes: Routes = dev
     ? {
-        [`${ssrPath}/_reload`]: () => createReloadResponse(),
-        [`${ssrPath}/_ping`]: () => new Response("ok"),
+        [`${ssrPath}/_reload`]: (req) => createReloadResponse(req.signal),
+        [`${ssrPath}/_ping`]: () => createPingResponse(),
       }
     : {};
 

package/src/adapter/client.js

@@ -14,11 +14,31 @@ if (!window.__ssr_reload) {
       position: "bl",
     };
 
-    const load = () => ({
-      ...defaults,
-      ...JSON.parse(localStorage.getItem(STORAGE_KEY) || "{}"),
-    });
-    const save = (s) => localStorage.setItem(STORAGE_KEY, JSON.stringify(s));
+    const readStorage = (key) => {
+      try {
+        return localStorage.getItem(key);
+      } catch {
+        return null;
+      }
+    };
+    const writeStorage = (key, value) => {
+      try {
+        localStorage.setItem(key, value);
+      } catch {
+        // Dev tools still work when storage is unavailable.
+      }
+    };
+    const load = () => {
+      try {
+        return {
+          ...defaults,
+          ...JSON.parse(readStorage(STORAGE_KEY) || "{}"),
+        };
+      } catch {
+        return { ...defaults };
+      }
+    };
+    const save = (s) => writeStorage(STORAGE_KEY, JSON.stringify(s));
     let settings = load();
 
     // Highlight Styles
@@ -152,10 +172,23 @@ if (!window.__ssr_reload) {
     bind("_ssr_pos", "position", applyPosition);
 
     // Live Reload (SSE)
-    let es, reconnectInterval, animationInterval;
+    const reloadId = globalThis.__SSR_CONFIG?.reloadId;
+    const reloadIdKey = `${STORAGE_KEY}:reload-id`;
+    const reloadLockName = `${STORAGE_KEY}:reload-lock`;
+    let es, retryTimer, retryController, animationInterval;
+    let lockController, releaseLock;
+    let retryAttempt = 0;
+    let retryGeneration = 0;
+    let ownsLock = false;
+    let pageActive = true;
+    let reloadRequested = false;
     const spinFrames = ["[ / ]", "[ – ]", "[ \\ ]", "[ | ]"];
     let spinIndex = 0;
 
+    // A fresh document already represents this server generation. Publishing
+    // it first wakes stale tabs without making the fresh document reload.
+    if (reloadId) writeStorage(reloadIdKey, reloadId);
+
     const stopAnimation = () => {
       clearInterval(animationInterval);
       animationInterval = null;
@@ -169,45 +202,220 @@ if (!window.__ssr_reload) {
       }, 150);
     };
 
-    const stop = () => {
-      es?.close();
+    const shouldParticipate = () =>
+      pageActive &&
+      !reloadRequested &&
+      settings.autoReload &&
+      document.visibilityState === "visible";
+    const canConnect = () => shouldParticipate() && ownsLock;
+
+    const closeSource = () => {
+      const source = es;
       es = null;
-      clearInterval(reconnectInterval);
-      reconnectInterval = null;
+      source?.close();
+    };
+
+    const cancelRetry = () => {
+      retryGeneration += 1;
+      clearTimeout(retryTimer);
+      retryTimer = null;
+      const controller = retryController;
+      retryController = null;
+      controller?.abort();
+    };
+
+    const stopConnection = () => {
+      closeSource();
+      cancelRetry();
+      retryAttempt = 0;
       stopAnimation();
+      badge.innerText = "[ssr]";
+    };
+
+    const releaseLeadership = () => {
+      const pendingLock = lockController;
+      lockController = null;
+      pendingLock?.abort();
+
+      const release = releaseLock;
+      releaseLock = null;
+      ownsLock = false;
+      release?.();
+      stopConnection();
+    };
+
+    const requestReload = () => {
+      if (reloadRequested) return;
+      reloadRequested = true;
+      releaseLeadership();
+      location.reload();
+    };
+
+    const acceptReloadId = (nextReloadId) => {
+      if (!nextReloadId) return;
+      writeStorage(reloadIdKey, nextReloadId);
+      if (reloadId && nextReloadId !== reloadId) requestReload();
+    };
+
+    const retryDelay = () =>
+      Math.min(2_000, 300 * 2 ** Math.min(retryAttempt, 3));
+
+    const scheduleRetry = () => {
+      if (!canConnect() || retryTimer || retryController) return;
+
+      const generation = retryGeneration;
+      retryTimer = setTimeout(async () => {
+        retryTimer = null;
+        if (generation !== retryGeneration || !canConnect()) return;
+
+        const controller = new AbortController();
+        retryController = controller;
+        try {
+          const response = await fetch(`${ssrPath}/_ping`, {
+            cache: "no-store",
+            signal: controller.signal,
+          });
+          if (response.ok && canConnect()) {
+            acceptReloadId(response.headers.get("X-SSR-Reload-ID"));
+            if (!reloadRequested) requestReload();
+            return;
+          }
+        } catch {
+          // A stopped or unavailable dev server is expected during reload.
+        } finally {
+          if (retryController === controller) retryController = null;
+        }
+
+        if (generation !== retryGeneration || !canConnect()) return;
+        retryAttempt += 1;
+        scheduleRetry();
+      }, retryDelay());
+    };
+
+    const startRetry = () => {
+      if (!canConnect()) return;
+      startAnimation();
+      scheduleRetry();
     };
 
     const start = () => {
-      if (es) return;
+      if (!canConnect() || es || retryTimer || retryController) return;
+
+      let source;
       try {
-        es = new EventSource(`${ssrPath}/_reload`);
+        source = new EventSource(`${ssrPath}/_reload`);
+        es = source;
         stopAnimation();
         badge.innerText = "[ssr]";
       } catch {
+        startRetry();
         return;
       }
 
-      es.onerror = (e) => {
-        e.preventDefault();
-        stop();
-        startAnimation();
-        if (!settings.autoReload) return;
-        reconnectInterval = setInterval(() => {
-          fetch(`${ssrPath}/_ping`)
-            .then((r) => r.ok && location.reload())
-            .catch(() => {});
-        }, 300);
+      source.onopen = () => {
+        if (es !== source) return;
+        retryAttempt = 0;
+        stopAnimation();
+        badge.innerText = "[ssr]";
       };
+
+      source.onmessage = (event) => {
+        if (es !== source) return;
+        acceptReloadId(event.data);
+      };
+
+      source.onerror = (event) => {
+        if (es !== source) return;
+        event.preventDefault();
+        closeSource();
+        retryAttempt = 0;
+        startRetry();
+      };
+    };
+
+    const requestLeadership = () => {
+      if (!shouldParticipate()) return;
+      if (ownsLock) {
+        start();
+        return;
+      }
+      if (lockController) return;
+
+      if (!navigator.locks?.request) {
+        ownsLock = true;
+        start();
+        return;
+      }
+
+      const controller = new AbortController();
+      lockController = controller;
+      void navigator.locks
+        .request(
+          reloadLockName,
+          { mode: "exclusive", signal: controller.signal },
+          async () => {
+            if (lockController === controller) lockController = null;
+            if (controller.signal.aborted || !shouldParticipate()) return;
+
+            ownsLock = true;
+            start();
+            await new Promise((resolve) => {
+              releaseLock = resolve;
+            });
+            releaseLock = null;
+            ownsLock = false;
+            stopConnection();
+          },
+        )
+        .catch((error) => {
+          if (lockController === controller) lockController = null;
+          if (error?.name === "AbortError" || !shouldParticipate()) return;
+
+          // If Web Locks is unavailable at runtime, retain per-tab behavior.
+          ownsLock = true;
+          start();
+        });
     };
 
-    if (settings.autoReload) start();
+    const syncConnection = () => {
+      const knownReloadId = readStorage(reloadIdKey);
+      if (
+        shouldParticipate() &&
+        reloadId &&
+        knownReloadId &&
+        knownReloadId !== reloadId
+      ) {
+        requestReload();
+        return;
+      }
+
+      if (shouldParticipate()) requestLeadership();
+      else releaseLeadership();
+    };
+
+    syncConnection();
 
     panel.querySelector("#_ssr_reload").onchange = (e) => {
       settings.autoReload = e.target.checked;
       save(settings);
-      settings.autoReload ? start() : stop();
+      syncConnection();
     };
 
-    window.addEventListener("pagehide", stop);
+    document.addEventListener("visibilitychange", syncConnection);
+    window.addEventListener("storage", (event) => {
+      if (event.key !== reloadIdKey || !event.newValue) return;
+      if (reloadId && event.newValue !== reloadId && shouldParticipate()) {
+        requestReload();
+      }
+    });
+    window.addEventListener("pagehide", () => {
+      pageActive = false;
+      releaseLeadership();
+    });
+    window.addEventListener("pageshow", () => {
+      pageActive = true;
+      reloadRequested = false;
+      syncConnection();
+    });
   })();
 }

package/src/adapter/elysia.ts

@@ -6,6 +6,7 @@ import { Elysia } from "elysia";
 import type { SsrConfig } from "../index";
 import {
   createAssetResponse,
+  createPingResponse,
   getSsrDir,
   createReloadResponse,
   notFound,
@@ -28,8 +29,10 @@ export const routes = (config: SsrConfig) => {
   const ssrDir = getSsrDir(config);
 
   return new Elysia({ name: "ssr" })
-    .get(`${ssrPath}/_reload`, () => (dev ? createReloadResponse() : notFound()))
-    .get(`${ssrPath}/_ping`, () => (dev ? new Response("ok") : notFound()))
+    .get(`${ssrPath}/_reload`, ({ request }) =>
+      dev ? createReloadResponse(request.signal) : notFound(),
+    )
+    .get(`${ssrPath}/_ping`, () => (dev ? createPingResponse() : notFound()))
     .get(`${ssrPath}/*`, ({ request, params }) =>
       createAssetResponse(request, ssrDir, params["*"], dev),
     );

package/src/adapter/hono.ts

@@ -6,7 +6,7 @@ import { Hono } from "hono";
 import { createFactory } from "hono/factory";
 import type { Context, Env, Handler, MiddlewareHandler, TypedResponse } from "hono";
 import type { SsrConfig, HtmlFn, RenderFn } from "../index";
-import { createAssetResponse, getSsrDir, createReloadResponse } from "./utils";
+import { createAssetResponse, createPingResponse, getSsrDir, createReloadResponse } from "./utils";
 
 // ============================================================================
 // Types
@@ -172,8 +172,8 @@ export const routes = (config: SsrConfig) => {
 
   // Dev mode endpoints
   if (dev) {
-    app.get("/_reload", () => createReloadResponse());
-    app.get("/_ping", (c) => c.text("ok"));
+    app.get("/_reload", (c) => createReloadResponse(c.req.raw.signal));
+    app.get("/_ping", () => createPingResponse());
   }
 
   const serveAsset = (c: Context) => createAssetResponse(c.req.raw, ssrDir, c.req.param("filename"), dev);

package/src/adapter/utils.ts

@@ -116,28 +116,63 @@ export const SSE_HEADERS = {
   Connection: "keep-alive",
 } as const;
 
+const reloadId = crypto.randomUUID();
+const reloadConnected = new TextEncoder().encode(`: connected\ndata: ${reloadId}\n\n`);
+const reloadPing = new TextEncoder().encode(": ping\n\n");
+
+export const getReloadId = (): string => reloadId;
+
+export const createPingResponse = (): Response =>
+  new Response("ok", { headers: { "X-SSR-Reload-ID": reloadId } });
+
 /**
  * Creates a Server-Sent Events stream for live reload
  */
-export const createReloadStream = (): ReadableStream =>
-  new ReadableStream({
+export const createReloadStream = (signal?: AbortSignal): ReadableStream<Uint8Array> => {
+  let interval: ReturnType<typeof setInterval> | undefined;
+  let streamController: ReadableStreamDefaultController<Uint8Array> | undefined;
+  const handleAbort = () => {
+    stopHeartbeat();
+    try {
+      streamController?.close();
+    } catch {
+      // The consumer may already have canceled the stream.
+    }
+  };
+  const stopHeartbeat = () => {
+    if (interval === undefined) return;
+    clearInterval(interval);
+    interval = undefined;
+    signal?.removeEventListener("abort", handleAbort);
+  };
+
+  return new ReadableStream<Uint8Array>({
     start(controller) {
-      controller.enqueue(new TextEncoder().encode(": connected\n\n"));
-      const interval = setInterval(() => {
+      streamController = controller;
+      if (signal?.aborted) {
+        controller.close();
+        return;
+      }
+
+      signal?.addEventListener("abort", handleAbort, { once: true });
+      controller.enqueue(reloadConnected);
+      interval = setInterval(() => {
         try {
-          controller.enqueue(new TextEncoder().encode(": ping\n\n"));
+          controller.enqueue(reloadPing);
         } catch {
-          clearInterval(interval);
+          stopHeartbeat();
         }
       }, 5000);
     },
+    cancel: stopHeartbeat,
   });
+};
 
 /**
  * Creates a Response for the SSE reload endpoint
  */
-export const createReloadResponse = (): Response =>
-  new Response(createReloadStream(), { headers: SSE_HEADERS });
+export const createReloadResponse = (signal?: AbortSignal): Response =>
+  new Response(createReloadStream(signal), { headers: SSE_HEADERS });
 
 /**
  * 404 Response

package/src/index.ts

@@ -12,7 +12,7 @@ import { transform } from "./transform";
 import { buildIslands, type DevSourcemap } from "./build";
 import { join, dirname, resolve } from "path";
 import { resolveIslandImport } from "./island-resolve";
-import { normalizeBasePath, toSsrPath } from "./adapter/utils";
+import { getReloadId, normalizeBasePath, toSsrPath } from "./adapter/utils";
 // @ts-ignore - Bun text import
 import devClientCode from "./adapter/client.js" with { type: "text" };
 
@@ -160,7 +160,7 @@ export const createConfig = <T extends object = object>(options: SsrOptions<T> =
 
   // Hydration script - dynamically loads island/client bundles based on DOM
   const hydrationScript = `<script type="module">const p=${JSON.stringify(ssrPath)};const v=${JSON.stringify(buildVersion)};document.querySelectorAll('solid-island,solid-client').forEach(e=>import(p+'/'+e.dataset.id+'.js'+(v?'?v='+v:'')));</script>`;
-  const devConfigScript = `<script>globalThis.__SSR_CONFIG=${JSON.stringify({ ssrPath })}</script>`;
+  const devConfigScript = `<script>globalThis.__SSR_CONFIG=${JSON.stringify({ ssrPath, reloadId: getReloadId() })}</script>`;
 
   // HTML renderer
   const html: HtmlFn<T> = async (render, opts = {} as T) => {