@naturalcycles/backend-lib 9.30.2 → 9.31.0

package/dist/cloudrun/cloudRun.util.d.ts

@@ -13,7 +13,7 @@ export interface CloudRunDeployInfo {
     cloudRunRegion: string;
     sqlInstance?: string;
     vpcConnector?: string;
-    serviceUrl: string;
+    serviceUrl?: string;
     /**
      * Service URL that is used to access the service externally (through load balancer)
      * todo: overlaps with env.K_EXTERNAL_URL

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

@@ -96,6 +96,7 @@ export class SentrySharedService {
      */
     getCommonLogger() {
         return {
+            debug: () => { }, // noop
             log: () => { }, // noop
             warn: () => { }, // noop
             error: (...args) => {

package/dist/server/asyncLocalStorageMiddleware.js

@@ -38,6 +38,7 @@ export function getRequestLogger() {
  * @experimental
  */
 export const requestLogger = {
+    debug: (...args) => getRequestLogger().debug(...args),
     log: (...args) => getRequestLogger().log(...args),
     warn: (...args) => getRequestLogger().warn(...args),
     error: (...args) => getRequestLogger().error(...args),

package/dist/server/logMiddleware.js

@@ -1,4 +1,5 @@
 import { inspect } from 'node:util';
+import { _objectAssign } from '@naturalcycles/js-lib/types';
 import { _inspect } from '@naturalcycles/nodejs-lib';
 import { dimGrey } from '@naturalcycles/nodejs-lib/colors';
 const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE, APP_ENV } = process.env;
@@ -13,6 +14,7 @@ let reqCounter = 0;
  * To be used in outside-of-request situations (otherwise req.log should be used).
  */
 export const gcpStructuredLogger = {
+    debug: (...args) => writeGCPStructuredLog({ severity: 'DEBUG' }, args),
     log: (...args) => writeGCPStructuredLog({}, args),
     warn: (...args) => writeGCPStructuredLog({ severity: 'WARNING' }, args),
     error: (...args) => writeGCPStructuredLog({ severity: 'ERROR' }, args),
@@ -22,6 +24,7 @@ export const gcpStructuredLogger = {
  * (otherwise req.log should be used).
  */
 export const devLogger = {
+    debug: (...args) => logToDev(null, args),
     log: (...args) => logToDev(null, args),
     warn: (...args) => logToDev(null, args),
     error: (...args) => logToDev(null, args),
@@ -30,6 +33,7 @@ export const devLogger = {
  * Same as devLogger, but without colors (e.g to not confuse Sentry).
  */
 export const ciLogger = {
+    debug: (...args) => logToCI(args),
     log: (...args) => logToCI(args),
     warn: (...args) => logToCI(args),
     error: (...args) => logToCI(args),
@@ -81,7 +85,8 @@ export function logMiddleware() {
             if (isGAE) {
                 meta['appengine.googleapis.com/request_id'] = req.header('x-appengine-request-log-id');
             }
-            Object.assign(req, {
+            _objectAssign(req, {
+                debug: (...args) => writeGCPStructuredLog({ ...meta, severity: 'DEBUG' }, args),
                 log: (...args) => writeGCPStructuredLog({ ...meta, severity: 'INFO' }, args),
                 warn: (...args) => writeGCPStructuredLog({ ...meta, severity: 'WARNING' }, args),
                 error: (...args) => writeGCPStructuredLog({ ...meta, severity: 'ERROR' }, args),
@@ -94,14 +99,18 @@ export function logMiddleware() {
         return function devLogHandler(req, _res, next) {
             // Local machine
             req.requestId = String(++reqCounter);
-            req.log = req.warn = req.error = (...args) => logToDev(req.requestId, args);
+            req.debug =
+                req.log =
+                    req.warn =
+                        req.error =
+                            (...args) => logToDev(req.requestId, args);
             next();
         };
     }
     // Otherwise, return "simple" logger
     // This includes: unit tests, CI environments
     return function simpleLogHandler(req, _res, next) {
-        req.log = req.warn = req.error = (...args) => logToCI(args);
+        req.debug = req.log = req.warn = req.error = (...args) => logToCI(args);
         next();
     };
 }

package/dist/server/server.model.d.ts

@@ -9,6 +9,7 @@ import type { Application, IRouter, NextFunction, Request, Response } from 'expr
  * Previous name `ExpressRequest` was clashing with Sentry.
  */
 export interface BackendRequest extends Request {
+    debug: CommonLogFunction;
     log: CommonLogFunction;
     warn: CommonLogFunction;
     error: CommonLogFunction;
@@ -31,6 +32,7 @@ export type BackendRouter = IRouter;
 export type BackendApplication = Application;
 declare module 'http' {
     interface IncomingMessage {
+        debug: CommonLogFunction;
         log: CommonLogFunction;
         warn: CommonLogFunction;
         error: CommonLogFunction;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.30.2",
+  "version": "9.31.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },

package/src/cloudrun/cloudRun.util.ts

@@ -26,7 +26,7 @@ export interface CloudRunDeployInfo {
   //
   // Urls
   //
-  serviceUrl: string
+  serviceUrl?: string
   /**
    * Service URL that is used to access the service externally (through load balancer)
    * todo: overlaps with env.K_EXTERNAL_URL

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

@@ -123,6 +123,7 @@ export class SentrySharedService {
    */
   getCommonLogger(): CommonLogger {
     return {
+      debug: () => {}, // noop
       log: () => {}, // noop
       warn: () => {}, // noop
       error: (...args) => {

package/src/server/asyncLocalStorageMiddleware.ts

@@ -53,6 +53,7 @@ export function getRequestLogger(): CommonLogger {
  * @experimental
  */
 export const requestLogger: CommonLogger = {
+  debug: (...args) => getRequestLogger().debug(...args),
   log: (...args) => getRequestLogger().log(...args),
   warn: (...args) => getRequestLogger().warn(...args),
   error: (...args) => getRequestLogger().error(...args),

package/src/server/logMiddleware.ts

@@ -1,6 +1,6 @@
 import { inspect } from 'node:util'
 import type { CommonLogger } from '@naturalcycles/js-lib/log'
-import type { AnyObject } from '@naturalcycles/js-lib/types'
+import { _objectAssign, type AnyObject } from '@naturalcycles/js-lib/types'
 import { _inspect } from '@naturalcycles/nodejs-lib'
 import { dimGrey } from '@naturalcycles/nodejs-lib/colors'
 import type { BackendRequestHandler } from './server.model.js'
@@ -19,6 +19,7 @@ let reqCounter = 0
  * To be used in outside-of-request situations (otherwise req.log should be used).
  */
 export const gcpStructuredLogger: CommonLogger = {
+  debug: (...args) => writeGCPStructuredLog({ severity: 'DEBUG' }, args),
   log: (...args) => writeGCPStructuredLog({}, args),
   warn: (...args) => writeGCPStructuredLog({ severity: 'WARNING' }, args),
   error: (...args) => writeGCPStructuredLog({ severity: 'ERROR' }, args),
@@ -29,6 +30,7 @@ export const gcpStructuredLogger: CommonLogger = {
  * (otherwise req.log should be used).
  */
 export const devLogger: CommonLogger = {
+  debug: (...args) => logToDev(null, args),
   log: (...args) => logToDev(null, args),
   warn: (...args) => logToDev(null, args),
   error: (...args) => logToDev(null, args),
@@ -38,6 +40,7 @@ export const devLogger: CommonLogger = {
  * Same as devLogger, but without colors (e.g to not confuse Sentry).
  */
 export const ciLogger: CommonLogger = {
+  debug: (...args) => logToCI(args),
   log: (...args) => logToCI(args),
   warn: (...args) => logToCI(args),
   error: (...args) => logToCI(args),
@@ -99,11 +102,12 @@ export function logMiddleware(): BackendRequestHandler {
         meta['appengine.googleapis.com/request_id'] = req.header('x-appengine-request-log-id')
       }
 
-      Object.assign(req, {
+      _objectAssign(req, {
+        debug: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'DEBUG' }, args),
         log: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'INFO' }, args),
         warn: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'WARNING' }, args),
         error: (...args: any[]) => writeGCPStructuredLog({ ...meta, severity: 'ERROR' }, args),
-      })
+      } satisfies CommonLogger)
 
       next()
     }
@@ -114,7 +118,11 @@ export function logMiddleware(): BackendRequestHandler {
     return function devLogHandler(req, _res, next) {
       // Local machine
       req.requestId = String(++reqCounter)
-      req.log = req.warn = req.error = (...args: any[]) => logToDev(req.requestId!, args)
+      req.debug =
+        req.log =
+        req.warn =
+        req.error =
+          (...args: any[]) => logToDev(req.requestId!, args)
       next()
     }
   }
@@ -122,7 +130,7 @@ export function logMiddleware(): BackendRequestHandler {
   // Otherwise, return "simple" logger
   // This includes: unit tests, CI environments
   return function simpleLogHandler(req, _res, next) {
-    req.log = req.warn = req.error = (...args: any[]) => logToCI(args)
+    req.debug = req.log = req.warn = req.error = (...args: any[]) => logToCI(args)
     next()
   }
 }

package/src/server/server.model.ts

@@ -10,6 +10,7 @@ import type { Application, IRouter, NextFunction, Request, Response } from 'expr
  * Previous name `ExpressRequest` was clashing with Sentry.
  */
 export interface BackendRequest extends Request {
+  debug: CommonLogFunction
   log: CommonLogFunction
   warn: CommonLogFunction
   error: CommonLogFunction
@@ -49,6 +50,7 @@ export type BackendApplication = Application
 
 declare module 'http' {
   interface IncomingMessage {
+    debug: CommonLogFunction
     log: CommonLogFunction
     warn: CommonLogFunction
     error: CommonLogFunction