feat(gatsby): Remove deleteNode with ID arg (#29205)

Co-authored-by: gatsbybot <mathews.kyle+gatsbybot@gmail.com>
gatsbyjs · Feb 10, 2021 · 01b6123 · 01b6123
1 parent e691342
commit 01b6123
Show file tree

Hide file tree

Showing 14 changed files with 51 additions and 77 deletions.
diff --git a/docs/docs/creating-a-source-plugin.md b/docs/docs/creating-a-source-plugin.md
@@ -446,9 +446,7 @@ exports.sourceNodes = async ({ actions, getNodesByType }, pluginOptions) => {
       newData.forEach(newDatum => {
         switch (newDatum.status) {
           case "deleted":
-            deleteNode({
-              node: getNode(createNodeId(`YourSourceType-${newDatum.uuid}`)),
-            })
+            deleteNode(getNode(createNodeId(`YourSourceType-${newDatum.uuid}`)))
             break
           case "created":
           case "updated":

diff --git a/docs/docs/how-to/plugins-and-themes/creating-a-source-plugin.md b/docs/docs/how-to/plugins-and-themes/creating-a-source-plugin.md
@@ -887,9 +887,7 @@ exports.sourceNodes = async (
         const nodeId = createNodeId(`${POST_NODE_TYPE}-${post.id}`)
         switch (post.status) {
           case "deleted":
-            deleteNode({
-              node: getNode(nodeId),
-            })
+            deleteNode(getNode(nodeId))
             break
           case "created":
           case "updated":

diff --git a/e2e-tests/development-runtime/plugins/gatsby-source-fake-data/gatsby-node.js b/e2e-tests/development-runtime/plugins/gatsby-source-fake-data/gatsby-node.js
@@ -40,9 +40,7 @@ exports.sourceNodes = async function sourceNodes({
     deleted.forEach(node => {
       const existing = getNode(node.id)
       if (existing) {
-        deleteNode({
-          node: existing,
-        })
+        deleteNode(existing)
       }
     })
   }

diff --git a/e2e-tests/development-runtime/plugins/gatsby-source-pinc-data/gatsby-node.js b/e2e-tests/development-runtime/plugins/gatsby-source-pinc-data/gatsby-node.js
@@ -40,9 +40,7 @@ exports.sourceNodes = async function sourceNodes({
     deleted.forEach(node => {
       const existing = getNode(node.id)
       if (existing) {
-        deleteNode({
-          node: existing,
-        })
+        deleteNode(existing)
       }
     })
   }

diff --git a/examples/creating-source-plugins/source-plugin/gatsby-node.js b/examples/creating-source-plugins/source-plugin/gatsby-node.js
@@ -179,9 +179,7 @@ exports.sourceNodes = async function sourceNodes(
         const nodeId = createNodeId(`${POST_NODE_TYPE}-${post.id}`)
         switch (post.status) {
           case "deleted":
-            deleteNode({
-              node: getNode(nodeId),
-            })
+            deleteNode(getNode(nodeId))
             break
           case "created":
           case "updated":

diff --git a/packages/gatsby-source-contentful/src/__tests__/gatsby-node.js b/packages/gatsby-source-contentful/src/__tests__/gatsby-node.js
@@ -256,7 +256,7 @@ describe(`gatsby-node`, () => {
       // don't allow mutations (this isn't traversing so only top level is frozen)
       currentNodeMap.set(node.id, Object.freeze(node))
     })
-    actions.deleteNode = ({ node }) => {
+    actions.deleteNode = node => {
       currentNodeMap.delete(node.id)
     }
     actions.touchNode = jest.fn()

diff --git a/packages/gatsby-source-contentful/src/gatsby-node.js b/packages/gatsby-source-contentful/src/gatsby-node.js
@@ -485,7 +485,7 @@ exports.sourceNodes = async (
     localizedNodes.forEach(node => {
       // touchNode first, to populate typeOwners & avoid erroring
       touchNode({ nodeId: node.id })
-      deleteNode({ node })
+      deleteNode(node)
     })
   }
 

diff --git a/packages/gatsby-source-drupal/src/gatsby-node.js b/packages/gatsby-source-drupal/src/gatsby-node.js
@@ -71,7 +71,7 @@ exports.sourceNodes = async (
         return
       }
       if (action === `delete`) {
-        actions.deleteNode({ node: getNode(createNodeId(id)) })
+        actions.deleteNode(getNode(createNodeId(id)))
         reporter.log(`Deleted node: ${id}`)
         changesActivity.end()
         return
@@ -147,7 +147,7 @@ exports.sourceNodes = async (
         let nodesToSync = data.data.entities
         for (const nodeSyncData of nodesToSync) {
           if (nodeSyncData.action === `delete`) {
-            actions.deleteNode({ node: getNode(createNodeId(nodeSyncData.id)) })
+            actions.deleteNode(getNode(createNodeId(nodeSyncData.id)))
           } else {
             // The data could be a single Drupal entity or an array of Drupal
             // entities to update.
@@ -385,7 +385,7 @@ exports.onCreateDevServer = (
           )
         }
         if (action === `delete`) {
-          actions.deleteNode({ node: getNode(createNodeId(id)) })
+          actions.deleteNode(getNode(createNodeId(id)))
           return reporter.log(`Deleted node: ${id}`)
         }
         const nodeToUpdate = JSON.parse(JSON.parse(req.body)).data

diff --git a/packages/gatsby-source-filesystem/src/gatsby-node.js b/packages/gatsby-source-filesystem/src/gatsby-node.js
@@ -36,7 +36,7 @@ const createFSMachine = (
     // It's possible the node was never created as sometimes tools will
     // write and then immediately delete temporary files to the file system.
     if (node) {
-      deleteNode({ node })
+      deleteNode(node)
     }
   }
 

diff --git a/packages/gatsby/index.d.ts b/packages/gatsby/index.d.ts
@@ -1091,10 +1091,6 @@ interface ActionPlugin {
   name: string
 }
 
-interface DeleteNodeArgs {
-  node: Node
-}
-
 interface CreateNodeFieldArgs {
   node: Node
   name: string
@@ -1128,9 +1124,8 @@ export interface Actions {
 
   /** @see https://www.gatsbyjs.org/docs/actions/#deletePage */
   deleteNode(
-    options: { node: Node },
+    node: NodeInput,
     plugin?: ActionPlugin,
-    option?: ActionOptions
   ): void
 
   /** @see https://www.gatsbyjs.org/docs/actions/#createNode */

diff --git a/packages/gatsby/src/db/__tests__/nodes.js b/packages/gatsby/src/db/__tests__/nodes.js
@@ -222,14 +222,9 @@ describe(`nodes db tests`, () => {
       )
     )
     store.dispatch(
-      actions.deleteNode(
-        {
-          node: getNode(`hi`),
-        },
-        {
-          name: `tests`,
-        }
-      )
+      actions.deleteNode(getNode(`hi`), {
+        name: `tests`,
+      })
     )
     expect(getNodes()).toHaveLength(1)
   })
@@ -306,12 +301,9 @@ describe(`nodes db tests`, () => {
       )
     )
     store.dispatch(
-      actions.deleteNode(
-        { node: getNode(`hi`) },
-        {
-          name: `tests`,
-        }
-      )
+      actions.deleteNode(getNode(`hi`), {
+        name: `tests`,
+      })
     )
     expect(getNodes()).toHaveLength(0)
   })
@@ -343,11 +335,7 @@ describe(`nodes db tests`, () => {
         }
       )
     )
-    store.dispatch(
-      actions.deleteNode({
-        node: getNode(`hi`),
-      })
-    )
+    store.dispatch(actions.deleteNode(getNode(`hi`)))
     expect(getNode(`hi`)).toBeUndefined()
   })
 
@@ -370,14 +358,17 @@ describe(`nodes db tests`, () => {
     )
     expect(getNode(`hi`)).toMatchObject({ id: `hi` })
     store.dispatch(
-      actions.deleteNode(`hi`, getNode(`hi`), {
-        name: `tests`,
-      })
+      actions.deleteNode(
+        { node: getNode(`hi`) },
+        {
+          name: `tests`,
+        }
+      )
     )
     expect(getNode(`hi`)).toBeUndefined()
     const deprecationNotice =
-      `Calling "deleteNode" with a nodeId is deprecated. Please pass an ` +
-      `object containing a full node instead: deleteNode({ node }). ` +
+      `Calling "deleteNode" with {node} is deprecated. Please pass ` +
+      `the node directly to the function: deleteNode(node) ` +
       `"deleteNode" was called by tests`
     expect(report.warn).toHaveBeenCalledWith(deprecationNotice)
   })
@@ -401,7 +392,7 @@ describe(`nodes db tests`, () => {
         )
       )
       store.dispatch(
-        actions.deleteNode(`hi`, getNode(`hi`), {
+        actions.deleteNode(getNode(`hi`), {
           name: `tests`,
         })
       )

diff --git a/packages/gatsby/src/internal-plugins/internal-data-bridge/gatsby-node.js b/packages/gatsby/src/internal-plugins/internal-data-bridge/gatsby-node.js
@@ -197,5 +197,5 @@ exports.onCreatePage = ({ createContentDigest, page, actions }) => {
 emitter.on(`DELETE_PAGE`, action => {
   const nodeId = createPageId(action.payload.path)
   const node = getNode(nodeId)
-  boundActionCreators.deleteNode({ node })
+  boundActionCreators.deleteNode(node)
 })
diff --git a/packages/gatsby/src/redux/actions/public.js b/packages/gatsby/src/redux/actions/public.js
@@ -425,53 +425,50 @@ ${reservedFields.map(f => `  * "${f}"`).join(`\n`)}
 
 /**
  * Delete a node
- * @param {object} $0
- * @param {object} $0.node the node object
+ * @param {object} node A node object. See the "createNode" action for more information about the node object details.
  * @example
- * deleteNode({node: node})
+ * deleteNode(node)
  */
-actions.deleteNode = (options: any, plugin: Plugin, args: any) => {
+actions.deleteNode = (node: any, plugin?: Plugin) => {
   let id
 
-  // Check if using old method signature. Warn about incorrect usage but get
-  // node from nodeID anyway.
-  if (typeof options === `string`) {
+  // TODO(v4): Remove this deprecation warning and only allow deleteNode(node)
+  if (node && node.node) {
     let msg =
-      `Calling "deleteNode" with a nodeId is deprecated. Please pass an ` +
-      `object containing a full node instead: deleteNode({ node }).`
-    if (args && args.name) {
-      // `plugin` used to be the third argument
-      plugin = args
+      `Calling "deleteNode" with {node} is deprecated. Please pass ` +
+      `the node directly to the function: deleteNode(node)`
+
+    if (plugin && plugin.name) {
       msg = msg + ` "deleteNode" was called by ${plugin.name}`
     }
     report.warn(msg)
 
-    id = options
+    id = node.node.id
   } else {
-    id = options && options.node && options.node.id
+    id = node && node.id
   }
 
   // Always get node from the store, as the node we get as an arg
   // might already have been deleted.
-  const node = getNode(id)
+  const internalNode = getNode(id)
   if (plugin) {
     const pluginName = plugin.name
 
     if (
-      node &&
-      typeOwners[node.internal.type] &&
-      typeOwners[node.internal.type] !== pluginName
+      internalNode &&
+      typeOwners[internalNode.internal.type] &&
+      typeOwners[internalNode.internal.type] !== pluginName
     )
       throw new Error(stripIndent`
           The plugin "${pluginName}" deleted a node of a type owned by another plugin.
 
-          The node type "${node.internal.type}" is owned by "${
-        typeOwners[node.internal.type]
+          The node type "${internalNode.internal.type}" is owned by "${
+        typeOwners[internalNode.internal.type]
       }".
 
           The node object passed to "deleteNode":
 
-          ${JSON.stringify(node, null, 4)}
+          ${JSON.stringify(internalNode, null, 4)}
 
           The plugin deleting the node:
 
@@ -487,12 +484,13 @@ actions.deleteNode = (options: any, plugin: Plugin, args: any) => {
     }
   }
 
-  const deleteAction = createDeleteAction(node)
+  const deleteAction = createDeleteAction(internalNode)
 
   // It's possible the file node was never created as sometimes tools will
   // write and then immediately delete temporary files to the file system.
   const deleteDescendantsActions =
-    node && findChildren(node.children).map(getNode).map(createDeleteAction)
+    internalNode &&
+    findChildren(internalNode.children).map(getNode).map(createDeleteAction)
 
   if (deleteDescendantsActions && deleteDescendantsActions.length) {
     return [...deleteDescendantsActions, deleteAction]

diff --git a/packages/gatsby/src/utils/source-nodes.ts b/packages/gatsby/src/utils/source-nodes.ts
@@ -81,7 +81,7 @@ function deleteStaleNodes(state: IGatsbyState, nodes: Array<Node>): void {
   const staleNodes = getStaleNodes(state, nodes)
 
   if (staleNodes.length > 0) {
-    staleNodes.forEach(node => deleteNode({ node }))
+    staleNodes.forEach(node => deleteNode(node))
   }
 }