richodemus/chronicler

An Event Store running on the JVM

Chronicler

An Event Store running on the JVM

Build application and run all tests

./gradlew

Build and run

./build-and-run.sh

Build and run in Docker

./gradlew build buildImage && ./docker-run.sh

Custom Docker Tag

./gradlew buildImage -Ptag=x

Run unit tests

./gradlew test

Run component tests

./gradlew componentTest

Print task dependency tree

./gradlew :server:dropwizard:build :server:dropwizard:taskTree --no-repeat

Configuration

Behaviour is configured via environment variables

• STORAGE - where to store events, values: DISK, GCS (google cloud storage)

Configuration for Disk storage:

• SAVE_TO_DISK - boolean, default true
• DATA_DIR - string, default data/

Configuration for Google Cloud Storage:

• GCS_PROJECT - project name
• GCS_BUCKET - bucket name

See docker-run.sh for examples

chronicler's Issues

Add Code Coverage badge

Coveralls seems to be the largest, but codecov has some vocal fans

Automatically build docker images for git tags

Basically, if someone creates a new tag in git, there should automatically be a docker image with the same tag produced

Investigate serialization libraries for disk persistence

Every millisecond counts!
We should try different libraries to see which one gives the best combination of speed/simplicity
some candidates:

• Json via Jackson
• Protobuf
• Protostuff
• Colfer

more information at jvm-serializers

Add support for gRPC

Could be a nice improvement gain for write-heavy scenarios

Implement disk persistence

The important part here is that we need to make sure that if Chronicler responds with HTTP 200 then the event MUST be persisted to disk, no sitting in the file buffer and being lost in a power outage, I found this on Stackoverflow which seems like the right thing

Add sample values to swagger page

Currently the swagger page does not have proper sample/default values for its entities, instead they look like this:

{
  "id": "null",
  "page": "null",
  "data": "null"
}

preferably it would look something like this:

{
  "id": "0cfbef3e-a145-4cb0-b257-f4ce96bce94c",
  "page": 1,
  "data": "{"foo":"baar"}" // or however json in json would look
}

the swagger spec is located at: server/swagger/src/main/resources/api-specification.yaml

Re-enable gzip

Gzip was disabled across the board to get Server Sent Events to work, it should be re-enabled for everything except the SSE endpoints

Mocking framework

Hi,

hope find you well with this cold call.

I am an author of mocking framework for Kotlin

I see you are using mockito-kotlin.

I just want you to be aware that there is solution that fully supports Kotlin and ask to try it in your new/current projects.

I can help you if you answer to this issue.

Thanks and please star it

Automatically push images to dockerhub

Either via Travis (seems most logical) or via Dockerhubs own automated builds

Upgrade Kotlin version again

Had to downgrade Kotlin to 1.0.6 to get it to work on raspberry pis, once 1.1.2 is out we should be able to upgrade again, when doing so, look at the commit ea07fd4 to make sure we don't miss any workaround that was added