VinDr Lab / IDGen

VinDr Lab IDGen (or ID Generator) is a part of the VinDr Lab project. Like the name it is, this service generates a new integer value which based on the key as string.

What does this project do?

The ID Generator service works like a counter service base on specified keys. Currently, it allows to increase by one and reset a counter key.

Project tree

.
├── conf/ // configuration files
│   ├── config.development.toml
│   └── config.production.toml
├── constants/ // some constants for project
│   ├── api.go
│   └── errors.go
├── Dockerfile
├── generator/ //main processor
│   ├── generator_api.go
│   └── generator_db.go
├── go.mod
├── go.sum
├── LICENSE.md
├── main.go //runner
├── README.md
└── utils/ // utilities for project
    └── log_utils.go

Installation

Option 1: Kubernetes

Go to deployment project and follow the instruction

Option 2: Docker

You can execute the docker-compose.yml file as follow:

docker-compose pull
docker-compose down
docker-compose up -d --remove-orphans

Option 3: Bare handed

Just run the main.go file

export GO111MODULE=on
go mod tidy
go run main.go

Configuration

Following the Installation, the application has two ways to read the configurations. Once is from the config.produciton.toml file that comes with the app. Or you can override it by passing through environment variables in Docker. As you can see, the configuration file has the following form:

[rqlite]
uri = "YOUR_RQLITE_URI"

Please note that, the conversion from environmental variables to API configuration items itself like: RQLITE__URI equals to rqlite.uri

Testing

Make some basic calls key as 'test' first.

http://localhost:38083/id_generator/test/tap

Normally, it will return 1

{"last_insert_id":1"}

If you keep make request, it return:

{"last_insert_id":2"}

After run the reset request, we got:

http://localhost:38083/id_generator/test/set
http://localhost:38083/id_generator/test/tap

It returns to default

{"last_insert_id":1"}

Others

More information

For a fully documented explanation, please visit the official document.

Roadmap

As I mentioned above, the IDGen service itself does the job of generating value, simple. We hope this can inherit some awsome features from AtomicInteger of Java. Welcome to join us./