72 lines
4.3 KiB
Markdown
72 lines
4.3 KiB
Markdown
# Spec Delta
|
||
|
||
## MODIFIED Requirements
|
||
|
||
### Requirement: Хранение в PostgreSQL
|
||
|
||
Пользователи, чаты, участники чатов, сообщения, сессии, а с лабы 4 —
|
||
метаданные вложений и связи сообщений с вложениями SHALL храниться в
|
||
PostgreSQL, он — источник истины. Сервис MUST NOT хранить эти данные
|
||
в памяти процесса, файлах или SQLite. Байты вложений SHALL храниться в
|
||
S3 (capability `attachments`, `object-storage`), а не в PostgreSQL и не
|
||
в файлах реплик. Подтверждённая запись (ответ 201 или 204) SHALL быть
|
||
зафиксирована до ответа и видна следующему запросу.
|
||
|
||
#### Scenario: Созданное видно сразу
|
||
|
||
- **WHEN** клиент зарегистрировался и следующим запросом входит с теми
|
||
же username и паролем
|
||
- **THEN** вход успешен, и `GET /api/v1/users/me` с выданным токеном
|
||
возвращает этого пользователя
|
||
|
||
### Requirement: Данные переживают рестарт
|
||
|
||
После перезапуска сервиса и PostgreSQL с сохранённым volume все ранее
|
||
подтверждённые пользователи, чаты, участники и сообщения SHALL быть
|
||
доступны в прежнем виде. С лабы 4 это относится и к вложениям: их
|
||
метаданные, `attachment_ids` сообщений и оригиналы переживают и
|
||
перезапуск S3 с его volume.
|
||
|
||
#### Scenario: Прежний пользователь после рестарта
|
||
|
||
- **WHEN** стенд перезапущен `scripts/restart.sh`, и клиент использует
|
||
токен, полученный до рестарта
|
||
- **THEN** ответ 200, а история чата этого пользователя содержит те же
|
||
сообщения в том же порядке
|
||
|
||
### Requirement: Целостность данных в БД
|
||
|
||
Ограничения SHALL проверяться самой БД, а не только сервисом:
|
||
- уникальность `username`;
|
||
- существование пользователей и чатов, на которые ссылаются участники
|
||
и сообщения;
|
||
- уникальность участника в чате;
|
||
- членство отправителя в чате сообщения.
|
||
|
||
С лабы 4 БД SHALL проверять и вложения:
|
||
- владелец вложения — участник его чата;
|
||
- связь сообщения с вложением ссылается на существующие сообщение и
|
||
вложение;
|
||
- вложение не повторяется в одном сообщении, у каждого места в порядке
|
||
одно вложение, мест не больше 10;
|
||
- вложение, на которое ссылается сообщение, удалить нельзя;
|
||
- допустимые значения размера, SHA-256, типа, статуса и длины
|
||
`filename`; ключ объекта уникален.
|
||
|
||
Порядок `member_ids`, заданный при создании чата, и порядок
|
||
`attachment_ids` сообщения SHALL сохраняться. Принадлежность вложения
|
||
чату сообщения проверяет сервис в той же транзакции: чат вложения и
|
||
чат сообщения не меняются после записи.
|
||
|
||
#### Scenario: Порядок участников
|
||
|
||
- **WHEN** чат создан с `member_ids` в порядке `[bob, alice]`
|
||
- **THEN** `GET` этого чата и список чатов возвращают `member_ids` в
|
||
том же порядке, в том числе после рестарта стенда
|
||
|
||
#### Scenario: Порядок вложений
|
||
|
||
- **WHEN** сообщение отправлено с `attachment_ids` `[C, A, B]`
|
||
- **THEN** ответ на отправку, история чата и повтор с тем же ключом
|
||
возвращают `[C, A, B]`
|