feat(gatsby): PQR workers can access page & static queries (#31852)

* test(gatsby): check if worker can access node created in different process * make timeout longer for workerpool tests * test fixes from other pr * wip: saveStateForWorkers / loadStateInWorker * basic functionality + type fixes * wip (failing tests) * revert child * add redux state func * revert early return changes * initial * update tests and add env var * Restore pool.ts * updates * rename setExtractedSlices to setQueries * ignore all node_modules * rename GatsbyStateSlices type to GatsbyStateKeys to more accurately describe it Co-authored-by: Michal Piechowiak <misiek.piechowiak@gmail.com> Co-authored-by: gatsbybot <mathews.kyle+gatsbybot@gmail.com>
gatsbyjs · Jun 14, 2021 · 222a5ed · 222a5ed
1 parent 28ca867
commit 222a5ed
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 7 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -253,6 +253,7 @@ jobs:
       image: "14.17.0"
     environment:
       GATSBY_EXPERIMENTAL_LMDB_STORE: 1
+      GATSBY_EXPERIMENTAL_PARALLEL_QUERY_RUNNING: 1
     <<: *test_template
 
   integration_tests_gatsby_source_wordpress:

diff --git a/packages/gatsby/src/bootstrap/index.ts b/packages/gatsby/src/bootstrap/index.ts
@@ -16,6 +16,7 @@ import reporter from "gatsby-cli/lib/reporter"
 import { globalTracer } from "opentracing"
 import type { GatsbyWorkerPool } from "../utils/worker/pool"
 import { handleStalePageData } from "../utils/page-data"
+import { saveStateForWorkers } from "../redux"
 
 const tracer = globalTracer()
 
@@ -62,6 +63,10 @@ export async function bootstrap(
 
   await extractQueries(context)
 
+  if (process.env.GATSBY_EXPERIMENTAL_PARALLEL_QUERY_RUNNING) {
+    saveStateForWorkers([`components`, `staticQueryComponents`])
+  }
+
   await writeOutRedirects(context)
 
   startRedirectListener()

diff --git a/packages/gatsby/src/utils/worker/__tests__/share-state.ts b/packages/gatsby/src/utils/worker/__tests__/share-state.ts
@@ -170,6 +170,7 @@ describe(`worker (share-state)`, () => {
 
   it(`can set slices results into state and access it`, async () => {
     worker = createTestWorker()
+    const staticQueryID = `1`
 
     store.dispatch({
       type: `CREATE_PAGE`,
@@ -179,20 +180,57 @@ describe(`worker (share-state)`, () => {
       },
     })
 
-    const slices: Array<GatsbyStateKeys> = [`components`]
+    store.dispatch({
+      type: `REPLACE_STATIC_QUERY`,
+      plugin: {
+        name: `test`,
+      },
+      payload: {
+        name: `foo`,
+        componentPath: dummyPagePayload.component,
+        id: staticQueryID,
+        query: `I'm a static query`,
+        hash: `hash`,
+      },
+    })
 
-    saveStateForWorkers(slices)
+    store.dispatch({
+      type: `QUERY_EXTRACTED`,
+      payload: {
+        componentPath: `/foo`,
+        componentChunkName: `foo`,
+        query: `I'm a page query`,
+      },
+      plugin: {
+        name: `test`,
+      },
+    })
 
-    await worker.setState(slices)
+    saveStateForWorkers([`components`, `staticQueryComponents`])
 
-    const res = await worker.getComponent(dummyPagePayload.component)
+    await worker.setQueries()
 
-    expect(res).toMatchInlineSnapshot(`
+    const components = await worker.getComponent(dummyPagePayload.component)
+    const staticQueryComponents = await worker.getStaticQueryComponent(
+      staticQueryID
+    )
+
+    expect(components).toMatchInlineSnapshot(`
       Object {
         "componentPath": "/foo",
         "isInBootstrap": true,
         "pages": Object {},
-        "query": "",
+        "query": "I'm a page query",
+      }
+    `)
+
+    expect(staticQueryComponents).toMatchInlineSnapshot(`
+      Object {
+        "componentPath": "/foo",
+        "hash": "hash",
+        "id": "1",
+        "name": "foo",
+        "query": "I'm a static query",
       }
     `)
   })

diff --git a/packages/gatsby/src/utils/worker/__tests__/test-helpers/child-for-tests.ts b/packages/gatsby/src/utils/worker/__tests__/test-helpers/child-for-tests.ts
@@ -1,6 +1,10 @@
 import { getNode } from "../../../../datastore"
 import { store } from "../../../../redux"
-import { IGatsbyPage, IGatsbyPageComponent } from "../../../../redux/types"
+import {
+  IGatsbyPage,
+  IGatsbyPageComponent,
+  IGatsbyStaticQueryComponents,
+} from "../../../../redux/types"
 import reporter from "gatsby-cli/lib/reporter"
 import apiRunner from "../../../api-runner-node"
 
@@ -24,6 +28,11 @@ export function getComponent(
 ): IGatsbyPageComponent | undefined {
   return store.getState().components.get(componentPath)
 }
+export function getStaticQueryComponent(
+  id: IGatsbyStaticQueryComponents["id"]
+): IGatsbyStaticQueryComponents | undefined {
+  return store.getState().staticQueryComponents.get(id)
+}
 
 // test: reporter
 export function log(message: string): boolean {

diff --git a/packages/gatsby/src/utils/worker/child/index.ts b/packages/gatsby/src/utils/worker/child/index.ts
@@ -1,3 +1,4 @@
 // Note: this doesn't check for conflicts between module exports
 export { renderHTMLProd, renderHTMLDev } from "./render-html"
+export { setQueries } from "./schema"
 export { loadConfigAndPlugins } from "./load-config-and-plugins"
diff --git a/packages/gatsby/src/utils/worker/child/schema.ts b/packages/gatsby/src/utils/worker/child/schema.ts
@@ -0,0 +1,5 @@
+import { setState } from "./state"
+
+export function setQueries(): void {
+  setState([`components`, `staticQueryComponents`])
+}