@monocle.sh/adonisjs-agent 1.0.1 → 1.0.3

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024-present, Julien Ripouteau
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/dist/init.mjs

@@ -74,6 +74,19 @@ async function init(dirname) {
 		await instrumentMail(mailConfig ?? { enabled: true }, dirname);
 	}
 	/**
+	* Queue Instrumentation
+	*
+	* Automatically instruments @boringnode/queue if installed.
+	* Creates PRODUCER spans for dispatch and CONSUMER spans for execution.
+	*
+	* @see ./instrumentations/queue/instrumentation.ts for implementation details
+	*/
+	const queueConfig = config.queue;
+	if (queueConfig !== false) {
+		const { instrumentQueue } = await import("./src/instrumentations/queue/instrumentation.mjs");
+		await instrumentQueue(queueConfig ?? { enabled: true }, dirname);
+	}
+	/**
 	* Cache Instrumentation
 	*
 	* Automatically instruments @adonisjs/cache (bentocache) if installed.

package/dist/src/define_config.mjs

@@ -20,13 +20,30 @@ function getHeader(response, name) {
 	}
 }
 /**
+* Returns the raw HTTP header string from a ServerResponse.
+* After `writeHead()` is called with inline headers, `getHeader()` returns
+* undefined. Node.js stores the serialized headers in `_header` which is
+* the only reliable way to read them after they've been flushed.
+*/
+function getRawHeader(response) {
+	const raw = response._header;
+	if (typeof raw === "string") return raw;
+}
+/**
 * Detects the connection type based on response headers.
 * Returns 'sse' for Server-Sent Events, 'websocket' for WebSocket upgrades,
 * or undefined for standard HTTP connections.
+*
+* Checks both `getHeader()` and the raw `_header` string to handle cases
+* where headers are passed inline to `writeHead()` (e.g. @hono/node-server).
 */
 function detectConnectionType(response) {
 	if (getHeader(response, "content-type")?.includes("text/event-stream")) return "sse";
 	if (getHeader(response, "upgrade")?.toLowerCase() === "websocket") return "websocket";
+	const raw = getRawHeader(response);
+	if (!raw) return;
+	if (raw.includes("text/event-stream")) return "sse";
+	if (raw.toLowerCase().includes("upgrade: websocket")) return "websocket";
 }
 /**
 * Creates a response hook that detects long-running HTTP connections

package/dist/src/instrumentations/mail/instrumentation.mjs

@@ -112,23 +112,34 @@ var MailInstrumentation = class extends InstrumentationBase {
 	}
 	/**
 	* Patches Mailer.prototype methods with tracing wrappers.
+	*
+	* Note: InstrumentationBase constructor calls enable() synchronously
+	* without awaiting (it ignores the returned Promise). Then instrumentMail()
+	* also calls `await enable()`. Setting `this.patched = true` before any
+	* `await` prevents the second call from double-patching the prototype,
+	* which would create duplicate spans for every email sent.
 	*/
 	async enable() {
 		if (this.patched) return;
+		this.patched = true;
 		const appRoot = this.getConfig().appRoot;
 		const require = createRequire(appRoot ? pathToFileURL(`${appRoot}/package.json`).href : import.meta.url);
 		let mailerPath;
 		try {
 			mailerPath = require.resolve("@adonisjs/mail");
 		} catch {
+			this.patched = false;
 			return;
 		}
-		this.mailerClass = (await import(pathToFileURL(mailerPath).href)).Mailer;
-		this.originalSendCompiled = this.mailerClass.prototype.sendCompiled;
-		this.originalSendLaterCompiled = this.mailerClass.prototype.sendLaterCompiled;
-		this.mailerClass.prototype.sendCompiled = this.#createSendCompiledWrapper(this.originalSendCompiled);
-		this.mailerClass.prototype.sendLaterCompiled = this.#createSendLaterCompiledWrapper(this.originalSendLaterCompiled);
-		this.patched = true;
+		try {
+			this.mailerClass = (await import(pathToFileURL(mailerPath).href)).Mailer;
+			this.originalSendCompiled = this.mailerClass.prototype.sendCompiled;
+			this.originalSendLaterCompiled = this.mailerClass.prototype.sendLaterCompiled;
+			this.mailerClass.prototype.sendCompiled = this.#createSendCompiledWrapper(this.originalSendCompiled);
+			this.mailerClass.prototype.sendLaterCompiled = this.#createSendLaterCompiledWrapper(this.originalSendLaterCompiled);
+		} catch {
+			this.patched = false;
+		}
 	}
 	/**
 	* Restores original Mailer.prototype methods.

package/dist/src/instrumentations/queue/instrumentation.mjs

@@ -0,0 +1,42 @@
+import { createRequire } from "node:module";
+import { pathToFileURL } from "node:url";
+//#region src/instrumentations/queue/instrumentation.ts
+/**
+* Auto-instruments @boringnode/queue with OpenTelemetry spans
+* for job dispatch (PRODUCER) and execution (CONSUMER).
+*
+* Patches `QueueManager.init()` to auto-inject the OTel plugin,
+* so users don't need to configure plugins in their queue config.
+*/
+async function instrumentQueue(config, appRoot) {
+	if (config.enabled === false) return void 0;
+	const appRequire = createRequire(appRoot ? pathToFileURL(`${appRoot}/package.json`).href : import.meta.url);
+	let queueOtelPath;
+	try {
+		queueOtelPath = appRequire.resolve("@boringnode/queue/otel");
+	} catch {
+		try {
+			queueOtelPath = appRequire.resolve("@adonisjs/queue/otel");
+		} catch {
+			return;
+		}
+	}
+	const { QueueInstrumentation } = await import(pathToFileURL(queueOtelPath).href);
+	const instrumentation = new QueueInstrumentation({
+		executionSpanLinkMode: config.executionSpanLinkMode,
+		messagingSystem: config.messagingSystem
+	});
+	instrumentation.enable();
+	try {
+		const queueModule = await import(pathToFileURL(appRequire.resolve("@boringnode/queue")).href);
+		instrumentation.manuallyRegister(queueModule);
+	} catch {
+		try {
+			const queueModule = await import(pathToFileURL(appRequire.resolve("@adonisjs/queue")).href);
+			instrumentation.manuallyRegister(queueModule);
+		} catch {}
+	}
+	return instrumentation;
+}
+//#endregion
+export { instrumentQueue };

package/dist/src/types.d.mts

@@ -6,6 +6,14 @@ import { DestinationMap, OtelConfig } from "@adonisjs/otel/types";
  * Configuration for cache instrumentation
  */
 interface CacheInstrumentationConfig extends BentoCacheInstrumentationConfig {}
+/**
+ * Configuration for queue instrumentation
+ */
+interface QueueInstrumentationConfig {
+  enabled?: boolean;
+  executionSpanLinkMode?: 'link' | 'parent';
+  messagingSystem?: string;
+}
 /**
  * Configuration for mail instrumentation
  */
@@ -143,6 +151,13 @@ interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExport
    * @default { enabled: true }
    */
   cache?: false | CacheInstrumentationConfig;
+  /**
+   * Queue instrumentation configuration.
+   * Automatically instruments @boringnode/queue if installed.
+   * Set to `false` to disable.
+   * @default { enabled: true }
+   */
+  queue?: false | QueueInstrumentationConfig;
 }
 //#endregion
 export { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocle.sh/adonisjs-agent",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Monocle agent for AdonisJS - sends telemetry to Monocle cloud",
   "keywords": [
     "adonisjs",
@@ -23,69 +23,23 @@
   "type": "module",
   "types": "./dist/index.d.mts",
   "exports": {
-    ".": {
-      "dev": "./index.ts",
-      "default": "./dist/index.mjs"
-    },
-    "./decorators": {
-      "dev": "./src/decorators.ts",
-      "default": "./dist/decorators.mjs"
-    },
-    "./helpers": {
-      "dev": "./src/helpers.ts",
-      "default": "./dist/helpers.mjs"
-    },
-    "./init": {
-      "dev": "./src/init.ts",
-      "default": "./dist/init.mjs"
-    },
-    "./mcp": {
-      "dev": "./src/mcp.ts",
-      "default": "./dist/mcp.mjs"
-    },
-    "./monocle_middleware": {
-      "dev": "./middleware/monocle_middleware.ts",
-      "default": "./dist/monocle_middleware.mjs"
-    },
-    "./monocle_provider": {
-      "dev": "./providers/monocle_provider.ts",
-      "default": "./dist/monocle_provider.mjs"
-    },
-    "./types": {
-      "dev": "./types.ts",
-      "default": "./dist/types.mjs"
-    },
+    ".": "./dist/index.mjs",
+    "./decorators": "./dist/decorators.mjs",
+    "./helpers": "./dist/helpers.mjs",
+    "./init": "./dist/init.mjs",
+    "./mcp": "./dist/mcp.mjs",
+    "./monocle_middleware": "./dist/monocle_middleware.mjs",
+    "./monocle_provider": "./dist/monocle_provider.mjs",
+    "./types": "./dist/types.mjs",
     "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public",
-    "exports": {
-      ".": "./dist/index.mjs",
-      "./decorators": "./dist/decorators.mjs",
-      "./helpers": "./dist/helpers.mjs",
-      "./init": "./dist/init.mjs",
-      "./mcp": "./dist/mcp.mjs",
-      "./monocle_middleware": "./dist/monocle_middleware.mjs",
-      "./monocle_provider": "./dist/monocle_provider.mjs",
-      "./types": "./dist/types.mjs",
-      "./package.json": "./package.json"
-    },
     "tag": "latest"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown",
-    "typecheck": "tsgo --noEmit",
-    "test": "node --import @poppinss/ts-exec bin/test.ts",
-    "quick:test": "node --import @poppinss/ts-exec bin/test.ts",
-    "release": "release-it",
-    "prepublishOnly": "pnpm run build"
-  },
   "dependencies": {
     "@adonisjs/otel": "^1.2.3",
     "@bentocache/otel": "^0.1.2",
-    "@monocle.sh/instrumentation-mcp": "workspace:*",
-    "@monocle.sh/otel-utils": "workspace:*",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.6.0",
     "@opentelemetry/exporter-metrics-otlp-http": "^0.213.0",
@@ -97,17 +51,19 @@
     "@opentelemetry/semantic-conventions": "^1.40.0",
     "@sindresorhus/is": "^7.2.0",
     "error-stack-parser-es": "^1.0.5",
-    "import-in-the-middle": "^3.0.0"
+    "import-in-the-middle": "^3.0.0",
+    "@monocle.sh/instrumentation-mcp": "^1.0.0",
+    "@monocle.sh/otel-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@adonisjs/core": "catalog:",
-    "@adonisjs/tsconfig": "catalog:",
-    "@japa/assert": "catalog:",
+    "@adonisjs/core": "^7.1.1",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@japa/assert": "^4.2.0",
     "@japa/file-system": "^3.0.0",
-    "@japa/runner": "catalog:",
+    "@japa/runner": "^5.3.0",
     "@japa/snapshot": "^2.0.10",
-    "@poppinss/ts-exec": "catalog:",
-    "release-it": "catalog:"
+    "@poppinss/ts-exec": "^1.4.4",
+    "release-it": "^19.2.4"
   },
   "peerDependencies": {
     "@adonisjs/core": "^6.2.0 || ^7.0.0",
@@ -118,5 +74,12 @@
       "optional": true
     }
   },
-  "packageManager": "pnpm@10.32.1"
-}
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown",
+    "typecheck": "tsgo --noEmit",
+    "test": "node --import @poppinss/ts-exec bin/test.ts",
+    "quick:test": "node --import @poppinss/ts-exec bin/test.ts",
+    "release": "release-it"
+  }
+}