Skip to content

πŸ™Œ OpenHands: AI-Driven Development

test: cover conversation store (#17333)

aivong-openhandsa2aafe96654b
diff --git a/__tests__/stores/conversation-store.test.ts b/__tests__/stores/conversation-store.test.ts
index 953f839cc7..9930b207a1 100644
--- a/__tests__/stores/conversation-store.test.ts
+++ b/__tests__/stores/conversation-store.test.ts
@@ -1,7 +1,12 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
-import { useConversationStore } from "#/stores/conversation-store";
-const defaultConversationState = {
+let useConversationStore: (typeof import("#/stores/conversation-store"))["useConversationStore"];
+
+const defaultConversationState: {
+ selectedTab: "files";
+ unpinnedTabs: string[];
+ conversationMode: "code" | "plan";
+} = {
selectedTab: "files" as const,
unpinnedTabs: [] as string[],
conversationMode: "code" as const,
@@ -21,20 +26,36 @@ vi.mock("#/utils/conversation-local-storage", () => ({
const CONV_ID = "conv-test-1";
describe("conversation store", () => {
- beforeEach(() => {
+ beforeEach(async () => {
vi.clearAllMocks();
mockGetConversationState.mockReturnValue(defaultConversationState);
Object.defineProperty(window, "location", {
value: { pathname: `/conversations/${CONV_ID}` },
writable: true,
});
- useConversationStore.setState({
- conversationMode: "code",
- planContent: null,
- subConversationTaskId: null,
- shouldHideSuggestions: false,
+ vi.resetModules();
+ ({ useConversationStore } = await import("#/stores/conversation-store"));
+ });
+
+ it("starts with the complete transient state reset", () => {
+ expect(useConversationStore.getState()).toMatchObject({
+ isRightPanelShown: false,
+ selectedTab: "files",
+ images: [],
+ files: [],
imagesMarkedUploadAsFile: [],
pastedImageNames: [],
+ loadingFiles: [],
+ loadingImages: [],
+ messageToSend: null,
+ messageRestoreIfEmpty: null,
+ shouldShownAgentLoading: false,
+ submittedMessage: null,
+ shouldHideSuggestions: false,
+ hasRightPanelToggled: false,
+ planContent: null,
+ conversationMode: "code",
+ subConversationTaskId: null,
});
});
@@ -56,9 +77,9 @@ describe("conversation store", () => {
);
useConversationStore.getState().toggleImageUploadAsFile("paste.png");
- expect(useConversationStore.getState().imagesMarkedUploadAsFile).toEqual(
- ["paste.png"],
- );
+ expect(useConversationStore.getState().imagesMarkedUploadAsFile).toEqual([
+ "paste.png",
+ ]);
useConversationStore.getState().toggleImageUploadAsFile("paste.png");
expect(useConversationStore.getState().imagesMarkedUploadAsFile).toEqual(
@@ -118,4 +139,274 @@ describe("conversation store", () => {
expect(mockGetConversationState).toHaveBeenCalledWith(CONV_ID);
});
});
+
+ it("updates the panel, tab, loading, and suggestion flags", () => {
+ const store = useConversationStore.getState();
+ store.setIsRightPanelShown(true);
+ store.setSelectedTab("terminal");
+ store.setShouldShownAgentLoading(true);
+ store.setShouldHideSuggestions(true);
+ store.setHasRightPanelToggled(true);
+
+ expect(useConversationStore.getState()).toMatchObject({
+ isRightPanelShown: true,
+ selectedTab: "terminal",
+ shouldShownAgentLoading: true,
+ shouldHideSuggestions: true,
+ hasRightPanelToggled: true,
+ });
+ });
+
+ it("appends and removes files and images while preserving unrelated entries", () => {
+ const firstImage = new File(["a"], "first.png", { type: "image/png" });
+ const secondImage = new File(["b"], "second.png", { type: "image/png" });
+ const firstFile = new File(["a"], "first.txt");
+ const secondFile = new File(["b"], "second.txt");
+ const store = useConversationStore.getState();
+
+ store.addImages([firstImage]);
+ store.addImages([secondImage]);
+ store.addFiles([firstFile]);
+ store.addFiles([secondFile]);
+ store.markImagesAsPasted(["first.png", "first.png", "second.png"]);
+ store.toggleImageUploadAsFile("first.png");
+ store.toggleImageUploadAsFile("second.png");
+ store.removeImage(99);
+ expect(useConversationStore.getState()).toMatchObject({
+ images: [firstImage, secondImage],
+ imagesMarkedUploadAsFile: ["first.png", "second.png"],
+ pastedImageNames: ["first.png", "second.png"],
+ });
+
+ store.removeImage(0);
+ store.removeFile(0);
+ expect(useConversationStore.getState()).toMatchObject({
+ images: [secondImage],
+ files: [secondFile],
+ imagesMarkedUploadAsFile: ["second.png"],
+ pastedImageNames: ["second.png"],
+ });
+
+ store.removeFile(99);
+ expect(useConversationStore.getState().files).toEqual([secondFile]);
+ store.clearImages();
+ store.clearFiles();
+ expect(useConversationStore.getState()).toMatchObject({
+ images: [],
+ files: [],
+ });
+ });
+
+ it("deduplicates and removes file and image loading indicators", () => {
+ const store = useConversationStore.getState();
+ store.addFileLoading("one.txt");
+ store.addFileLoading("one.txt");
+ store.addFileLoading("two.txt");
+ store.addImageLoading("one.png");
+ store.addImageLoading("one.png");
+ store.addImageLoading("two.png");
+
+ expect(useConversationStore.getState()).toMatchObject({
+ loadingFiles: ["one.txt", "two.txt"],
+ loadingImages: ["one.png", "two.png"],
+ });
+
+ store.removeFileLoading("one.txt");
+ store.removeImageLoading("one.png");
+ expect(useConversationStore.getState()).toMatchObject({
+ loadingFiles: ["two.txt"],
+ loadingImages: ["two.png"],
+ });
+
+ store.clearAllLoading();
+ expect(useConversationStore.getState()).toMatchObject({
+ loadingFiles: [],
+ loadingImages: [],
+ });
+ });
+
+ it("clears every attachment and loading collection together", () => {
+ const image = new File(["a"], "one.png", { type: "image/png" });
+ const file = new File(["a"], "one.txt");
+ const store = useConversationStore.getState();
+ store.addImages([image]);
+ store.addFiles([file]);
+ store.toggleImageUploadAsFile("one.png");
+ store.markImagesAsPasted(["one.png"]);
+ store.addFileLoading("one.txt");
+ store.addImageLoading("one.png");
+
+ store.clearAllFiles();
+
+ expect(useConversationStore.getState()).toMatchObject({
+ images: [],
+ files: [],
+ imagesMarkedUploadAsFile: [],
+ pastedImageNames: [],
+ loadingFiles: [],
+ loadingImages: [],
+ });
+ });
+
+ it("creates and consumes timestamped send and restore requests", () => {
+ vi.spyOn(Date, "now").mockReturnValueOnce(100).mockReturnValueOnce(200);
+ const store = useConversationStore.getState();
+ store.setMessageToSend("send me");
+ store.restoreMessageToInputIfEmpty("restore me");
+ expect(useConversationStore.getState()).toMatchObject({
+ messageToSend: { text: "send me", timestamp: 100 },
+ messageRestoreIfEmpty: { text: "restore me", timestamp: 200 },
+ });
+
+ store.clearMessageToSend();
+ store.clearMessageRestoreIfEmpty();
+ expect(useConversationStore.getState()).toMatchObject({
+ messageToSend: null,
+ messageRestoreIfEmpty: null,
+ });
+ });
+
+ it("updates submitted, task, plan, and conversation-mode state without a route id", () => {
+ Object.defineProperty(window, "location", {
+ value: { pathname: "/" },
+ writable: true,
+ });
+ const store = useConversationStore.getState();
+ store.setSubmittedMessage("submitted");
+ store.setSubConversationTaskId("task-1");
+ store.setPlanContent("# Plan");
+ store.setConversationMode("plan");
+
+ expect(useConversationStore.getState()).toMatchObject({
+ submittedMessage: "submitted",
+ subConversationTaskId: "task-1",
+ planContent: "# Plan",
+ conversationMode: "plan",
+ });
+ expect(mockSetConversationState).not.toHaveBeenCalled();
+
+ store.setSubmittedMessage(null);
+ store.setSubConversationTaskId(null);
+ store.setPlanContent(null);
+ expect(useConversationStore.getState()).toMatchObject({
+ submittedMessage: null,
+ subConversationTaskId: null,
+ planContent: null,
+ });
+ });
+
+ it("resets transient conversation planning state from persisted mode", () => {
+ mockGetConversationState.mockReturnValue({
+ selectedTab: "files",
+ unpinnedTabs: [],
+ conversationMode: "plan",
+ });
+ useConversationStore.setState({
+ shouldHideSuggestions: true,
+ subConversationTaskId: "task",
+ planContent: "plan",
+ });
+
+ useConversationStore.getState().resetConversationState();
+
+ expect(useConversationStore.getState()).toMatchObject({
+ shouldHideSuggestions: false,
+ conversationMode: "plan",
+ subConversationTaskId: null,
+ planContent: null,
+ });
+ });
+
+ it.each([
+ [
+ "setIsRightPanelShown",
+ () => useConversationStore.getState().setIsRightPanelShown(true),
+ ],
+ ["clearImages", () => useConversationStore.getState().clearImages()],
+ ["clearAllFiles", () => useConversationStore.getState().clearAllFiles()],
+ [
+ "clearAllLoading",
+ () => useConversationStore.getState().clearAllLoading(),
+ ],
+ [
+ "setMessageToSend",
+ () => useConversationStore.getState().setMessageToSend("message"),
+ ],
+ [
+ "clearMessageToSend",
+ () => useConversationStore.getState().clearMessageToSend(),
+ ],
+ [
+ "setSubmittedMessage",
+ () => useConversationStore.getState().setSubmittedMessage("message"),
+ ],
+ [
+ "resetConversationState",
+ () => useConversationStore.getState().resetConversationState(),
+ ],
+ ])("%s preserves unrelated store state and actions", (_name, update) => {
+ useConversationStore.setState({ selectedTab: "planner" });
+
+ update();
+
+ expect(useConversationStore.getState().selectedTab).toBe("planner");
+ expect(useConversationStore.getState().setSelectedTab).toEqual(
+ expect.any(Function),
+ );
+ });
+
+ it("initializes safely without window and keeps mode changes in memory", async () => {
+ vi.resetModules();
+ vi.stubGlobal("window", undefined);
+
+ const serverModule = await import("#/stores/conversation-store");
+ expect(serverModule.useConversationStore.getState().conversationMode).toBe(
+ "code",
+ );
+ serverModule.useConversationStore.getState().setConversationMode("plan");
+ expect(serverModule.useConversationStore.getState().conversationMode).toBe(
+ "plan",
+ );
+ expect(mockSetConversationState).not.toHaveBeenCalled();
+
+ vi.unstubAllGlobals();
+ vi.resetModules();
+ });
+
+ it("initializes code mode without reading persistence when the route has no id", async () => {
+ Object.defineProperty(window, "location", {
+ value: { pathname: "/" },
+ writable: true,
+ });
+ mockGetConversationState.mockClear();
+ vi.resetModules();
+
+ const freshModule = await import("#/stores/conversation-store");
+
+ expect(freshModule.useConversationStore.getState().conversationMode).toBe(
+ "code",
+ );
+ expect(mockGetConversationState).not.toHaveBeenCalled();
+ });
+
+ it("initializes a fresh module from persisted conversation mode", async () => {
+ mockGetConversationState.mockReturnValue({
+ selectedTab: "files",
+ unpinnedTabs: [],
+ conversationMode: "plan",
+ });
+ Object.defineProperty(window, "location", {
+ value: { pathname: "/conversations/loaded-id/details" },
+ writable: true,
+ });
+ vi.resetModules();
+
+ const loadedModule = await import("#/stores/conversation-store");
+
+ expect(loadedModule.useConversationStore.getState().conversationMode).toBe(
+ "plan",
+ );
+ expect(mockGetConversationState).toHaveBeenCalledWith("loaded-id");
+ vi.resetModules();
+ });
});