feat(effect): Add client/server entrypoints without functionality #19649
+178
−110
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,25 @@ | ||
| import { makeBaseNPMConfig, makeNPMConfigVariants } from '@sentry-internal/rollup-utils'; | ||
|
|
||
| const baseConfig = makeBaseNPMConfig({ | ||
| entrypoints: ['src/index.server.ts', 'src/index.client.ts'], | ||
| packageSpecificConfig: { | ||
| output: { | ||
| preserveModulesRoot: 'src', | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| const defaultExternal = baseConfig.external || []; | ||
| baseConfig.external = id => { | ||
| if (defaultExternal.includes(id)) { | ||
| return true; | ||
| } | ||
|
|
||
| if (id === 'effect' || id.startsWith('effect/') || id.startsWith('@sentry/')) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| }; | ||
|
|
||
| export default makeNPMConfigVariants(baseConfig); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import type { BrowserOptions } from '@sentry/browser'; | ||
| import * as EffectLayer from 'effect/Layer'; | ||
|
|
||
| /** | ||
| * Options for the Sentry Effect client layer. | ||
| */ | ||
| export type EffectClientLayerOptions = BrowserOptions; | ||
|
|
||
| /** | ||
| * Creates an empty Effect Layer | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * import * as Sentry from '@sentry/effect/client'; | ||
| * import { Layer, Effect } from 'effect'; | ||
| * | ||
| * const ApiClientWithSentry = ApiClientLive.pipe( | ||
| * Layer.provide(Sentry.effectLayer({ | ||
| * dsn: '__DSN__', | ||
| * integrations: [Sentry.browserTracingIntegration()], | ||
| * tracesSampleRate: 1.0, | ||
| * })), | ||
| * ); | ||
| * | ||
| * Effect.runPromise(Effect.provide(myEffect, ApiClientWithSentry)); | ||
| * ``` | ||
| */ | ||
| export function effectLayer(_: EffectClientLayerOptions): EffectLayer.Layer<never, never, never> { | ||
| return EffectLayer.empty; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| export * from '@sentry/browser'; | ||
|
|
||
| export { effectLayer } from './client/index'; | ||
| export type { EffectClientLayerOptions } from './client/index'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| export * from '@sentry/node-core/light'; | ||
|
|
||
| export { effectLayer } from './server/index'; | ||
| export type { EffectServerLayerOptions } from './server/index'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* eslint-disable import/export */ | ||
|
|
||
| // We export everything from both the client part of the SDK and from the server part. | ||
| // Some of the exports collide, which is not allowed, unless we redefine the colliding | ||
| // exports in this file - which we do below. | ||
| import type { Client, Integration, Options, StackParser } from '@sentry/core'; | ||
| import type * as EffectLayer from 'effect/Layer'; | ||
| import type * as clientSdk from './index.client'; | ||
| import type * as serverSdk from './index.server'; | ||
|
|
||
| export * from './index.client'; | ||
| export * from './index.server'; | ||
|
|
||
| export type { EffectClientLayerOptions } from './index.client'; | ||
| export type { EffectServerLayerOptions } from './index.server'; | ||
|
|
||
| export declare function effectLayer( | ||
| options: clientSdk.EffectClientLayerOptions | serverSdk.EffectServerLayerOptions, | ||
| ): EffectLayer.Layer<never, never, never>; | ||
|
|
||
| export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined; | ||
| export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration; | ||
| export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration; | ||
| export declare const getDefaultIntegrations: (options: Options) => Integration[]; | ||
| export declare const defaultStackParser: StackParser; | ||
| export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import type { NodeOptions } from '@sentry/node-core'; | ||
| import * as EffectLayer from 'effect/Layer'; | ||
|
|
||
| /** | ||
| * Options for the Sentry Effect server layer. | ||
| */ | ||
| export type EffectServerLayerOptions = NodeOptions; | ||
|
|
||
| /** | ||
| * Creates an empty Effect Layer | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * import * as Sentry from '@sentry/effect/server'; | ||
| * import { NodeRuntime } from '@effect/platform-node'; | ||
| * import { Layer } from 'effect'; | ||
| * import { HttpLive } from './Http.js'; | ||
| * | ||
| * const MainLive = HttpLive.pipe( | ||
| * Layer.provide(Sentry.effectLayer({ | ||
| * dsn: '__DSN__', | ||
| * enableLogs: true, | ||
| * enableMetrics: true, | ||
| * })), | ||
| * ); | ||
| * | ||
| * MainLive.pipe(Layer.launch, NodeRuntime.runMain); | ||
| * ``` | ||
| */ | ||
| export function effectLayer(_: EffectServerLayerOptions): EffectLayer.Layer<never, never, never> { | ||
| return EffectLayer.empty; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing default fallback conditions in exports map
Medium Severity
The
"."export inpackage.jsononly definesbrowserandnodeconditions with noimport/require/defaultfallback. The comparable@sentry/nuxtpackage includes top-level"import"and"require"fallbacks after"browser"and"node". Without these, environments that don't setbrowserornodeconditions (edge runtimes, some test runners, certain bundler configurations) will fail to resolve@sentry/effect.