feat(gatsby-plugin-page-creator): Fix gatsby plugin page creator v4 (#…

…33120) * use onPluginInit in page creator and set entire program in workers * add gatsby-plugin-utils * remove logs * Update packages/gatsby/src/bootstrap/index.ts Co-authored-by: Ward Peeters <ward@coding-tech.com> * fix snapshot Co-authored-by: Ward Peeters <ward@coding-tech.com>
gatsbyjs · Sep 10, 2021 · 4837b72 · 4837b72
1 parent 3401149
commit 4837b72
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 32 deletions.
diff --git a/packages/gatsby-plugin-page-creator/package.json b/packages/gatsby-plugin-page-creator/package.json
@@ -30,6 +30,7 @@
     "chokidar": "^3.5.2",
     "fs-exists-cached": "^1.0.0",
     "gatsby-core-utils": "^2.14.0-next.2",
+    "gatsby-plugin-utils": "^1.14.0-next.2",
     "gatsby-page-utils": "^1.14.0-next.2",
     "gatsby-telemetry": "^2.14.0-next.2",
     "globby": "^11.0.4",

diff --git a/packages/gatsby-plugin-page-creator/src/gatsby-node.ts b/packages/gatsby-plugin-page-creator/src/gatsby-node.ts
@@ -23,6 +23,19 @@ import { derivePath } from "./derive-path"
 import { validatePathQuery } from "./validate-path-query"
 import { CODES, ERROR_MAP, prefixId } from "./error-utils"
 
+let coreSupportsOnPluginInit: `unstable` | `stable` | undefined
+
+try {
+  const { isGatsbyNodeLifecycleSupported } = require(`gatsby-plugin-utils`)
+  if (isGatsbyNodeLifecycleSupported(`onPluginInit`)) {
+    coreSupportsOnPluginInit = `stable`
+  } else if (isGatsbyNodeLifecycleSupported(`unstable_onPluginInit`)) {
+    coreSupportsOnPluginInit = `unstable`
+  }
+} catch (e) {
+  console.error(`Could not check if Gatsby supports onPluginInit lifecycle`)
+}
+
 interface IOptions extends PluginOptions {
   path: string
   pathCheck?: boolean
@@ -221,7 +234,7 @@ export function setFieldsOnGraphQLNodeType(
   }
 }
 
-export async function onPreInit(
+async function initializePlugin(
   { reporter }: ParentSpanPluginArgs,
   { path: pagesPath }: IOptions
 ): Promise<void> {
@@ -265,3 +278,12 @@ export async function onPreInit(
     })
   }
 }
+
+if (coreSupportsOnPluginInit === `stable`) {
+  // need to conditionally export otherwise it throws an error for older versions
+  exports.onPluginInit = initializePlugin
+} else if (coreSupportsOnPluginInit === `unstable`) {
+  exports.unstable_onPluginInit = initializePlugin
+} else {
+  exports.onPreInit = initializePlugin
+}
diff --git a/packages/gatsby/src/bootstrap/index.ts b/packages/gatsby/src/bootstrap/index.ts
@@ -50,9 +50,10 @@ export async function bootstrap(
   const workerPool = context.workerPool
 
   if (process.env.GATSBY_EXPERIMENTAL_PARALLEL_QUERY_RUNNING) {
-    const directory = slash(context.store.getState().program.directory)
+    const program = context.store.getState().program
+    const directory = slash(program.directory)
 
-    workerPool.all.loadConfigAndPlugins({ siteDirectory: directory })
+    workerPool.all.loadConfigAndPlugins({ siteDirectory: directory, program })
   }
 
   await customizeSchema(context)

diff --git a/packages/gatsby/src/bootstrap/load-config-and-plugins.ts b/packages/gatsby/src/bootstrap/load-config-and-plugins.ts
@@ -11,13 +11,15 @@ import loadThemes from "../bootstrap/load-themes"
 import { store } from "../redux"
 import handleFlags from "../utils/handle-flags"
 import availableFlags from "../utils/flags"
+import { IProgram } from "../commands/types"
 
 export async function loadConfigAndPlugins({
   siteDirectory,
   processFlags = false,
 }: {
   siteDirectory: string
   processFlags?: boolean
+  program?: IProgram
 }): Promise<{
   config: any
   flattenedPlugins: Array<IFlattenedPlugin>

diff --git a/packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.ts.snap b/packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.ts.snap
@@ -110,7 +110,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/dev-404-page/src/pages",
@@ -131,7 +131,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/load-babel-config/src/pages",
@@ -152,7 +152,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/internal-data-bridge/src/pages",
@@ -173,7 +173,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/prod-404/src/pages",
@@ -194,7 +194,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/webpack-theme-component-shadowing/src/pages",
@@ -215,7 +215,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/bundle-optimisations/src/pages",
@@ -236,7 +236,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/functions/src/pages",
@@ -292,7 +292,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "/src/pages",
@@ -429,7 +429,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/dev-404-page/src/pages",
@@ -450,7 +450,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/load-babel-config/src/pages",
@@ -471,7 +471,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/internal-data-bridge/src/pages",
@@ -492,7 +492,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/prod-404/src/pages",
@@ -513,7 +513,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/webpack-theme-component-shadowing/src/pages",
@@ -534,7 +534,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/bundle-optimisations/src/pages",
@@ -555,7 +555,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/functions/src/pages",
@@ -576,7 +576,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "__TEST__/src/pages",
@@ -632,7 +632,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "/src/pages",
@@ -757,7 +757,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "ignore": Array [
@@ -780,7 +780,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/dev-404-page/src/pages",
@@ -801,7 +801,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/load-babel-config/src/pages",
@@ -822,7 +822,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/internal-data-bridge/src/pages",
@@ -843,7 +843,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/prod-404/src/pages",
@@ -864,7 +864,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/webpack-theme-component-shadowing/src/pages",
@@ -885,7 +885,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/bundle-optimisations/src/pages",
@@ -906,7 +906,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby/src/internal-plugins/functions/src/pages",
@@ -927,7 +927,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "<PROJECT_ROOT>/packages/gatsby-plugin-page-creator/src/pages",
@@ -983,7 +983,7 @@ Array [
     "nodeAPIs": Array [
       "createPagesStatefully",
       "setFieldsOnGraphQLNodeType",
-      "onPreInit",
+      "unstable_onPluginInit",
     ],
     "pluginOptions": Object {
       "path": "/src/pages",

diff --git a/packages/gatsby/src/utils/worker/child/load-config-and-plugins.ts b/packages/gatsby/src/utils/worker/child/load-config-and-plugins.ts
@@ -5,12 +5,12 @@ import apiRunnerNode from "../../api-runner-node"
 export async function loadConfigAndPlugins(
   ...args: Parameters<typeof internalLoadConfigAndPlugins>
 ): Promise<void> {
-  const [{ siteDirectory }] = args
+  const [{ siteDirectory, program }] = args
 
   store.dispatch({
     type: `SET_PROGRAM`,
     payload: {
-      ...store.getState().program,
+      ...program,
       directory: siteDirectory,
     },
   })