cq_server

cq_server

CQ Server is short for Concurrent Queue Server

This application is an HTTP server to accept requests representing jobs which can be enqueued to handlers to do work. Once a request is issued, a job record is created for it in Redis to track progress, which is updated by the worker asynchronously. Then the message is enqueued to RabbitMQ, where a queue worker will process it. Progress can be queried by making requests to the service which will check the record in Redis and return a status update.

endpoints

ask

/ask/{requestType}

- Creates a new identifier token for this request.
- Creates a record to track the status of this work and uploads to Redis.
- Enqueues the work to RabbitMQ based on the `requestType` for process by one of the queue workers.
- Accepts generic payload to enqueue to a worker

get

/get/{requestType}/{id}

- Retrieves record from redis for message with matching `id` and `requestType`
- Returns response

update

/update/{requestType}/{id}

- Updates the status based on the "status" parameter in the request body in Redis
- Called from worker context

workers

Workers are defined in the worker directory. For implementation, copy the worker.go file, and fill in the commented TODO section to perform the work desired.

config

A default localhost config is defined in /config/example.yaml. This is where connections to postgres, RabbitMQ, and Redis are configured, as well as the port that this service will be listening on.