@eienjs/adonisjs-sentry 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License
+
+Copyright (c) 2025 - 2026 | EienJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @eienjs/adonisjs-sentry
+
+[![Source Code][badge-source]][source]
+[![Npm Node Version Support][badge-node-version]][node-version]
+[![Latest Version][badge-release]][release]
+[![Software License][badge-license]][license]
+[![Build Status][badge-build]][build]
+[![Total Downloads][badge-downloads]][downloads]
+
+> Sentry service provider for AdonisJS.
+
+## Introduction
+
+A simple wrapper around the Sentry SDK to make it easier to use with AdonisJS.
+
+## Documentation
+
+The documentation is available on [EienJS](https://eienjs.com/packages/adonisjs-sentry/getting-started/).
+
+## Contributing
+
+Contributions are welcome. Please read [CONTRIBUTING][] for more details and remember to check the [CHANGELOG][] file.
+
+## Copyright and License
+
+The `@eienjs/adonisjs-sentry` library is licensed for use under the MIT License (MIT). Please see [LICENSE][] for more information.
+
+[contributing]: https://github.com/eienjs/.github/blob/main/docs/CONTRIBUTING.md
+[changelog]: https://github.com/eienjs/adonisjs-sentry/blob/main/CHANGELOG.md
+[source]: https://github.com/eienjs/adonisjs-sentry
+[node-version]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
+[release]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
+[license]: https://github.com/eienjs/adonisjs-sentry/blob/main/LICENSE.md
+[build]: https://github.com/eienjs/adonisjs-sentry/actions/workflows/build.yml?query=branch:main
+[downloads]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
+[badge-source]: https://img.shields.io/badge/source-eienjs/adonisjs--sentry-blue.svg?logo=github
+[badge-node-version]: https://img.shields.io/node/v/@eienjs/adonisjs-sentry.svg?logo=nodedotjs
+[badge-release]: https://img.shields.io/npm/v/@eienjs/adonisjs-sentry.svg?logo=npm
+[badge-license]: https://img.shields.io/github/license/eienjs/adonisjs-sentry?logo=open-source-initiative
+[badge-build]: https://img.shields.io/github/actions/workflow/status/eienjs/adonisjs-sentry/build.yml?branch=main
+[badge-downloads]: https://img.shields.io/npm/dm/@eienjs/adonisjs-sentry.svg?logo=npm

package/build/commands/commands.json

@@ -0,0 +1 @@
+{"commands":[{"commandName":"sentry:verify","description":"Generate a test event and send it to Sentry","help":"","namespace":"sentry","aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":false},"filePath":"verify_sentry_integration.mjs"}],"version":1}

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

package/build/commands/main.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises'
+
+/**
+ * In-memory cache of commands after they have been loaded
+ */
+let commandsMetaData
+
+/**
+ * Reads the commands from the "./commands.json" file. Since, the commands.json
+ * file is generated automatically, we do not have to validate its contents
+ */
+export async function getMetaData() {
+  if (commandsMetaData) {
+    return commandsMetaData
+  }
+
+  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
+  commandsMetaData = JSON.parse(commandsIndex).commands
+
+  return commandsMetaData
+}
+
+/**
+ * Imports the command by lookingup its path from the commands
+ * metadata
+ */
+export async function getCommand(metaData) {
+  const commands = await getMetaData()
+  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
+  if (!command) {
+    return null
+  }
+
+  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
+  return commandConstructor
+}

package/build/commands/verify_sentry_integration.d.mts

@@ -0,0 +1,12 @@
+import { BaseCommand } from "@adonisjs/core/ace";
+import { CommandOptions } from "@adonisjs/core/types/ace";
+
+//#region commands/verify_sentry_integration.d.ts
+declare class VerifySentryIntegration extends BaseCommand {
+  static readonly commandName = "sentry:verify";
+  static readonly description = "Generate a test event and send it to Sentry";
+  static options: CommandOptions;
+  run(): Promise<void>;
+}
+//#endregion
+export { VerifySentryIntegration as default };

package/build/commands/verify_sentry_integration.mjs

@@ -0,0 +1,29 @@
+import { BaseCommand } from "@adonisjs/core/ace";
+
+//#region commands/verify_sentry_integration.ts
+var VerifySentryIntegration = class extends BaseCommand {
+	static commandName = "sentry:verify";
+	static description = "Generate a test event and send it to Sentry";
+	static options = {
+		startApp: true,
+		staysAlive: false
+	};
+	async run() {
+		const sentryConfig = (await this.app.container.make("config")).get("sentry");
+		if (!sentryConfig.enabled) {
+			this.logger.info("Sentry is disabled");
+			return;
+		}
+		const { Sentry } = await import("../src/sentry.mjs");
+		if (!Sentry.isInitialized()) Sentry.init(sentryConfig);
+		try {
+			throw new Error("This is a test exception sent from the sentry adonisjs");
+		} catch (error) {
+			const eventId = Sentry.captureException(error);
+			this.logger.success(`Event sent with ID: ${eventId}`);
+		}
+	}
+};
+
+//#endregion
+export { VerifySentryIntegration as default };

package/build/configure.d.mts

@@ -0,0 +1,6 @@
+import ConfigureCommand from "@adonisjs/core/commands/configure";
+
+//#region configure.d.ts
+declare function configure(command: ConfigureCommand): Promise<void>;
+//#endregion
+export { configure };

package/build/configure.mjs

@@ -0,0 +1,23 @@
+import { stubsRoot } from "./stubs/main.mjs";
+
+//#region configure.ts
+async function configure(command) {
+	const codemods = await command.createCodemods();
+	await codemods.makeUsingStub(stubsRoot, "config.stub", {});
+	await codemods.defineEnvVariables({ SENTRY_DSN: "<your_dsn_url>" });
+	await codemods.defineEnvValidations({
+		variables: { SENTRY_DSN: "Env.schema.string()" },
+		leadingComment: "Variables for configuring @eienjs/adonisjs-sentry package"
+	});
+	await codemods.registerMiddleware("router", [{
+		path: "@eienjs/adonisjs-sentry/sentry_middleware",
+		position: "before"
+	}]);
+	await codemods.updateRcFile((rcFile) => {
+		rcFile.addCommand("@eienjs/adonisjs-sentry/commands");
+		rcFile.addProvider("@eienjs/adonisjs-sentry/sentry_provider");
+	});
+}
+
+//#endregion
+export { configure };

package/build/index.d.mts

@@ -0,0 +1,5 @@
+import { configure } from "./configure.mjs";
+import { defineConfig } from "./src/define_config.mjs";
+import { Sentry } from "./src/sentry.mjs";
+import { stubsRoot } from "./stubs/main.mjs";
+export { Sentry, configure, defineConfig, stubsRoot };

package/build/index.mjs

@@ -0,0 +1,6 @@
+import { stubsRoot } from "./stubs/main.mjs";
+import { configure } from "./configure.mjs";
+import { defineConfig } from "./src/define_config.mjs";
+import { Sentry } from "./src/sentry.mjs";
+
+export { Sentry, configure, defineConfig, stubsRoot };

package/build/sentry_middleware.d.mts

@@ -0,0 +1,9 @@
+import { HttpContext } from "@adonisjs/core/http";
+import { NextFn } from "@adonisjs/core/types/http";
+
+//#region src/middleware/sentry_middleware.d.ts
+declare class SentryMiddleware {
+  handle(ctx: HttpContext, next: NextFn): Promise<unknown>;
+}
+//#endregion
+export { SentryMiddleware as default };

package/build/sentry_middleware.mjs

@@ -0,0 +1,14 @@
+import { Sentry } from "./src/sentry.mjs";
+
+//#region src/middleware/sentry_middleware.ts
+var SentryMiddleware = class {
+	async handle(ctx, next) {
+		const activeSpan = Sentry.getActiveSpan();
+		const rootSpan = activeSpan && Sentry.getRootSpan(activeSpan);
+		if (rootSpan) Sentry.updateSpanName(rootSpan, ctx.routeKey || "unknown");
+		return next();
+	}
+};
+
+//#endregion
+export { SentryMiddleware as default };

package/build/sentry_provider.d.mts

@@ -0,0 +1,10 @@
+import { ApplicationService } from "@adonisjs/core/types";
+
+//#region providers/sentry_provider.d.ts
+declare class SentryProvider {
+  protected app: ApplicationService;
+  constructor(app: ApplicationService);
+  boot(): Promise<void>;
+}
+//#endregion
+export { SentryProvider as default };

package/build/sentry_provider.mjs

@@ -0,0 +1,16 @@
+//#region providers/sentry_provider.ts
+var SentryProvider = class {
+	constructor(app) {
+		this.app = app;
+	}
+	async boot() {
+		const config = this.app.config.get("sentry", {});
+		if (config.enabled) {
+			const { Sentry } = await import("./src/sentry.mjs");
+			Sentry.init(config);
+		}
+	}
+};
+
+//#endregion
+export { SentryProvider as default };

package/build/src/define_config.d.mts

@@ -0,0 +1,6 @@
+import { SentryConfig } from "../types.mjs";
+
+//#region src/define_config.d.ts
+declare function defineConfig(config: SentryConfig): SentryConfig;
+//#endregion
+export { defineConfig };

package/build/src/define_config.mjs

@@ -0,0 +1,10 @@
+import { RuntimeException } from "@adonisjs/core/exceptions";
+
+//#region src/define_config.ts
+function defineConfig(config) {
+	if (!config.environment) throw new RuntimeException("Missing \"environment\" property in sentry config");
+	return config;
+}
+
+//#endregion
+export { defineConfig };

package/build/src/sentry.d.mts

@@ -0,0 +1,2 @@
+import * as Sentry from "@sentry/node";
+export { Sentry };

package/build/src/sentry.mjs

@@ -0,0 +1,3 @@
+import * as Sentry from "@sentry/node";
+
+export { Sentry };

package/build/stubs/config.stub

@@ -0,0 +1,37 @@
+{{{
+  exports({ to: app.configPath('sentry.ts') })
+}}}
+import env from '#start/env'
+import app from '@adonisjs/core/services/app'
+import { defineConfig } from '@eienjs/adonisjs-sentry'
+
+const sentryConfig = defineConfig({
+  /**
+   * Enable or disable Sentry
+   */
+  enabled: app.inProduction,
+
+  /**
+   * The environment Sentry is running in
+   */
+  environment: app.nodeEnvironment,
+
+  /**
+   * The DSN of the project
+   */
+  dsn: env.get('SENTRY_DSN'),
+
+  /**
+   * Additional integrations to use with the Sentry SDK
+   * @see https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/#available-integrations
+   */
+  integrations: [],
+
+  /**
+   * The sample rate of traces to send to Sentry
+   * @see https://docs.sentry.io/platforms/javascript/guides/node/configuration/sampling
+   */
+  tracesSampleRate: 0.2,
+})
+
+export default sentryConfig

package/build/stubs/main.d.mts

@@ -0,0 +1,8 @@
+//#region stubs/main.d.ts
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+declare const stubsRoot: string;
+//#endregion
+export { stubsRoot };

package/build/stubs/main.mjs

@@ -0,0 +1,12 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+//#region stubs/main.ts
+/**
+* Path to the root directory where the stubs are stored. We use
+* this path within commands and the configure hook
+*/
+const stubsRoot = path.dirname(fileURLToPath(import.meta.url));
+
+//#endregion
+export { stubsRoot };

package/build/types.d.mts

@@ -0,0 +1,12 @@
+import { NodeOptions } from "@sentry/node";
+
+//#region src/types.d.ts
+interface SentryConfig extends NodeOptions {
+  /**
+   * Enable or disable Sentry
+   */
+  enabled: boolean;
+  dsn: string;
+}
+//#endregion
+export { SentryConfig };

package/build/types.mjs

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@eienjs/adonisjs-sentry",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "Sentry service provider for AdonisJS",
+  "author": "Fernando Isidro <luffynando@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/eienjs/adonisjs-sentry",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eienjs/adonisjs-sentry.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eienjs/adonisjs-sentry/issues"
+  },
+  "keywords": [
+    "adonis",
+    "adonisjs",
+    "adonis-framework",
+    "sentry"
+  ],
+  "exports": {
+    ".": "./build/index.mjs",
+    "./commands/verify_sentry_integration": "./build/commands/verify_sentry_integration.mjs",
+    "./sentry_middleware": "./build/sentry_middleware.mjs",
+    "./sentry_provider": "./build/sentry_provider.mjs",
+    "./types": "./build/types.mjs",
+    "./package.json": "./package.json",
+    "./commands": "./build/commands/main.js"
+  },
+  "main": "./build/index.mjs",
+  "module": "./build/index.mjs",
+  "types": "./build/index.d.mts",
+  "files": [
+    "build"
+  ],
+  "engines": {
+    "node": ">=20.19"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.19.2"
+  },
+  "dependencies": {
+    "@sentry/node": "^10.32.1"
+  },
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.19.2",
+    "@adonisjs/tsconfig": "^1.4.1",
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
+    "@eienjs/eslint-config": "^1.9.0",
+    "@japa/assert": "^4.2.0",
+    "@japa/file-system": "^3.0.0",
+    "@japa/runner": "^5.2.0",
+    "@swc/core": "^1.15.8",
+    "@types/node": "^24.10.4",
+    "auto-changelog": "^2.5.0",
+    "c8": "^10.1.3",
+    "eslint": "^9.39.2",
+    "eslint-plugin-erasable-syntax-only": "^0.4.0",
+    "husky": "^9.1.7",
+    "is-in-ci": "^2.0.0",
+    "np": "^10.2.0",
+    "ts-node-maintained": "^10.9.6",
+    "tsdown": "^0.18.4",
+    "typescript": "^5.9.3"
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "lcov"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "auto-changelog": {
+    "template": "keepachangelog",
+    "hideCredit": true
+  },
+  "np": {
+    "message": "chore(release): :tada: %s",
+    "tag": "latest",
+    "branch": "main",
+    "testScript": "test"
+  },
+  "scripts": {
+    "changelog": "auto-changelog -p && git add CHANGELOG.md",
+    "index:commands": "adonis-kit index build/commands",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
+    "test:coverage": "c8 pnpm run test",
+    "tool:code": "pnpm run lint:check && pnpm run typecheck",
+    "tool:build": "pnpm run tool:code && pnpm run test",
+    "prebuild": "pnpm run tool:code",
+    "build": "tsdown --clean --dts",
+    "postbuild": "pnpm run index:commands",
+    "release": "np",
+    "version": "pnpm run build && pnpm run changelog"
+  }
+}