Сервис сокращения URL с Docker

Описание проекта

Это приложение для сокращения URL с использованием Docker и Redis. Приложение позволяет сократить URL и создать короткую ссылку, которая будет перенаправлять на оригинальный ресурс.

Описание структуры файлов:

• Dockerfile — используется для создания Docker-образа приложения.
• docker-compose.yml — конфигурация Docker Compose, включающая сервисы Redis и приложение.
• server.js — основной серверный файл на Node.js, реализующий логику сокращения URL.
• views/ — каталог с шаблонами для отображения страниц (используется EJS).
• services/ — каталог с сервисами:
  • IStorageService.js — интерфейс для различных хранилищ URL.
  • RedisStorageService.js — реализация хранилища URL с использованием Redis.
  • InMemoryStorageService.js — альтернативное хранилище (в памяти) для локального тестирования.
  • UrlService.js — сервис обработки и сокращения ссылок.

Требования

• Установленный Docker для контейнеризации приложения.
• Node.js — для выполнения серверной логики приложения.

Убедитесь, что все зависимости установлены перед запуском приложения.

Установка и запуск:

1. Клонируйте репозиторий:

   git clone https://github.com/YanKarpov/URL-shortening-service.git
   cd URL-shortening-service
   

2. Соберите и запустите контейнеры:

   docker-compose up --build
   

3. Перейдите в браузер и откройте http://localhost:3000.

4. Используйте интерфейс для создания сокращённых ссылок.

Рефакторинг по SOLID: что улучшилось?

В ходе рефакторинга код стал чище, гибче и удобнее для расширения.

• SRP (Принцип единственной ответственности) – логика хранения и обработки ссылок теперь разделена. UrlService отвечает только за работу с URL, а redisStorage.js — за хранение данных.
• OCP (Принцип открытости/закрытости) – теперь можно заменить Redis на другое хранилище (например, MongoDB) без изменения основной логики.
• DIP (Принцип инверсии зависимостей) – UrlService теперь работает через абстрактный интерфейс IStorageService, а не напрямую с Redis. Это снижает зависимость от конкретного хранилища.
• LSP (Принцип подстановки Барбары Лисков) – добавлен IStorageService, который можно реализовать для любого хранилища (Redis, файлы, базы данных), не ломая код.
• ISP (Принцип разделения интерфейсов) – IStorageService содержит только минимальный набор методов (save, get), избавляясь от лишних зависимостей. В будущем можно выделить IClickStatsService для сбора статистики.

Какая польза от этого?

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

Тестирование

Тесты обращаются к уже работающему серверу http://localhost:3000,
поэтому перед запуском тестов нужно поднять контейнеры Docker, т.к как минимум нужно стучаться к рабочему Redis. Но лучше себе жизнь не усложнять и запустить сразу само приложение и Redis с учётом наличия docker-compose.yml

1. Поднятие окружения

docker-compose up --build -d

2. Установка зависимостей для тестов

Локально установите Node.js-зависимости:

npm install

3. Запуск тестов || Интеграция с allure

npm test
npm run allure:report