Add await support to extendHttpServer (#9026)

Co-authored-by: Daniel Cousens <[email protected]>
keystonejs · Feb 14, 2024 · 8147976 · 8147976
1 parent c0dacbf
commit 8147976
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 23 deletions.
diff --git a/.changeset/boolean-not-false-2.md b/.changeset/boolean-not-false-2.md
@@ -0,0 +1,5 @@
+----
+'@keystone-6/core': patch
+----
+
+Fix `config.server.cors` type blocking `false` values
diff --git a/.changeset/boolean-not-false.md b/.changeset/boolean-not-false.md
@@ -1,5 +1,5 @@
 ----
-'@keystone-6/auth': core
+'@keystone-6/core': patch
 ----
 
 Fix `defaultIsFilterable` and `defaultIsOrderable` types blocking `true` values
diff --git a/.changeset/http-async.md b/.changeset/http-async.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Add `async` to `extendHttpServer`, for `await` on startup
diff --git a/docs/pages/docs/config/config.md b/docs/pages/docs/config/config.md
@@ -226,8 +226,8 @@ export default config<TypeInfo>({
     cors: { origin: ['http://localhost:7777'], credentials: true },
     port: 3000,
     maxFileSize: 200 * 1024 * 1024,
-    extendExpressApp: (app, commonContext) => { /* ... */ },
-    extendHttpServer: (httpServer, commonContext, graphQLSchema) => { /* ... */ },
+    extendExpressApp: async (app, commonContext) => { /* ... */ },
+    extendHttpServer: async (httpServer, commonContext, graphQLSchema) => { /* ... */ },
   },
   /* ... */
 });

diff --git a/packages/core/src/lib/server/createExpressServer.ts b/packages/core/src/lib/server/createExpressServer.ts
@@ -1,5 +1,5 @@
 import { createServer, type Server } from 'http'
-import cors, { type CorsOptions } from 'cors'
+import cors from 'cors'
 import { json } from 'body-parser'
 import { expressMiddleware } from '@apollo/server/express4'
 import express from 'express'
@@ -20,8 +20,6 @@ The Admin UI takes a while to build for dev, and is created separately
 so the CLI can bring up the dev server early to handle GraphQL requests.
 */
 
-const DEFAULT_MAX_FILE_SIZE = 200 * 1024 * 1024 // 200 MiB
-
 function formatError (graphqlConfig: GraphQLConfig | undefined) {
   return (formattedError: GraphQLFormattedError, error: unknown) => {
     let debug = graphqlConfig?.debug
@@ -56,9 +54,7 @@ export async function createExpressServer (
   const httpServer = createServer(expressServer)
 
   if (config.server?.cors) {
-    // Setting config.server.cors = true will provide backwards compatible defaults
-    // Otherwise, the user can provide their own config object to use
-    const corsConfig: CorsOptions =
+    const corsConfig =
       typeof config.server.cors === 'boolean'
         ? { origin: true, credentials: true }
         : config.server.cors
@@ -80,13 +76,8 @@ export async function createExpressServer (
     })
   }
 
-  if (config.server?.extendExpressApp) {
-    await config.server.extendExpressApp(expressServer, context)
-  }
-
-  if (config.server?.extendHttpServer) {
-    config.server?.extendHttpServer(httpServer, context, graphQLSchema)
-  }
+  await config.server?.extendExpressApp?.(expressServer, context)
+  await config.server?.extendHttpServer?.(httpServer, context, graphQLSchema)
 
   if (config.storage) {
     for (const val of Object.values(config.storage)) {
@@ -129,8 +120,8 @@ export async function createExpressServer (
   } as ApolloServerOptions<KeystoneContext>
 
   const apolloServer = new ApolloServer({ ...serverConfig })
+  const maxFileSize = config.server?.maxFileSize
 
-  const maxFileSize = config.server?.maxFileSize ?? DEFAULT_MAX_FILE_SIZE
   expressServer.use(graphqlUploadExpress({ maxFileSize }))
   await apolloServer.start()
   expressServer.use(

diff --git a/packages/core/src/system.ts b/packages/core/src/system.ts
@@ -25,10 +25,11 @@ export function initConfig (config: KeystoneConfig) {
   config.db.url ??= 'postgres://'
 
   return {
+    ...config,
     types: {
-      path: 'node_modules/.keystone/types.ts'
+      path: 'node_modules/.keystone/types.ts',
+      ...config.types,
     },
-    ...config,
     db: {
       prismaSchemaPath: 'schema.prisma',
       ...config.db,
@@ -38,6 +39,13 @@ export function initConfig (config: KeystoneConfig) {
       ...config.graphql,
     },
     lists: applyIdFieldDefaults(config),
+    server: {
+      cors: false,
+      maxFileSize: 200 * 1024 * 1024, // 200 MiB
+      extendExpressApp: async () => {},
+      extendHttpServer: async () => {},
+      ...config.server,
+    },
   }
 }
 

diff --git a/packages/core/src/types/config/index.ts b/packages/core/src/types/config/index.ts
@@ -193,8 +193,8 @@ export type AdminFileToWrite =
 
 // config.server
 export type ServerConfig<TypeInfo extends BaseKeystoneTypeInfo> = {
-  /** Configuration options for the cors middleware. Set to `true` to use core Keystone defaults */
-  cors?: CorsOptions | true
+  /** Configuration options for the cors middleware. Set to `true` to use Keystone's defaults */
+  cors?: boolean | CorsOptions
   /** Maximum upload file size allowed (in bytes) */
   maxFileSize?: number
 
@@ -210,14 +210,14 @@ export type ServerConfig<TypeInfo extends BaseKeystoneTypeInfo> = {
   extendExpressApp?: (
     app: express.Express,
     context: KeystoneContext<TypeInfo>
-  ) => void | Promise<void>
+  ) => MaybePromise<void>
 
   /** extend the node:http server used by Keystone */
   extendHttpServer?: (
     server: Server,
     context: KeystoneContext<TypeInfo>,
     graphqlSchema: GraphQLSchema
-  ) => void
+  ) => MaybePromise<void>
 } & (
   | {
       /** Port number to start the server on. Defaults to process.env.PORT || 3000 */