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 > - 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>
33 lines
1.3 KiB
TypeScript
33 lines
1.3 KiB
TypeScript
// Resolves the Sentry DSN for each component from the process environment.
|
|
//
|
|
// Precedence: a specific variable always wins for its own component.
|
|
// `SENTRY_DSN` supplies a component that has no specific value set.
|
|
// An empty string counts as absent for every variable, so a specific
|
|
// variable set to `""` still falls back to `SENTRY_DSN`.
|
|
//
|
|
// To add a DSN for a new component, add a field to `SentryDsns`, add a
|
|
// variable named with the shared `SENTRY_DSN_` prefix, and resolve it with
|
|
// `normalize` the same way `frontend` and `backend` resolve here.
|
|
|
|
export interface SentryDsns {
|
|
frontend: string | null;
|
|
backend: string | null;
|
|
legacyFallbackUsed: boolean;
|
|
}
|
|
|
|
function normalize(value: string | undefined): string | null {
|
|
return value ? value : null;
|
|
}
|
|
|
|
export function resolveSentryDsns(env: NodeJS.ProcessEnv = process.env): SentryDsns {
|
|
const legacy = normalize(env.SENTRY_DSN);
|
|
const specificFrontend = normalize(env.SENTRY_DSN_FRONTEND);
|
|
const specificBackend = normalize(env.SENTRY_DSN_BACKEND);
|
|
|
|
const frontend = specificFrontend ?? legacy;
|
|
const backend = specificBackend ?? legacy;
|
|
const legacyFallbackUsed = (specificFrontend === null || specificBackend === null) && legacy !== null;
|
|
|
|
return { frontend, backend, legacyFallbackUsed };
|
|
}
|