@naturalcycles/backend-lib 7.0.0 → 7.1.0

package/dist/index.d.ts

@@ -4,9 +4,7 @@ export * from './admin/base.admin.service';
 export * from './admin/firebase.shared.service';
 export * from './admin/secureHeaderMiddleware';
 export * from './env/env.shared.service';
-export * from './gae/appEngine.util';
 export * from './sentry/sentry.shared.service';
-export * from './server/appEngineLogMiddleware';
 export * from './server/asyncLocalStorageMiddleware';
 export * from './server/basicAuthMiddleware';
 export * from './server/bodyParserTimeoutMiddleware';
@@ -16,6 +14,7 @@ export * from './server/createDefaultApp.model';
 export * from './server/deployInfo.util';
 export * from './server/genericErrorMiddleware';
 export * from './server/getDefaultRouter';
+export * from './server/logMiddleware';
 export * from './server/methodOverrideMiddleware';
 export * from './server/notFoundMiddleware';
 export * from './server/okMiddleware';
@@ -32,4 +31,5 @@ export * from './server/startServer.model';
 export * from './server/validation/validateMiddleware';
 export * from './server/validation/validateRequest';
 export * from './server/validation/zodValidateMiddleware';
+export * from './util';
 export { onFinished };

package/dist/index.js

@@ -9,9 +9,7 @@ tslib_1.__exportStar(require("./admin/base.admin.service"), exports);
 tslib_1.__exportStar(require("./admin/firebase.shared.service"), exports);
 tslib_1.__exportStar(require("./admin/secureHeaderMiddleware"), exports);
 tslib_1.__exportStar(require("./env/env.shared.service"), exports);
-tslib_1.__exportStar(require("./gae/appEngine.util"), exports);
 tslib_1.__exportStar(require("./sentry/sentry.shared.service"), exports);
-tslib_1.__exportStar(require("./server/appEngineLogMiddleware"), exports);
 tslib_1.__exportStar(require("./server/asyncLocalStorageMiddleware"), exports);
 tslib_1.__exportStar(require("./server/basicAuthMiddleware"), exports);
 tslib_1.__exportStar(require("./server/bodyParserTimeoutMiddleware"), exports);
@@ -21,6 +19,7 @@ tslib_1.__exportStar(require("./server/createDefaultApp.model"), exports);
 tslib_1.__exportStar(require("./server/deployInfo.util"), exports);
 tslib_1.__exportStar(require("./server/genericErrorMiddleware"), exports);
 tslib_1.__exportStar(require("./server/getDefaultRouter"), exports);
+tslib_1.__exportStar(require("./server/logMiddleware"), exports);
 tslib_1.__exportStar(require("./server/methodOverrideMiddleware"), exports);
 tslib_1.__exportStar(require("./server/notFoundMiddleware"), exports);
 tslib_1.__exportStar(require("./server/okMiddleware"), exports);
@@ -37,3 +36,4 @@ tslib_1.__exportStar(require("./server/startServer.model"), exports);
 tslib_1.__exportStar(require("./server/validation/validateMiddleware"), exports);
 tslib_1.__exportStar(require("./server/validation/validateRequest"), exports);
 tslib_1.__exportStar(require("./server/validation/zodValidateMiddleware"), exports);
+tslib_1.__exportStar(require("./util"), exports);

package/dist/server/asyncLocalStorageMiddleware.js

@@ -6,10 +6,11 @@ exports.getRequest = getRequest;
 exports.getRequestLogger = getRequestLogger;
 const node_async_hooks_1 = require("node:async_hooks");
 const js_lib_1 = require("@naturalcycles/js-lib");
-const appEngineLogMiddleware_1 = require("./appEngineLogMiddleware");
+const logMiddleware_1 = require("./logMiddleware");
 const { GAE_INSTANCE, CI } = process.env;
 const isGAE = !!GAE_INSTANCE;
 const isCI = !!CI;
+const isCloudRun = !!CI;
 // Singleton, for simplicity
 // Create it lazily (on demand)
 const storage = (0, js_lib_1._lazyValue)(() => new node_async_hooks_1.AsyncLocalStorage());
@@ -30,7 +31,7 @@ function getRequest() {
  * @experimental
  */
 function getRequestLogger() {
-    return storage().getStore()?.req || (isGAE ? appEngineLogMiddleware_1.gaeLogger : isCI ? appEngineLogMiddleware_1.ciLogger : appEngineLogMiddleware_1.devLogger);
+    return (storage().getStore()?.req || (isGAE ? logMiddleware_1.gaeLogger : isCI || isCloudRun ? logMiddleware_1.ciLogger : logMiddleware_1.devLogger));
 }
 /**
  * CommonLogger implementation that is Request-bound.

package/dist/server/createDefaultApp.js

@@ -5,9 +5,9 @@ const cookieParser = require("cookie-parser");
 const cors = require("cors");
 const express = require("express");
 const __1 = require("..");
-const appEngineLogMiddleware_1 = require("./appEngineLogMiddleware");
 const asyncLocalStorageMiddleware_1 = require("./asyncLocalStorageMiddleware");
 const genericErrorMiddleware_1 = require("./genericErrorMiddleware");
+const logMiddleware_1 = require("./logMiddleware");
 const notFoundMiddleware_1 = require("./notFoundMiddleware");
 const requestTimeoutMiddleware_1 = require("./requestTimeoutMiddleware");
 const simpleRequestLoggerMiddleware_1 = require("./simpleRequestLoggerMiddleware");
@@ -20,7 +20,7 @@ function createDefaultApp(cfg) {
     app.set('trust proxy', true);
     // preHandlers
     useHandlers(app, cfg.preHandlers);
-    app.use((0, appEngineLogMiddleware_1.appEngineLogMiddleware)());
+    app.use((0, logMiddleware_1.logMiddleware)());
     if (!isTest) {
         app.use((0, asyncLocalStorageMiddleware_1.asyncLocalStorageMiddleware)());
     }

package/dist/server/{appEngineLogMiddleware.d.ts → logMiddleware.d.ts}

@@ -14,4 +14,4 @@ export declare const devLogger: CommonLogger;
  * Same as devLogger, but without colors (e.g to not confuse Sentry).
  */
 export declare const ciLogger: CommonLogger;
-export declare function appEngineLogMiddleware(): BackendRequestHandler;
+export declare function logMiddleware(): BackendRequestHandler;

package/dist/server/{appEngineLogMiddleware.js → logMiddleware.js}

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ciLogger = exports.devLogger = exports.gaeLogger = void 0;
-exports.appEngineLogMiddleware = appEngineLogMiddleware;
+exports.logMiddleware = logMiddleware;
 const node_util_1 = require("node:util");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE } = process.env;
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE } = process.env;
 const isGAE = !!GAE_INSTANCE;
+const isCloudRun = !!K_SERVICE;
 // Simple "request counter" (poor man's "correlation id") counter, to use on dev machine (not in the cloud)
 let reqCounter = 0;
 /**
@@ -55,7 +56,14 @@ function logToDev(requestId, args) {
 function logToCI(args) {
     console.log(args.map(a => (0, nodejs_lib_1._inspect)(a, { includeErrorStack: true, colors: false })).join(' '));
 }
-function appEngineLogMiddleware() {
+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;
+            next();
+        };
+    }
     if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
         // Local machine, return "simple" logToDev middleware with request numbering
         return function gaeLogMiddlewareDev(req, _res, next) {

package/dist/server/serverStatusMiddleware.js

@@ -5,8 +5,8 @@ exports.getServerStatusData = getServerStatusData;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const deployInfo_util_1 = require("./deployInfo.util");
-const { versions } = process;
-const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, APP_ENV, NODE_OPTIONS } = process.env;
+const { versions, arch, platform } = process;
+const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, K_SERVICE, K_REVISION, APP_ENV, NODE_OPTIONS } = process.env;
 function serverStatusMiddleware(projectDir, extra) {
     return async (_req, res) => {
         res.json(getServerStatusData(projectDir, extra));
@@ -17,7 +17,6 @@ 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,
@@ -26,6 +25,8 @@ function getServerStatusData(projectDir = process.cwd(), extra) {
         GAE_APPLICATION,
         GAE_SERVICE,
         GAE_VERSION,
+        K_SERVICE,
+        K_REVISION,
         processInfo: {
             arch,
             platform,

package/dist/util.d.ts

@@ -0,0 +1,2 @@
+export declare function isGAE(): boolean;
+export declare function isCloudRun(): boolean;

package/dist/{gae/appEngine.util.js → util.js}

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isGAE = isGAE;
-const { GAE_INSTANCE } = process.env;
+exports.isCloudRun = isCloudRun;
+const { GAE_INSTANCE, K_SERVICE } = process.env;
 function isGAE() {
     return !!GAE_INSTANCE;
 }
+function isCloudRun() {
+    return !!K_SERVICE;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/index.ts

@@ -4,9 +4,7 @@ export * from './admin/base.admin.service'
 export * from './admin/firebase.shared.service'
 export * from './admin/secureHeaderMiddleware'
 export * from './env/env.shared.service'
-export * from './gae/appEngine.util'
 export * from './sentry/sentry.shared.service'
-export * from './server/appEngineLogMiddleware'
 export * from './server/asyncLocalStorageMiddleware'
 export * from './server/basicAuthMiddleware'
 export * from './server/bodyParserTimeoutMiddleware'
@@ -16,6 +14,7 @@ export * from './server/createDefaultApp.model'
 export * from './server/deployInfo.util'
 export * from './server/genericErrorMiddleware'
 export * from './server/getDefaultRouter'
+export * from './server/logMiddleware'
 export * from './server/methodOverrideMiddleware'
 export * from './server/notFoundMiddleware'
 export * from './server/okMiddleware'
@@ -32,5 +31,6 @@ export * from './server/startServer.model'
 export * from './server/validation/validateMiddleware'
 export * from './server/validation/validateRequest'
 export * from './server/validation/zodValidateMiddleware'
+export * from './util'
 
 export { onFinished }

package/src/server/asyncLocalStorageMiddleware.ts

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

package/src/server/createDefaultApp.ts

@@ -2,7 +2,6 @@ import cookieParser = require('cookie-parser')
 import cors = require('cors')
 import express = require('express')
 import { BackendApplication, isGAE, methodOverrideMiddleware } from '..'
-import { appEngineLogMiddleware } from './appEngineLogMiddleware'
 import { asyncLocalStorageMiddleware } from './asyncLocalStorageMiddleware'
 import {
   BackendRequestHandlerCfg,
@@ -10,6 +9,7 @@ import {
   DefaultAppCfg,
 } from './createDefaultApp.model'
 import { genericErrorMiddleware } from './genericErrorMiddleware'
+import { logMiddleware } from './logMiddleware'
 import { notFoundMiddleware } from './notFoundMiddleware'
 import { requestTimeoutMiddleware } from './requestTimeoutMiddleware'
 import { simpleRequestLoggerMiddleware } from './simpleRequestLoggerMiddleware'
@@ -28,7 +28,7 @@ export function createDefaultApp(cfg: DefaultAppCfg): BackendApplication {
   // preHandlers
   useHandlers(app, cfg.preHandlers)
 
-  app.use(appEngineLogMiddleware())
+  app.use(logMiddleware())
 
   if (!isTest) {
     app.use(asyncLocalStorageMiddleware())

package/src/server/{appEngineLogMiddleware.ts → logMiddleware.ts}

@@ -3,8 +3,9 @@ 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 } = process.env
+const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE } = process.env
 const isGAE = !!GAE_INSTANCE
+const isCloudRun = !!K_SERVICE
 
 // Simple "request counter" (poor man's "correlation id") counter, to use on dev machine (not in the cloud)
 let reqCounter = 0
@@ -66,7 +67,15 @@ function logToCI(args: any[]): void {
   console.log(args.map(a => _inspect(a, { includeErrorStack: true, colors: false })).join(' '))
 }
 
-export function appEngineLogMiddleware(): BackendRequestHandler {
+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
+      next()
+    }
+  }
+
   if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
     // Local machine, return "simple" logToDev middleware with request numbering
     return function gaeLogMiddlewareDev(req, _res, next) {

package/src/server/serverStatusMiddleware.ts

@@ -3,8 +3,9 @@ import { memoryUsageFull, processSharedUtil } from '@naturalcycles/nodejs-lib'
 import { getDeployInfo } from './deployInfo.util'
 import { BackendRequestHandler } from './server.model'
 
-const { versions } = process
-const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, APP_ENV, NODE_OPTIONS } = process.env
+const { versions, arch, platform } = process
+const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, K_SERVICE, K_REVISION, APP_ENV, NODE_OPTIONS } =
+  process.env
 
 export function serverStatusMiddleware(projectDir?: string, extra?: any): BackendRequestHandler {
   return async (_req, res) => {
@@ -21,8 +22,6 @@ 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,
@@ -31,6 +30,8 @@ export function getServerStatusData(
     GAE_APPLICATION,
     GAE_SERVICE,
     GAE_VERSION,
+    K_SERVICE,
+    K_REVISION,
     processInfo: {
       arch,
       platform,

package/src/util.ts

@@ -0,0 +1,9 @@
+const { GAE_INSTANCE, K_SERVICE } = process.env
+
+export function isGAE(): boolean {
+  return !!GAE_INSTANCE
+}
+
+export function isCloudRun(): boolean {
+  return !!K_SERVICE
+}

package/dist/gae/appEngine.util.d.ts

@@ -1 +0,0 @@
-export declare function isGAE(): boolean;

package/src/gae/appEngine.util.ts

@@ -1,5 +0,0 @@
-const { GAE_INSTANCE } = process.env
-
-export function isGAE(): boolean {
-  return !!GAE_INSTANCE
-}