mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 21:49:18 +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>
287 lines
7.6 KiB
TypeScript
287 lines
7.6 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
import { errorHandler } from "../middleware/index.js";
|
|
import { authRoutes } from "../routes/auth.js";
|
|
|
|
function createSelectChain(rows: unknown[]) {
|
|
return {
|
|
from() {
|
|
return {
|
|
where() {
|
|
return Promise.resolve(rows);
|
|
},
|
|
};
|
|
},
|
|
};
|
|
}
|
|
|
|
function createUpdateChain(row: unknown) {
|
|
return {
|
|
set(values: unknown) {
|
|
return {
|
|
where() {
|
|
return {
|
|
returning() {
|
|
return Promise.resolve([{ ...(row as Record<string, unknown>), ...(values as Record<string, unknown>) }]);
|
|
},
|
|
};
|
|
},
|
|
};
|
|
},
|
|
};
|
|
}
|
|
|
|
function createDb(row: Record<string, unknown>) {
|
|
return {
|
|
select: () => createSelectChain([row]),
|
|
update: () => createUpdateChain(row),
|
|
} as any;
|
|
}
|
|
|
|
function createApp(actor: Express.Request["actor"], row: Record<string, unknown>) {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api/auth", authRoutes(createDb(row)));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe.sequential("auth routes", () => {
|
|
const baseUser = {
|
|
id: "user-1",
|
|
name: "Jane Example",
|
|
email: "jane@example.com",
|
|
image: "https://example.com/jane.png",
|
|
};
|
|
const originalSentryDsn = process.env.SENTRY_DSN;
|
|
const originalSentryDsnFrontend = process.env.SENTRY_DSN_FRONTEND;
|
|
const originalSentryDsnBackend = process.env.SENTRY_DSN_BACKEND;
|
|
|
|
afterEach(() => {
|
|
if (originalSentryDsn === undefined) delete process.env.SENTRY_DSN;
|
|
else process.env.SENTRY_DSN = originalSentryDsn;
|
|
if (originalSentryDsnFrontend === undefined) delete process.env.SENTRY_DSN_FRONTEND;
|
|
else process.env.SENTRY_DSN_FRONTEND = originalSentryDsnFrontend;
|
|
if (originalSentryDsnBackend === undefined) delete process.env.SENTRY_DSN_BACKEND;
|
|
else process.env.SENTRY_DSN_BACKEND = originalSentryDsnBackend;
|
|
});
|
|
|
|
it("returns the persisted user profile in the session payload", async () => {
|
|
delete process.env.SENTRY_DSN;
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toEqual({
|
|
session: {
|
|
id: "paperclip:session:user-1",
|
|
userId: "user-1",
|
|
},
|
|
user: baseUser,
|
|
sentryDsn: null,
|
|
});
|
|
});
|
|
|
|
it("sends sentryDsn for a board actor when SENTRY_DSN is set", async () => {
|
|
process.env.SENTRY_DSN = "https://public@o0.ingest.sentry.io/1";
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.sentryDsn).toBe("https://public@o0.ingest.sentry.io/1");
|
|
});
|
|
|
|
it("sends a null sentryDsn when SENTRY_DSN is unset", async () => {
|
|
delete process.env.SENTRY_DSN;
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.sentryDsn).toBe(null);
|
|
});
|
|
|
|
it("sends sentryDsn for a board actor when only SENTRY_DSN_FRONTEND is set", async () => {
|
|
delete process.env.SENTRY_DSN;
|
|
delete process.env.SENTRY_DSN_BACKEND;
|
|
process.env.SENTRY_DSN_FRONTEND = "https://public-frontend@o0.ingest.sentry.io/1";
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.sentryDsn).toBe("https://public-frontend@o0.ingest.sentry.io/1");
|
|
});
|
|
|
|
it("sends a null sentryDsn when only SENTRY_DSN_BACKEND is set", async () => {
|
|
delete process.env.SENTRY_DSN;
|
|
delete process.env.SENTRY_DSN_FRONTEND;
|
|
process.env.SENTRY_DSN_BACKEND = "https://public-backend@o0.ingest.sentry.io/2";
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.sentryDsn).toBe(null);
|
|
});
|
|
|
|
it("sends only the front-end DSN when SENTRY_DSN_FRONTEND and SENTRY_DSN_BACKEND differ", async () => {
|
|
delete process.env.SENTRY_DSN;
|
|
process.env.SENTRY_DSN_FRONTEND = "https://public-frontend@o0.ingest.sentry.io/1";
|
|
process.env.SENTRY_DSN_BACKEND = "https://public-backend@o0.ingest.sentry.io/2";
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.sentryDsn).toBe("https://public-frontend@o0.ingest.sentry.io/1");
|
|
expect(res.body.sentryDsn).not.toBe("https://public-backend@o0.ingest.sentry.io/2");
|
|
});
|
|
|
|
it("answers 401 and sends no DSN when the actor type is none", async () => {
|
|
process.env.SENTRY_DSN = "https://public@o0.ingest.sentry.io/1";
|
|
const app = await createApp(
|
|
{
|
|
type: "none",
|
|
source: "none",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app).get("/api/auth/get-session");
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(res.body.sentryDsn).toBeUndefined();
|
|
});
|
|
|
|
it("updates the signed-in profile", async () => {
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "local_implicit",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.patch("/api/auth/profile")
|
|
.send({ name: "Board Operator", image: "" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
id: "user-1",
|
|
name: "Board Operator",
|
|
email: "jane@example.com",
|
|
image: null,
|
|
});
|
|
});
|
|
|
|
it("preserves the existing avatar when updating only the profile name", async () => {
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "local_implicit",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.patch("/api/auth/profile")
|
|
.send({ name: "Board Operator" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
id: "user-1",
|
|
name: "Board Operator",
|
|
email: "jane@example.com",
|
|
image: "https://example.com/jane.png",
|
|
});
|
|
});
|
|
|
|
it("accepts Paperclip asset paths for avatars", async () => {
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.patch("/api/auth/profile")
|
|
.send({ name: "Jane Example", image: "/api/assets/asset-1/content" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.image).toBe("/api/assets/asset-1/content");
|
|
});
|
|
|
|
it("rejects invalid avatar image references", async () => {
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
},
|
|
baseUser,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.patch("/api/auth/profile")
|
|
.send({ name: "Jane Example", image: "not-a-url" });
|
|
|
|
expect(res.status).toBe(400);
|
|
});
|
|
});
|