url-shortener

URL shortener (“сокращатель ссылок”) - это сервис, позволяющий пользователю генерировать для произвольного URL’a его короткую версию, которую удобно вставлять в различные публикации, сообщения, новости, промо-материалы и так далее. Также сервис позволяет получать статистику переходов по каждому сгенерированному URL’у, что будет полезно, если его владелец захочет узнать сколько людей перешло по короткой ссылке из конкретного источника.

Бизнес логика

Описание, список возможных операции, которые будут соврешать наше приложение:

1. Создание ссылки, на входе передаем исходный url ссылки, кодируем и возвращаем короткий url, возвращаем url для просмотра статистики по созданной ссылке.
2. Переход по короткой ссылке, осуществляем редирект на исходный url, увеличиваем счетчик переходов, делаем запись в лог переходов.
3. Просмотр, выдача статистики по ссылке:

Карточка ссылки:

• Исходный url ссылки - origin url
• Короткий url - short url
• Дата создания ссылки - created at
• Количество переходов - redirect count.
• Ссылка на лог статистики - stats id

При переходе по короткой ссылке:

1. Определить и записать referrer

2. Определить и записать location ip

3. Увеличить счетчик переходов по ссылке.

4. Сделать новую запись в лог

5. Осуществить редирект на оригинальную ссылку.

6. Лог пееходов может содержать: id ссылки, дата перехода, источник хост, IP, Источник перехода? Referers, IP адрес хоста с которго был произведен клик по ссылке Location.

7. Показать список всех записей лога по короткой ссылке.

Models: link, stats

Выбор роутера

Роутером проекта выбран роутер go-chi/chi, так как он позволяет:

1. Устанавливать продвинутые правила маршрутизации запросов, при этом сохраняя компактность и удобность интерфейса, подобный тому, который предоставляет пакет net/http.
2. Примеры кода с этим роутером мне показались более понятны. В Readme.md и в _examples понятно описанное API.
3. Роутер активно развивается v5.0.4 от 25 авг. 2021г., а, например, gorilla/mux v1.8.0 от 22 авг. 2020г.
4. Судя по отзывам и рекомендациям коллег, для него есть достаточно хороший кодогенаратор основанный на OpenaAPI 3.0 - deepmap/oapi-codegen, который я так же собираюсь подключить и опробовать в проекте.

Дополнительно:

1. Выбрать и реализовать алгоритм кодирования ссылки.
2. Решить нужен ли логин для просмотра статистики, админка.
3. Для просмотр списка всех ссылок. решить нужен ли фильтр по исходному url ссылки. Фильтр можно вынести на фронтенд.

https://golangci-lint.run/usage/install/#local-installation

Changelog:

1. Golangci lint is enabled
2. Pre-commit is installed and the git hook scripts are configured
3. GitHub Actions are configured