chore(gatsby): convert schema-customization to typescript (#24259)

* Convert schema-customization to TS * Update import * Fix type errors * Revert "Fix type errors" This reverts commit 849c227. * Remove unneded type * Fix type * Remove unneded imports * Fix import * Improve typings and defaults * default null value and handle cases * update yarn.lock Co-authored-by: Blaine Kasten <blainekasten@gmail.com>
gatsbyjs · Jun 16, 2020 · 670f92f · 670f92f
1 parent a6ef610
commit 670f92f
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 23 deletions.
diff --git a/packages/gatsby/src/commands/develop-process.ts b/packages/gatsby/src/commands/develop-process.ts
@@ -2,7 +2,6 @@ import url from "url"
 import fs from "fs"
 import openurl from "better-opn"
 import chokidar from "chokidar"
-import { SchemaComposer } from "graphql-compose"
 
 import webpackHotMiddleware from "webpack-hot-middleware"
 import webpackDevMiddleware from "webpack-dev-middleware"
@@ -13,7 +12,7 @@ import webpack from "webpack"
 import graphqlHTTP from "express-graphql"
 import graphqlPlayground from "graphql-playground-middleware-express"
 import graphiqlExplorer from "gatsby-graphiql-explorer"
-import { formatError, GraphQLSchema } from "graphql"
+import { formatError } from "graphql"
 
 import webpackConfig from "../utils/webpack.config"
 import bootstrap from "../bootstrap"
@@ -200,16 +199,13 @@ async function startServer(program: IProgram): Promise<IServer> {
     graphqlEndpoint,
     graphqlHTTP(
       (): graphqlHTTP.OptionsData => {
-        const {
-          schema,
-          schemaCustomization,
-        }: {
-          schema: GraphQLSchema
-          schemaCustomization: {
-            composer: SchemaComposer<any>
-            context: any
-          }
-        } = store.getState()
+        const { schema, schemaCustomization } = store.getState()
+
+        if (!schemaCustomization.composer) {
+          throw new Error(
+            `A schema composer was not created in time. This is likely a gatsby bug. If you experienced this please create an issue.`
+          )
+        }
 
         return {
           schema,

diff --git a/packages/gatsby/src/redux/reducers/index.ts b/packages/gatsby/src/redux/reducers/index.ts
@@ -22,7 +22,7 @@ import programReducer from "./program"
 import { resolvedNodesCacheReducer } from "./resolved-nodes"
 import { nodesTouchedReducer } from "./nodes-touched"
 import { flattenedPluginsReducer } from "./flattened-plugins"
-import schemaCustomizationReducer from "./schema-customization"
+import { schemaCustomizationReducer } from "./schema-customization"
 import { inferenceMetadataReducer } from "./inference-metadata"
 
 /**

diff --git a/...rc/redux/reducers/schema-customization.js → ...rc/redux/reducers/schema-customization.ts b/...rc/redux/reducers/schema-customization.js → ...rc/redux/reducers/schema-customization.ts
@@ -1,4 +1,6 @@
-const initialState = () => {
+import { IGatsbyState, ActionsUnion } from "../types"
+
+const initialState = (): IGatsbyState["schemaCustomization"] => {
   return {
     composer: null,
     context: {},
@@ -9,7 +11,10 @@ const initialState = () => {
   }
 }
 
-module.exports = (state = initialState(), action) => {
+export const schemaCustomizationReducer = (
+  state: IGatsbyState["schemaCustomization"] = initialState(),
+  action: ActionsUnion
+): IGatsbyState["schemaCustomization"] => {
   switch (action.type) {
     case `ADD_THIRD_PARTY_SCHEMA`:
       return {
@@ -22,7 +27,7 @@ module.exports = (state = initialState(), action) => {
         composer: action.payload,
       }
     case `CREATE_TYPES`: {
-      let types
+      let types: IGatsbyState["schemaCustomization"]["types"]
       if (Array.isArray(action.payload)) {
         types = [
           ...state.types,

diff --git a/packages/gatsby/src/redux/types.ts b/packages/gatsby/src/redux/types.ts
@@ -213,12 +213,17 @@ export interface IGatsbyState {
     }
   }
   schemaCustomization: {
-    composer: SchemaComposer<any>
-    context: {} // TODO
-    fieldExtensions: {} // TODO
-    printConfig: any // TODO
-    thridPartySchemas: any[] // TODO
-    types: any[] // TODO
+    composer: null | SchemaComposer<any>
+    context: Record<string, any>
+    fieldExtensions: GraphQLFieldExtensionDefinition
+    printConfig: {
+      path?: string
+      include?: { types?: Array<string>; plugins?: Array<string> }
+      exclude?: { types?: Array<string>; plugins?: Array<string> }
+      withFieldTypes?: boolean
+    } | null
+    thirdPartySchemas: GraphQLSchema[]
+    types: (string | { typeOrTypeDef: DocumentNode; plugin: IGatsbyPlugin })[]
   }
   themes: any // TODO
   logs: IGatsbyCLIState
@@ -290,6 +295,9 @@ export type ActionsUnion =
   | ICreateJobAction
   | ISetJobAction
   | IEndJobAction
+  | ICreateResolverContext
+  | IClearSchemaCustomizationAction
+  | ISetSchemaComposerAction
   | IStartIncrementalInferenceAction
   | IBuildTypeMetadataAction
   | IDisableTypeInferenceAction
@@ -505,6 +513,15 @@ export interface ICreateResolverContext {
     | { [camelCasedPluginNameWithoutPrefix: string]: IGatsbyPluginContext }
 }
 
+interface IClearSchemaCustomizationAction {
+  type: `CLEAR_SCHEMA_CUSTOMIZATION`
+}
+
+interface ISetSchemaComposerAction {
+  type: `SET_SCHEMA_COMPOSER`
+  payload: SchemaComposer<any>
+}
+
 export interface ICreatePageAction {
   type: `CREATE_PAGE`
   payload: IGatsbyPage

diff --git a/packages/gatsby/src/schema/context.ts b/packages/gatsby/src/schema/context.ts
@@ -18,7 +18,7 @@ export default function withResolverContext<TSource, TArgs>({
   tracer,
 }: {
   schema: GraphQLSchema
-  schemaComposer: SchemaComposer<IGatsbyResolverContext<TSource, TArgs>>
+  schemaComposer: SchemaComposer<IGatsbyResolverContext<TSource, TArgs>> | null
   context?: Record<string, any>
   customContext?: Record<string, any>
   nodeModel?: any