fix(gatsby-source-drupal): Clone nodes before adding back references so Gatsby knows the node has changed (so knows to re-run queries) #33328
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
…eferences so queries are re-run
gatsbot
bot
added
the
status: triage needed
KyleAMathews
added
topic: source-drupal
KyleAMathews
changed the title
KyleAMathews
changed the title
KyleAMathews
commented
Sep 29, 2021
| const referencedNode = getNode(nodeID) | ||
| let referencedNode | ||
| if (mutateNode) { | ||
| referencedNode = getNode(nodeID) |
There was a problem hiding this comment.
On the initial sourcing, it does make sense to directly mutate nodes as none of them have been created yet.
KyleAMathews
commented
Sep 29, 2021
| @@ -271,23 +299,9 @@ ${JSON.stringify(nodeToUpdate, null, 4)} | |||
| ) | |||
| } | |||
| }) | |||
|
|
|||
| // see what nodes are newly referenced, and make sure to call `createNode` on them | |||
| const addedReferencedNodes = _.difference( | |||
There was a problem hiding this comment.
This code isn't needed as it just duplicates what handleReferences does. We now return nodes with updated backreferences from that function so we can eliminate this code.
KyleAMathews
changed the title
KyleAMathews
commented
Sep 29, 2021
| @@ -9,16 +9,17 @@ const { | |||
|
|
|||
| const { getOptions } = require(`./plugin-options`) | |||
|
|
|||
| const backRefsNamesLookup = new WeakMap() | |||
| const referencedNodesLookup = new WeakMap() | |||
| const backRefsNamesLookup = new Map() | |||
There was a problem hiding this comment.
move to regular maps w/ IDs as we're not holding consistent references to the same node object anymore.
vladar
approved these changes
Sep 29, 2021
KyleAMathews
added a commit
that referenced
this pull request
Sep 29, 2021
…eferences so queries are re-run (#33328)
wardpeet
pushed a commit
to herecydev/gatsby
that referenced
this pull request
Oct 29, 2021
…eferences so queries are re-run (gatsbyjs#33328)
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
This was referenced Apr 15, 2024
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.
Big thanks to @kszot-ref for finding the root problem of the issue he was noticing with his Drupal/Gatsby site in #33285 (comment).
Fixes #33284
The bug is fairly subtle. The plugin currently updates backreferences on nodes by
directly mutating them. This means that for already existing nodes, Gatsby wasn't able
to tell that they'd changed because when it tried to compare the "new" version of the node
with the "old" version, they were the same because we'd mutated the old node object directly.
The fix is to always do a deep clone of the node object before making modifications to it
so Gatsby knows the node has changed and re-runs any pages depending on it.
I wonder now how common this issue is in other source plugins.