add support for mode parameter for POST /runs

Author: abhishek97

package.json

@@ -11,6 +11,7 @@
     "@types/amqplib": "^0.5.4",
     "amqplib": "^0.5.2",
     "apidoc": "^0.17.6",
+    "axios": "^0.18.0",
     "base-64": "^0.1.0",
     "debug": "^4.0.0",
     "express": "^4.16.2",

src/routes/api/run.ts

@@ -1,4 +1,6 @@
 import {Response, Router, Request} from 'express'
+import axios from 'axios'
+
 import {SubmissionAttributes, Submissions} from '../../db/models'
 import {RunJob, queueJob, successListener} from '../../rabbitmq/jobqueue'
 import {isInvalidRunRequest} from '../../validators/SubmissionValidators'
@@ -9,7 +11,9 @@ const route: Router = Router()
 export type RunRequestBody = {
   source: string, //Base64 encoded
   lang: string,
-  stdin: string
+  stdin: string,
+  mode: string,
+  callback?: string
 }
 export interface RunRequest extends Request {
   body: RunRequestBody
@@ -21,7 +25,62 @@ export interface RunResponse {
   stderr: string
 }
 
-const runPool: {[x: number]: Response} = {}
+export type RunPoolElement = {
+  mode: string,
+  res: Response,
+  callback?: string
+}
+
+const runPool: {[x: number]: RunPoolElement} = {}
+
+const handleTimeoutForSubmission = function (submissionId: number) {
+  const job = runPool[submissionId]
+  const errorResponse = {
+    id: submissionId,
+    code: 408,
+    message: "Compile/Run timed out",
+  }
+
+  switch (job.mode) {
+    case 'sync': 
+      job.res.status(408).json(errorResponse)
+      break;
+    case 'callback':
+      axios.post(job.callback, errorResponse)
+  }
+}
+
+const handleSuccessForSubmission = function (result: RunResponse) {
+  const job = runPool[result.id]
+  switch (job.mode) {
+    case 'sync':
+      job.res.status(200).json(result)
+      break;
+    case 'callback':
+      // send a post request to callback 
+      axios.post(job.callback, result)
+      break;
+  }
+}
+
+/**
+ * Returns a runPoolElement for request
+ */
+const getRunPoolElement = function (body: RunRequestBody, res: Response): RunPoolElement {
+  switch (body.mode) {
+    case 'sync':
+      return ({
+        mode: 'sync',
+        res
+      })
+    case 'callback':
+      return ({
+        mode: 'callback',
+        res,
+        callback: body.callback
+      })
+  }
+}
 
 /**
  * @api {post} /runs POST /runs
@@ -70,19 +129,22 @@ route.post('/', (req, res, next) => {
       lang: req.body.lang,
       stdin: req.body.stdin
     })
+
     // Put into pool and wait for judge-worker to respond
-    runPool[submission.id] = res
+    runPool[submission.id] = getRunPoolElement(req.body, res)
+
     setTimeout(() => {
       if (runPool[submission.id]) {
-        runPool[submission.id].status(408).json({
-          id: submission.id,
-          code: 408,
-          message: "Compile/Run timed out",
-        })
+        handleTimeoutForSubmission(submission.id)
         delete runPool[submission.id]
       }
     }, config.RUN.TIMEOUT)
 
+    switch (req.body.mode) {
+      case 'callback':
+        res.sendStatus(200)
+    }
+
   }).catch(err => {
     res.status(501).json({
       code: 501,
@@ -97,7 +159,7 @@ route.post('/', (req, res, next) => {
  */
 successListener.on('success', (result: RunResponse) => {
   if (runPool[result.id]) {
-    runPool[result.id].status(200).json(result)
+    handleSuccessForSubmission(result)
     delete runPool[result.id]
   }
   Submissions.update({

src/validators/SubmissionValidators.ts

@@ -12,6 +12,15 @@ export function isInvalidRunRequest(req: Request): Error | boolean {
   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 false
 }

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "es2015",
+    "target": "es2016",
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
     "sourceMap": true,

yarn.lock

@@ -365,6 +365,14 @@ aws4@^1.6.0:
   version "1.6.0"
   resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.6.0.tgz#83ef5ca860b2b32e4a0deedee8c771b9db57471e"
 
+axios@^0.18.0:
+  version "0.18.0"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.18.0.tgz#32d53e4851efdc0a11993b6cd000789d70c05102"
+  integrity sha1-MtU+SFHv3AoRmTts0AB4nXDAUQI=
+  dependencies:
+    follow-redirects "^1.3.0"
+    is-buffer "^1.1.5"
+
 balanced-match@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
@@ -721,7 +729,7 @@ debug@2.6.9, debug@^2.2.0, debug@^2.3.3, debug@^2.6.9:
   dependencies:
     ms "2.0.0"
 
-debug@3.1.0, debug@^3.0.0, debug@^3.1.0:
+debug@3.1.0, debug@=3.1.0, debug@^3.0.0, debug@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/debug/-/debug-3.1.0.tgz#5bb5a0672628b64149566ba16819e61518c67261"
   dependencies:
@@ -1026,6 +1034,13 @@ find-up@^2.1.0:
   dependencies:
     locate-path "^2.0.0"
 
+follow-redirects@^1.3.0:
+  version "1.6.1"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.6.1.tgz#514973c44b5757368bad8bddfe52f81f015c94cb"
+  integrity sha512-t2JCjbzxQpWvbhts3l6SH1DKzSrx8a+SsaVf4h6bG4kOXUuPYS/kg2Lr4gQSb7eemaHqJkOThF1BGyjlUkO1GQ==
+  dependencies:
+    debug "=3.1.0"
+
 for-in@^1.0.1, for-in@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80"