@dash0/sdk-web 0.22.0 → 0.23.0

package/src/types/options.ts

@@ -2,7 +2,12 @@ import { AttributeValueType } from "../utils/otel";
 import { AnyValue } from "./otlp";
 import { Endpoint, Vars, PropagatorConfig } from "../vars";
 
-export type InstrumentationName = "@dash0/navigation" | "@dash0/web-vitals" | "@dash0/error" | "@dash0/fetch";
+export type InstrumentationName =
+  | "@dash0/navigation"
+  | "@dash0/web-vitals"
+  | "@dash0/error"
+  | "@dash0/fetch"
+  | "@dash0/xhr";
 
 /**
  * VCS (version control) context describing the build the SDK is running

package/src/utils/wrap.ts

@@ -1,4 +1,4 @@
-import { debug } from "./debug";
+import { debug, warn } from "./debug";
 
 const INSTRUMENTED_BY_DASH0_SYMBOL = Symbol.for("INSTRUMENTED_BY_DASH0");
 
@@ -29,6 +29,18 @@ export function wrap<ModuleType extends object, TargetNameType extends keyof Mod
     return;
   }
 
-  markAsInstrumented(original);
-  module[target] = wrapper(original);
+  try {
+    const wrapped = wrapper(original);
+    // Mark the replacement as well: a later wrap() call reads the replacement from module[target],
+    // so marking only the original would let repeated instrumentation wrap the wrapper.
+    markAsInstrumented(original);
+    if (wrapped) {
+      markAsInstrumented(wrapped);
+    }
+    module[target] = wrapped;
+  } catch (e) {
+    // Pages can lock properties via Object.defineProperty/Object.freeze -- failing to install
+    // one instrumentation must not throw out of init() and abort the remaining ones.
+    warn(`failed to instrument ${String(target)}, the page may have locked the property`, e);
+  }
 }

package/src/utils/wrap_test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, it, vi } from "vitest";
+import { wrap } from "./wrap";
+
+describe("wrap", () => {
+  it("replaces the target with the wrapper's return value", () => {
+    const original = () => "original";
+    const module = { fn: original };
+
+    wrap(module, "fn", (orig) => () => `wrapped ${orig()}`);
+
+    expect(module.fn()).toBe("wrapped original");
+  });
+
+  it("does not wrap the same target twice", () => {
+    const module = { fn: () => "original" };
+    const wrapper = vi.fn((orig: () => string) => () => `wrapped ${orig()}`);
+
+    wrap(module, "fn", wrapper);
+    wrap(module, "fn", wrapper);
+
+    expect(wrapper).toHaveBeenCalledTimes(1);
+    expect(module.fn()).toBe("wrapped original");
+  });
+
+  it("skips undefined targets", () => {
+    const module: { fn?: () => string } = {};
+    const wrapper = vi.fn();
+
+    expect(() => wrap(module, "fn", wrapper)).not.toThrow();
+    expect(wrapper).not.toHaveBeenCalled();
+  });
+
+  it("does not throw when the page locked the target property", () => {
+    const original = () => "original";
+    const module = {} as { fn: () => string };
+    Object.defineProperty(module, "fn", { value: original, writable: false, configurable: false });
+
+    expect(() => wrap(module, "fn", (orig) => () => `wrapped ${orig()}`)).not.toThrow();
+    expect(module.fn).toBe(original);
+  });
+});