mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 12:59:13 +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>
226 lines
7.9 KiB
TypeScript
226 lines
7.9 KiB
TypeScript
// @vitest-environment node
|
||
|
||
import { describe, expect, it } from "vitest";
|
||
import { renderToStaticMarkup } from "react-dom/server";
|
||
import { ExternalObjectPill } from "./ExternalObjectPill";
|
||
import { ExternalObjectStatusSummary } from "./ExternalObjectStatusSummary";
|
||
|
||
describe("ExternalObjectPill", () => {
|
||
it("renders a clickable anchor when a URL is provided", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
statusCategory: "succeeded",
|
||
liveness: "fresh",
|
||
displayTitle: "Add external refs",
|
||
url: "https://github.com/acme/web/pull/241",
|
||
}}
|
||
sourceCount={4}
|
||
sourceSummary="description, 3 comments"
|
||
/>,
|
||
);
|
||
expect(html).toContain('href="https://github.com/acme/web/pull/241"');
|
||
expect(html).toContain('data-mention-kind="external-object"');
|
||
expect(html).toContain('data-external-status="succeeded"');
|
||
expect(html).toContain('data-external-liveness="fresh"');
|
||
expect(html).toContain("×4");
|
||
expect(html).toContain('aria-label="GitHub pull request — Succeeded: Add external refs"');
|
||
});
|
||
|
||
it("falls back to a non-interactive span when no URL is supplied", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: null,
|
||
objectType: null,
|
||
statusCategory: "unknown",
|
||
liveness: "unknown",
|
||
url: null,
|
||
}}
|
||
/>,
|
||
);
|
||
expect(html).toContain('data-mention-kind="external-object"');
|
||
expect(html).not.toContain("<a ");
|
||
expect(html).toContain('aria-label="External object — Not yet resolved"');
|
||
});
|
||
|
||
it("applies the dashed-border liveness overlay when stale or auth_required", () => {
|
||
const stale = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
statusCategory: "failed",
|
||
liveness: "stale",
|
||
url: "https://github.com/acme/web/pull/242",
|
||
}}
|
||
/>,
|
||
);
|
||
expect(stale).toContain("opacity-70");
|
||
expect(stale).toContain("[border-style:dashed]");
|
||
|
||
const auth = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "hubspot",
|
||
objectType: "lead",
|
||
statusCategory: "auth_required",
|
||
liveness: "auth_required",
|
||
url: "https://app.hubspot.com/leads/99",
|
||
}}
|
||
/>,
|
||
);
|
||
expect(auth).toContain("[border-style:dashed]");
|
||
});
|
||
|
||
it("shows the liveness warning tone for a rate-limited object, not the last status tone", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
statusCategory: "open",
|
||
liveness: "rate_limited",
|
||
statusIconKey: "git-pull-request",
|
||
url: "https://github.com/acme/web/pull/243",
|
||
}}
|
||
/>,
|
||
);
|
||
expect(html).toContain("text-amber-600");
|
||
expect(html).toContain("[border-style:dashed]");
|
||
expect(html).not.toContain("text-blue-600");
|
||
});
|
||
|
||
it("does not show a source count when only a single mention is present", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
statusCategory: "succeeded",
|
||
liveness: "fresh",
|
||
url: "https://github.com/acme/web/pull/241",
|
||
}}
|
||
sourceCount={1}
|
||
/>,
|
||
);
|
||
expect(html).not.toContain("×");
|
||
});
|
||
|
||
it("labels detected GitHub pull requests without fetched status as not refreshed", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
statusCategory: "unknown",
|
||
liveness: "unknown",
|
||
displayTitle: "acme/web#241",
|
||
url: "https://github.com/acme/web/pull/241",
|
||
}}
|
||
/>,
|
||
);
|
||
|
||
expect(html).toContain("PR 241 - Not yet refreshed");
|
||
expect(html).toContain('aria-label="GitHub pull request — Not yet refreshed: acme/web#241"');
|
||
expect(html).not.toContain("Not yet resolved");
|
||
});
|
||
|
||
it("uses the object link label, provider icon, and visible status when supplied", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "github",
|
||
objectType: "pull_request",
|
||
displayKey: "Github Pull Request",
|
||
iconKey: "github",
|
||
statusCategory: "succeeded",
|
||
statusIconKey: null,
|
||
liveness: "fresh",
|
||
statusLabel: "Merged",
|
||
displayTitle: "acme/web#241: Add rich object presentation metadata",
|
||
url: "https://github.com/acme/web/pull/241",
|
||
}}
|
||
/>,
|
||
);
|
||
expect(html).toContain("Merged");
|
||
expect(html).toContain("PR 241 - Merged");
|
||
expect(html).not.toContain("acme/web#241</span>");
|
||
expect(html).toContain("text-violet-600");
|
||
expect(html).not.toContain(">Github Pull Request</span>");
|
||
expect(html).toContain('aria-label="Github Pull Request — Merged: acme/web#241: Add rich object presentation metadata"');
|
||
});
|
||
|
||
it("labels generic URL link objects as URL instead of URL link", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectPill
|
||
object={{
|
||
providerKey: "url",
|
||
objectType: "link",
|
||
statusCategory: "unknown",
|
||
liveness: "unknown",
|
||
displayTitle: null,
|
||
url: "https://example.com/",
|
||
}}
|
||
/>,
|
||
);
|
||
|
||
expect(html).toContain('aria-label="URL — Not yet resolved"');
|
||
expect(html).not.toContain("URL link");
|
||
});
|
||
});
|
||
|
||
describe("ExternalObjectStatusSummary", () => {
|
||
it("hides itself when there are no external objects", () => {
|
||
const html = renderToStaticMarkup(<ExternalObjectStatusSummary summary={null} />);
|
||
expect(html).toBe("");
|
||
});
|
||
|
||
it("hides itself when the highest severity is muted", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectStatusSummary
|
||
summary={{
|
||
total: 2,
|
||
byStatusCategory: { closed: 2 },
|
||
byLiveness: { fresh: 2 },
|
||
highestSeverity: "muted",
|
||
staleCount: 0,
|
||
authRequiredCount: 0,
|
||
unreachableCount: 0,
|
||
objects: [],
|
||
}}
|
||
/>,
|
||
);
|
||
expect(html).toBe("");
|
||
});
|
||
|
||
it("shows the dominant-severity icon and count", () => {
|
||
const html = renderToStaticMarkup(
|
||
<ExternalObjectStatusSummary
|
||
summary={{
|
||
total: 5,
|
||
byStatusCategory: { failed: 3, succeeded: 2 },
|
||
byLiveness: { fresh: 5 },
|
||
highestSeverity: "danger",
|
||
staleCount: 0,
|
||
authRequiredCount: 0,
|
||
unreachableCount: 0,
|
||
objects: [
|
||
{ id: "a", providerKey: "ci", objectType: "deployment", displayTitle: null, statusCategory: "failed", statusTone: "danger", liveness: "fresh", isTerminal: false },
|
||
{ id: "b", providerKey: "ci", objectType: "deployment", displayTitle: null, statusCategory: "failed", statusTone: "danger", liveness: "fresh", isTerminal: false },
|
||
{ id: "c", providerKey: "ci", objectType: "deployment", displayTitle: null, statusCategory: "failed", statusTone: "danger", liveness: "fresh", isTerminal: false },
|
||
{ id: "d", providerKey: "github", objectType: "pull_request", displayTitle: null, statusCategory: "succeeded", statusTone: "success", liveness: "fresh", isTerminal: true },
|
||
{ id: "e", providerKey: "github", objectType: "pull_request", displayTitle: null, statusCategory: "succeeded", statusTone: "success", liveness: "fresh", isTerminal: true },
|
||
],
|
||
}}
|
||
/>,
|
||
);
|
||
expect(html).toContain('data-external-status="failed"');
|
||
expect(html).toContain('data-external-tone="danger"');
|
||
expect(html).toContain(">3<");
|
||
expect(html).toContain("aria-label=\"External objects: 3 failed, 2 succeeded, 5 total\"");
|
||
});
|
||
});
|