diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8ceefa10..40fd81e5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,52 @@ ## Лабораторная 2 -Автор / группа: TODO -Целевая оценка (3/4/5): TODO -Трек 5, если заявлен: TODO +Автор / группа: Антипин Егор Иванович, БПИ2301 +Целевая оценка (3/4/5): 4 +Трек 5, если заявлен: не заявлен -Что реализовано и что перенесено: TODO -Команды запуска из чистого clone: TODO -Результаты проверок и ссылка на REPORT.md: TODO -Ограничения / известные ошибки: TODO -Источники и использование ИИ: TODO +Что реализовано и что перенесено: пользователи, чаты, членство, сообщения и действующие +сессии перенесены в PostgreSQL. Добавлены версионируемые Flyway-миграции, первичные и внешние +ключи, уникальность username, атомарное создание чата и keyset-пагинация истории. Реализованы +password KDF, Basic-вход только через `POST /auth/sessions`, opaque Bearer-сессии с expiry и logout, +Spring Security и Swagger UI. Redis используется как cache-aside-кэш пользователей с TTL и +fallback в PostgreSQL; включён AOF. Настроены ограниченные пулы соединений и таймауты. -- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. -- [ ] Контракт и публичные тесты не ослаблены. -- [ ] make check и make test выполнены; приложен реальный вывод. -- [ ] Сценарии отказов/безопасности своего уровня воспроизведены. -- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. -- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. +Команды запуска из чистого clone: + +```sh +cp .env.example .env +# Задать DATABASE_PASSWORD в локальном .env +docker compose --env-file .env config --quiet +docker compose --env-file .env up -d --build --wait +python3 -m pip install -r requirements-dev.txt +make check +make validate +make test +make test-persistence ACTION_SCRIPT=scripts/restart.sh +make test-operational +make explain-history +``` + +Результаты проверок и ссылка на REPORT.md: `make check`, `make validate` и `make test` — PASS; +`make test-persistence ACTION_SCRIPT=scripts/restart.sh` подтвердил сохранение данных и действующей +сессии после рестарта; `make test-operational` проверил expiry, logout, неверный пароль, отказы Redis +и PostgreSQL, гонку регистрации и rollback создания чата; `make explain-history` подтвердил +`Index Scan` без полного сканирования таблицы на 10 000 сообщениях. Подробности: [REPORT.md](../REPORT.md), +план запроса: [evidence/message-history-explain.md](../evidence/message-history-explain.md). + +Ограничения / известные ошибки: запущен один экземпляр API, высокая доступность не заявлена. +Проверка каждой Bearer-сессии обращается в PostgreSQL для строгого expiry/logout; Redis кэширует +только данные пользователя. Защита от cache stampede и нагрузочное исследование на 100 000+ +сообщениях относятся к треку 5 и не реализованы. Известных ошибок обязательного уровня 4 нет. + +Источники и использование ИИ: использованы материалы и контракт лабораторной работы, документация +Spring Boot/Spring Security, PostgreSQL, Flyway и Redis. ИИ применялся для анализа архитектуры, +подготовки реализации и тестовых сценариев; результат проверен автоматическими тестами и ручным +просмотром изменений. Секреты, токены и приватные ключи ИИ не передавались и в Git не добавлялись. + +- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. +- [x] Контракт и публичные тесты не ослаблены. +- [x] make check и make test выполнены; приложен реальный вывод. +- [x] Сценарии отказов/безопасности своего уровня воспроизведены. +- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. +- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. diff --git a/src/main/java/com/example/mtusi_messenger/cache/UserCache.java b/src/main/java/com/example/mtusi_messenger/cache/UserCache.java index 894119da..04ad8036 100644 --- a/src/main/java/com/example/mtusi_messenger/cache/UserCache.java +++ b/src/main/java/com/example/mtusi_messenger/cache/UserCache.java @@ -42,7 +42,13 @@ public class UserCache { if (value == null) { return Optional.empty(); } - return Optional.of(mapper.readValue(value, User.class)); + User cachedUser = mapper.readValue(value, User.class); + if (cachedUser == null) { + log.warn("Ignoring null Redis user cache entry for {}", userId); + evict(userId); + return Optional.empty(); + } + return Optional.of(cachedUser); } catch (DataAccessException e) { log.warn("Redis user cache is unavailable; using PostgreSQL fallback"); return Optional.empty(); diff --git a/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java b/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java index 44ee12f9..6d6e5a91 100644 --- a/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java +++ b/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java @@ -3,7 +3,6 @@ package com.example.mtusi_messenger.dto; import com.example.mtusi_messenger.web.NotUnicodeBlank; import com.example.mtusi_messenger.web.UnicodeSize; import jakarta.validation.constraints.NotBlank; -import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Pattern; public record CreateUserRequest( @@ -15,7 +14,7 @@ public record CreateUserRequest( @UnicodeSize(min = 1, max = 100) String display_name, - @NotNull + @NotUnicodeBlank @UnicodeSize(min = 12, max = 128) String password ) {} diff --git a/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java b/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java index 321734d4..253e974d 100644 --- a/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java +++ b/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java @@ -59,6 +59,25 @@ class MtusiMessengerApplicationTests { .value("invalid_request")); } + @Test + void shouldReturn400WhenPasswordContainsOnlyWhitespace() throws Exception { + String requestBody = objectMapper.writeValueAsString( + Map.of( + "username", "blank_password_" + UUID.randomUUID().toString().substring(0, 8), + "display_name", "Blank password probe", + "password", " " + ) + ); + + mockMvc.perform(post(USERS_URL) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isBadRequest()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("invalid_request")); + } + @Test void shouldNotAllowNonMemberToReadChatMessages() throws Exception { String chatId = createChat(alice, bob); diff --git a/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java b/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java new file mode 100644 index 00000000..fdc05347 --- /dev/null +++ b/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java @@ -0,0 +1,31 @@ +package com.example.mtusi_messenger.cache; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.Test; +import org.springframework.data.redis.core.StringRedisTemplate; +import org.springframework.data.redis.core.ValueOperations; + +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +class UserCacheTest { + + @Test + void shouldEvictJsonNullAndReturnCacheMiss() { + UUID userId = UUID.randomUUID(); + String key = "messenger:user:" + userId; + StringRedisTemplate redis = mock(StringRedisTemplate.class); + @SuppressWarnings("unchecked") + ValueOperations values = mock(ValueOperations.class); + when(redis.opsForValue()).thenReturn(values); + when(values.get(key)).thenReturn("null"); + UserCache cache = new UserCache(redis, new ObjectMapper(), 300); + + assertTrue(cache.find(userId).isEmpty()); + verify(redis).delete(key); + } +} diff --git a/tests/operational.py b/tests/operational.py index 442ba1cd..82be0970 100644 --- a/tests/operational.py +++ b/tests/operational.py @@ -86,6 +86,13 @@ def main(): actor = client.user('operational') password = actor['registration']['password'] + client.call( + 'POST', '/api/v1/users', 400, + body={ + 'username': 'blank_password_' + uuid.uuid4().hex[:12], + 'display_name': 'Blank password probe', + 'password': ' ', + }) client.call( 'POST', '/api/v1/auth/sessions', 401, headers=basic(actor['registration']['username'], password + '-wrong')) @@ -94,6 +101,17 @@ def main(): cache_key = 'messenger:user:' + actor['id'] ttl = compose('exec', '-T', 'redis', 'redis-cli', 'TTL', cache_key, capture=True) check(ttl.isdigit() and 0 < int(ttl) <= 300, 'Redis cache key has no bounded TTL') + compose('exec', '-T', 'redis', 'redis-cli', 'SET', cache_key, 'null') + client.call('GET', '/api/v1/users/me', actor=actor, schema='User') + cached_user = compose( + 'exec', '-T', 'redis', 'redis-cli', '--raw', 'GET', cache_key, capture=True) + try: + cached_payload = json.loads(cached_user) + except json.JSONDecodeError as error: + raise Failure('JSON null cache entry was not replaced with valid JSON') from error + check( + isinstance(cached_payload, dict) and cached_payload.get('id') == actor['id'], + 'JSON null cache entry was not replaced from PostgreSQL') appendonly = compose( 'exec', '-T', 'redis', 'redis-cli', '--raw', 'CONFIG', 'GET', 'appendonly', capture=True) @@ -160,8 +178,8 @@ def main(): capture=True) check(count == '0', 'failed composite chat operation was not rolled back') - print('PASS: expiry, logout, wrong password, Redis fallback, DB failure, ' - 'username race, and chat rollback verified.') + print('PASS: blank password, JSON null cache recovery, expiry, logout, wrong password, ' + 'Redis fallback, DB failure, username race, and chat rollback verified.') finally: compose('up', '-d', '--wait', 'postgres', 'redis') if trigger_installed: