mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-06-11 18:05:58 +00:00
b6fbf0d105
* fix(frontend): keep workspace interactive when SSR auth probe cannot reach gateway (#3493) When the SSR auth probe at /api/v1/auth/me times out or fails, the workspace layout used to render a static fallback page without AuthProvider or QueryClientProvider, making logout and every other interaction non-functional until the gateway recovered. Render the normal WorkspaceContent in 'gateway_unavailable' mode instead, surfacing a polite offline banner that re-probes the gateway in the background and hides itself the moment refreshUser() returns an authenticated user. The probe is reentrancy-guarded so a slow gateway cannot pile up parallel /auth/me requests. Closes #3493 * fix(workspace): silent probe in offline banner to avoid /login redirect during gateway recovery (#3493) The banner previously delegated retry probes to AuthProvider.refreshUser(), which treats any 401 from /api/v1/auth/me as 'session expired' and force-redirects to /login. During gateway recovery, the first few requests may transiently return 401 before the gateway is fully ready, which would incorrectly kick the user out — defeating the purpose of the offline banner. Now the banner silently fetches /api/v1/auth/me itself and only delegates to refreshUser() on 200 OK. Non-200 responses (401 / 5xx / network) are swallowed and retried on the next interval tick, ensuring the user stays logged in across short gateway outages. Verified in Docker: - docker pause deer-flow-gateway → banner appears, page interactive - docker unpause deer-flow-gateway → banner auto-disappears within 10s, user remains on /workspace/chats/new with full session restored - All 117 unit tests pass * fix(workspace): fix banner polling leak and persistent 401 handling (#3493) - Stop polling immediately after user recovery: add user to effect dependencies, cleanup interval when user !== null - Handle persistent 401: trigger login redirect after 3 consecutive unauthorized responses - Extract decision logic to pure helper, add 8 unit tests covering all critical paths * fix(workspace): address CR feedback on gateway offline recovery (#3493) - gateway-offline-banner-helpers: decrement (not reset) auth-failure streak on transient outcomes so a flapping gateway (401 alternating with 5xx) still converges on session-expired - gateway-offline-banner: reuse probe response body to apply user directly via new AuthProvider.applyUser, halving the recovery burst against an already-struggling gateway - gateway-offline-banner: extract classifyProbe into helpers for unit testability; log probe failures via console.warn instead of swallowing - gateway-offline-fallback: new shared component used by both workspace and (auth) layouts so auth pages recover the same way the workspace does, fixing the lockup where bare static HTML had no AuthProvider - AuthProvider.logout: fall back to hard navigation when the gateway logout fetch fails, matching legacy form-POST behaviour and avoiding stale client state during outage - tests: extend gateway-offline-banner-helpers.test with flapping convergence and classifyProbe branch coverage (19 cases total)
207 lines
5.8 KiB
TypeScript
207 lines
5.8 KiB
TypeScript
"use client";
|
|
|
|
import { useRouter, usePathname } from "next/navigation";
|
|
import React, {
|
|
createContext,
|
|
useContext,
|
|
useState,
|
|
useCallback,
|
|
useEffect,
|
|
type ReactNode,
|
|
} from "react";
|
|
|
|
import { isStaticWebsiteOnly } from "../static-mode";
|
|
|
|
import { type User, buildLoginUrl } from "./types";
|
|
|
|
// Re-export for consumers
|
|
export type { User };
|
|
|
|
/**
|
|
* Authentication context provided to consuming components
|
|
*/
|
|
interface AuthContextType {
|
|
user: User | null;
|
|
isAuthenticated: boolean;
|
|
isLoading: boolean;
|
|
logout: () => Promise<void>;
|
|
refreshUser: () => Promise<void>;
|
|
applyUser: (user: User | null) => void;
|
|
}
|
|
|
|
const AuthContext = createContext<AuthContextType | undefined>(undefined);
|
|
|
|
interface AuthProviderProps {
|
|
children: ReactNode;
|
|
initialUser: User | null;
|
|
}
|
|
|
|
/**
|
|
* AuthProvider - Unified authentication context for the application
|
|
*
|
|
* Per RFC-001:
|
|
* - Only holds display information (user), never JWT or tokens
|
|
* - initialUser comes from server-side guard, avoiding client flicker
|
|
* - Provides logout and refresh capabilities
|
|
*/
|
|
export function AuthProvider({ children, initialUser }: AuthProviderProps) {
|
|
const [user, setUser] = useState<User | null>(initialUser);
|
|
const [isLoading, setIsLoading] = useState(false);
|
|
const router = useRouter();
|
|
const pathname = usePathname();
|
|
const staticMode = isStaticWebsiteOnly();
|
|
|
|
const isAuthenticated = user !== null;
|
|
|
|
/**
|
|
* Apply a user value supplied by a caller (e.g. banner probe) that has
|
|
* already fetched it. Equivalent to setUser, exposed with a stable name
|
|
* so consumers don't reach into React internals.
|
|
*/
|
|
const applyUser = useCallback((next: User | null) => {
|
|
setUser(next);
|
|
}, []);
|
|
|
|
/**
|
|
* Fetch current user from FastAPI
|
|
* Used when initialUser might be stale (e.g., after tab was inactive)
|
|
*/
|
|
const refreshUser = useCallback(async () => {
|
|
if (staticMode) return;
|
|
|
|
try {
|
|
setIsLoading(true);
|
|
const res = await fetch("/api/v1/auth/me", {
|
|
credentials: "include",
|
|
});
|
|
|
|
if (res.ok) {
|
|
const data = await res.json();
|
|
setUser(data);
|
|
} else if (res.status === 401) {
|
|
// Session expired or invalid
|
|
setUser(null);
|
|
// Redirect to login if on a protected route
|
|
if (pathname?.startsWith("/workspace")) {
|
|
router.push(buildLoginUrl(pathname));
|
|
}
|
|
}
|
|
} catch (err) {
|
|
console.error("Failed to refresh user:", err);
|
|
setUser(null);
|
|
} finally {
|
|
setIsLoading(false);
|
|
}
|
|
}, [staticMode, pathname, router]);
|
|
|
|
/**
|
|
* Logout - call FastAPI logout endpoint and clear local state
|
|
* Per RFC-001: Immediately clear local state, don't wait for server confirmation
|
|
*
|
|
* When the gateway is unreachable the fetch silently fails — the SPA
|
|
* router.push("/") would leave the user on "/" still holding stale
|
|
* React state and any in-flight SSE / fetch / query subscriptions.
|
|
* We therefore fall back to a hard navigation (window.location.href),
|
|
* which discards all client state the same way the legacy form-POST
|
|
* logout used to.
|
|
*/
|
|
const logout = useCallback(async () => {
|
|
// Immediately clear local state to prevent UI flicker
|
|
setUser(null);
|
|
|
|
if (staticMode) {
|
|
router.push("/");
|
|
return;
|
|
}
|
|
|
|
let logoutFailed = false;
|
|
try {
|
|
const res = await fetch("/api/v1/auth/logout", {
|
|
method: "POST",
|
|
credentials: "include",
|
|
});
|
|
if (!res.ok) logoutFailed = true;
|
|
} catch (err) {
|
|
console.error("Logout request failed:", err);
|
|
logoutFailed = true;
|
|
}
|
|
|
|
if (logoutFailed && typeof window !== "undefined") {
|
|
// Hard navigation ensures every in-flight subscription is torn down,
|
|
// matching the legacy form-POST logout behaviour during a gateway outage.
|
|
window.location.href = "/";
|
|
return;
|
|
}
|
|
|
|
// Redirect to home page
|
|
router.push("/");
|
|
}, [staticMode, router]);
|
|
|
|
/**
|
|
* Handle visibility change - refresh user when tab becomes visible again.
|
|
* Throttled to at most once per 60 s to avoid spamming the backend on rapid tab switches.
|
|
*/
|
|
const lastCheckRef = React.useRef(0);
|
|
|
|
useEffect(() => {
|
|
if (staticMode) return;
|
|
|
|
const handleVisibilityChange = () => {
|
|
if (document.visibilityState !== "visible" || user === null) return;
|
|
const now = Date.now();
|
|
if (now - lastCheckRef.current < 60_000) return;
|
|
lastCheckRef.current = now;
|
|
void refreshUser();
|
|
};
|
|
|
|
document.addEventListener("visibilitychange", handleVisibilityChange);
|
|
return () => {
|
|
document.removeEventListener("visibilitychange", handleVisibilityChange);
|
|
};
|
|
}, [staticMode, user, refreshUser]);
|
|
|
|
const value: AuthContextType = {
|
|
user,
|
|
isAuthenticated,
|
|
isLoading,
|
|
logout,
|
|
refreshUser,
|
|
applyUser,
|
|
};
|
|
|
|
return <AuthContext.Provider value={value}>{children}</AuthContext.Provider>;
|
|
}
|
|
|
|
/**
|
|
* Hook to access authentication context
|
|
* Throws if used outside AuthProvider - this is intentional for proper usage
|
|
*/
|
|
export function useAuth(): AuthContextType {
|
|
const context = useContext(AuthContext);
|
|
if (context === undefined) {
|
|
throw new Error("useAuth must be used within an AuthProvider");
|
|
}
|
|
return context;
|
|
}
|
|
|
|
/**
|
|
* Hook to require authentication - redirects to login if not authenticated
|
|
* Useful for client-side checks in addition to server-side guards
|
|
*/
|
|
export function useRequireAuth(): AuthContextType {
|
|
const auth = useAuth();
|
|
const router = useRouter();
|
|
const pathname = usePathname();
|
|
|
|
useEffect(() => {
|
|
if (isStaticWebsiteOnly()) return;
|
|
|
|
// Only redirect if we're sure user is not authenticated (not just loading)
|
|
if (!auth.isLoading && !auth.isAuthenticated) {
|
|
router.push(buildLoginUrl(pathname || "/workspace"));
|
|
}
|
|
}, [auth.isAuthenticated, auth.isLoading, router, pathname]);
|
|
|
|
return auth;
|
|
}
|