feat: move metadata to contentfulMetadata with codemods

Author: axe312ger

packages/gatsby-codemods/src/transforms/__testfixtures__/gatsby-source-contentful/metadata.input.js

@@ -0,0 +1,16 @@
+const result = await graphql(`{
+  allContentfulPage {
+    edges {
+      node {
+        metadata {
+          tags {
+            id
+          }
+        }
+      }
+    }
+  }
+}
+`)
+
+const { tags } = data.contentfulPage.node.metadata

packages/gatsby-codemods/src/transforms/__testfixtures__/gatsby-source-contentful/metadata.output.js

@@ -0,0 +1,16 @@
+const result = await graphql(`{
+  allContentfulContentTypePage {
+    edges {
+      node {
+        contentfulMetadata {
+          tags {
+            id
+          }
+        }
+      }
+    }
+  }
+}
+`)
+
+const { tags } = data.contentfulContentTypePage.node.contentfulMetadata

packages/gatsby-codemods/src/transforms/__tests__/gatsby-source-contentful-test.js

@@ -2,6 +2,7 @@ const tests = [
   `assets`,
   `graphql-filter`,
   `graphql-sort`,
+  `metadata`,
   `query-results`,
   `sys`,
   `sys-type`,

packages/gatsby-codemods/src/transforms/gatsby-source-contentful.js

@@ -204,6 +204,20 @@ export function updateImport(babel) {
             )}: You might need to change flatten the Contentful Asset structure: "file.details.image.width" -> "width"`
           )
         }
+
+        if (path.node.property?.name === `metadata`) {
+          if (path.node.object.property.name === `node`) {
+            path.node.property.name = `contentfulMetadata`
+            state.opts.hasChanged = true
+            return
+          }
+          console.log(
+            `${renderFilename(
+              path,
+              state
+            )}: You might need to change your data selectors: "metadata" -> "contentfulMetadata"`
+          )
+        }
       },
       TaggedTemplateExpression({ node }, state) {
         if (node.tag.name !== `graphql`) {
@@ -430,6 +444,14 @@ function processGraphQLQuery(query, state) {
           }
         })
 
+        // Rename metadata to contentfulMetadata node selectors
+        node.selections.forEach(field => {
+          if (field.name?.value === `metadata`) {
+            field.name.value = `contentfulMetadata`
+            hasChanged = true
+          }
+        })
+
         // Rename sys.type to sys.contentType
         node.selections.forEach(field => {
           if (field.name?.value === `sys`) {

packages/gatsby-source-contentful/src/generate-schema.js

@@ -181,7 +181,7 @@ export async function generateSchema({
       fields: {
         id: { type: `ID!` },
         sys: { type: `ContentfulSys!` },
-        metadata: { type: `ContentfulMetadata!` },
+        contentfulMetadata: { type: `ContentfulMetadata!` },
       },
       interfaces: [`Node`],
     })
@@ -193,7 +193,7 @@ export async function generateSchema({
       fields: {
         id: { type: `ID!` },
         sys: { type: `ContentfulSys!` },
-        metadata: { type: `ContentfulMetadata!` },
+        contentfulMetadata: { type: `ContentfulMetadata!` },
       },
       interfaces: [`ContentfulEntity`, `Node`],
     })
@@ -485,7 +485,7 @@ export async function generateSchema({
           fields: {
             id: { type: `ID!` },
             sys: { type: `ContentfulSys!` },
-            metadata: { type: `ContentfulMetadata!` },
+            contentfulMetadata: { type: `ContentfulMetadata!` },
             ...fields,
           },
           interfaces: [`ContentfulEntity`, `ContentfulEntry`, `Node`],

packages/gatsby-source-contentful/src/normalize.js

@@ -536,7 +536,7 @@ export const createNodesForContentType = ({
         entryNode = {
           ...entryItemFields,
           ...entryNode,
-          metadata: {
+          contentfulMetadata: {
             tags___NODE: entryItem.metadata.tags.map(tag =>
               createNodeId(`ContentfulTag__${space.sys.id}__${tag.sys.id}`)
             ),
@@ -602,7 +602,7 @@ export const createAssetNodes = ({
         publishedVersion: assetItem.sys.revision,
       },
       placeholderUrl: `https:${file.url}?w=%width%&h=%height%`,
-      metadata: {
+      contentfulMetadata: {
         tags___NODE: assetItem.metadata.tags.map(tag =>
           createNodeId(`ContentfulTag__${space.sys.id}__${tag.sys.id}`)
         ),