@naturalcycles/backend-lib 5.17.2 → 6.0.0

package/dist/sentry/sentry.shared.service.d.ts

@@ -1,26 +1,20 @@
 import { CommonLogger, Primitive, StringMap } from '@naturalcycles/js-lib';
-import type { Breadcrumb, NodeOptions, SeverityLevel } from '@sentry/node';
+import type { Breadcrumb, SeverityLevel } from '@sentry/node';
 import type * as SentryLib from '@sentry/node';
-import { BackendErrorRequestHandler, BackendRequestHandler } from '../index';
-export interface SentrySharedServiceCfg extends NodeOptions {
+export interface SentrySharedServiceCfg {
+    sentry: typeof SentryLib;
 }
+/**
+ * Recommended sentry configuration:
+ *
+ * {
+ *   maxValueLength: 2000, // default is 250 characters
+ * }
+ *
+ */
 export declare class SentrySharedService {
-    private sentryServiceCfg;
     constructor(sentryServiceCfg: SentrySharedServiceCfg);
-    init(): void;
-    sentry(): typeof SentryLib;
-    /**
-     * Currently not recommended, because it makes `void` requests throw user-facing errors.
-     *
-     * UPD: to be tested. Without it - request is not enriched and the error is less useful.
-     */
-    getRequestHandler(): BackendRequestHandler;
-    /**
-     * Currently not recommended, as it's replaced by our custom sentryErrorHandler.
-     *
-     * @deprecated
-     */
-    getErrorHandler(): BackendErrorRequestHandler;
+    sentry: typeof SentryLib;
     /**
      * For GDPR reasons we never send more information than just User ID.
      */

package/dist/sentry/sentry.shared.service.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SentrySharedService = void 0;
-const tslib_1 = require("tslib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const index_1 = require("../index");
@@ -17,54 +16,27 @@ const INSPECT_OPT = {
     colors: false,
     includeErrorData: true,
 };
+/**
+ * Recommended sentry configuration:
+ *
+ * {
+ *   maxValueLength: 2000, // default is 250 characters
+ * }
+ *
+ */
 class SentrySharedService {
     constructor(sentryServiceCfg) {
-        this.sentryServiceCfg = sentryServiceCfg;
-    }
-    init() {
-        this.sentry();
-    }
-    sentry() {
-        // Lazy-loading `@sentry/node`
-        // Reasons:
-        // 1. Can be useful is this module is imported but never actually used
-        // 2. Works around memory leak when used with Jest
-        const sentry = require('@sentry/node');
-        if (this.sentryServiceCfg.dsn) {
-            // Sentry enabled
-            console.log('SentryService init...');
-        }
-        sentry.init({
-            maxValueLength: 2000, // default is 250 characters
-            ...this.sentryServiceCfg,
-        });
-        return sentry;
-    }
-    /**
-     * Currently not recommended, because it makes `void` requests throw user-facing errors.
-     *
-     * UPD: to be tested. Without it - request is not enriched and the error is less useful.
-     */
-    getRequestHandler() {
-        return this.sentry().Handlers.requestHandler();
-    }
-    /**
-     * Currently not recommended, as it's replaced by our custom sentryErrorHandler.
-     *
-     * @deprecated
-     */
-    getErrorHandler() {
-        return this.sentry().Handlers.errorHandler();
+        this.sentry = sentryServiceCfg.sentry;
     }
     /**
      * For GDPR reasons we never send more information than just User ID.
      */
     setUserId(id) {
         if (id === null) {
-            this.sentry().setUser(null);
+            this.sentry.setUser(null);
             return;
         }
-        this.sentry().setUser({
+        this.sentry.setUser({
             id,
         });
     }
@@ -78,7 +50,7 @@ class SentrySharedService {
      * https://docs.sentry.io/platforms/node/enriching-events/scopes/
      */
     setTags(tags) {
-        this.sentry().setTags(tags);
+        this.sentry.setTags(tags);
     }
     /**
      * Does console.log(err)
@@ -104,20 +76,20 @@ class SentrySharedService {
         // This is to avoid Sentry cutting err.message to 253 characters
         // It will log additional "breadcrumb object" before the error
         // It's a Breadcrumb, not a console.log, because console.log are NOT automatically attached as Breadcrumbs in cron-job environments (outside of Express)
-        this.sentry().addBreadcrumb({
+        this.sentry.addBreadcrumb({
             message: (0, nodejs_lib_1._inspect)(err, INSPECT_OPT),
         });
-        return this.sentry().captureException(err);
+        return this.sentry.captureException(err);
     }
     /**
      * Returns "eventId"
      */
     captureMessage(msg, level) {
         (0, index_1.getRequestLogger)()[sentrySeverityMap[level] || 'log']('captureMessage:', msg);
-        return this.sentry().captureMessage(msg, level);
+        return this.sentry.captureMessage(msg, level);
     }
     addBreadcrumb(breadcrumb) {
-        this.sentry().addBreadcrumb(breadcrumb);
+        this.sentry.addBreadcrumb(breadcrumb);
     }
     /**
      * Currently it will only use `logger.error` ("error" level) and ignore `log` and `warn`.
@@ -132,15 +104,12 @@ class SentrySharedService {
             warn: () => { }, // noop
             error: (...args) => {
                 const message = args.map(arg => (0, nodejs_lib_1._inspect)(arg, INSPECT_OPT)).join(' ');
-                this.sentry().addBreadcrumb({
+                this.sentry.addBreadcrumb({
                     message,
                 });
-                this.sentry().captureException((0, js_lib_1._anyToError)(args.length === 1 ? args[0] : args));
+                this.sentry.captureException((0, js_lib_1._anyToError)(args.length === 1 ? args[0] : args));
             },
         };
     }
 }
 exports.SentrySharedService = SentrySharedService;
-tslib_1.__decorate([
-    (0, js_lib_1._Memo)()
-], SentrySharedService.prototype, "sentry", null);

package/dist/server/createDefaultApp.js

@@ -24,12 +24,6 @@ function createDefaultApp(cfg) {
     if (!isTest) {
         app.use((0, asyncLocalStorageMiddleware_1.asyncLocalStorageMiddleware)());
     }
-    // The request handler must be the first middleware on the app
-    if (sentryService) {
-        // On error - this handler will set res.headers,
-        // which will trigger genericErrorHandler "headers already sent"
-        app.use(sentryService.getRequestHandler());
-    }
     app.use((0, __1.methodOverrideMiddleware)());
     app.use((0, requestTimeoutMiddleware_1.requestTimeoutMiddleware)());
     // app.use(serverStatsMiddleware()) // disabled by default
@@ -81,6 +75,9 @@ function createDefaultApp(cfg) {
     useHandlers(app, cfg.postHandlers);
     // Generic 404 handler
     app.use((0, notFoundMiddleware_1.notFoundMiddleware)());
+    // todo: test if it's needed!
+    // Add this after all routes, but before any and other error-handling middlewares are defined
+    // Sentry.setupExpressErrorHandler(app);
     // Generic error handler
     // It handles errors, returns proper status, does sentry.captureException(),
     // assigns err.data.errorId from sentry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "5.17.2",
+  "version": "6.0.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",
@@ -18,7 +18,7 @@
     "deploy-health-check-debug2": "yarn tsn ./src/bin/deploy-health-check.ts --url https://api-master2.naturalcycles.com --thresholdUnhealthy 5"
   },
   "peerDependencies": {
-    "@sentry/node": "^7"
+    "@sentry/node": "^8"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^9",
@@ -43,7 +43,7 @@
   "devDependencies": {
     "@naturalcycles/bench-lib": "^3",
     "@naturalcycles/dev-lib": "^15",
-    "@sentry/node": "^7",
+    "@sentry/node": "^8",
     "@types/ejs": "^3",
     "@types/node": "^22",
     "@types/yargs": "^16",

package/src/sentry/sentry.shared.service.ts

@@ -1,18 +1,19 @@
 import {
   _anyToError,
   _isErrorObject,
-  _Memo,
   CommonLogger,
   CommonLogLevel,
   Primitive,
   StringMap,
 } from '@naturalcycles/js-lib'
 import { _inspect, InspectAnyOptions } from '@naturalcycles/nodejs-lib'
-import type { Breadcrumb, NodeOptions, SeverityLevel } from '@sentry/node'
+import type { Breadcrumb, SeverityLevel } from '@sentry/node'
 import type * as SentryLib from '@sentry/node'
-import { BackendErrorRequestHandler, BackendRequestHandler, getRequestLogger } from '../index'
+import { getRequestLogger } from '../index'
 
-export interface SentrySharedServiceCfg extends NodeOptions {}
+export interface SentrySharedServiceCfg {
+  sentry: typeof SentryLib
+}
 
 const sentrySeverityMap: Record<SeverityLevel, CommonLogLevel> = {
   debug: 'log',
@@ -28,62 +29,31 @@ const INSPECT_OPT: InspectAnyOptions = {
   includeErrorData: true,
 }
 
+/**
+ * Recommended sentry configuration:
+ *
+ * {
+ *   maxValueLength: 2000, // default is 250 characters
+ * }
+ *
+ */
 export class SentrySharedService {
-  constructor(private sentryServiceCfg: SentrySharedServiceCfg) {}
-
-  init(): void {
-    this.sentry()
+  constructor(sentryServiceCfg: SentrySharedServiceCfg) {
+    this.sentry = sentryServiceCfg.sentry
   }
 
-  @_Memo()
-  sentry(): typeof SentryLib {
-    // Lazy-loading `@sentry/node`
-    // Reasons:
-    // 1. Can be useful is this module is imported but never actually used
-    // 2. Works around memory leak when used with Jest
-    const sentry = require('@sentry/node') as typeof SentryLib
-
-    if (this.sentryServiceCfg.dsn) {
-      // Sentry enabled
-      console.log('SentryService init...')
-    }
-
-    sentry.init({
-      maxValueLength: 2000, // default is 250 characters
-      ...this.sentryServiceCfg,
-    })
-
-    return sentry
-  }
-
-  /**
-   * Currently not recommended, because it makes `void` requests throw user-facing errors.
-   *
-   * UPD: to be tested. Without it - request is not enriched and the error is less useful.
-   */
-  getRequestHandler(): BackendRequestHandler {
-    return this.sentry().Handlers.requestHandler()
-  }
-
-  /**
-   * Currently not recommended, as it's replaced by our custom sentryErrorHandler.
-   *
-   * @deprecated
-   */
-  getErrorHandler(): BackendErrorRequestHandler {
-    return this.sentry().Handlers.errorHandler()
-  }
+  sentry: typeof SentryLib
 
   /**
    * For GDPR reasons we never send more information than just User ID.
    */
   setUserId(id: string | null): void {
     if (id === null) {
-      this.sentry().setUser(null)
+      this.sentry.setUser(null)
       return
     }
 
-    this.sentry().setUser({
+    this.sentry.setUser({
       id,
     })
   }
@@ -98,7 +68,7 @@ export class SentrySharedService {
    * https://docs.sentry.io/platforms/node/enriching-events/scopes/
    */
   setTags(tags: StringMap<Primitive>): void {
-    this.sentry().setTags(tags)
+    this.sentry.setTags(tags)
   }
 
   /**
@@ -131,11 +101,11 @@ export class SentrySharedService {
     // This is to avoid Sentry cutting err.message to 253 characters
     // It will log additional "breadcrumb object" before the error
     // It's a Breadcrumb, not a console.log, because console.log are NOT automatically attached as Breadcrumbs in cron-job environments (outside of Express)
-    this.sentry().addBreadcrumb({
+    this.sentry.addBreadcrumb({
       message: _inspect(err, INSPECT_OPT),
     })
 
-    return this.sentry().captureException(err)
+    return this.sentry.captureException(err)
   }
 
   /**
@@ -143,11 +113,11 @@ export class SentrySharedService {
    */
   captureMessage(msg: string, level?: SeverityLevel): string {
     getRequestLogger()[sentrySeverityMap[level!] || 'log']('captureMessage:', msg)
-    return this.sentry().captureMessage(msg, level)
+    return this.sentry.captureMessage(msg, level)
   }
 
   addBreadcrumb(breadcrumb: Breadcrumb): void {
-    this.sentry().addBreadcrumb(breadcrumb)
+    this.sentry.addBreadcrumb(breadcrumb)
   }
 
   /**
@@ -164,11 +134,11 @@ export class SentrySharedService {
       error: (...args) => {
         const message = args.map(arg => _inspect(arg, INSPECT_OPT)).join(' ')
 
-        this.sentry().addBreadcrumb({
+        this.sentry.addBreadcrumb({
           message,
         })
 
-        this.sentry().captureException(_anyToError(args.length === 1 ? args[0] : args))
+        this.sentry.captureException(_anyToError(args.length === 1 ? args[0] : args))
       },
     }
   }

package/src/server/createDefaultApp.ts

@@ -34,13 +34,6 @@ export function createDefaultApp(cfg: DefaultAppCfg): BackendApplication {
     app.use(asyncLocalStorageMiddleware())
   }
 
-  // The request handler must be the first middleware on the app
-  if (sentryService) {
-    // On error - this handler will set res.headers,
-    // which will trigger genericErrorHandler "headers already sent"
-    app.use(sentryService.getRequestHandler())
-  }
-
   app.use(methodOverrideMiddleware())
   app.use(requestTimeoutMiddleware())
   // app.use(serverStatsMiddleware()) // disabled by default
@@ -117,6 +110,10 @@ export function createDefaultApp(cfg: DefaultAppCfg): BackendApplication {
   // Generic 404 handler
   app.use(notFoundMiddleware())
 
+  // todo: test if it's needed!
+  // Add this after all routes, but before any and other error-handling middlewares are defined
+  // Sentry.setupExpressErrorHandler(app);
+
   // Generic error handler
   // It handles errors, returns proper status, does sentry.captureException(),
   // assigns err.data.errorId from sentry