@naturalcycles/backend-lib 6.1.0 → 6.3.0

package/dist/deploy/deployHealthCheck.d.ts

@@ -17,7 +17,7 @@ export declare const deployHealthCheckYargsOptions: {
     };
     readonly thresholdUnhealthy: {
         readonly type: "number";
-        readonly default: 1;
+        readonly default: 3;
     };
     readonly maxTries: {
         readonly type: "number";

package/dist/deploy/deployHealthCheck.js

@@ -13,7 +13,7 @@ exports.deployHealthCheckYargsOptions = {
     },
     thresholdUnhealthy: {
         type: 'number',
-        default: 1,
+        default: 3,
     },
     maxTries: {
         type: 'number',
@@ -57,7 +57,7 @@ const inspectOpt = {
  * Fails after maxTries.
  */
 async function deployHealthCheck(url, opt = {}) {
-    const { thresholdHealthy = 5, thresholdUnhealthy = 1, maxTries = 20, timeoutSec = 30, intervalSec = 1, logOnFailure = true, logOnSuccess, gaeProject, gaeService, gaeVersion, } = opt;
+    const { thresholdHealthy = 5, thresholdUnhealthy = 3, maxTries = 30, timeoutSec = 30, intervalSec = 1, logOnFailure = true, logOnSuccess, gaeProject, gaeService, gaeVersion, } = opt;
     let attempt = 0;
     let countHealthy = 0;
     let countUnhealthy = 0;

package/dist/server/createDefaultApp.js

@@ -75,9 +75,10 @@ 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);
+    // currently disabled as not necessary (because genericErrorMiddleware already reports to sentry)
+    // if (sentryService) {
+    //   sentryService.sentry.setupExpressErrorHandler(app)
+    // }
     // Generic error handler
     // It handles errors, returns proper status, does sentry.captureException(),
     // assigns err.data.errorId from sentry

package/dist/server/genericErrorMiddleware.js

@@ -36,7 +36,7 @@ function genericErrorMiddleware(cfg = {}) {
 function respondWithError(req, res, err) {
     const { headersSent } = res;
     if (headersSent) {
-        req.error(`after headersSent`, err);
+        req.error(`error after headersSent:`, err);
     }
     else {
         req.error(err);
@@ -46,7 +46,7 @@ function respondWithError(req, res, err) {
     if (sentryService && shouldReportToSentry(originalError)) {
         errorId = sentryService.captureException(originalError, false);
     }
-    if (res.headersSent)
+    if (headersSent)
         return;
     const httpError = (0, js_lib_1._errorLikeToErrorObject)(originalError);
     if (!includeErrorStack)

package/dist/server/serverStatusMiddleware.js

@@ -17,6 +17,7 @@ function getServerStatusData(projectDir = process.cwd(), extra) {
     const t = (0, js_lib_1.localTime)(ts);
     const deployBuildTime = t.toPretty();
     const buildInfo = [t.toStringCompact(), gitBranch, gitRev].filter(Boolean).join('_');
+    const { arch, platform } = process;
     return (0, js_lib_1._filterNullishValues)({
         started: getStartedStr(),
         deployBuildTime,
@@ -25,9 +26,13 @@ function getServerStatusData(projectDir = process.cwd(), extra) {
         GAE_APPLICATION,
         GAE_SERVICE,
         GAE_VERSION,
+        processInfo: {
+            arch,
+            platform,
+        },
         mem: (0, nodejs_lib_1.memoryUsageFull)(),
         cpuAvg: nodejs_lib_1.processSharedUtil.cpuAvg(),
-        // resourceUsage: process.resourceUsage?.(),
+        cpuInfo: nodejs_lib_1.processSharedUtil.cpuInfo(),
         versions,
         NODE_OPTIONS,
         ...extra,

package/dist/server/startServer.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BackendServer = void 0;
 exports.startServer = startServer;
 const tslib_1 = require("tslib");
+const node_os_1 = tslib_1.__importDefault(require("node:os"));
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const index_1 = require("../index");
@@ -12,16 +13,18 @@ class BackendServer {
         this.cfg = cfg;
     }
     async start() {
-        const { port: cfgPort, expressApp = (0, index_1.createDefaultApp)(this.cfg) } = this.cfg;
+        const { port: cfgPort, expressApp = (0, index_1.createDefaultApp)(this.cfg), registerUncaughtExceptionHandlers = true, } = this.cfg;
         // 1. Register error handlers, etc.
-        process.on('uncaughtException', err => {
-            console.error('uncaughtException:', err);
-            this.cfg.sentryService?.captureException(err, false);
-        });
-        process.on('unhandledRejection', err => {
-            console.error('unhandledRejection:', err);
-            this.cfg.sentryService?.captureException(err, false);
-        });
+        if (registerUncaughtExceptionHandlers) {
+            process.on('uncaughtException', err => {
+                console.error('BackendServer uncaughtException:', err);
+                this.cfg.sentryService?.captureException(err, false);
+            });
+            process.on('unhandledRejection', err => {
+                console.error('BackendServer unhandledRejection:', err);
+                this.cfg.sentryService?.captureException(err, false);
+            });
+        }
         process.once('SIGINT', () => this.stop('SIGINT'));
         process.once('SIGTERM', () => this.stop('SIGTERM'));
         // sentryService.install()
@@ -46,7 +49,10 @@ class BackendServer {
                 address = `http://${addr.address}:${port}`;
             }
         }
-        console.log((0, nodejs_lib_1.dimGrey)(`node ${process.version}, NODE_OPTIONS: ${NODE_OPTIONS || 'undefined'}, APP_ENV: ${APP_ENV || 'undefined'}`));
+        const cpus = node_os_1.default.cpus().length;
+        const availableParallelism = node_os_1.default.availableParallelism?.();
+        const { version, platform, arch } = process;
+        console.log((0, nodejs_lib_1.dimGrey)(`node ${version} ${platform} ${arch}, NODE_OPTIONS: ${NODE_OPTIONS || 'undefined'}, APP_ENV: ${APP_ENV || 'undefined'}, cpus: ${cpus}, availableParallelism: ${availableParallelism}`));
         console.log(`serverStarted on ${(0, nodejs_lib_1.white)(address)} in ${(0, nodejs_lib_1.dimGrey)((0, js_lib_1._ms)(process.uptime() * 1000))}`);
         return {
             port,

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

@@ -21,6 +21,11 @@ export interface StartServerCfg extends DefaultAppCfg {
      */
     forceShutdownTimeout?: number;
     sentryService?: SentrySharedService;
+    /**
+     * Defaults to true.
+     * Set to false if you already have your handlers elsewhere and don't need them here.
+     */
+    registerUncaughtExceptionHandlers?: boolean;
 }
 export interface StartServerData {
     port: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "6.1.0",
+  "version": "6.3.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": "^8"
+    "@sentry/node": "^9"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^9",
@@ -43,13 +43,16 @@
   "devDependencies": {
     "@naturalcycles/bench-lib": "^3",
     "@naturalcycles/dev-lib": "^15",
-    "@sentry/node": "^8",
+    "@sentry/node": "^9",
     "@types/ejs": "^3",
     "@types/node": "^22",
     "@types/yargs": "^16",
     "fastify": "^5",
     "jest": "^29"
   },
+  "resolutions": {
+    "long": "5.2.4"
+  },
   "files": [
     "dist",
     "cfg",

package/src/deploy/deployHealthCheck.ts

@@ -30,7 +30,7 @@ export const deployHealthCheckYargsOptions = {
   },
   thresholdUnhealthy: {
     type: 'number',
-    default: 1,
+    default: 3,
   },
   maxTries: {
     type: 'number',
@@ -81,8 +81,8 @@ export async function deployHealthCheck(
 ): Promise<void> {
   const {
     thresholdHealthy = 5,
-    thresholdUnhealthy = 1,
-    maxTries = 20,
+    thresholdUnhealthy = 3,
+    maxTries = 30,
     timeoutSec = 30,
     intervalSec = 1,
     logOnFailure = true,

package/src/server/createDefaultApp.ts

@@ -110,9 +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);
+  // currently disabled as not necessary (because genericErrorMiddleware already reports to sentry)
+  // if (sentryService) {
+  //   sentryService.sentry.setupExpressErrorHandler(app)
+  // }
 
   // Generic error handler
   // It handles errors, returns proper status, does sentry.captureException(),

package/src/server/genericErrorMiddleware.ts

@@ -66,7 +66,7 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
   const { headersSent } = res
 
   if (headersSent) {
-    req.error(`after headersSent`, err)
+    req.error(`error after headersSent:`, err)
   } else {
     req.error(err)
   }
@@ -79,7 +79,7 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
     errorId = sentryService.captureException(originalError, false)
   }
 
-  if (res.headersSent) return
+  if (headersSent) return
 
   const httpError = _errorLikeToErrorObject(originalError)
   if (!includeErrorStack) delete httpError.stack

package/src/server/serverStatusMiddleware.ts

@@ -21,6 +21,8 @@ export function getServerStatusData(
   const deployBuildTime = t.toPretty()
   const buildInfo = [t.toStringCompact(), gitBranch, gitRev].filter(Boolean).join('_')
 
+  const { arch, platform } = process
+
   return _filterNullishValues({
     started: getStartedStr(),
     deployBuildTime,
@@ -29,9 +31,13 @@ export function getServerStatusData(
     GAE_APPLICATION,
     GAE_SERVICE,
     GAE_VERSION,
+    processInfo: {
+      arch,
+      platform,
+    },
     mem: memoryUsageFull(),
     cpuAvg: processSharedUtil.cpuAvg(),
-    // resourceUsage: process.resourceUsage?.(),
+    cpuInfo: processSharedUtil.cpuInfo(),
     versions,
     NODE_OPTIONS,
     ...extra,

package/src/server/startServer.model.ts

@@ -26,6 +26,12 @@ export interface StartServerCfg extends DefaultAppCfg {
   forceShutdownTimeout?: number
 
   sentryService?: SentrySharedService
+
+  /**
+   * Defaults to true.
+   * Set to false if you already have your handlers elsewhere and don't need them here.
+   */
+  registerUncaughtExceptionHandlers?: boolean
 }
 
 export interface StartServerData {

package/src/server/startServer.ts

@@ -1,4 +1,5 @@
 import { Server } from 'node:http'
+import os from 'node:os'
 import { _Memo, _ms } from '@naturalcycles/js-lib'
 import { boldGrey, dimGrey, white } from '@naturalcycles/nodejs-lib'
 import { createDefaultApp } from '../index'
@@ -12,18 +13,24 @@ export class BackendServer {
   server?: Server
 
   async start(): Promise<StartServerData> {
-    const { port: cfgPort, expressApp = createDefaultApp(this.cfg) } = this.cfg
+    const {
+      port: cfgPort,
+      expressApp = createDefaultApp(this.cfg),
+      registerUncaughtExceptionHandlers = true,
+    } = this.cfg
 
     // 1. Register error handlers, etc.
-    process.on('uncaughtException', err => {
-      console.error('uncaughtException:', err)
-      this.cfg.sentryService?.captureException(err, false)
-    })
+    if (registerUncaughtExceptionHandlers) {
+      process.on('uncaughtException', err => {
+        console.error('BackendServer uncaughtException:', err)
+        this.cfg.sentryService?.captureException(err, false)
+      })
 
-    process.on('unhandledRejection', err => {
-      console.error('unhandledRejection:', err)
-      this.cfg.sentryService?.captureException(err, false)
-    })
+      process.on('unhandledRejection', err => {
+        console.error('BackendServer unhandledRejection:', err)
+        this.cfg.sentryService?.captureException(err, false)
+      })
+    }
 
     process.once('SIGINT', () => this.stop('SIGINT'))
     process.once('SIGTERM', () => this.stop('SIGTERM'))
@@ -54,11 +61,14 @@ export class BackendServer {
       }
     }
 
+    const cpus = os.cpus().length
+    const availableParallelism = os.availableParallelism?.()
+    const { version, platform, arch } = process
     console.log(
       dimGrey(
-        `node ${process.version}, NODE_OPTIONS: ${NODE_OPTIONS || 'undefined'}, APP_ENV: ${
+        `node ${version} ${platform} ${arch}, NODE_OPTIONS: ${NODE_OPTIONS || 'undefined'}, APP_ENV: ${
           APP_ENV || 'undefined'
-        }`,
+        }, cpus: ${cpus}, availableParallelism: ${availableParallelism}`,
       ),
     )
     console.log(`serverStarted on ${white(address)} in ${dimGrey(_ms(process.uptime() * 1000))}`)