@naturalcycles/backend-lib 4.10.1 → 4.11.0

package/dist/admin/base.admin.service.js

@@ -41,6 +41,7 @@ class BaseAdminService {
     /**
      * To be extended.
      */
+    // eslint-disable-next-line max-params
     async onPermissionCheck(req, email, reqPermissions, required, granted, meta = {}) {
         req.log(`${(0, colors_1.dimGrey)(email)} ${required ? 'required' : 'optional'} permissions check [${(0, colors_1.dimGrey)(reqPermissions.join(', '))}]: ${granted ? (0, colors_1.green)('GRANTED') : (0, colors_1.red)('DENIED')}`, meta);
     }
@@ -70,7 +71,7 @@ class BaseAdminService {
      * Override if needed.
      */
     async getAdminToken(req) {
-        return ((req.cookies || {})[this.cfg.adminTokenKey] ||
+        return (req.cookies?.[this.cfg.adminTokenKey] ||
             req.header(this.cfg.adminTokenKey) ||
             req.header('x-admin-token'));
     }

package/dist/db/httpDB.d.ts

@@ -16,7 +16,7 @@ export declare class HttpDB extends BaseCommonDB implements CommonDB {
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     resetCache(table?: string): Promise<void>;
-    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CommonDBOptions): Promise<ROW[]>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: CommonDBOptions): Promise<ROW[]>;
     runQuery<ROW extends ObjectWithId>(query: DBQuery<ROW>, opt?: CommonDBOptions): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(query: DBQuery<ROW>, opt?: CommonDBOptions): Promise<number>;
     saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;

package/dist/db/httpDBRequestHandler.js

@@ -72,10 +72,10 @@ function httpDBRequestHandler(db) {
         res.end();
     });
     // deleteByIds
-    router.put('/deleteByIds', (0, __1.reqValidation)('body', getByIdsInputSchema), async (req, res) => {
-        const { table, ids, opt } = req.body;
-        res.json(await db.deleteByIds(table, ids, opt));
-    });
+    // router.put('/deleteByIds', reqValidation('body', getByIdsInputSchema), async (req, res) => {
+    //   const { table, ids, opt } = req.body as GetByIdsInput
+    //   res.json(await db.deleteByIds(table, ids, opt))
+    // })
     // deleteByQuery
     router.put('/deleteByQuery', (0, __1.reqValidation)('body', runQueryInputSchema), async (req, res) => {
         const { query, opt } = req.body;

package/dist/deploy/deployHealthCheck.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployHealthCheck = exports.deployHealthCheckYargsOptions = void 0;
 const node_util_1 = require("node:util");
 const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const colors_1 = require("@naturalcycles/nodejs-lib/dist/colors");
 const exec_1 = require("@naturalcycles/nodejs-lib/dist/exec");
 const request_log_util_1 = require("../server/request.log.util");
@@ -66,7 +65,7 @@ async function deployHealthCheck(url, opt = {}) {
     let doneReason;
     let failed = false;
     let currentInterval = intervalSec * 1000;
-    const got = (0, nodejs_lib_1.getGot)();
+    const fetcher = (0, js_lib_1.getFetcher)();
     while (!done) {
         // eslint-disable-next-line no-await-in-loop
         await makeAttempt();
@@ -85,18 +84,18 @@ async function deployHealthCheck(url, opt = {}) {
         attempt++;
         console.log([`>>`, (0, colors_1.dimGrey)(url), (0, node_util_1.inspect)({ attempt }, inspectOpt)].join(' '));
         const started = Date.now();
-        const { statusCode } = await got(url, {
-            responseType: 'json',
-            timeout: timeoutSec * 1000,
-            retry: 0,
-            followRedirect: false,
-            throwHttpErrors: false,
-        }).catch((err) => {
-            console.log(err.message);
-            return {
-                statusCode: 0,
-            };
+        const { err, fetchResponse } = await fetcher.rawFetch(url, {
+            mode: 'json',
+            timeoutSeconds: timeoutSec,
+            retry: {
+                count: 0,
+            },
+            followRedirects: false,
         });
+        if (err) {
+            console.log(err);
+        }
+        const statusCode = fetchResponse?.status || 0;
         if (statusCode === 200) {
             countHealthy++;
             countUnhealthy = 0;

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

@@ -86,7 +86,7 @@ class SentrySharedService {
             }),
             // data: (err as AppError).data, // included in message
         });
-        return this.sentry().captureException((0, js_lib_1._anyToError)(err, Error, {
+        return this.sentry().captureException((0, js_lib_1._anyToError)(err, Error, {}, {
             stringifyFn: nodejs_lib_1.inspectAnyStringifyFn,
         }));
     }
@@ -121,7 +121,7 @@ class SentrySharedService {
                 this.sentry().addBreadcrumb({
                     message,
                 });
-                this.sentry().captureException((0, js_lib_1._anyToError)(args.length === 1 ? args[0] : args, Error, {
+                this.sentry().captureException((0, js_lib_1._anyToError)(args.length === 1 ? args[0] : args, Error, {}, {
                     stringifyFn: nodejs_lib_1.inspectAnyStringifyFn,
                 }));
             },

package/dist/server/genericErrorMiddleware.js

@@ -42,7 +42,7 @@ function respondWithError(req, res, err) {
     else {
         req.error(err);
     }
-    const originalError = (0, js_lib_1._anyToError)(err, Error, {
+    const originalError = (0, js_lib_1._anyToError)(err, Error, {}, {
         stringifyFn: nodejs_lib_1.inspectAnyStringifyFn,
     });
     let errorId;

package/dist/server/server.util.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Server } from 'node:http';
 export interface DestroyableServer extends Server {
-    destroy(): Promise<void>;
+    destroy: () => Promise<void>;
 }
 /**
  * Based on: https://github.com/isaacs/server-destroy/blob/master/index.js

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

@@ -2,7 +2,7 @@ import { GetGotOptions, Got } from '@naturalcycles/nodejs-lib';
 import { BackendApplication, DefaultAppCfg } from '../index';
 import { BackendRequestHandlerCfg } from '../server/createDefaultApp.model';
 export interface ExpressApp extends Got {
-    close(): Promise<void>;
+    close: () => Promise<void>;
 }
 declare class ExpressTestService {
     createAppFromResource(resource: BackendRequestHandlerCfg, opt?: GetGotOptions, defaultAppCfg?: DefaultAppCfg): ExpressApp;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.10.1",
+  "version": "4.11.0",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",
-    "docs-serve": "vuepress dev docs",
-    "docs-build": "vuepress build docs",
+    "docs-serve": "NODE_OPTIONS=--openssl-legacy-provider vuepress dev docs",
+    "docs-build": "NODE_OPTIONS=--openssl-legacy-provider vuepress build docs",
     "deploy-gae": "yarn tsn ./src/bin/deploy-gae.ts",
     "deploy-prepare": "yarn tsn ./src/bin/deploy-prepare.ts",
     "deploy-prepare-debug": "AA=AA1 BB=BB1 yarn tsn ./src/bin/deploy-prepare.ts --projectDir ./src/test/project",
@@ -78,7 +78,7 @@
     "url": "https://github.com/NaturalCycles/backend-lib"
   },
   "engines": {
-    "node": ">=16.10.0"
+    "node": ">=16.15.0"
   },
   "type": "commonjs",
   "description": "Standard library for making Express.js / AppEngine based backend services",

package/src/admin/base.admin.service.ts

@@ -68,6 +68,7 @@ export class BaseAdminService {
   /**
    * To be extended.
    */
+  // eslint-disable-next-line max-params
   protected async onPermissionCheck(
     req: BackendRequest,
     email: string,
@@ -113,7 +114,7 @@ export class BaseAdminService {
    */
   async getAdminToken(req: BackendRequest): Promise<string | undefined> {
     return (
-      (req.cookies || {})[this.cfg.adminTokenKey] ||
+      req.cookies?.[this.cfg.adminTokenKey] ||
       req.header(this.cfg.adminTokenKey) ||
       req.header('x-admin-token')
     )

package/src/db/httpDB.ts

@@ -50,7 +50,7 @@ export class HttpDB extends BaseCommonDB implements CommonDB {
 
   override async getByIds<ROW extends ObjectWithId>(
     table: string,
-    ids: string[],
+    ids: ROW['id'][],
     opt?: CommonDBOptions,
   ): Promise<ROW[]> {
     return await this.got
@@ -106,7 +106,7 @@ export class HttpDB extends BaseCommonDB implements CommonDB {
     })
   }
 
-  override async deleteByIds(table: string, ids: string[], opt?: CommonDBOptions): Promise<number> {
+  async deleteByIds(table: string, ids: string[], opt?: CommonDBOptions): Promise<number> {
     return await this.got
       .put(`deleteByIds`, {
         json: {

package/src/db/httpDBRequestHandler.ts

@@ -111,10 +111,10 @@ export function httpDBRequestHandler(db: CommonDB): BackendRouter {
   })
 
   // deleteByIds
-  router.put('/deleteByIds', reqValidation('body', getByIdsInputSchema), async (req, res) => {
-    const { table, ids, opt } = req.body as GetByIdsInput
-    res.json(await db.deleteByIds(table, ids, opt))
-  })
+  // router.put('/deleteByIds', reqValidation('body', getByIdsInputSchema), async (req, res) => {
+  //   const { table, ids, opt } = req.body as GetByIdsInput
+  //   res.json(await db.deleteByIds(table, ids, opt))
+  // })
 
   // deleteByQuery
   router.put('/deleteByQuery', reqValidation('body', runQueryInputSchema), async (req, res) => {

package/src/deploy/deployHealthCheck.ts

@@ -1,6 +1,5 @@
 import { inspect, InspectOptions } from 'node:util'
-import { pDelay, _filterFalsyValues, _ms, _since } from '@naturalcycles/js-lib'
-import { getGot } from '@naturalcycles/nodejs-lib'
+import { pDelay, _filterFalsyValues, _ms, _since, getFetcher } from '@naturalcycles/js-lib'
 import { dimGrey, red } from '@naturalcycles/nodejs-lib/dist/colors'
 import { execCommand } from '@naturalcycles/nodejs-lib/dist/exec'
 import { coloredHttpCode } from '../server/request.log.util'
@@ -95,7 +94,7 @@ export async function deployHealthCheck(
   let failed = false
   let currentInterval = intervalSec * 1000
 
-  const got = getGot()
+  const fetcher = getFetcher()
 
   while (!done) {
     // eslint-disable-next-line no-await-in-loop
@@ -127,20 +126,21 @@ export async function deployHealthCheck(
 
     const started = Date.now()
 
-    const { statusCode } = await got(url, {
-      responseType: 'json',
-      timeout: timeoutSec * 1000,
-      retry: 0, // no retries allowed
-      followRedirect: false,
-      throwHttpErrors: false,
-    }).catch((err: Error) => {
-      console.log(err.message)
-
-      return {
-        statusCode: 0,
-      }
+    const { err, fetchResponse } = await fetcher.rawFetch(url, {
+      mode: 'json',
+      timeoutSeconds: timeoutSec,
+      retry: {
+        count: 0,
+      },
+      followRedirects: false,
     })
 
+    if (err) {
+      console.log(err)
+    }
+
+    const statusCode = fetchResponse?.status || 0
+
     if (statusCode === 200) {
       countHealthy++
       countUnhealthy = 0

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

@@ -100,9 +100,14 @@ export class SentrySharedService {
     })
 
     return this.sentry().captureException(
-      _anyToError(err, Error, {
-        stringifyFn: inspectAnyStringifyFn,
-      }),
+      _anyToError(
+        err,
+        Error,
+        {},
+        {
+          stringifyFn: inspectAnyStringifyFn,
+        },
+      ),
     )
   }
 
@@ -144,9 +149,14 @@ export class SentrySharedService {
         })
 
         this.sentry().captureException(
-          _anyToError(args.length === 1 ? args[0] : args, Error, {
-            stringifyFn: inspectAnyStringifyFn,
-          }),
+          _anyToError(
+            args.length === 1 ? args[0] : args,
+            Error,
+            {},
+            {
+              stringifyFn: inspectAnyStringifyFn,
+            },
+          ),
         )
       },
     }

package/src/server/genericErrorMiddleware.ts

@@ -73,9 +73,14 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
     req.error(err)
   }
 
-  const originalError = _anyToError(err, Error, {
-    stringifyFn: inspectAnyStringifyFn,
-  })
+  const originalError = _anyToError(
+    err,
+    Error,
+    {},
+    {
+      stringifyFn: inspectAnyStringifyFn,
+    },
+  )
 
   let errorId: string | undefined
 

package/src/server/server.util.ts

@@ -3,7 +3,7 @@ import { Socket } from 'node:net'
 import { StringMap } from '@naturalcycles/js-lib'
 
 export interface DestroyableServer extends Server {
-  destroy(): Promise<void>
+  destroy: () => Promise<void>
 }
 
 /**

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

@@ -5,7 +5,7 @@ import { BackendApplication, createDefaultApp, DefaultAppCfg } from '../index'
 import { BackendRequestHandlerCfg } from '../server/createDefaultApp.model'
 
 export interface ExpressApp extends Got {
-  close(): Promise<void>
+  close: () => Promise<void>
 }
 
 // Example: