@stuntman/server 0.1.6 → 0.1.7

package/README.md

@@ -31,7 +31,7 @@ pnpm stuntman
 
 Stuntman uses [config](https://github.com/node-config/node-config)
 
-You can create `config/default.json` with settings of your liking matching `ServerConfig` type
+You can create `config/default.json` with settings of your liking matching `Stuntman.Config` type
 
 ## Running as a package
 
@@ -55,9 +55,9 @@ node ./node_modules/.bin/stuntman
 
 ```ts
 import { Mock } from '../mock';
-import { serverConfig } from '@stuntman/shared';
+import { stuntmanConfig } from '@stuntman/shared';
 
-const mock = new Mock(serverConfig);
+const mock = new Mock(stuntmanConfig);
 
 mock.start();
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stuntman/server",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Stuntman - HTTP proxy / mock server with API",
   "main": "dist/index.js",
   "repository": {
@@ -69,8 +69,8 @@
     "test": "SUPPRESS_NO_CONFIG_WARNING=1 jest",
     "clean": "rm -fr dist",
     "build": "tsc && cp -rv src/api/webgui dist/api",
-    "lint": "prettier --check . && eslint . --ext ts",
-    "lint:fix": "prettier --write ./{src,test} && eslint ./{src,test} --ext ts --fix",
+    "lint": "prettier --check \"./{src,test}/**/*\" && eslint \"./{src,test}/**/*\"",
+    "lint:fix": "prettier --write \"./{src,test}/**/*\" && eslint \"./{src,test}/**/*\" --fix",
     "start": "node ./dist/bin/stuntman.js",
     "start:dev": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' ./src/bin/stuntman.ts",
     "start:debug": "node --inspect-brk=0.0.0.0 ./node_modules/.bin/ts-node --transpile-only ./src/bin/stuntman.ts"

package/src/api/api.ts

@@ -19,67 +19,81 @@ const API_KEY_HEADER = 'x-api-key';
 
 export class API {
     protected options: Required<ApiOptions>;
-    protected apiApp: ExpressServer;
+    protected webGuiOptions: Stuntman.WebGuiConfig;
+    protected apiApp: ExpressServer | null = null;
     trafficStore: LRUCache<string, Stuntman.LogEntry>;
     server: http.Server | null = null;
-    auth: (req: Request, type: 'read' | 'write') => void;
-    authReadOnly: (req: Request, res: Response, next: NextFunction) => void;
-    authReadWrite: (req: Request, res: Response, next: NextFunction) => void;
 
-    constructor(options: ApiOptions, webGuiOptions?: Stuntman.WebGuiConfig) {
+    constructor(options: ApiOptions, webGuiOptions: Stuntman.WebGuiConfig = { disabled: false }) {
         if (!options.apiKeyReadOnly !== !options.apiKeyReadWrite) {
             throw new Error('apiKeyReadOnly and apiKeyReadWrite options need to be set either both or none');
         }
         this.options = options;
+        this.webGuiOptions = webGuiOptions;
 
         this.trafficStore = getTrafficStore(this.options.mockUuid);
-        this.apiApp = express();
-
-        this.apiApp.use(express.json());
-        this.apiApp.use(express.text());
+        this.auth = this.auth.bind(this);
+        this.authReadOnly = this.authReadOnly.bind(this);
+        this.authReadWrite = this.authReadWrite.bind(this);
+    }
 
-        this.auth = (req: Request, type: 'read' | 'write'): void => {
-            if (!this.options.apiKeyReadOnly && !this.options.apiKeyReadWrite) {
-                return;
-            }
-            const hasValidReadKey = req.header(API_KEY_HEADER) === this.options.apiKeyReadOnly;
-            const hasValidWriteKey = req.header(API_KEY_HEADER) === this.options.apiKeyReadWrite;
-            const hasValidKey = type === 'read' ? hasValidReadKey || hasValidWriteKey : hasValidWriteKey;
-            if (!hasValidKey) {
-                throw new AppError({ httpCode: HttpCode.UNAUTHORIZED, message: 'unauthorized' });
-            }
+    private auth(req: Request, type: 'read' | 'write'): void {
+        if (!this.options.apiKeyReadOnly && !this.options.apiKeyReadWrite) {
             return;
-        };
+        }
+        const hasValidReadKey = req.header(API_KEY_HEADER) === this.options.apiKeyReadOnly;
+        const hasValidWriteKey = req.header(API_KEY_HEADER) === this.options.apiKeyReadWrite;
+        const hasValidKey = type === 'read' ? hasValidReadKey || hasValidWriteKey : hasValidWriteKey;
+        if (!hasValidKey) {
+            throw new AppError({ httpCode: HttpCode.UNAUTHORIZED, message: 'unauthorized' });
+        }
+        return;
+    }
 
-        this.authReadOnly = (req: Request, res: Response, next: NextFunction): void => {
-            this.auth(req, 'read');
-            next();
-        };
+    protected authReadOnly(req: Request, _res: Response, next: NextFunction): void {
+        this.auth(req, 'read');
+        next();
+    }
 
-        this.authReadWrite = (req: Request, res: Response, next: NextFunction): void => {
-            this.auth(req, 'write');
-            next();
-        };
+    protected authReadWrite(req: Request, _res: Response, next: NextFunction): void {
+        this.auth(req, 'write');
+        next();
+    }
+
+    private initApi() {
+        this.apiApp = express();
 
-        this.apiApp.use((req: Request, res: Response, next: NextFunction) => {
+        this.apiApp.use(express.json());
+        this.apiApp.use(express.text());
+
+        this.apiApp.use((req: Request, _res: Response, next: NextFunction) => {
             RequestContext.bind(req, this.options.mockUuid);
             next();
         });
 
-        this.apiApp.get('/rule', this.authReadOnly, async (req, res) => {
+        this.apiApp.get('/rule', this.authReadOnly.bind, async (_req, res) => {
             res.send(stringify(await getRuleExecutor(this.options.mockUuid).getRules()));
         });
 
         this.apiApp.get('/rule/:ruleId', this.authReadOnly, async (req, res) => {
+            if (!req.params.ruleId) {
+                throw new AppError({ httpCode: HttpCode.BAD_REQUEST, message: 'missing ruleId' });
+            }
             res.send(stringify(await getRuleExecutor(this.options.mockUuid).getRule(req.params.ruleId)));
         });
 
         this.apiApp.get('/rule/:ruleId/disable', this.authReadWrite, (req, res) => {
+            if (!req.params.ruleId) {
+                throw new AppError({ httpCode: HttpCode.BAD_REQUEST, message: 'missing ruleId' });
+            }
             getRuleExecutor(this.options.mockUuid).disableRule(req.params.ruleId);
             res.send();
         });
 
         this.apiApp.get('/rule/:ruleId/enable', this.authReadWrite, (req, res) => {
+            if (!req.params.ruleId) {
+                throw new AppError({ httpCode: HttpCode.BAD_REQUEST, message: 'missing ruleId' });
+            }
             getRuleExecutor(this.options.mockUuid).enableRule(req.params.ruleId);
             res.send();
         });
@@ -98,11 +112,14 @@ export class API {
         );
 
         this.apiApp.get('/rule/:ruleId/remove', this.authReadWrite, async (req, res) => {
+            if (!req.params.ruleId) {
+                throw new AppError({ httpCode: HttpCode.BAD_REQUEST, message: 'missing ruleId' });
+            }
             await getRuleExecutor(this.options.mockUuid).removeRule(req.params.ruleId);
             res.send();
         });
 
-        this.apiApp.get('/traffic', this.authReadOnly, (req, res) => {
+        this.apiApp.get('/traffic', this.authReadOnly, (_req, res) => {
             const serializedTraffic: Stuntman.LogEntry[] = [];
             for (const value of this.trafficStore.values()) {
                 serializedTraffic.push(value);
@@ -111,6 +128,9 @@ export class API {
         });
 
         this.apiApp.get('/traffic/:ruleIdOrLabel', this.authReadOnly, (req, res) => {
+            if (!req.params.ruleIdOrLabel) {
+                throw new AppError({ httpCode: HttpCode.BAD_REQUEST, message: 'missing ruleIdOrLabel' });
+            }
             const serializedTraffic: Stuntman.LogEntry[] = [];
             for (const value of this.trafficStore.values()) {
                 if (value.mockRuleId === req.params.ruleIdOrLabel || (value.labels || []).includes(req.params.ruleIdOrLabel)) {
@@ -120,13 +140,13 @@ export class API {
             res.json(serializedTraffic);
         });
 
-        if (!webGuiOptions?.disabled) {
+        if (!this.webGuiOptions.disabled) {
             this.apiApp.set('views', __dirname + '/webgui');
             this.apiApp.set('view engine', 'pug');
             this.initWebGui();
         }
 
-        this.apiApp.all(/.*/, (req: Request, res: Response) => res.status(404).send());
+        this.apiApp.all(/.*/, (_req: Request, res: Response) => res.status(404).send());
 
         this.apiApp.use((error: Error | AppError, req: Request, res: Response) => {
             const ctx: RequestContext | null = RequestContext.get(req);
@@ -152,7 +172,10 @@ export class API {
     }
 
     private initWebGui() {
-        this.apiApp.get('/webgui/rules', this.authReadOnly, async (req, res) => {
+        if (!this.apiApp) {
+            throw new Error('initialization error');
+        }
+        this.apiApp.get('/webgui/rules', this.authReadOnly, async (_req, res) => {
             const rules: Record<string, string> = {};
             for (const rule of await getRuleExecutor(this.options.mockUuid).getRules()) {
                 rules[rule.id] = serializeJavascript(liveRuleToRule(rule), { unsafe: true });
@@ -160,7 +183,7 @@ export class API {
             res.render('rules', { rules: escapedSerialize(rules), INDEX_DTS, ruleKeys: Object.keys(rules) });
         });
 
-        this.apiApp.get('/webgui/traffic', this.authReadOnly, async (req, res) => {
+        this.apiApp.get('/webgui/traffic', this.authReadOnly, async (_req, res) => {
             const serializedTraffic: Stuntman.LogEntry[] = [];
             for (const value of this.trafficStore.values()) {
                 serializedTraffic.push(value);
@@ -208,6 +231,10 @@ export class API {
         if (this.server) {
             throw new Error('mock server already started');
         }
+        this.initApi();
+        if (!this.apiApp) {
+            throw new Error('initialization error');
+        }
         this.server = this.apiApp.listen(this.options.port, () => {
             logger.info(`API listening on ${this.options.port}`);
         });

package/src/api/webgui/rules.pug

@@ -22,6 +22,7 @@ html
             div(style='margin-left: 240px')
                 #container(style='height: 400px')
                     script.
+                        /* eslint no-undef: 0 */
                         const uuidv4 = () => {
                             function getRandomSymbol(symbol) {
                                 var array;
@@ -72,7 +73,6 @@ html
                             }
                             const editor = monaco.editor.create(document.getElementById('container'), {
                                 theme: 'vs-dark',
-                                autoIndent: true,
                                 formatOnPaste: true,
                                 formatOnType: true,
                                 automaticLayout: true,
@@ -135,7 +135,7 @@ html
 
                             window.newRule = () => {
                                 const ruleId = uuidv4();
-                                const emptyRule = `import type * as Stuntman from \'stuntman\';\n\nvar STUNTMAN_RULE: Stuntman.Rule = { id: '${ruleId}', matches: (req: Stuntman.Request) => true, ttlSeconds: 600, actions: { mockResponse: { status: '200', body: '${ruleId}' }} };`;
+                                const emptyRule = `import type * as Stuntman from 'stuntman';\n\nvar STUNTMAN_RULE: Stuntman.Rule = { id: '${ruleId}', matches: (req: Stuntman.Request) => true, ttlSeconds: 600, actions: { mockResponse: { status: '200', body: '${ruleId}' }} };`;
                                 models[ruleId] = monaco.editor.createModel(emptyRule, 'typescript', `file:///${ruleId}.ts`);
                                 const ruleKeyNode = document.getElementById('ruleKeys').firstChild;
                                 const ruleKeyNodeClone = ruleKeyNode.cloneNode(true);

package/src/api/webgui/style.css

@@ -21,8 +21,8 @@ button.rule {
 }
 
 ul.no-bullets {
-    list-style-type: none; /* Remove bullets */
-    padding: 0; /* Remove padding */
-    margin: 0; /* Remove margins */
+    list-style-type: none;
+    padding: 0;
+    margin: 0;
     text-align: left;
 }

package/src/api/webgui/traffic.pug

@@ -12,6 +12,7 @@ html
             div(style='margin-left: 220px')
                 #container(style='height: 800px')
                     script.
+                        /* eslint no-undef: 0 */
                         require.config({
                             paths: {
                                 vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.35.0/min/vs',

package/src/bin/stuntman.ts

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 import { Mock } from '../mock';
-import { serverConfig } from '@stuntman/shared';
+import { stuntmanConfig } from '@stuntman/shared';
 
-const mock = new Mock(serverConfig);
+const mock = new Mock(stuntmanConfig);
 
 mock.start();

package/src/ipUtils.ts

@@ -55,7 +55,7 @@ export class IPUtils {
                     return;
                 }
                 logger.debug({ ip: addresses, hostname }, 'resolved hostname');
-                resolve([addresses[0], ...addresses.slice(1)]);
+                resolve([addresses[0]!, ...addresses.slice(1)]);
             };
             if (options?.useExternalDns) {
                 if (!this.externalDns) {