go-sandbox-demo

A simple demo site for the go-judge, deployed on heroku. Under development...

Components:

Frontend: Vue.js
APIGateway: GO
Backend: GO
Judger Client: GO
Dev Server Compiler: Air

Tools:

go install github.com/cosmtrek/air@latest
go install github.com/DarthSim/overmind@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

API Gateway

Interface

GET /api/submission?id=_id: Query history submissions
POST /api/submit: Submit judge request
WS /api/ws/judge: Broadcast judge updates
WS /api/ws/shell: Interactive shell
GET /: SPA HTML & JS -> /dist

Backend

Token-based gRPC

submission(id)
submit(request)
updates(): stream judge updates
judge(): stream for judge client
shell(): stream for interactive shell

default ports:

gRPC: :5081
metrics: :5082

Judge Client

Connect to backend with judge()

-metrics: :2112

Development

# front end
npm run dev
# apigateway 
# demoserver
# judger
overmind start -f Procfile.dev

# mongoDB
docker run -p 27017:27017 mongo
# exec server
air

Docker build

docker build -t apigateway -f Dockerfile.apigateway .
docker build -t demoserver -f Dockerfile.demoserver .

docker build -t judger -f Dockerfile.judger .
docker build -t judger_exec -f Dockerfile.exec .

Docker run

docker run --name mongo -d -p 27017:27017 mongo

docker run --name demo --link mongo -d -e TOKEN=token -e GRPC_ADDR=:6081 -e MONGODB_URI=mongodb://mongo:27017/admin -e RELEASE=1 -p 6081:6081 -p 5082:5082 demoserver

docker run --name apigateway --link demo -d -e TOKEN=token -e DEMO_SERVER=demo:6081 -e RELEASE=1 -p 5000:5000 apigateway

docker run --name exec -d --privileged -e ES_AUTH_TOKEN=token -e ES_ENABLE_GRPC=1 -e ES_ENABLE_METRICS=1 -e ES_ENABLE_DEBUG=1 -e ES_GRPC_ADDR=:6051 -e ES_HTTP_ADDR=:6050 -p 6051:6051 -p 6050:6050 judger_exec

docker run --name judger --link exec --link demo -d -e TOKEN=token -e DEMO_SERVER=demo:6081 -e EXEC_SERVER=exec:6051 -e RELEASE=1 -p 2112:2112 judger

Data Model

Language:

{
  "name": "c++",
  "sourceFileName": "a.cc",
  "compileCmd": "g++ -o a a.cc",
  "executables": [ "a" ],
  "runCmd": "a",
}

Result:

{
  "_id": "primary key",
  "language": "<language>",
  "source": "<source code>",
  "date": "<submit date>",
  "status": "<current status (AC / TLE / MLE / OLE / JGF)>",
  "totalTime": "total time",
  "maxMemory": "max memory",
  "results": [
    {
      "time": "<user time (ms)>",
      "memory": "<memory (kb)>",
      "stdin": "<stdin>",
      "stdout": "<stdout>",
      "stderr": "<stderr>",
      "log": "<judger log>",
    },
  ],
}

POST /api/submit

Request:

{
  "language": "<language>",
  "source": "<source code>",
}

Response:

{
  "_id": "<_id>"
}

Client WS

S -> C:

{
  "id": "<id>",
  "status": "<status>",
  "date": "<date>",
  "language": "language name",
  "results": "results[]"
}

Judger WS

Include Authorization: Token token in the HTTP Header when call for upgrade.

J -> S:

Progress:

{
  "id": "<id>",
  "type": "progress",
  "status": "<status>",
  "date": "<date>",
  "language": "language name",
}

Finish:

{
  "id": "<id>",
  "type": "finish",
  "status": "<status>",
  "date": "<date>",
  "language": "language name",
  "results": [ "result" ],
}

S -> J:

{
  "id": "<id>",
  "language": "<language>",
  "source": "source",
}

thesabbir/go-judger-demo