@rxap/nest-sentry 10.5.5-dev.6 → 10.6.0-dev.0

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.6.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/nest-sentry@10.5.5-dev.6...@rxap/nest-sentry@10.6.0-dev.0) (2025-05-16)
+
+### Features
+
+- **sentry:** remove SentryService and streamline integration ([68d77b9](https://gitlab.com/rxap/packages/commit/68d77b9ac0b91dbab455c0472c58ade93d831851))
+- **sentry:** remove SentryService and streamline integration ([92c37bb](https://gitlab.com/rxap/packages/commit/92c37bb6fa4b75d6c9f970e42090ff6619949749))
+
 ## [10.5.5-dev.6](https://gitlab.com/rxap/packages/compare/@rxap/nest-sentry@10.5.5-dev.5...@rxap/nest-sentry@10.5.5-dev.6) (2025-04-22)
 
 ### Bug Fixes

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "10.5.5-dev.6",
+  "version": "10.6.0-dev.0",
   "name": "@rxap/nest-sentry",
   "description": "This package provides a Sentry integration for NestJS applications. It includes a logger, interceptor, and module to simplify error tracking and performance monitoring with Sentry. It offers configurable options for setting up Sentry in your NestJS application.\n",
   "license": "GPL-3.0-or-later",
@@ -14,7 +14,7 @@
     "@nestjs/config": "^3.2.2",
     "@nestjs/core": "^10.3.8",
     "@rxap/nest-logger": "^10.3.5-dev.4",
-    "@rxap/nest-utilities": "^10.4.3-dev.0",
+    "@rxap/nest-utilities": "^10.4.3-dev.1",
     "@sentry/core": "^8.18.0",
     "@sentry/nestjs": "^8.18.0",
     "@sentry/node": "^8.18.0",
@@ -84,7 +84,7 @@
       },
       {
         "package": "@rxap/nest-utilities",
-        "version": "10.4.3-dev.0"
+        "version": "10.4.3-dev.1"
       },
       {
         "package": "@rxap/utilities",
@@ -127,7 +127,7 @@
   },
   "schematics": "./generators.json",
   "type": "commonjs",
-  "gitHead": "c4852b8a1c98c7c153614bdf59c0e8c6a48bda4e",
+  "gitHead": "3fa611b2b0cd102039813fb5c696924069fb40f1",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"
 }

package/src/index.d.ts

@@ -1,4 +1,7 @@
+export * from './lib/determine-sentry-environment';
+export * from './lib/determine-sentry-release';
 export * from './lib/sentry-app-config';
+export * from './lib/sentry-init-hook';
 export * from './lib/sentry-logger.module';
 export * from './lib/sentry-options.factory';
 export * from './lib/sentry.interceptor';

package/src/index.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 // region 
+tslib_1.__exportStar(require("./lib/determine-sentry-environment"), exports);
+tslib_1.__exportStar(require("./lib/determine-sentry-release"), exports);
 tslib_1.__exportStar(require("./lib/sentry-app-config"), exports);
+tslib_1.__exportStar(require("./lib/sentry-init-hook"), exports);
 tslib_1.__exportStar(require("./lib/sentry-logger.module"), exports);
 tslib_1.__exportStar(require("./lib/sentry-options.factory"), exports);
 tslib_1.__exportStar(require("./lib/sentry.interceptor"), exports);

package/src/lib/determine-sentry-environment.d.ts

@@ -0,0 +1,10 @@
+import { Environment } from '@rxap/nest-utilities';
+/**
+ * Determines the sentry environment based on the build info object.
+ *
+ * If the tier is local return undefined.
+ * If the tier is production determine the environment based on the tag and branch name.
+ *
+ * @param environment
+ */
+export declare function DetermineSentryEnvironment(environment: Environment): string | undefined;

package/src/lib/determine-sentry-environment.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DetermineSentryEnvironment = DetermineSentryEnvironment;
+const nest_utilities_1 = require("@rxap/nest-utilities");
+/**
+ * Determines the sentry environment based on the build info object.
+ *
+ * If the tier is local return undefined.
+ * If the tier is production determine the environment based on the tag and branch name.
+ *
+ * @param environment
+ */
+function DetermineSentryEnvironment(environment) {
+    switch (environment['tier']) {
+        case 'local':
+            return undefined;
+        case 'production':
+            return (0, nest_utilities_1.DetermineProductionEnvironmentName)(environment);
+        default:
+            return undefined;
+    }
+}

package/src/lib/determine-sentry-release.d.ts

@@ -0,0 +1,10 @@
+import { Environment } from '@rxap/nest-utilities';
+/**
+ * Determines the sentry release based on the build info object.
+ *
+ * If the tier is local return undefined.
+ * If the tier is production return the tag value as release or undefined.
+ *
+ * @param environment
+ */
+export declare function DetermineSentryRelease(environment: Environment): string | undefined;

package/src/lib/determine-sentry-release.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DetermineSentryRelease = DetermineSentryRelease;
+/**
+ * Determines the sentry release based on the build info object.
+ *
+ * If the tier is local return undefined.
+ * If the tier is production return the tag value as release or undefined.
+ *
+ * @param environment
+ */
+function DetermineSentryRelease(environment) {
+    switch (environment.tier) {
+        case 'local':
+            return undefined;
+        case 'development':
+        case 'testing':
+        case 'staging':
+        case 'production':
+            return environment.tag ?? undefined;
+        default:
+            return undefined;
+    }
+}

package/src/lib/sentry-init-hook.d.ts

@@ -0,0 +1,2 @@
+import { Environment } from '@rxap/nest-utilities';
+export declare function sentryInitHook(): (_: any, environment: Environment) => void;

package/src/lib/sentry-init-hook.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sentryInitHook = sentryInitHook;
+const Sentry = require("@sentry/nestjs");
+const determine_sentry_environment_1 = require("./determine-sentry-environment");
+const determine_sentry_release_1 = require("./determine-sentry-release");
+const profiling_node_1 = require("@sentry/profiling-node");
+function sentryInitHook() {
+    return (_, environment) => {
+        const dsn = process.env['SENTRY_DSN'] ?? environment.sentry?.dsn;
+        if (!dsn) {
+            console.warn('No sentry dsn provided.');
+        }
+        Sentry.init({
+            dsn,
+            enabled: process.env['SENTRY_ENABLED'] === 'true' || (environment.sentry?.enabled ?? false),
+            debug: process.env['SENTRY_DEBUG'] === 'true' || (environment.sentry?.debug ?? false),
+            environment: (0, determine_sentry_environment_1.DetermineSentryEnvironment)(environment),
+            release: (0, determine_sentry_release_1.DetermineSentryRelease)(environment),
+            integrations: [
+                Sentry.captureConsoleIntegration({
+                    levels: ['error', 'warn'],
+                }),
+                (0, profiling_node_1.nodeProfilingIntegration)(),
+                Sentry.anrIntegration({ captureStackTrace: true }),
+            ],
+            tracesSampleRate: 1.0,
+            profilesSampleRate: 1.0,
+        });
+    };
+}

package/src/lib/sentry.interceptor.d.ts

@@ -2,9 +2,7 @@ import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
 import { Scope } from '@sentry/core';
 import { Observable } from 'rxjs';
 import { SentryInterceptorOptions } from './sentry.interfaces';
-import { SentryService } from './sentry.service';
 export declare class SentryInterceptor implements NestInterceptor {
-    protected readonly client: SentryService;
     protected readonly options?: SentryInterceptorOptions;
     intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
     protected captureException(context: ExecutionContext, scope: Scope, exception: unknown): void;

package/src/lib/sentry.interceptor.js

@@ -3,25 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SentryInterceptor = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
+const Sentry = require("@sentry/nestjs");
 const node_1 = require("@sentry/node");
 const operators_1 = require("rxjs/operators");
-const sentry_service_1 = require("./sentry.service");
 const tokens_1 = require("./tokens");
 let SentryInterceptor = class SentryInterceptor {
     intercept(context, next) {
-        if (this.client.hasInstance) {
-            // first param would be for events, second is for errors
-            return next.handle().pipe((0, operators_1.tap)({
-                error: (exception) => {
-                    if (this.shouldReport(exception)) {
-                        this.client.instance().withScope((scope) => {
-                            return this.captureException(context, scope, exception);
-                        });
-                    }
-                },
-            }));
-        }
-        return next.handle();
+        return next.handle().pipe((0, operators_1.tap)({
+            error: (exception) => {
+                if (this.shouldReport(exception)) {
+                    Sentry.withScope((scope) => {
+                        return this.captureException(context, scope, exception);
+                    });
+                }
+            },
+        }));
     }
     captureException(context, scope, exception) {
         if (exception && typeof exception === 'object' && typeof exception['setScope'] === 'function') {
@@ -45,16 +41,16 @@ let SentryInterceptor = class SentryInterceptor {
         if (data.user) {
             scope.setUser(data.user);
         }
-        this.client.instance().captureException(exception);
+        Sentry.captureException(exception);
     }
     captureRpcException(scope, rpc, exception) {
         scope.setExtra('rpc_data', rpc.getData());
-        this.client.instance().captureException(exception);
+        Sentry.captureException(exception);
     }
     captureWsException(scope, ws, exception) {
         scope.setExtra('ws_client', ws.getClient());
         scope.setExtra('ws_data', ws.getData());
-        this.client.instance().captureException(exception);
+        Sentry.captureException(exception);
     }
     shouldReport(exception) {
         if (!this.options?.filters) {
@@ -65,10 +61,6 @@ let SentryInterceptor = class SentryInterceptor {
     }
 };
 exports.SentryInterceptor = SentryInterceptor;
-tslib_1.__decorate([
-    (0, common_1.Inject)(sentry_service_1.SentryService),
-    tslib_1.__metadata("design:type", sentry_service_1.SentryService)
-], SentryInterceptor.prototype, "client", void 0);
 tslib_1.__decorate([
     (0, common_1.Optional)(),
     (0, common_1.Inject)(tokens_1.SENTRY_INTERCEPTOR_OPTIONS),

package/src/lib/sentry.module.js

@@ -5,12 +5,11 @@ exports.SentryModule = exports.DEFAULT_SENTRY_INTERCEPTOR_OPTIONS = exports.ASYN
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
 const config_1 = require("@nestjs/config");
+const core_1 = require("@nestjs/core");
 const nest_logger_1 = require("@rxap/nest-logger");
+const sentry_interceptor_1 = require("./sentry.interceptor");
 const sentry_logger_1 = require("./sentry.logger");
-const sentry_service_1 = require("./sentry.service");
 const tokens_1 = require("./tokens");
-const core_1 = require("@nestjs/core");
-const sentry_interceptor_1 = require("./sentry.interceptor");
 _a = new common_1.ConfigurableModuleBuilder()
     .setExtras({
     isGlobal: true,
@@ -88,8 +87,7 @@ exports.SentryModule = SentryModule = tslib_1.__decorate([
             },
             sentry_logger_1.SentryLogger,
             nest_logger_1.RxapLogger,
-            sentry_service_1.SentryService
         ],
-        exports: [common_1.Logger, sentry_service_1.SentryService],
+        exports: [common_1.Logger],
     })
 ], SentryModule);