V2 - Switch Sources and Transformers to use createNodeId for ids (#3807)

* Switch Sources and Transformers to use createNodeId for ids * Only use createNodeId if an id isn't passed in * Remove unused imports
gatsbyjs · Feb 10, 2018 · 613c56b · 613c56b
1 parent 8339263
commit 613c56b
Show file tree

Hide file tree

Showing 64 changed files with 502 additions and 685 deletions.
diff --git a/Breaking Changes.md b/Breaking Changes.md
@@ -1,3 +1,4 @@
 
 - Remove postcss plugins (cssnext, cssimport) from default css loader config
 - change webpack api
+- Source & transformer plugins now use UUIDs for ids. If you used glob or regex to query nodes by id then you'll need to query something else.
diff --git a/packages/gatsby-source-contentful/src/__tests__/__snapshots__/normalize.js.snap b/packages/gatsby-source-contentful/src/__tests__/__snapshots__/normalize.js.snap
diff --git a/packages/gatsby-source-contentful/src/__tests__/normalize.js b/packages/gatsby-source-contentful/src/__tests__/normalize.js
@@ -52,13 +52,16 @@ describe(`Process contentful data`, () => {
 
   it(`creates nodes for each entry`, () => {
     const createNode = jest.fn()
+    const createNodeId = jest.fn()
+    createNodeId.mockReturnValue(`uuid-from-gatsby`)
     contentTypeItems.forEach((contentTypeItem, i) => {
       normalize.createContentTypeNodes({
         contentTypeItem,
         restrictedNodeFields,
         conflictFieldPrefix,
         entries: entryList[i].map(normalize.fixIds),
         createNode,
+        createNodeId,
         resolvable,
         foreignReferenceMap,
         defaultLocale,
@@ -70,11 +73,14 @@ describe(`Process contentful data`, () => {
 
   it(`creates nodes for each asset`, () => {
     const createNode = jest.fn()
+    const createNodeId = jest.fn()
+    createNodeId.mockReturnValue(`uuid-from-gatsby`)
     const assets = currentSyncData.assets
     assets.forEach(assetItem => {
       normalize.createAssetNodes({
         assetItem,
         createNode,
+        createNodeId,
         defaultLocale,
         locales,
       })

diff --git a/packages/gatsby-source-contentful/src/gatsby-node.js b/packages/gatsby-source-contentful/src/gatsby-node.js
@@ -30,7 +30,7 @@ exports.setFieldsOnGraphQLNodeType = require(`./extend-node-type`).extendNodeTyp
  */
 
 exports.sourceNodes = async (
-  { actions, getNodes, hasNodeChanged, store },
+  { actions, getNodes, createNodeId, hasNodeChanged, store },
   { spaceId, accessToken, host }
 ) => {
   const { createNode, deleteNodes, touchNode, setPluginStatus } = actions
@@ -151,6 +151,7 @@ exports.sourceNodes = async (
       conflictFieldPrefix,
       entries: entryList[i],
       createNode,
+      createNodeId,
       resolvable,
       foreignReferenceMap,
       defaultLocale,
@@ -162,6 +163,7 @@ exports.sourceNodes = async (
     normalize.createAssetNodes({
       assetItem,
       createNode,
+      createNodeId,
       defaultLocale,
       locales,
     })

diff --git a/packages/gatsby-source-contentful/src/normalize.js b/packages/gatsby-source-contentful/src/normalize.js
@@ -149,10 +149,10 @@ exports.buildForeignReferenceMap = ({
   return foreignReferenceMap
 }
 
-function createTextNode(node, key, text, createNode) {
+function createTextNode(node, key, text, createNode, createNodeId) {
   const str = _.isString(text) ? text : ` `
   const textNode = {
-    id: `${node.id}${key}TextNode`,
+    id: createNodeId(`${node.id}${key}TextNode`),
     parent: node.id,
     children: [],
     [key]: str,
@@ -171,11 +171,11 @@ function createTextNode(node, key, text, createNode) {
 }
 exports.createTextNode = createTextNode
 
-function createJSONNode(node, key, content, createNode) {
+function createJSONNode(node, key, content, createNode, createNodeId) {
   const str = JSON.stringify(content)
   const JSONNode = {
     ...content,
-    id: `${node.id}${key}JSONNode`,
+    id: createNodeId(`${node.id}${key}JSONNode`),
     parent: node.id,
     children: [],
     internal: {
@@ -199,6 +199,7 @@ exports.createContentTypeNodes = ({
   conflictFieldPrefix,
   entries,
   createNode,
+  createNodeId,
   resolvable,
   foreignReferenceMap,
   defaultLocale,
@@ -286,7 +287,7 @@ exports.createContentTypeNodes = ({
       }
 
       let entryNode = {
-        id: mId(entryItem.sys.id),
+        id: createNodeId(mId(entryItem.sys.id)),
         contentful_id: entryItem.sys.contentful_id,
         createdAt: entryItem.sys.createdAt,
         updatedAt: entryItem.sys.updatedAt,
@@ -328,7 +329,8 @@ exports.createContentTypeNodes = ({
             entryNode,
             entryItemFieldKey,
             entryItemFields[entryItemFieldKey],
-            createNode
+            createNode,
+            createNodeId,
           )
 
           delete entryItemFields[entryItemFieldKey]
@@ -337,7 +339,8 @@ exports.createContentTypeNodes = ({
             entryNode,
             entryItemFieldKey,
             entryItemFields[entryItemFieldKey],
-            createNode
+            createNode,
+            createNodeId,
           )
 
           delete entryItemFields[entryItemFieldKey]
@@ -356,7 +359,7 @@ exports.createContentTypeNodes = ({
 
     // Create a node for each content type
     const contentTypeNode = {
-      id: contentTypeItemId,
+      id: createNodeId(contentTypeItemId),
       parent: null,
       children: [],
       name: contentTypeItem.name,
@@ -382,6 +385,7 @@ exports.createContentTypeNodes = ({
 exports.createAssetNodes = ({
   assetItem,
   createNode,
+  createNodeId,
   defaultLocale,
   locales,
 }) => {
@@ -405,7 +409,7 @@ exports.createAssetNodes = ({
         : ``,
     }
     const assetNode = {
-      id: mId(localizedAsset.sys.id),
+      id: createNodeId(mId(localizedAsset.sys.id)),
       parent: null,
       children: [],
       ...localizedAsset.fields,

diff --git a/packages/gatsby-source-drupal/src/gatsby-node.js b/packages/gatsby-source-drupal/src/gatsby-node.js
@@ -13,7 +13,7 @@ const createContentDigest = obj =>
 
 exports.sourceNodes = async (
   { actions, getNode, hasNodeChanged, store, cache },
-  { baseUrl, apiBase }
+  { baseUrl, apiBase, createNodeId }
 ) => {
   const { createNode } = actions
 
@@ -103,7 +103,7 @@ exports.sourceNodes = async (
 
     _.each(contentType.data, datum => {
       const node = {
-        id: datum.id,
+        id: createNodeId(datum.id),
         parent: null,
         children: [],
         ...datum.attributes,

diff --git a/packages/gatsby-source-faker/package.json b/packages/gatsby-source-faker/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-source-faker",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "A gatsby plugin to get fake data for testing",
   "main": "index.js",
   "scripts": {

diff --git a/packages/gatsby-source-faker/src/gatsby-node.js b/packages/gatsby-source-faker/src/gatsby-node.js
@@ -1,7 +1,7 @@
 const faker = require(`faker`)
 const crypto = require(`crypto`)
 
-exports.sourceNodes = ({ actions }, pluginOptions) => {
+exports.sourceNodes = ({ actions, createNodeId }, pluginOptions) => {
   const { createNode } = actions
   const { schema, count, type } = pluginOptions
   for (let i = 0; i < count; i++) {
@@ -20,7 +20,7 @@ exports.sourceNodes = ({ actions }, pluginOptions) => {
       .digest(`hex`)
 
     const nodeBase = {
-      id: JSON.stringify(faker.random.number()),
+      id: createNodeId(JSON.stringify(faker.random.number())),
       parent: null,
       children: [],
       internal: {

diff --git a/packages/gatsby-source-filesystem/src/__tests__/create-file-node.js b/packages/gatsby-source-filesystem/src/__tests__/create-file-node.js
@@ -5,6 +5,9 @@ const { createFileNode } = require(`../create-file-node`)
 // FIXME: This test needs to not use snapshots because of file differences
 // and locations across users and CI systems
 describe(`create-file-node`, () => {
-  it(`creates a file node`, () =>
-    createFileNode(path.resolve(`${__dirname}/fixtures/file.json`), {}))
+  it(`creates a file node`, () => {
+    const createNodeId = jest.fn()
+    createNodeId.mockReturnValue(`uuid-from-gatsby`)
+    return createFileNode(path.resolve(`${__dirname}/fixtures/file.json`), createNodeId, {})
+  })
 })
diff --git a/packages/gatsby-source-filesystem/src/create-file-node.js b/packages/gatsby-source-filesystem/src/create-file-node.js
@@ -14,7 +14,7 @@ const createId = path => {
 
 exports.createId = createId
 
-exports.createFileNode = async (pathToFile, pluginOptions = {}) => {
+exports.createFileNode = async (pathToFile, createNodeId, pluginOptions = {}) => {
   const slashed = slash(pathToFile)
   const parsedSlashed = path.parse(slashed)
   const slashedFile = {
@@ -56,7 +56,7 @@ exports.createFileNode = async (pathToFile, pluginOptions = {}) => {
       // Don't actually make the File id the absolute path as otherwise
       // people will use the id for that and ids shouldn't be treated as
       // useful information.
-      id: createId(pathToFile),
+      id: createNodeId(pathToFile),
       children: [],
       parent: `___SOURCE___`,
       internal,

diff --git a/packages/gatsby-source-filesystem/src/gatsby-node.js b/packages/gatsby-source-filesystem/src/gatsby-node.js
@@ -4,7 +4,7 @@ const fs = require(`fs`)
 const { createId, createFileNode } = require(`./create-file-node`)
 
 exports.sourceNodes = (
-  { actions, getNode, hasNodeChanged, reporter },
+  { actions, getNode, createNodeId, hasNodeChanged, reporter },
   pluginOptions
 ) => {
   const { createNode, deleteNode } = actions
@@ -36,7 +36,7 @@ Please pick a path to an existing directory.
   })
 
   const createAndProcessNode = path =>
-    createFileNode(path, pluginOptions).then(createNode)
+    createFileNode(path, createNodeId, pluginOptions).then(createNode)
 
   // For every path that is reported before the 'ready' event, we throw them
   // into a queue and then flush the queue when 'ready' event arrives.

diff --git a/packages/gatsby-source-hacker-news/package.json b/packages/gatsby-source-hacker-news/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-source-hacker-news",
-  "version": "1.0.9",
+  "version": "2.0.0",
   "description": "Gatsby source plugin for building websites using Hacker News as a data source",
   "scripts": {
     "build": "babel src --out-dir . --ignore **/__tests__/**",

diff --git a/packages/gatsby-source-hacker-news/src/gatsby-node.js b/packages/gatsby-source-hacker-news/src/gatsby-node.js
@@ -8,7 +8,7 @@ const get = query =>
     `https://www.graphqlhub.com/graphql?query=${encodeURIComponent(query)}`
   )
 
-exports.sourceNodes = async ({ actions, getNode, hasNodeChanged }) => {
+exports.sourceNodes = async ({ actions, getNode, createNodeId, hasNodeChanged }) => {
   const { createNode } = actions
 
   // Do the initial fetch
@@ -96,6 +96,7 @@ fragment commentsFragment on HackerNewsItem {
 
     const storyNode = {
       ...kidLessStory,
+      id: createNodeId(kidLessStory.id),
       children: kids.kids.map(k => k.id),
       parent: `__SOURCE__`,
       content: storyStr,
@@ -127,6 +128,7 @@ fragment commentsFragment on HackerNewsItem {
         }
         let commentNode = {
           ..._.omit(comment, `kids`),
+          id: createNodeId(comment.id),
           children: comment.kids.map(k => k.id),
           parent,
           internal: {
@@ -150,12 +152,12 @@ fragment commentsFragment on HackerNewsItem {
         createNode(commentNode)
 
         if (comment.kids.length > 0) {
-          createCommentNodes(comment.kids, comment.id, depth + 1)
+          createCommentNodes(comment.kids, commentNode.id, depth + 1)
         }
       })
     }
 
-    createCommentNodes(kids.kids, story.id)
+    createCommentNodes(kids.kids, storyNode.id)
   })
 
   return

diff --git a/packages/gatsby-source-medium/package.json b/packages/gatsby-source-medium/package.json
@@ -1,7 +1,7 @@
 {
   "name": "gatsby-source-medium",
   "description": "Gatsby source plugin for building websites using Medium as a data source",
-  "version": "1.0.11",
+  "version": "2.0.0",
   "author": "Robert Vogt <[email protected]>",
   "dependencies": {
     "axios": "^0.16.2",

diff --git a/packages/gatsby-source-medium/src/gatsby-node.js b/packages/gatsby-source-medium/src/gatsby-node.js
@@ -25,7 +25,7 @@ const convertTimestamps = (nextObj, prevObj, prevKey) => {
 
 const strip = payload => payload.replace(prefix, ``)
 
-exports.sourceNodes = async ({ actions }, { username }) => {
+exports.sourceNodes = async ({ actions, createNodeId }, { username }) => {
   const { createNode } = actions
 
   try {
@@ -84,7 +84,7 @@ exports.sourceNodes = async ({ actions }, { username }) => {
       const node = Object.assign(
         resource,
         {
-          id: resource.id ? resource.id : resource.userId,
+          id: createNodeId(resource.id ? resource.id : resource.userId),
           parent: `__SOURCE__`,
           children: [],
           internal: {

diff --git a/packages/gatsby-source-mongodb/package.json b/packages/gatsby-source-mongodb/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-source-mongodb",
-  "version": "1.5.13",
+  "version": "2.0.0",
   "description": "Stub description for gatsby-source-mongodb",
   "main": "index.js",
   "scripts": {

diff --git a/packages/gatsby-source-mongodb/src/gatsby-node.js b/packages/gatsby-source-mongodb/src/gatsby-node.js
@@ -4,7 +4,7 @@ const createMappingChildNodes = require(`./mapping`)
 const _ = require(`lodash`)
 
 exports.sourceNodes = (
-  { actions, getNode, hasNodeChanged },
+  { actions, getNode, createNodeId, hasNodeChanged },
   pluginOptions,
   done
 ) => {
@@ -32,10 +32,10 @@ exports.sourceNodes = (
       let collection = pluginOptions.collection || `documents`
       if (_.isArray(collection)) {
         for (const col of collection) {
-          createNodes(db, pluginOptions, dbName, createNode, col, done)
+          createNodes(db, pluginOptions, dbName, createNode, createNodeId, col, done)
         }
       } else {
-        createNodes(db, pluginOptions, dbName, createNode, collection, done)
+        createNodes(db, pluginOptions, dbName, createNode, createNodeId, collection, done)
       }
     }
   )
@@ -46,6 +46,7 @@ function createNodes(
   pluginOptions,
   dbName,
   createNode,
+  createNodeId,
   collectionName,
   done
 ) {
@@ -66,7 +67,7 @@ function createNodes(
       var node = {
         // Data for the node.
         ...item,
-        id: `${id}`,
+        id: createNodeId(`${id}`),
         parent: `__${collectionName}__`,
         children: [],
         internal: {

diff --git a/packages/gatsby-transformer-csv/package.json b/packages/gatsby-transformer-csv/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-transformer-csv",
-  "version": "1.3.7",
+  "version": "2.0.0",
   "description": "Gatsby transformer plugin for CSV files",
   "main": "index.js",
   "scripts": {