chore: re-write GUI to typescript part 3

lib/gui/routes/plugins.js → lib/gui/routes/plugins.ts

@@ -1,22 +1,21 @@
-'use strict';
+import {Router} from 'express';
+import {INTERNAL_SERVER_ERROR, BAD_REQUEST} from 'http-codes';
 
-const {Router} = require('express');
-const {INTERNAL_SERVER_ERROR, BAD_REQUEST} = require('http-codes');
-
-const {
+import {
     isUnexpectedPlugin,
     getPluginClientScriptPath,
     getPluginMiddleware,
     forEachPlugin,
     logError
-} = require('../../server-utils');
+} from '../../server-utils';
+import {ReporterConfig} from '../../types';
 
-module.exports = function(router, pluginConfig) {
+export const initPluginsRoutes = (router: Router, pluginConfig: ReporterConfig): Router =>{
     if (!pluginConfig.pluginsEnabled) {
         return router;
     }
 
-    router.get(`/plugins/:pluginName/plugin.js`, (req, res) => {
+    router.get<{pluginName: string}>(`/plugins/:pluginName/plugin.js`, (req, res) => {
         if (isUnexpectedPlugin(pluginConfig.plugins, req.params.pluginName)) {
             res.status(BAD_REQUEST).send({error: `Unexpected plugin "${req.params.pluginName}" requested.`});
             return;
@@ -42,12 +41,12 @@ module.exports = function(router, pluginConfig) {
             initPluginMiddleware(pluginRouter);
 
             router.use(`/plugin-routes/${pluginName}`, pluginRouter);
-        } catch (err) {
-            logError(err);
+        } catch (err: unknown) {
+            logError(err as Error);
         }
     });
 
-    router.use('/plugin-routes/:pluginName', (req, res) => {
+    router.use<{pluginName: string}>('/plugin-routes/:pluginName', (req, res) => {
         res.status(BAD_REQUEST).send({error: `No middleware is registered for "${req.params.pluginName}".`});
     });
 

lib/gui/server.js

@@ -11,7 +11,7 @@ const {App} = require('./app');
 const {MAX_REQUEST_SIZE, KEEP_ALIVE_TIMEOUT, HEADERS_TIMEOUT} = require('./constants');
 const {initializeCustomGui, runCustomGuiAction} = require('../server-utils');
 const {logger} = require('../common-utils');
-const initPluginsRoutes = require('./routes/plugins');
+const {initPluginsRoutes} = require('./routes/plugins');
 
 exports.start = async ({paths, hermione, guiApi, configs}) => {
     const {options, pluginConfig} = configs;

lib/server-utils.ts

@@ -12,6 +12,7 @@ import type Hermione from 'hermione';
 import crypto from 'crypto';
 import {ImageHandler, ImagesInfoFormatter} from './image-handler';
 import {HermioneTestAdapter} from './test-adapter';
+import {Router} from 'express';
 
 const DATA_FILE_NAME = 'data.js';
 
@@ -270,7 +271,11 @@ export function getPluginClientScriptPath(pluginName: string): string | null {
     }
 }
 
-export function getPluginMiddleware(pluginName: string): unknown | null {
+interface PluginMiddleware {
+    (pluginRouter: Router): unknown;
+}
+
+export function getPluginMiddleware(pluginName: string): PluginMiddleware | null {
     try {
         return require(`${pluginName}/middleware.js`);
     } catch (e: any) { // eslint-disable-line @typescript-eslint/no-explicit-any

package.json

@@ -107,6 +107,7 @@
     "@types/enzyme": "^3.10.13",
     "@types/express": "4.16",
     "@types/fs-extra": "^7.0.0",
+    "@types/http-codes": "^1.0.4",
     "@types/json-stringify-safe": "^5.0.2",
     "@types/lodash": "^4.14.195",
     "@types/nested-error-stacks": "^2.1.0",