Skip to content

Latest commit

 

History

History
143 lines (99 loc) · 3.68 KB

README.md

File metadata and controls

143 lines (99 loc) · 3.68 KB
Raw

A simple broker API

CircleCI

Description

The queuejs is a simple broker API for dummy purposes.

Design

The API was designed to interact with producer and consumer http clients.

To see the endpoints documentation go here

Dependencies

  • NestJS for API abstraction;
  • Prisma for database abstration;
  • async-lock for concurrency management;
  • PostgreSQL for database engine on production environment;
  • SQLite for database engine on development/test environments;
  • Swagger for API documentation;

Running with docker (if you are hurry !)

$ docker-compose up --build

To see API endpoints go to https://localhost:3000/api (Swagger UI)

Running locally

Before running the code locally, we need to prepare the enviroment.

Prepare

# install dependencies
$ npm install

# create the database structure (sqlite)
$ npm run pushdb:dev

# generate database abstractions
$ npm run pgenerate:dev

Running

Make sure you have prepared the environment.

# development
$ npm run start

# watch mode (hot reload)
$ npm run start:dev

To see API endpoints go to https://localhost:3000/api (Swagger UI)

Testing

Make sure you have prepared the environment.

# create the database structure for integration test (sqlite)
$ npm run pushdb:test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

Tools

Some standalone implementations for producer and consumer are provided.

Currently, the consumer implements at-most-once approach to handle messages.

Example:

  1. Make sure queuejs is running at localhost:3000;
  2. Produce 3 messages (or messages.txt): echo -e 'message1\nmessage2\nmessage3' | node tools/producer.js -t topic1
message1 OK
message2 OK
message3 OK
  1. Consume 3 messages: node tools/consumer.js -t topic1 -w:
[ { topic: 'topic1', data: 'message1', offset: 1 } ]
[ { topic: 'topic1', data: 'message3', offset: 2 } ]
[ { topic: 'topic1', data: 'message2', offset: 3 } ]

tools/producer.js

$ node tools/producer.js --help

Usage: producer.js [options]

produce a message for each stdin line to queuejs

Options:
  -h, --host <host>     The host for queuejs (default: localhost) (default: "localhost")
  -p, --port <port>     The port for queuejs (default: 3000) (default: "3000")
  -t, --topic <topic>  topic to produce messages

tools/consumer.js

$ node tools/consumer.js --help

Usage: consumer.js [options]

consume messages from queuejs and write to stdout

Options:
  -h, --host <host>    The host for queuejs (default: "localhost")
  -p, --port <port>    The port for queuejs (default: "3000")
  -g, --group <group>  The consumer group to be used
  -t, --topic <topic>  topic to produce messages
  -w, --watch          Keep listening for new messages (default: false)

Limitations

This API is not supposed to have multiple instances by database. So scaling horizontally is not an option now.

Backlog

  1. Improve the API client library and documentation;
  2. Add support to reset consumer group offset;
  3. Migrate atomic operations (i.e. produce, commit and consume) to PostgreSQL procedures;
  4. Add partition key support.