Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[source-contentful] If entry is not set by user, provide an empty value of the same type #2037

Closed
wants to merge 4 commits into from
Closed

[source-contentful] If entry is not set by user, provide an empty value of the same type #2037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b29ced
If entry is not set by user, provide an empty value of the same type
m4rrc0 Sep 6, 2017
d8d9227
avoid validationError on createTextNode
m4rrc0 Sep 6, 2017
462b092
NaN for Numbers. Recursive function for arrays. Format
m4rrc0 Sep 8, 2017
34a67cf
add json property on objects to allow query even if properties vary f…
m4rrc0 Sep 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions packages/gatsby-source-contentful/src/__tests__/__snapshots__/normalize.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2587,7 +2587,7 @@ Our Lemnos products are made carefully by our craftsmen finely honed skillful te
"email": "[email protected]",
"id": "c4LgMotpNF6W20YKmuemW0a",
"internal": Object {
"contentDigest": "179698e2d0fdeafe064c16dc552905e0",
"contentDigest": "56c8049cbea94a91a808515540f1e0b3",
"type": "ContentfulBrand",
},
"logo___NODE": "c2Y8LhXLnYAYqKCGEWG4EKI",
Expand All @@ -2599,6 +2599,7 @@ Our Lemnos products are made carefully by our craftsmen finely honed skillful te
"product___NODE": Array [
"c4BqrajvA8E6qwgkieoqmqO",
],
"twitter": "",
"website": "http://www.lemnos.jp/en/",
},
],
Expand All @@ -2610,17 +2611,22 @@ Our Lemnos products are made carefully by our craftsmen finely honed skillful te
],
"companyDescription___NODE": "JrePkDVYomE8AwcuCUyMicompanyDescriptionTextNode",
"companyName___NODE": "JrePkDVYomE8AwcuCUyMicompanyNameTextNode",
"email": "",
"id": "JrePkDVYomE8AwcuCUyMi",
"internal": Object {
"contentDigest": "60153e88a39483fa024d4bf41ab95b6a",
"contentDigest": "98dc28795de1ada78c781c9979afb19b",
"type": "ContentfulBrand",
},
"logo___NODE": "c4zj1ZOfHgQ8oqgaSKm4Qo2",
"node_locale": "en-US",
"parent": "Brand",
"phone": Array [
"",
],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it something we want or should I leave it like an empty array (please see my long comment above for details on why I changed that)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we'd need this or else the schema would be wrong e.g. Gatsby wouldn't know that phone is an array of strings.

"product___NODE": Array [
"c5KsDBWseXY6QegucYAoacS",
],
"twitter": "",
"website": "http://playsam.com/",
},
],
Expand Down Expand Up @@ -2781,7 +2787,7 @@ Unsere Lemnos Produkte werden sorgfältig von unseren Handwerkern fein geschliff
"email": "[email protected]",
"id": "c4LgMotpNF6W20YKmuemW0a___de",
"internal": Object {
"contentDigest": "6e4e76e159aef9a4c09d87404ffb6009",
"contentDigest": "62689ca2ee05da931171762ee0a60d1d",
"type": "ContentfulBrand",
},
"logo___NODE": "c2Y8LhXLnYAYqKCGEWG4EKI___de",
Expand All @@ -2793,6 +2799,7 @@ Unsere Lemnos Produkte werden sorgfältig von unseren Handwerkern fein geschliff
"product___NODE": Array [
"c4BqrajvA8E6qwgkieoqmqO___de",
],
"twitter": "",
"website": "http://www.lemnos.jp/en/",
},
],
Expand All @@ -2804,17 +2811,22 @@ Unsere Lemnos Produkte werden sorgfältig von unseren Handwerkern fein geschliff
],
"companyDescription___NODE": "JrePkDVYomE8AwcuCUyMi___decompanyDescriptionTextNode",
"companyName___NODE": "JrePkDVYomE8AwcuCUyMi___decompanyNameTextNode",
"email": "",
"id": "JrePkDVYomE8AwcuCUyMi___de",
"internal": Object {
"contentDigest": "51ead6a16ac5a54cc51e571eb8a0923d",
"contentDigest": "6d5995e7a04b1680c48c75a17112c533",
"type": "ContentfulBrand",
},
"logo___NODE": "c4zj1ZOfHgQ8oqgaSKm4Qo2___de",
"node_locale": "de",
"parent": "Brand",
"phone": Array [
"",
],
"product___NODE": Array [
"c5KsDBWseXY6QegucYAoacS___de",
],
"twitter": "",
"website": "http://playsam.com/",
},
],
Expand Down
44 changes: 43 additions & 1 deletion packages/gatsby-source-contentful/src/normalize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ exports.buildForeignReferenceMap = ({
}

function createTextNode(node, key, text, createNode) {
const str = _.isString(text) ? text : ` `
const str = _.isString(text) && text !== `` ? text : ` `
const textNode = {
id: `${node.id}${key}TextNode`,
parent: node.id,
Expand Down Expand Up @@ -193,6 +193,47 @@ exports.createContentTypeNodes = ({
// Get localized fields.
const entryItemFields = _.mapValues(entryItem.fields, v => getField(v))

// If entry is not set by user, provide an empty value of the same type
const setBlankValue = contentTypeItemField => {
if (contentTypeItemField.type.match(/Symbol|Text|Date/)) {
return ``
} else if (contentTypeItemField.type.match(/Number/)) {
return NaN
} else if (
contentTypeItemField.type.match(
/Object|Location|Media|Reference|Link/
)
) {
return {}
} else if (contentTypeItemField.type.match(/Array/)) {
// Setting values recursively is useful for 'never defined entries'
// TODO: Does not work for arrays of references, assets, objects, ...
return [setBlankValue(contentTypeItemField.items)]
} else if (contentTypeItemField.type.match(/Boolean/)) {
return false
}
}
contentTypeItem.fields.forEach(contentTypeItemField => {
const fieldName = contentTypeItemField.id
if (typeof entryItemFields[fieldName] === `undefined`) {
entryItemFields[fieldName] = setBlankValue(contentTypeItemField)
}
// Add a "json" property on Objects with the stringified version of its content
// This allows for querying objects with changing properties
// TODO: how to handle a property "json" entered by user? Should we just
// use a more specific name than "json" for our created property
if (contentTypeItemField.type === `Object`) {
if (typeof entryItemFields[fieldName].json === `undefined`) {
entryItemFields[fieldName].json = JSON.stringify(
entryItemFields[fieldName]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a proposition to solve #1703

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of converting every object to string, I added a json property to every object containing the stringified version of the object. This means we can query that json field on any object even if the object content vary from entry to entry.
Does that make sense?
Should we choose a wiser property name?

)
} else {
const { json, ...originalObj } = entryItemFields[fieldName]
entryItemFields[fieldName].json = JSON.stringify(originalObj)
}
}
})

// Prefix any conflicting fields
// https://github.com/gatsbyjs/gatsby/pull/1084#pullrequestreview-41662888
conflictFields.forEach(conflictField => {
Expand All @@ -207,6 +248,7 @@ exports.createContentTypeNodes = ({
const entryItemFieldValue = entryItemFields[entryItemFieldKey]
if (Array.isArray(entryItemFieldValue)) {
if (
entryItemFieldValue[0] &&
entryItemFieldValue[0].sys &&
entryItemFieldValue[0].sys.type &&
entryItemFieldValue[0].sys.id
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby/src/bootstrap/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const { initCache } = require(`../utils/cache`)
const report = require(`../reporter`)

// Show stack trace on unhandled promises.
process.on("unhandledRejection", (reason, p) => {
process.on(`unhandledRejection`, (reason, p) => {
report.panic(reason)
})

Expand Down