@elysiumjs/plugin-sentry 0.1.0

package/README.md

@@ -0,0 +1,36 @@
+# @elysiumjs/plugin-sentry
+
+Enables Sentry error reporting for Elysium applications.
+
+## Installation
+
+```bash
+bun add @elysiumjs/plugin-sentry
+```
+
+## Usage
+
+```ts
+import { Application } from '@elysiumjs/core';
+import { plugin as sentry } from '@elysiumjs/plugin-sentry';
+
+@Application.register({
+	// Your other app options
+	plugins: [
+		sentry({
+			serverName: 'my-app',
+			dsn: 'https://<key>@sentry.io/<project>'
+		})
+		// Your other plugins
+	]
+})
+class MyApp extends Application {}
+```
+
+## Configuration
+
+This plugin forwards all options to the Sentry initialization method. You can find the full list of options [here](https://docs.sentry.io/platforms/javascript/guides/bun/configuration/options/).
+
+## License
+
+This project is licensed under the terms of the [Apache License 2.0](LICENSE).

package/index.ts

@@ -0,0 +1,71 @@
+import type { Application, ElysiumPlugin } from '@elysiumjs/core';
+
+import { opentelemetry } from '@elysiajs/opentelemetry';
+import { Env } from '@elysiumjs/core';
+import * as Sentry from '@sentry/bun';
+import { Elysia } from 'elysia';
+
+/**
+ * Elysium plugin for Sentry integration.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param options Plugin options.
+ */
+export const plugin = (options?: Sentry.BunOptions): ElysiumPlugin => {
+	return async (_app: Application) => {
+		const dsn = options?.dsn ?? Env.get('SENTRY_DSN');
+		if (!dsn) {
+			throw new Error('Must provide a DSN');
+		}
+
+		const environment = options?.environment ?? Env.get('SENTRY_ENVIRONMENT');
+
+		Sentry.init({
+			dsn,
+			environment,
+			tracesSampleRate: 1.0,
+			integrations: [
+				Sentry.bunServerIntegration(),
+				Sentry.onUnhandledRejectionIntegration({
+					mode: 'warn'
+				}),
+				Sentry.onUncaughtExceptionIntegration()
+			],
+			...options
+		});
+
+		return (
+			new Elysia({
+				name: '@elysiumjs/plugin-sentry'
+			})
+				.decorate('Sentry', Sentry)
+				.use(
+					opentelemetry({
+						serviceName: options?.serverName
+					})
+				)
+				// Capture exceptions
+				.onError({ as: 'global' }, ({ error, Sentry }) => {
+					Sentry.captureException(error);
+				})
+				// Need this to inject attributes into the span
+				// https://github.com/elysiajs/opentelemetry/issues/40
+				.onAfterResponse(
+					{ as: 'global' },
+					// @ts-expect-error Unused parameters
+					function injectAttributes({
+						body,
+						cookie,
+						params,
+						request,
+						response,
+						route,
+						server,
+						store,
+						headers,
+						path,
+						query
+					}) {}
+				)
+		);
+	};
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@elysiumjs/plugin-sentry",
+	"version": "0.1.0",
+	"license": "Apache-2.0",
+	"description": "The CLI tool for the Elysium framework.",
+	"private": false,
+	"author": {
+		"name": "Axel Nana",
+		"email": "axel.nana@workbud.com"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Workerly/elysium"
+	},
+	"homepage": "https://github.com/Workerly/elysium",
+	"scripts": {
+		"format": "prettier --write \"./src/**/*.ts\""
+	},
+	"keywords": [
+		"elysium",
+		"framework",
+		"web",
+		"api",
+		"typescript",
+		"sentry",
+		"error",
+		"reporting"
+	],
+	"type": "module",
+	"module": "index.ts",
+	"devDependencies": {
+		"@ianvs/prettier-plugin-sort-imports": "^4.4.1",
+		"@types/bun": "latest"
+	},
+	"peerDependencies": {
+		"@elysiumjs/core": "latest",
+		"typescript": "^5.8.3"
+	},
+	"dependencies": {
+		"@elysiajs/opentelemetry": "^1.2.0",
+		"@sentry/bun": "^9.14.0"
+	}
+}