feat: add an option to resolve locales in entries referenced by rich …

…text (#21619)

* feat: add an option to resolve locales in entries referenced by rich text

* fix: remove unnecessary default value

* feat: only use locale resolution if richText.resolveFieldLocales is true

* perf: pass in content types keyed by ID rather than looking them up for each entry

* docs: document the new option in the README

* perf: use a set instead of an array to track resolved entry IDs

* perf: use a Map to keep track of content types by ID

packages/gatsby-source-contentful/README.md

@@ -172,6 +172,10 @@ If you are confident your Content Types will have natural-language IDs (e.g. `bl
 
 Number of entries to retrieve from Contentful at a time. Due to some technical limitations, the response payload should not be greater than 7MB when pulling content from Contentful. If you encounter this issue you can set this param to a lower number than 100, e.g `50`.
 
+**`richText.resolveFieldLocales`** [boolean][optional] [default: `false`]
+
+If you want to resolve the locales in fields of assets and entries that are referenced by rich text (e.g., via embedded entries or entry hyperlinks), set this to `true`. Otherwise, fields of referenced assets or entries will be objects keyed by locale.
+
 ## Notes on Contentful Content Models
 
 There are currently some things to keep in mind when building your content models at Contentful.

packages/gatsby-source-contentful/package.json

@@ -8,6 +8,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
+    "@contentful/rich-text-types": "^13.1.0",
     "@hapi/joi": "^15.1.1",
     "axios": "^0.19.0",
     "base64-img": "^1.0.4",

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

@@ -60,7 +60,7 @@ describe(`Process contentful data (by name)`, () => {
     createNodeId.mockReturnValue(`uuid-from-gatsby`)
     contentTypeItems.forEach((contentTypeItem, i) => {
       entryList[i].forEach(normalize.fixIds)
-      normalize.createContentTypeNodes({
+      normalize.createNodesForContentType({
         contentTypeItem,
         restrictedNodeFields,
         conflictFieldPrefix,
@@ -139,7 +139,7 @@ describe(`Process contentful data (by id)`, () => {
     createNodeId.mockReturnValue(`uuid-from-gatsby`)
     contentTypeItems.forEach((contentTypeItem, i) => {
       entryList[i].forEach(normalize.fixIds)
-      normalize.createContentTypeNodes({
+      normalize.createNodesForContentType({
         contentTypeItem,
         restrictedNodeFields,
         conflictFieldPrefix,

packages/gatsby-source-contentful/src/__tests__/plugin-options.js

@@ -171,6 +171,7 @@ describe(`Options validation`, () => {
         downloadLocal: 5,
         useNameForId: 5,
         pageLimit: `fifty`,
+        richText: true,
       }
     )
 
@@ -203,6 +204,9 @@ describe(`Options validation`, () => {
     expect(reporter.panic).toBeCalledWith(
       expect.stringContaining(`"pageLimit" must be a number`)
     )
+    expect(reporter.panic).toBeCalledWith(
+      expect.stringContaining(`"richText" must be an object`)
+    )
   })
 
   it(`Fails with undefined option keys`, () => {