feat(gatsby): detect node mutations (enabled by flag or env var) #34006
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.
Description
This adds a mode that allows detecting where nodes are being mutated directly which just doesn't work (as it used to) when LMDB is used.
This is done by wrapping nodes with recursive Proxies when being passed to plugins/user code and logging whenever
set
handler is called (with some exception as gatsby internals DO mutate nodes, but later they do use actions to actually update those nodes in LMDB, so those mutations are not lost)Unfortunately we can't just have it always enabled as there is performance impact. From my testing it was mostly impacting node creation (the
onCreateNode
patterns unfortunately need this up front instead of "on usage" withgetNode
helpers or vianodeModel
methods)Documentation
TODO: add how-to guide about thisAdded guide:
Related Issues
[sc-40551]