7069053a1f
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Issue work mode controls how a task starts and how the conversation composer frames the operator's intent. > - Paperclip already supports standard agent execution and planning mode, but there is no lightweight mode for asking a question without immediately implying execution or plan drafting. > - That gap makes low-commitment clarification workflows look like normal task execution. > - This pull request adds an explicit Ask mode and threads it through shared contracts, server heartbeat context, and the issue composer UI. > - The benefit is that operators can create or switch a task into a question-oriented mode while preserving existing agent and planning flows. ## Linked Issues or Issue Description No public GitHub issue exists for this change. Inline feature request follows the repository feature request template. ### Subsystem affected Cross-cutting: `packages/shared`, `server/`, and `ui/`. ### Problem or motivation Issue conversations currently distinguish standard agent work from planning work, but question-first conversations do not have a clear public mode in the shared contract or UI. Operators who want to ask an agent a focused question have to use standard mode, which can imply normal task execution, or planning mode, which asks for a plan rather than an answer. ### Proposed solution Add Ask as a first-class issue work mode. It should be selectable from issue creation and issue chat, cycle alongside Standard and Planning from the keyboard shortcut/menu, appear distinctly in composer styling, and be included in heartbeat context so agents know to answer directly instead of executing or drafting a plan. ### Alternatives considered - Keep using standard mode for questions: rejected because it does not communicate answer-only intent to the agent or the UI. - Reuse planning mode for questions: rejected because planning mode asks for a plan and is semantically different from asking a question. - Add only local UI copy: rejected because the mode needs to be represented in the shared contract and server heartbeat context to be reliable. ### Roadmap alignment This is a focused issue-workflow improvement. `ROADMAP.md` was checked and no duplicate planned core work was found. ### Additional context Related public searches performed before opening this PR: - GitHub PR search for `"ask mode" repo:paperclipai/paperclip` - GitHub issue search for `"ask mode" repo:paperclipai/paperclip` - GitHub PR search for `"work mode" "ask" repo:paperclipai/paperclip` No duplicate PR was found. ## What Changed - Added `ask` to the shared issue work-mode contract and validation coverage. - Included issue work mode in heartbeat context summaries so agents can see standard, planning, and ask state. - Added Ask mode metadata, styling, composer tone handling, and selection/cycling behavior in the issue chat/new issue UI. - Updated focused tests for shared validators, heartbeat context, and affected UI work-mode flows. ## Verification - `NODE_ENV=test pnpm exec vitest run ui/src/components/ChatComposer.test.tsx ui/src/components/IssueChatThread.test.tsx ui/src/components/NewIssueDialog.test.tsx ui/src/lib/work-mode-meta.test.ts` - `NODE_ENV=test pnpm exec vitest run packages/shared/src/validators/issue.test.ts server/src/__tests__/heartbeat-context-summary.test.ts server/src/__tests__/issues-service.test.ts ui/src/components/ChatComposer.test.tsx ui/src/components/IssueChatThread.test.tsx ui/src/components/NewIssueDialog.test.tsx ui/src/lib/work-mode-meta.test.ts ui/src/pages/IssueDetail.test.tsx` The broader targeted command passed 8 test files / 245 tests. Visual reference for Standard/Planning/Ask composer states: https://gist.github.com/cryppadotta/714d8590bac55500a65e7e16de5bb4b8 It emitted an expected warning from an existing server test fixture about a missing run-log fixture while verifying derived issue comment metadata. ## Risks Low to moderate risk. This adds a new enum value that crosses shared, server, and UI contracts. Existing standard and planning modes are preserved, but any downstream code assuming only two non-terminal work modes may need to handle `ask`. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI GPT-5 Codex coding agent in Paperclip CodexCoder mode, with shell, git, GitHub connector, and local test execution tools. Context window and exact hosted model snapshot are not exposed in this runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [ ] My branch name describes the change (e.g. `docs/...`, `fix/...`, `feat/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
255 lines
9.0 KiB
TypeScript
255 lines
9.0 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act, useState } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { ChatComposer, type ChatComposerProps } from "./ChatComposer";
|
|
|
|
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
/** Stateful harness so the controlled textarea reflects typed input. */
|
|
function Harness(props: Partial<ChatComposerProps> & { initial?: string }) {
|
|
const { initial = "", onChange, ...rest } = props;
|
|
const [value, setValue] = useState(initial);
|
|
return (
|
|
<ChatComposer
|
|
value={value}
|
|
onChange={(v) => {
|
|
setValue(v);
|
|
onChange?.(v);
|
|
}}
|
|
onSubmit={rest.onSubmit ?? (() => {})}
|
|
{...rest}
|
|
/>
|
|
);
|
|
}
|
|
|
|
function typeInput(textarea: HTMLTextAreaElement, text: string) {
|
|
const setter = Object.getOwnPropertyDescriptor(
|
|
window.HTMLTextAreaElement.prototype,
|
|
"value",
|
|
)?.set;
|
|
setter?.call(textarea, text);
|
|
textarea.dispatchEvent(new Event("input", { bubbles: true }));
|
|
}
|
|
|
|
describe("ChatComposer", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
});
|
|
|
|
function input() {
|
|
return container.querySelector<HTMLTextAreaElement>('[data-testid="chat-composer-input"]')!;
|
|
}
|
|
function sendButton() {
|
|
return container.querySelector<HTMLButtonElement>('button[aria-label="Send message"]')!;
|
|
}
|
|
function attachButton() {
|
|
return container.querySelector<HTMLButtonElement>('button[aria-label="Attach files"]');
|
|
}
|
|
|
|
it("renders a bare textarea + send and no attach button without a handler", () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness placeholder="Ask anything…" />);
|
|
});
|
|
expect(input()).toBeTruthy();
|
|
expect(input().placeholder).toBe("Ask anything…");
|
|
expect(attachButton()).toBeNull();
|
|
// No formatting toolbar — there is exactly one button (send) when bare.
|
|
expect(container.querySelectorAll("button").length).toBe(1);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("shows the attach affordance when onAttachFiles is provided", () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness onAttachFiles={() => {}} />);
|
|
});
|
|
expect(attachButton()).toBeTruthy();
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("disables send while empty and enables it once there is text", () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness />);
|
|
});
|
|
expect(sendButton().disabled).toBe(true);
|
|
act(() => {
|
|
typeInput(input(), "hello");
|
|
});
|
|
expect(sendButton().disabled).toBe(false);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("submits on click", () => {
|
|
const onSubmit = vi.fn();
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness onSubmit={onSubmit} initial="hi" />);
|
|
});
|
|
act(() => {
|
|
sendButton().dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
expect(onSubmit).toHaveBeenCalledTimes(1);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('submitKey="enter": plain Enter submits, Shift+Enter does not', () => {
|
|
const onSubmit = vi.fn();
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness onSubmit={onSubmit} initial="hi" submitKey="enter" />);
|
|
});
|
|
act(() => {
|
|
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true, shiftKey: true }));
|
|
});
|
|
expect(onSubmit).not.toHaveBeenCalled();
|
|
act(() => {
|
|
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
|
|
});
|
|
expect(onSubmit).toHaveBeenCalledTimes(1);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('submitKey="mod-enter": plain Enter does not submit, Cmd/Ctrl+Enter does', () => {
|
|
const onSubmit = vi.fn();
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness onSubmit={onSubmit} initial="hi" submitKey="mod-enter" />);
|
|
});
|
|
act(() => {
|
|
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
|
|
});
|
|
expect(onSubmit).not.toHaveBeenCalled();
|
|
act(() => {
|
|
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true, metaKey: true }));
|
|
});
|
|
expect(onSubmit).toHaveBeenCalledTimes(1);
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("singleLine strips newlines from input", () => {
|
|
const onChange = vi.fn();
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness singleLine onChange={onChange} />);
|
|
});
|
|
act(() => {
|
|
typeInput(input(), "one\ntwo");
|
|
});
|
|
expect(onChange).toHaveBeenLastCalledWith("one two");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("default (multiline) mode soft-wraps and auto-grows instead of clipping (PAP-116)", () => {
|
|
// The conference room composer adopts this default mode. Text must wrap and
|
|
// the box grow up to a cap — never clip horizontally or show an idle scrollbar.
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness />);
|
|
});
|
|
const el = input();
|
|
expect(el.getAttribute("wrap")).toBe("soft");
|
|
expect(el.className).toContain("overflow-y-auto");
|
|
expect(el.className).toContain("max-h-[200px]");
|
|
expect(el.className).not.toContain("whitespace-nowrap");
|
|
expect(el.className).not.toContain("overflow-x-auto");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("singleLine mode clips to one row (opt-in only)", () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness singleLine />);
|
|
});
|
|
const el = input();
|
|
expect(el.getAttribute("wrap")).toBe("off");
|
|
expect(el.className).toContain("whitespace-nowrap");
|
|
expect(el.className).toContain("max-h-[22px]");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('tone="planning" is reflected on the container', () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness tone="planning" />);
|
|
});
|
|
const box = container.querySelector('[data-testid="chat-composer"]');
|
|
expect(box?.getAttribute("data-tone")).toBe("planning");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('tone="ask" is reflected on the container', () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness tone="ask" />);
|
|
});
|
|
const box = container.querySelector('[data-testid="chat-composer"]');
|
|
expect(box?.getAttribute("data-tone")).toBe("ask");
|
|
expect(box?.className).toContain("sky");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('defaults to the opaque "card" surface', () => {
|
|
// PAP-131: surface is opt-in — existing adopters keep the bg-card box.
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness />);
|
|
});
|
|
const box = container.querySelector('[data-testid="chat-composer"]')!;
|
|
expect(box.getAttribute("data-surface")).toBe("card");
|
|
expect(box.className).toContain("bg-card");
|
|
expect(box.className).not.toContain("backdrop-blur");
|
|
// Rounded corners are shared chrome on both surfaces.
|
|
expect(box.className).toContain("rounded-xl");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it('surface="translucent" applies the task glass recipe and keeps shared chrome (PAP-131)', () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness surface="translucent" />);
|
|
});
|
|
const box = container.querySelector('[data-testid="chat-composer"]')!;
|
|
expect(box.getAttribute("data-surface")).toBe("translucent");
|
|
// Glass recipe — mirrors the task-comments composer shell.
|
|
expect(box.className).toContain("bg-background/95");
|
|
expect(box.className).toContain("supports-[backdrop-filter]:bg-background/85");
|
|
expect(box.className).toContain("backdrop-blur");
|
|
expect(box.className).toContain("shadow-[0_-12px_28px_rgba(15,23,42,0.08)]");
|
|
expect(box.className).toContain("dark:shadow-[0_-12px_28px_rgba(0,0,0,0.28)]");
|
|
expect(box.className).not.toContain("bg-card");
|
|
// Shared chrome survives: rounded-xl corners + neutral focus darkening.
|
|
expect(box.className).toContain("rounded-xl");
|
|
expect(box.className).toContain("focus-within:border-muted-foreground/40");
|
|
act(() => root.unmount());
|
|
});
|
|
|
|
it("translucent surface keeps the drag-over attach layering", () => {
|
|
const root = createRoot(container);
|
|
act(() => {
|
|
root.render(<Harness surface="translucent" onAttachFiles={() => {}} />);
|
|
});
|
|
const box = container.querySelector<HTMLDivElement>('[data-testid="chat-composer"]')!;
|
|
act(() => {
|
|
const dataTransfer = { types: ["Files"], dropEffect: "none" };
|
|
const evt = new Event("dragenter", { bubbles: true }) as DragEvent & {
|
|
dataTransfer: typeof dataTransfer;
|
|
};
|
|
Object.defineProperty(evt, "dataTransfer", { value: dataTransfer });
|
|
box.dispatchEvent(evt);
|
|
});
|
|
expect(container.querySelector('[data-testid="chat-composer-drop-overlay"]')).toBeTruthy();
|
|
act(() => root.unmount());
|
|
});
|
|
});
|