bugthesystem / reducio

❱ 🐇 URL shortener service is written in Scala using Akka-Http and Redis ❰

❱ reduc.io ❰

URL shortener service http://reduc.io/wuXaq

Tech stack

• Scala
• Akka Http
• Circe
• Redis
• ScalaTest
• Specs2
• Mockito
• Gatling

Alternative solutions

We could use following short code gen also:

substr(base62(md5(url)), 6) = 62 ^ 6 //unique short urls

Commands

Run

Run docker-compose, it will start api, redis and will expose api port to host.

docker-compose up

Sample usage

# Shorten
curl -i http://localhost:9001 -F "url=https://www.amazon.com/Star-Wars-Battlefront-II-Digital/dp/B072JZZ4XD"

# Call shortened url
for ((i=1;i<=100;i++)); do curl -i "http://localhost:9001/SEwuXHhBQw"; done

# Get Stats
curl -i "http://localhost:9001/stats/?url=https://www.amazon.com/Star-Wars-Battlefront-II-Digital/dp/B072JZZ4XD"

# returns: {"callCount":100}

Create executable

sbt packageBin

Test

sbt test

Gatling Simulation

Simulation users count can be set in application.conf in test resources.

# terminal 1
sbt run

# Run simulation in terminal 2
sbt gatling:test gatling:latestReport

Coverage with Report

sbt clean coverage test coverageReport

Improvements

• Seperate read and write API's
• Move statistics to different data store and API
• Add DB support by having write master/replicas and have read replicas
• Move hit counts to MapReduce job and generate them from the Web Server logs
• Implement Authentication using JWT authentication protocol with OAuth2 authentication framework
• API Documentation using swagger or similar
• Add Host denyList
• Add Retry policies for Redis calls using Retry or similar one
• Add Throttling using akka-http-contrib
• Add Metrics support using akka-http-metrics

z i λ a s a l.

reducio's Issues

Host it on your own

Can you host reduc.io on your own just with ftp and manually creating databases/modifying files? Unfortunately, I'm not able to run commands.

Image on Docker Hub

Would be great to have a prebuilt docker image on docker hub!

JWT authentication

Can you provide more detailed explanation when it comes to authentication? E.g. which framework? Would you embed the authentication mechanism in the application or use some dedicated server for authentication (e.g. Keycloack) and only perform authorization within the application?