Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pedrosfaria2/email_verifier

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/pedrosfaria2/email_verifier
Owner: pedrosfaria2
Created: 2024-05-20T21:16:21.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-06-16T21:26:30.000Z (7 months ago)
Last Synced: 2024-06-16T22:34:30.127Z (7 months ago)
Language: Kotlin
Size: 231 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Email Verifier

An app for verifying email addresses in a registration flow, which is
designed to handle very high throughput.

## Set up

1. Run docker-compose.

```shell
docker-compose up
```

1. Run migrations
```shell
./gradlew devMigrate testMigrate
```

## Build and run

1. Use the [Gradle Kotlin plugin](https://kotlinlang.org/docs/gradle.html#compiler-options)
to run tests, build, and fetch dependencies.
For example, to build run
```shell
./gradlew build
```

1. Run the notification server.
```shell
./gradlew applications:notification-server:run
```

Luckily, Gradle fuzzy-matches task names, so the command can optionally be shortened to

```shell
./gradlew a:n:r
```

1. Run the registration server in a separate terminal window.
```shell
./gradlew applications:registration-server:run
```

1. Run the fake Sendgrid server in another separate terminal window.
```shell
./gradlew platform-support:fake-sendgrid:run
```

## Make requests

1. Post to [http://localhost:8081/request-registration](http://localhost:8081/request-registration)
to make a registration request.
Include the email address to register in the request body.
```json
{
"email": "[email protected]"
}
```

Don't forget to add the content type header.
```text
Content-Type: application/json
```

1. Check the logs of the fake Sendgrid server for your confirmation code.
Once you receive it, post to [http://localhost:8081/register](http://localhost:8081/register)
to confirm your registration.
Include your email address and confirmation code in the request body.
```json
{
"email": "[email protected]",
"confirmationCode": "18675309-1234-5678-90ab-cdef00000000"
}
```

Don't forget to add the content type header.
```text
Content-Type: application/json
```

See the `requests.http` file for sample requests

## Benchmarks

The _benchmark app_ runs a simple benchmark test against the running apps.

1. Stop the fake Sendgrid app, then run the benchmark app with
```shell
./gradlew applications:benchmark:run
```

This will send some traffic to the notification and registration servers, and will print some basic metrics to the
console.

1. Once the benchmark is finished, try running it again giving different values for the `REGISTRATION_COUNT`,
`REGISTRATION_WORKER_COUNT`, and `REQUEST_WORKER_COUNT` environment variables.

1. After getting comfortable with the environment, try running multiple instances of the notification server and the
registration server.
Make sure to provide a unique `PORT` environment variable to each instance of the registration server.

## Consistent hash exchange

Now that we have our system working with multiple instances, we will implement a [consistent hash exchange](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_consistent_hash_exchange)
to better distribute load between our registration request consumers.