forked from farhoodlabs/paperclip
320fd5d23b
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Operators need to find work, documents, agents, projects, comments, and activity across a company without jumping through separate surfaces. > - The existing Command-K flow was useful for fast navigation but not enough for deeper company-wide discovery. > - Search also needs company-scoped backend contracts, query cost controls, and indexed document matching so it stays safe as company data grows. > - This pull request adds a full company search API and a dedicated board search page that Command-K can hand off to. > - The benefit is a single searchable control-plane surface with richer result context, recents, highlights, and test coverage across server and UI behavior. ## What Changed - Added a company-scoped search endpoint/service with query validation, rate limiting, text matching, fuzzy title matching, and result typing shared through `@paperclipai/shared`. - Added idempotent search migrations for document search indexes and fuzzy matching support. - Added the full `/companies/:companyKey/search` UI, search result row components, highlighted snippets, recent searches, and sidebar/Command-K handoff. - Added Storybook coverage for search surfaces and Vitest coverage for server search behavior, rate limiting, route generation, Command-K behavior, and the search page. - Addressed Greptile findings by renaming the no-match SQL helper, applying search pagination after cross-type merge sorting, and lazy-initializing the default search service so unrelated route-test mocks do not need to know about it. - Merged current `public-gh/master` and renumbered the search migrations behind upstream `0078_white_darwin`: search indexes are now `0079_company_search_document_indexes` and fuzzy matching is `0080_company_search_fuzzystrmatch`. ## Verification - `git fetch public-gh master` - `git diff --check public-gh/master...HEAD` - `git diff --name-only public-gh/master...HEAD | rg '^pnpm-lock\.yaml$' || true` produced no output before opening the PR. - `pnpm run preflight:workspace-links && pnpm exec vitest run server/src/__tests__/company-search-service.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts ui/src/pages/Search.test.tsx ui/src/components/CommandPalette.test.tsx ui/src/lib/company-routes.test.ts` passed: 5 files, 25 tests. - `pnpm --filter @paperclipai/shared typecheck && pnpm --filter @paperclipai/db typecheck && pnpm --filter @paperclipai/server typecheck && pnpm --filter @paperclipai/ui typecheck` passed. - `pnpm exec vitest run server/src/__tests__/company-search-service.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts && pnpm --filter @paperclipai/server typecheck` passed after Greptile pagination fixes. - `pnpm exec vitest run server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts server/src/__tests__/company-search-service.test.ts && pnpm --filter @paperclipai/server typecheck` passed after the CI mock fix. - After resolving the migration conflict with current `public-gh/master`: `pnpm --filter @paperclipai/db typecheck && pnpm exec vitest run server/src/__tests__/company-search-service.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts && pnpm --filter @paperclipai/server typecheck` passed. - DB migration numbering check passed as part of `@paperclipai/db` typecheck. - UI states are covered by the added Storybook stories in `ui/storybook/stories/search.stories.tsx`. - GitHub reports the PR merge state as `CLEAN` on head `18e54fa8`. - GitHub PR checks are green on head `18e54fa8`: policy, verify, serialized server shards 1/4 through 4/4, e2e, canary dry run, Snyk, and Greptile Review. ## Risks - Search ranking and snippets are new user-facing behavior, so reviewers should check whether result ordering feels right on real company data. - Search touches broad company data, so company scoping and query cost/rate-limit behavior should be reviewed carefully. - The migrations add search indexes/extensions; they are idempotent with `IF NOT EXISTS` for users who may have applied an earlier branch migration number. > ROADMAP.md checked. This PR adds a focused board search surface and does not duplicate an open roadmap item. ## Model Used - OpenAI Codex, GPT-5 coding agent, tool-enabled shell/git/GitHub CLI session with medium reasoning effort. Existing branch commits were produced across prior agent sessions; this packaging pass verified, opened the PR, addressed Greptile findings, resolved migration conflicts after upstream PRs landed, and got PR checks green. ## 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 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] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
93 lines
2.6 KiB
TypeScript
93 lines
2.6 KiB
TypeScript
const BOARD_ROUTE_ROOTS = new Set([
|
|
"dashboard",
|
|
"companies",
|
|
"company",
|
|
"skills",
|
|
"org",
|
|
"agents",
|
|
"projects",
|
|
"workspaces",
|
|
"execution-workspaces",
|
|
"issues",
|
|
"routines",
|
|
"goals",
|
|
"approvals",
|
|
"costs",
|
|
"usage",
|
|
"activity",
|
|
"inbox",
|
|
"u",
|
|
"design-guide",
|
|
"search",
|
|
]);
|
|
|
|
const GLOBAL_ROUTE_ROOTS = new Set(["auth", "invite", "board-claim", "cli-auth", "docs", "instance"]);
|
|
|
|
export function normalizeCompanyPrefix(prefix: string): string {
|
|
return prefix.trim().toUpperCase();
|
|
}
|
|
|
|
function splitPath(path: string): { pathname: string; search: string; hash: string } {
|
|
const match = path.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/);
|
|
return {
|
|
pathname: match?.[1] ?? path,
|
|
search: match?.[2] ?? "",
|
|
hash: match?.[3] ?? "",
|
|
};
|
|
}
|
|
|
|
function getRootSegment(pathname: string): string | null {
|
|
const segment = pathname.split("/").filter(Boolean)[0];
|
|
return segment ?? null;
|
|
}
|
|
|
|
export function isGlobalPath(pathname: string): boolean {
|
|
if (pathname === "/") return true;
|
|
const root = getRootSegment(pathname);
|
|
if (!root) return true;
|
|
return GLOBAL_ROUTE_ROOTS.has(root.toLowerCase());
|
|
}
|
|
|
|
export function isBoardPathWithoutPrefix(pathname: string): boolean {
|
|
const root = getRootSegment(pathname);
|
|
if (!root) return false;
|
|
return BOARD_ROUTE_ROOTS.has(root.toLowerCase());
|
|
}
|
|
|
|
export function extractCompanyPrefixFromPath(pathname: string): string | null {
|
|
const segments = pathname.split("/").filter(Boolean);
|
|
if (segments.length === 0) return null;
|
|
const first = segments[0]!.toLowerCase();
|
|
if (GLOBAL_ROUTE_ROOTS.has(first) || BOARD_ROUTE_ROOTS.has(first)) {
|
|
return null;
|
|
}
|
|
return normalizeCompanyPrefix(segments[0]!);
|
|
}
|
|
|
|
export function applyCompanyPrefix(path: string, companyPrefix: string | null | undefined): string {
|
|
const { pathname, search, hash } = splitPath(path);
|
|
if (!pathname.startsWith("/")) return path;
|
|
if (isGlobalPath(pathname)) return path;
|
|
if (!companyPrefix) return path;
|
|
|
|
const prefix = normalizeCompanyPrefix(companyPrefix);
|
|
const activePrefix = extractCompanyPrefixFromPath(pathname);
|
|
if (activePrefix) return path;
|
|
|
|
return `/${prefix}${pathname}${search}${hash}`;
|
|
}
|
|
|
|
export function toCompanyRelativePath(path: string): string {
|
|
const { pathname, search, hash } = splitPath(path);
|
|
const segments = pathname.split("/").filter(Boolean);
|
|
|
|
if (segments.length >= 2) {
|
|
const second = segments[1]!.toLowerCase();
|
|
if (!GLOBAL_ROUTE_ROOTS.has(segments[0]!.toLowerCase()) && BOARD_ROUTE_ROOTS.has(second)) {
|
|
return `/${segments.slice(1).join("/")}${search}${hash}`;
|
|
}
|
|
}
|
|
|
|
return `${pathname}${search}${hash}`;
|
|
}
|