@naturalcycles/backend-lib 4.6.0 → 4.7.0

package/dist/server/appEngineLogMiddleware.d.ts

@@ -10,4 +10,8 @@ export declare const gaeLogger: CommonLogger;
  * (otherwise req.log should be used).
  */
 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;

package/dist/server/appEngineLogMiddleware.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.appEngineLogMiddleware = exports.devLogger = exports.gaeLogger = void 0;
+exports.appEngineLogMiddleware = exports.ciLogger = exports.devLogger = exports.gaeLogger = void 0;
 const util_1 = require("util");
 const colors_1 = require("@naturalcycles/nodejs-lib/dist/colors");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
@@ -26,6 +26,14 @@ exports.devLogger = {
     warn: (...args) => logToDev(null, args),
     error: (...args) => logToDev(null, args),
 };
+/**
+ * Same as devLogger, but without colors (e.g to not confuse Sentry).
+ */
+exports.ciLogger = {
+    log: (...args) => logToCI(args),
+    warn: (...args) => logToCI(args),
+    error: (...args) => logToCI(args),
+};
 // Documented here: https://cloud.google.com/logging/docs/structured-logging
 function logToAppEngine(meta, args) {
     console.log(JSON.stringify({
@@ -40,6 +48,13 @@ function logToDev(requestId, args) {
         ...args.map(a => (0, nodejs_lib_1.inspectAny)(a, { includeErrorStack: true, colors: true })),
     ].join(' '));
 }
+/**
+ * Same as logToDev, but without request and without colors.
+ * This is to not confuse e.g Sentry when it picks up messages with colors
+ */
+function logToCI(args) {
+    console.log(args.map(a => (0, nodejs_lib_1.inspectAny)(a, { includeErrorStack: true, colors: false })).join(' '));
+}
 function appEngineLogMiddleware() {
     if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
         // Local machine, return "simple" logToDev middleware with request numbering

package/dist/server/asyncLocalStorageMiddleware.js

@@ -4,8 +4,9 @@ exports.requestLogger = exports.getRequestLogger = exports.getRequest = exports.
 const async_hooks_1 = require("async_hooks");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const appEngineLogMiddleware_1 = require("./appEngineLogMiddleware");
-const { GAE_INSTANCE } = process.env;
+const { GAE_INSTANCE, CI } = process.env;
 const isGAE = !!GAE_INSTANCE;
+const isCI = !!CI;
 // Singleton, for simplicity
 // Create it lazily (on demand)
 const storage = (0, js_lib_1._lazyValue)(() => new async_hooks_1.AsyncLocalStorage());
@@ -28,7 +29,7 @@ exports.getRequest = getRequest;
  * @experimental
  */
 function getRequestLogger() {
-    return storage().getStore()?.req || (isGAE ? appEngineLogMiddleware_1.gaeLogger : appEngineLogMiddleware_1.devLogger);
+    return storage().getStore()?.req || (isGAE ? appEngineLogMiddleware_1.gaeLogger : isCI ? appEngineLogMiddleware_1.ciLogger : appEngineLogMiddleware_1.devLogger);
 }
 exports.getRequestLogger = getRequestLogger;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",

package/src/server/appEngineLogMiddleware.ts

@@ -30,6 +30,15 @@ export const devLogger: CommonLogger = {
   error: (...args) => logToDev(null, args),
 }
 
+/**
+ * Same as devLogger, but without colors (e.g to not confuse Sentry).
+ */
+export const ciLogger: CommonLogger = {
+  log: (...args) => logToCI(args),
+  warn: (...args) => logToCI(args),
+  error: (...args) => logToCI(args),
+}
+
 // Documented here: https://cloud.google.com/logging/docs/structured-logging
 function logToAppEngine(meta: AnyObject, args: any[]): void {
   console.log(
@@ -50,6 +59,14 @@ function logToDev(requestId: string | null, args: any[]): void {
   )
 }
 
+/**
+ * Same as logToDev, but without request and without colors.
+ * This is to not confuse e.g Sentry when it picks up messages with colors
+ */
+function logToCI(args: any[]): void {
+  console.log(args.map(a => inspectAny(a, { includeErrorStack: true, colors: false })).join(' '))
+}
+
 export function appEngineLogMiddleware(): BackendRequestHandler {
   if (!isGAE || !GOOGLE_CLOUD_PROJECT) {
     // Local machine, return "simple" logToDev middleware with request numbering

package/src/server/asyncLocalStorageMiddleware.ts

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