@naturalcycles/backend-lib 9.2.0 → 9.3.1

package/dist/server/asyncLocalStorageMiddleware.js

@@ -1,10 +1,10 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 import { _lazyValue } from '@naturalcycles/js-lib';
-import { ciLogger, devLogger, gaeLogger } from './logMiddleware.js';
-const { GAE_INSTANCE, CI } = process.env;
+import { ciLogger, devLogger, gcpStructuredLogger } from './logMiddleware.js';
+const { GAE_INSTANCE, K_SERVICE, CI } = process.env;
 const isGAE = !!GAE_INSTANCE;
 const isCI = !!CI;
-const isCloudRun = !!CI;
+const isCloudRun = !!K_SERVICE;
 // Singleton, for simplicity
 // Create it lazily (on demand)
 const storage = _lazyValue(() => new AsyncLocalStorage());
@@ -25,7 +25,8 @@ export function getRequest() {
  * @experimental
  */
 export function getRequestLogger() {
-    return (storage().getStore()?.req || (isGAE ? gaeLogger : isCI || isCloudRun ? ciLogger : devLogger));
+    return (storage().getStore()?.req ||
+        (isGAE || isCloudRun ? gcpStructuredLogger : isCI ? ciLogger : devLogger));
 }
 /**
  * CommonLogger implementation that is Request-bound.

package/dist/server/logMiddleware.d.ts

@@ -1,10 +1,10 @@
 import type { CommonLogger } from '@naturalcycles/js-lib';
 import type { BackendRequestHandler } from './server.model.js';
 /**
- * Logger that logs in AppEngine format.
+ * Logger that logs in "GCP structured log" format.
  * To be used in outside-of-request situations (otherwise req.log should be used).
  */
-export declare const gaeLogger: CommonLogger;
+export declare const gcpStructuredLogger: CommonLogger;
 /**
  * Fancy development logger, to be used in outside-of-request situations
  * (otherwise req.log should be used).

package/dist/server/logMiddleware.js

@@ -1,20 +1,20 @@
 import { inspect } from 'node:util';
 import { _inspect, dimGrey } from '@naturalcycles/nodejs-lib';
-const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, APP_ENV } = process.env;
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE, 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;
 /**
- * Logger that logs in AppEngine format.
+ * Logger that logs in "GCP structured log" format.
  * To be used in outside-of-request situations (otherwise req.log should be used).
  */
-export const gaeLogger = {
-    log: (...args) => logToAppEngine({}, args),
-    warn: (...args) => logToAppEngine({ severity: 'WARNING' }, args),
-    error: (...args) => logToAppEngine({ severity: 'ERROR' }, args),
+export const gcpStructuredLogger = {
+    log: (...args) => writeGCPStructuredLog({}, args),
+    warn: (...args) => writeGCPStructuredLog({ severity: 'WARNING' }, args),
+    error: (...args) => writeGCPStructuredLog({ severity: 'ERROR' }, args),
 };
 /**
  * Fancy development logger, to be used in outside-of-request situations
@@ -34,7 +34,8 @@ export const ciLogger = {
     error: (...args) => logToCI(args),
 };
 // Documented here: https://cloud.google.com/logging/docs/structured-logging
-function logToAppEngine(meta, args) {
+// Cloud Run logging: https://cloud.google.com/run/docs/logging
+function writeGCPStructuredLog(meta, args) {
     console.log(JSON.stringify({
         message: args.map(a => (typeof a === 'string' ? a : inspect(a))).join(' '),
         ...meta,
@@ -55,31 +56,29 @@ function logToCI(args) {
     console.log(args.map(a => _inspect(a, { includeErrorStack: true, colors: false })).join(' '));
 }
 export function logMiddleware() {
-    if (isGAE) {
-        if (GOOGLE_CLOUD_PROJECT) {
-            return function appEngineLogHandler(req, _res, next) {
+    if (isGAE || isCloudRun) {
+        return function gcpStructuredLogHandler(req, _res, next) {
+            const meta = {};
+            // CloudRun does NOT have this env variable set,
+            // so you have to set it manually on deployment, like this:
+            // gcloud run deploy my-service \
+            //   --update-env-vars=GOOGLE_CLOUD_PROJECT=$(gcloud config get-value project)
+            if (GOOGLE_CLOUD_PROJECT) {
                 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),
-                    });
+                    meta['logging.googleapis.com/trace'] = `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`;
                     req.requestId = trace;
                 }
-                else {
-                    Object.assign(req, gaeLogger);
-                }
-                next();
-            };
-        }
-        return function appEngineLogHandler(req, _res, next) {
-            Object.assign(req, gaeLogger);
+            }
+            if (isGAE) {
+                meta['appengine.googleapis.com/request_id'] = req.header('x-appengine-request-log-id');
+            }
+            Object.assign(req, {
+                log: (...args) => writeGCPStructuredLog({ ...meta, severity: 'INFO' }, args),
+                warn: (...args) => writeGCPStructuredLog({ ...meta, severity: 'WARNING' }, args),
+                error: (...args) => writeGCPStructuredLog({ ...meta, severity: 'ERROR' }, args),
+            });
             next();
         };
     }
@@ -93,7 +92,7 @@ export function logMiddleware() {
         };
     }
     // Otherwise, return "simple" logger
-    // This includes: unit tests, CloudRun, CI environments
+    // This includes: unit tests, CI environments
     return function simpleLogHandler(req, _res, next) {
         req.log = req.warn = req.error = (...args) => logToCI(args);
         next();

package/dist/server/serverStatusMiddleware.js

@@ -2,7 +2,7 @@ import { _filterNullishValues, localTime } from '@naturalcycles/js-lib';
 import { memoryUsageFull, processSharedUtil } from '@naturalcycles/nodejs-lib';
 import { getDeployInfo } from './deployInfo.util.js';
 const { versions, arch, platform } = process;
-const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, K_SERVICE, K_REVISION, APP_ENV, NODE_OPTIONS } = process.env;
+const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, GOOGLE_CLOUD_PROJECT, K_SERVICE, K_REVISION, APP_ENV, NODE_OPTIONS, } = process.env;
 export function serverStatusMiddleware(projectDir, extra) {
     return async (_req, res) => {
         res.json(getServerStatusData(projectDir, extra));
@@ -18,6 +18,7 @@ export function getServerStatusData(projectDir = process.cwd(), extra) {
         deployBuildTime,
         APP_ENV,
         buildInfo,
+        GOOGLE_CLOUD_PROJECT,
         GAE_APPLICATION,
         GAE_SERVICE,
         GAE_VERSION,

package/dist/server/simpleRequestLoggerMiddleware.d.ts

@@ -9,4 +9,4 @@ export interface SimpleRequestLoggerMiddlewareCfg {
      */
     logFinish: boolean;
 }
-export declare function simpleRequestLoggerMiddleware(_cfg?: Partial<SimpleRequestLoggerMiddlewareCfg>): BackendRequestHandler;
+export declare function simpleRequestLoggerMiddleware(cfg?: Partial<SimpleRequestLoggerMiddlewareCfg>): BackendRequestHandler;

package/dist/server/simpleRequestLoggerMiddleware.js

@@ -3,17 +3,12 @@ import { boldGrey, dimGrey } from '@naturalcycles/nodejs-lib';
 import { onFinished } from '../index.js';
 import { logRequest } from './request.log.util.js';
 const { APP_ENV } = process.env;
-export function simpleRequestLoggerMiddleware(_cfg = {}) {
+export function simpleRequestLoggerMiddleware(cfg = {}) {
     // Disable logger in AppEngine, as it doesn't make sense there
     // UPD: Only log in dev environment
     if (APP_ENV !== 'dev')
         return (_req, _res, next) => next();
-    const cfg = {
-        logStart: false,
-        logFinish: true,
-        ..._cfg,
-    };
-    const { logStart, logFinish } = cfg;
+    const { logStart = false, logFinish = true } = cfg;
     return (req, res, next) => {
         const started = Date.now();
         if (logStart) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.2.0",
+  "version": "9.3.1",
   "peerDependencies": {
     "@sentry/node": "^9"
   },
@@ -69,6 +69,7 @@
     "lint": "dev-lib lint",
     "bt": "dev-lib bt",
     "clean": "dev-lib clean",
+    "check": "dev-lib check",
     "typecheck": "dev-lib typecheck",
     "dev": "APP_ENV=dev tsx watch src/test/server/server.ts",
     "deploy-gae": "tsx src/bin/deploy-gae.ts",

package/src/server/asyncLocalStorageMiddleware.ts

@@ -1,13 +1,13 @@
 import { AsyncLocalStorage } from 'node:async_hooks'
 import type { CommonLogger } from '@naturalcycles/js-lib'
 import { _lazyValue } from '@naturalcycles/js-lib'
-import { ciLogger, devLogger, gaeLogger } from './logMiddleware.js'
+import { ciLogger, devLogger, gcpStructuredLogger } from './logMiddleware.js'
 import type { BackendRequest, BackendRequestHandler } from './server.model.js'
 
-const { GAE_INSTANCE, CI } = process.env
+const { GAE_INSTANCE, K_SERVICE, CI } = process.env
 const isGAE = !!GAE_INSTANCE
 const isCI = !!CI
-const isCloudRun = !!CI
+const isCloudRun = !!K_SERVICE
 
 export interface RequestLocalStorage {
   req: BackendRequest
@@ -38,7 +38,8 @@ export function getRequest(): BackendRequest | undefined {
  */
 export function getRequestLogger(): CommonLogger {
   return (
-    storage().getStore()?.req || (isGAE ? gaeLogger : isCI || isCloudRun ? ciLogger : devLogger)
+    storage().getStore()?.req ||
+    (isGAE || isCloudRun ? gcpStructuredLogger : isCI ? ciLogger : devLogger)
   )
 }
 

package/src/server/logMiddleware.ts

@@ -1,11 +1,11 @@
 import { inspect } from 'node:util'
-import type { AnyObject, CommonLogger } from '@naturalcycles/js-lib'
+import type { AnyObject, CommonLogger, StringMap } from '@naturalcycles/js-lib'
 import { _inspect, dimGrey } from '@naturalcycles/nodejs-lib'
 import type { BackendRequestHandler } from './server.model.js'
 
-const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, APP_ENV } = process.env
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE, 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'
 
@@ -13,13 +13,13 @@ const isDev = APP_ENV === 'dev'
 let reqCounter = 0
 
 /**
- * Logger that logs in AppEngine format.
+ * Logger that logs in "GCP structured log" format.
  * To be used in outside-of-request situations (otherwise req.log should be used).
  */
-export const gaeLogger: CommonLogger = {
-  log: (...args) => logToAppEngine({}, args),
-  warn: (...args) => logToAppEngine({ severity: 'WARNING' }, args),
-  error: (...args) => logToAppEngine({ severity: 'ERROR' }, args),
+export const gcpStructuredLogger: CommonLogger = {
+  log: (...args) => writeGCPStructuredLog({}, args),
+  warn: (...args) => writeGCPStructuredLog({ severity: 'WARNING' }, args),
+  error: (...args) => writeGCPStructuredLog({ severity: 'ERROR' }, args),
 }
 
 /**
@@ -42,7 +42,8 @@ export const ciLogger: CommonLogger = {
 }
 
 // Documented here: https://cloud.google.com/logging/docs/structured-logging
-function logToAppEngine(meta: AnyObject, args: any[]): void {
+// Cloud Run logging: https://cloud.google.com/run/docs/logging
+function writeGCPStructuredLog(meta: AnyObject, args: any[]): void {
   console.log(
     JSON.stringify({
       message: args.map(a => (typeof a === 'string' ? a : inspect(a))).join(' '),
@@ -70,32 +71,32 @@ function logToCI(args: any[]): void {
 }
 
 export function logMiddleware(): BackendRequestHandler {
-  if (isGAE) {
-    if (GOOGLE_CLOUD_PROJECT) {
-      return function appEngineLogHandler(req, _res, next) {
+  if (isGAE || isCloudRun) {
+    return function gcpStructuredLogHandler(req, _res, next) {
+      const meta: StringMap = {}
+
+      // CloudRun does NOT have this env variable set,
+      // so you have to set it manually on deployment, like this:
+      // gcloud run deploy my-service \
+      //   --update-env-vars=GOOGLE_CLOUD_PROJECT=$(gcloud config get-value project)
+      if (GOOGLE_CLOUD_PROJECT) {
         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),
-          })
+          meta['logging.googleapis.com/trace'] = `projects/${GOOGLE_CLOUD_PROJECT}/traces/${trace}`
           req.requestId = trace
-        } else {
-          Object.assign(req, gaeLogger)
         }
-
-        next()
       }
-    }
+      if (isGAE) {
+        meta['appengine.googleapis.com/request_id'] = req.header('x-appengine-request-log-id')
+      }
+
+      Object.assign(req, {
+        log: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'INFO' }, args),
+        warn: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'WARNING' }, args),
+        error: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'ERROR' }, args),
+      })
 
-    return function appEngineLogHandler(req, _res, next) {
-      Object.assign(req, gaeLogger)
       next()
     }
   }
@@ -111,7 +112,7 @@ export function logMiddleware(): BackendRequestHandler {
   }
 
   // Otherwise, return "simple" logger
-  // This includes: unit tests, CloudRun, CI environments
+  // This includes: unit tests, CI environments
   return function simpleLogHandler(req, _res, next) {
     req.log = req.warn = req.error = (...args: any[]) => logToCI(args)
     next()

package/src/server/serverStatusMiddleware.ts

@@ -4,8 +4,16 @@ import { getDeployInfo } from './deployInfo.util.js'
 import type { BackendRequestHandler } from './server.model.js'
 
 const { versions, arch, platform } = process
-const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, K_SERVICE, K_REVISION, APP_ENV, NODE_OPTIONS } =
-  process.env
+const {
+  GAE_APPLICATION,
+  GAE_SERVICE,
+  GAE_VERSION,
+  GOOGLE_CLOUD_PROJECT,
+  K_SERVICE,
+  K_REVISION,
+  APP_ENV,
+  NODE_OPTIONS,
+} = process.env
 
 export function serverStatusMiddleware(projectDir?: string, extra?: any): BackendRequestHandler {
   return async (_req, res) => {
@@ -27,6 +35,7 @@ export function getServerStatusData(
     deployBuildTime,
     APP_ENV,
     buildInfo,
+    GOOGLE_CLOUD_PROJECT,
     GAE_APPLICATION,
     GAE_SERVICE,
     GAE_VERSION,

package/src/server/simpleRequestLoggerMiddleware.ts

@@ -20,18 +20,13 @@ export interface SimpleRequestLoggerMiddlewareCfg {
 }
 
 export function simpleRequestLoggerMiddleware(
-  _cfg: Partial<SimpleRequestLoggerMiddlewareCfg> = {},
+  cfg: Partial<SimpleRequestLoggerMiddlewareCfg> = {},
 ): BackendRequestHandler {
   // Disable logger in AppEngine, as it doesn't make sense there
   // UPD: Only log in dev environment
   if (APP_ENV !== 'dev') return (_req, _res, next) => next()
 
-  const cfg: SimpleRequestLoggerMiddlewareCfg = {
-    logStart: false,
-    logFinish: true,
-    ..._cfg,
-  }
-  const { logStart, logFinish } = cfg
+  const { logStart = false, logFinish = true } = cfg
 
   return (req, res, next) => {
     const started = Date.now() as UnixTimestampMillis