@naturalcycles/backend-lib 7.1.0 → 7.1.2

package/dist/bin/deploy-gae.js

@@ -1,14 +1,12 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const yargs_1 = tslib_1.__importDefault(require("yargs"));
 const deployGae_1 = require("../deploy/deployGae");
 const deployHealthCheck_1 = require("../deploy/deployHealthCheck");
 const deployPrepare_1 = require("../deploy/deployPrepare");
 (0, nodejs_lib_1.runScript)(async () => {
-    const opt = yargs_1.default.options({
+    const opt = (0, nodejs_lib_1._yargs)().options({
         ...deployPrepare_1.deployPrepareYargsOptions,
         ...deployHealthCheck_1.deployHealthCheckYargsOptions,
     }).argv;

package/dist/bin/deploy-health-check.js

@@ -9,12 +9,10 @@ yarn deploy-health-check --url https://service-dot-yourproject.appspot.com
 
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const yargs_1 = tslib_1.__importDefault(require("yargs"));
 const deployHealthCheck_1 = require("../deploy/deployHealthCheck");
 (0, nodejs_lib_1.runScript)(async () => {
-    const { url, ...opt } = yargs_1.default.options({
+    const { url, ...opt } = (0, nodejs_lib_1._yargs)().options({
         ...deployHealthCheck_1.deployHealthCheckYargsOptions,
         url: {
             type: 'string',

package/dist/bin/deploy-prepare.js

@@ -6,12 +6,10 @@ yarn deploy-prepare
 
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const yargs_1 = tslib_1.__importDefault(require("yargs"));
 const deployPrepare_1 = require("../deploy/deployPrepare");
 (0, nodejs_lib_1.runScript)(async () => {
-    const opt = yargs_1.default.options(deployPrepare_1.deployPrepareYargsOptions).argv;
+    const opt = (0, nodejs_lib_1._yargs)().options(deployPrepare_1.deployPrepareYargsOptions).argv;
     await (0, deployPrepare_1.deployPrepare)(opt);
 });
 // deploy strategy

package/dist/bin/undeploy-gae.js

@@ -1,12 +1,10 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const yargs_1 = tslib_1.__importDefault(require("yargs"));
 const deployGae_1 = require("../deploy/deployGae");
 (0, nodejs_lib_1.runScript)(async () => {
-    const { branch } = yargs_1.default.options({
+    const { branch } = (0, nodejs_lib_1._yargs)().options({
         branch: {
             type: 'string',
             demandOption: true,

package/dist/server/logMiddleware.js

@@ -4,9 +4,11 @@ exports.ciLogger = exports.devLogger = exports.gaeLogger = void 0;
 exports.logMiddleware = logMiddleware;
 const node_util_1 = require("node:util");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE } = process.env;
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, APP_ENV } = process.env;
 const isGAE = !!GAE_INSTANCE;
-const isCloudRun = !!K_SERVICE;
+// const isCloudRun = !!K_SERVICE
+// const isTest = APP_ENV === 'test'
+const isDev = APP_ENV === 'dev';
 // Simple "request counter" (poor man's "correlation id") counter, to use on dev machine (not in the cloud)
 let reqCounter = 0;
 /**
@@ -57,41 +59,47 @@ function logToCI(args) {
     console.log(args.map(a => (0, nodejs_lib_1._inspect)(a, { includeErrorStack: true, colors: false })).join(' '));
 }
 function logMiddleware() {
-    if (isCloudRun) {
-        // Cloud Run, return simple logger, similar to CI logger
-        return function cloudRunLogHandler(req, _res, next) {
-            req.log = req.warn = req.error = logToCI;
+    if (isGAE) {
+        if (GOOGLE_CLOUD_PROJECT) {
+            return function appEngineLogHandler(req, _res, next) {
+                const traceHeader = req.header('x-cloud-trace-context');
+                if (traceHeader) {
+                    const [trace] = traceHeader.split('/');
+                    const meta = {
+                        'logging.googleapis.com/trace': `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`,
+                        'appengine.googleapis.com/request_id': req.header('x-appengine-request-log-id'),
+                    };
+                    Object.assign(req, {
+                        log: (...args) => logToAppEngine({ ...meta, severity: 'INFO' }, args),
+                        warn: (...args) => logToAppEngine({ ...meta, severity: 'WARNING' }, args),
+                        error: (...args) => logToAppEngine({ ...meta, severity: 'ERROR' }, args),
+                    });
+                    req.requestId = trace;
+                }
+                else {
+                    Object.assign(req, exports.gaeLogger);
+                }
+                next();
+            };
+        }
+        return function appEngineLogHandler(req, _res, next) {
+            Object.assign(req, exports.gaeLogger);
             next();
         };
     }
-    if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
+    if (isDev) {
         // Local machine, return "simple" logToDev middleware with request numbering
-        return function gaeLogMiddlewareDev(req, _res, next) {
+        return function devLogHandler(req, _res, next) {
             // Local machine
             req.requestId = String(++reqCounter);
             req.log = req.warn = req.error = (...args) => logToDev(req.requestId, args);
             next();
         };
     }
-    // Otherwise, we're in AppEngine
-    return function appEngineLogHandler(req, _res, next) {
-        const traceHeader = req.header('x-cloud-trace-context');
-        if (traceHeader) {
-            const [trace] = traceHeader.split('/');
-            const meta = {
-                'logging.googleapis.com/trace': `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`,
-                'appengine.googleapis.com/request_id': req.header('x-appengine-request-log-id'),
-            };
-            Object.assign(req, {
-                log: (...args) => logToAppEngine({ ...meta, severity: 'INFO' }, args),
-                warn: (...args) => logToAppEngine({ ...meta, severity: 'WARNING' }, args),
-                error: (...args) => logToAppEngine({ ...meta, severity: 'ERROR' }, args),
-            });
-            req.requestId = trace;
-        }
-        else {
-            Object.assign(req, exports.gaeLogger);
-        }
+    // Otherwise, return "simple" logger
+    // This includes: unit tests, CloudRun, CI environments
+    return function simpleLogHandler(req, _res, next) {
+        req.log = req.warn = req.error = (...args) => logToCI(args);
         next();
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "7.1.0",
+  "version": "7.1.2",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",
@@ -11,11 +11,11 @@
     "dev": "APP_ENV=dev node -r ts-node/register --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": "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",
-    "deploy-health-check-debug1": "yarn tsn ./src/bin/deploy-health-check.ts --url https://api-master.naturalcycles.com",
-    "deploy-health-check-debug2": "yarn tsn ./src/bin/deploy-health-check.ts --url https://api-master2.naturalcycles.com --thresholdUnhealthy 5"
+    "deploy-gae": "yarn tsx ./src/bin/deploy-gae.ts",
+    "deploy-prepare": "yarn tsx ./src/bin/deploy-prepare.ts",
+    "deploy-prepare-debug": "AA=AA1 BB=BB1 yarn tsx ./src/bin/deploy-prepare.ts --projectDir ./src/test/project",
+    "deploy-health-check-debug1": "yarn tsx ./src/bin/deploy-health-check.ts --url https://api-master.naturalcycles.com",
+    "deploy-health-check-debug2": "yarn tsx ./src/bin/deploy-health-check.ts --url https://api-master2.naturalcycles.com --thresholdUnhealthy 5"
   },
   "peerDependencies": {
     "@sentry/node": "^9"
@@ -37,18 +37,17 @@
     "firebase-admin": "^13",
     "helmet": "^8",
     "on-finished": "^2",
-    "simple-git": "^3",
-    "yargs": "^17"
+    "simple-git": "^3"
   },
   "devDependencies": {
     "@naturalcycles/bench-lib": "^3",
-    "@naturalcycles/dev-lib": "^16",
+    "@naturalcycles/dev-lib": "^17",
     "@sentry/node": "^9",
     "@types/ejs": "^3",
     "@types/node": "^22",
-    "@types/yargs": "^16",
     "@vitest/coverage-v8": "^3",
     "fastify": "^5",
+    "tsx": "^4",
     "vitest": "^3"
   },
   "files": [

package/src/bin/deploy-gae.ts

@@ -1,13 +1,12 @@
 #!/usr/bin/env node
 
-import { runScript } from '@naturalcycles/nodejs-lib'
-import yargs from 'yargs'
+import { _yargs, runScript } from '@naturalcycles/nodejs-lib'
 import { deployGae } from '../deploy/deployGae'
 import { deployHealthCheckYargsOptions } from '../deploy/deployHealthCheck'
 import { deployPrepareYargsOptions } from '../deploy/deployPrepare'
 
 runScript(async () => {
-  const opt = yargs.options({
+  const opt = _yargs().options({
     ...deployPrepareYargsOptions,
     ...deployHealthCheckYargsOptions,
   }).argv

package/src/bin/deploy-health-check.ts

@@ -9,12 +9,11 @@ yarn deploy-health-check --url https://service-dot-yourproject.appspot.com
 
  */
 
-import { runScript } from '@naturalcycles/nodejs-lib'
-import yargs from 'yargs'
+import { _yargs, runScript } from '@naturalcycles/nodejs-lib'
 import { deployHealthCheck, deployHealthCheckYargsOptions } from '../deploy/deployHealthCheck'
 
 runScript(async () => {
-  const { url, ...opt } = yargs.options({
+  const { url, ...opt } = _yargs().options({
     ...deployHealthCheckYargsOptions,
     url: {
       type: 'string',

package/src/bin/deploy-prepare.ts

@@ -6,12 +6,11 @@ yarn deploy-prepare
 
  */
 
-import { runScript } from '@naturalcycles/nodejs-lib'
-import yargs from 'yargs'
+import { _yargs, runScript } from '@naturalcycles/nodejs-lib'
 import { deployPrepare, deployPrepareYargsOptions } from '../deploy/deployPrepare'
 
 runScript(async () => {
-  const opt = yargs.options(deployPrepareYargsOptions).argv
+  const opt = _yargs().options(deployPrepareYargsOptions).argv
 
   await deployPrepare(opt)
 })

package/src/bin/undeploy-gae.ts

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-import { runScript } from '@naturalcycles/nodejs-lib'
-import yargs from 'yargs'
+import { _yargs, runScript } from '@naturalcycles/nodejs-lib'
 import { undeployGae } from '../deploy/deployGae'
 
 runScript(async () => {
-  const { branch } = yargs.options({
+  const { branch } = _yargs().options({
     branch: {
       type: 'string',
       demandOption: true,

package/src/server/logMiddleware.ts

@@ -3,9 +3,11 @@ import { AnyObject, CommonLogger } from '@naturalcycles/js-lib'
 import { _inspect, dimGrey } from '@naturalcycles/nodejs-lib'
 import { BackendRequestHandler } from './server.model'
 
-const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE } = process.env
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, APP_ENV } = process.env
 const isGAE = !!GAE_INSTANCE
-const isCloudRun = !!K_SERVICE
+// const isCloudRun = !!K_SERVICE
+// const isTest = APP_ENV === 'test'
+const isDev = APP_ENV === 'dev'
 
 // Simple "request counter" (poor man's "correlation id") counter, to use on dev machine (not in the cloud)
 let reqCounter = 0
@@ -68,17 +70,39 @@ function logToCI(args: any[]): void {
 }
 
 export function logMiddleware(): BackendRequestHandler {
-  if (isCloudRun) {
-    // Cloud Run, return simple logger, similar to CI logger
-    return function cloudRunLogHandler(req, _res, next) {
-      req.log = req.warn = req.error = logToCI
+  if (isGAE) {
+    if (GOOGLE_CLOUD_PROJECT) {
+      return function appEngineLogHandler(req, _res, next) {
+        const traceHeader = req.header('x-cloud-trace-context')
+        if (traceHeader) {
+          const [trace] = traceHeader.split('/')
+          const meta = {
+            'logging.googleapis.com/trace': `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`,
+            'appengine.googleapis.com/request_id': req.header('x-appengine-request-log-id'),
+          }
+          Object.assign(req, {
+            log: (...args: any[]) => logToAppEngine({ ...meta, severity: 'INFO' }, args),
+            warn: (...args: any[]) => logToAppEngine({ ...meta, severity: 'WARNING' }, args),
+            error: (...args: any[]) => logToAppEngine({ ...meta, severity: 'ERROR' }, args),
+          })
+          req.requestId = trace
+        } else {
+          Object.assign(req, gaeLogger)
+        }
+
+        next()
+      }
+    }
+
+    return function appEngineLogHandler(req, _res, next) {
+      Object.assign(req, gaeLogger)
       next()
     }
   }
 
-  if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
+  if (isDev) {
     // Local machine, return "simple" logToDev middleware with request numbering
-    return function gaeLogMiddlewareDev(req, _res, next) {
+    return function devLogHandler(req, _res, next) {
       // Local machine
       req.requestId = String(++reqCounter)
       req.log = req.warn = req.error = (...args: any[]) => logToDev(req.requestId!, args)
@@ -86,26 +110,10 @@ export function logMiddleware(): BackendRequestHandler {
     }
   }
 
-  // Otherwise, we're in AppEngine
-
-  return function appEngineLogHandler(req, _res, next) {
-    const traceHeader = req.header('x-cloud-trace-context')
-    if (traceHeader) {
-      const [trace] = traceHeader.split('/')
-      const meta = {
-        'logging.googleapis.com/trace': `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`,
-        'appengine.googleapis.com/request_id': req.header('x-appengine-request-log-id'),
-      }
-      Object.assign(req, {
-        log: (...args: any[]) => logToAppEngine({ ...meta, severity: 'INFO' }, args),
-        warn: (...args: any[]) => logToAppEngine({ ...meta, severity: 'WARNING' }, args),
-        error: (...args: any[]) => logToAppEngine({ ...meta, severity: 'ERROR' }, args),
-      })
-      req.requestId = trace
-    } else {
-      Object.assign(req, gaeLogger)
-    }
-
+  // Otherwise, return "simple" logger
+  // This includes: unit tests, CloudRun, CI environments
+  return function simpleLogHandler(req, _res, next) {
+    req.log = req.warn = req.error = (...args: any[]) => logToCI(args)
     next()
   }
 }