@naturalcycles/backend-lib 9.0.9 → 9.2.0

package/dist/server/createDefaultApp.js

@@ -81,7 +81,7 @@ export async function createDefaultApp(cfg) {
     // Generic error handler
     // It handles errors, returns proper status, does sentry.captureException(),
     // assigns err.data.errorId from sentry
-    app.use(genericErrorMiddleware({ sentryService, ...cfg.genericErrorMwCfg }));
+    app.use(genericErrorMiddleware({ errorReportingService: sentryService, ...cfg.genericErrorMwCfg }));
     return app;
 }
 function useHandlers(app, handlers = []) {

package/dist/server/genericErrorMiddleware.d.ts

@@ -1,8 +1,7 @@
 import type { ErrorObject } from '@naturalcycles/js-lib';
-import type { SentrySharedService } from '../sentry/sentry.shared.service.js';
 import type { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model.js';
 export interface GenericErrorMiddlewareCfg {
-    sentryService?: SentrySharedService;
+    errorReportingService?: ErrorReportingService;
     /**
      * Defaults to false.
      * So, by default, it will report ALL errors, not only 5xx.
@@ -14,6 +13,18 @@ export interface GenericErrorMiddlewareCfg {
      */
     formatError?: (err: ErrorObject) => void;
 }
+export interface ErrorReportingService {
+    /**
+     * Call to report an error.
+     *
+     * It returns an ID for the error (which may be used to reference it later),
+     * and may return undefined if the error is not reported.
+     * Which may happen if the error is not considered reportable,
+     * or if an error reporting rate is configured in the service.
+     *
+     */
+    captureException: (err: any) => string | undefined;
+}
 /**
  * Generic error handler.
  * Returns HTTP code based on err.data.backendResponseStatusCode (default to 500).

package/dist/server/genericErrorMiddleware.js

@@ -2,7 +2,7 @@ import { _anyToError, _errorLikeToErrorObject, _filterUndefinedValues } from '@n
 const { APP_ENV } = process.env;
 const includeErrorStack = APP_ENV === 'dev';
 // Hacky way to store the sentryService, so it's available to `respondWithError` function
-let sentryService;
+let errorService;
 let reportOnly5xx = false;
 let formatError;
 /**
@@ -11,7 +11,7 @@ let formatError;
  * Sends json payload as ErrorResponse, transformed via errorSharedUtil.
  */
 export function genericErrorMiddleware(cfg = {}) {
-    sentryService ||= cfg.sentryService;
+    errorService ||= cfg.errorReportingService;
     reportOnly5xx = cfg.reportOnly5xx || false;
     formatError = cfg.formatError;
     return (err, req, res, _next) => {
@@ -39,8 +39,9 @@ export function respondWithError(req, res, err) {
     }
     const originalError = _anyToError(err);
     let errorId;
-    if (sentryService && shouldReportToSentry(originalError)) {
-        errorId = sentryService.captureException(originalError, false);
+    const shouldReport = errorService && shouldReportToSentry(originalError);
+    if (shouldReport) {
+        errorId = errorService?.captureException(originalError);
     }
     if (headersSent)
         return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.0.9",
+  "version": "9.2.0",
   "peerDependencies": {
     "@sentry/node": "^9"
   },
@@ -9,6 +9,7 @@
     "@naturalcycles/db-lib": "^10",
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^14",
+    "@types/body-parser": "^1",
     "@types/cookie-parser": "^1",
     "@types/cors": "^2",
     "@types/express": "^5",
@@ -21,7 +22,8 @@
     "firebase-admin": "^13",
     "helmet": "^8",
     "on-finished": "^2",
-    "simple-git": "^3"
+    "simple-git": "^3",
+    "tslib": "^2"
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "*",
@@ -66,10 +68,9 @@
     "test": "dev-lib test",
     "lint": "dev-lib lint",
     "bt": "dev-lib bt",
-    "lbt": "dev-lib lbt",
+    "clean": "dev-lib clean",
+    "typecheck": "dev-lib typecheck",
     "dev": "APP_ENV=dev tsx watch src/test/server/server.ts",
-    "docs-serve": "NODE_OPTIONS=--openssl-legacy-provider vuepress dev docs",
-    "docs-build": "NODE_OPTIONS=--openssl-legacy-provider vuepress build docs",
     "deploy-gae": "tsx src/bin/deploy-gae.ts",
     "deploy-prepare": "tsx src/bin/deploy-prepare.ts",
     "deploy-prepare-debug": "AA=AA1 BB=BB1 tsx src/bin/deploy-prepare.ts --projectDir ./src/test/project",

package/src/server/createDefaultApp.ts

@@ -121,7 +121,9 @@ export async function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendAppli
   // Generic error handler
   // It handles errors, returns proper status, does sentry.captureException(),
   // assigns err.data.errorId from sentry
-  app.use(genericErrorMiddleware({ sentryService, ...cfg.genericErrorMwCfg }))
+  app.use(
+    genericErrorMiddleware({ errorReportingService: sentryService, ...cfg.genericErrorMwCfg }),
+  )
 
   return app
 }

package/src/server/genericErrorMiddleware.ts

@@ -1,10 +1,9 @@
 import type { AppError, BackendErrorResponseObject, ErrorObject } from '@naturalcycles/js-lib'
 import { _anyToError, _errorLikeToErrorObject, _filterUndefinedValues } from '@naturalcycles/js-lib'
-import type { SentrySharedService } from '../sentry/sentry.shared.service.js'
 import type { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model.js'
 
 export interface GenericErrorMiddlewareCfg {
-  sentryService?: SentrySharedService
+  errorReportingService?: ErrorReportingService
 
   /**
    * Defaults to false.
@@ -19,11 +18,24 @@ export interface GenericErrorMiddlewareCfg {
   formatError?: (err: ErrorObject) => void
 }
 
+export interface ErrorReportingService {
+  /**
+   * Call to report an error.
+   *
+   * It returns an ID for the error (which may be used to reference it later),
+   * and may return undefined if the error is not reported.
+   * Which may happen if the error is not considered reportable,
+   * or if an error reporting rate is configured in the service.
+   *
+   */
+  captureException: (err: any) => string | undefined
+}
+
 const { APP_ENV } = process.env
 const includeErrorStack = APP_ENV === 'dev'
 
 // Hacky way to store the sentryService, so it's available to `respondWithError` function
-let sentryService: SentrySharedService | undefined
+let errorService: ErrorReportingService | undefined
 let reportOnly5xx = false
 let formatError: GenericErrorMiddlewareCfg['formatError']
 
@@ -35,7 +47,7 @@ let formatError: GenericErrorMiddlewareCfg['formatError']
 export function genericErrorMiddleware(
   cfg: GenericErrorMiddlewareCfg = {},
 ): BackendErrorRequestHandler {
-  sentryService ||= cfg.sentryService
+  errorService ||= cfg.errorReportingService
   reportOnly5xx = cfg.reportOnly5xx || false
   formatError = cfg.formatError
 
@@ -69,8 +81,9 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
 
   let errorId: string | undefined
 
-  if (sentryService && shouldReportToSentry(originalError)) {
-    errorId = sentryService.captureException(originalError, false)
+  const shouldReport = errorService && shouldReportToSentry(originalError)
+  if (shouldReport) {
+    errorId = errorService?.captureException(originalError)
   }
 
   if (headersSent) return