Cleaning up

Author: andreogle

.gitignore

@@ -1,3 +1,4 @@
+coverage/
 dist/
 node_modules/
 .env

package.json

@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "build": "yarn clean && yarn tsc",
-    "clean": "rimraf -rf ./dist",
+    "clean": "rimraf -rf ./coverage ./dist",
     "dev": "nodemon --ext '*' --watch src --exec 'ts-node src/server.ts'",
     "lint": "yarn lint:eslint",
     "lint:eslint": "eslint . --ext .js,.ts",
@@ -21,13 +21,12 @@
     "pretty-quick": "pretty-quick --staged --pattern \"**/*.*(js|ts|json|md)\"",
     "start": "node dist/src/server.js",
     "test": "jest",
+    "test:coverage": "yarn test --coverage",
     "test:watch": "yarn test --watch"
   },
   "dependencies": {
     "dotenv": "^16.0.1",
     "express": "^4.18.1",
-    "fastify": "^4.3.0",
-    "fastify-plugin": "^4.1.0",
     "pino": "^8.4.0",
     "pino-http": "^8.2.0",
     "ts-pattern": "^4.0.5",

src/app.ts

@@ -1,7 +1,7 @@
 import express, { Express, Request, Response } from 'express';
 import { validate } from './validation';
 
-export const build = () => {
+export const build = (): Express => {
   const app: Express = express();
   app.use(express.json());
 

src/server.ts

@@ -1,29 +1,14 @@
-import express, { Express, Request, Response } from 'express';
+import { Express } from 'express';
 import pinoHTTP from 'pino-http';
 import dotenv from 'dotenv';
+import { build } from './app';
 import { logger } from './logger';
-import { validate } from './validation';
 
 dotenv.config();
 
-const app: Express = express();
+const app: Express = build();
 app.use(pinoHTTP()); // Logging
 
-app.get('/', async (req: Request, res: Response) => {
-  res.type('application/json').status(200).send({ status: 'alive' });
-});
-
-app.post('/validate', async (req: Request, res: Response) => {
-  const { config, version } = req.body;
-  try {
-    const { valid, errors } = validate(version, config);
-    const status = valid ? 200 : 422;
-    res.type('application/json').status(status).send({ valid, errors });
-  } catch (e) {
-    res.type('application/json').status(400).send({ error: 'Invalid request' });
-  }
-});
-
 const PORT = Number(process.env.PORT) || 8000;
 app.listen(PORT, () => {
   logger.info(`Listening on port:${PORT}`);

src/validation.test.ts

@@ -8,6 +8,10 @@ describe.each(SUPPORTED_VERSIONS)('validates v%s configs', (version) => {
     expect(validation.validate(version, config)).toEqual({ valid: true, errors: [] });
   });
 
+  it('throws an error if the version is not supported', () => {
+    expect(() => validation.validate('0.6', config)).toThrowError('Unsupported version:0.6');
+  });
+
   it('validates an invalid config', () => {
     const invalid = JSON.parse(JSON.stringify(config));
     delete invalid.ois;

src/validation.ts

@@ -22,6 +22,8 @@ const getVersionValidator = (semverStr: string) => {
     throw new Error(`Unsupported version:${semverStr}`);
   }
 
+  // TODO: investigate how/if this can be better done with types alone
+  // and dynamic pattern matching
   return match(semver)
     .with({ major: 0, minor: 7 }, () => validator07.parseConfig)
     .otherwise(() => {