Adds http.Server options as configuration server.options

keystonejs · Aug 11, 2022 · 5f6efb5 · 5f6efb5
1 parent ddf834a
commit 5f6efb5
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 11 deletions.
diff --git a/.changeset/five-ports-open.md b/.changeset/five-ports-open.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Adds http.Server options as configuration `server.options`
diff --git a/packages/core/src/scripts/run/dev.ts b/packages/core/src/scripts/run/dev.ts
@@ -1,4 +1,5 @@
 import path from 'path';
+import type { ListenOptions } from 'net';
 import url from 'url';
 import util from 'util';
 import express from 'express';
@@ -115,7 +116,7 @@ exports.default = function (req, res) { return res.send(x.toString()) }
         //   so we shouldn't log something like "hey, we reloaded your config"
         //   because it would go off at times when the user didn't change their config
 
-        const version = await fetch(`http://localhost:${port}/api/__keystone_api_build`).then(x =>
+        const version = await fetch(`http://localhost:${httpOptions.port}/api/__keystone_api_build`).then(x =>
           x.text()
         );
         if (lastVersion !== version) {
@@ -231,19 +232,36 @@ exports.default = function (req, res) { return res.send(x.toString()) }
     res.sendFile(devLoadingHTMLFilepath);
   });
 
-  const port = config.server?.port || process.env.PORT || 3000;
   let initKeystonePromiseResolve: () => void | undefined;
   let initKeystonePromiseReject: (err: any) => void | undefined;
   let initKeystonePromise = new Promise<void>((resolve, reject) => {
     initKeystonePromiseResolve = resolve;
     initKeystonePromiseReject = reject;
   });
-  const server = app.listen(port, (err?: any) => {
+
+  const httpOptions: ListenOptions = {
+    port: 3000,
+  };
+
+  // preference env.PORT if supplied
+  if (config?.server && 'port' in config.server) {
+    httpOptions.port = config.server.port;
+  }
+
+  if (config?.server && 'options' in config.server && typeof config.server.options === 'object') {
+    Object.assign(httpOptions, config.server.options);
+  }
+
+  if ('PORT' in process.env) {
+    httpOptions.port = parseInt(process.env.PORT || '');
+  }
+
+  const server = app.listen(httpOptions, (err?: any) => {
     if (err) throw err;
     // We start initialising Keystone after the dev server is ready,
-    console.log(`⭐️ Dev Server Starting on http://localhost:${port}`);
+    console.log(`⭐️ Dev Server Starting on http://localhost:${httpOptions.port}`);
     console.log(
-      `⭐️ GraphQL API Starting on http://localhost:${port}${
+      `⭐️ GraphQL API Starting on http://localhost:${httpOptions.port}${
         config.graphql?.path || '/api/graphql'
       }`
     );

diff --git a/packages/core/src/scripts/run/start.ts b/packages/core/src/scripts/run/start.ts
@@ -1,4 +1,5 @@
 import path from 'path';
+import type { ListenOptions } from 'net';
 import * as fs from 'fs-extra';
 import { createSystem } from '../../lib/createSystem';
 import { initConfig } from '../../lib/config/initConfig';
@@ -44,9 +45,25 @@ export const start = async (cwd: string) => {
     console.log(`✅ Admin UI ready`);
   }
 
-  const port = config.server?.port || process.env.PORT || 3000;
-  httpServer.listen(port, (err?: any) => {
+  const options: ListenOptions = {
+    port: 3000,
+  };
+
+  // preference env.PORT if supplied
+  if (config?.server && 'port' in config.server) {
+    options.port = config.server.port;
+  }
+
+  if (config?.server && 'options' in config.server && typeof config.server.options === 'object') {
+    Object.assign(options, config.server.options);
+  }
+
+  if ('PORT' in process.env) {
+    options.port = parseInt(process.env.PORT || '');
+  }
+
+  httpServer.listen(options, (err?: any) => {
     if (err) throw err;
-    console.log(`⭐️ Server Ready on http://localhost:${port}`);
+    console.log(`⭐️ Server Ready on http://localhost:${options.port}`);
   });
 };
diff --git a/packages/core/src/types/config/index.ts b/packages/core/src/types/config/index.ts
@@ -1,4 +1,5 @@
 import type { Server } from 'http';
+import type { ListenOptions } from 'net';
 import type { Config } from 'apollo-server-express';
 import { CorsOptions } from 'cors';
 import express from 'express';
@@ -169,8 +170,6 @@ type HealthCheckConfig = {
 export type ServerConfig<TypeInfo extends BaseKeystoneTypeInfo> = {
   /** Configuration options for the cors middleware. Set to `true` to use core Keystone defaults */
   cors?: CorsOptions | true;
-  /** Port number to start the server on. Defaults to process.env.PORT || 3000 */
-  port?: number;
   /** Maximum upload file size allowed (in bytes) */
   maxFileSize?: number;
   /** Health check configuration. Set to `true` to add a basic `/_healthcheck` route, or specify the path and data explicitly */
@@ -181,7 +180,16 @@ export type ServerConfig<TypeInfo extends BaseKeystoneTypeInfo> = {
     createContext: CreateRequestContext<TypeInfo>
   ) => void | Promise<void>;
   extendHttpServer?: (server: Server, createContext: CreateRequestContext<TypeInfo>) => void;
-};
+} & (
+  | {
+      /** Port number to start the server on. Defaults to process.env.PORT || 3000 */
+      port?: number;
+    }
+  | {
+      /** node http.Server options */
+      options?: ListenOptions;
+    }
+);
 
 // config.graphql