mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 09:41:04 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Paperclip reports server and browser errors through optional Sentry monitoring > - One environment variable sends both error types to one Sentry project > - Operators need separate control for browser and server error data > - This pull request adds specific variables and keeps the existing variable as a fallback > - The benefit is separate monitoring without breaking current deployments ## Linked Issues or Issue Description **What existing behavior does this improve?** The Sentry configuration for server and browser monitoring uses one environment variable. **Subsystem affected** Cross-cutting (multiple of the above) **Current behavior** `SENTRY_DSN` supplies the server and browser clients. Both clients therefore report to the same Sentry project. **Proposed behavior** `SENTRY_DSN_FRONTEND` supplies the browser client. `SENTRY_DSN_BACKEND` supplies the server process. `SENTRY_DSN` remains a fallback for either component. **Reason and benefit** Operators can send browser and server errors to separate Sentry projects. Operators can also activate only one component. **Breaking changes** None. Existing deployments can continue to use `SENTRY_DSN`. ## What Changed - Add `resolveSentryDsns(env)` and use it in the server and browser configuration paths. - Add precedence, empty-string, fallback, and route tests. - Update the README, observability guide, and stale code comments. - Log one warning when the server uses the legacy fallback without exposing a DSN value. ## Verification - `pnpm vitest run --project server sentry-dsn` — 8 tests pass. - `pnpm vitest run --project server auth-routes` — 21 tests pass. - The earlier run of the three targeted suites passed 40 tests. - `tsc --noEmit` passes for the files in this diff. - All required GitHub Actions checks pass, including the full continuous-integration suite. ## Risks The main risk is an incorrect environment variable precedence rule. Unit tests cover specific values, empty strings, and legacy fallback behavior. The existing `SENTRY_DSN` path remains compatible. ## Model Used OpenAI Codex — GPT-5, current runtime, tool use and code execution. ## 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>
64 lines
2.5 KiB
TypeScript
64 lines
2.5 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { resolveSentryDsns } from "../sentry-dsn.js";
|
|
|
|
const FRONTEND_DSN = "https://public-frontend@o0.ingest.sentry.io/1";
|
|
const BACKEND_DSN = "https://public-backend@o0.ingest.sentry.io/2";
|
|
const LEGACY_DSN = "https://public-legacy@o0.ingest.sentry.io/3";
|
|
|
|
describe("resolveSentryDsns", () => {
|
|
it("resolves both fields to null when no variable is set", () => {
|
|
const result = resolveSentryDsns({});
|
|
|
|
expect(result).toEqual({ frontend: null, backend: null, legacyFallbackUsed: false });
|
|
});
|
|
|
|
it("uses the legacy value for both fields when only SENTRY_DSN is set", () => {
|
|
const result = resolveSentryDsns({ SENTRY_DSN: LEGACY_DSN });
|
|
|
|
expect(result).toEqual({ frontend: LEGACY_DSN, backend: LEGACY_DSN, legacyFallbackUsed: true });
|
|
});
|
|
|
|
it("resolves only the frontend field when only SENTRY_DSN_FRONTEND is set", () => {
|
|
const result = resolveSentryDsns({ SENTRY_DSN_FRONTEND: FRONTEND_DSN });
|
|
|
|
expect(result).toEqual({ frontend: FRONTEND_DSN, backend: null, legacyFallbackUsed: false });
|
|
});
|
|
|
|
it("resolves only the backend field when only SENTRY_DSN_BACKEND is set", () => {
|
|
const result = resolveSentryDsns({ SENTRY_DSN_BACKEND: BACKEND_DSN });
|
|
|
|
expect(result).toEqual({ frontend: null, backend: BACKEND_DSN, legacyFallbackUsed: false });
|
|
});
|
|
|
|
it("resolves each field to its own value when both specific variables are set", () => {
|
|
const result = resolveSentryDsns({
|
|
SENTRY_DSN_FRONTEND: FRONTEND_DSN,
|
|
SENTRY_DSN_BACKEND: BACKEND_DSN,
|
|
});
|
|
|
|
expect(result).toEqual({ frontend: FRONTEND_DSN, backend: BACKEND_DSN, legacyFallbackUsed: false });
|
|
});
|
|
|
|
it("prefers the specific variables over SENTRY_DSN when all three are set", () => {
|
|
const result = resolveSentryDsns({
|
|
SENTRY_DSN_FRONTEND: FRONTEND_DSN,
|
|
SENTRY_DSN_BACKEND: BACKEND_DSN,
|
|
SENTRY_DSN: LEGACY_DSN,
|
|
});
|
|
|
|
expect(result).toEqual({ frontend: FRONTEND_DSN, backend: BACKEND_DSN, legacyFallbackUsed: false });
|
|
});
|
|
|
|
it("falls back to the legacy value for a component whose specific variable is an empty string", () => {
|
|
const result = resolveSentryDsns({ SENTRY_DSN_FRONTEND: "", SENTRY_DSN: LEGACY_DSN });
|
|
|
|
expect(result).toEqual({ frontend: LEGACY_DSN, backend: LEGACY_DSN, legacyFallbackUsed: true });
|
|
});
|
|
|
|
it("treats an empty SENTRY_DSN as absent when no specific variable is set", () => {
|
|
const result = resolveSentryDsns({ SENTRY_DSN: "" });
|
|
|
|
expect(result).toEqual({ frontend: null, backend: null, legacyFallbackUsed: false });
|
|
});
|
|
});
|