-
Notifications
You must be signed in to change notification settings - Fork 5.6k
fix(web): keep citation comment when popover is dismissed #10831
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
flamboh
wants to merge
6
commits into
pingdotgg:main
Choose a base branch
from
flamboh:fix/web-citation-comment-dismiss
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+310
−11
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9217a91
fix(web): keep citation comment when popover is dismissed
flamboh f75f107
fix(web): keep citation popover open when dismissal save is refused
flamboh 8db937f
fix(web): treat whitespace-only comment differences as unchanged
flamboh 37e0786
chore(web): drop citation dismissal comments
flamboh 9d54e21
fix(web): preserve citation drafts when source disappears
flamboh 809f68d
Merge branch 'main' into fix/web-citation-comment-dismiss
flamboh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
152 changes: 152 additions & 0 deletions
152
apps/web/src/components/chat/AssistantCitationChip.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| import { | ||
| ASSISTANT_CITATION_MAX_COMMENT_LENGTH, | ||
| EnvironmentId, | ||
| MessageId, | ||
| ThreadId, | ||
| } from "@t3tools/contracts"; | ||
| import { act, useState, type ReactNode } from "react"; | ||
| import { create, type ReactTestRenderer } from "react-test-renderer"; | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test"; | ||
|
|
||
| import type { AssistantCitationSourceAnchor } from "~/lib/assistantTextSelection"; | ||
|
|
||
| const mocks = vi.hoisted(() => ({ observeSource: vi.fn(), dispose: vi.fn() })); | ||
| vi.mock("./AssistantCitationSource", () => ({ | ||
| observeAssistantCitationCommentSource: mocks.observeSource, | ||
| })); | ||
| vi.mock("@tanstack/react-router", () => ({ | ||
| useNavigate: () => vi.fn(), | ||
| Link: ({ children }: { children: ReactNode }) => <a>{children}</a>, | ||
| })); | ||
| // Keep the real chip/editor lifecycle while replacing DOM positioning and portals. | ||
| vi.mock("../ui/popover", () => ({ | ||
| Popover: ({ children }: { children: ReactNode }) => <>{children}</>, | ||
| PopoverTrigger: ({ children }: { children: ReactNode }) => <button>{children}</button>, | ||
| PopoverPopup: ({ children }: { children: ReactNode }) => <>{children}</>, | ||
| })); | ||
| vi.mock("../ui/button", () => ({ | ||
| Button: (props: React.ComponentProps<"button">) => <button {...props} />, | ||
| })); | ||
|
|
||
| import { PopoverPopup } from "../ui/popover"; | ||
| import { AssistantCitationChip } from "./AssistantCitationChip"; | ||
|
|
||
| const citation = { | ||
| version: 1 as const, | ||
| environmentId: EnvironmentId.make("environment"), | ||
| threadId: ThreadId.make("thread"), | ||
| messageId: MessageId.make("source"), | ||
| text: "hello", | ||
| start: 0, | ||
| end: 5, | ||
| prefix: "", | ||
| suffix: "", | ||
| }; | ||
| // The observer owns DOM access; these identities let us check which anchor survives. | ||
| const sourceAnchor = { | ||
| source: {}, | ||
| range: {}, | ||
| viewport: {}, | ||
| } as AssistantCitationSourceAnchor; | ||
|
|
||
| let renderer: ReactTestRenderer; | ||
|
|
||
| function mount(onSave = vi.fn(() => true)) { | ||
| function Composer() { | ||
| const [open, setOpen] = useState(true); | ||
| return ( | ||
| <AssistantCitationChip | ||
| citation={citation} | ||
| onRemove={() => {}} | ||
| commentEditor={{ open, sourceAnchor, onOpenChange: setOpen, onSave }} | ||
| /> | ||
| ); | ||
| } | ||
| act(() => { | ||
| renderer = create(<Composer />); | ||
| }); | ||
| return onSave; | ||
| } | ||
|
|
||
| function typeComment(value: string) { | ||
| act(() => renderer.root.findByType("textarea").props.onChange({ currentTarget: { value } })); | ||
| } | ||
|
|
||
| function removeSource() { | ||
| const { onUnavailable } = mocks.observeSource.mock.lastCall![0]; | ||
| act(() => onUnavailable()); | ||
| } | ||
|
|
||
| function clickButton(label: string) { | ||
| act(() => | ||
| renderer.root | ||
| .findAllByType("button") | ||
| .find((button) => button.props.children === label)! | ||
| .props.onClick(), | ||
| ); | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true); | ||
| mocks.observeSource.mockReset().mockReturnValue(mocks.dispose); | ||
| mocks.dispose.mockClear(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| act(() => renderer?.unmount()); | ||
| vi.unstubAllGlobals(); | ||
| }); | ||
|
|
||
| describe("citation comment source disappearance", () => { | ||
| it("preserves an over-length draft at the composer until it can be shortened and saved", () => { | ||
| const onSave = mount(); | ||
| const draft = "x".repeat(ASSISTANT_CITATION_MAX_COMMENT_LENGTH + 1); | ||
| typeComment(draft); | ||
| removeSource(); | ||
|
|
||
| expect(renderer.root.findByType("textarea").props.value).toBe(draft); | ||
| expect(renderer.root.findByType("textarea").props["aria-invalid"]).toBe(true); | ||
| expect(renderer.root.findByType(PopoverPopup).props.anchor).toBeUndefined(); | ||
| expect(renderer.root.findByType(PopoverPopup).props.side).toBe("top"); | ||
| expect(onSave).not.toHaveBeenCalled(); | ||
| expect(mocks.dispose).toHaveBeenCalled(); | ||
| expect(mocks.observeSource).toHaveBeenCalledTimes(1); | ||
|
|
||
| typeComment("shortened comment"); | ||
| clickButton("Save"); | ||
| expect(onSave).toHaveBeenCalledWith("shortened comment"); | ||
| expect(renderer.root.findAllByType("textarea")).toHaveLength(0); | ||
| }); | ||
|
|
||
| it("preserves a rejected save and allows a later retry", () => { | ||
| const onSave = mount(vi.fn(() => false)); | ||
| typeComment("keep this draft"); | ||
| removeSource(); | ||
|
|
||
| expect(onSave).toHaveBeenCalledWith("keep this draft"); | ||
| expect(renderer.root.findByType("textarea").props.value).toBe("keep this draft"); | ||
| expect(renderer.root.findByType(PopoverPopup).props.anchor).toBeUndefined(); | ||
| onSave.mockReturnValue(true); | ||
| clickButton("Save"); | ||
| expect(onSave).toHaveBeenLastCalledWith("keep this draft"); | ||
| expect(renderer.root.findAllByType("textarea")).toHaveLength(0); | ||
| }); | ||
|
|
||
| it("still allows explicit cancellation after source disappearance", () => { | ||
| const onSave = mount(vi.fn(() => false)); | ||
| typeComment("discard this draft"); | ||
| removeSource(); | ||
| onSave.mockClear(); | ||
| clickButton("Cancel"); | ||
| expect(onSave).not.toHaveBeenCalled(); | ||
| expect(renderer.root.findAllByType("textarea")).toHaveLength(0); | ||
| }); | ||
|
|
||
| it("saves and closes when the source disappears with a valid draft", () => { | ||
| const onSave = mount(); | ||
| typeComment("saved comment"); | ||
| removeSource(); | ||
| expect(onSave).toHaveBeenCalledWith("saved comment"); | ||
| expect(renderer.root.findAllByType("textarea")).toHaveLength(0); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
apps/web/src/components/chat/assistantCitationCommentDismissal.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| import { ASSISTANT_CITATION_MAX_COMMENT_LENGTH } from "@t3tools/contracts"; | ||
| import { describe, expect, it } from "vite-plus/test"; | ||
|
|
||
| import { resolveAssistantCitationCommentDismissal } from "./assistantCitationCommentDismissal"; | ||
|
|
||
| describe("resolveAssistantCitationCommentDismissal", () => { | ||
| it("commits typed text when the popover is dismissed by clicking away", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "outside-press", | ||
| draft: "needs a retry", | ||
| savedComment: undefined, | ||
| }), | ||
| ).toEqual({ kind: "commit", comment: "needs a retry" }); | ||
| }); | ||
|
|
||
| it("commits an edited comment when focus leaves the popover", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "focus-out", | ||
| draft: "second thought", | ||
| savedComment: "first thought", | ||
| }), | ||
| ).toEqual({ kind: "commit", comment: "second thought" }); | ||
| }); | ||
|
|
||
| it("closes without saving when nothing changed", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "outside-press", | ||
| draft: null, | ||
| savedComment: "kept", | ||
| }), | ||
| ).toEqual({ kind: "close" }); | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "outside-press", | ||
| draft: " kept ", | ||
| savedComment: "kept", | ||
| }), | ||
| ).toEqual({ kind: "close" }); | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "outside-press", | ||
| draft: "kept", | ||
| savedComment: " kept ", | ||
| }), | ||
| ).toEqual({ kind: "close" }); | ||
| }); | ||
|
|
||
| it("clears a comment when the draft was emptied", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "trigger-press", | ||
| draft: "", | ||
| savedComment: "old", | ||
| }), | ||
| ).toEqual({ kind: "commit", comment: "" }); | ||
| }); | ||
|
|
||
| it("keeps Escape as an explicit discard", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "escape-key", | ||
| draft: "unsaved", | ||
| savedComment: undefined, | ||
| }), | ||
| ).toEqual({ kind: "close" }); | ||
| }); | ||
|
|
||
| it("keeps the popover open instead of dropping an over-length draft", () => { | ||
| expect( | ||
| resolveAssistantCitationCommentDismissal({ | ||
| reason: "outside-press", | ||
| draft: "x".repeat(ASSISTANT_CITATION_MAX_COMMENT_LENGTH + 1), | ||
| savedComment: undefined, | ||
| }), | ||
| ).toEqual({ kind: "keep-open" }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.