mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 20:50:08 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The issue properties panel can show external objects such as GitHub pull requests. > - Those objects are resolved by external-object providers and then displayed as compact status labels. > - A GitHub pull request could remain in the fallback `unknown` state and appear as `Not yet resolved`. > - That label is confusing when the object is known but has not been refreshed yet. > - This pull request refreshes due external objects from the heartbeat scheduler and improves the unknown-status copy. > - The benefit is a properties panel that moves from pending refresh to the real pull request state without a manual refresh. ## Linked Issues or Issue Description No public GitHub issue exists for this bug. I searched for related public issues and pull requests using the terms `Not yet refreshed`, `external objects refresh`, and `external PR status`, and did not find a duplicate implementation. **What happened?** The issue properties panel could show a GitHub pull request as `Not yet resolved` even when the referenced pull request was valid. The object stayed stale unless a manual refresh path ran. **Expected behavior** A known external object should show pending-refresh copy while it waits for provider data. When the scheduler refreshes it, the properties panel should show the provider status such as open, merged, or closed. **Steps to reproduce** 1. Create or view an issue that references a GitHub pull request. 2. Open the issue properties panel. 3. Observe the external object row before a manual refresh has run. **Paperclip version or commit** Current `master` before this pull request. **Deployment mode** Local dev and self-hosted server. **Installation method** Built from source. **Agent adapter(s) involved** Not adapter-specific. **Database mode** Not database-related. **Access context** Board view. **Privacy checklist** I reviewed this description and did not include logs, credentials, private URLs, internal issue IDs, or PII. ## What Changed - Added a heartbeat scheduler tick that refreshes due external objects for active companies. - Kept manual external-object refresh behavior on the same service path. - Changed display copy so known provider objects use liveness labels such as `Not yet refreshed`, while fresh unknown provider statuses show `Status unavailable`. - Added server and UI tests for scheduled refresh and label behavior. ## Verification - `corepack pnpm install --frozen-lockfile` - `pnpm check:token-gates` - `pnpm exec vitest run server/src/__tests__/external-objects-service.test.ts server/src/__tests__/server-startup-feedback-export.test.ts ui/src/components/ExternalObjectPill.test.tsx ui/src/components/IssueProperties.test.tsx ui/src/lib/external-objects.test.ts` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm --filter @paperclipai/server typecheck` - `pnpm --filter @paperclipai/server build` - `pnpm --filter @paperclipai/ui build` - `pnpm run typecheck:build-gaps` - GitHub PR checks passed on head `0e7fcd30` - Greptile reported 5/5 on head `0e7fcd30` with no unresolved review threads Notes: - I ran recursive typecheck and build first. Both hit container resource limits with exit 137 during concurrent package work, so I reran the affected server and UI targets separately. - An unrelated workspace-runtime auto-port test fails in this container with a PID ownership mismatch. It is outside the files changed here. ## Risks Low to medium risk. The scheduler does more periodic external-object work, so the main risk is extra provider refresh load. The implementation bounds the work to active companies, due non-terminal objects, and 50 objects per company per tick. The path also stays behind the external-objects experimental setting. ## Model Used OpenAI GPT-5 Codex in the Codex execution environment, with shell and GitHub CLI tool use. The runtime did not expose a more specific internal model ID or context window. ## 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>
267 lines
7.9 KiB
TypeScript
267 lines
7.9 KiB
TypeScript
import {
|
|
AlertCircle,
|
|
AlertOctagon,
|
|
Archive,
|
|
CheckCircle2,
|
|
Circle,
|
|
CircleDashed,
|
|
CircleDot,
|
|
Clock,
|
|
CloudOff,
|
|
GitMerge,
|
|
Github,
|
|
GitPullRequest,
|
|
KeyRound,
|
|
Loader2,
|
|
XCircle,
|
|
type LucideIcon,
|
|
} from "lucide-react";
|
|
import type {
|
|
ExternalObjectLivenessState,
|
|
ExternalObjectStatusCategory,
|
|
ExternalObjectStatusTone,
|
|
ExternalObjectSummary,
|
|
ExternalObjectSummaryItem,
|
|
} from "@paperclipai/shared";
|
|
|
|
/**
|
|
* Lucide icon for each status category. The mapping is host-owned per the
|
|
* Phase 1B security review — providers never inject inline React.
|
|
*/
|
|
export const externalObjectCategoryIcon: Record<string, LucideIcon> = {
|
|
unknown: CircleDashed,
|
|
open: CircleDot,
|
|
waiting: Clock,
|
|
running: Loader2,
|
|
succeeded: CheckCircle2,
|
|
failed: XCircle,
|
|
blocked: AlertOctagon,
|
|
closed: Circle,
|
|
archived: Archive,
|
|
auth_required: KeyRound,
|
|
unreachable: CloudOff,
|
|
};
|
|
|
|
export const externalObjectCategoryIconDefault: LucideIcon = CircleDashed;
|
|
|
|
export function externalObjectIconForCategory(category: string): LucideIcon {
|
|
return externalObjectCategoryIcon[category] ?? externalObjectCategoryIconDefault;
|
|
}
|
|
|
|
const EXTERNAL_OBJECT_ICON_KEYS: Record<string, LucideIcon> = {
|
|
archive: Archive,
|
|
check: CheckCircle2,
|
|
"check-circle": CheckCircle2,
|
|
circle: Circle,
|
|
"circle-dot": CircleDot,
|
|
clock: Clock,
|
|
github: Github,
|
|
"git-merge": GitMerge,
|
|
"git-pull-request": GitPullRequest,
|
|
key: KeyRound,
|
|
loader: Loader2,
|
|
"x-circle": XCircle,
|
|
};
|
|
|
|
export function externalObjectIconForKey(iconKey: string | null | undefined): LucideIcon | null {
|
|
if (!iconKey) return null;
|
|
return EXTERNAL_OBJECT_ICON_KEYS[iconKey] ?? null;
|
|
}
|
|
|
|
export function externalObjectIconForLiveness(liveness: string): LucideIcon | null {
|
|
if (liveness === "auth_required") return KeyRound;
|
|
if (liveness === "unreachable") return CloudOff;
|
|
return null;
|
|
}
|
|
|
|
const CATEGORY_LABELS: Record<string, string> = {
|
|
unknown: "Not yet resolved",
|
|
open: "Open",
|
|
waiting: "Waiting",
|
|
running: "Running",
|
|
succeeded: "Succeeded",
|
|
failed: "Failed",
|
|
blocked: "Blocked",
|
|
closed: "Closed",
|
|
archived: "Archived",
|
|
auth_required: "Authorization required",
|
|
unreachable: "Unreachable",
|
|
};
|
|
|
|
export function externalObjectCategoryLabel(category: string): string {
|
|
return CATEGORY_LABELS[category] ?? category.replace(/_/g, " ");
|
|
}
|
|
|
|
const LIVENESS_LABELS: Record<string, string> = {
|
|
unknown: "Not yet refreshed",
|
|
fresh: "Fresh",
|
|
stale: "Stale",
|
|
auth_required: "Requires auth",
|
|
unreachable: "Unreachable",
|
|
};
|
|
|
|
export function externalObjectLivenessLabel(liveness: string): string {
|
|
return LIVENESS_LABELS[liveness] ?? liveness.replace(/_/g, " ");
|
|
}
|
|
|
|
export function externalObjectDisplayStatusLabel(input: {
|
|
providerKey: string | null | undefined;
|
|
objectType: string | null | undefined;
|
|
statusCategory: string;
|
|
liveness: string;
|
|
statusLabel?: string | null;
|
|
}): string {
|
|
const trimmedStatusLabel = input.statusLabel?.trim();
|
|
if (trimmedStatusLabel) return trimmedStatusLabel;
|
|
const isGenericUrl = input.providerKey === "url" && input.objectType === "link";
|
|
const hasKnownObjectType = Boolean(input.providerKey && input.objectType);
|
|
if (input.statusCategory === "unknown" && hasKnownObjectType && !isGenericUrl) {
|
|
if (input.liveness === "fresh") return "Status unavailable";
|
|
return externalObjectLivenessLabel(input.liveness);
|
|
}
|
|
return externalObjectCategoryLabel(input.statusCategory);
|
|
}
|
|
|
|
/**
|
|
* Higher number = more attention-worthy. The rollups in §5 sort by tone first.
|
|
* Mirrors `externalObjectStatusToneSeverity` in `status-colors.ts`.
|
|
*/
|
|
const TONE_SEVERITY: Record<string, number> = {
|
|
muted: 0,
|
|
neutral: 1,
|
|
success: 2,
|
|
info: 3,
|
|
warning: 4,
|
|
danger: 5,
|
|
};
|
|
|
|
export function externalObjectToneSeverity(tone: string | null | undefined): number {
|
|
if (!tone) return 0;
|
|
return TONE_SEVERITY[tone] ?? 0;
|
|
}
|
|
|
|
const CATEGORY_TONE_FALLBACK: Record<string, ExternalObjectStatusTone> = {
|
|
unknown: "muted",
|
|
open: "info",
|
|
waiting: "warning",
|
|
running: "info",
|
|
succeeded: "success",
|
|
failed: "danger",
|
|
blocked: "danger",
|
|
closed: "muted",
|
|
archived: "muted",
|
|
auth_required: "warning",
|
|
unreachable: "danger",
|
|
};
|
|
|
|
export function externalObjectFallbackTone(
|
|
category: ExternalObjectStatusCategory,
|
|
): ExternalObjectStatusTone {
|
|
return CATEGORY_TONE_FALLBACK[category] ?? "neutral";
|
|
}
|
|
|
|
const PROVIDER_LABELS: Record<string, string> = {
|
|
github: "GitHub",
|
|
github_pull_request: "GitHub",
|
|
github_issue: "GitHub",
|
|
hubspot: "HubSpot",
|
|
linear: "Linear",
|
|
jira: "Jira",
|
|
notion: "Notion",
|
|
asana: "Asana",
|
|
};
|
|
|
|
export function externalObjectProviderLabel(providerKey: string | null | undefined): string {
|
|
if (!providerKey) return "External";
|
|
const lookup = PROVIDER_LABELS[providerKey];
|
|
if (lookup) return lookup;
|
|
return providerKey
|
|
.split(/[._-]/)
|
|
.map((part) => part.charAt(0).toUpperCase() + part.slice(1))
|
|
.join(" ");
|
|
}
|
|
|
|
const OBJECT_TYPE_LABELS: Record<string, string> = {
|
|
pull_request: "pull request",
|
|
issue: "issue",
|
|
deployment: "deployment",
|
|
workflow_run: "workflow run",
|
|
ticket: "ticket",
|
|
lead: "lead",
|
|
url_link: "URL",
|
|
};
|
|
|
|
export function externalObjectTypeLabel(objectType: string | null | undefined): string {
|
|
if (!objectType) return "object";
|
|
return OBJECT_TYPE_LABELS[objectType] ?? objectType.replace(/_/g, " ");
|
|
}
|
|
|
|
export function externalObjectDisplayLabel(
|
|
providerKey: string | null | undefined,
|
|
objectType: string | null | undefined,
|
|
displayKey?: string | null,
|
|
): string {
|
|
const trimmedDisplayKey = displayKey?.trim();
|
|
if (trimmedDisplayKey) return trimmedDisplayKey;
|
|
if (providerKey === "url" && objectType === "link") return "URL";
|
|
return `${externalObjectProviderLabel(providerKey)} ${externalObjectTypeLabel(objectType)}`;
|
|
}
|
|
|
|
/**
|
|
* Sort summary items by severity-first ordering: danger → warning → info →
|
|
* success → muted/neutral. Within a tone, items keep their incoming order so
|
|
* server-side ordering (e.g. most recent change first) is preserved.
|
|
*/
|
|
export function sortExternalObjectsBySeverity<T extends ExternalObjectSummaryItem>(
|
|
items: readonly T[],
|
|
): T[] {
|
|
return [...items]
|
|
.map((item, index) => ({ item, index }))
|
|
.sort((a, b) => {
|
|
const aTone = externalObjectToneSeverity(a.item.statusTone);
|
|
const bTone = externalObjectToneSeverity(b.item.statusTone);
|
|
if (aTone !== bTone) return bTone - aTone;
|
|
return a.index - b.index;
|
|
})
|
|
.map(({ item }) => item);
|
|
}
|
|
|
|
/**
|
|
* Compute the dominant tone in a summary — used by sidebar / list rollups.
|
|
* Falls back to `null` when no objects are present or every tone is `muted`.
|
|
*/
|
|
export function dominantExternalObjectTone(
|
|
summary: Pick<ExternalObjectSummary, "highestSeverity" | "objects"> | null | undefined,
|
|
): ExternalObjectStatusTone | null {
|
|
if (!summary) return null;
|
|
const tone = summary.highestSeverity;
|
|
if (!tone) return null;
|
|
if (externalObjectToneSeverity(tone) <= TONE_SEVERITY.muted) return null;
|
|
return tone;
|
|
}
|
|
|
|
/**
|
|
* For the sidebar / list rollup we want the count of objects matching the
|
|
* dominant severity (e.g. "3 failed PRs"), not the global total. Returns 0
|
|
* whenever the dominant tone is muted so callers can render based on the
|
|
* count without double-checking the rollup-hide rule.
|
|
*/
|
|
export function externalObjectDominantCount(
|
|
summary: Pick<ExternalObjectSummary, "highestSeverity" | "objects"> | null | undefined,
|
|
): number {
|
|
if (!summary) return 0;
|
|
const tone = dominantExternalObjectTone(summary);
|
|
if (!tone) return 0;
|
|
return summary.objects.filter((object) => object.statusTone === tone).length;
|
|
}
|
|
|
|
/**
|
|
* Reduced motion support — match `prefers-reduced-motion: reduce` so the
|
|
* spinning Loader2 stays static when requested. Hooks consume this via React
|
|
* to react to runtime changes; non-hook callers can use the helper directly.
|
|
*/
|
|
export function prefersReducedMotion(): boolean {
|
|
if (typeof window === "undefined" || !window.matchMedia) return false;
|
|
return window.matchMedia("(prefers-reduced-motion: reduce)").matches;
|
|
}
|