tony824 / accumulation Goto Github PK

Context:
As a developer, I need put some cheap Clojure code in HTTP req and ask the server to run this piece of code for me.

Acceptance Criteria:

1. Create the job
   POST req /v1/jobs with params {:job-name "Sum 100 and 2" :user-id 4 :job-content "(+ 100 2)"}
   a) authenticate the user and return 401 when the user is not logged on
   b) authenticate the user and return 403 when the user does't have permission to create jobs
   c) return 404 when there is an error in url
   d) return 400 when missing params or the submitted code has syntax errors . Params could be users, job name , job content (Clojure code)
   e) return 200 and job-id if everything is good. e.g.{:job-id 123}

2. Check the job status by job-id and get results when the job is done
   GET /v1/job/:job-id
   a) authenticate the user and return 401 when the user is not logged on
   b) authenticate the user and return 403 when the user does't have permission to query the job
   Note: super admins have permissions to query any jobs
   c) return 200 and {:status "In progress"} job status could also be not found, in queue
   d) return 200 and result when the job is finished. e.g. {:status "Finished" :result "102"}

3. Control this feature by env var ENABLE_JOB, when no var or set ENABLE_JOB=false return 400 with message not enabled feature

Release Note for users:

1. Ensure the env var is set before using
2. Ensure you have the permission to create job
3. Ensure you have the permission to query job status or job results

Deploy Note for system team:
set env var. ENABLE_JOB

Impact on confidentiality:
No, this feature doesn't affect existing confidentiality

Impact on availability
No, this feature doesn't affect existing availability