Skip to content

Commit ac2a54a

Browse files
stefanprobstpieh
stefanprobst
authored and
pieh
committed
chore: use null not "SOURCE" as parent of top level nodes (#10920)
1 parent fdcbe65 commit ac2a54a

File tree

17 files changed

+42
-42
lines changed

17 files changed

+42
-42
lines changed

‎docs/docs/node-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A node is stored in redux under the `nodes` namespace, whose state is a map of t
88

99
## Sourcing Nodes
1010

11-
The creation of nodes occurs primarily in the [sourceNodes](/docs/node-apis/#sourceNodes) bootstrap phase. Nodes created during this phase are top level nodes. I.e, they have no parent. This is represented by source plugins setting the node's `parent` field to `___SOURCE___`. Nodes created via transform plugins (who implement [onCreateNode](/docs/node-apis/#onCreateNode)) will have source nodes as their parents, or other transformed nodes. For a rough overview of what happens when source nodes run, see the [traceID illustration](/docs/how-plugins-apis-are-run/#using-traceid-to-await-downstream-api-calls).
11+
The creation of nodes occurs primarily in the [sourceNodes](/docs/node-apis/#sourceNodes) bootstrap phase. Nodes created during this phase are top level nodes. I.e, they have no parent. This is represented by source plugins setting the node's `parent` field to `null`. Nodes created via transform plugins (who implement [onCreateNode](/docs/node-apis/#onCreateNode)) will have source nodes as their parents, or other transformed nodes. For a rough overview of what happens when source nodes run, see the [traceID illustration](/docs/how-plugins-apis-are-run/#using-traceid-to-await-downstream-api-calls).
1212

1313
## Parent/Child/Refs
1414

‎packages/gatsby-source-filesystem/src/create-file-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ exports.createFileNode = async (
5757
// useful information.
5858
id: createNodeId(pathToFile),
5959
children: [],
60-
parent: `___SOURCE___`,
60+
parent: null,
6161
internal,
6262
sourceInstanceName: pluginOptions.name || `__PROGRAMMATIC__`,
6363
absolutePath: slashedFile.absolutePath,

‎packages/gatsby-transformer-csv/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ false,\\"nope\\"",
5858
"mediaType": "text/csv",
5959
},
6060
"name": "test",
61-
"parent": "SOURCE",
61+
"parent": null,
6262
},
6363
},
6464
],
@@ -87,7 +87,7 @@ false,\\"nope\\"",
8787
"mediaType": "text/csv",
8888
},
8989
"name": "test",
90-
"parent": "SOURCE",
90+
"parent": null,
9191
},
9292
},
9393
],
@@ -165,7 +165,7 @@ false,nope",
165165
"mediaType": "text/csv",
166166
},
167167
"name": "test",
168-
"parent": "SOURCE",
168+
"parent": null,
169169
},
170170
},
171171
],
@@ -194,7 +194,7 @@ false,nope",
194194
"mediaType": "text/csv",
195195
},
196196
"name": "test",
197-
"parent": "SOURCE",
197+
"parent": null,
198198
},
199199
},
200200
],
@@ -223,7 +223,7 @@ false,nope",
223223
"mediaType": "text/csv",
224224
},
225225
"name": "test",
226-
"parent": "SOURCE",
226+
"parent": null,
227227
},
228228
},
229229
],

‎packages/gatsby-transformer-csv/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const { onCreateNode } = require(`../gatsby-node`)
66
describe(`Process nodes correctly`, () => {
77
const node = {
88
id: `whatever`,
9-
parent: `SOURCE`,
9+
parent: null,
1010
children: [],
1111
extension: `csv`,
1212
internal: {

‎packages/gatsby-transformer-excel/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ FALSE,nope
7070
"mediaType": "text/csv",
7171
},
7272
"name": "test",
73-
"parent": "SOURCE",
73+
"parent": null,
7474
},
7575
},
7676
],
@@ -100,7 +100,7 @@ FALSE,nope
100100
"mediaType": "text/csv",
101101
},
102102
"name": "test",
103-
"parent": "SOURCE",
103+
"parent": null,
104104
},
105105
},
106106
],
@@ -128,7 +128,7 @@ FALSE,nope
128128
"mediaType": "text/csv",
129129
},
130130
"name": "test",
131-
"parent": "SOURCE",
131+
"parent": null,
132132
},
133133
},
134134
],
@@ -205,7 +205,7 @@ FALSE,nada
205205
"mediaType": "text/csv",
206206
},
207207
"name": "test",
208-
"parent": "SOURCE",
208+
"parent": null,
209209
},
210210
},
211211
],
@@ -235,7 +235,7 @@ FALSE,nada
235235
"mediaType": "text/csv",
236236
},
237237
"name": "test",
238-
"parent": "SOURCE",
238+
"parent": null,
239239
},
240240
},
241241
],
@@ -263,7 +263,7 @@ FALSE,nada
263263
"mediaType": "text/csv",
264264
},
265265
"name": "test",
266-
"parent": "SOURCE",
266+
"parent": null,
267267
},
268268
},
269269
],
@@ -340,7 +340,7 @@ FALSE,nada
340340
"mediaType": "text/csv",
341341
},
342342
"name": "test",
343-
"parent": "SOURCE",
343+
"parent": null,
344344
},
345345
},
346346
],
@@ -370,7 +370,7 @@ FALSE,nada
370370
"mediaType": "text/csv",
371371
},
372372
"name": "test",
373-
"parent": "SOURCE",
373+
"parent": null,
374374
},
375375
},
376376
],
@@ -398,7 +398,7 @@ FALSE,nada
398398
"mediaType": "text/csv",
399399
},
400400
"name": "test",
401-
"parent": "SOURCE",
401+
"parent": null,
402402
},
403403
},
404404
],

‎packages/gatsby-transformer-excel/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const { onCreateNode } = require(`../gatsby-node`)
66
describe(`Process nodes correctly`, () => {
77
const node = {
88
id: `whatever`,
9-
parent: `SOURCE`,
9+
parent: null,
1010
children: [],
1111
extension: `csv`,
1212
internal: {

‎packages/gatsby-transformer-hjson/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Array [
4848
"name": "test",
4949
},
5050
"name": "nodeName",
51-
"parent": "SOURCE",
51+
"parent": null,
5252
},
5353
},
5454
],
@@ -121,7 +121,7 @@ Array [
121121
"name": "test",
122122
},
123123
"name": "nodeName",
124-
"parent": "SOURCE",
124+
"parent": null,
125125
},
126126
},
127127
],
@@ -158,7 +158,7 @@ Array [
158158
"name": "test",
159159
},
160160
"name": "nodeName",
161-
"parent": "SOURCE",
161+
"parent": null,
162162
},
163163
},
164164
],

‎packages/gatsby-transformer-hjson/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ describe(`Process HJSON nodes correctly`, () => {
77
const node = {
88
name: `nodeName`,
99
id: `whatever`,
10-
parent: `SOURCE`,
10+
parent: null,
1111
children: [],
1212
internal: {
1313
contentDigest: `whatever`,

‎packages/gatsby-transformer-json/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Array [
4444
"type": "File",
4545
},
4646
"name": "nodeName",
47-
"parent": "SOURCE",
47+
"parent": null,
4848
},
4949
},
5050
],
@@ -93,7 +93,7 @@ Array [
9393
"mediaType": "application/json",
9494
"type": "NotFile",
9595
},
96-
"parent": "SOURCE",
96+
"parent": null,
9797
},
9898
},
9999
],
@@ -157,7 +157,7 @@ Array [
157157
"type": "File",
158158
},
159159
"name": "nodeName",
160-
"parent": "SOURCE",
160+
"parent": null,
161161
},
162162
},
163163
],
@@ -185,7 +185,7 @@ Array [
185185
"type": "File",
186186
},
187187
"name": "nodeName",
188-
"parent": "SOURCE",
188+
"parent": null,
189189
},
190190
},
191191
],
@@ -247,7 +247,7 @@ Array [
247247
"mediaType": "application/json",
248248
"type": "NotFile",
249249
},
250-
"parent": "SOURCE",
250+
"parent": null,
251251
},
252252
},
253253
],
@@ -273,7 +273,7 @@ Array [
273273
"mediaType": "application/json",
274274
"type": "NotFile",
275275
},
276-
"parent": "SOURCE",
276+
"parent": null,
277277
},
278278
},
279279
],

‎packages/gatsby-transformer-json/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const bootstrapTest = async (node, pluginOptions = {}) => {
3333
describe(`Process JSON nodes correctly`, () => {
3434
const baseNode = {
3535
id: `whatever`,
36-
parent: `SOURCE`,
36+
parent: null,
3737
children: [],
3838
internal: {
3939
contentDigest: `whatever`,

‎packages/gatsby-transformer-toml/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Array [
9797
"contentDigest": "whatever",
9898
},
9999
"name": "test",
100-
"parent": "SOURCE",
100+
"parent": null,
101101
},
102102
},
103103
],

‎packages/gatsby-transformer-toml/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const { onCreateNode } = require(`../gatsby-node`)
33
describe(`Process TOML nodes correctly`, () => {
44
const node = {
55
id: `whatever`,
6-
parent: `SOURCE`,
6+
parent: null,
77
children: [],
88
extension: `toml`,
99
internal: {

‎packages/gatsby-transformer-xml/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Array [
206206
"name": "test",
207207
},
208208
"name": "nodeName",
209-
"parent": "SOURCE",
209+
"parent": null,
210210
},
211211
},
212212
],
@@ -299,7 +299,7 @@ Array [
299299
"name": "test",
300300
},
301301
"name": "nodeName",
302-
"parent": "SOURCE",
302+
"parent": null,
303303
},
304304
},
305305
],

‎packages/gatsby-transformer-xml/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ describe(`Process XML nodes correctly`, () => {
55
const node = {
66
name: `nodeName`,
77
id: `whatever`,
8-
parent: `SOURCE`,
8+
parent: null,
99
children: [],
1010
internal: {
1111
contentDigest: `whatever`,

‎packages/gatsby-transformer-yaml/src/__tests__/__snapshots__/gatsby-node.js.snap

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ funny: yup
4545
"mediaType": "text/yaml",
4646
},
4747
"name": "test",
48-
"parent": "SOURCE",
48+
"parent": null,
4949
},
5050
},
5151
],
@@ -111,7 +111,7 @@ Array [
111111
"mediaType": "text/yaml",
112112
},
113113
"name": "test",
114-
"parent": "SOURCE",
114+
"parent": null,
115115
},
116116
},
117117
],
@@ -141,7 +141,7 @@ Array [
141141
"mediaType": "text/yaml",
142142
},
143143
"name": "test",
144-
"parent": "SOURCE",
144+
"parent": null,
145145
},
146146
},
147147
],

‎packages/gatsby-transformer-yaml/src/__tests__/gatsby-node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const { onCreateNode } = require(`../gatsby-node`)
66
describe(`Process YAML nodes correctly`, () => {
77
const node = {
88
id: `whatever`,
9-
parent: `SOURCE`,
9+
parent: null,
1010
children: [],
1111
internal: {
1212
contentDigest: `whatever`,

‎packages/gatsby/src/internal-plugins/internal-data-bridge/gatsby-node.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ exports.sourceNodes = ({ createContentDigest, actions, store }) => {
5353
createNode({
5454
...page,
5555
id: createPageId(page.path),
56-
parent: `SOURCE`,
56+
parent: null,
5757
children: [],
5858
internal: {
5959
type: `SitePage`,
@@ -68,7 +68,7 @@ exports.sourceNodes = ({ createContentDigest, actions, store }) => {
6868
packageJson: transformPackageJson(
6969
require(`${plugin.resolve}/package.json`)
7070
),
71-
parent: `SOURCE`,
71+
parent: null,
7272
children: [],
7373
internal: {
7474
contentDigest: createContentDigest(plugin),
@@ -98,7 +98,7 @@ exports.sourceNodes = ({ createContentDigest, actions, store }) => {
9898
createNode({
9999
...node,
100100
id: `Site`,
101-
parent: `SOURCE`,
101+
parent: null,
102102
children: [],
103103
internal: {
104104
contentDigest: createContentDigest(node),
@@ -138,7 +138,7 @@ exports.onCreatePage = ({ createContentDigest, page, actions }) => {
138138
createNode({
139139
...pageWithoutUpdated,
140140
id: createPageId(page.path),
141-
parent: `SOURCE`,
141+
parent: null,
142142
children: [],
143143
internal: {
144144
type: `SitePage`,

0 commit comments

Comments
 (0)