diff --git a/docs/architecture.png b/docs/architecture.png new file mode 100644 index 0000000..8af3b50 Binary files /dev/null and b/docs/architecture.png differ diff --git a/docs/architecture.puml b/docs/architecture.puml new file mode 100644 index 0000000..45eab12 --- /dev/null +++ b/docs/architecture.puml @@ -0,0 +1,24 @@ +@startuml + +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml + +title C4 — Container diagram + +Person(client, "Client", "Клиент мессенджера") + +System_Boundary(messenger, "Messenger") { + + Container(api, "API", "Go", "HTTP API: authentication, users, chats and messages") + + ContainerDb(postgres, "PostgreSQL", "PostgreSQL", "Source of truth: users, chats, members and messages") + + ContainerDb(redis, "Redis", "Redis", "Active sessions and chat cache") +} + +Rel(client, api, "Работает с API", "HTTP/JSON") + +Rel(api, postgres, "Читает и записывает данные", "SQL") + +Rel(api, redis, "Хранит сессии и кэширует чаты", "Redis protocol") + +@enduml \ No newline at end of file diff --git a/docs/track-5-report-md b/docs/track-5-report-md new file mode 100644 index 0000000..f6aa650 --- /dev/null +++ b/docs/track-5-report-md @@ -0,0 +1,52 @@ +Трек 5 + + +Цель + +Цель работы - уменьшить количество обращений к PostgreSQL при чтении данных чатов за счёт использования Redis и устранить избыточные запросы при одновременном обращении нескольких клиентов к одному чату. + +Реализация + +Для кэширования используется Redis. Данные чатов сохраняются в кэше с ограниченным временем жизни (TTL). +При получении чата приложение сначала проверяет наличие данных в кэше. Если запись найдена, данные возвращаются без обращения к PostgreSQL. При промахе кэша приложение загружает данные из PostgreSQL, сохраняет результат в Redis и возвращает его клиенту. +Для обработки конкурентных запросов используется singleflight из Go. Он объединяет одновременно выполняющиеся операции с одинаковым ключом внутри одного экземпляра приложения. + +Основные файлы реализации: + +internal/cache/cache.go - операции чтения и записи кэша; +internal/httpapi/chats.go - интеграция кэша с HTTP-обработчиком и использование singleflight; +internal/store/store.go - получение данных из PostgreSQL и счётчик SQL-запросов. + +Проверка корректности + +Для проверки используются тесты: +TestChatCache_ConcurrentRequests - конкурентные запросы к одному чату; +TestChatCache_WarmCache - повторное чтение из прогретого кэша; +TestChatCache_ReadAfterWriteAndRecovery - актуальность данных и восстановление после удаления записи из кэша. + +Измерение количества SQL-запросов + +Сравниваются следующие сценарии: +Прямые конкурентные вызовы GetChat без HTTP-кэша. +Конкурентные HTTP-запросы при холодном кэше. +Повторные HTTP-запросы при прогретом кэше. + +Сценарий Количество запросов Число SQL-запросов +Прямые конкурентные вызовы GetChat 50 100 + +HTTP-запросы при холодном кэше 50 2 + +HTTP-запросы при прогретом кэше 50 0 + + +Измерения выполняются на одной и той же тестовой конфигурации. Счётчик SQL-запросов используется для оценки нагрузки на PostgreSQL. + +Команды проверки + +go test ./internal/httpapi -run TestChatCache -v +go test ./... +go test -race ./... + +Вывод + +Реализация позволяет уменьшить число обращений к PostgreSQL при повторном чтении чатов. Использование singleflight сокращает число одинаковых конкурентных загрузок в пределах одного экземпляра приложения. \ No newline at end of file diff --git a/internal/store/store.go b/internal/store/store.go index 8f1cd44..2ec5bff 100644 --- a/internal/store/store.go +++ b/internal/store/store.go @@ -3,6 +3,7 @@ package store import ( "context" "errors" + "fmt" "strconv" "sync/atomic" "time" @@ -137,7 +138,10 @@ func (s *Store) GetChat(ctx context.Context, chatID, userID string) (model.Chat, ).Scan(&c.ID, &c.Title, &c.CreatedAt) if err != nil { - return model.Chat{}, ErrChatNotFound + if errors.Is(err, pgx.ErrNoRows) { + return model.Chat{}, ErrChatNotFound + } + return model.Chat{}, fmt.Errorf("get chat: %w", err) } memberIDs, err := s.listChatMemberIDs(ctx, c.ID) diff --git a/scripts/restart.sh b/scripts/restart.sh index df1a70d..1b84587 100755 --- a/scripts/restart.sh +++ b/scripts/restart.sh @@ -1,5 +1,5 @@ #!/bin/sh set -eu -docker compose restart postgres api +docker compose restart postgres redis api