@benhepburn/adonis-sentry 1.0.4 → 2.0.0

package/README.md

@@ -1,71 +1,90 @@
-# AdonisJS Sentry
+# Sentry for AdonisJS
 
-## Install
+Report exceptions and capture performance traces in Sentry from an AdonisJS application. The package configures the Sentry Node.js SDK and exposes it as an AdonisJS container service.
+
+## Compatibility
 
-Install from npm:
+| AdonisJS | Node.js                                | Assembler for `ace configure` |
+| -------- | -------------------------------------- | ----------------------------- |
+| v7       | 24 or later                            | v8                            |
+| v6       | 20.19+ (20.x), 22.12+ (22.x), or 23.2+ | v7                            |
+
+Both AdonisJS versions use the Sentry Node.js SDK v11. The service import and provider registration are the same on both.
+
+## Install
 
 ```sh
 npm install @benhepburn/adonis-sentry
+node ace configure @benhepburn/adonis-sentry
 ```
 
-or
+The configure command creates `config/sentry.ts`, adds the Sentry environment variables and their validation rules, and registers `@benhepburn/adonis-sentry/sentry_provider` in `adonisrc.ts`. Run it with your application's matching Assembler version installed.
 
-```sh
-pnpm install @benhepburn/adonis-sentry
-```
+## Configure Sentry
 
-or
+Copy the DSN from your Sentry project's Client Keys settings and set these variables in your application's environment.
 
-```sh
-yarn add @benhepburn/adonis-sentry
+```dotenv
+SENTRY_DSN=https://public-key@o0.ingest.sentry.io/0
+SENTRY_TRACES_SAMPLE_RATE=0.1
 ```
 
-Then, configure the package for Adonis:
+An empty DSN disables delivery. The trace sample rate is a number from `0` to `1` and controls performance tracing. The generated config defaults to `1.0`. Set the rate to `0` to disable trace sampling while continuing to report errors.
 
-```sh
-node ace configure @benhepburn/adonis-sentry
-```
+Edit `config/sentry.ts` to pass other Sentry Node SDK options through `defineConfig`, such as `environment`, `release`, or `beforeSend`.
 
-## Configuration
+### Upgrade from Sentry SDK v7
 
-Enter the Sentry DSN and Traces sample rate in your .env file:
+The generated DSN and trace sampling settings work with SDK v11. Review any custom options in `config/sentry.ts` and any SDK methods called through `/service`. For example, replace `startTransaction` with `startSpan`, and use `dataCollection` to configure SDK data collection. SDK v11 collects more data by default, including HTTP bodies, so review your data collection settings when upgrading. [Sentry SDK migration guide](https://github.com/getsentry/sentry-javascript/blob/11.12.0/MIGRATION.md)
 
-```dotenv
-SENTRY_DSN=https://<...>.sentry.io/<...>
-SENTRY_TRACES_SAMPLE_RATE=1.0 # Set this to a lower value in production
-```
+### Enable CPU profiling
 
-To enable enhanced event data, you must enable useAsyncLocalStorage in config/app.ts 
-so the current request can be fetched ([see caveats here](https://docs.adonisjs.com/guides/async-local-storage#caveats)):
+Install the profiler in your AdonisJS app. Keep it on the same exact version as the SDK resolved by the wrapper. For SDK 11.12.0, install this pair in the app.
 
-```ts
-useAsyncLocalStorage: true,
+```sh
+npm install --save-exact @sentry/node@11.12.0 @sentry/profiling-node@11.12.0
 ```
 
-## Usage
-
-Import the service to use it:
+Add the integration and profiling options to your existing `config/sentry.ts`.
 
 ```ts
-import sentry from "@benhepburn/adonis-sentry/service"
+import env from '#start/env'
+import { defineConfig } from '@benhepburn/adonis-sentry'
+import { nodeProfilingIntegration } from '@sentry/profiling-node'
+
+export default defineConfig({
+  dsn: env.get('SENTRY_DSN'),
+  tracesSampleRate: env.get('SENTRY_TRACES_SAMPLE_RATE', 1.0),
+  integrations: [nodeProfilingIntegration()],
+  profileSessionSampleRate: 0.1,
+  profileLifecycle: 'trace',
+})
 ```
 
-To capture all exceptions, add the capture line to app/exceptions/handler.ts inside the report function:
+This samples 10% of profiling sessions and profiles while a sampled root span is active. Keep trace sampling enabled for this lifecycle. [Sentry profiling documentation](https://docs.sentry.io/platforms/javascript/guides/node/profiling/)
 
-```ts
-async report(error: unknown, ctx: HttpContext) {
-  sentry.captureException(error); // Add this line
-  ...
-  return super.report(error, ctx);
-}
-```
+## Report HTTP exceptions
 
-Exceptions can be captured manually as well:
+Add the Sentry import and `report` method to your existing handler in `app/exceptions/handler.ts`.
 
 ```ts
-try {
-  ...
-} catch (error: unknown) {
-  sentry.captureException(error);
+import { ExceptionHandler, type HttpContext } from '@adonisjs/core/http'
+import sentry from '@benhepburn/adonis-sentry/service'
+
+export default class HttpExceptionHandler extends ExceptionHandler {
+  async report(error: unknown, ctx: HttpContext) {
+    sentry.captureException(error)
+    return super.report(error, ctx)
+  }
 }
 ```
+
+This sends every exception that reaches the handler’s `report` method to Sentry and keeps AdonisJS’s normal reporting. For caught errors in controllers, jobs, or commands, import the same service and call `sentry.captureException(error)` from your catch block.
+
+### Include HTTP request context
+
+To let Sentry events pick up the current request, set `useAsyncLocalStorage: true` inside the existing `http` configuration in `config/app.ts`. The package attaches the request method and URL, the response status at capture time, and the authenticated user when available. Use `beforeSend` in `config/sentry.ts` to redact query parameters or user fields before sending events. [AdonisJS HTTP context documentation](https://docs.adonisjs.com/guides/basics/http-context#using-async-local-storage)
+
+## License
+
+[MIT](LICENSE.md)

package/build/configure.d.ts

@@ -1,2 +1,2 @@
-import ConfigureCommand from '@adonisjs/core/commands/configure';
-export declare function configure(_command: ConfigureCommand): Promise<void>;
+import type ConfigureCommand from '@adonisjs/core/commands/configure';
+export declare function configure(command: ConfigureCommand): Promise<void>;

package/build/configure.js

@@ -12,8 +12,8 @@
 |
 */
 import { stubsRoot } from './stubs/main.js';
-export async function configure(_command) {
-    const codemods = await _command.createCodemods();
+export async function configure(command) {
+    const codemods = await command.createCodemods();
     // Create config file
     await codemods.makeUsingStub(stubsRoot, 'config/sentry.stub', {});
     // Add env validations

package/build/services/main.d.ts

@@ -1,3 +1,3 @@
-import * as Sentry from '@sentry/node';
+import type * as Sentry from '@sentry/node';
 declare let sentry: typeof Sentry;
 export { sentry as default };

package/build/src/adonis_event_processor.d.ts

@@ -1,2 +1,2 @@
-import { EventProcessor } from '@sentry/types/types/eventprocessor.js';
-export declare const adonisEventProcessor: EventProcessor;
+import type { Event } from '@sentry/node';
+export declare const adonisEventProcessor: (event: Event) => Event;

package/build/src/adonis_event_processor.js

@@ -1,5 +1,5 @@
 import { HttpContext } from '@adonisjs/core/http';
-export const adonisEventProcessor = (event, _hint) => {
+export const adonisEventProcessor = (event) => {
     const ctx = HttpContext.get();
     if (!ctx)
         return event;
@@ -15,7 +15,7 @@ export const adonisEventProcessor = (event, _hint) => {
         status_code: ctx.response.getStatus(),
     };
     // Add user
-    // @ts-ignore
-    event.user = ctx.auth?.user || null;
+    const { auth } = ctx;
+    event.user = auth?.user;
     return event;
 };

package/build/src/define_config.d.ts

@@ -1,2 +1,2 @@
-import { NodeOptions } from '@sentry/node';
+import type { NodeOptions } from '@sentry/node';
 export declare function defineConfig(config: NodeOptions): NodeOptions;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@benhepburn/adonis-sentry",
-  "description": "A Sentry integration for AdonisJS v6",
-  "version": "1.0.4",
+  "description": "Sentry error monitoring and tracing for AdonisJS v6 and v7",
+  "version": "2.0.0",
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20.19.0 <22.0.0 || >=22.12.0 <23.0.0 || >=23.2.0"
   },
   "type": "module",
   "main": "build/index.js",
@@ -21,9 +21,9 @@
     "clean": "del-cli build",
     "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
     "typecheck": "tsc --noEmit",
-    "lint": "eslint . --ext=.ts",
+    "lint": "eslint .",
     "format": "prettier --write .",
-    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
@@ -41,31 +41,34 @@
     "v6",
     "adonis 6",
     "provider",
-    "service"
+    "service",
+    "v7",
+    "adonis 7"
   ],
   "author": "benhepburn",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/assembler": "^7.0.0",
-    "@adonisjs/core": "^6.2.0",
-    "@adonisjs/eslint-config": "^1.2.1",
+    "@adonisjs/assembler": "^8.0.0",
+    "@adonisjs/core": "^7.0.0",
+    "@adonisjs/eslint-config": "^3.0.0",
     "@adonisjs/prettier-config": "^1.2.1",
-    "@adonisjs/tsconfig": "^1.2.1",
-    "@japa/assert": "^2.1.0",
-    "@japa/runner": "^3.1.1",
-    "@swc/core": "^1.3.102",
-    "@types/node": "^20.10.7",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@japa/assert": "^4.2.0",
+    "@japa/runner": "^5.3.0",
+    "@poppinss/ts-exec": "^1.4.4",
+    "@types/node": "^24.0.0",
     "c8": "^9.0.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
-    "eslint": "^8.38.0",
+    "eslint": "^10.0.0",
     "np": "^9.2.0",
     "prettier": "^3.1.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "~5.9.3",
+    "youch": "^4.1.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.2.0"
+    "@adonisjs/core": "^6.2.0 || ^7.0.0",
+    "@adonisjs/assembler": "^7.0.0 || ^8.0.0"
   },
   "publishConfig": {
     "access": "public",
@@ -86,12 +89,13 @@
       "tests/**"
     ]
   },
-  "eslintConfig": {
-    "extends": "@adonisjs/eslint-config/package"
-  },
   "prettier": "@adonisjs/prettier-config",
   "dependencies": {
-    "@sentry/node": "^7.109.0",
-    "@sentry/profiling-node": "^7.109.0"
+    "@sentry/node": "^11.12.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/assembler": {
+      "optional": true
+    }
   }
 }