@nxtedition/lib 19.1.5 → 19.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "19.1.5",
+  "version": "19.1.7",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",
@@ -94,7 +94,6 @@
     "object-hash": "^3.0.0",
     "p-queue": "^8.0.1",
     "pino": "^8.20.0",
-    "pino-std-serializers": "^6.2.2",
     "qs": "^6.12.1",
     "request-target": "^1.0.2",
     "smpte-timecode": "^1.3.5",

package/serializers.js

@@ -1,4 +1,3 @@
-import serializers from 'pino-std-serializers'
 import { SIGNALS } from './platform.js'
 import { util } from 'undici'
 
@@ -25,41 +24,7 @@ function getHeaders(obj) {
 export default {
   data: (data) =>
     data != null && typeof data === 'object' ? JSON.stringify(data, undefined, 2) : data,
-  err: (err) => {
-    // TODO (fix): Merge with errors/serializeError?
-
-    if (Buffer.isBuffer(err)) {
-      err = new Error('unexpected buffer error')
-    }
-
-    if (Array.isArray(err)) {
-      err = err.length === 1 ? err[0] : new AggregateError(err)
-    }
-
-    if (err == null) {
-      return undefined
-    }
-
-    const ret = serializers.err(err)
-
-    if (ret == null) {
-      return undefined
-    }
-
-    if (ret.data !== null && typeof ret.data === 'object') {
-      ret.data = JSON.stringify(ret.data)
-    }
-
-    if (typeof ret.signal === 'number') {
-      ret.signal = SIGNALS[ret.signal] ?? String(ret.signal)
-    }
-
-    if (typeof ret.code === 'number') {
-      ret.code = String(ret.code)
-    }
-
-    return ret
-  },
+  err: (err) => errSerializer(err),
   res: (res) =>
     res && {
       id: res.id || res.req?.id || getHeader(res, 'request-id') || getHeader(res.req, 'request-id'),
@@ -124,3 +89,121 @@ export default {
     }
   },
 }
+
+// TODO (fix): Merge with errros/serializeError.
+// Note that 'data' here should be string while in "serializeError" it should be object.
+// Maybe we should rename serializeError to makeErrorObject or somehting??
+
+// Based on: https://github.com/pinojs/pino-std-serializers
+
+const seen = Symbol('circular-ref-tag')
+const rawSymbol = Symbol('pino-raw-err-ref')
+
+const pinoErrProto = Object.create(
+  {},
+  {
+    type: {
+      enumerable: true,
+      writable: true,
+      value: undefined,
+    },
+    message: {
+      enumerable: true,
+      writable: true,
+      value: undefined,
+    },
+    stack: {
+      enumerable: true,
+      writable: true,
+      value: undefined,
+    },
+    aggregateErrors: {
+      enumerable: true,
+      writable: true,
+      value: undefined,
+    },
+    raw: {
+      enumerable: false,
+      get: function () {
+        return this[rawSymbol]
+      },
+      set: function (val) {
+        this[rawSymbol] = val
+      },
+    },
+  },
+)
+Object.defineProperty(pinoErrProto, rawSymbol, {
+  writable: true,
+  value: {},
+})
+
+function errSerializer(err) {
+  if (Array.isArray(err)) {
+    return err.length === 0 ? undefined : errSerializer({ message: '', errors: err })
+  } else if (!isErrorLike(err)) {
+    return undefined
+  } else if (err.message === '' && Array.isArray(err.errors) && err.errors.length === 0) {
+    return undefined
+  } else if (err.message === '' && Array.isArray(err.errors) && err.errors.length === 1) {
+    return errSerializer(err.errors[0])
+  }
+
+  err[seen] = undefined // tag to prevent re-looking at this
+  const _err = Object.create(pinoErrProto)
+  _err.type =
+    toString.call(err.constructor) === '[object Function]' ? err.constructor.name : err.name
+  _err.message = err.message
+  _err.stack = err.stack
+
+  if (Array.isArray(err.errors)) {
+    _err.aggregateErrors = err.errors.map((err) => errSerializer(err))
+  }
+
+  if (isErrorLike(err.cause) && !Object.prototype.hasOwnProperty.call(err.cause, seen)) {
+    _err.cause = errSerializer(err.cause)
+  }
+
+  for (const key in err) {
+    if (_err[key] === undefined) {
+      const val = err[key]
+      if (isErrorLike(val)) {
+        if (!Object.prototype.hasOwnProperty.call(val, seen)) {
+          _err[key] = errSerializer(val)
+        }
+      } else if (val != null) {
+        _err[key] = val
+      }
+    }
+  }
+
+  if (_err.data != null && typeof _err.data !== 'string') {
+    _err.data = JSON.stringify(_err.data, undefined, 2)
+  }
+
+  if (_err.code != null && typeof _err.code !== 'string') {
+    _err.code = String(_err.code)
+  }
+
+  if (_err.statusCode == null && _err.status != null) {
+    _err.statusCode = Number(_err.status) ?? undefined
+  }
+
+  if (_err.signalCode == null && _err.signal != null) {
+    _err.signalCode = SIGNALS[_err._signal] ?? _err._signal
+  } else if (_err.signalCode != null) {
+    _err.signalCode = SIGNALS[_err.signalCode] ?? _err.signalCode
+  }
+
+  if (_err.exitCode == null && _err.code != null && /^([A-Z]+|[a-z]+|[0-9]+)$/.test(_err.code)) {
+    _err.exitCode = String(_err.code)
+  }
+
+  delete err[seen] // clean up tag in case err is serialized again later
+  _err.raw = err
+  return _err
+}
+
+const isErrorLike = (err) => {
+  return err && typeof err.message === 'string'
+}