fix: mutations in IPC queue #62
Merged
Conversation
This file contains 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
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.
Fixes issue spotted while developing jest-allure2-reporter.
This project strives to optimise things and suffers from this good intent.
When writing user metadata, we enqueue the changes while keeping direct references to the objects in question.
So, if the events live long enough in the IPC message batch, they might get mutated inadvertently.
The solution is to serialize the payload immediately to stay away from these dangerous situations.
They're damn hard to debug, so little performance decrease is worth it.
UPD: benchmarks don't show any noticeable decrease (still ¹⁄₃ ms per test).
P.S. On top of this, I renamed "set metadata" events to "write metadata", because it confuses when you're observing logs: there are multiple operations: set, assign, merge, push, so it's better not to confuse set and set.