psaproxy / demo2

Задача

Используя фреймворк Yii2 (basic) необходимо написать генератор коротких url. Получение ссылок реализовать по RESTful протоколу в формате json. Реализовать 2 метода: POST /api/v1/link/create - с параметром url, в котором будет передаваться исходная ссылка. Метод должен возвращать сокращенную ссылку в виде https://yourdomain.com/j5oK4s. Генерация должна происходить на стороне сервера без использования сторонних сервисов. GET /api/v1/link/{hash} - где hash это уникальный идентификатор сгенерированной ссылки, например j5oK4s из предыдущего пункта. Возвращает исходную ссылку и кол-во переходов по ней. Короткий URL должен уникальным, редиректить на исходную ссылку и быть актуальным всегда, неважно, сколько раз он был использован.

Приложение

Команды управления в файле Makefile.

Укороченный URL-адрес: http://localhost:13380/r/<id>.

Архитектура

Архитектура на основе Clean Architecture с элементами DDD. Полный DDD не используется ввиду сложности проектирования агрегатов и их связи с другими агрегатами в сложной прикладной модели. Для упрощения проектирования и ускорения разработки.

Ядро проекта (бизнес-логика) в директории core. Инфраструктурный слой (БД, кеш, обращение во внешние API, и т.п.) в директории infrastructure.

Выделение ядра в отдельный слой помогает абстрагироваться от приложения (FW). При этом доменный слой имеет связь с инфраструктурным слоем через обратную зависимость. В результате максимально уменьшается связь между бизнес-логикой и фреймворком.

Логика взаимодействия с хранилищами (БД, кеш и т.п.) разделена на:

• Репозиторий - интерфейс представления коллекции сущностей из хранилища. Используется только для работы со всей сущностью целиком. Полная связь с доменным слоем.
• Провайдер данных - интерфейс чтения данных из хранилища. Применяется для чтения части или всех данных сущности с минимум обращения в доменный слой. Для облегчения выполнения запроса в хранилище, ускорения и уменьшения нагрузки.
• Шлюз БД - интерфейс обновления данных в хранилище с минимум обращения в доменный слой. Для облегчения выполнения запроса в хранилище, ускорения и уменьшения нагрузки.

ID сущностей в формате UUID v4. Чтобы для генерировать на стороне кода, а не через хранилище. Это позволяет изолировать доменный слой (бизнес-логику) от инфраструктурного слоя (БД). При необходимости уникальное имя сущности является главным ключем, чтобы не создавать излишнее свойство в виде отдельного ID.

UI слой (контроллеры) взаимодействуют только с прикладным слоем через действия. Действия - это сервисы прикладного слоя для оркестрации (управления) доменным слоем (бизнес-логикой).

Основная цель в том, чтобы разделить реализацию на:

• логику интерфейса запроса
• логику управления
• бизнес-логику
• логику БД/API и подобное С разделением на сценарий выполнения и представление данных в виде типизированных объектов.

В результате:

• Уменьшается сложность и сцепленность всей реализации. Что позволяет уменьшить затраты на поддержание и развитие проекта. Особенно после MVP этапа или фазы активного развития.
• Уменьшается связь бизнес-логики с приложением. Что максимально упрощает миграцию на другой FW.
• Упрощается чтение реализации. Что очень сильно облегчает введение в проект новых разработчиков.
• Упрощается тестирование и отладка.

Реализация

Контроллер обработки укороченной ссылки для редиректа controllers/RedirectController. Контроллер API modules/api/v1/controllers/LinkController. Бизнес-логика core.

Генерация короткого ID укорачиваемого URL-адреса с помощью bin2hex(random_bytes(8)). Обновление счетчика перехода с прямой записью в БД. Упрощение в рамках тестового задания. Для боевой задачи необходимо реализовать запись счетчика в кеш, с последующей записью в БД с помощью CLI-команды по расписанию. Пример в другом demo-задании.

Установка и настройка окружения

Для Debian & Ubuntu.

Обновление системы

Выполнить с root правами.

apt-get update \
    && apt-get upgrade \
    && apt-get install make libssl-dev libghc-zlib-dev libcurl4-gnutls-dev libexpat1-dev gettext unzip apt-transport-https ca-certificates curl gnupg2 software-properties-common make libcurl4-gnutls-dev gcc libssl-dev expat libexpat1-dev gettext wget

Установка Docker

Выполнить с root правами.

curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg \
    && echo \
"deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian \
$(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null \
    && apt-get update \
    && apt-get install docker-ce docker-ce-cli containerd.io

Добавить рабочего пользователя в группу докера:

sudo usermod -aG docker ${USER}

Перезапустить сеанса рабочего пользователя.

Тест:

docker version

Тест из-под рабочего пользователя:

docker ps

На основе инструкции.

Установка Docker Compose

Выполнить с root правами.

Узнать актуальную версию в исходниках.

export dockerComposeVersion=<версия>

curl -L "https://github.com/docker/compose/releases/download/${dockerComposeVersion}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose \
    && chmod +x /usr/local/bin/docker-compose

Тест:

docker-compose version

На основе инструкции.

Установка GIT

Выполнить с root правами.

Узнать актуальную версию в исходниках.

export gitVersion=<версия>

cd /tmp \
    && wget https://github.com/git/git/archive/v${gitVersion}.zip -O git.zip \
    && unzip git.zip \
    && cd git-${gitVersion} \
    && make prefix=/usr/local all \
    && make prefix=/usr/local install \
    && cd ~ \
    && rm -rf /tmp/git.zip \
    && rm -rf /tmp/git-${gitVersion}

Тест:

git version

На основе инструкции.

Добавление SSH ключа для GitHub

ssh-keygen -t ed25519 -f ~/.ssh/github -C "<email аккаунта github>"

echo 'Host github.com \
    IdentityFile ~/.ssh/github' \
    >> ~/.ssh/config

cat ~/.ssh/github.pub

Скопировать результат вывода cat и выполнить добавление ключа в аккаунт github по инструкции.

Тест:

ssh -T [email protected]

Установка и настройка приложения

Клонирование git-репозитория

Создать и перейти в директорию для исходников приложения, например:

mkdir -p ~/dev/demo && cd ~/dev/demo

Выполнить:

git clone [email protected]:Psaproxy/demo2.git \
    && find demo/ -mindepth 1 -maxdepth 1 -exec mv -t ./ -- {} + \
    && rm -rf demo \

Настройка окружения приложения

cp .env.example .env

Отредактировать .env при необходимости.

Установка и запуск приложения

make install

CLI-тест:

make cli ARGS=app:test

WEB-тест:

http://localhost:13380