mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-18 23:08:26 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The board UI wraps every page in an `EditorAutocompleteProvider` that supplies slash commands to Markdown editors > - The provider read the full company skills and routines lists as soon as a company was selected, on every page > - The Mine inbox has no editor, but it still paid for both reads: 259–284 KB for skills and 225–333 KB for routines on our dev and staging instances, with skills taking 8.5–13.7 s on a saturated staging server > - Those reads compete with the inbox rows for the same server > - This pull request starts the two reads only when the first Markdown editor mounts > - The benefit is two fewer large reads on every page without an editor, and no change for pages that have one ## Linked Issues or Issue Description **What existing behavior does this improve?** The requests that every board UI page sends on load. **Subsystem affected** Board UI context (`ui/src/context/EditorAutocompleteContext.tsx`). **Current behavior** A cold load of `/:prefix/issues?view=mine` sends `GET /companies/:id/skills` and `GET /companies/:id/routines` although nothing on the page renders them. **Proposed behavior** The provider keeps both queries disabled until a component calls `useEditorAutocomplete()`. `MarkdownEditor` is the only caller, so the reads start when an editor mounts: a task composer, the new-task dialog when it opens, a comment box. **Reason and benefit** Each page without an editor saves two large reads. Pages with an editor read the same data at mount, before a user can type `/`. ## What Changed - `EditorAutocompleteProvider` holds a `requested` flag. Both queries are `enabled` only after it is set. - `useEditorAutocomplete()` sets the flag in an effect on first use. The flag stays set, so the lists stay current through the existing live-update invalidations for skills and routines. - New unit test `EditorAutocompleteContext.test.tsx`: no reads without an editor; one read of each list when two editors mount. - New browser check `tests/perf/collections/shell-editor-reads.spec.ts`: a Mine load sends no `skills` or `routines` request. ## Verification - `pnpm verify` passes. - `ui`: `npx vitest run src/context/EditorAutocompleteContext.test.tsx src/components/task-chat/TaskChatComposer.test.tsx` passes. - Browser check against a disposable local instance: `PAPERCLIP_COLLECTION_PERF_BASE_URL=http://127.0.0.1:<port> pnpm exec playwright test --config tests/perf/collections/playwright.config.ts shell-editor-reads.spec.ts`. It passes on this branch and fails on `master`. - Manual: on a local instance the Mine load dropped from 34 to 32 API requests. Opening a task shows the composer; `/` lists skills and routines as before. ## Risks - Low risk. On the first editor mount the slash menu is empty until the two reads return. On `master` the same reads ran at app start, so a user who typed `/` within the first moments of a page with an editor saw the same gap. - `attention/summary` is not changed. The navigation's "Needs you" count renders it on the Mine page. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, via Claude Code with tool use (shell, file edits, browser). 1M-token context window. Extended thinking was off. ## 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 - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
125 lines
4.0 KiB
TypeScript
125 lines
4.0 KiB
TypeScript
import { createContext, useCallback, useContext, useEffect, useMemo, useState, type ReactNode } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import { buildRoutineMentionHref, buildSkillMentionHref } from "@paperclipai/shared";
|
|
import { companySkillsApi } from "../api/companySkills";
|
|
import { routinesApi } from "../api/routines";
|
|
import { useCompany } from "./CompanyContext";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
|
|
export interface SkillCommandOption {
|
|
id: string;
|
|
kind: "skill";
|
|
skillId: string;
|
|
key: string;
|
|
name: string;
|
|
slug: string;
|
|
description: string | null;
|
|
href: string;
|
|
aliases: string[];
|
|
}
|
|
|
|
export interface RoutineCommandOption {
|
|
id: string;
|
|
kind: "routine";
|
|
routineId: string;
|
|
name: string;
|
|
status: string;
|
|
href: string;
|
|
aliases: string[];
|
|
}
|
|
|
|
export interface ActionCommandOption {
|
|
id: string;
|
|
kind: "action";
|
|
command: string;
|
|
name: string;
|
|
description: string;
|
|
aliases: string[];
|
|
disabled?: boolean;
|
|
disabledReason?: string | null;
|
|
}
|
|
|
|
export type SlashCommandOption = SkillCommandOption | RoutineCommandOption | ActionCommandOption;
|
|
|
|
interface EditorAutocompleteContextValue {
|
|
slashCommands: SlashCommandOption[];
|
|
/** Starts the skills and routines reads. Editors call it when they mount. */
|
|
requestSlashCommands: () => void;
|
|
}
|
|
|
|
const EditorAutocompleteContext = createContext<EditorAutocompleteContextValue>({
|
|
slashCommands: [],
|
|
requestSlashCommands: () => {},
|
|
});
|
|
|
|
/**
|
|
* Slash-command options for Markdown editors. The company skills and routines
|
|
* lists are large, and most pages have no editor, so the provider reads them
|
|
* only after the first editor mounts. Once read they stay current through the
|
|
* live-update invalidations for skills and routines.
|
|
*/
|
|
export function EditorAutocompleteProvider({ children }: { children: ReactNode }) {
|
|
const { selectedCompanyId } = useCompany();
|
|
const [requested, setRequested] = useState(false);
|
|
const requestSlashCommands = useCallback(() => setRequested(true), []);
|
|
const { data: companySkills = [] } = useQuery({
|
|
queryKey: selectedCompanyId
|
|
? queryKeys.companySkills.list(selectedCompanyId)
|
|
: ["company-skills", "__none__"],
|
|
queryFn: () => companySkillsApi.list(selectedCompanyId!),
|
|
enabled: requested && Boolean(selectedCompanyId),
|
|
});
|
|
const { data: routines = [] } = useQuery({
|
|
queryKey: selectedCompanyId
|
|
? queryKeys.routines.list(selectedCompanyId)
|
|
: ["routines", "__none__", "__all-projects__"],
|
|
queryFn: () => routinesApi.list(selectedCompanyId!),
|
|
enabled: requested && Boolean(selectedCompanyId),
|
|
});
|
|
|
|
const value = useMemo<EditorAutocompleteContextValue>(() => ({
|
|
slashCommands: [
|
|
...companySkills.map((skill) => ({
|
|
id: `skill:${skill.id}`,
|
|
kind: "skill" as const,
|
|
skillId: skill.id,
|
|
key: skill.key,
|
|
name: skill.name,
|
|
slug: skill.slug,
|
|
description: skill.description ?? null,
|
|
href: buildSkillMentionHref(skill.id, skill.slug),
|
|
aliases: [skill.slug, skill.name, skill.key],
|
|
})),
|
|
...routines
|
|
.filter((routine) => routine.status !== "archived")
|
|
.sort((left, right) => left.title.localeCompare(right.title))
|
|
.map((routine) => ({
|
|
id: `routine:${routine.id}`,
|
|
kind: "routine" as const,
|
|
routineId: routine.id,
|
|
name: routine.title,
|
|
status: routine.status,
|
|
href: buildRoutineMentionHref(routine.id),
|
|
aliases: [`routine:${routine.title}`, routine.title, routine.id],
|
|
})),
|
|
],
|
|
requestSlashCommands,
|
|
}), [companySkills, requestSlashCommands, routines]);
|
|
|
|
return (
|
|
<EditorAutocompleteContext.Provider value={value}>
|
|
{children}
|
|
</EditorAutocompleteContext.Provider>
|
|
);
|
|
}
|
|
|
|
/** Returns the slash commands and starts their reads on first use. */
|
|
export function useEditorAutocomplete() {
|
|
const value = useContext(EditorAutocompleteContext);
|
|
const { requestSlashCommands } = value;
|
|
useEffect(() => {
|
|
requestSlashCommands();
|
|
}, [requestSlashCommands]);
|
|
return value;
|
|
}
|