Merge pull request #23 from abhishek97/runEnc

add support for enc parameter for POST: /runs

Author: championswimmer

migrations/001-addOutputsToSubmission.sql

@@ -1,2 +1 @@
-alter table submissions 
-  add column outputs varchar[];
+alter table submissions add column outputs varchar[];

src/routes/api/run.ts

@@ -5,6 +5,7 @@ import {SubmissionAttributes, Submissions, db} from '../../db/models'
 import {RunJob, queueJob, successListener} from '../../rabbitmq/jobqueue'
 import {isInvalidRunRequest} from '../../validators/SubmissionValidators'
 import {upload} from '../../utils/s3'
+import {normalizeRunJob} from '../../utils'
 import config = require('../../../config')
 
 const route: Router = Router()
@@ -110,6 +111,7 @@ const getRunPoolElement = function (body: RunRequestBody, res: Response): RunPoo
  * @apiParam {String(Base64)} input [Optional] stdin input for the program (encoded in base64)
  * @apiParam {Enum} mode [Optional] mode for request. Default = `sync`, see: https://github.com/coding-blocks/judge-api/issues/16
  * @apiParam {String)} callback [Optional] callback url for request. Required for `mode = callback`
+ * @apiParam {String)} enc [Optional] Encoding type for stdin and source. Can be `url`|`base64`. Default = 'base64' 
  *
  * @apiUse AvailableLangs
  *
@@ -151,14 +153,16 @@ route.post('/', (req, res, next) => {
   Submissions.create(<SubmissionAttributes>{
     lang: req.body.lang,
     start_time: new Date()
-  }).then((submission: SubmissionAttributes) => {
+  }).then(async (submission: SubmissionAttributes) => {
 
-    let queued = queueJob(<RunJob>{
+    const job: RunJob = await normalizeRunJob({
       id: submission.id,
       source: req.body.source,
       lang: req.body.lang,
       stdin: req.body.stdin
-    })
+    }, req.body.enc)
+
+    let queued = queueJob(job)
 
     // Put into pool and wait for judge-worker to respond
     runPool[submission.id] = getRunPoolElement(req.body, res)

src/utils/index.ts

@@ -0,0 +1,21 @@
+import {RunJob} from '../rabbitmq/jobqueue'
+import {download} from './s3'
+
+/**
+ * Normalizes the Run Job (effectively normalizes source and stdin to base64 immediate values)
+ * @param {RunJob} job
+ * @param {string} enc (Default = 'base64')
+ * @returns {Promise<RunJob>} the normalized runJob
+ */
+export const normalizeRunJob = async function (job: RunJob, enc:string = 'base64') : Promise<RunJob> {
+  switch (enc) {
+    case 'url':
+      const [source, stdin] = await Promise.all([download(job.source), download(job.stdin)])
+      return {
+        ...job,
+        source,
+        stdin
+      }
+    default: return job
+  }
+}

src/utils/s3.ts

@@ -1,5 +1,6 @@
 import Minio = require('minio')
 import v4 =  require('uuid/v4')
+import axios from 'axios'
 import config = require('../../config')
 
 const client = new Minio.Client({
@@ -17,11 +18,31 @@ export type savedFile = {
 
 export const urlForFilename = (bucket: string, filename: string) : string => `http${config.S3.ssl ? 's': ''}://${config.S3.endpoint}/${bucket}/${filename}`
 
+/**
+ * Uploads an object to s3 encoded as json
+ * @param {object} object
+ * @param {string} filename The filename (Default = randomized)
+ * @param {string} bucket The bucket name (Default = picked from config.json)
+ * @returns {Promise<savedFile>} The etag and url for the file saved
+ */
 export const upload = function (object:object, filename:string = v4() + '.json' ,bucket:string = config.S3.bucket) : Promise<savedFile> {
   return new Promise((resolve, reject) => {
     client.putObject(bucket, filename, JSON.stringify(object), function(err, etag) {
       if (err) return reject(err)
       resolve({etag, url: urlForFilename(bucket, filename) })
     })
   })
+}
+
+/**
+ * Downloads a file from url and encodes it 
+ * @param {string} url
+ * @param {string} enc (Default = 'base64')
+ * @returns {Promise<string>} the downloaded file encoded as specified
+ */
+export const download = async function (url: string, enc: string = 'base64') : Promise<string> {
+  if (!url) return ''
+   
+  const {data} = await axios.get(url)
+  return Buffer.from(data).toString(enc)
 }