Files
PaperClipAI/ui/src/context/FileViewerContext.tsx
T
DottaandPaperclip bded6ac5c7 [codex] Polish operator issue workflow UI (#9091)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The board UI is where operators create issues, inspect issue-thread
decisions, write markdown, and move between issue workflow surfaces.
> - A broad recovered branch mixed these operator workflow polish fixes
with unrelated backend, pipeline, plugin, eval, and work-product
changes.
> - Reviewers need the operator UI workflow fixes in a small PR that can
be understood without pulling in the rest of that recovery branch.
> - This pull request extracts only the issue workflow UI slice:
interaction cards, markdown editing fallback behavior, create-issue work
mode shortcuts, file-viewer URL handling, and issue navigation scroll
behavior.
> - The benefit is a lower-risk review path for operator workflow fixes
while keeping unrelated execution-workspace and server work out of this
PR.

## Linked Issues or Issue Description

- Refs #8866, the closed broad source PR that this focused slice was
extracted from.
- Related: #8228 is an open UI polish PR, but its file list does not
overlap this branch.
- Related: #4090 is older merged operator workflow polish context.

No public GitHub issue exists for this exact extracted slice. The
problem is that several small operator issue-workflow fixes were bundled
inside a broad recovery branch, making them hard to review and ship
independently.

## What Changed

- Removed interaction continuation wake-policy labels from issue-thread
interaction card headers and updated the card test/story copy
accordingly.
- Added a markdown editor error boundary so rich editor render crashes
fall back to a raw textarea instead of breaking the compose surface.
- Made the create-issue work-mode shortcut accept ctrl-period and iOS
hardware-keyboard command-period-as-Escape behavior without dismissing
the dialog.
- Fixed file-viewer URL navigation to compare against the live browser
search string when router state is stale.
- Restored scroll reset when navigating from an issue detail route back
to the issue index, while preserving browser-history restoration
behavior.

## Screenshots

Before removing the continuation wake-policy badge from interaction card
headers:

![Before: issue interaction card header with wake-policy
badge](https://gist.githubusercontent.com/cryppadotta/3e1030e3b379ffbbbcec4074d6cce4fa/raw/9bf44ee2bfea3a9930a68883f7f5ed2200613a51/issue-interaction-card-before.svg)

After removing the wake-policy badge:

![After: issue interaction card header without wake-policy
badge](https://gist.githubusercontent.com/cryppadotta/3e1030e3b379ffbbbcec4074d6cce4fa/raw/fa43b83f657833841e0e790bd851e4f57d4ded8e/issue-interaction-card-after.svg)

## Verification

- `pnpm exec vitest run
ui/src/components/IssueThreadInteractionCard.test.tsx
ui/src/components/MarkdownEditor.test.tsx
ui/src/components/NewIssueDialog.test.tsx
ui/src/context/FileViewerContext.test.ts
ui/src/lib/navigation-scroll.test.ts` — 5 files, 102 tests passed.
- `pnpm --filter @paperclipai/ui typecheck` — passed.
- `git diff --check` — passed.

## Risks

Low risk. The PR is limited to UI workflow components/helpers and their
tests. Main behavioral risks are keyboard shortcut edge cases across
browsers and fallback editor rendering, both covered by focused tests.

## Model Used

OpenAI Codex, GPT-5-based coding agent (`gpt-5` family; exact served
variant and context window are not exposed in this runtime), with
terminal, Git, GitHub, and test execution tools.

## 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)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
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] 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>
2026-07-06 16:34:57 -05:00

338 lines
12 KiB
TypeScript

import { createContext, useContext, useCallback, useMemo, type ReactNode } from "react";
import { useLocation, useNavigate, type NavigateOptions } from "@/lib/router";
import type { WorkspaceFileSelector } from "@paperclipai/shared";
import type { ParsedWorkspaceFileRef } from "@/lib/workspace-file-parser";
export interface FileViewerUrlState {
path: string;
line: number | null;
column: number | null;
workspace: WorkspaceFileSelector;
projectId: string | null;
workspaceId: string | null;
}
export interface FileViewerContextValue {
issueId: string;
/** Current viewer state derived from the URL, or null if closed. */
state: FileViewerUrlState | null;
/** True when the sheet is in browse mode (URL carries `browse=1`). */
browse: boolean;
/** The active browse search query (URL `q`), or null. */
query: string | null;
browseProjectId: string | null;
browseWorkspaceId: string | null;
folderPath: string | null;
open(
ref: Pick<ParsedWorkspaceFileRef, "path" | "line" | "column" | "projectId" | "workspaceId"> & {
workspace?: WorkspaceFileSelector;
},
opts?: {
fromBrowse?: boolean;
browseState?: Partial<FileViewerBrowseState>;
},
): void;
/** Open (or stay in) browse mode, optionally seeding the search query. */
openBrowse(opts?: { q?: string }): void;
/** Update URL-backed browse state without closing the active preview. */
updateBrowseState(opts: Partial<FileViewerBrowseState>): void;
openFolder(
ref: Pick<ParsedWorkspaceFileRef, "path" | "projectId" | "workspaceId"> & {
workspace?: WorkspaceFileSelector;
},
): void;
/** From a file opened via browse, return to the browse list. */
backToFiles(): void;
close(): void;
}
const FileViewerContext = createContext<FileViewerContextValue | null>(null);
export const FILE_VIEWER_NAVIGATE_OPTIONS = {
replace: false,
preventScrollReset: true,
} satisfies NavigateOptions;
export function getCurrentFileViewerSearch(fallbackSearch: string): string {
if (typeof window === "undefined") return fallbackSearch;
return window.location.search;
}
export function shouldNavigateFileViewerSearch(nextSearch: string, fallbackSearch: string): boolean {
return nextSearch !== getCurrentFileViewerSearch(fallbackSearch);
}
export function readFileViewerStateFromSearch(search: string): FileViewerUrlState | null {
const params = new URLSearchParams(search);
const path = params.get("file");
if (!path) return null;
const lineRaw = params.get("line");
const columnRaw = params.get("column");
const workspaceRaw = params.get("workspace");
const projectIdRaw = params.get("projectId");
const workspaceIdRaw = params.get("workspaceId");
const hasExplicitTarget = Boolean(projectIdRaw && workspaceIdRaw);
const line = lineRaw ? Number.parseInt(lineRaw, 10) : NaN;
const column = columnRaw ? Number.parseInt(columnRaw, 10) : NaN;
const workspace = (workspaceRaw === "execution" || workspaceRaw === "project")
? workspaceRaw
: "auto";
return {
path,
line: Number.isFinite(line) && line > 0 ? line : null,
column: Number.isFinite(column) && column > 0 ? column : null,
workspace,
projectId: hasExplicitTarget ? projectIdRaw : null,
workspaceId: hasExplicitTarget ? workspaceIdRaw : null,
};
}
export function writeFileViewerStateToSearch(current: string, next: FileViewerUrlState | null): string {
const params = new URLSearchParams(current);
// A direct file open/close is never a browse origin — clear browse params too.
params.delete("browse");
params.delete("q");
params.delete("folder");
if (!next) {
params.delete("file");
params.delete("line");
params.delete("column");
params.delete("workspace");
params.delete("projectId");
params.delete("workspaceId");
} else {
params.set("file", next.path);
if (next.line !== null) params.set("line", String(next.line));
else params.delete("line");
if (next.column !== null) params.set("column", String(next.column));
else params.delete("column");
if (next.workspace && next.workspace !== "auto") params.set("workspace", next.workspace);
else params.delete("workspace");
if (next.projectId) params.set("projectId", next.projectId);
else params.delete("projectId");
if (next.workspaceId) params.set("workspaceId", next.workspaceId);
else params.delete("workspaceId");
}
const str = params.toString();
return str ? `?${str}` : "";
}
export interface FileViewerBrowseState {
q: string | null;
folderPath: string | null;
projectId: string | null;
workspaceId: string | null;
}
export function readBrowseStateFromSearch(search: string): FileViewerBrowseState | null {
const params = new URLSearchParams(search);
if (params.get("browse") !== "1") return null;
const q = params.get("q");
const folder = params.get("folder");
const projectId = params.get("projectId");
const workspaceId = params.get("workspaceId");
return {
q: q && q.length > 0 ? q : null,
folderPath: folder && folder.length > 0 ? folder : null,
projectId: projectId || null,
workspaceId: workspaceId || null,
};
}
export function writeFolderViewerStateToSearch(
current: string,
next: {
path: string;
projectId: string | null;
workspaceId: string | null;
},
): string {
const params = new URLSearchParams(current);
params.delete("file");
params.delete("line");
params.delete("column");
params.delete("workspace");
params.delete("q");
params.set("browse", "1");
params.set("folder", next.path);
if (next.projectId) params.set("projectId", next.projectId);
else params.delete("projectId");
if (next.workspaceId) params.set("workspaceId", next.workspaceId);
else params.delete("workspaceId");
const str = params.toString();
return str ? `?${str}` : "";
}
export function writeBrowseStateToSearch(current: string, next: Partial<FileViewerBrowseState>): string {
const params = new URLSearchParams(current);
params.set("browse", "1");
if ("q" in next) {
const q = next.q?.trim() ?? "";
if (q) params.set("q", q);
else params.delete("q");
}
if ("folderPath" in next) {
const folderPath = next.folderPath?.trim() ?? "";
if (folderPath) params.set("folder", folderPath);
else params.delete("folder");
}
if ("projectId" in next) {
if (next.projectId) params.set("projectId", next.projectId);
else params.delete("projectId");
}
if ("workspaceId" in next) {
if (next.workspaceId) params.set("workspaceId", next.workspaceId);
else params.delete("workspaceId");
}
const str = params.toString();
return str ? `?${str}` : "";
}
interface FileViewerProviderProps {
issueId: string;
children: ReactNode;
enabled?: boolean;
}
export function FileViewerProvider({ issueId, children, enabled = true }: FileViewerProviderProps) {
if (!enabled) return <>{children}</>;
return <EnabledFileViewerProvider issueId={issueId}>{children}</EnabledFileViewerProvider>;
}
function EnabledFileViewerProvider({ issueId, children }: Omit<FileViewerProviderProps, "enabled">) {
const location = useLocation();
const navigate = useNavigate();
const state = useMemo(() => readFileViewerStateFromSearch(location.search), [location.search]);
const browseState = useMemo(() => readBrowseStateFromSearch(location.search), [location.search]);
const navigateSearch = useCallback(
(nextSearch: string, opts?: Partial<NavigateOptions>) => {
if (!shouldNavigateFileViewerSearch(nextSearch, location.search)) return;
navigate(
{ pathname: location.pathname, hash: location.hash, search: nextSearch },
{ ...FILE_VIEWER_NAVIGATE_OPTIONS, ...opts, state: location.state },
);
},
[location.hash, location.pathname, location.state, navigate],
);
const open = useCallback<FileViewerContextValue["open"]>(
(ref, opts) => {
let nextSearch = writeFileViewerStateToSearch(location.search, {
path: ref.path,
line: ref.line ?? null,
column: ref.column ?? null,
workspace: ref.workspace ?? "auto",
projectId: ref.projectId ?? null,
workspaceId: ref.workspaceId ?? null,
});
if (opts?.fromBrowse) {
const params = new URLSearchParams(nextSearch);
params.set("browse", "1");
const previousParams = new URLSearchParams(location.search);
const prevQ = previousParams.get("q");
const prevFolder = previousParams.get("folder");
const nextQ = Object.prototype.hasOwnProperty.call(opts.browseState ?? {}, "q")
? opts.browseState?.q
: prevQ;
const nextFolder = Object.prototype.hasOwnProperty.call(opts.browseState ?? {}, "folderPath")
? opts.browseState?.folderPath
: prevFolder;
if (nextQ) params.set("q", nextQ);
else params.delete("q");
if (nextFolder) params.set("folder", nextFolder);
else params.delete("folder");
nextSearch = params.toString() ? `?${params.toString()}` : "";
}
navigateSearch(nextSearch);
},
[location.search, navigateSearch],
);
const openBrowse = useCallback<FileViewerContextValue["openBrowse"]>(
(opts) => {
const params = new URLSearchParams(location.search);
params.delete("file");
params.delete("line");
params.delete("column");
params.delete("folder");
params.set("browse", "1");
if (typeof opts?.q === "string" && opts.q.length > 0) params.set("q", opts.q);
else params.delete("q");
navigateSearch(params.toString() ? `?${params.toString()}` : "");
},
[location.search, navigateSearch],
);
const updateBrowseState = useCallback<FileViewerContextValue["updateBrowseState"]>(
(opts) => {
navigateSearch(writeBrowseStateToSearch(location.search, opts), { replace: true });
},
[location.search, navigateSearch],
);
const openFolder = useCallback<FileViewerContextValue["openFolder"]>(
(ref) => {
const nextSearch = writeFolderViewerStateToSearch(location.search, {
path: ref.path,
projectId: ref.projectId ?? null,
workspaceId: ref.workspaceId ?? null,
});
navigateSearch(nextSearch);
},
[location.search, navigateSearch],
);
const backToFiles = useCallback(() => {
const params = new URLSearchParams(location.search);
params.delete("file");
params.delete("line");
params.delete("column");
params.delete("workspace");
params.set("browse", "1");
navigateSearch(params.toString() ? `?${params.toString()}` : "");
}, [location.search, navigateSearch]);
const close = useCallback(() => {
const currentSearch = getCurrentFileViewerSearch(location.search);
const params = new URLSearchParams(writeFileViewerStateToSearch(currentSearch, null).replace(/^\?/, ""));
params.delete("browse");
params.delete("q");
params.delete("folder");
navigateSearch(params.toString() ? `?${params.toString()}` : "");
}, [location.search, navigateSearch]);
const value = useMemo<FileViewerContextValue>(
() => ({
issueId,
state,
browse: browseState !== null,
query: browseState?.q ?? null,
browseProjectId: browseState?.projectId ?? null,
browseWorkspaceId: browseState?.workspaceId ?? null,
folderPath: browseState?.folderPath ?? null,
open,
openBrowse,
updateBrowseState,
openFolder,
backToFiles,
close,
}),
[issueId, state, browseState, open, openBrowse, updateBrowseState, openFolder, backToFiles, close],
);
return <FileViewerContext.Provider value={value}>{children}</FileViewerContext.Provider>;
}
export function useFileViewer(): FileViewerContextValue | null {
return useContext(FileViewerContext);
}
export function useRequiredFileViewer(): FileViewerContextValue {
const ctx = useContext(FileViewerContext);
if (!ctx) {
throw new Error("useRequiredFileViewer must be used within a FileViewerProvider");
}
return ctx;
}