mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 21:07:40 +01:00
<!-- 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>
102 lines
3.7 KiB
TypeScript
102 lines
3.7 KiB
TypeScript
import type {
|
|
ExternalObjectLivenessState,
|
|
ExternalObjectStatusCategory,
|
|
} from "@paperclipai/shared";
|
|
import { Clock } from "lucide-react";
|
|
import {
|
|
externalObjectStatusIcon,
|
|
externalObjectStatusIconDefault,
|
|
} from "../lib/status-colors";
|
|
import {
|
|
externalObjectCategoryLabel,
|
|
externalObjectIconForCategory,
|
|
externalObjectIconForKey,
|
|
externalObjectIconForLiveness,
|
|
externalObjectLivenessLabel,
|
|
} from "../lib/external-objects";
|
|
import { usePrefersReducedMotion } from "../hooks/usePrefersReducedMotion";
|
|
import { cn } from "../lib/utils";
|
|
|
|
interface ExternalObjectStatusIconProps {
|
|
category: ExternalObjectStatusCategory;
|
|
liveness: ExternalObjectLivenessState;
|
|
statusIconKey?: string | null;
|
|
/** Optional override label used in `aria-label` (e.g. provider-specific copy). */
|
|
label?: string | null;
|
|
className?: string;
|
|
/** Tailwind size class — defaults to `h-3.5 w-3.5` (compact pill use). */
|
|
sizeClassName?: string;
|
|
/**
|
|
* When true the icon renders inline at 12 px with the `mr-1`/`align`
|
|
* adjustments used by `MarkdownIssueLink`. Used by the markdown decorator.
|
|
*/
|
|
inline?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Pure presentational icon for an external object's status. Combines:
|
|
*
|
|
* - A category icon (lucide) from `externalObjectIconForCategory`.
|
|
* - Tone classes (text + border) from `externalObjectStatusIcon`.
|
|
* - An overlaid clock micro-mark when liveness is `stale`.
|
|
* - Reduced-motion-aware spinner for the `running` category.
|
|
*
|
|
* Never mounts plugin React; the host is the sole renderer of identity glyphs.
|
|
*/
|
|
export function ExternalObjectStatusIcon({
|
|
category,
|
|
liveness,
|
|
statusIconKey,
|
|
label,
|
|
className,
|
|
sizeClassName = "h-3.5 w-3.5",
|
|
inline = false,
|
|
}: ExternalObjectStatusIconProps) {
|
|
const reducedMotion = usePrefersReducedMotion();
|
|
// A liveness problem (auth required, rate limited, unreachable) takes the icon and
|
|
// the tone, so a warning is visible even when the last known status was healthy.
|
|
const livenessIcon = externalObjectIconForLiveness(liveness);
|
|
const Icon = livenessIcon ?? externalObjectIconForKey(statusIconKey) ?? externalObjectIconForCategory(category);
|
|
const livenessTone = externalObjectStatusIcon[liveness];
|
|
const tone = livenessTone
|
|
?? (statusIconKey === "git-merge"
|
|
? "text-violet-600 border-violet-600 dark:text-violet-400 dark:border-violet-400"
|
|
: externalObjectStatusIcon[category] ?? externalObjectStatusIconDefault);
|
|
const livenessSuffix = liveness === "fresh" || liveness === "unknown"
|
|
? ""
|
|
: ` (${externalObjectLivenessLabel(liveness)})`;
|
|
const baseLabel = label ?? externalObjectCategoryLabel(category);
|
|
const ariaLabel = `${baseLabel}${baseLabel.includes(externalObjectLivenessLabel(liveness)) ? "" : livenessSuffix}`;
|
|
|
|
// The clock overlay needs a positioned wrapper. Inline mode keeps the icon
|
|
// tight to the surrounding text; pill mode expects to size by sizeClassName.
|
|
const wrapperBase = inline
|
|
? "relative mr-1 inline-flex shrink-0 align-(--va-0_125em)"
|
|
: "relative inline-flex shrink-0";
|
|
const iconSize = inline ? "h-3 w-3" : sizeClassName;
|
|
const isSpinner = category === "running";
|
|
const animateClass = isSpinner && !reducedMotion ? "animate-spin" : "";
|
|
|
|
return (
|
|
<span
|
|
role="img"
|
|
aria-label={ariaLabel}
|
|
className={cn(wrapperBase, className)}
|
|
>
|
|
<Icon
|
|
aria-hidden="true"
|
|
className={cn(iconSize, tone.split(" ").filter((c) => c.startsWith("text-")).join(" "), animateClass)}
|
|
/>
|
|
{liveness === "stale" ? (
|
|
<Clock
|
|
aria-hidden="true"
|
|
className={cn(
|
|
"absolute -bottom-0.5 -right-0.5 h-2 w-2 rounded-full bg-background text-muted-foreground",
|
|
inline ? "" : "p-px",
|
|
)}
|
|
/>
|
|
) : null}
|
|
</span>
|
|
);
|
|
}
|