chore(gatsby): Convert query-runner to typescript

gatsbyjs · Mar 20, 2020 · 219d82b · 219d82b
1 parent 8dd2cc2
commit 219d82b
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 23 deletions.
diff --git a/packages/gatsby/src/query/error-parser.ts b/packages/gatsby/src/query/error-parser.ts
@@ -3,8 +3,8 @@ import { SourceLocation } from "graphql"
 
 interface IErrorParser {
   message: string
-  filePath: string | undefined
-  location:
+  filePath?: string | undefined
+  location?:
     | {
         start: SourceLocation
         end?: SourceLocation

diff --git a/packages/gatsby/src/query/query-runner.js → packages/gatsby/src/query/query-runner.ts b/packages/gatsby/src/query/query-runner.js → packages/gatsby/src/query/query-runner.ts
@@ -1,34 +1,47 @@
-// @flow
+import fs from "fs-extra"
+import report from "gatsby-cli/lib/reporter"
 
-const fs = require(`fs-extra`)
-const report = require(`gatsby-cli/lib/reporter`)
+import path from "path"
+import { store } from "../redux"
+import { boundActionCreators } from "../redux/actions"
+import pageDataUtil from "../utils/page-data"
+import { getCodeFrame } from "./graphql-errors"
+import errorParser from "./error-parser"
 
-const path = require(`path`)
-const { store } = require(`../redux`)
-const { boundActionCreators } = require(`../redux/actions`)
-const pageDataUtil = require(`../utils/page-data`)
-const { getCodeFrame } = require(`./graphql-errors`)
-const { default: errorParser } = require(`./error-parser`)
+import { GraphQLRunner } from "./graphql-runner"
+import { ExecutionResultDataDefault } from "graphql/execution/execute"
+import { ExecutionResult } from "graphql"
 
 const resultHashes = new Map()
 
-type QueryJob = {
-  id: string,
-  hash?: string,
-  query: string,
-  componentPath: string,
-  context: Object,
-  isPage: Boolean,
+interface IQueryJob {
+  id: string
+  hash?: string
+  query: string
+  componentPath: string
+  context: {
+    path: any
+    context: any
+  }
+  isPage: boolean
+  pluginCreatorId: string
 }
 
 // Run query
-module.exports = async (graphqlRunner, queryJob: QueryJob) => {
+export const queryRunner = async (
+  graphqlRunner: GraphQLRunner,
+  queryJob: IQueryJob
+): Promise<ExecutionResult<ExecutionResultDataDefault>> => {
   const { program } = store.getState()
 
-  const graphql = (query, context) => graphqlRunner.query(query, context)
+  const graphql = (
+    query: string,
+    context: any
+  ): Promise<ExecutionResult<ExecutionResultDataDefault>> =>
+    graphqlRunner.query(query, context)
 
   // Run query
-  let result
+  let result: ExecutionResult<ExecutionResultDataDefault>
   // Nothing to do if the query doesn't exist.
   if (!queryJob.query || queryJob.query === ``) {
     result = {}
@@ -62,7 +75,7 @@ module.exports = async (graphqlRunner, queryJob: QueryJob) => {
             e.locations && e.locations[0].column
           ),
           filePath: queryJob.componentPath,
-          ...(urlPath && { urlPath }),
+          ...(urlPath ? { urlPath } : {}),
           ...queryContext,
           plugin,
         }

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]: unknown
   }
   error?: Error | undefined
   [key: string]: unknown