Files
PaperClipAI/ui/src/lib/external-objects.ts
T
Devin Foleyanddevinfoley cfed739f81 fix(external-objects): stop reporting GitHub rate limits as unreachable (#17792)
<!-- entire-trail-link-start -->
https://entire.com/gh/paperclipai/-/trails/11/changes/paperclip/11
<!-- entire-trail-link-end -->

## Thinking Path

> - Paperclip is the open source app that people use to manage AI agents
for work.
> - Paperclip shows the status of external objects, such as GitHub pull
requests and issues.
> - A background sweep refreshes these objects and resolves a GitHub
credential.
> - The sweep read a credential only from a company secret with a
well-known name.
> - An instance without that secret made anonymous GitHub API calls.
Anonymous calls are limited to 60 per hour.
> - When the limit was reached, the sweep showed "unreachable" for
objects that it could not refresh.
> - A server environment token is instance-wide, so it must not expose a
private repository that a company cannot see.
> - This pull request reads a server token for public repositories,
reports a rate limit as its own state, and shows a warning on the pill.
> - The benefit is an accurate status, fewer misleading failures, and no
cross-company private data.

## Linked Issues or Issue Description

No public GitHub issue exists. The sections below describe the bug.

**What happened?**

The board showed "unreachable" for many GitHub links, even after a
related fix was deployed.

**Expected behavior**

The board should show "unreachable" only for real network failures. It
should show a rate limit as its own state and retry later.

**Steps to reproduce**

1. Use an instance with no GitHub token company secret and no server
token.
2. Let the external-object sweep make more than 60 anonymous GitHub
requests in one hour.
3. Open a task with GitHub links.

**Paperclip version or commit**

master (commit a67a18c at report time).

**Deployment mode**

Self-hosted server.

## What Changed

- Add `resolveGitHubApiCredential` in
`server/src/services/git-credentials.ts`. It reads a company secret with
a well-known name, then falls back to the server environment token
(`GITHUB_TOKEN`/`GH_TOKEN`), and it reports the credential `source`.
- Use the source in the GitHub external-object provider and in
`github-commit-details.ts`. A `server_env` token is limited to public
repositories. A private repository resolves only with a company
credential; otherwise the object reports `auth_required` and does not
fetch the private object.
- Add a `rate_limited` liveness state in
`packages/shared/src/constants.ts`.
- Classify a 403 with `x-ratelimit-remaining: 0`, a 429 response, and a
rate-limited repo probe as `rate_limited` instead of `unreachable`.
- Show `rate_limited` in the UI filter, icon, label, tone, overlay, and
badge maps.
- Make `ExternalObjectPill` and `ExternalObjectStatusIcon` prefer a
liveness warning icon and tone, so a rate-limited object shows a warning
even when the last status was healthy.
- Add tests for the credential source, the public-only server token, the
company-scoped private repository, and the rate-limited pill tone.

## Verification

- `vitest run server/src/__tests__/external-objects-service.test.ts
server/src/__tests__/git-credentials.test.ts
server/src/__tests__/github-commit-details.test.ts
server/src/__tests__/work-products.test.ts` — pass, with the new scoping
and credential-source tests.
- `vitest run ui/src/lib/external-objects.test.ts
ui/src/lib/issue-filters.test.ts
ui/src/components/ExternalObjectPill.test.tsx
ui/src/components/MarkdownExternalLink.test.tsx` — pass, with the new
rate-limited pill test.
- `pnpm --filter @paperclipai/shared typecheck` — pass. The full
monorepo `tsc` (server and ui) is killed by the 4GB memory cap of this
sandbox; the authoritative CI Typecheck gate runs it instead.
- One test in `git-credentials.test.ts` fails in this sandbox only. The
test "credential helper execution (real git, no network) ... env-carried
token" reads a global GitHub credential helper in the sandbox. The test
fails the same way on the base without this change.

## Risks

- Low risk. The change adds a liveness state and a credential source. It
does not change existing terminal verdicts.
- A server-environment token cannot resolve a private repository. This
is intentional. An operator who needs private repositories must add a
GitHub token as a company secret. The object then reports
`auth_required` with that instruction.
- `rate_limited` is a new value in `EXTERNAL_OBJECT_LIVENESS_STATES`. An
old client ignores an unknown value.

## Model Used

- Provider: DeepSeek (OpenRouter).
- Exact model ID: `openrouter/deepseek/deepseek-v4.1-flash`.
- Capabilities: tool use and code execution in the Paperclip runner.

## 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 similar open and closed PRs and
confirmed this is not a duplicate
- [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)
- [ ] 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
- [ ] 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
- [ ] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: devinfoley <139239+devinfoley@users.noreply.github.com>
2026-10-26 16:13:04 -07:00

272 lines
8.1 KiB
TypeScript

import {
AlertCircle,
AlertOctagon,
Archive,
CheckCircle2,
Circle,
CircleDashed,
CircleDot,
Clock,
CloudOff,
GitMerge,
GitPullRequest,
KeyRound,
Loader2,
XCircle,
type LucideIcon,
} from "lucide-react";
import { GithubIcon } from "@/components/icons/github-icon";
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,
rate_limited: AlertCircle,
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: GithubIcon,
"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 === "rate_limited") return AlertCircle;
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",
rate_limited: "Rate limited",
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",
rate_limited: "Rate limited",
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",
rate_limited: "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;
}