feat(effect): add applySdkMetadata

Author: JPeer264

packages/effect/src/client/index.ts

@@ -1,8 +1,10 @@
 import type { BrowserOptions } from '@sentry/browser';
-import * as Sentry from '@sentry/browser';
 import type * as EffectLayer from 'effect/Layer';
 import { suspend as suspendLayer } from 'effect/Layer';
 import { buildEffectLayer } from '../utils/buildEffectLayer';
+import { init } from './sdk';
+
+export { init } from './sdk';
 
 /**
  * Options for the Sentry Effect client layer.
@@ -32,5 +34,5 @@ export type EffectClientLayerOptions = BrowserOptions;
  * ```
  */
 export function effectLayer(options: EffectClientLayerOptions): EffectLayer.Layer<never, never, never> {
-  return suspendLayer(() => buildEffectLayer(options, Sentry.init(options)));
+  return suspendLayer(() => buildEffectLayer(options, init(options)));
 }

packages/effect/src/client/sdk.ts

@@ -0,0 +1,20 @@
+import type { BrowserOptions } from '@sentry/browser';
+import { init as initBrowser } from '@sentry/browser';
+import type { Client } from '@sentry/core';
+import { applySdkMetadata } from '@sentry/core';
+
+/**
+ * Initializes the Sentry Effect SDK for browser clients.
+ *
+ * @param options - Configuration options for the SDK
+ * @returns The initialized Sentry client, or undefined if initialization failed
+ */
+export function init(options: BrowserOptions): Client | undefined {
+  const opts = {
+    ...options,
+  };
+
+  applySdkMetadata(opts, 'effect', ['effect', 'browser']);
+
+  return initBrowser(opts);
+}

packages/effect/src/index.client.ts

@@ -1,4 +1,7 @@
+// import/export got a false positive, and affects most of our index barrel files
+// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
+/* eslint-disable import/export */
 export * from '@sentry/browser';
 
-export { effectLayer } from './client/index';
+export { effectLayer, init } from './client/index';
 export type { EffectClientLayerOptions } from './client/index';

packages/effect/src/index.server.ts

@@ -1,4 +1,4 @@
 export * from '@sentry/node-core/light';
 
-export { effectLayer } from './server/index';
+export { effectLayer, init } from './server/index';
 export type { EffectServerLayerOptions } from './server/index';

packages/effect/src/server/index.ts

@@ -1,7 +1,9 @@
-import type { NodeOptions } from '@sentry/node-core';
-import * as Sentry from '@sentry/node-core/light';
+import type { NodeOptions } from '@sentry/node-core/light';
 import type * as EffectLayer from 'effect/Layer';
 import { buildEffectLayer } from '../utils/buildEffectLayer';
+import { init } from './sdk';
+
+export { init } from './sdk';
 
 /**
  * Options for the Sentry Effect server layer.
@@ -33,5 +35,5 @@ export type EffectServerLayerOptions = NodeOptions;
  * ```
  */
 export function effectLayer(options: EffectServerLayerOptions): EffectLayer.Layer<never, never, never> {
-  return buildEffectLayer(options, Sentry.init(options));
+  return buildEffectLayer(options, init(options));
 }

packages/effect/src/server/sdk.ts

@@ -0,0 +1,20 @@
+import type { Client } from '@sentry/core';
+import { applySdkMetadata } from '@sentry/core';
+import type { NodeOptions } from '@sentry/node-core/light';
+import { init as initNode } from '@sentry/node-core/light';
+
+/**
+ * Initializes the Sentry Effect SDK for Node.js servers.
+ *
+ * @param options - Configuration options for the SDK
+ * @returns The initialized Sentry client, or undefined if initialization failed
+ */
+export function init(options: NodeOptions): Client | undefined {
+  const opts = {
+    ...options,
+  };
+
+  applySdkMetadata(opts, 'effect', ['effect', 'node-light']);
+
+  return initNode(opts);
+}

packages/effect/test/layer.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from '@effect/vitest';
-import { getCurrentScope, getIsolationScope } from '@sentry/core';
+import { getClient, getCurrentScope, getIsolationScope, SDK_VERSION } from '@sentry/core';
 import { Effect, Layer } from 'effect';
 import { afterEach, beforeEach, vi } from 'vitest';
 import * as sentryClient from '../src/index.client';
@@ -15,9 +15,9 @@ function getMockTransport() {
 }
 
 describe.each([
-  ['client', sentryClient.effectLayer],
-  ['server', sentryServer.effectLayer],
-])('effectLayer ($name)', (name, effectLayer) => {
+  [{ subSdkName: 'browser', effectLayer: sentryClient.effectLayer }],
+  [{ subSdkName: 'node-light', effectLayer: sentryServer.effectLayer }],
+])('effectLayer ($subSdkName)', ({ subSdkName, effectLayer }) => {
   beforeEach(() => {
     getCurrentScope().clear();
     getIsolationScope().clear();
@@ -37,6 +37,25 @@ describe.each([
     expect(Layer.isLayer(layer)).toBe(true);
   });
 
+  it.effect('applies SDK metadata', () =>
+    Effect.gen(function* () {
+      yield* Effect.void;
+
+      const client = getClient();
+      const metadata = client?.getOptions()._metadata?.sdk;
+
+      expect(metadata?.name).toBe('sentry.javascript.effect');
+      expect(metadata?.packages).toEqual([{ name: 'npm:@sentry/effect', version: SDK_VERSION }, { name: `npm:@sentry/${subSdkName}`, version: SDK_VERSION }]);
+    }).pipe(
+      Effect.provide(
+        effectLayer({
+          dsn: TEST_DSN,
+          transport: getMockTransport(),
+        }),
+      ),
+    ),
+  );
+
   it.effect('layer can be provided to an Effect program', () =>
     Effect.gen(function* () {
       const result = yield* Effect.succeed('test-result');