History

Cover the fingerprint wiring and pin the hash threshold

Rhys Sullivan committed 2 months ago

Commit f8f033f1 parent 4c3f2229 files · +193 −70Browse files

Showing the changes to apps/cloud/src (3 of 9 files). Show all

Unified · Split

3 files
  1. apps/cloud/src/observability/index.ts +29 −11
  2. apps/cloud/src/observability/observability.test.ts +20 −2
  3. apps/cloud/src/server.ts +3 −26
apps/cloud/src/observability/index.ts+29−11
@@ -16,7 +16,7 @@ import { Cause, Effect, Layer } from "effect"; · 15 unmodified lines
1616 import type * as Tracer from "effect/Tracer";
1717
1818 import { ErrorCapture } from "@executor-js/api";
19−import { stableGroupingFingerprint, type GroupingEvent } from "@executor-js/sdk/sentry-grouping";
19+import { withStableGroupingFingerprint } from "@executor-js/sdk/sentry-grouping";
2020
2121 // Drizzle/postgres-js include the failing SQL (params + bound values) in
2222 // their error message. For OpenAPI source inserts that's 1MB+ of spec
@@ -148,19 +148,13 @@ export const beforeSendWithOtelCorrelation = ( · 125 unmodified lines
148148 };
149149
150150 /**
151+ * The single `beforeSend` the worker and its Durable Objects install.
152+ *
151153 * The worker ships as content-hashed chunks and its frames are not resolved
152154 * back to source, so Sentry's default grouping keys on names like
153155 * `execution-rate-limit-<hash>` and re-opens every issue on the next deploy.
154− * Pin a fingerprint with the hash normalized out; events with no hashed
155− * grouping input are left on the default algorithm.
156− */
157−export const withStableGroupingFingerprint = <T extends GroupingEvent>(event: T): T => {
158− const fingerprint = stableGroupingFingerprint(event);
159− return fingerprint ? { ...event, fingerprint: [...fingerprint] } : event;
160−};
161−
162−/**
163− * The single `beforeSend` the worker and its Durable Objects install.
156+ * `withStableGroupingFingerprint` pins a key with the hash normalized out;
157+ * events with no hashed grouping input are left on the default algorithm.
164158 *
165159 * The two stages are independent and compose in this order: the capture-owner
166160 * pass decides WHETHER the event is reported at all (a cause the Durable
@@ -176,6 +170,30 @@ export const beforeSendCloudEvent = ( · 9 unmodified lines
176170 return reported === null ? null : withStableGroupingFingerprint(reported);
177171 };
178172
173+/**
174+ * The Sentry options the worker and every Durable Object install. It lives
175+ * beside the `beforeSend` it wires so the composition is covered by
176+ * observability.test.ts; `server.ts` only passes this through.
177+ *
178+ * NOTE: do NOT enable `instrumentPrototypeMethods`. It walks the DO prototype
179+ * and reads every property — including accessors — to find methods to wrap,
180+ * which invokes the `sessionId` getter with `this` bound to the prototype
181+ * (where `ctx` is undefined) and throws during construction, 500ing every
182+ * session create / cold restore. The DO captures its own errors via the
183+ * `captureCause` seam (→ Sentry) instead.
184+ */
185+export const cloudSentryOptions = (env: Env) => ({
186+ dsn: env.SENTRY_DSN,
187+ tracesSampleRate: 0,
188+ enableLogs: true,
189+ sendDefaultPii: true,
190+ skipOpenTelemetrySetup: true,
191+ beforeSend: (event: ErrorEvent) =>
192+ beforeSendCloudEvent(event, {
193+ logPayload: !env.SENTRY_DSN || env.SENTRY_OTEL_LOG_PAYLOAD === "true",
194+ }),
195+});
196+
179197 export const addCurrentOtelCorrelationTags = <
180198 T extends { readonly tags?: Record<string, unknown> },
181199 >(
apps/cloud/src/observability/observability.test.ts+20−2
@@ -8,6 +8,7 @@ import { · 7 unmodified lines
88 addCurrentOtelCorrelationTags,
99 beforeSendCloudEvent,
1010 beforeSendWithOtelCorrelation,
11+ cloudSentryOptions,
1112 DO_CAUSE_OWNER_TAG,
1213 DO_CAUSE_OWNER_VALUE,
1314 OTEL_SPAN_ID_TAG,
@@ -86,8 +87,10 @@ describe("sentryPayloadForCause", () => { · 72 unmodified lines
8687 });
8788
8889 // Grouping keys are decided inside the Sentry SDK and never appear on any
89−// product surface, so the e2e harness cannot observe them; the running
90−// beforeSend itself is covered by e2e/cloud/sentry-otel-correlation.test.ts.
90+// product surface, so the e2e harness cannot observe them. The split is:
91+// e2e/cloud/sentry-otel-correlation.test.ts proves the worker really installs
92+// `cloudSentryOptions.beforeSend` (its correlation payload only exists if that
93+// hook ran), and the tests here prove the hook it installs fingerprints.
9194 describe("Sentry grouping", () => {
9295 // The worker bundle ships as content-hashed chunks, so the only module name
9396 // Sentry ever sees for a given frame changes on every deploy.
@@ -143,6 +146,21 @@ describe("Sentry grouping", () => { · 49 unmodified lines
143146 expect(sent).not.toBeNull();
144147 expect(sent?.fingerprint).toBeUndefined();
145148 });
149+
150+ // The wiring check: this is the exact object handed to `Sentry.withSentry`
151+ // and `instrumentDurableObjectWithSentry` in server.ts. If the normalizer is
152+ // ever dropped from the hook the worker installs, this fails.
153+ it("the options the worker and DOs install carry the fingerprinting hook", () => {
154+ const options = cloudSentryOptions({ SENTRY_DSN: "https://public@example.invalid/1" } as Env);
155+ const sent = options.beforeSend(workerEvent("BAuwphPA"));
156+
157+ expect(sent?.fingerprint).toEqual([
158+ "GateCheckTimeoutError",
159+ "timeoutOrElse@execution-rate-limit",
160+ ]);
161+ // Same source, next deploy, new chunk hash — one issue, not two.
162+ expect(options.beforeSend(workerEvent("DkcPBbWe"))?.fingerprint).toEqual(sent?.fingerprint);
163+ });
146164 });
147165
148166 describe("Sentry OTel correlation", () => {
apps/cloud/src/server.ts+3−26
@@ -1,6 +1,5 @@
11 import { DurableObject } from "cloudflare:workers";
22 import { SpanKind, SpanStatusCode, context, trace, type SpanContext } from "@opentelemetry/api";
3−import type { ErrorEvent } from "@sentry/cloudflare";
43 import {
54 ATTR_HTTP_REQUEST_METHOD,
65 ATTR_HTTP_RESPONSE_STATUS_CODE,
@@ -19,7 +18,7 @@ import { classifyMcpPath, prepareMcpOrgScope } from "./mcp/mount"; · 12 unmodified lines
1918 import { parseTraceparent } from "./mcp/traceparent";
2019 import { McpSessionDOSqlite as McpSessionDOBase } from "./mcp/session-durable-object";
2120 import {
22− beforeSendCloudEvent,
21+ cloudSentryOptions,
2322 captureCause,
2423 otelCorrelationContextFromOpenTelemetrySpan,
2524 SENTRY_EVENT_ID_ATTRIBUTE,
@@ -28,28 +27,6 @@ import { · 2 unmodified lines
2827 import { browserTracesResponse } from "./observability/browser-traces";
2928 import { flushTracerProvider, installTracerProvider } from "./observability/telemetry";
3029
31−// ---------------------------------------------------------------------------
32−// Sentry config
33−// ---------------------------------------------------------------------------
34−
35−const sentryOptions = (env: Env) => ({
36− dsn: env.SENTRY_DSN,
37− tracesSampleRate: 0,
38− enableLogs: true,
39− sendDefaultPii: true,
40− skipOpenTelemetrySetup: true,
41− beforeSend: (event: ErrorEvent) =>
42− beforeSendCloudEvent(event, {
43− logPayload: !env.SENTRY_DSN || env.SENTRY_OTEL_LOG_PAYLOAD === "true",
44− }),
45− // NOTE: do NOT enable `instrumentPrototypeMethods`. It walks the DO prototype
46− // and reads every property — including accessors — to find methods to wrap,
47− // which invokes the `sessionId` getter with `this` bound to the prototype
48− // (where `ctx` is undefined) and throws during construction, 500ing every
49− // session create / cold restore. The DO captures its own errors via the
50− // `captureCause` seam (→ Sentry) instead.
51−});
52−
5330 // ---------------------------------------------------------------------------
5431 // Durable Object — wrapped with Sentry so DO errors land in Sentry (inits the
5532 // client inside the DO isolate, which plain `Sentry.captureException` cannot
@@ -58,7 +35,7 @@ const sentryOptions = (env: Env) => ({ · 2 unmodified lines
5835 // ---------------------------------------------------------------------------
5936
6037 export const McpSessionDOSqlite = Sentry.instrumentDurableObjectWithSentry(
61− sentryOptions,
38+ cloudSentryOptions,
6239 McpSessionDOBase,
6340 );
6441
@@ -458,4 +435,4 @@ const cloudflareHandler: ExportedHandler<Env> = { · 393 unmodified lines
458435 },
459436 };
460437
461−export default Sentry.withSentry(sentryOptions, cloudflareHandler);
438+export default Sentry.withSentry(cloudSentryOptions, cloudflareHandler);

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t