mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-08 00:54:38 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to coordinate AI agents, issues, approvals, comments, and work products. > - The involved subsystem is issue context: markdown links, issue properties, related work, lists, filters, inbox/sidebar status, and plugin-provided external context. > - The gap is that URLs to external systems currently remain mostly plain links, so humans and agents must manually open them to understand status, identity, and liveness. > - This matters because external work objects such as GitHub issues and pull requests are part of the operational state of a Paperclip company. > - The implementation keeps core provider-neutral: shared contracts, storage, sync, routes, and UI surfaces live in core while providers can contribute detection and status resolution. > - This pull request adds the external object reference foundation, GitHub provider support, issue-surface rendering, filters, sidebar/list/inbox signals, and test/story coverage. > - The benefit is that linked external work becomes inspectable Paperclip context without hardcoding every provider directly into the UI. ## Linked Issues or Issue Description No public GitHub issue exists for this work. Feature request: - Problem: URLs in Paperclip issues, comments, documents, and related surfaces do not expose provider status or object identity inline. - Proposed behavior: detect supported external object URLs, persist normalized references, refresh provider status, and render concise status-aware links across issue surfaces. - Users affected: board users, agents, and maintainers who triage issues containing external work links. - Acceptance: external object references are company-scoped, provider-extensible, visible in key issue surfaces, filterable where relevant, and covered by focused shared/server/UI tests. Related PR search: - No open duplicate PRs found for `external object references`. - Closed related prior attempt: #4556. ## What Changed - Added shared external-object contracts, validators, status/liveness helpers, and plugin protocol declarations. - Added database schema and additive migrations for external objects, source mentions, and display metadata. - Added server services/routes for detecting, syncing, summarizing, refreshing, and resolving external objects across issues, documents, comments, projects, and plugins. - Added a GitHub external-object provider plus plugin SDK authoring docs. - Wired UI presentation across markdown links, comments, issue chat, documents, properties, related work, issue rows, filters, inbox/sidebar badges, and Storybook stories. - Rebasing cleanup: moved the branch onto current `master`, repaired stale worktree provision config, hardened environment-sensitive tests/mocks, and removed committed screenshot artifacts from the PR branch to keep the reviewable file set below tool limits. ## Verification - `pnpm exec vitest run packages/shared/src/external-objects.test.ts server/src/__tests__/external-object-routes.test.ts server/src/__tests__/external-objects-service.test.ts ui/src/components/ExternalObjectPill.test.tsx ui/src/lib/external-objects.test.ts` passed after rebasing: 5 files, 56 tests. - Historical branch verification before this PR creation included `pnpm test:run`, `pnpm -r typecheck`, and `pnpm build`; this PR body does not claim those were rerun after the final rebase. ## Risks - Medium: this adds a new cross-surface sync path on issue/document/comment writes. The implementation uses safe sync wrappers so external-object failures warn instead of blocking core mutations. - Medium: the migrations introduce new tables and indexes. They are additive and company-scoped. - Medium: provider-specific URL parsing can miss or misclassify edge cases. Shared canonicalization tests and provider tests cover current GitHub shapes. - Low: UI badge/filter behavior could add visual noise for object-heavy issues; component tests and Storybook stories cover the intended surfaces. > Roadmap checked: `ROADMAP.md` references the plugin system as the current extension path and does not list a duplicate core feature. Related long-range docs discuss external references, work products, preview URLs, and plugin extension points; this PR implements the scoped external-object reference foundation. ## Model Used OpenAI Codex, GPT-5 coding-agent runtime, with shell and GitHub CLI tool use. Reasoning mode: medium. Exact deployed runtime model ID and context window were not exposed in the environment. ## 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>
218 lines
6.5 KiB
TypeScript
218 lines
6.5 KiB
TypeScript
import { createHash } from "node:crypto";
|
|
import { parseIssueReferenceHref } from "./issue-references.js";
|
|
import type {
|
|
ExternalObjectCanonicalIdentity,
|
|
ExternalObjectCanonicalUrl,
|
|
ExternalObjectMentionSource,
|
|
ExternalObjectUrlCanonicalizationOptions,
|
|
ExternalObjectUrlMatch,
|
|
} from "./external-objects.js";
|
|
|
|
const EXTERNAL_URL_TOKEN_RE = /https?:\/\/[^\s<>()]+/gi;
|
|
|
|
function preserveNewlinesAsWhitespace(value: string) {
|
|
return value.replace(/[^\n]/g, " ");
|
|
}
|
|
|
|
function stripMarkdownCode(markdown: string): string {
|
|
if (!markdown) return "";
|
|
|
|
let output = "";
|
|
let index = 0;
|
|
|
|
while (index < markdown.length) {
|
|
const remaining = markdown.slice(index);
|
|
const fenceMatch = /^(?:```+|~~~+)/.exec(remaining);
|
|
const atLineStart = index === 0 || markdown[index - 1] === "\n";
|
|
|
|
if (atLineStart && fenceMatch) {
|
|
const fence = fenceMatch[0]!;
|
|
const blockStart = index;
|
|
index += fence.length;
|
|
while (index < markdown.length && markdown[index] !== "\n") index += 1;
|
|
if (index < markdown.length) index += 1;
|
|
|
|
while (index < markdown.length) {
|
|
const lineStart = index === 0 || markdown[index - 1] === "\n";
|
|
if (lineStart && markdown.startsWith(fence, index)) {
|
|
index += fence.length;
|
|
while (index < markdown.length && markdown[index] !== "\n") index += 1;
|
|
if (index < markdown.length) index += 1;
|
|
break;
|
|
}
|
|
index += 1;
|
|
}
|
|
|
|
output += preserveNewlinesAsWhitespace(markdown.slice(blockStart, index));
|
|
continue;
|
|
}
|
|
|
|
if (markdown[index] === "`") {
|
|
let tickCount = 1;
|
|
while (index + tickCount < markdown.length && markdown[index + tickCount] === "`") {
|
|
tickCount += 1;
|
|
}
|
|
const fence = "`".repeat(tickCount);
|
|
const inlineStart = index;
|
|
index += tickCount;
|
|
const closeIndex = markdown.indexOf(fence, index);
|
|
if (closeIndex === -1) {
|
|
output += markdown.slice(inlineStart, inlineStart + tickCount);
|
|
index = inlineStart + tickCount;
|
|
continue;
|
|
}
|
|
index = closeIndex + tickCount;
|
|
output += preserveNewlinesAsWhitespace(markdown.slice(inlineStart, index));
|
|
continue;
|
|
}
|
|
|
|
output += markdown[index]!;
|
|
index += 1;
|
|
}
|
|
|
|
return output;
|
|
}
|
|
|
|
function trimTrailingPunctuation(token: string): string {
|
|
let trimmed = token;
|
|
while (trimmed.length > 0) {
|
|
const last = trimmed[trimmed.length - 1]!;
|
|
if (!".,!?;:".includes(last) && last !== ")" && last !== "]") break;
|
|
|
|
if (
|
|
(last === ")" && (trimmed.match(/\(/g)?.length ?? 0) >= (trimmed.match(/\)/g)?.length ?? 0))
|
|
|| (last === "]" && (trimmed.match(/\[/g)?.length ?? 0) >= (trimmed.match(/\]/g)?.length ?? 0))
|
|
) {
|
|
break;
|
|
}
|
|
trimmed = trimmed.slice(0, -1);
|
|
}
|
|
return trimmed;
|
|
}
|
|
|
|
function sha256Hex(value: string): string {
|
|
return createHash("sha256").update(value).digest("hex");
|
|
}
|
|
|
|
function stableStringify(value: unknown): string {
|
|
if (Array.isArray(value)) {
|
|
return `[${value.map((entry) => stableStringify(entry)).join(",")}]`;
|
|
}
|
|
if (value && typeof value === "object") {
|
|
const record = value as Record<string, unknown>;
|
|
return `{${Object.keys(record)
|
|
.sort()
|
|
.map((key) => `${JSON.stringify(key)}:${stableStringify(record[key])}`)
|
|
.join(",")}}`;
|
|
}
|
|
return JSON.stringify(value);
|
|
}
|
|
|
|
function normalizePathname(pathname: string): string {
|
|
return pathname || "/";
|
|
}
|
|
|
|
export function findExternalObjectUrlMatches(markdown: string): ExternalObjectUrlMatch[] {
|
|
if (!markdown) return [];
|
|
|
|
const scrubbed = stripMarkdownCode(markdown);
|
|
const matches: ExternalObjectUrlMatch[] = [];
|
|
let match: RegExpExecArray | null;
|
|
const re = new RegExp(EXTERNAL_URL_TOKEN_RE);
|
|
|
|
while ((match = re.exec(scrubbed)) !== null) {
|
|
const matchedText = trimTrailingPunctuation(match[0]);
|
|
if (!matchedText || parseIssueReferenceHref(matchedText)) continue;
|
|
|
|
matches.push({
|
|
index: match.index,
|
|
length: matchedText.length,
|
|
matchedText,
|
|
});
|
|
}
|
|
|
|
return matches;
|
|
}
|
|
|
|
export function canonicalizeExternalObjectUrl(
|
|
value: string,
|
|
options: ExternalObjectUrlCanonicalizationOptions = {},
|
|
): ExternalObjectCanonicalUrl | null {
|
|
let url: URL;
|
|
try {
|
|
url = new URL(value.trim());
|
|
} catch {
|
|
return null;
|
|
}
|
|
|
|
if (url.protocol !== "http:" && url.protocol !== "https:") return null;
|
|
if (url.username || url.password) return null;
|
|
|
|
const scheme = url.protocol === "https:" ? "https" : "http";
|
|
const path = normalizePathname(url.pathname);
|
|
const sanitizedCanonicalUrl = `${scheme}://${url.host.toLowerCase()}${path}`;
|
|
const identityQueryParams = new Set(options.identityQueryParams ?? []);
|
|
const queryParamHashes: Record<string, string> = {};
|
|
|
|
for (const key of [...identityQueryParams].sort()) {
|
|
const values = url.searchParams.getAll(key);
|
|
if (values.length === 0) continue;
|
|
queryParamHashes[key] = sha256Hex(values.join("\u0000"));
|
|
}
|
|
|
|
const canonicalIdentity: ExternalObjectCanonicalIdentity = {
|
|
scheme,
|
|
host: url.host.toLowerCase(),
|
|
path,
|
|
...(Object.keys(queryParamHashes).length > 0 ? { queryParamHashes } : {}),
|
|
};
|
|
|
|
return {
|
|
sanitizedCanonicalUrl,
|
|
sanitizedDisplayUrl: sanitizedCanonicalUrl,
|
|
canonicalIdentity,
|
|
canonicalIdentityHash: sha256Hex(stableStringify(canonicalIdentity)),
|
|
redactedMatchedText: sanitizedCanonicalUrl,
|
|
};
|
|
}
|
|
|
|
export function extractExternalObjectCanonicalUrls(
|
|
markdown: string,
|
|
options: ExternalObjectUrlCanonicalizationOptions = {},
|
|
): ExternalObjectCanonicalUrl[] {
|
|
const seen = new Set<string>();
|
|
const ordered: ExternalObjectCanonicalUrl[] = [];
|
|
|
|
for (const match of findExternalObjectUrlMatches(markdown)) {
|
|
const canonical = canonicalizeExternalObjectUrl(match.matchedText, options);
|
|
if (!canonical || seen.has(canonical.canonicalIdentityHash)) continue;
|
|
seen.add(canonical.canonicalIdentityHash);
|
|
ordered.push(canonical);
|
|
}
|
|
|
|
return ordered;
|
|
}
|
|
|
|
export function buildExternalObjectScopedIdentityKey(args: {
|
|
companyId: string;
|
|
providerKey: string;
|
|
objectType: string;
|
|
canonicalIdentityHash: string;
|
|
}): string {
|
|
return [args.companyId, args.providerKey, args.objectType, args.canonicalIdentityHash].join(":");
|
|
}
|
|
|
|
export function buildExternalObjectMentionSourceKey(source: Required<Pick<
|
|
ExternalObjectMentionSource,
|
|
"companyId" | "sourceIssueId" | "sourceKind"
|
|
>> & ExternalObjectMentionSource): string {
|
|
return [
|
|
source.companyId,
|
|
source.sourceIssueId,
|
|
source.sourceKind,
|
|
source.sourceRecordId ?? "",
|
|
source.documentKey ?? "",
|
|
source.propertyKey ?? "",
|
|
].join(":");
|
|
}
|