Allow specifying a webRoot in GameServer constructor

Author: maxwellmatthis

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-game-project/server",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "This is the JavaScript (and TypeScript) server library for CodeGame.",
   "license": "MIT",
   "author": {

src/api.ts

@@ -1,4 +1,5 @@
 import { Router, json } from "express";
+import express from "express";
 import { GameServer } from "./server.js";
 
 export interface Info {
@@ -16,14 +17,23 @@ interface InfoInternal extends Info {
 /**
  * Creates an express.js `Router` that handles the standard routes defined in the Game Server Specification.
  * @param gameServer The `GameServer` instace.
+ * @param webRoot The path to the root of the frontend. Specify `null` if there are no static assets.
  * @param cgePath The file path to the Code Game Events file about the game.
  * @param info Information about the game server.
  * @returns an express `Router`.
  */
-export function createApi<Config extends object>(gameServer: GameServer<Config>, cgePath: string, info: InfoInternal): Router {
+export function createApi<Config extends object>(
+  gameServer: GameServer<Config>,
+  webRoot: string | null,
+  cgePath: string,
+  info: InfoInternal
+): Router {
   const router = Router();
   router.use(json({ limit: '2kb' }));
 
+  // static
+  if (webRoot) router.use(express.static(webRoot));
+
   // info
   router.get("/api/info", (_, res) => res.status(200).json(info));
 

src/server.ts

@@ -36,9 +36,21 @@ export class GameServer<Config extends object = object> {
   private readonly privateGames: Games<Config> = {};
   public readonly logger = new Logger<Config>();
 
+  /**
+   * Creates a new `GameServer`.
+   * @param info Information about the game server.
+   * @param cgePath The file path to the Code Game Events file about the game.
+   * @param webRoot The path to the root of the frontend. Specify `null` if there are no static assets.
+   * @param createGame A function that is called to create a new game. An instance of `Game` must be returned.
+   * @param port The port that the server will bind to.
+   * @param maxGamesCount The maximum number of games allowed on the server at once.
+   * @param heartbeatIntervalSeconds The time in seconds to wait before checking again whether a socket is still alive.
+   * @returns an instance of `GameServer`.
+   */
   public constructor(
     info: Info,
     cgePath: string,
+    webroot: string | null,
     createGame: CreateGameFn<Config>,
     port: number = DEFAULT_PORT,
     maxGamesCount: number = DEFAULT_GAMES_COUNT,
@@ -54,7 +66,7 @@ export class GameServer<Config extends object = object> {
     // Api
     const app = express();
     app.use(cors());
-    app.use(createApi(this, cgePath, Object.assign(info, { cg_version: CG_VERSION.join(".") })));
+    app.use(createApi(this, webroot, cgePath, Object.assign(info, { cg_version: CG_VERSION.join(".") })));
 
     // Game
     this.createGameFn = createGame;
@@ -70,6 +82,22 @@ export class GameServer<Config extends object = object> {
     this.HEARTBEAT_INTERVAL_SECONDS = heartbeatIntervalSeconds;
   }
 
+  /**
+   * Stops the server from accepting new connections and keeps
+   * existing connections. This function is asynchronous, the
+   * server is finally closed when all connections are ended
+   * and the server emits a 'close' event. The optional callback
+   * will be called once the 'close' event occurs. Unlike that
+   * event, it will be called with an Error as its only argument
+   * if the server was not open when it was closed.
+   * 
+   * See `http.Server.close` for more.
+   */
+  public close(onCloseCallback?: ((err?: Error | undefined) => void) | undefined) {
+    this.server.close(onCloseCallback);
+    // TODO: Close all WebSockets if they are not already closed.
+  }
+
   /**
    * Looks for a game in the `publicGames`, as well as in the `privateGames`.
    * @param gameId The game ID.