@naturalcycles/backend-lib 3.4.0 → 4.1.1

package/dist/deploy/deployPrepare.js

@@ -47,7 +47,8 @@ const DEFAULT_FILES = [
     'tsconfig.dist.json',
     '.gcloudignore',
     'app.yaml',
-    'patches', // to allow patch-package
+    'patches',
+    'resources',
 ];
 const defaultFilesDir = `${paths_cnst_1.srcDir}/deploy/files-default`;
 async function deployPrepare(opt = {}) {

package/dist/server/createDefaultApp.js

@@ -38,8 +38,22 @@ function createDefaultApp(cfg) {
         app.use((0, simpleRequestLoggerMiddleware_1.simpleRequestLoggerMiddleware)());
     }
     // app.use(safeJsonMiddleware()) // optional
-    app.use(express.json({ limit: '1mb' }));
-    app.use(express.urlencoded({ limit: '1mb', extended: true }));
+    // accepts application/json
+    app.use(express.json({
+        limit: '1mb',
+        ...cfg.bodyParserJsonOptions,
+    }));
+    app.use(express.urlencoded({
+        limit: '1mb',
+        extended: true,
+        ...cfg.bodyParserUrlEncodedOptions,
+    }));
+    // accepts application/octet-stream
+    app.use(express.raw({
+        // inflate: true, // default is `true`
+        limit: '1mb',
+        ...cfg.bodyParserRawOptions,
+    }));
     app.use(cookieParser());
     if (!isTest) {
         // leaks, load lazily
@@ -52,6 +66,7 @@ function createDefaultApp(cfg) {
         credentials: true,
         // methods: 'GET,HEAD,PUT,PATCH,POST,DELETE', // default
         maxAge: 86400,
+        ...cfg.corsOptions,
     }));
     // app.use(clearBodyParserTimeout()) // removed by default
     // Static is now disabled by default due to performance

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

@@ -1,3 +1,5 @@
+import { Options, OptionsJson, OptionsUrlencoded } from 'body-parser';
+import { CorsOptions } from 'cors';
 import { SentrySharedService } from '../sentry/sentry.shared.service';
 import { BackendRequestHandler } from './server.model';
 /**
@@ -23,4 +25,8 @@ export interface DefaultAppCfg {
     resources?: BackendRequestHandlerCfg[];
     postHandlers?: BackendRequestHandlerCfg[];
     sentryService?: SentrySharedService;
+    bodyParserJsonOptions?: OptionsJson;
+    bodyParserUrlEncodedOptions?: OptionsUrlencoded;
+    bodyParserRawOptions?: Options;
+    corsOptions?: CorsOptions;
 }

package/dist/server/genericErrorMiddleware.d.ts

@@ -2,6 +2,11 @@ import { SentrySharedService } from '../sentry/sentry.shared.service';
 import { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model';
 export interface GenericErrorMiddlewareCfg {
     sentryService?: SentrySharedService;
+    /**
+     * Defaults to false.
+     * So, by default, it will report ALL errors, not only 5xx.
+     */
+    reportOnly5xx?: boolean;
 }
 /**
  * Generic error handler.

package/dist/server/genericErrorMiddleware.js

@@ -7,6 +7,7 @@ const { APP_ENV } = process.env;
 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;
 /**
  * Generic error handler.
  * Returns HTTP code based on err.data.httpStatusCode (default to 500).
@@ -14,6 +15,7 @@ let sentryService;
  */
 function genericErrorMiddleware(cfg = {}) {
     sentryService || (sentryService = cfg.sentryService);
+    reportOnly5xx = cfg.reportOnly5xx || false;
     return (err, req, res, _next) => {
         // if (res.headersSent) {
         // Here we don't even log this error
@@ -30,9 +32,6 @@ function genericErrorMiddleware(cfg = {}) {
     };
 }
 exports.genericErrorMiddleware = genericErrorMiddleware;
-// export interface ResponseWithError extends Response {
-//   __err?: any
-// }
 function respondWithError(req, res, err) {
     var _a, _b;
     const { headersSent } = res;
@@ -73,5 +72,8 @@ function shouldReportToSentry(err) {
     if (e.data.report === false)
         return false;
     // Report if http 5xx, otherwise not
-    return !e.data.httpStatusCode || e.data.httpStatusCode >= 500;
+    // If no httpCode - report
+    // if httpCode >= 500 - report
+    // Otherwise - report, unless !reportOnly5xx is set
+    return !reportOnly5xx || !e.data.httpStatusCode || e.data.httpStatusCode >= 500;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "3.4.0",
+  "version": "4.1.1",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",
@@ -32,7 +32,7 @@
     "express-promise-router": "^4.0.0",
     "firebase-admin": "^10.0.0",
     "fs-extra": "^10.0.0",
-    "helmet": "^4.0.0",
+    "helmet": "^5.0.0",
     "js-yaml": "^4.0.0",
     "on-finished": "^2.3.0",
     "simple-git": "^2.1.0",
@@ -44,7 +44,7 @@
     "@sentry/node": "^6.5.1",
     "@types/ejs": "^3.0.0",
     "@types/js-yaml": "^4.0.0",
-    "@types/node": "^16.4.1",
+    "@types/node": "^17.0.0",
     "esbuild-register": "^3.1.2",
     "fastify": "^3.20.1",
     "jest": "^27.0.1",
@@ -84,7 +84,7 @@
     "url": "https://github.com/NaturalCycles/backend-lib"
   },
   "engines": {
-    "node": ">=14.15.0"
+    "node": ">=16.13.0"
   },
   "type": "commonjs",
   "description": "Standard library for making Express.js / AppEngine based backend services",

package/src/deploy/deployPrepare.ts

@@ -60,6 +60,7 @@ const DEFAULT_FILES = [
   '.gcloudignore',
   'app.yaml',
   'patches', // to allow patch-package
+  'resources',
 ]
 
 const defaultFilesDir = `${srcDir}/deploy/files-default`

package/src/server/createDefaultApp.model.ts

@@ -1,3 +1,5 @@
+import { Options, OptionsJson, OptionsUrlencoded } from 'body-parser'
+import { CorsOptions } from 'cors'
 import { SentrySharedService } from '../sentry/sentry.shared.service'
 import { BackendRequestHandler } from './server.model'
 
@@ -25,5 +27,12 @@ export interface DefaultAppCfg {
   handlers?: BackendRequestHandlerCfg[]
   resources?: BackendRequestHandlerCfg[]
   postHandlers?: BackendRequestHandlerCfg[]
+
   sentryService?: SentrySharedService
+
+  bodyParserJsonOptions?: OptionsJson
+  bodyParserUrlEncodedOptions?: OptionsUrlencoded
+  bodyParserRawOptions?: Options
+
+  corsOptions?: CorsOptions
 }

package/src/server/createDefaultApp.ts

@@ -51,9 +51,34 @@ export function createDefaultApp(cfg: DefaultAppCfg): BackendApplication {
   }
 
   // app.use(safeJsonMiddleware()) // optional
-  app.use(express.json({ limit: '1mb' }))
-  app.use(express.urlencoded({ limit: '1mb', extended: true }))
+
+  // accepts application/json
+  app.use(
+    express.json({
+      limit: '1mb',
+      ...cfg.bodyParserJsonOptions,
+    }),
+  )
+
+  app.use(
+    express.urlencoded({
+      limit: '1mb',
+      extended: true,
+      ...cfg.bodyParserUrlEncodedOptions,
+    }),
+  )
+
+  // accepts application/octet-stream
+  app.use(
+    express.raw({
+      // inflate: true, // default is `true`
+      limit: '1mb',
+      ...cfg.bodyParserRawOptions,
+    }),
+  )
+
   app.use(cookieParser())
+
   if (!isTest) {
     // leaks, load lazily
     app.use(
@@ -69,6 +94,7 @@ export function createDefaultApp(cfg: DefaultAppCfg): BackendApplication {
       credentials: true,
       // methods: 'GET,HEAD,PUT,PATCH,POST,DELETE', // default
       maxAge: 86400,
+      ...cfg.corsOptions,
     }),
   )
 

package/src/server/genericErrorMiddleware.ts

@@ -12,6 +12,12 @@ import { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './s
 
 export interface GenericErrorMiddlewareCfg {
   sentryService?: SentrySharedService
+
+  /**
+   * Defaults to false.
+   * So, by default, it will report ALL errors, not only 5xx.
+   */
+  reportOnly5xx?: boolean
 }
 
 const { APP_ENV } = process.env
@@ -19,6 +25,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
 
 /**
  * Generic error handler.
@@ -29,6 +36,7 @@ export function genericErrorMiddleware(
   cfg: GenericErrorMiddlewareCfg = {},
 ): BackendErrorRequestHandler {
   sentryService ||= cfg.sentryService
+  reportOnly5xx = cfg.reportOnly5xx || false
 
   return (err, req, res, _next) => {
     // if (res.headersSent) {
@@ -47,9 +55,6 @@ export function genericErrorMiddleware(
   }
 }
 
-// export interface ResponseWithError extends Response {
-//   __err?: any
-// }
 export function respondWithError(req: BackendRequest, res: BackendResponse, err: any): void {
   const { headersSent } = res
 
@@ -95,5 +100,8 @@ function shouldReportToSentry(err: Error): boolean {
   if (e.data.report === false) return false
 
   // Report if http 5xx, otherwise not
-  return !e.data.httpStatusCode || e.data.httpStatusCode >= 500
+  // If no httpCode - report
+  // if httpCode >= 500 - report
+  // Otherwise - report, unless !reportOnly5xx is set
+  return !reportOnly5xx || !e.data.httpStatusCode || e.data.httpStatusCode >= 500
 }