@benhepburn/adonis-sentry 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+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 NONINFRINGEMENT. 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,60 @@
+# AdonisJS Sentry
+
+## Install
+
+Install from npm:
+
+```sh
+npm install @benhepburn/adonis-sentry
+```
+
+or
+
+```sh
+pnpm install @benhepburn/adonis-sentry
+```
+
+or
+
+```sh
+yarn add @benhepburn/adonis-sentry
+```
+
+Then, configure the package for Adonis:
+
+```sh
+node ace configure @benhepburn/adonis-sentry
+```
+
+## Configuration
+
+Enter the Sentry DSN and Traces sample rate in your .env file:
+
+```dotenv
+SENTRY_DSN=https://<...>.sentry.io/<...>
+SENTRY_TRACES_SAMPLE_RATE=1.0 # Set this to a lower value in production
+```
+
+## Usage
+
+Import the service to use it:
+
+```ts
+import sentry from "@benhepburn/adonis-sentry/service"
+```
+
+To capture all exceptions, add this line to app/exceptions/handler inside the handle function:
+
+```ts
+sentry.captureException(error);
+```
+
+This can be used to capture exceptions manually as well:
+
+```ts
+try {
+  ...
+} catch (error: unknown) {
+  sentry.captureException(error);
+}
+```

package/build/configure.d.ts

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

package/build/configure.js

@@ -0,0 +1,37 @@
+/*
+|--------------------------------------------------------------------------
+| Configure hook
+|--------------------------------------------------------------------------
+|
+| The configure hook is called when someone runs "node ace configure <package>"
+| command. You are free to perform any operations inside this function to
+| configure the package.
+|
+| To make things easier, you have access to the underlying "ConfigureCommand"
+| instance and you can use codemods to modify the source files.
+|
+*/
+import { stubsRoot } from './stubs/main.js';
+export async function configure(_command) {
+    const codemods = await _command.createCodemods();
+    // Create config file
+    await codemods.makeUsingStub(stubsRoot, 'config/sentry.stub', {});
+    // Add env validations
+    try {
+        await codemods.defineEnvVariables({
+            SENTRY_DSN: '',
+            SENTRY_TRACES_SAMPLE_RATE: '1.0',
+        });
+        await codemods.defineEnvValidations({
+            leadingComment: 'Sentry environment variables',
+            variables: {
+                SENTRY_DSN: 'Env.schema.string.optional()',
+                SENTRY_TRACES_SAMPLE_RATE: 'Env.schema.number.optional()',
+            },
+        });
+    }
+    catch (error) {
+        console.error('Unable to define env variables/validations');
+        console.error(error);
+    }
+}

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';

package/build/index.js

@@ -0,0 +1,10 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint as you see fit.
+|
+*/
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';

package/build/providers/sentry_provider.d.ts

@@ -0,0 +1,31 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import * as Sentry from '@sentry/node';
+export default class SentryProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    /**
+     * Register bindings to the container
+     */
+    register(): void;
+    /**
+     * The container bindings have booted
+     */
+    boot(): Promise<void>;
+    /**
+     * The application has been booted
+     */
+    start(): Promise<void>;
+    /**
+     * The process has been started
+     */
+    ready(): Promise<void>;
+    /**
+     * Preparing to shut down the app
+     */
+    shutdown(): Promise<void>;
+}
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        sentry: typeof Sentry;
+    }
+}

package/build/providers/sentry_provider.js

@@ -0,0 +1,34 @@
+import * as Sentry from '@sentry/node';
+export default class SentryProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Register bindings to the container
+     */
+    register() {
+        this.app.container.singleton('sentry', async (resolver) => {
+            const config = await resolver.make('config');
+            const sentryConfig = config.get('sentry');
+            Sentry.init(sentryConfig);
+            return Sentry;
+        });
+    }
+    /**
+     * The container bindings have booted
+     */
+    async boot() { }
+    /**
+     * The application has been booted
+     */
+    async start() { }
+    /**
+     * The process has been started
+     */
+    async ready() { }
+    /**
+     * Preparing to shut down the app
+     */
+    async shutdown() { }
+}

package/build/services/main.d.ts

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

package/build/services/main.js

@@ -0,0 +1,9 @@
+import app from '@adonisjs/core/services/app';
+let sentry;
+/**
+ * Returns a singleton instance of Sentry from the container.
+ */
+await app.booted(async () => {
+    sentry = await app.container.make('sentry');
+});
+export { sentry as default };

package/build/src/define_config.d.ts

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

package/build/src/define_config.js

@@ -0,0 +1,3 @@
+export function defineConfig(config) {
+    return config;
+}

package/build/stubs/config/sentry.stub

@@ -0,0 +1,17 @@
+{{{
+  exports({
+    to: app.configPath('sentry.ts')
+  })
+}}}
+import env from '#start/env'
+import { defineConfig } from '@benhepburn/adonis-sentry'
+
+/**
+ * Configuration options to use Sentry in your AdonisJS application.
+ */
+const sentryConfig = defineConfig({
+  dsn: env.get('SENTRY_DSN'),
+  tracesSampleRate: env.get('SENTRY_TRACES_SAMPLE_RATE', 1.0),
+})
+
+export default sentryConfig

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

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

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@benhepburn/adonis-sentry",
+  "description": "A Sentry integration for AdonisJS v6",
+  "version": "1.0.0",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "type": "module",
+  "main": "build/index.js",
+  "files": [
+    "build",
+    "!build/bin",
+    "!build/tests"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./service": "./build/services/main.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext=.ts",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "adonis",
+    "adonisjs",
+    "sentry",
+    "sentry.io",
+    "v6",
+    "adonis 6",
+    "provider",
+    "service"
+  ],
+  "author": "benhepburn",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.0.0",
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/eslint-config": "^1.2.1",
+    "@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",
+    "c8": "^9.0.0",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.38.0",
+    "np": "^9.2.0",
+    "prettier": "^3.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "dependencies": {
+    "@sentry/node": "^7.109.0",
+    "@sentry/profiling-node": "^7.109.0"
+  }
+}