feat(serializers): wrap breaking changes in future

pinojs · Dec 9, 2024 · da9a16f · da9a16f
1 parent ebd84c3
commit da9a16f
Show file tree

Hide file tree

Showing 6 changed files with 283 additions and 131 deletions.
diff --git a/lib/proto.js b/lib/proto.js
@@ -195,6 +195,7 @@ function write (_obj, msg, num) {
   const responseKey = this[responseKeySym]
   const messageKey = this[messageKeySym]
   const mixinMergeStrategy = this[mixinMergeStrategySym] || defaultMixinMergeStrategy
+  const future = this[futureSym]
   let obj
 
   if (_obj === undefined || _obj === null) {
@@ -205,9 +206,13 @@ function write (_obj, msg, num) {
       msg = _obj.message
     }
   } else if (_obj.method && _obj.headers && _obj.socket) {
-    obj = { [requestKey]: _obj }
+    if (future.skipUnconditionalStdSerializers) {
+      obj = { [requestKey]: _obj }
+    }
   } else if (typeof _obj.setHeader === 'function') {
-    obj = { [responseKey]: _obj }
+    if (future.skipUnconditionalStdSerializers) {
+      obj = { [responseKey]: _obj }
+    }
   } else {
     obj = _obj
     if (msg === undefined && _obj[messageKey] === undefined && _obj[errorKey]) {

diff --git a/lib/symbols.js b/lib/symbols.js
@@ -25,12 +25,12 @@ const endSym = Symbol('pino.end')
 const formatOptsSym = Symbol('pino.formatOpts')
 const messageKeySym = Symbol('pino.messageKey')
 const errorKeySym = Symbol('pino.errorKey')
+const requestKeySym = Symbol('pino.requestKey')
+const responseKeySym = Symbol('pino.responseKey')
 const nestedKeySym = Symbol('pino.nestedKey')
 const nestedKeyStrSym = Symbol('pino.nestedKeyStr')
 const mixinMergeStrategySym = Symbol('pino.mixinMergeStrategy')
 const msgPrefixSym = Symbol('pino.msgPrefix')
-const responseKeySym = Symbol('pino.responseKey')
-const requestKeySym = Symbol('pino.requestKey')
 const futureSym = Symbol('pino.future')
 
 const wildcardFirstSym = Symbol('pino.wildcardFirst')
@@ -65,8 +65,8 @@ module.exports = {
   formatOptsSym,
   messageKeySym,
   errorKeySym,
-  responseKeySym,
   requestKeySym,
+  responseKeySym,
   nestedKeySym,
   wildcardFirstSym,
   needsMetadataGsym,

diff --git a/lib/tools.js b/lib/tools.js
@@ -3,6 +3,7 @@
 /* eslint no-prototype-builtins: 0 */
 
 const format = require('quick-format-unescaped')
+const { mapHttpRequest, mapHttpResponse } = require('pino-std-serializers')
 const SonicBoom = require('sonic-boom')
 const onExit = require('on-exit-leak-free')
 const {
@@ -23,10 +24,12 @@ const {
   requestKeySym,
   responseKeySym,
   nestedKeyStrSym,
-  msgPrefixSym
+  msgPrefixSym,
+  futureSym
 } = require('./symbols')
 const { isMainThread } = require('worker_threads')
 const transport = require('./transport')
+const { warning } = require('./deprecations')
 
 function noop () {
 }
@@ -41,6 +44,16 @@ function genLog (level, hook) {
   function LOG (o, ...n) {
     if (typeof o === 'object') {
       let msg = o
+      if (!this[futureSym].skipUnconditionalStdSerializers) {
+        warning.PINODEP010()
+        if (o !== null) {
+          if (o.method && o.headers && o.socket) {
+            o = mapHttpRequest(o)
+          } else if (typeof o.setHeader === 'function') {
+            o = mapHttpResponse(o)
+          }
+        }
+      }
       let formatParams
       if (msg === null && n.length === 0) {
         formatParams = [null]
@@ -128,9 +141,9 @@ function asJson (obj, msg, num, time) {
         value = serializers[key](value)
       } else if (key === errorKey && serializers.err) {
         value = serializers.err(value)
-      } else if (key === requestKey && serializers.req) {
+      } else if (key === requestKey && serializers.req && this[futureSym].skipUnconditionalStdSerializers) {
         value = serializers.req(value)
-      } else if (key === responseKey && serializers.res) {
+      } else if (key === responseKey && serializers.res && this[futureSym].skipUnconditionalStdSerializers) {
         value = serializers.res(value)
       }
 
@@ -316,7 +329,7 @@ function createArgsNormalizer (defaultOptions) {
       stream = transport({ caller, ...opts.transport, levels: customLevels })
     }
     opts = Object.assign({}, defaultOptions, opts)
-    opts.serializers = Object.assign({}, defaultOptions.serializers, opts.serializers)
+
     opts.formatters = Object.assign({}, defaultOptions.formatters, opts.formatters)
 
     if (opts.prettyPrint) {

diff --git a/pino.js b/pino.js
@@ -53,9 +53,7 @@ const {
 const { epochTime, nullTime } = time
 const { pid } = process
 const hostname = os.hostname()
-const defaultErrorSerializer = stdSerializers.err
-const defaultRequestSerializer = stdSerializers.req
-const defaultResponseSerializer = stdSerializers.res
+
 const defaultOptions = {
   level: 'info',
   levelComparison: SORTING_ORDER.ASC,
@@ -67,11 +65,6 @@ const defaultOptions = {
   nestedKey: null,
   enabled: true,
   base: { pid, hostname },
-  serializers: Object.assign(Object.create(null), {
-    err: defaultErrorSerializer,
-    req: defaultRequestSerializer,
-    res: defaultResponseSerializer
-  }),
   formatters: Object.assign(Object.create(null), {
     bindings (bindings) {
       return bindings
@@ -95,8 +88,6 @@ const defaultOptions = {
 
 const normalize = createArgsNormalizer(defaultOptions)
 
-const serializers = Object.assign(Object.create(null), stdSerializers)
-
 function pino (...args) {
   const instance = {}
   const { opts, stream } = normalize(instance, caller(), ...args)
@@ -110,8 +101,8 @@ function pino (...args) {
     timestamp,
     messageKey,
     errorKey,
-    requestKey,
     responseKey,
+    requestKey,
     nestedKey,
     base,
     name,
@@ -130,7 +121,13 @@ function pino (...args) {
     future
   } = opts
 
-  const futureSafe = Object.assign(Object.create(null), defaultFuture, future)
+  // future is made immutable, as it impacts other settings
+  const futureSafe = Object.freeze(Object.assign(Object.create(null), defaultFuture, future))
+
+  const defaultSerializers = futureSafe.skipUnconditionalStdSerializers
+    ? { err: stdSerializers.err, req: stdSerializers.req, res: stdSerializers.res }
+    : { err: stdSerializers.err }
+  const serializersSafe = Object.assign(Object.create(null), defaultSerializers, serializers)
 
   const stringifySafe = configure({
     maximumDepth: depthLimit,
@@ -153,7 +150,7 @@ function pino (...args) {
   const end = '}' + (crlf ? '\r\n' : '\n')
   const coreChindings = asChindings.bind(null, {
     [chindingsSym]: '',
-    [serializersSym]: serializers,
+    [serializersSym]: serializersSafe,
     [stringifiersSym]: stringifiers,
     [stringifySym]: stringify,
     [stringifySafeSym]: stringifySafe,
@@ -202,12 +199,12 @@ function pino (...args) {
     [formatOptsSym]: formatOpts,
     [messageKeySym]: messageKey,
     [errorKeySym]: errorKey,
-    [requestKeySym]: requestKey,
     [responseKeySym]: responseKey,
+    [requestKeySym]: requestKey,
     [nestedKeySym]: nestedKey,
     // protect against injection
     [nestedKeyStrSym]: nestedKey ? `,${JSON.stringify(nestedKey)}:{` : '',
-    [serializersSym]: serializers,
+    [serializersSym]: serializersSafe,
     [mixinSym]: mixin,
     [mixinMergeStrategySym]: mixinMergeStrategy,
     [chindingsSym]: chindings,
@@ -216,7 +213,7 @@ function pino (...args) {
     silent: noop,
     onChild,
     [msgPrefixSym]: msgPrefix,
-    [futureSym]: Object.freeze(futureSafe) // future is set immutable to each Pino top-instance, as it affects behavior of other settings
+    [futureSym]: futureSafe
   })
 
   Object.setPrototypeOf(instance, proto())
@@ -243,7 +240,7 @@ module.exports.transport = require('./lib/transport')
 module.exports.multistream = require('./lib/multistream')
 
 module.exports.levels = mappings()
-module.exports.stdSerializers = serializers
+module.exports.stdSerializers = Object.assign(Object.create(null), stdSerializers)
 module.exports.stdTimeFunctions = Object.assign({}, time)
 module.exports.symbols = symbols
 module.exports.version = version