80 lines
5.3 KiB
Markdown
80 lines
5.3 KiB
Markdown
# Spec Delta
|
||
|
||
## MODIFIED Requirements
|
||
|
||
### Requirement: Хранение в PostgreSQL
|
||
|
||
Пользователи, чаты, участники чатов, сообщения, сессии, с лабы 4 —
|
||
метаданные вложений и связи сообщений с вложениями, а с лабы 5 — задания
|
||
обработки и метаданные вариантов SHALL храниться в PostgreSQL, он — источник
|
||
истины. Сервис MUST NOT хранить эти данные в памяти процесса, файлах или
|
||
SQLite. Сообщение брокера лишь сообщает о задании: состояние задания MUST NOT
|
||
определяться по брокеру. Байты вложений SHALL храниться в S3 (capability
|
||
`attachments`, `object-storage`), а не в PostgreSQL и не в файлах реплик.
|
||
Подтверждённая запись (ответ 201, 202 или 204) SHALL быть зафиксирована до
|
||
ответа и видна следующему запросу.
|
||
|
||
#### Scenario: Созданное видно сразу
|
||
|
||
- **WHEN** клиент зарегистрировался и следующим запросом входит с теми
|
||
же username и паролем
|
||
- **THEN** вход успешен, и `GET /api/v1/users/me` с выданным токеном
|
||
возвращает этого пользователя
|
||
|
||
#### Scenario: Принятое вложение видно сразу
|
||
|
||
- **WHEN** участник получил ответ 202 на загрузку и сразу запрашивает
|
||
метаданные через другую реплику
|
||
- **THEN** ответ 200 с тем же `id`, а `status` — `queued` или более поздний
|
||
|
||
### Requirement: Целостность данных в БД
|
||
|
||
Ограничения SHALL проверяться самой БД, а не только сервисом:
|
||
- уникальность `username`;
|
||
- существование пользователей и чатов, на которые ссылаются участники
|
||
и сообщения;
|
||
- уникальность участника в чате;
|
||
- членство отправителя в чате сообщения.
|
||
|
||
С лабы 4 БД SHALL проверять и вложения:
|
||
- владелец вложения — участник его чата;
|
||
- связь сообщения с вложением ссылается на существующие сообщение и
|
||
вложение;
|
||
- вложение не повторяется в одном сообщении, у каждого места в порядке
|
||
одно вложение, мест не больше 10;
|
||
- вложение, на которое ссылается сообщение, удалить нельзя;
|
||
- допустимые значения размера, SHA-256, типа, статуса и длины
|
||
`filename`; ключ объекта уникален.
|
||
|
||
С лабы 5 БД SHALL проверять и обработку:
|
||
- код ошибки есть только у вложения `failed`, и у `failed` он есть;
|
||
- на вложение и версию конвейера одно задание, оно ссылается на существующее
|
||
вложение; вложение с заданием удалить нельзя;
|
||
- допустимые значения состояния и числа попыток задания;
|
||
- вариант уникален по вложению, версии конвейера и имени; он ссылается на
|
||
существующее вложение; допустимые значения имени, типа, размера, ширины,
|
||
высоты и SHA-256; ключ объекта варианта уникален.
|
||
|
||
Порядок `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]`
|
||
|
||
#### Scenario: Ограничения обработки в схеме
|
||
|
||
- **WHEN** проверяющий пытается вставить второе задание той же версии конвейера,
|
||
второй вариант с тем же именем и `error_code` у вложения не `failed`
|
||
- **THEN** PostgreSQL отклоняет каждую вставку нарушением ограничения
|