Skip to content

fix(gatsby): always add both childField and childrenField in GraphQL #28656

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

Merged
merged 9 commits into from
Dec 17, 2020
Merged

fix(gatsby): always add both childField and childrenField in GraphQL #28656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
26a74d4
fix(gatsby): always add both `childField` and `childrenField` in GraphQL
vladar Dec 16, 2020
9f4d803
Update docs
vladar Dec 16, 2020
dc573f6
fix null reference
vladar Dec 16, 2020
8eaef4b
Update tests
vladar Dec 16, 2020
dab3476
TODO item to remove `many` arg in `v3`
vladar Dec 16, 2020
8ea1859
Update snapshot
vladar Dec 16, 2020
e2021b0
add description to convenience child fields
vladar Dec 17, 2020
dade5bd
update description
vladar Dec 17, 2020
8687e2c
Revert docs for now
vladar Dec 17, 2020
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
2 changes: 1 addition & 1 deletion packages/gatsby/src/schema/__tests__/__snapshots__/build-schema.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ directive @mimeTypes(
) on OBJECT

\\"\\"\\"
Define parent-child relations between types. This is used to add \`child*\` or
Define parent-child relations between types. This is used to add \`child*\` and
\`children*\` convenience fields like \`childImageSharp\`.
\\"\\"\\"
directive @childOf(
Expand Down
15 changes: 15 additions & 0 deletions packages/gatsby/src/schema/__tests__/__snapshots__/kitchen-sink.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Object {
"childImageSharp": Object {
"id": "0b06bdfe-f253-5859-8321-b42b5d737195",
},
"childrenImageSharp": Array [
Object {
"id": "0b06bdfe-f253-5859-8321-b42b5d737195",
},
],
},
"time": "06 kesäkuu",
},
Expand All @@ -64,6 +69,11 @@ Object {
"childImageSharp": Object {
"id": "f5f0e564-899f-5bbc-92de-a2325b69cb75",
},
"childrenImageSharp": Array [
Object {
"id": "f5f0e564-899f-5bbc-92de-a2325b69cb75",
},
],
},
"likes": 8,
"localeFormat": "05 huhtikuu 2017",
Expand All @@ -83,6 +93,11 @@ Object {
"childImageSharp": Object {
"id": "6ba97198-5331-53d6-a0e0-c9c063c5094e",
},
"childrenImageSharp": Array [
Object {
"id": "6ba97198-5331-53d6-a0e0-c9c063c5094e",
},
],
},
"likes": 9,
"localeFormat": "11 syyskuu 2017",
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby/src/schema/__tests__/__snapshots__/rebuild-schema.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ directive @mimeTypes(
) on OBJECT

\\"\\"\\"
Define parent-child relations between types. This is used to add \`child*\` or
Define parent-child relations between types. This is used to add \`child*\` and
\`children*\` convenience fields like \`childImageSharp\`.
\\"\\"\\"
directive @childOf(
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby/src/schema/__tests__/build-node-connections.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ describe(`build-node-connections`, () => {
childRelative { # lol
id
}
childrenRelative {
id
}
}
}
}
Expand All @@ -193,6 +196,9 @@ describe(`build-node-connections`, () => {

expect(allParent.edges[0].node.childRelative).toBeDefined()
expect(allParent.edges[0].node.childRelative.id).toEqual(`r1`)

expect(allParent.edges[0].node.childrenRelative).toBeDefined()
expect(allParent.edges[0].node.childrenRelative).toEqual([{ id: `r1` }])
})

it(`should create page dependency`, async () => {
Expand Down
8 changes: 7 additions & 1 deletion packages/gatsby/src/schema/__tests__/build-node-types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,19 +154,25 @@ describe(`build-node-types`, () => {
})

it(`should create typed children fields`, async () => {
let { parent } = await runQuery(
const { parent } = await runQuery(
`
{
parent(id: { eq: "p1" }) {
childrenChild { # lol
id
}
childChild {
id
}
}
}
`
)
expect(parent.childrenChild).toBeDefined()
expect(parent.childrenChild.map(c => c.id)).toEqual([`c1`, `c2`])

expect(parent.childChild).toBeDefined()
expect(parent.childChild).toEqual({ id: `c1` })
})

it(`should create typed child field for singular children`, async () => {
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby/src/schema/__tests__/kitchen-sink.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ describe(`Kitchen sink schema test`, () => {
childImageSharp {
id
}
childrenImageSharp {
id
}
}
}
}
Expand All @@ -146,6 +149,9 @@ describe(`Kitchen sink schema test`, () => {
childImageSharp {
id
}
childrenImageSharp {
id
}
}
_3invalidKey
}
Expand Down
12 changes: 12 additions & 0 deletions packages/gatsby/src/schema/__tests__/queries.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ describe(`Query schema`, () => {
edges {
node {
childMarkdown { frontmatter { title } }
childrenMarkdown { frontmatter { title } }
}
}
}
Expand All @@ -236,16 +237,23 @@ describe(`Query schema`, () => {
{
node: {
childMarkdown: { frontmatter: { title: `Markdown File 1` } },
childrenMarkdown: [
{ frontmatter: { title: `Markdown File 1` } },
],
},
},
{
node: {
childMarkdown: { frontmatter: { title: `Markdown File 2` } },
childrenMarkdown: [
{ frontmatter: { title: `Markdown File 2` } },
],
},
},
{
node: {
childMarkdown: null,
childrenMarkdown: [],
},
},
],
Expand All @@ -261,6 +269,7 @@ describe(`Query schema`, () => {
allFile {
edges {
node {
childAuthor { name }
childrenAuthor { name }
}
}
Expand All @@ -273,16 +282,19 @@ describe(`Query schema`, () => {
edges: [
{
node: {
childAuthor: null,
childrenAuthor: [],
},
},
{
node: {
childAuthor: null,
childrenAuthor: [],
},
},
{
node: {
childAuthor: { name: `Author 2` },
childrenAuthor: [{ name: `Author 2` }, { name: `Author 1` }],
},
},
Expand Down
9 changes: 7 additions & 2 deletions packages/gatsby/src/schema/__tests__/rebuild-schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,9 @@ describe(`build and update individual types`, () => {
const fields = newSchema.getType(`Foo`).getFields()
const fieldNames = Object.keys(fields).sort()
expect(fieldNames).toEqual(
initialFooFields.concat(`childBar`, `childBaz`).sort()
initialFooFields
.concat(`childBar`, `childBaz`, `childrenBar`, `childrenBaz`)
.sort()
)
expect(String(fields.childBar.type)).toEqual(`Bar`)
expect(String(fields.childBaz.type)).toEqual(`Baz`)
Expand Down Expand Up @@ -573,7 +575,10 @@ describe(`build and update individual types`, () => {

const fields = newSchema.getType(`Foo`).getFields()
const fieldNames = Object.keys(fields).sort()
expect(fieldNames).toEqual(initialFooFields.concat(`childrenBar`).sort())
expect(fieldNames).toEqual(
initialFooFields.concat(`childBar`, `childrenBar`).sort()
)
expect(String(fields.childBar.type)).toEqual(`Bar`)
expect(String(fields.childrenBar.type)).toEqual(`[Bar]`)

await expectSymmetricDelete(nodes)
Expand Down
50 changes: 29 additions & 21 deletions packages/gatsby/src/schema/extensions/__tests__/child-relations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,15 +167,16 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Child implements Node {
id: ID!
}
type AnotherChild implements Node @childOf(types: ["Parent"], many: true) {
type AnotherChild implements Node @childOf(types: ["Parent"]) {
id: ID!
}
`)
)
await buildSchema()
expect(report.warn).toBeCalledTimes(1)
expect(report.warn.mock.calls[0][0]).toEqual(
`Deprecation warning: In Gatsby v3 field \`Parent.childChild\` will not be added automatically ` +
`Deprecation warning: In Gatsby v3 fields \`Parent.childChild\` and \`Parent.childrenChild\` ` +
`will not be added automatically ` +
`because type \`Child\` does not explicitly list type \`Parent\` in \`childOf\` extension.\n` +
`Add the following type definition to fix this:\n\n` +
` type Child implements Node @childOf(types: ["Parent"]) {\n` +
Expand All @@ -185,19 +186,19 @@ describe(`Define parent-child relationships with field extensions`, () => {
)
})

it(`adds child fields to parent type with childOf(many: true) extension`, async () => {
it(`adds children[Field] field to parent type with childOf extension`, async () => {
dispatch(
createTypes(`
type Parent implements Node @dontInfer {
id: ID!
}
type Child implements Node @childOf(types: ["Parent"], many: true) {
type Child implements Node @childOf(types: ["Parent"]) {
id: ID!
}
type AnotherChild implements Node @childOf(types: ["Parent"], many: true) {
type AnotherChild implements Node @childOf(types: ["Parent"]) {
id: ID!
}
type ChildWithoutNodes implements Node @childOf(types: ["Parent"], many: true) {
type ChildWithoutNodes implements Node @childOf(types: ["Parent"]) {
id: ID!
}
`)
Expand All @@ -209,10 +210,12 @@ describe(`Define parent-child relationships with field extensions`, () => {
// expect(parentFields.childChild).toBeUndefined() // Deprecated, see above
expect(parentFields.childrenAnotherChild).toBeDefined()
expect(parentFields.childrenAnotherChild.resolve).toBeDefined()
expect(parentFields.childAnotherChild).toBeUndefined()
expect(parentFields.childAnotherChild).toBeDefined()
expect(parentFields.childAnotherChild.resolve).toBeDefined()
expect(parentFields.childrenChildWithoutNodes).toBeDefined()
expect(parentFields.childrenChildWithoutNodes.resolve).toBeDefined()
expect(parentFields.childChildWithoutNodes).toBeUndefined()
expect(parentFields.childChildWithoutNodes).toBeDefined()
expect(parentFields.childChildWithoutNodes.resolve).toBeDefined()
})

it(`shows error when childOf extension is used on type that does not implement the Node interface`, async () => {
Expand All @@ -239,7 +242,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Child implements Node @childOf(types: ["Parent"]) {
name: String
}
type AnotherChild implements Node @childOf(types: ["Parent"], many: true) {
type AnotherChild implements Node @childOf(types: ["Parent"]) {
name: String
}
type ChildWithoutNodes implements Node @childOf(types: ["Parent"]) {
Expand Down Expand Up @@ -330,7 +333,6 @@ describe(`Define parent-child relationships with field extensions`, () => {
extensions: {
childOf: {
types: [`Parent`],
many: true,
},
},
}),
Expand Down Expand Up @@ -411,7 +413,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Child implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
id: ID!
}
type AnotherChild implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"], many: true) {
type AnotherChild implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
id: ID!
}
type ChildWithoutNodes implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
Expand All @@ -423,23 +425,29 @@ describe(`Define parent-child relationships with field extensions`, () => {
const parentFields = schema.getType(`Parent`).getFields()
expect(parentFields.childChild).toBeDefined()
expect(parentFields.childChild.resolve).toBeDefined()
expect(parentFields.childrenChild).toBeUndefined()
expect(parentFields.childrenChild).toBeDefined()
expect(parentFields.childrenChild.resolve).toBeDefined()
expect(parentFields.childrenAnotherChild).toBeDefined()
expect(parentFields.childrenAnotherChild.resolve).toBeDefined()
expect(parentFields.childAnotherChild).toBeUndefined()
expect(parentFields.childAnotherChild).toBeDefined()
expect(parentFields.childAnotherChild.resolve).toBeDefined()
expect(parentFields.childChildWithoutNodes).toBeDefined()
expect(parentFields.childChildWithoutNodes.resolve).toBeDefined()
expect(parentFields.childChildrenWithoutNodes).toBeUndefined()
expect(parentFields.childrenChildWithoutNodes).toBeDefined()
expect(parentFields.childrenChildWithoutNodes.resolve).toBeDefined()
const relativeFields = schema.getType(`Relative`).getFields()
expect(relativeFields.childChild).toBeDefined()
expect(relativeFields.childChild.resolve).toBeDefined()
expect(relativeFields.childrenChild).toBeUndefined()
expect(relativeFields.childrenChild).toBeDefined()
expect(relativeFields.childrenChild.resolve).toBeDefined()
expect(relativeFields.childrenAnotherChild).toBeDefined()
expect(relativeFields.childrenAnotherChild.resolve).toBeDefined()
expect(relativeFields.childAnotherChild).toBeUndefined()
expect(relativeFields.childAnotherChild).toBeDefined()
expect(relativeFields.childAnotherChild.resolve).toBeDefined()
expect(relativeFields.childChildWithoutNodes).toBeDefined()
expect(relativeFields.childChildWithoutNodes.resolve).toBeDefined()
expect(relativeFields.childChildrenWithoutNodes).toBeUndefined()
expect(relativeFields.childrenChildWithoutNodes).toBeDefined()
expect(relativeFields.childrenChildWithoutNodes.resolve).toBeDefined()
})

it(`returns correct query results for mime-types`, async () => {
Expand All @@ -454,7 +462,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Child implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
name: String
}
type AnotherChild implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"], many: true) {
type AnotherChild implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
name: String
}
type ChildWithoutNodes implements Node @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
Expand Down Expand Up @@ -533,7 +541,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Child implements Node @childOf(types: ["Relative"], mimeTypes: ["application/listenup"]) {
name: String
}
type AnotherChild implements Node @childOf(types: ["Relative"], mimeTypes: ["multipart/related"], many: true) {
type AnotherChild implements Node @childOf(types: ["Relative"], mimeTypes: ["multipart/related"]) {
name: String
}
`)
Expand Down Expand Up @@ -598,7 +606,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Relative implements Node @dontInfer @mimeTypes(types: ["multipart/related"]) {
id: ID!
}
interface NextGeneration @nodeInterface @childOf(mimeTypes: ["application/listenup", "multipart/related"], many: true) {
interface NextGeneration @nodeInterface @childOf(mimeTypes: ["application/listenup", "multipart/related"]) {
id: ID!
name: String
}
Expand Down Expand Up @@ -688,7 +696,7 @@ describe(`Define parent-child relationships with field extensions`, () => {
type Parent implements Node & Ancestors {
id: ID!
}
type AnotherChild implements Node @childOf(types: ["Ancestors"], many: true) {
type AnotherChild implements Node @childOf(types: ["Ancestors"]) {
name: String
}
`)
Expand Down
4 changes: 3 additions & 1 deletion packages/gatsby/src/schema/extensions/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ const typeExtensions = {
childOf: {
description:
`Define parent-child relations between types. This is used to add ` +
`\`child*\` or \`children*\` convenience fields like \`childImageSharp\`.`,
`\`child*\` and \`children*\` convenience fields like \`childImageSharp\`.`,
args: {
mimeTypes: {
type: `[String!]!`,
Expand All @@ -75,9 +75,11 @@ const typeExtensions = {
`types handled by a transformer plugin.`,
},
many: {
// TODO: Remove in Gatsby v3
type: `Boolean!`,
defaultValue: false,
description: `Specifies whether a parent can have multiple children of this type or not.`,
deprecationReason: `No-op. We always add both \`child[Field]\` and \`children[Field]\` to the parent type`,
},
},
},
Expand Down
Loading