@bentocache/otel 0.1.2 → 0.2.0

package/README.md

@@ -8,6 +8,8 @@ Official OpenTelemetry instrumentation for Bentocache.
 pnpm add @bentocache/otel
 ```
 
+Requires OpenTelemetry JS SDK 3 (`@opentelemetry/api` 1.10) and Node.js 22.15.0 or newer. For OpenTelemetry SDK 2, use `@bentocache/otel@0.1.x`.
+
 ## Usage
 
 ```ts

package/build/index.d.ts

@@ -1,5 +1,5 @@
-import { Span } from '@opentelemetry/api';
 import { CacheOperationMessage } from 'bentocache';
+import { Span } from '@opentelemetry/api';
 import { TracingChannelSubscribers } from 'node:diagnostics_channel';
 import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
 import { BentoCacheInstrumentationConfig, BentoCacheModuleExports } from './src/types.js';

package/build/index.js

@@ -5,6 +5,105 @@ import {
   InstrumentationBase,
   InstrumentationNodeModuleDefinition
 } from "@opentelemetry/instrumentation";
+
+// package.json
+var package_default = {
+  name: "@bentocache/otel",
+  version: "0.2.0",
+  description: "OpenTelemetry instrumentation for Bentocache",
+  keywords: [
+    "bentocache",
+    "instrumentation",
+    "opentelemetry",
+    "otel",
+    "tracing"
+  ],
+  license: "MIT",
+  author: "Julien Ripouteau <julien@ripouteau.com>",
+  repository: {
+    type: "git",
+    url: "git+https://github.com/Julien-R44/bentocache.git",
+    directory: "packages/otel"
+  },
+  files: [
+    "build"
+  ],
+  type: "module",
+  main: "build/index.js",
+  exports: {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  },
+  publishConfig: {
+    access: "public",
+    tag: "latest"
+  },
+  scripts: {
+    test: "c8 pnpm quick:test",
+    "quick:test": "cross-env NODE_NO_WARNINGS=1 node --enable-source-maps --import=tsx bin/test.ts",
+    build: "tsup-node",
+    typecheck: "tsc --noEmit",
+    lint: "oxlint",
+    release: "pnpm build && pnpm release-it",
+    prepublishOnly: "pnpm build",
+    checks: "pnpm lint && pnpm typecheck"
+  },
+  dependencies: {
+    "@opentelemetry/core": "^3.1.1",
+    "@opentelemetry/instrumentation": "^0.301.1"
+  },
+  devDependencies: {
+    "@julr/utils": "^1.9.0",
+    "@opentelemetry/api": "^1.10.0",
+    "@opentelemetry/context-async-hooks": "^3.1.1",
+    "@opentelemetry/sdk-trace": "^3.1.1",
+    bentocache: "workspace:*"
+  },
+  peerDependencies: {
+    "@opentelemetry/api": "^1.10.0",
+    bentocache: "^1.6.0"
+  },
+  c8: {
+    exclude: [
+      "bin",
+      "tests/**",
+      "test_helpers/**",
+      "factories/**"
+    ],
+    reporter: [
+      "text",
+      "html"
+    ]
+  },
+  engines: {
+    node: ">=22.15.0"
+  },
+  "release-it": {
+    git: {
+      commitMessage: "chore(release): @bentocache/otel@${version}",
+      tagAnnotation: "release ${version}",
+      tagName: "@bentocache/otel@${version}"
+    },
+    github: {
+      release: true,
+      releaseName: "@bentocache/otel@${version}",
+      web: true
+    }
+  },
+  tsup: {
+    entry: [
+      "./index.ts",
+      "./src/types.ts"
+    ],
+    outDir: "./build",
+    clean: true,
+    format: "esm",
+    dts: true,
+    target: "esnext"
+  }
+};
+
+// src/instrumentation.ts
 var DEFAULT_CONFIG = {
   requireParentSpan: true,
   includeKeys: false,
@@ -16,10 +115,11 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
   spans = /* @__PURE__ */ new WeakMap();
   handlers;
   /**
-   * Tracks active getOrSet contexts so child operations (factory, set)
-   * can be parented to the getOrSet span. Keyed by `store:key`.
+   * Context tokens attached on `start` and disposed on the synchronous `end`
+   * event, so the operation span is the active context for everything the
+   * operation runs: nested cache operations and the user factory.
    */
-  #activeContexts = /* @__PURE__ */ new Map();
+  #contextTokens = /* @__PURE__ */ new WeakMap();
   #cacheOperation;
   #originalBentoCache;
   /**
@@ -42,20 +142,22 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
     }
     if (moduleExports.BentoCache !== this.#originalBentoCache) return;
     const original = this.#originalBentoCache;
-    const instrumentation = this;
+    const patchConfig = this.#patchConfig.bind(this);
     const BentoCachePatched = class BentoCachePatched extends original {
       /**
        * Wraps user config before delegating to the original BentoCache constructor.
        */
       constructor(config) {
-        super(instrumentation.#patchConfig(config));
+        super(patchConfig(config));
       }
     };
     Object.setPrototypeOf(BentoCachePatched, original);
     try {
       moduleExports.BentoCache = BentoCachePatched;
     } catch {
-      return;
+      this._diag.warn(
+        "Cannot patch the BentoCache constructor because the module exports are read-only (ESM namespace). suppressInternalOperations has no effect on caches created from these exports."
+      );
     }
   }
   /**
@@ -93,8 +195,7 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
     this.subscribed = true;
     this.handlers = {
       start: (message) => this.#handleStart(message),
-      end: () => {
-      },
+      end: (message) => this.#handleEnd(message),
       asyncStart: () => {
       },
       asyncEnd: (message) => this.#handleAsyncEnd(message),
@@ -111,17 +212,15 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
     this.subscribed = false;
     this.handlers = void 0;
     this.spans = /* @__PURE__ */ new WeakMap();
-    this.#activeContexts.clear();
   }
   /**
-   * Starts a span for each cache operation event and tracks getOrSet parent contexts.
+   * Starts a span for each cache operation and makes it the active context
+   * while the operation runs, so nested operations and the factory are parented to it.
    */
   #handleStart(message) {
     const config = this.getConfig();
-    const contextKey = `${message.store}:${message.key}`;
-    const parentContext = this.#activeContexts.get(contextKey) ?? context.active();
-    const parentSpan = trace.getSpan(parentContext);
-    if (config.requireParentSpan && !parentSpan) return;
+    const parentContext = context.active();
+    if (config.requireParentSpan && !trace.getSpan(parentContext)) return;
     const spanName = this.#getSpanName(message);
     const span = this.tracer.startSpan(
       spanName,
@@ -132,9 +231,15 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
       parentContext
     );
     this.spans.set(message, span);
-    if (message.operation === "getOrSet") {
-      this.#activeContexts.set(contextKey, trace.setSpan(parentContext, span));
-    }
+    this.#contextTokens.set(message, context.attach(trace.setSpan(parentContext, span)));
+  }
+  /**
+   * Restores the caller context once the operation has returned its promise.
+   * Async continuations created by the operation keep the attached context.
+   */
+  #handleEnd(message) {
+    this.#contextTokens.get(message)?.dispose();
+    this.#contextTokens.delete(message);
   }
   /**
    * Finalizes successful async spans and records result attributes.
@@ -147,9 +252,6 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
     if (message.graced !== void 0) span.setAttribute("cache.graced", message.graced);
     span.end();
     this.spans.delete(message);
-    if (message.operation === "getOrSet") {
-      this.#activeContexts.delete(`${message.store}:${message.key}`);
-    }
   }
   /**
    * Finalizes failed spans and records exception details when available.
@@ -163,9 +265,6 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
     }
     span.end();
     this.spans.delete(message);
-    if (message.operation === "getOrSet") {
-      this.#activeContexts.delete(`${message.store}:${message.key}`);
-    }
   }
   /**
    * Builds the final span name using custom naming or the configured prefix.
@@ -201,7 +300,7 @@ var BentoCacheInstrumentation = class extends InstrumentationBase {
    * Creates a new instrumentation instance with default and user config merged.
    */
   constructor(config = {}) {
-    super("@bentocache/otel", "0.1.0", { ...DEFAULT_CONFIG, ...config });
+    super(package_default.name, package_default.version, { ...DEFAULT_CONFIG, ...config });
   }
   /**
    * Applies runtime config updates while preserving default values.

package/package.json

@@ -1,64 +1,63 @@
 {
   "name": "@bentocache/otel",
-  "type": "module",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "OpenTelemetry instrumentation for Bentocache",
-  "author": "Julien Ripouteau <julien@ripouteau.com>",
-  "license": "MIT",
   "keywords": [
     "bentocache",
+    "instrumentation",
     "opentelemetry",
     "otel",
-    "instrumentation",
     "tracing"
   ],
-  "exports": {
-    ".": "./build/index.js",
-    "./types": "./build/src/types.js"
+  "license": "MIT",
+  "author": "Julien Ripouteau <julien@ripouteau.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Julien-R44/bentocache.git",
+    "directory": "packages/otel"
   },
-  "main": "build/index.js",
   "files": [
     "build"
   ],
-  "peerDependencies": {
-    "bentocache": "^1.6.0"
+  "type": "module",
+  "main": "build/index.js",
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
   },
   "dependencies": {
-    "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/core": "^2.5.0",
-    "@opentelemetry/instrumentation": "^0.211.0"
+    "@opentelemetry/core": "^3.1.1",
+    "@opentelemetry/instrumentation": "^0.301.1"
   },
   "devDependencies": {
     "@julr/utils": "^1.9.0",
-    "@opentelemetry/sdk-trace-base": "^2.5.0",
+    "@opentelemetry/api": "^1.10.0",
+    "@opentelemetry/context-async-hooks": "^3.1.1",
+    "@opentelemetry/sdk-trace": "^3.1.1",
     "bentocache": "1.6.1"
   },
-  "tsup": {
-    "entry": [
-      "./index.ts",
-      "./src/types.ts"
-    ],
-    "outDir": "./build",
-    "clean": true,
-    "format": "esm",
-    "dts": true,
-    "target": "esnext"
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.10.0",
+    "bentocache": "^1.6.0"
   },
   "c8": {
-    "reporter": [
-      "text",
-      "html"
-    ],
     "exclude": [
       "bin",
       "tests/**",
       "test_helpers/**",
       "factories/**"
+    ],
+    "reporter": [
+      "text",
+      "html"
     ]
   },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
+  "engines": {
+    "node": ">=22.15.0"
   },
   "release-it": {
     "git": {
@@ -72,12 +71,23 @@
       "web": true
     }
   },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/types.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
+  },
   "scripts": {
     "test": "c8 pnpm quick:test",
-    "quick:test": "cross-env NODE_NO_WARNINGS=1 node --enable-source-maps --loader=ts-node/esm bin/test.ts",
+    "quick:test": "cross-env NODE_NO_WARNINGS=1 node --enable-source-maps --import=tsx bin/test.ts",
     "build": "tsup-node",
     "typecheck": "tsc --noEmit",
-    "lint": "eslint .",
+    "lint": "oxlint",
     "release": "pnpm build && pnpm release-it",
     "checks": "pnpm lint && pnpm typecheck"
   }