mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-17 10:06:42 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators can enable Sentry for the server and the signed-in browser. > - The server SDK reads `SENTRY_ENVIRONMENT` from the process environment. > - The browser receives its DSN through the session response, but receives no environment. > - A browser in staging therefore reports errors under the SDK's production default. > - This pull request passes the configured environment through the existing session and monitoring gate. > - Browser errors then identify the deployment environment while preserving the existing privacy settings. ## Linked Issues or Issue Description **What happened?** With `SENTRY_ENVIRONMENT=staging`, browser exceptions are tagged `production`. This can send errors to the wrong environment's alerts and makes deployment follow-up unreliable. **Expected behavior** The browser uses the server's configured Sentry environment. A reused image works in either staging or production. A signed-out browser still sends no events. **Steps to reproduce** 1. Configure a frontend Sentry DSN and `SENTRY_ENVIRONMENT=staging`. 2. Sign in and capture a browser exception. 3. Inspect the event environment. Before this change, it is `production`. **Paperclip version or commit** Reproduced on `a3749aac4680a901fa0fe1cc898907887abc9908` with the real browser SDK and a local test transport. **Deployment mode** Authenticated server and browser with optional Sentry monitoring enabled. No duplicate environment-attribution issue or pull request was found in the targeted GitHub search. ## What Changed - Add `sentryEnvironment` to the authenticated session response and shared schema. The optional field supports a newer browser reading an older server response. - Pass the environment to the browser SDK. An environment change restarts the client through its existing serialized lifecycle. - Cover environment attribution with a real SDK event, session authorization, unchanged-session refetches, environment changes, and legacy responses. - Document configuration and compatibility. Keep the loaded bundle's release identity and existing privacy filters. ## Verification - The regression test emits `production` for a requested staging environment before the fix. - Focused route, schema, browser lifecycle and real-SDK tests: 69 pass. - UI and shared-package typechecks, direct server `tsc --noEmit`, and token gates pass. - Full `pnpm build` and `pnpm -r typecheck` were attempted. Both stop at the Runner Rust step because `cargo` is absent on this machine. - Complete UI suite: 6,540 tests pass in 626 files. - Full `pnpm test:run`: 8,210 passed, 14 failed, 4,753 skipped; 36 files fail due to embedded PostgreSQL startup/cleanup and macOS runtime-cache `EACCES`. These match the existing local baseline; none touch the changed behavior. - Greptile: 5/5, no unresolved review threads. Linux CI has passed Build, Typecheck + Release Registry, and the completed test jobs so far. Remaining jobs are running or queued: the AWS runner provisioner is retrying EC2 CreateFleet `InternalError` responses. Full results will be recorded before merge. ## Risks Low risk. This adds one optional session field and changes Sentry attribution only. No migration or new monitoring opt-in is introduced. Missing settings keep the browser SDK default. Agent and unauthenticated requests still receive 401 without monitoring settings. Existing loaded browser bundles keep their old behavior until refreshed. ## Model Used OpenAI GPT-6 via Codex, with reasoning, repository inspection, code editing, and test execution. The session does not expose an exact model snapshot or context-window size. ## 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 - [ ] I have run tests locally and they pass (focused and full UI suites pass; full-root environment failures documented above) - [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 - [ ] 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>
186 lines
5.7 KiB
TypeScript
186 lines
5.7 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { authSessionSchema, currentUserProfileSchema } from "./access.js";
|
|
|
|
describe("currentUserProfileSchema", () => {
|
|
it("coerces empty-string name to null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "a@b.com",
|
|
name: "",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.name).toBe(null);
|
|
});
|
|
|
|
it("coerces whitespace-only name to null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "a@b.com",
|
|
name: " ",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.name).toBe(null);
|
|
});
|
|
|
|
it("preserves a real name unchanged", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "a@b.com",
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.name).toBe("Jane");
|
|
});
|
|
|
|
it("preserves null name as null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "a@b.com",
|
|
name: null,
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.name).toBe(null);
|
|
});
|
|
|
|
it("coerces empty-string email to null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "",
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.email).toBe(null);
|
|
});
|
|
|
|
it("coerces whitespace-only email to null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: " ",
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.email).toBe(null);
|
|
});
|
|
|
|
it("preserves a real email unchanged", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "a@b.com",
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.email).toBe("a@b.com");
|
|
});
|
|
|
|
it("preserves null email as null", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: null,
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.email).toBe(null);
|
|
});
|
|
|
|
it("still rejects a malformed non-empty email", () => {
|
|
const result = currentUserProfileSchema.safeParse({
|
|
id: "u1",
|
|
email: "not-an-email",
|
|
name: "Jane",
|
|
image: null,
|
|
});
|
|
expect(result.success).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("authSessionSchema", () => {
|
|
it("parses a session where user name is empty string (identity provider without a name)", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "", image: null },
|
|
sentryDsn: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.user.name).toBe(null);
|
|
});
|
|
|
|
it("parses a session where user has a real name", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "Jane", image: null },
|
|
sentryDsn: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.user.name).toBe("Jane");
|
|
});
|
|
|
|
it("parses a session where user name is null", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: null, image: null },
|
|
sentryDsn: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.user.name).toBe(null);
|
|
});
|
|
|
|
it("parses a session where user email is empty string (identity provider without an email)", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "", name: "Jane", image: null },
|
|
sentryDsn: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.user.email).toBe(null);
|
|
});
|
|
|
|
it("rejects a payload with no sentryDsn field", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "Jane", image: null },
|
|
});
|
|
expect(result.success).toBe(false);
|
|
});
|
|
|
|
it("accepts a null sentryDsn", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "Jane", image: null },
|
|
sentryDsn: null,
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.sentryDsn).toBe(null);
|
|
});
|
|
|
|
it.each([undefined, null, "staging", "production"])(
|
|
"preserves the optional Sentry environment (%s)",
|
|
(environment) => {
|
|
const result = authSessionSchema.parse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "Jane", image: null },
|
|
sentryDsn: null,
|
|
...(environment === undefined ? {} : { sentryEnvironment: environment }),
|
|
});
|
|
expect(result.sentryEnvironment).toBe(environment);
|
|
},
|
|
);
|
|
|
|
it("accepts a real sentryDsn value", () => {
|
|
const result = authSessionSchema.safeParse({
|
|
session: { id: "s1", userId: "u1" },
|
|
user: { id: "u1", email: "a@b.com", name: "Jane", image: null },
|
|
sentryDsn: "https://public@o0.ingest.sentry.io/1",
|
|
});
|
|
expect(result.success).toBe(true);
|
|
expect(result.success && result.data.sentryDsn).toBe("https://public@o0.ingest.sentry.io/1");
|
|
});
|
|
});
|