Merge pull request #55 from coding-blocks/validations

Validations

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:09:53.972Z",    "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,38 @@
-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() }),
+    enc: Joi
+      .string()
+      .valid('base64', 'url')
+  })
 }
 
 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

@@ -1,10 +1,11 @@
 import { Router } from 'express'
 import Controller from './controller'
+import Validator from './validators'
 import { successListener } from 'rabbitmq/jobqueue'
 
 const router: Router = Router()
 
-router.post('/', Controller.SubmitPOST)
+router.post('/', Validator.POST, Controller.SubmitPOST)
 successListener.on('submit_result', Controller.onSuccess)
 
 export default router

src/routes/api/submit/index.ts

@@ -0,0 +1,43 @@
+import { Handler } from 'express'
+import BaseValidator from 'validators/baseValidator'
+import * as Joi from '@hapi/joi'
+
+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'),
+    timelimit: Joi
+      .number(),
+    callback: Joi
+      .string()
+      .uri()
+      .when('mode', { is: 'callback', then: Joi.string().required() }),
+    testcases: Joi
+      .array()
+      .min(1)
+      .items(
+        Joi.object({
+          id: Joi.number().required(),
+          stdin: Joi.string().uri(),
+          stdout: Joi.string().uri()
+        })
+      )
+      .required()
+  })
+}
+
+export default new RunValidator()

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()
+    }
+  }
+}