Refactor: Schema Definition in TypeScript with Zod

.mocharc.json

@@ -0,0 +1,6 @@
+{
+	"extension": ["ts"],
+	"require": "ts-node/register",
+	"spec": "test/**/*.ts",
+	"timeout": 35000
+}

package.json

@@ -1,76 +1,78 @@
 {
-  "name": "lectern",
-  "version": "1.14.0",
-  "description": "Data Dictionary Management",
-  "scripts": {
-    "start": "npm run serve",
-    "build": "npm run build-ts",
-    "serve": "node dist/server.js",
-    "watch-node": "nodemon dist/server.js",
-    "test": "mocha --timeout 35000 --exit -r ts-node/register test/**/*.ts",
-    "watch-test": "mocha --watch --timeout 35000 --exit -r ts-node/register test/**/*.ts",
-    "build-ts": "tsc",
-    "watch-ts": "tsc -w",
-    "debug": "npm run build && npm run watch-debug",
-    "serve-debug": "nodemon --inspect dist/server.js",
-    "watch-debug": "nodemon --watch 'src/**/*.ts' --ignore 'src/**/*.spec.ts' --exec node --inspect-brk -r ts-node/register ./src/server.ts",
-    "gitmoji-config": "gitmoji -g",
-    "commit": "gitmoji -c"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/overture-stack/lectern.git"
-  },
-  "author": "andricDu",
-  "license": "AGPL-3.0",
-  "bugs": {
-    "url": "https://github.com/overture-stack/lectern/issues"
-  },
-  "homepage": "https://github.com/overture-stack/lectern#readme",
-  "devDependencies": {
-    "@types/body-parser": "^1.19.2",
-    "@types/chai": "^4.1.7",
-    "@types/errorhandler": "0.0.32",
-    "@types/express": "^4.17.13",
-    "@types/jsonwebtoken": "^8.3.2",
-    "@types/lodash": "^4.14.136",
-    "@types/memoizee": "^0.4.7",
-    "@types/mocha": "^5.2.7",
-    "@types/ms": "^0.7.31",
-    "@types/swagger-ui-express": "^3.0.1",
-    "chai": "^4.3.6",
-    "chai-http": "^4.3.0",
-    "concurrently": "^5.3.0",
-    "gitmoji-cli": "^4.8.0",
-    "husky": "^3.1.0",
-    "mocha": "^9.2.0",
-    "nodemon": "^2.0.15",
-    "prettier": "^2.8.0",
-    "testcontainers": "^1.1.19",
-    "ts-node": "^10.0.0",
-    "typescript": "^5.0.0"
-  },
-  "dependencies": {
-    "ajv": "^8.0.0",
-    "axios": "^1.0.0",
-    "body-parser": "^1.19.2",
-    "dotenv": "^16.0.0",
-    "errorhandler": "^1.5.1",
-    "express": "^4.18.2",
-    "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.21",
-    "memoizee": "^0.4.15",
-    "mongoose": "^7.0.0",
-    "ms": "^2.1.3",
-    "node-vault": "^0.9.22",
-    "swagger-ui-express": "^4.3.0",
-    "winston": "^3.6.0"
-  },
-  "prettier": {
-    "printWidth": 120,
-    "trailingComma": "all",
-    "singleQuote": true,
-    "arrowParens": "always",
-    "useTabs": true
-  }
+	"name": "lectern",
+	"version": "2.0.0-next0",
+	"description": "Data Dictionary Management",
+	"scripts": {
+		"start": "npm run serve",
+		"build": "npm run build-ts",
+		"serve": "node dist/server.js",
+		"watch-node": "nodemon dist/server.js",
+		"test": "mocha ",
+		"watch-test": "mocha --watch",
+		"build-ts": "tsc",
+		"watch-ts": "tsc -w",
+		"debug": "npm run build && npm run watch-debug",
+		"serve-debug": "nodemon --inspect dist/server.js",
+		"watch-debug": "nodemon --watch 'src/**/*.ts' --ignore 'src/**/*.spec.ts' --exec node --inspect -r ts-node/register ./src/server.ts",
+		"gitmoji-config": "gitmoji -g",
+		"commit": "gitmoji -c"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/overture-stack/lectern.git"
+	},
+	"author": "andricDu",
+	"license": "AGPL-3.0",
+	"bugs": {
+		"url": "https://github.com/overture-stack/lectern/issues"
+	},
+	"homepage": "https://github.com/overture-stack/lectern#readme",
+	"devDependencies": {
+		"@types/body-parser": "^1.19.2",
+		"@types/chai": "^4.1.7",
+		"@types/errorhandler": "0.0.32",
+		"@types/express": "^4.17.13",
+		"@types/jsonwebtoken": "^8.3.2",
+		"@types/lodash": "^4.14.136",
+		"@types/memoizee": "^0.4.7",
+		"@types/mocha": "^5.2.7",
+		"@types/ms": "^0.7.31",
+		"@types/swagger-ui-express": "^3.0.1",
+		"chai": "^4.3.6",
+		"chai-http": "^4.3.0",
+		"concurrently": "^5.3.0",
+		"gitmoji-cli": "^4.8.0",
+		"husky": "^3.1.0",
+		"mocha": "^9.2.0",
+		"nodemon": "^2.0.15",
+		"prettier": "^2.8.0",
+		"testcontainers": "^1.1.19",
+		"ts-node": "^10.0.0",
+		"typescript": "^5.0.0"
+	},
+	"dependencies": {
+		"ajv": "^8.0.0",
+		"axios": "^1.0.0",
+		"body-parser": "^1.19.2",
+		"dotenv": "^16.0.0",
+		"errorhandler": "^1.5.1",
+		"express": "^4.18.2",
+		"immer": "^10.0.2",
+		"jsonwebtoken": "^8.5.1",
+		"lodash": "^4.17.21",
+		"memoizee": "^0.4.15",
+		"mongoose": "^7.0.0",
+		"ms": "^2.1.3",
+		"node-vault": "^0.9.22",
+		"swagger-ui-express": "^4.3.0",
+		"winston": "^3.6.0",
+		"zod": "^3.21.4"
+	},
+	"prettier": {
+		"printWidth": 120,
+		"trailingComma": "all",
+		"singleQuote": true,
+		"arrowParens": "always",
+		"useTabs": true
+	}
 }

samples/dictionary/simple.json

@@ -0,0 +1,16 @@
+{
+	"name": "Simple",
+	"version": "1.0",
+	"schemas": [
+		{
+			"name": "primatives",
+			"description": "Includes one field of each primative type without any restrictions. No Frills.",
+			"fields": [
+				{ "name": "boolean_field", "valueType": "boolean" },
+				{ "name": "integer_field", "valueType": "integer" },
+				{ "name": "number_field", "valueType": "number" },
+				{ "name": "string_field", "valueType": "string" }
+			]
+		}
+	]
+}

samples/schemas/primatives.json

@@ -0,0 +1,10 @@
+{
+	"name": "primatives",
+	"description": "Includes one field of each primative type without any restrictions. No Frills.",
+	"fields": [
+		{ "name": "boolean_field", "valueType": "boolean" },
+		{ "name": "integer_field", "valueType": "integer" },
+		{ "name": "number_field", "valueType": "number" },
+		{ "name": "string_field", "valueType": "string" }
+	]
+}

src/app-health.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 The Ontario Institute for Cancer Research. All rights reserved
+ * Copyright (c) 2023 The Ontario Institute for Cancer Research. All rights reserved
  *
  * This program and the accompanying materials are made available under the terms of
  * the GNU Affero General Public License v3.0. You should have received a copy of the

src/app.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 The Ontario Institute for Cancer Research. All rights reserved
+ * Copyright (c) 2023 The Ontario Institute for Cancer Research. All rights reserved
  *
  * This program and the accompanying materials are made available under the terms of
  * the GNU Affero General Public License v3.0. You should have received a copy of the
@@ -17,35 +17,19 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-import express, { RequestHandler, Express } from 'express';
 import bodyParser from 'body-parser';
-import { AppConfig } from './config/appConfig';
-import * as dictionaryController from './controllers/dictionaryController';
-import { errorHandler } from './utils/errors';
+import express, { Express } from 'express';
 import * as swaggerUi from 'swagger-ui-express';
-import * as swagger from './config/swagger.json';
-import ego from './services/egoTokenService';
-import logger from './config/logger';
-import { dbHealth, Status } from './app-health';
 
-/**
- * Decorator to handle errors from async express route handlers
- */
-const wrapAsync = (fn: RequestHandler<any, any, any, any>): RequestHandler => {
-	return (req, res, next) => {
-		const routePromise: any = fn(req, res, next);
-		if (routePromise.catch) {
-			routePromise.catch(next);
-		}
-	};
-};
+import { AppConfig } from './config/appConfig';
+import logger from './config/logger';
+import * as swagger from './config/swagger.json';
+import dictionaryRouter from './routers/dictionaryRouter';
+import diffRouter from './routers/diffRouter';
+import healthRouter from './routers/healthRouter';
+import { errorHandler } from './utils/errors';
 
 const App = (config: AppConfig): Express => {
-	/**
-	 * Auth Decorator
-	 */
-	const egoDecorator = process.env.AUTH_ENABLED === 'true' ? ego() : wrapAsync;
-
 	// Create Express server with mongoConfig
 	const app = express();
 	const serverPort = config.serverPort();
@@ -60,43 +44,27 @@ const App = (config: AppConfig): Express => {
 		}),
 	);
 
-	swagger['info']['version'] = process.env.npm_package_version;
-	app.use(openApiPath, swaggerUi.serve, swaggerUi.setup(swagger));
-
-	logger.info(`OpenAPI setup... done: http://localhost:${serverPort}${openApiPath}`);
-
-	app.get('/health', (req, res) => {
-		if (dbHealth.status == Status.OK) {
-			const resBody = {
-				appStatus: 'Up',
-				dbStatus: dbHealth.status,
-			};
-			return res.status(200).send(resBody);
-		} else {
-			const resBody = {
-				appStatus: 'Error/Unknown',
-				dbStatus: dbHealth.status,
-			};
-			return res.status(500).send(resBody);
-		}
-	});
-
+	// Root Handler:
 	app.get('/', (_, res) => {
 		const details = {
-			app: 'Lectern',
 			version: process.env.npm_package_version,
 			commit: process.env.COMMIT_SHA,
 		};
 		res.send(details);
 	});
+	app.use('/health', healthRouter);
+	app.use('/dictionaries', dictionaryRouter);
+	app.use('/diff', diffRouter);
 
-	app.get('/dictionaries', wrapAsync(dictionaryController.listDictionaries));
-	app.post('/dictionaries', egoDecorator(dictionaryController.createDictionary));
-	app.get('/dictionaries/:dictId', wrapAsync(dictionaryController.getDictionary));
-	app.post('/dictionaries/:dictId/schemas', egoDecorator(dictionaryController.addSchema));
-	app.put('/dictionaries/:dictId/schemas', egoDecorator(dictionaryController.updateSchema));
-	app.get('/diff/', wrapAsync(dictionaryController.diffDictionaries));
+	/**
+	 * Swagger Setup
+	 */
+	swagger.info.version = process.env.npm_package_version || '';
+
+	app.use(openApiPath, swaggerUi.serve, swaggerUi.setup(swagger));
+	logger.info(`Access swagger docs: http://localhost:${serverPort}${openApiPath}`);
 
+	// Error handler must be added last to capture all thrown errors.
 	app.use(errorHandler);
 
 	return app;