NOTE - Run all commands from the project root
Most of the configuration is done via Environment variables that are passed to docker-compose (docs).
You can either set them up in your shell or create .env in project root.
See .env.template file for possible options and defaults.
NOTE - Set at least:
DJANGO_SECRET_KEY
TARGET_ENV (development|production)
Interactive docs are available under /api/docs
how it works
Once Url is created (via api or admin) - it will redirect permanently from /{token} path to original long_url.
URL can stay in high demand as backend will constantly refresh Redis cache to CACHE_TIMEOUT_READ settings.
Cache is set at create too with CACHE_TIMEOUT_READ setting. Cache is updated/deleted on PUT or DELETE.
list
GET /api/urls/
Auth method: Basic
Return a list of all the existing urls.
Query Parameters
The following parameters should be included as part of a URL query string.
page A page number within the paginated result set.
create
POST /api/urls/
Auth method: None (Public)
Create a new short url.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
long_url (required)
click_limit (optional, if set url is deleted after limit is reached)
read
GET /api/urls/{token}/
Auth method: None (Public)
Return the given url using token.
Path Parameters
The following parameters should be included in the URL path.
token required
update
PUT /api/urls/{token}/
Auth method: Basic
Update long url (long_url body needed)
The following parameters should be included in the URL path.
token (required)
The request body should be a "application/json" encoded object, containing the following items.
long_url (required)
click_limit
delete
DELETE /api/urls/{token}/
Auth method: Basic
Delete url and clear cache
The following parameters should be included in the URL path.
token (required)
admin
There is admin panel available too under /admin. Make sure to createsuperuser before.
With TARGET_ENV=development -> docker-compose up. Access in browser -> localhost:8001
This loads docker-compose.override.yml and mounts app directory to container.
Any code changes will restart server dynamically.
- Run development server -
docker-compose up - Run development server (with stdout for debug) -
docker-compose run -p 8001:8001 ur_l - To run local dir tests -
docker-compose run ur_l test - To run local dir linter
docker-compose run ur_l lint_mounted_dir - Access to manage.py -
docker-compose run manage {args}
NOTES:
- First run will need
docker-compose run ur_l manage migrate - Nginx is not running in dev but it's port (
8000) is reserved. - Redis cache is dev should be persistent - to disable, remove redis volume in docker-compose.override.yml
With TARGET_ENV=production -> docker-compose -f docker-compose.yml up. Access in browser -> localhost:8000
Local code changes will not be visible.
- Run server -
docker-compose -f docker-compose.yml up - To run tests -
docker-compose -f docker-compose.yml run ur_l test - Access to manage.py -
docker-compose -f docker-compose.yml run ur_l manage {args}
NOTES:
- Local code changes will not be visible after image is built.
If any changes to dependencies, run below before rebuilding docker images:
poetry update
See the poetry docs for information on how to add/update dependencies.
The Dockerfile uses multi-stage builds to run lint before building the production stage. If linting fails the build will fail too.
Same commands as in Dockerfile can be run in poetry shell
NOTES:
- To rebuild images, run
docker-compose build - pyproject.yml and poetry.lock are used for dependency caching
To run, execute below with whole stack running:
docker exec `docker ps -qf "name=ur_l_nginx"` benchmark
Fetching url - Mean time 4.004 ms:
Server Software: nginx/1.18.0
Server Hostname: localhost
Server Port: 80
Document Path: /Lq9uJfc
Concurrency Level: 10
Time taken for tests: 20.020 seconds
Complete requests: 5000
Failed requests: 0
Non-2xx responses: 5000
Keep-Alive requests: 4954
Total transferred: 2034770 bytes
HTML transferred: 0 bytes
Requests per second: 249.75 [#/sec] (mean)
Time per request: 40.040 [ms] (mean)
Time per request: 4.004 [ms] (mean, across all concurrent requests)
Transfer rate: 99.25 [Kbytes/sec] received
Connection Times (ms)
min mean[+/-sd] median max
Connect: 0 0 0.0 0 0
Processing: 11 40 8.5 39 243
Waiting: 11 40 8.5 39 243
Total: 11 40 8.5 39 244
Percentage of the requests served within a certain time (ms)
50% 39
66% 41
75% 42
80% 43
90% 47
95% 52
98% 60
99% 71
100% 244 (longest request)
Creating url - Mean time 3.987 ms:
Server Software: nginx/1.18.0
Server Hostname: localhost
Server Port: 80
Document Path: /api/urls/
Document Length: 102 bytes
Concurrency Level: 10
Time taken for tests: 19.935 seconds
Complete requests: 5000
Failed requests: 0
Total transferred: 1990000 bytes
Total body sent: 845000
HTML transferred: 510000 bytes
Requests per second: 250.81 [#/sec] (mean)
Time per request: 39.871 [ms] (mean)
Time per request: 3.987 [ms] (mean, across all concurrent requests)
Transfer rate: 97.48 [Kbytes/sec] received
41.39 kb/s sent
138.88 kb/s total
Connection Times (ms)
min mean[+/-sd] median max
Connect: 0 0 0.1 0 3
Processing: 10 40 5.8 39 160
Waiting: 10 39 5.8 39 160
Total: 11 40 5.9 39 160
Percentage of the requests served within a certain time (ms)
50% 39
66% 41
75% 42
80% 43
90% 46
95% 49
98% 53
99% 57
100% 160 (longest request)
- Build Docker Image (includes
)
- Run containers
- Benchmark with ab
- Run tests (pass >=
)
- Push Docker Image
- I tried to reference snippets in code
- Build is based on https://github.com/michael0liver/python-poetry-docker-example which was also first presented in here python-poetry/poetry#1879