Skip to content

feat(effect): Export layers for browser | setTracer in buildEffectTracer #19816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 2 commits into from
Mar 17, 2026
+41 −26
Merged

feat(effect): Export layers for browser | setTracer in buildEffectTracer #19816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8af0f44
feat(effect): Export layers for browser | setTracer in buildEffectTracer
JPeer264 Mar 16, 2026
6427f10
fixup! feat(effect): Export layers for browser | setTracer in buildEf…
JPeer264 Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/effect/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const MainLive = HttpLive.pipe(
Layer.provide(
Sentry.effectLayer({
dsn: '__DSN__',
tracesSampleRate: 1.0,
enableLogs: true,
enableEffectLogs: true,
enableEffectMetrics: true,
Expand Down
4 changes: 4 additions & 0 deletions packages/effect/src/index.client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ export * from '@sentry/browser';

export { effectLayer, init } from './client/index';
export type { EffectClientLayerOptions } from './client/index';

export { SentryEffectTracer } from './tracer';
export { SentryEffectLogger } from './logger';
export { SentryEffectMetricsLayer } from './metrics';
4 changes: 4 additions & 0 deletions packages/effect/src/index.server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@ export * from '@sentry/node-core/light';

export { effectLayer, init } from './server/index';
export type { EffectServerLayerOptions } from './server/index';

export { SentryEffectTracer } from './tracer';
export { SentryEffectLogger } from './logger';
export { SentryEffectMetricsLayer } from './metrics';
4 changes: 1 addition & 3 deletions packages/effect/src/tracer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import {
} from '@sentry/core';
import type * as Context from 'effect/Context';
import * as Exit from 'effect/Exit';
import type * as Layer from 'effect/Layer';
import { setTracer } from 'effect/Layer';
import * as Option from 'effect/Option';
import * as EffectTracer from 'effect/Tracer';

Expand Down Expand Up @@ -198,4 +196,4 @@ const makeSentryTracer = (): EffectTracer.Tracer =>
/**
* Effect Layer that sets up the Sentry tracer for Effect spans.
*/
export const SentryEffectTracerLayer: Layer.Layer<never, never, never> = setTracer(makeSentryTracer());
export const SentryEffectTracer = makeSentryTracer();
Copy link

@sentry sentry bot Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The export SentryEffectTracerLayer was renamed, but the test file tracer.test.ts was not updated and still imports the old, non-existent name, which will break tests.
Severity: HIGH

Suggested Fix

Update packages/effect/test/tracer.test.ts to import the new SentryEffectTracer and wrap it with setTracer before providing it to the Effect in the tests, for example: Effect.provide(setTracer(SentryEffectTracer)). Also, remove the unused setTracer import from packages/effect/src/tracer.ts.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: packages/effect/src/tracer.ts#L201

Potential issue: The refactoring in `packages/effect/src/tracer.ts` replaced the `Layer`
export `SentryEffectTracerLayer` with a raw `Tracer` object named `SentryEffectTracer`.
However, the corresponding test file, `packages/effect/test/tracer.test.ts`, was not
updated. It continues to import `SentryEffectTracerLayer`, which no longer exists. This
import will resolve to `undefined` at runtime, causing all 16 test cases that call
`Effect.provide(SentryEffectTracerLayer)` to fail with a runtime error. Additionally, an
unused import for `setTracer` remains in `tracer.ts`.

Did we get this right? 👍 / 👎 to inform future reviews.

13 changes: 9 additions & 4 deletions packages/effect/src/utils/buildEffectLayer.ts
View file
Open in desktop
Copy link
Member

@Lms24 Lms24 Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignoring this for the review since we remove it in #19823

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import type { Client } from '@sentry/core';
import { hasSpansEnabled, type Client } from '@sentry/core';
import type * as EffectLayer from 'effect/Layer';
import { empty as emptyLayer, provideMerge } from 'effect/Layer';
import { empty as emptyLayer, provideMerge, setTracer } from 'effect/Layer';
import { defaultLogger, replace as replaceLogger } from 'effect/Logger';
import { SentryEffectLogger } from '../logger';
import { SentryEffectMetricsLayer } from '../metrics';
import { SentryEffectTracerLayer } from '../tracer';
import { SentryEffectTracer } from '../tracer';

export interface EffectLayerBaseOptions {
enableEffectLogs?: boolean;
Expand All @@ -27,10 +27,15 @@ export function buildEffectLayer<T extends EffectLayerBaseOptions>(
}

const clientOptions = client.getOptions();
const hasSpans = hasSpansEnabled(clientOptions);
const enableMetrics = clientOptions.enableMetrics ?? clientOptions._experiments?.enableMetrics ?? true;
const enableLogs = clientOptions.enableLogs ?? clientOptions._experiments?.enableLogs ?? false;
const { enableEffectLogs = false, enableEffectMetrics = false } = options;
let layer: EffectLayer.Layer<never, never, never> = SentryEffectTracerLayer;
let layer = emptyLayer;

if (hasSpans) {
layer = layer.pipe(provideMerge(setTracer(SentryEffectTracer)));
}

if (enableEffectLogs && enableLogs) {
const effectLogger = replaceLogger(defaultLogger, SentryEffectLogger);
Expand Down
2 changes: 1 addition & 1 deletion packages/effect/test/buildEffectLayer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ describe('buildEffectLayer', () => {
}),
);
startInactiveSpanSpy.mockRestore();
}).pipe(Effect.provide(buildEffectLayer({}, createClient()))),
}).pipe(Effect.provide(buildEffectLayer({}, createClient({ tracesSampleRate: 1.0 })))),
);
});

Expand Down
39 changes: 21 additions & 18 deletions packages/effect/test/tracer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ import { describe, expect, it } from '@effect/vitest';
import * as sentryCore from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { Effect } from 'effect';
import { setTracer } from 'effect/Layer';
import { afterEach, vi } from 'vitest';
import { SentryEffectTracerLayer } from '../src/tracer';
import { SentryEffectTracer } from '../src/tracer';

describe('SentryEffectTracerLayer', () => {
const SentryTracerLayer = setTracer(SentryEffectTracer);

describe('SentryEffectTracer', () => {
afterEach(() => {
vi.restoreAllMocks();
});
Expand All @@ -22,15 +25,15 @@ describe('SentryEffectTracerLayer', () => {
);

expect(capturedSpanName).toBe('effect-span-executed');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('creates spans with correct attributes', () =>
Effect.gen(function* () {
const result = yield* Effect.withSpan('my-operation')(Effect.succeed('success'));

expect(result).toBe('success');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('handles nested spans', () =>
Expand All @@ -43,7 +46,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(result).toBe('outer-inner-result');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('propagates span context through Effect fibers', () =>
Expand All @@ -60,7 +63,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(results).toEqual(['parent-start', 'child-1', 'child-2', 'parent-end']);
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('handles span failures correctly', () =>
Expand All @@ -70,7 +73,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(result).toBe('caught: expected-error');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('handles span with defects (die)', () =>
Expand All @@ -80,7 +83,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(result).toBe('caught-defect: defect-value');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('works with Effect.all for parallel operations', () =>
Expand All @@ -94,7 +97,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(results).toEqual([1, 2, 3]);
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('supports span annotations', () =>
Expand All @@ -105,7 +108,7 @@ describe('SentryEffectTracerLayer', () => {
);

expect(result).toBe('annotated');
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets span status to ok on success', () =>
Expand All @@ -128,7 +131,7 @@ describe('SentryEffectTracerLayer', () => {
expect(setStatusCalls).toContainEqual({ code: 1 });

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets span status to error on failure', () =>
Expand All @@ -151,7 +154,7 @@ describe('SentryEffectTracerLayer', () => {
expect(setStatusCalls).toContainEqual({ code: 2, message: 'test-error' });

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets span status to error on defect', () =>
Expand All @@ -174,7 +177,7 @@ describe('SentryEffectTracerLayer', () => {
expect(setStatusCalls).toContainEqual({ code: 2, message: 'fatal-defect' });

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('propagates Sentry span context via withActiveSpan', () =>
Expand All @@ -195,7 +198,7 @@ describe('SentryEffectTracerLayer', () => {
expect(withActiveSpanCalls.length).toBeGreaterThan(0);

mockWithActiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets origin to auto.function.effect for regular spans', () =>
Expand All @@ -220,7 +223,7 @@ describe('SentryEffectTracerLayer', () => {
expect(capturedAttributes?.[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]).toBe('auto.function.effect');

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets origin to auto.http.effect for http.server spans', () =>
Expand All @@ -245,7 +248,7 @@ describe('SentryEffectTracerLayer', () => {
expect(capturedAttributes?.[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]).toBe('auto.http.effect');

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('sets origin to auto.http.effect for http.client spans', () =>
Expand All @@ -270,7 +273,7 @@ describe('SentryEffectTracerLayer', () => {
expect(capturedAttributes?.[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]).toBe('auto.http.effect');

mockStartInactiveSpan.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);

it.effect('uses transaction name from isolation scope for http.server spans', () =>
Expand Down Expand Up @@ -301,6 +304,6 @@ describe('SentryEffectTracerLayer', () => {

mockStartInactiveSpan.mockRestore();
mockGetIsolationScope.mockRestore();
}).pipe(Effect.provide(SentryEffectTracerLayer)),
}).pipe(Effect.provide(SentryTracerLayer)),
);
});
Loading