Files
fusion/packages/dashboard/app/hooks/useChatRooms.ts
Fusion (runfusion.ai) e96cb09982 feat(FN-5388): add warm room cache hydration with open diagnostics
Add room open performance diagnostics and warm cache hydration for room switches (FN-5388). The implementation adds a timing instrumentation utility, SWR cache constants, warm-room handoff logic in `useChatRooms`, and a documentation file covering the performance model, accompanied by regression tes

Fusion-Task-Id: FN-5388
2026-05-20 20:27:11 -07:00

589 lines
23 KiB
TypeScript

import { useCallback, useEffect, useRef, useState } from "react";
import type { ChatAttachment, ChatRoom, ChatRoomMember, ChatRoomMessage } from "@fusion/core";
import {
clearChatRoomMessages,
createChatRoom,
deleteChatRoom,
fetchChatRoomMembers,
fetchChatRoomMessages,
fetchChatRooms,
postChatRoomMessage,
uploadChatRoomAttachment,
} from "../api";
import { subscribeSse } from "../sse-bus";
import { getScopedItem, removeScopedItem, setScopedItem } from "../utils/projectStorage";
import { recordResumeEvent } from "../utils/resumeInstrumentation";
import {
readCache,
SWR_CACHE_KEYS,
SWR_CHAT_ROOM_MAX_AGE_MS,
SWR_DEFAULT_MAX_AGE_MS,
SWR_LONG_MAX_AGE_MS,
writeCache,
} from "../utils/swrCache";
import { startRoomOpenTimer } from "../utils/roomOpenDiagnostics";
const ACTIVE_ROOM_STORAGE_KEY = "fusion:chat-active-room";
export class RoomMessageDeliveredButReplyFailedError extends Error {
roomId: string;
constructor(message: string, roomId: string) {
super(message);
this.name = "RoomMessageDeliveredButReplyFailedError";
this.roomId = roomId;
}
}
export interface UseChatRoomsResult {
rooms: ChatRoom[];
roomsLoading: boolean;
roomsError: string | null;
activeRoom: ChatRoom | null;
activeRoomMembers: ChatRoomMember[];
messages: ChatRoomMessage[];
messagesLoading: boolean;
selectRoom: (roomId: string | null) => void;
createRoom: (input: { name: string; memberAgentIds: string[] }) => Promise<ChatRoom>;
deleteRoom: (roomId: string) => Promise<void>;
sendRoomMessage: (content: string, opts?: { attachments?: ChatAttachment[]; files?: File[] }) => Promise<void>;
clearRoom: (roomId: string) => Promise<void>;
refreshRooms: () => Promise<void>;
}
function sortRooms(nextRooms: ChatRoom[]): ChatRoom[] {
return [...nextRooms].sort((a, b) => new Date(b.updatedAt).getTime() - new Date(a.updatedAt).getTime());
}
function upsertRoom(existingRooms: ChatRoom[], room: ChatRoom): ChatRoom[] {
const idx = existingRooms.findIndex((candidate) => candidate.id === room.id);
if (idx === -1) return sortRooms([room, ...existingRooms]);
const next = [...existingRooms];
next[idx] = room;
return sortRooms(next);
}
function parseSsePayload<T>(event: MessageEvent): T | null {
try {
return JSON.parse(event.data) as T;
} catch {
return null;
}
}
function createOptimisticRoomMessage(roomId: string, content: string, attachments?: ChatAttachment[]): ChatRoomMessage {
return {
id: `temp-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`,
roomId,
role: "user",
content,
thinkingOutput: null,
metadata: null,
senderAgentId: null,
mentions: [],
...(attachments?.length ? { attachments } : {}),
createdAt: new Date().toISOString(),
};
}
export function useChatRooms(
projectId?: string,
addToast?: (msg: string, type?: "success" | "error" | "warning") => void,
): UseChatRoomsResult {
const roomsCacheKey = `${SWR_CACHE_KEYS.CHAT_ROOMS}:${projectId ?? "global"}`;
const activeRoomCacheKey = `${SWR_CACHE_KEYS.ACTIVE_CHAT_ROOM_ID}:${projectId ?? "global"}`;
const messagesCacheKey = useCallback(
(roomId: string) => `${SWR_CACHE_KEYS.CHAT_ROOM_MESSAGES_PREFIX}${projectId ?? "global"}:${roomId}`,
[projectId],
);
const membersCacheKey = useCallback(
(roomId: string) => `${SWR_CACHE_KEYS.CHAT_ROOM_MEMBERS_PREFIX}${projectId ?? "global"}:${roomId}`,
[projectId],
);
const [rooms, setRooms] = useState<ChatRoom[]>(() => {
const cached = readCache<ChatRoom[]>(roomsCacheKey, { maxAgeMs: SWR_DEFAULT_MAX_AGE_MS });
return Array.isArray(cached) ? cached : [];
});
const [roomsLoading, setRoomsLoading] = useState(() => rooms.length === 0);
const [roomsError, setRoomsError] = useState<string | null>(null);
const [activeRoom, setActiveRoom] = useState<ChatRoom | null>(() => {
const cachedRoomId = readCache<string>(activeRoomCacheKey, { maxAgeMs: SWR_LONG_MAX_AGE_MS });
if (!cachedRoomId) {
return null;
}
return rooms.find((room) => room.id === cachedRoomId) ?? null;
});
const [activeRoomMembers, setActiveRoomMembers] = useState<ChatRoomMember[]>([]);
const [messages, setMessages] = useState<ChatRoomMessage[]>([]);
const [messagesLoading, setMessagesLoading] = useState(false);
const roomsRef = useRef(rooms);
const activeRoomRef = useRef(activeRoom);
const projectContextVersionRef = useRef(0);
const previousProjectIdRef = useRef<string | undefined>(projectId);
roomsRef.current = rooms;
activeRoomRef.current = activeRoom;
if (previousProjectIdRef.current !== projectId) {
previousProjectIdRef.current = projectId;
projectContextVersionRef.current += 1;
}
const loadRoomData = useCallback(async (room: ChatRoom | null) => {
if (!room) {
setActiveRoomMembers([]);
setMessages([]);
setMessagesLoading(false);
return;
}
const timer = startRoomOpenTimer(room.id, { warm: false });
timer.mark("select");
const cachedMessages = readCache<ChatRoomMessage[]>(messagesCacheKey(room.id), { maxAgeMs: SWR_CHAT_ROOM_MAX_AGE_MS });
const cachedMembers = readCache<ChatRoomMember[]>(membersCacheKey(room.id), { maxAgeMs: SWR_DEFAULT_MAX_AGE_MS });
const hasCachedMessages = Array.isArray(cachedMessages) && cachedMessages.length > 0;
const hasCachedMembers = Array.isArray(cachedMembers) && cachedMembers.length > 0;
if (hasCachedMessages || hasCachedMembers) {
timer.mark("cache-hit");
if (hasCachedMessages) {
setMessages(cachedMessages);
timer.mark("hydrate");
}
if (hasCachedMembers) {
setActiveRoomMembers(cachedMembers);
}
setMessagesLoading(false);
} else {
setMessages([]);
setMessagesLoading(true);
}
try {
const [membersData, messagesData] = await Promise.all([
fetchChatRoomMembers(room.id, projectId),
fetchChatRoomMessages(room.id, { limit: 100, order: "desc" }, projectId),
]);
timer.mark("members-fetch");
timer.mark("messages-fetch");
writeCache(membersCacheKey(room.id), membersData.members, { maxBytes: 500_000 });
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(room.id), messagesData.messages, { maxBytes: 500_000 });
if (activeRoomRef.current?.id === room.id) {
setActiveRoomMembers(membersData.members);
setMessages(messagesData.messages);
timer.mark("hydrate");
}
} catch {
if (!hasCachedMessages && !hasCachedMembers) {
setActiveRoomMembers([]);
setMessages([]);
}
} finally {
setMessagesLoading(false);
timer.complete({ warm: hasCachedMessages, membersCached: hasCachedMembers });
}
}, [membersCacheKey, messagesCacheKey, projectId]);
const refreshRooms = useCallback(async () => {
if (roomsRef.current.length === 0) {
setRoomsLoading(true);
}
try {
const data = await fetchChatRooms({}, projectId);
const sortedRooms = sortRooms(data.rooms);
setRooms(sortedRooms);
writeCache(roomsCacheKey, sortedRooms, { maxBytes: 500_000 });
setRoomsError(null);
const persistedRoomId = readCache<string>(activeRoomCacheKey, { maxAgeMs: SWR_LONG_MAX_AGE_MS }) ?? getScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
if (persistedRoomId) {
const persistedRoom = sortedRooms.find((room) => room.id === persistedRoomId) ?? null;
if (persistedRoom) {
setActiveRoom(persistedRoom);
void loadRoomData(persistedRoom);
} else {
removeScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
writeCache(activeRoomCacheKey, "", { maxBytes: 500_000 });
}
}
} catch (error) {
const message = error instanceof Error ? error.message : "Failed to load chat rooms";
setRoomsError(message);
addToast?.(message, "error");
} finally {
setRoomsLoading(false);
}
}, [activeRoomCacheKey, addToast, loadRoomData, projectId, roomsCacheKey]);
const selectRoom = useCallback((roomId: string | null) => {
if (!roomId) {
activeRoomRef.current = null;
setActiveRoom(null);
removeScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
writeCache(activeRoomCacheKey, "", { maxBytes: 500_000 });
void loadRoomData(null);
return;
}
const room = roomsRef.current.find((candidate) => candidate.id === roomId) ?? null;
activeRoomRef.current = room;
setActiveRoom(room);
if (room) {
setScopedItem(ACTIVE_ROOM_STORAGE_KEY, room.id, projectId);
writeCache(activeRoomCacheKey, room.id, { maxBytes: 500_000 });
void loadRoomData(room);
}
}, [activeRoomCacheKey, loadRoomData, projectId]);
const createRoomLocal = useCallback(async (input: { name: string; memberAgentIds: string[] }) => {
const created = await createChatRoom({ name: input.name, memberAgentIds: input.memberAgentIds }, projectId);
const nextRoom = created.room;
setRooms((previous) => upsertRoom(previous, nextRoom));
activeRoomRef.current = nextRoom;
setActiveRoom(nextRoom);
setScopedItem(ACTIVE_ROOM_STORAGE_KEY, nextRoom.id, projectId);
writeCache(activeRoomCacheKey, nextRoom.id, { maxBytes: 500_000 });
await loadRoomData(nextRoom);
return nextRoom;
}, [activeRoomCacheKey, loadRoomData, projectId]);
const deleteRoomLocal = useCallback(async (roomId: string) => {
await deleteChatRoom(roomId, projectId);
setRooms((previous) => previous.filter((room) => room.id !== roomId));
// Invalidate by writing empty snapshots for deterministic warm-open behavior.
writeCache(messagesCacheKey(roomId), [], { maxBytes: 500_000 });
writeCache(membersCacheKey(roomId), [], { maxBytes: 500_000 });
if (activeRoomRef.current?.id === roomId) {
activeRoomRef.current = null;
setActiveRoom(null);
setActiveRoomMembers([]);
setMessages([]);
removeScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
writeCache(activeRoomCacheKey, "", { maxBytes: 500_000 });
}
}, [activeRoomCacheKey, membersCacheKey, messagesCacheKey, projectId]);
/**
* Sends a room message with optimistic UI.
*
* Error contract:
* - Throws the original error when delivery did not happen (before `postChatRoomMessage` resolves); callers may restore composer text.
* - Throws `RoomMessageDeliveredButReplyFailedError` when delivery succeeded but a post-send step failed; callers must keep composer cleared.
*/
const sendRoomMessage = useCallback(async (content: string, opts?: { attachments?: ChatAttachment[]; files?: File[] }) => {
const activeRoomSnapshot = activeRoomRef.current;
const roomId = activeRoomSnapshot?.id;
if (!roomId) {
throw new Error("Select a room before sending a message");
}
const timer = startRoomOpenTimer(roomId, { warm: false });
const placeholderAttachments = opts?.files?.map((file) => ({
id: `upload-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`,
filename: file.name,
originalName: file.name,
mimeType: file.type || "application/octet-stream",
size: file.size,
createdAt: new Date().toISOString(),
} satisfies ChatAttachment));
const optimisticMessage = createOptimisticRoomMessage(roomId, content, placeholderAttachments?.length ? placeholderAttachments : opts?.attachments);
if (activeRoomRef.current?.id === roomId) {
setMessages((previous) => {
const next = [...previous, optimisticMessage];
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(roomId), next, { maxBytes: 500_000 });
return next;
});
}
let userMessageDelivered = false;
try {
const uploadedAttachments: ChatAttachment[] = [];
if (opts?.files?.length) {
for (const file of opts.files) {
try {
const uploaded = await uploadChatRoomAttachment(roomId, file, projectId);
uploadedAttachments.push(uploaded.attachment);
} catch {
throw new Error(`Failed to upload attachment: ${file.name}`);
}
}
}
const mergedAttachments = [...(opts?.attachments ?? []), ...uploadedAttachments];
const postResult = await postChatRoomMessage(roomId, {
content,
...(mergedAttachments.length ? { attachments: mergedAttachments } : {}),
}, projectId);
userMessageDelivered = true;
if (postResult.message?.createdAt && activeRoomSnapshot) {
setRooms((previous) => upsertRoom(previous, { ...activeRoomSnapshot, updatedAt: postResult.message.createdAt }));
}
if (activeRoomRef.current?.id === roomId) {
setMessages((previous) => {
const next = previous.map((message) =>
message.id === optimisticMessage.id ? postResult.message : message);
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(roomId), next, { maxBytes: 500_000 });
return next;
});
}
const latestMessages = await fetchChatRoomMessages(roomId, { limit: 100, order: "desc" }, projectId);
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(roomId), latestMessages.messages, { maxBytes: 500_000 });
if (activeRoomRef.current?.id !== roomId) {
return;
}
setMessages(latestMessages.messages);
timer.mark("hydrate");
} catch (error) {
try {
const latestMessages = await fetchChatRoomMessages(roomId, { limit: 100, order: "desc" }, projectId);
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(roomId), latestMessages.messages, { maxBytes: 500_000 });
if (activeRoomRef.current?.id === roomId) {
setMessages(latestMessages.messages);
timer.mark("hydrate");
}
} catch {
if (activeRoomRef.current?.id === roomId) {
setMessages((previous) => {
const next = previous.filter((message) => message.id !== optimisticMessage.id);
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(roomId), next, { maxBytes: 500_000 });
return next;
});
}
}
if (userMessageDelivered) {
const message = error instanceof Error && error.message.trim()
? error.message
: "Message delivered, but failed to refresh room replies";
throw new RoomMessageDeliveredButReplyFailedError(message, roomId);
}
throw error;
} finally {
timer.complete({ source: "send-room-message" });
}
}, [messagesCacheKey, projectId]);
const clearRoom = useCallback(async (roomId: string) => {
if (!roomId || !roomsRef.current.some((room) => room.id === roomId)) {
return;
}
await clearChatRoomMessages(roomId, projectId);
// Invalidate by writing an empty snapshot for deterministic warm-open behavior.
writeCache(messagesCacheKey(roomId), [], { maxBytes: 500_000 });
if (activeRoomRef.current?.id === roomId) {
setMessages([]);
}
}, [messagesCacheKey, projectId]);
useEffect(() => {
void refreshRooms();
}, [refreshRooms]);
useEffect(() => {
const contextVersionAtStart = projectContextVersionRef.current;
const eventsUrl = projectId ? `/api/events?projectId=${encodeURIComponent(projectId)}` : "/api/events";
return subscribeSse(eventsUrl, {
onReconnect: () => {
recordResumeEvent({
view: "useChatRooms",
trigger: "sse-reconnect",
projectId,
replayAttempted: false,
});
const roomId = activeRoomRef.current?.id;
if (roomId) {
const timer = startRoomOpenTimer(roomId, { warm: true });
timer.mark("sse-reconnect-refresh");
void refreshRooms().finally(() => timer.complete({ source: "sse-reconnect" }));
return;
}
void refreshRooms();
},
events: {
"chat:room:created": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const room = parseSsePayload<ChatRoom>(event);
if (!room) return;
setRooms((previous) => upsertRoom(previous, room));
},
"chat:room:updated": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const room = parseSsePayload<ChatRoom>(event);
if (!room) return;
setRooms((previous) => upsertRoom(previous, room));
if (activeRoomRef.current?.id === room.id) {
setActiveRoom(room);
}
},
"chat:room:deleted": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const payload = parseSsePayload<{ id: string }>(event);
if (!payload?.id) return;
setRooms((previous) => previous.filter((room) => room.id !== payload.id));
// Invalidate by writing empty snapshots for deterministic warm-open behavior.
writeCache(messagesCacheKey(payload.id), [], { maxBytes: 500_000 });
writeCache(membersCacheKey(payload.id), [], { maxBytes: 500_000 });
if (activeRoomRef.current?.id === payload.id) {
activeRoomRef.current = null;
setActiveRoom(null);
setActiveRoomMembers([]);
setMessages([]);
removeScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
writeCache(activeRoomCacheKey, "", { maxBytes: 500_000 });
}
},
"chat:room:member:added": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const payload = parseSsePayload<ChatRoomMember>(event);
if (!payload || activeRoomRef.current?.id !== payload.roomId) return;
setActiveRoomMembers((previous) => {
if (previous.some((member) => member.agentId === payload.agentId)) {
return previous;
}
const next = [...previous, payload];
writeCache(membersCacheKey(payload.roomId), next, { maxBytes: 500_000 });
return next;
});
},
"chat:room:member:removed": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const payload = parseSsePayload<{ roomId: string; agentId: string }>(event);
if (!payload || activeRoomRef.current?.id !== payload.roomId) return;
setActiveRoomMembers((previous) => {
const next = previous.filter((member) => member.agentId !== payload.agentId);
writeCache(membersCacheKey(payload.roomId), next, { maxBytes: 500_000 });
return next;
});
},
"chat:room:message:added": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const message = parseSsePayload<ChatRoomMessage>(event);
if (!message) return;
setRooms((previous) => {
const room = previous.find((candidate) => candidate.id === message.roomId);
if (!room) return previous;
return upsertRoom(previous, { ...room, updatedAt: message.createdAt });
});
if (activeRoomRef.current?.id !== message.roomId) return;
setMessages((previous) => {
if (previous.some((candidate) => candidate.id === message.id)) {
return previous;
}
if (message.role === "user") {
const optimisticIndex = previous.findIndex((candidate) =>
candidate.role === "user"
&& candidate.id.startsWith("temp-")
&& candidate.content.trim() === message.content.trim());
if (optimisticIndex >= 0) {
const next = [...previous];
next[optimisticIndex] = message;
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(message.roomId), next, { maxBytes: 500_000 });
return next;
}
}
const next = [...previous, message];
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(message.roomId), next, { maxBytes: 500_000 });
return next;
});
},
"chat:room:message:updated": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const message = parseSsePayload<ChatRoomMessage>(event);
if (!message || activeRoomRef.current?.id !== message.roomId) return;
setMessages((previous) => {
const next = previous.map((candidate) => (candidate.id === message.id ? message : candidate));
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(message.roomId), next, { maxBytes: 500_000 });
return next;
});
},
"chat:room:message:deleted": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const payload = parseSsePayload<{ id: string }>(event);
if (!payload?.id) return;
setMessages((previous) => {
const next = previous.filter((message) => message.id !== payload.id);
const activeRoomId = activeRoomRef.current?.id;
if (activeRoomId) {
// Snapshot mirrors server `order: desc` shape.
writeCache(messagesCacheKey(activeRoomId), next, { maxBytes: 500_000 });
}
return next;
});
},
"chat:room:messages:cleared": (event) => {
if (projectContextVersionRef.current !== contextVersionAtStart) return;
const payload = parseSsePayload<{ roomId: string; deletedCount: number }>(event);
if (!payload?.roomId) return;
// Invalidate by writing an empty snapshot for deterministic warm-open behavior.
writeCache(messagesCacheKey(payload.roomId), [], { maxBytes: 500_000 });
if (activeRoomRef.current?.id === payload.roomId) {
setMessages([]);
}
setRooms((previous) => {
const room = previous.find((candidate) => candidate.id === payload.roomId);
if (!room) return previous;
return upsertRoom(previous, { ...room, updatedAt: new Date().toISOString() });
});
},
},
});
}, [activeRoomCacheKey, membersCacheKey, messagesCacheKey, projectId, refreshRooms]);
useEffect(() => {
if (!activeRoom) return;
if (!rooms.some((room) => room.id === activeRoom.id)) {
activeRoomRef.current = null;
setActiveRoom(null);
setActiveRoomMembers([]);
setMessages([]);
removeScopedItem(ACTIVE_ROOM_STORAGE_KEY, projectId);
writeCache(activeRoomCacheKey, "", { maxBytes: 500_000 });
}
}, [activeRoom, activeRoomCacheKey, projectId, rooms]);
return {
rooms,
roomsLoading,
roomsError,
activeRoom,
activeRoomMembers,
messages,
messagesLoading,
selectRoom,
createRoom: createRoomLocal,
deleteRoom: deleteRoomLocal,
sendRoomMessage,
clearRoom,
refreshRooms,
};
}