Сервис динамического сегментирования пользователей

Это решение тестового задания для стажёра Backend в AvitoTech. Сценарии использования, требования и детали по заданию в репозитории.

Задача

Требовалось реализовать сервис, хранящий пользователя и сегменты, в которых он состоит (создание, изменение, удаление сегментов, а также добавление и удаление пользователей в сегмент).

Сервис предоставляет HTTP API с форматом JSON как при отправке запроса, так и при получении результата.

Структура HTTP API

Публичные endpoint'ы, доступные всем:

POST /seg - создание сегмента
DELETE /seg - удаление сегмента
PUT /seg - добавление/удаление пользователя в сегмент
GET /seg - просмотр активных сегментов пользователя

Схема базы данных

Архитектура

Структура проекта

├── cmd
|   ├── app
|
├── configs
├── internal
|   ├── app
|   ├── controller
|   ├── entity
|   ├── repository
|   ├── usecase
|
├── migrations
├── .env
├── .gitignore
├── Makefile
├── README.md
├── go.mod
├── go.sum

Запуск и отладка

Все команды, используемые в процессе разработки и тестирования, фиксировались в Makefile.

Чтобы поднять проект, необходимо выполнить две задачи из Makefile:

make compose-build
make compose-up

Примеры запросов

• Создание сегмента
• Удаление сегмента
• Добавление/удаление пользователя в сегмент
• Просмотр активных сегментов пользователя

Создание сегмента

Создание нового сегмента:

curl --location --request POST http://localhost:8080/seg \
--data-raw '{
    "slug": "AVITO_DISCOUNT_30"
}'

Пример ответа:

{
    "seg_id": 1,
    "slug": "AVITO_DISCOUNT_30"
}

Удаление сегмента

Удаление сегмента:

curl --location --request DELETE http://localhost:8080/seg \
--data-raw '{
    "slug": "AVITO_DISCOUNT_30"
}'

Пример ответа:

{
    "delete segment": "AVITO_DISCOUNT_30"
}

Добавление/удаление пользователя в сегмент

Добавление/удаление пользователя в сегмент:

curl --location --request PUT http://localhost:8080/seg \
--data-raw '{
    "slug_list_add": [
        "AVITO_VOICE_MESSAGES",
        "AVITO_PERFORMANCE_VAS"
        ],
    "slug_list_del": [
        "AVITO_DISCOUNT_30",
        "AVITO_DISCOUNT_40",
        "AVITO_DISCOUNT_50",
        "AVITO_DISCOUNT_60"], 
    "user_id": 1
}'

Пример ответа:

{
    "add segments": [
        "AVITO_VOICE_MESSAGES",
        "AVITO_PERFORMANCE_VAS"
    ],
    "delete segments": [
        "AVITO_DISCOUNT_30",
        "AVITO_DISCOUNT_40",
        "AVITO_DISCOUNT_50",
        "AVITO_DISCOUNT_60"
    ],
    "user_id": 1
}

Просмотр активных сегментов пользователя

Просмотр активных сегментов пользователя:

curl --location --request GET http://localhost:8080/seg \
--data-raw '{
    "user_id": 1
}'

Пример ответа:

[
    {
        "seg_id": 5,
        "slug": "AVITO_VOICE_MESSAGES"
    },
    {
        "seg_id": 6,
        "slug": "AVITO_PERFORMANCE_VAS"
    }
]

Миграции БД

CREATE USER dev WITH PASSWORD 'qwerty';
CREATE DATABASE user_seg_app_dev;

migrate create -ext sql -dir migrations create_segments
migrate create -ext sql -dir migrations create_users_with_segments

migrate -path migrations -database "postgres://localhost/user_seg_app_dev?sslmode=disable&user=dev&password=qwerty" up

\c user_seg_app_dev
\d segments
\d users_with_segments

CREATE DATABASE user_seg_app_test;

migrate -path migrations -database "postgres://localhost/user_seg_app_test?sslmode=disable&user=dev&password=qwerty" up