chore(gatsby): Migrate graphql-runner into TypeScript (#22860)

* feat: typed graphql-runner * fix: anything else context can also be boolean (graphql-runner.ts:L55) * refactor: format * fix: caling default export from ts * fix: defining default in test suite * cleanup PR * fix ci * fix lint again * fix ci again * update snapshot Co-authored-by: Blaine Kasten <blainekasten@gmail.com>
gatsbyjs · Apr 9, 2020 · 5037e9d · 5037e9d
1 parent 246c39c
commit 5037e9d
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 19 deletions.
diff --git a/...ts__/__snapshots__/graphql-runner.js.snap → ...snapshots__/create-graphql-runner.js.snap b/...ts__/__snapshots__/graphql-runner.js.snap → ...snapshots__/create-graphql-runner.js.snap
diff --git a/...src/bootstrap/__tests__/graphql-runner.js → ...tstrap/__tests__/create-graphql-runner.js b/...src/bootstrap/__tests__/graphql-runner.js → ...tstrap/__tests__/create-graphql-runner.js
@@ -1,6 +1,6 @@
 jest.mock(`graphql`)
 
-const createGraphqlRunner = require(`../graphql-runner`)
+import { createGraphQLRunner } from "../create-graphql-runner"
 const { execute, validate, parse } = require(`graphql`)
 
 parse.mockImplementation(() => {
@@ -31,7 +31,7 @@ describe(`grapqhl-runner`, () => {
   })
 
   it(`should return the result when grapqhl has no errors`, async () => {
-    const graphqlRunner = createGraphqlRunner(createStore(), reporter)
+    const graphqlRunner = createGraphQLRunner(createStore(), reporter)
 
     const expectation = {
       data: {
@@ -46,7 +46,7 @@ describe(`grapqhl-runner`, () => {
   })
 
   it(`should return an errors array when structured errors found`, async () => {
-    const graphqlRunner = createGraphqlRunner(createStore(), reporter)
+    const graphqlRunner = createGraphQLRunner(createStore(), reporter)
 
     const expectation = {
       errors: [
@@ -64,7 +64,7 @@ describe(`grapqhl-runner`, () => {
   })
 
   it(`should throw a structured error when created from createPage file`, async () => {
-    const graphqlRunner = createGraphqlRunner(createStore(), reporter)
+    const graphqlRunner = createGraphQLRunner(createStore(), reporter)
 
     const errorObject = {
       stack: `Error

diff --git a/...es/gatsby/src/bootstrap/graphql-runner.js → ...by/src/bootstrap/create-graphql-runner.ts b/...es/gatsby/src/bootstrap/graphql-runner.js → ...by/src/bootstrap/create-graphql-runner.ts
@@ -1,14 +1,27 @@
-const stackTrace = require(`stack-trace`)
+import stackTrace from "stack-trace"
+import { ExecutionResultDataDefault } from "graphql/execution/execute"
+import { Store } from "redux"
 
-const GraphQLRunner = require(`../query/graphql-runner`).default
-const errorParser = require(`../query/error-parser`).default
+import GraphQLRunner from "../query/graphql-runner"
+import errorParser from "../query/error-parser"
+import { emitter } from "../redux"
+import { Reporter } from "../.."
+import { ExecutionResult, Source } from "../../graphql"
+import { IGatsbyState } from "../redux/types"
 
-const { emitter } = require(`../redux`)
+type Runner = (
+  query: string | Source,
+  context: Record<string, any>
+) => Promise<ExecutionResult<ExecutionResultDataDefault>>
 
-module.exports = (store, reporter) => {
+export const createGraphQLRunner = (
+  store: Store<IGatsbyState>,
+  reporter: Reporter
+): Runner => {
   // TODO: Move tracking of changed state inside GraphQLRunner itself. https://github.com/gatsbyjs/gatsby/issues/20941
   let runner = new GraphQLRunner(store)
-  ;[
+
+  const eventTypes: string[] = [
     `DELETE_CACHE`,
     `CREATE_NODE`,
     `DELETE_NODE`,
@@ -17,28 +30,34 @@ module.exports = (store, reporter) => {
     `SET_SCHEMA`,
     `ADD_FIELD_TO_NODE`,
     `ADD_CHILD_NODE_TO_PARENT_NODE`,
-  ].forEach(eventType => {
-    emitter.on(eventType, event => {
+  ]
+
+  eventTypes.forEach(type => {
+    emitter.on(type, () => {
       runner = new GraphQLRunner(store)
     })
   })
-  return (query, context) =>
+
+  return (query, context): ReturnType<Runner> =>
     runner.query(query, context).then(result => {
       if (result.errors) {
         const structuredErrors = result.errors
           .map(e => {
             // Find the file where graphql was called.
             const file = stackTrace
               .parse(e)
-              .find(file => /createPages/.test(file.functionName))
+              .find(file => /createPages/.test(file.getFunctionName()))
 
             if (file) {
               const structuredError = errorParser({
                 message: e.message,
                 location: {
-                  start: { line: file.lineNumber, column: file.columnNumber },
+                  start: {
+                    line: file.getLineNumber(),
+                    column: file.getColumnNumber(),
+                  },
                 },
-                filePath: file.fileName,
+                filePath: file.getFileName(),
               })
               structuredError.context = {
                 ...structuredError.context,

diff --git a/packages/gatsby/src/bootstrap/index.js b/packages/gatsby/src/bootstrap/index.js
@@ -28,7 +28,7 @@ process.on(`unhandledRejection`, (reason, p) => {
   report.panic(reason)
 })
 
-const createGraphqlRunner = require(`./graphql-runner`)
+import { createGraphQLRunner } from "./create-graphql-runner"
 const { extractQueries } = require(`../query/query-watcher`)
 const requiresWriter = require(`./requires-writer`)
 const { writeRedirects } = require(`./redirects-writer`)
@@ -469,7 +469,7 @@ module.exports = async (args: BootstrapArgs) => {
     payload: _.flattenDeep([extensions, apiResults]),
   })
 
-  const graphqlRunner = createGraphqlRunner(store, report)
+  const graphqlRunner = createGraphQLRunner(store, report)
 
   // Collect pages.
   activity = report.activityTimer(`createPages`, {

diff --git a/packages/gatsby/src/types.ts b/packages/gatsby/src/types.ts
@@ -2,7 +2,7 @@ export interface IMatch {
   id: string
   context: {
     sourceMessage: string
-    [key: string]: string
+    [key: string]: string | boolean
   }
   error?: Error | undefined
   [key: string]: unknown