Use joi for validation and add base validator

Author: jatinkatyal13

docs/api_project.js

@@ -1 +1 @@
-{  "title": "judge-blocks API",  "url": "https://judge2.codingblocks.com/api",  "sampleUrl": "https://judge2.codingblocks.com/api",  "name": "judge-api",  "version": "1.2.0",  "description": "Judge API",  "defaultVersion": "0.0.0",  "apidoc": "0.3.0",  "generator": {    "name": "apidoc",    "time": "2020-04-11T15:13:28.923Z",    "url": "http://apidocjs.com",    "version": "0.17.7"  }}
+{  "title": "judge-blocks API",  "url": "https://judge2.codingblocks.com/api",  "sampleUrl": "https://judge2.codingblocks.com/api",  "name": "judge-api",  "version": "1.2.0",  "description": "Judge API",  "defaultVersion": "0.0.0",  "apidoc": "0.3.0",  "generator": {    "name": "apidoc",    "time": "2020-04-17T14:00:28.777Z",    "url": "http://apidocjs.com",    "version": "0.17.7"  }}

docs/api_project.json

@@ -8,6 +8,7 @@
   "license": "Apache-2.0",
   "private": true,
   "dependencies": {
+    "@hapi/joi": "^17.1.1",
     "@types/amqplib": "^0.5.4",
     "amqplib": "^0.5.2",
     "apidoc": "^0.17.6",
@@ -24,6 +25,7 @@
     "@types/chai": "^4.0.4",
     "@types/debug": "^0.0.30",
     "@types/express": "^4.0.39",
+    "@types/joi": "^14.3.4",
     "@types/minio": "^7.0.1",
     "@types/mocha": "^5.0.0",
     "@types/sequelize": "^4.0.79",

package.json

@@ -40,7 +40,6 @@ export const define = (
       allowNull: false
     },
     results: Sequelize.JSON,
-    outputs: Sequelize.ARRAY(Sequelize.STRING),
     callback: Sequelize.STRING
   }, {
       paranoid: true, // We do not want to lose any submission data

src/models/Submission.ts

@@ -52,11 +52,7 @@ class RunController {
   }
 
   async onSuccess(result: RunResponse) {
-    const { url } = await upload(result)
-
     const job = await DB.submissions.findById(result.id)
-    job.outputs = [url]
-    await job.save()
 
     switch (job.mode) {
       case 'callback':

src/routes/api/run/controller.ts

@@ -1,28 +1,35 @@
-import { Request, Response, NextFunction } from 'express'
+import { Handler } from 'express'
+import BaseValidator from 'validators/baseValidator'
+import * as Joi from '@hapi/joi'
 
-class RunValidator {
-  POST(req: Request, res: Response, next: NextFunction) {
-    if (!req.body.lang || (typeof req.body.lang !== 'string')) {
-      return new Error('Invalid Language')
-    }
-    if (!req.body.source) {
-      return new Error('Source not found')
-    }
-    if (!req.body.stdin) {
-      req.body.stdin = ''
-    }
-    if (!req.body.mode) {
-      req.body.mode = 'sync'
-    }
-    if (!['sync', 'callback'].includes(req.body.mode)) {
-      return new Error('Mode must be one of sync, callback')
-    }
-    if (req.body.mode === 'callback' && !req.body.callback) {
-      return new Error('Must specify a callback for callback mode')
-    }
-  
-    return next()
+class RunValidator extends BaseValidator {
+  POST: Handler
+
+  constructor() {
+    super()
+    this.POST = this.requestValidator(this.POSTSchema)
   }
+
+  POSTSchema = Joi.object({
+    lang: Joi
+      .string()
+      .required(),
+    source: Joi
+      .string()
+      .required(),
+    mode: Joi
+      .string()
+      .valid('sync', 'callback', 'poll'),
+    stdin: Joi
+      .string()
+      .default(''),
+    timelimit: Joi
+      .number(),
+    callback: Joi
+      .string()
+      .uri()
+      .when('mode', { is: 'callback', then: Joi.string().required() })
+  })
 }
 
 export default new RunValidator()

src/routes/api/run/validators.ts

@@ -55,7 +55,7 @@ class SubmitController {
 
   async onSuccess(result: SubmitResponse) {    
     const job = await DB.submissions.findById(result.id)
-    job.results = result.testcases
+    job.results = result
     await job.save()
 
     switch (job.mode) {

src/routes/api/submit/controller.ts

@@ -0,0 +1 @@
+

src/routes/api/submit/validators.ts

@@ -0,0 +1,31 @@
+import { Request, Response, NextFunction } from 'express';
+import * as Joi from '@hapi/joi';
+
+export default class BaseValidator {
+  constructor() {
+    new Array(
+      'requestValidator'
+    ).map(_ => {
+      this[_] = this[_].bind(this)
+    })
+  }
+
+  forbid(err, res: Response) {
+    return res
+      .status(err.code || 400)
+      .json({
+        err
+      })
+  }
+
+  requestValidator(schema, key = 'body') {
+    return (req: Request, res: Response, next: NextFunction) => {
+      const { error } = schema.validate(req[key], { allowUnknown: true })
+      if (error) {
+        return this.forbid({message: error.details[0].message, code: 400}, res)
+      }
+
+      next()
+    }
+  }
+}

src/validators/baseValidator.ts

@@ -92,6 +92,46 @@
     lodash "^4.17.5"
     to-fast-properties "^2.0.0"
 
+"@hapi/address@^4.0.1":
+  version "4.0.1"
+  resolved "https://registry.yarnpkg.com/@hapi/address/-/address-4.0.1.tgz#267301ddf7bc453718377a6fb3832a2f04a721dd"
+  integrity sha512-0oEP5UiyV4f3d6cBL8F3Z5S7iWSX39Knnl0lY8i+6gfmmIBj44JCBNtcMgwyS+5v7j3VYavNay0NFHDS+UGQcw==
+  dependencies:
+    "@hapi/hoek" "^9.0.0"
+
+"@hapi/formula@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/formula/-/formula-2.0.0.tgz#edade0619ed58c8e4f164f233cda70211e787128"
+  integrity sha512-V87P8fv7PI0LH7LiVi8Lkf3x+KCO7pQozXRssAHNXXL9L1K+uyu4XypLXwxqVDKgyQai6qj3/KteNlrqDx4W5A==
+
+"@hapi/hoek@^9.0.0":
+  version "9.0.4"
+  resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.0.4.tgz#e80ad4e8e8d2adc6c77d985f698447e8628b6010"
+  integrity sha512-EwaJS7RjoXUZ2cXXKZZxZqieGtc7RbvQhUy8FwDoMQtxWVi14tFjeFCYPZAM1mBCpOpiBpyaZbb9NeHc7eGKgw==
+
+"@hapi/joi@^17.1.1":
+  version "17.1.1"
+  resolved "https://registry.yarnpkg.com/@hapi/joi/-/joi-17.1.1.tgz#9cc8d7e2c2213d1e46708c6260184b447c661350"
+  integrity sha512-p4DKeZAoeZW4g3u7ZeRo+vCDuSDgSvtsB/NpfjXEHTUjSeINAi/RrVOWiVQ1isaoLzMvFEhe8n5065mQq1AdQg==
+  dependencies:
+    "@hapi/address" "^4.0.1"
+    "@hapi/formula" "^2.0.0"
+    "@hapi/hoek" "^9.0.0"
+    "@hapi/pinpoint" "^2.0.0"
+    "@hapi/topo" "^5.0.0"
+
+"@hapi/pinpoint@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/pinpoint/-/pinpoint-2.0.0.tgz#805b40d4dbec04fc116a73089494e00f073de8df"
+  integrity sha512-vzXR5MY7n4XeIvLpfl3HtE3coZYO4raKXW766R6DZw/6aLqR26iuZ109K7a0NtF2Db0jxqh7xz2AxkUwpUFybw==
+
+"@hapi/topo@^5.0.0":
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-5.0.0.tgz#c19af8577fa393a06e9c77b60995af959be721e7"
+  integrity sha512-tFJlT47db0kMqVm3H4nQYgn6Pwg10GTZHb1pwmSiv1K4ks6drQOtfEF5ZnPjkvC+y4/bUPHK+bc87QvLcL+WMw==
+  dependencies:
+    "@hapi/hoek" "^9.0.0"
+
 "@types/amqplib@^0.5.4":
   version "0.5.13"
   resolved "https://registry.yarnpkg.com/@types/amqplib/-/amqplib-0.5.13.tgz#a0dc9be08f38b91e5f7532acf0c89b0e515cdc6c"
@@ -164,6 +204,11 @@
   resolved "https://registry.yarnpkg.com/@types/geojson/-/geojson-7946.0.7.tgz#c8fa532b60a0042219cdf173ca21a975ef0666ad"
   integrity sha512-wE2v81i4C4Ol09RtsWFAqg3BUitWbHSpSlIo+bNdsCJijO9sjme+zm+73ZMCa/qMC8UEERxzGbvmr1cffo2SiQ==
 
+"@types/joi@^14.3.4":
+  version "14.3.4"
+  resolved "https://registry.yarnpkg.com/@types/joi/-/joi-14.3.4.tgz#eed1e14cbb07716079c814138831a520a725a1e0"
+  integrity sha512-1TQNDJvIKlgYXGNIABfgFp9y0FziDpuGrd799Q5RcnsDu+krD+eeW/0Fs5PHARvWWFelOhIG2OPCo6KbadBM4A==
+
 "@types/lodash@*":
   version "4.14.149"
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.149.tgz#1342d63d948c6062838fbf961012f74d4e638440"