@naturalcycles/backend-lib 4.7.1 → 4.8.0

package/dist/server/createDefaultApp.js

@@ -84,7 +84,7 @@ function createDefaultApp(cfg) {
     // Generic error handler
     // It handles errors, returns proper status, does sentry.captureException(),
     // assigns err.data.errorId from sentry
-    app.use((0, genericErrorMiddleware_1.genericErrorMiddleware)({ sentryService }));
+    app.use((0, genericErrorMiddleware_1.genericErrorMiddleware)({ sentryService, ...cfg.genericErrorMwCfg }));
     return app;
 }
 exports.createDefaultApp = createDefaultApp;

package/dist/server/createDefaultApp.model.d.ts

@@ -2,6 +2,7 @@ import { Options, OptionsJson, OptionsUrlencoded } from 'body-parser';
 import { CorsOptions } from 'cors';
 import { SentrySharedService } from '../sentry/sentry.shared.service';
 import { BackendRequestHandler } from './server.model';
+import { GenericErrorMiddlewareCfg } from './genericErrorMiddleware';
 /**
  * Plain RequestHandler can be provided - then it's mounted to /
  * Otherwise `path` can be provided to specify mounting point.
@@ -29,4 +30,5 @@ export interface DefaultAppCfg {
     bodyParserUrlEncodedOptions?: OptionsUrlencoded;
     bodyParserRawOptions?: Options;
     corsOptions?: CorsOptions;
+    genericErrorMwCfg?: GenericErrorMiddlewareCfg;
 }

package/dist/server/genericErrorMiddleware.d.ts

@@ -1,3 +1,4 @@
+import { ErrorObject, HttpErrorData } from '@naturalcycles/js-lib';
 import { SentrySharedService } from '../sentry/sentry.shared.service';
 import { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model';
 export interface GenericErrorMiddlewareCfg {
@@ -7,6 +8,11 @@ export interface GenericErrorMiddlewareCfg {
      * So, by default, it will report ALL errors, not only 5xx.
      */
     reportOnly5xx?: boolean;
+    /**
+     * Generic hook that can be used to **mutate** errors before they are returned to client.
+     * This function does not affect data sent to sentry.
+     */
+    formatError?: (err: ErrorObject<HttpErrorData>) => void;
 }
 /**
  * Generic error handler.

package/dist/server/genericErrorMiddleware.js

@@ -8,6 +8,7 @@ const includeErrorStack = APP_ENV !== 'prod' && APP_ENV !== 'test';
 // Hacky way to store the sentryService, so it's available to `respondWithError` function
 let sentryService;
 let reportOnly5xx = false;
+let formatError;
 /**
  * Generic error handler.
  * Returns HTTP code based on err.data.httpStatusCode (default to 500).
@@ -16,6 +17,7 @@ let reportOnly5xx = false;
 function genericErrorMiddleware(cfg = {}) {
     sentryService || (sentryService = cfg.sentryService);
     reportOnly5xx = cfg.reportOnly5xx || false;
+    formatError = cfg.formatError;
     return (err, req, res, _next) => {
         // if (res.headersSent) {
         // Here we don't even log this error
@@ -56,6 +58,7 @@ function respondWithError(req, res, err) {
     httpError.data.headersSent = headersSent || undefined;
     (_b = httpError.data).report || (_b.report = undefined); // set to undefined if false
     (0, js_lib_1._filterUndefinedValues)(httpError.data, true);
+    formatError?.(httpError); // Mutates
     res.status(httpError.data.httpStatusCode).json({
         error: httpError,
     });

package/dist/testing/express.test.service.d.ts

@@ -1,11 +1,11 @@
 import { GetGotOptions, Got } from '@naturalcycles/nodejs-lib';
-import { BackendApplication } from '../index';
+import { BackendApplication, DefaultAppCfg } from '../index';
 import { BackendRequestHandlerCfg } from '../server/createDefaultApp.model';
 export interface ExpressApp extends Got {
     close(): Promise<void>;
 }
 declare class ExpressTestService {
-    createAppFromResource(resource: BackendRequestHandlerCfg, opt?: GetGotOptions): ExpressApp;
+    createAppFromResource(resource: BackendRequestHandlerCfg, opt?: GetGotOptions, defaultAppCfg?: DefaultAppCfg): ExpressApp;
     createAppFromResources(resources: BackendRequestHandlerCfg[], opt?: GetGotOptions): ExpressApp;
     createApp(app: BackendApplication, opt?: GetGotOptions): ExpressApp;
     /**

package/dist/testing/express.test.service.js

@@ -9,8 +9,9 @@ const index_1 = require("../index");
 //   await app.close()
 // })
 class ExpressTestService {
-    createAppFromResource(resource, opt) {
+    createAppFromResource(resource, opt, defaultAppCfg) {
         return this.createApp((0, index_1.createDefaultApp)({
+            ...defaultAppCfg,
             resources: [resource],
         }), opt);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.7.1",
+  "version": "4.8.0",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",

package/src/server/createDefaultApp.model.ts

@@ -2,6 +2,7 @@ import { Options, OptionsJson, OptionsUrlencoded } from 'body-parser'
 import { CorsOptions } from 'cors'
 import { SentrySharedService } from '../sentry/sentry.shared.service'
 import { BackendRequestHandler } from './server.model'
+import { GenericErrorMiddlewareCfg } from './genericErrorMiddleware'
 
 /**
  * Plain RequestHandler can be provided - then it's mounted to /
@@ -35,4 +36,6 @@ export interface DefaultAppCfg {
   bodyParserRawOptions?: Options
 
   corsOptions?: CorsOptions
+
+  genericErrorMwCfg?: GenericErrorMiddlewareCfg
 }

package/src/server/createDefaultApp.ts

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

package/src/server/genericErrorMiddleware.ts

@@ -2,6 +2,7 @@ import {
   _anyToError,
   _errorToErrorObject,
   _filterUndefinedValues,
+  ErrorObject,
   HttpError,
   HttpErrorData,
   HttpErrorResponse,
@@ -18,6 +19,12 @@ export interface GenericErrorMiddlewareCfg {
    * So, by default, it will report ALL errors, not only 5xx.
    */
   reportOnly5xx?: boolean
+
+  /**
+   * Generic hook that can be used to **mutate** errors before they are returned to client.
+   * This function does not affect data sent to sentry.
+   */
+  formatError?: (err: ErrorObject<HttpErrorData>) => void
 }
 
 const { APP_ENV } = process.env
@@ -26,6 +33,7 @@ const includeErrorStack = APP_ENV !== 'prod' && APP_ENV !== 'test'
 // Hacky way to store the sentryService, so it's available to `respondWithError` function
 let sentryService: SentrySharedService | undefined
 let reportOnly5xx = false
+let formatError: GenericErrorMiddlewareCfg['formatError']
 
 /**
  * Generic error handler.
@@ -37,6 +45,7 @@ export function genericErrorMiddleware(
 ): BackendErrorRequestHandler {
   sentryService ||= cfg.sentryService
   reportOnly5xx = cfg.reportOnly5xx || false
+  formatError = cfg.formatError
 
   return (err, req, res, _next) => {
     // if (res.headersSent) {
@@ -84,6 +93,8 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
   httpError.data.report ||= undefined // set to undefined if false
   _filterUndefinedValues(httpError.data, true)
 
+  formatError?.(httpError) // Mutates
+
   res.status(httpError.data.httpStatusCode).json({
     error: httpError,
   } as HttpErrorResponse)

package/src/server/reqValidationMiddleware.ts

@@ -56,7 +56,7 @@ export function reqValidation(
  */
 function redact(redactPaths: string[], obj: any, error: Error): void {
   redactPaths
-    .map(path => _get(obj, path))
+    .map(path => _get(obj, path) as string)
     .filter(Boolean)
     .forEach(secret => {
       error.message = error.message.replace(secret, REDACTED)

package/src/server/validateMiddleware.ts

@@ -71,7 +71,7 @@ function validateObject(
  */
 function redact(redactPaths: string[], obj: any, error: Error): void {
   redactPaths
-    .map(path => _get(obj, path))
+    .map(path => _get(obj, path) as string)
     .filter(Boolean)
     .forEach(secret => {
       error.message = error.message.replace(secret, REDACTED)

package/src/testing/express.test.service.ts

@@ -1,7 +1,7 @@
 import { Server } from 'http'
 import { AddressInfo } from 'net'
 import { getGot, GetGotOptions, Got } from '@naturalcycles/nodejs-lib'
-import { BackendApplication, createDefaultApp } from '../index'
+import { BackendApplication, createDefaultApp, DefaultAppCfg } from '../index'
 import { BackendRequestHandlerCfg } from '../server/createDefaultApp.model'
 
 export interface ExpressApp extends Got {
@@ -15,9 +15,14 @@ export interface ExpressApp extends Got {
 // })
 
 class ExpressTestService {
-  createAppFromResource(resource: BackendRequestHandlerCfg, opt?: GetGotOptions): ExpressApp {
+  createAppFromResource(
+    resource: BackendRequestHandlerCfg,
+    opt?: GetGotOptions,
+    defaultAppCfg?: DefaultAppCfg,
+  ): ExpressApp {
     return this.createApp(
       createDefaultApp({
+        ...defaultAppCfg,
         resources: [resource],
       }),
       opt,