- carry the lab 2 solution over and plan lab 3 (PLAN.md, OpenSpec change instance-id-idempotency) - rename the compose project to mtusi-lab3 and the image to :lab3 - add X-Instance-Id to every response and instance_id to every log record ([app] instance_id, hostname by default) - require Idempotency-Key on POST messages: keys table in Postgres, key and message in one transaction, replay returns the same 201, another body gets 409, TTL from [idempotency] ttl_seconds - send the key from student-tests, k6 scenarios and the skill driver; add idempotency, X-Instance-Id, key race and fault tests Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
87 lines
4.2 KiB
Markdown
87 lines
4.2 KiB
Markdown
# messages Specification
|
||
|
||
## Purpose
|
||
|
||
Текстовые сообщения в чате: отправка от имени текущего пользователя и
|
||
чтение истории чата его участниками в порядке `(created_at, id)`.
|
||
|
||
## Requirements
|
||
|
||
### Requirement: Отправка сообщения
|
||
|
||
`POST /api/v1/chats/{chat_id}/messages` SHALL принимать тело
|
||
`{"text": ...}` с заголовком `Idempotency-Key` и при успехе отвечать
|
||
201 с объектом `Message`: `id`, `chat_id`, `sender_id`, `text`,
|
||
`created_at`, без других полей. `sender_id` SHALL быть текущим
|
||
пользователем, `text` SHALL совпадать с отправленным. Формат ключа,
|
||
повтор и конфликт описаны в capability `idempotency`.
|
||
|
||
#### Scenario: Участник отправляет сообщение
|
||
|
||
- **WHEN** Алиса отправляет `"Привет, мир 👋"` в свой чат с новым
|
||
`Idempotency-Key`
|
||
- **THEN** ответ 201, `sender_id` — Алиса, `chat_id` — этот чат, `text`
|
||
равен `"Привет, мир 👋"`
|
||
|
||
### Requirement: Валидация текста
|
||
|
||
`text` SHALL содержать от 1 до 4000 Unicode code points и MUST NOT
|
||
состоять только из пробельных символов. Поле `sender_id` в теле MUST NOT
|
||
приниматься. Нарушения SHALL давать 400 `invalid_request`.
|
||
|
||
#### Scenario: Пустой текст
|
||
|
||
- **WHEN** участник отправляет `{"text": ""}`
|
||
- **THEN** ответ 400
|
||
|
||
#### Scenario: Граница длины
|
||
|
||
- **WHEN** текст из 4000 code points, затем из 4001
|
||
- **THEN** первый запрос даёт 201, второй — 400
|
||
|
||
#### Scenario: Попытка подменить отправителя
|
||
|
||
- **WHEN** тело содержит `sender_id` другого пользователя
|
||
- **THEN** ответ 400, сообщение не создаётся
|
||
|
||
### Requirement: Писать и читать могут только участники
|
||
|
||
Отправка и чтение истории SHALL быть доступны только участникам чата.
|
||
Посторонний и запрос к несуществующему чату SHALL получать одинаковый
|
||
404 `not_found`; сообщение при этом MUST NOT создаваться.
|
||
|
||
#### Scenario: Посторонний пишет
|
||
|
||
- **WHEN** Ева отправляет сообщение в чат Алисы и Боба
|
||
- **THEN** ответ 404, в истории чата новых сообщений нет
|
||
|
||
#### Scenario: Посторонний читает
|
||
|
||
- **WHEN** Ева запрашивает историю чата Алисы и Боба
|
||
- **THEN** ответ 404
|
||
|
||
### Requirement: История чата
|
||
|
||
`GET /api/v1/chats/{chat_id}/messages` SHALL возвращать сообщения чата
|
||
в порядке `(created_at, id)` по возрастанию, с постраничным выводом по
|
||
capability `pagination`. Любой участник SHALL видеть все сообщения
|
||
чата, в том числе чужие.
|
||
|
||
#### Scenario: Два участника, две страницы
|
||
|
||
- **WHEN** Алиса и Боб отправили по сообщению, и Боб читает историю с
|
||
`limit=1`, а затем продолжает по курсору
|
||
- **THEN** первая страница содержит одно сообщение и непустой
|
||
`next_cursor`, вторая — второе сообщение и `next_cursor` null, а
|
||
порядок совпадает с `(created_at, id)`
|
||
|
||
### Requirement: Подтверждённое сообщение сразу видно
|
||
|
||
Сообщение, на которое сервис ответил 201, SHALL присутствовать в
|
||
любом следующем чтении истории этого чата.
|
||
|
||
#### Scenario: Чтение после записи
|
||
|
||
- **WHEN** участник получил 201 на отправку и сразу читает историю
|
||
- **THEN** сообщение есть в истории
|