[3.x] HTTP API healthcheck

package.json

@@ -28,6 +28,7 @@
         "async": "^3.2.0",
         "bluebird": "^3.7.2",
         "bluebird-global": "^1.0.1",
+        "body-parser": "^1.19.0",
         "bptf-listings-2": "^1.2.0",
         "bptf-login-2": "^1.0.2",
         "callback-queue": "^3.0.0",
@@ -38,6 +39,7 @@
         "dot-prop": "^6.0.1",
         "dotenv": "^8.2.0",
         "eslint-config-prettier": "^8.1.0",
+        "express": "^4.17.1",
         "graceful-fs": "^4.2.6",
         "isobject": "^4.0.0",
         "js-levenshtein": "^1.1.6",
@@ -73,6 +75,7 @@
         "@types/bluebird-global": "^3.5.12",
         "@types/cheerio": "^0.22.24",
         "@types/death": "^1.1.1",
+        "@types/express": "^4.17.11",
         "@types/graceful-fs": "^4.1.5",
         "@types/jest": "^26.0.20",
         "@types/pluralize": "0.0.29",

src/app.ts

@@ -4,6 +4,7 @@ const { version: BOT_VERSION } = require('../package.json');
 import { getPricer } from '@pricer/pricer';
 import Pricer, { GetPricerFn } from './classes/Pricer';
 import { loadOptions } from './classes/Options';
+import HttpManager from './classes/HttpManager';
 
 process.env.BOT_VERSION = BOT_VERSION as string;
 
@@ -130,4 +131,14 @@ void botManager.start(options).asCallback(err => {
     if (err) {
         throw err;
     }
+
+    if (options.enableHttpApi) {
+        const httpManager = new HttpManager(options);
+
+        void httpManager.start().asCallback(err => {
+            if (err) {
+                throw err;
+            }
+        });
+    }
 });

src/classes/HttpManager.ts

@@ -0,0 +1,54 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+
+import bodyParser from 'body-parser';
+import express from 'express';
+import log from '../lib/logger';
+import Options from './Options';
+
+export default class HttpManager {
+    /**
+     * The Express.js app.
+     */
+    protected app: express.Application;
+
+    /**
+     * The Express.js server app.
+     */
+    public server;
+
+    /**
+     * Initialize the HTTP manager.
+     *
+     * @param options - The options list.
+     */
+    constructor(protected options: Options) {
+        this.app = express();
+        this.app.use(bodyParser.json());
+        this.app.use(bodyParser.urlencoded({ extended: false }));
+
+        this.registerRoutes();
+    }
+
+    /**
+     * Register the routes.
+     */
+    protected registerRoutes(): void {
+        this.app.get('/health', (req, res) => res.send('OK'));
+        this.app.get('/uptime', (req, res) => res.json({ uptime: process.uptime() }));
+    }
+
+    /**
+     * Start the server.
+     */
+    start(): Promise<void> {
+        return new Promise(resolve => {
+            this.server = this.app.listen(this.options.httpApiPort, () => {
+                resolve();
+                log.debug(`HTTP Server started: http://127.0.0.1:${this.options.httpApiPort}`);
+            });
+        });
+    }
+}

src/classes/Options.ts

@@ -654,6 +654,7 @@ export const DEFAULTS = {
             }
         }
     },
+
     detailsExtra: {
         /**
          * Custom string to be shown in listing note if details.highValue.showSpells set to true
@@ -1814,6 +1815,9 @@ export default interface Options extends JsonOptions {
 
     folderName?: string;
     filePrefix?: string;
+
+    enableHttpApi?: boolean;
+    httpApiPort?: number;
 }
 
 function getOption<T>(option: string, def: T, parseFn: (target: string) => T, options?: Options): T {
@@ -1909,6 +1913,7 @@ export function loadOptions(options?: Options): Options {
 
     const jsonParseArray = (jsonString: string): string[] => (JSON.parse(jsonString) as unknown) as string[];
     const jsonParseBoolean = (jsonString: string): boolean => (JSON.parse(jsonString) as unknown) as boolean;
+    const jsonParseNumber = (jsonString: string): number => (JSON.parse(jsonString) as unknown) as number;
 
     const envOptions = {
         steamAccountName: steamAccountName,
@@ -1937,7 +1942,10 @@ export function loadOptions(options?: Options): Options {
         timeAdditionalNotes: getOption('timeAdditionalNotes', '', String, incomingOptions),
 
         debug: getOption('debug', true, jsonParseBoolean, incomingOptions),
-        debugFile: getOption('debugFile', true, jsonParseBoolean, incomingOptions)
+        debugFile: getOption('debugFile', true, jsonParseBoolean, incomingOptions),
+
+        enableHttpApi: getOption('enableHttpApi', false, jsonParseBoolean, incomingOptions),
+        httpApiPort: getOption('httpApiPort', 80, jsonParseNumber, incomingOptions)
     };
 
     if (!envOptions.steamAccountName) {

template.ecosystem.json

@@ -39,7 +39,10 @@
                 "TIME_ADDITIONAL_NOTES": "",
 
                 "DEBUG": true,
-                "DEBUG_FILE": true
+                "DEBUG_FILE": true,
+
+                "ENABLE_HTTP_API": false,
+                "HTTP_API_PORT": 80
             }
         }
     ]

template.env

@@ -27,3 +27,6 @@ TIME_ADDITIONAL_NOTES=""
 
 DEBUG=true
 DEBUG_FILE=true
+
+ENABLE_HTTP_API=false
+HTTP_API_PORT=80