@atrim/instrument-web 0.5.1 → 0.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atrim/instrument-web",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "OpenTelemetry instrumentation for browsers with centralized YAML configuration",
   "type": "module",
   "license": "MIT",
@@ -52,7 +52,6 @@
     "effect": "^3.19.0",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/auto-instrumentations-web": "^0.54.0",
-    "@opentelemetry/context-zone": "^2.2.0",
     "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
     "@opentelemetry/instrumentation": "^0.208.0",
     "@opentelemetry/resources": "^2.2.0",
@@ -60,7 +59,16 @@
     "@opentelemetry/sdk-trace-web": "^2.2.0",
     "yaml": "^2.8.1"
   },
+  "peerDependencies": {
+    "@opentelemetry/context-zone": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/context-zone": {
+      "optional": true
+    }
+  },
   "devDependencies": {
+    "@opentelemetry/context-zone": "^2.2.0",
     "@opentelemetry/semantic-conventions": "^1.38.0",
     "@types/node": "^20.10.0",
     "@vitest/coverage-v8": "^4.0.8",

package/target/dist/index.d.ts

@@ -95,6 +95,29 @@ interface SdkInitializationOptions {
      * ```
      */
     propagateTraceContext?: 'all' | 'none' | 'same-origin' | string[];
+    /**
+     * Use Zone.js-based context manager for async context propagation
+     *
+     * By default, we use StackContextManager which is lightweight and doesn't
+     * interfere with application behavior. However, it has limited async context
+     * propagation.
+     *
+     * Enable this option if you need context to propagate across async boundaries
+     * (e.g., setTimeout, Promise chains). Note that Zone.js monkey-patches many
+     * browser APIs which can cause issues with some libraries:
+     *
+     * - Libraries that call preventDefault() on wheel/touch events may fail
+     * - Some React patterns may lose context
+     * - Bundle size increases due to Zone.js dependency
+     *
+     * @default false
+     *
+     * @example Enable Zone.js context (use with caution)
+     * ```typescript
+     * useZoneContext: true
+     * ```
+     */
+    useZoneContext?: boolean;
 }
 /**
  * Get the current SDK instance

package/target/dist/index.js

@@ -1,8 +1,7 @@
-import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
+import { WebTracerProvider, StackContextManager } from '@opentelemetry/sdk-trace-web';
 import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { getWebAutoInstrumentations } from '@opentelemetry/auto-instrumentations-web';
-import { ZoneContextManager } from '@opentelemetry/context-zone';
 import { Data, Context, Effect, Layer } from 'effect';
 import { FileSystem } from '@effect/platform/FileSystem';
 import * as HttpClient from '@effect/platform/HttpClient';
@@ -3845,7 +3844,7 @@ ZodNaN.create = (params) => {
     ...processCreateParams(params)
   });
 };
-var BRAND = Symbol("zod_brand");
+var BRAND = /* @__PURE__ */ Symbol("zod_brand");
 var ZodBranded = class extends ZodType {
   _parse(input) {
     const { ctx } = this._processInputParams(input);
@@ -4587,6 +4586,27 @@ function buildPropagateTraceUrls(options, config) {
       return [];
   }
 }
+async function createContextManager(useZoneContext) {
+  if (!useZoneContext) {
+    return new StackContextManager();
+  }
+  if (typeof window !== "undefined") {
+    window.__zone_symbol__PASSIVE_EVENTS = [];
+    console.info(
+      "[@atrim/instrument-web] Zone.js context enabled. Passive events disabled for wheel/touch events to prevent breaking preventDefault()."
+    );
+  }
+  try {
+    const { ZoneContextManager } = await import('@opentelemetry/context-zone');
+    return new ZoneContextManager();
+  } catch (error) {
+    console.warn(
+      "[@atrim/instrument-web] Failed to load ZoneContextManager. Falling back to StackContextManager. Make sure @opentelemetry/context-zone is installed if you need async context propagation.",
+      error
+    );
+    return new StackContextManager();
+  }
+}
 async function initializeSdk(options) {
   if (sdkInstance) {
     return sdkInstance;
@@ -4641,8 +4661,11 @@ async function initializeSdk(options) {
     const provider = new WebTracerProvider({
       spanProcessors
     });
+    const contextManager = await createContextManager(
+      options.useZoneContext ?? false
+    );
     provider.register({
-      contextManager: new ZoneContextManager()
+      contextManager
     });
     registerInstrumentations({
       instrumentations: [