fix: match n-logger's function serialization #490
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rowanmanning
commented
Apr 4, 2023
| const pino = require('pino').default; | ||
| const serializeError = require('@dotcom-reliability-kit/serialize-error'); | ||
| const { default: structuredClone } = require('@ungap/structured-clone'); | ||
| const { default: clone } = require('@ungap/structured-clone'); |
Member
Author
There was a problem hiding this comment.
note: I renamed this to avoid confusion. In Node.js 18+ structuredClone is a global which doesn't exactly match the method signature of ungap's structured-clone module. I can imagine this confusing us a lot later.
rowanmanning
force-pushed
the
fix-function-serialization
branch
from
e42def5 to
f80fb13
Compare
This resolves #489. We were not matching n-logger in the way it serialized functions and this resulted in errors. We now match n-logger and just ignore any function properties. I did this using the `lossy` option of ungap's structured-clone, which offers a few features over the native structured clone. Once Reliability Kit drops Node.js 16 support we can reassess this and perhaps move to native `structuredClone`. Docs are here: https://github.com/ungap/structured-clone#extra-features
rowanmanning
force-pushed
the
fix-function-serialization
branch
from
f80fb13 to
10d86f2
Compare
rowanmanning
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This resolves #489. We were not matching n-logger in the way it serialized functions and this resulted in errors. We now match n-logger and just ignore any function properties.
I did this using the
lossyoption of ungap's structured-clone, which offers a few features over the native structured clone. Thelossyoption makes the clone behave more likeJSON.stringify, ignoring properties that it can't serialize rather than throwing an error. Once Reliability Kit drops Node.js 16 support we can reassess this and perhaps move to nativestructuredClone.