fix(auth): preserve intentional logout across browser return
Keep a bounded per-tab logout intent and broadcast it to already open tabs so back navigation after a normal logout is not mistaken for renewal failure. Preserve real refresh and session expiry signals, and keep IdP navigation reachable when local cleanup fails.
This commit is contained in:
@@ -1,4 +1,8 @@
|
||||
import { completeLogout, reportLogoutAudit } from "./logoutFlow";
|
||||
import {
|
||||
clearIntentionalLogout,
|
||||
isIntentionalLogout,
|
||||
} from "./logoutIntent";
|
||||
|
||||
describe("reportLogoutAudit", () => {
|
||||
it("starts an authenticated keepalive request", async () => {
|
||||
@@ -28,6 +32,10 @@ describe("reportLogoutAudit", () => {
|
||||
});
|
||||
|
||||
describe("completeLogout", () => {
|
||||
beforeEach(() => {
|
||||
clearIntentionalLogout();
|
||||
});
|
||||
|
||||
it("navigates immediately without waiting for audit reporting", async () => {
|
||||
const reportAudit = jest.fn(
|
||||
() => new Promise<unknown>(() => undefined),
|
||||
@@ -44,6 +52,7 @@ describe("completeLogout", () => {
|
||||
await Promise.resolve();
|
||||
|
||||
expect(reportAudit).toHaveBeenCalledTimes(1);
|
||||
expect(isIntentionalLogout()).toBe(true);
|
||||
expect(clearLocalState).toHaveBeenCalledTimes(1);
|
||||
expect(navigate).toHaveBeenCalledWith("/api/auth/keycloak-logout");
|
||||
await expect(result).resolves.toEqual({ success: true });
|
||||
@@ -79,4 +88,20 @@ describe("completeLogout", () => {
|
||||
expect(clearLocalState).toHaveBeenCalledTimes(1);
|
||||
expect(navigate).toHaveBeenCalledWith("/api/auth/keycloak-logout");
|
||||
});
|
||||
|
||||
it("still navigates when local cleanup throws", async () => {
|
||||
const navigate = jest.fn();
|
||||
|
||||
await expect(
|
||||
completeLogout({
|
||||
reportAudit: jest.fn().mockResolvedValue(undefined),
|
||||
clearLocalState: () => {
|
||||
throw new DOMException("Storage unavailable", "SecurityError");
|
||||
},
|
||||
navigate,
|
||||
}),
|
||||
).resolves.toEqual({ success: true });
|
||||
|
||||
expect(navigate).toHaveBeenCalledWith("/api/auth/keycloak-logout");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import { markIntentionalLogout } from "@/lib/logoutIntent";
|
||||
|
||||
const KEYCLOAK_LOGOUT_PATH = "/api/auth/keycloak-logout";
|
||||
|
||||
type CompleteLogoutOptions = {
|
||||
@@ -41,7 +43,12 @@ export const completeLogout = async ({
|
||||
// Synchronous reporting errors must not block logout either.
|
||||
}
|
||||
|
||||
clearLocalState();
|
||||
markIntentionalLogout();
|
||||
try {
|
||||
clearLocalState();
|
||||
} catch {
|
||||
// Browser storage cleanup failures must not prevent the IdP logout.
|
||||
}
|
||||
navigate(KEYCLOAK_LOGOUT_PATH);
|
||||
return { success: true as const };
|
||||
};
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
import {
|
||||
clearIntentionalLogout,
|
||||
isIntentionalLogout,
|
||||
markIntentionalLogout,
|
||||
} from "./logoutIntent";
|
||||
|
||||
describe("intentional logout marker", () => {
|
||||
afterEach(() => {
|
||||
jest.restoreAllMocks();
|
||||
clearIntentionalLogout();
|
||||
});
|
||||
|
||||
it("stores a timestamp only for the current tab", () => {
|
||||
jest.spyOn(Date, "now").mockReturnValue(1_700_000_000_000);
|
||||
|
||||
markIntentionalLogout();
|
||||
|
||||
expect(sessionStorage.getItem("tjwater:intentional-logout")).toBe(
|
||||
"1700000000000",
|
||||
);
|
||||
expect(localStorage.getItem("tjwater:intentional-logout")).toBeNull();
|
||||
expect(isIntentionalLogout()).toBe(true);
|
||||
});
|
||||
|
||||
it("accepts an intentional logout event from another open tab", () => {
|
||||
window.dispatchEvent(
|
||||
new StorageEvent("storage", {
|
||||
key: "tjwater:intentional-logout-event",
|
||||
newValue: JSON.stringify({
|
||||
type: "mark",
|
||||
markedAt: Date.now(),
|
||||
}),
|
||||
}),
|
||||
);
|
||||
|
||||
expect(isIntentionalLogout()).toBe(true);
|
||||
});
|
||||
|
||||
it("does not broadcast a clear event when the current tab has no marker", () => {
|
||||
clearIntentionalLogout();
|
||||
const setItem = jest.spyOn(Storage.prototype, "setItem");
|
||||
|
||||
expect(isIntentionalLogout()).toBe(false);
|
||||
expect(setItem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("expires a stale marker", () => {
|
||||
const now = 1_700_000_000_000;
|
||||
const nowSpy = jest.spyOn(Date, "now").mockReturnValue(now);
|
||||
markIntentionalLogout();
|
||||
|
||||
nowSpy.mockReturnValue(now + 30 * 60 * 1000 + 1);
|
||||
|
||||
expect(isIntentionalLogout()).toBe(false);
|
||||
expect(sessionStorage.getItem("tjwater:intentional-logout")).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,81 @@
|
||||
const INTENTIONAL_LOGOUT_STORAGE_KEY = "tjwater:intentional-logout";
|
||||
const INTENTIONAL_LOGOUT_EVENT_KEY = "tjwater:intentional-logout-event";
|
||||
const INTENTIONAL_LOGOUT_TTL_MS = 30 * 60 * 1000;
|
||||
let memoryMarkedAt: number | null = null;
|
||||
|
||||
const withStorage = (
|
||||
storageName: "localStorage" | "sessionStorage",
|
||||
callback: (storage: Storage) => void,
|
||||
) => {
|
||||
if (typeof window === "undefined") return;
|
||||
try {
|
||||
callback(window[storageName]);
|
||||
} catch {
|
||||
// Logout must still proceed when browser storage is unavailable.
|
||||
}
|
||||
};
|
||||
|
||||
const setLocalMarker = (markedAt: number | null) => {
|
||||
memoryMarkedAt = markedAt;
|
||||
withStorage("sessionStorage", (storage) => {
|
||||
if (markedAt === null) {
|
||||
storage.removeItem(INTENTIONAL_LOGOUT_STORAGE_KEY);
|
||||
} else {
|
||||
storage.setItem(INTENTIONAL_LOGOUT_STORAGE_KEY, String(markedAt));
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const broadcastIntent = (
|
||||
payload: { type: "mark"; markedAt: number } | { type: "clear" },
|
||||
) => {
|
||||
withStorage("localStorage", (storage) => {
|
||||
storage.setItem(INTENTIONAL_LOGOUT_EVENT_KEY, JSON.stringify(payload));
|
||||
storage.removeItem(INTENTIONAL_LOGOUT_EVENT_KEY);
|
||||
});
|
||||
};
|
||||
|
||||
if (typeof window !== "undefined") {
|
||||
window.addEventListener("storage", (event) => {
|
||||
if (event.key !== INTENTIONAL_LOGOUT_EVENT_KEY || !event.newValue) return;
|
||||
try {
|
||||
const payload = JSON.parse(event.newValue) as {
|
||||
type?: unknown;
|
||||
markedAt?: unknown;
|
||||
};
|
||||
if (payload.type === "mark" && typeof payload.markedAt === "number") {
|
||||
setLocalMarker(payload.markedAt);
|
||||
} else if (payload.type === "clear") {
|
||||
setLocalMarker(null);
|
||||
}
|
||||
} catch {
|
||||
// Ignore malformed cross-tab events.
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
export const markIntentionalLogout = () => {
|
||||
const markedAt = Date.now();
|
||||
setLocalMarker(markedAt);
|
||||
broadcastIntent({ type: "mark", markedAt });
|
||||
};
|
||||
|
||||
export const clearIntentionalLogout = () => {
|
||||
setLocalMarker(null);
|
||||
broadcastIntent({ type: "clear" });
|
||||
};
|
||||
|
||||
export const isIntentionalLogout = () => {
|
||||
let markedAt = memoryMarkedAt;
|
||||
withStorage("sessionStorage", (storage) => {
|
||||
const stored = Number(storage.getItem(INTENTIONAL_LOGOUT_STORAGE_KEY));
|
||||
if (Number.isFinite(stored) && stored > 0) markedAt = stored;
|
||||
});
|
||||
if (markedAt === null) return false;
|
||||
const age = Date.now() - markedAt;
|
||||
if (age < 0 || age > INTENTIONAL_LOGOUT_TTL_MS) {
|
||||
setLocalMarker(null);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
};
|
||||
Reference in New Issue
Block a user