AURORA-1683 OpenSpec document-comments-ui и план

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Andrey Epifancev 2026-10-27 00:20:39 +04:00
parent 6433c23cf0
commit 07648ba3ac
6 changed files with 273 additions and 0 deletions

View File

@ -0,0 +1,115 @@
# Комментарии к документу в UI — план реализации
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
**Goal:** список комментариев документа на экране проверки [41] (боковая панель) и счётчик с поповером в панели «Первичные документы» [39-01].
**Architecture:** только фронт `web/`; API ядра готов (`GET`/`POST /documents/{id}/comments`, `comments_count`). Общий компонент `CommentsList` используют боковая панель экрана документа и поповер строки панели. Чистые функции (форматирование времени, строки панели) — с тестами vitest; компоненты проверяются в браузере.
**Tech Stack:** React 18, TS strict, antd 6, vitest, biome + ESLint + Prettier.
**Spec:** `openspec/changes/document-comments-ui/` (proposal, design D-1…D-5, дельты `document-review-ui`, `primary-files-ui`).
**Ветка:** `feat/180-document-comments` (worktree `/Users/andrey.epifancev/projects/awp-ca/.wt/doc-comments/arm-core`), issue RSHB/arm-core#180, Jira AURORA-1683.
## Global Constraints
- Тексты UI: «Комментарии (N)», «Комментарии к документу», «Комментариев нет», «Не удалось загрузить комментарии», «Добавить», «Комментарии к документу <имя файла>», «Комментарий отсутствует», «Закрыть».
- Время — по Москве, «dd.mm.yyyy hh:mm».
- Текст комментария — до 4000 символов; пустой после обрезки не отправляется.
- Правок и удаления комментариев нет; бэкенд и DBML не меняются.
- Стиль: табы, одинарные кавычки, ширина 140 (biome); комментарии в коде — по-русски.
## Review Focus
- Клик по кнопке комментариев и внутри поповера в строке панели не должен открывать документ (всплытие к `onRow.onClick`) — проверка в браузере, Task 3.
- Длинный текст без пробелов и многострочный текст не ломают ширину панели/поповера (`pre-wrap` + `overflow-wrap: anywhere`) — проверка в браузере, Task 4.
- Ответ на запрос списка от прошлого открытия, пришедший после закрытия или переоткрытия, не должен перетирать текущий (счётчик запросов, как в `FileWarningsPopover`) — Task 2/3.
- Ошибка добавления (403/422) оставляет текст в поле — Task 2, проверка в браузере.
- Ядро без `comments_count` в документе — счётчик 0 (тест в Task 1).
---
### Task 1: Данные — тип, запрос, время, счётчик строки
**Files:**
- Modify: `web/src/types/api.ts` (после `DocumentBrief`)
- Modify: `web/src/services/api/documents.ts`
- Modify: `web/src/utils/dates.ts`, Test: `web/src/utils/dates.test.ts`
- Modify: `web/src/widgets/FilesDrawer/documentRows.ts`, Test: `web/src/widgets/FilesDrawer/documentRows.test.ts`
**Interfaces:**
- Produces: `interface CommentOut { id: string; text: string; author: { id: string; full_name: string }; created_at: string }`;
`getComments(documentId: string): Promise<CommentOut[]>`; `postComment` типизируется `api.post<CommentOut>`;
`formatMoscowDateTime(iso: string | null | undefined): string | null`; `DocumentRow.commentsCount: number`.
- [ ] **Step 1: Падающие тесты**
```ts
describe('formatMoscowDateTime', () => {
it('момент из API (UTC) — дата и время по Москве', () => {
expect(formatMoscowDateTime('2026-10-07T23:11:42.981145Z')).toBe('08.10.2026 02:11');
expect(formatMoscowDateTime('2024-03-12T10:05:00Z')).toBe('12.03.2024 13:05');
});
it('пусто и мусор', () => {
expect(formatMoscowDateTime(null)).toBeNull();
expect(formatMoscowDateTime('не дата')).toBeNull();
});
});
```
В `documentRows.test.ts`: `buildDocumentRows([file({ documents: [doc({ comments_count: 2 })] })])[0].commentsCount === 2`;
строка файла без документов — `commentsCount === 0`; документ без поля (`{ ...doc(), comments_count: undefined } as unknown as DocumentBrief`) — 0.
- [ ] **Step 2:** `cd web && npx vitest run src/utils/dates.test.ts src/widgets/FilesDrawer/documentRows.test.ts` — FAIL (нет функции/поля).
- [ ] **Step 3: Реализация.** `formatMoscowDateTime` — `Intl.DateTimeFormat('ru-RU', { timeZone: 'Europe/Moscow', day, month, year, hour: '2-digit', minute: '2-digit', hourCycle: 'h23' })`, разделитель «, » из `Intl` заменить пробелом. `commentsCount: d.comments_count ?? 0`, у строки файла — 0. `getComments` — `api.get<CommentOut[]>(\`/documents/${id}/comments\`)`.
- [ ] **Step 4:** тот же vitest — PASS; `npx tsc --noEmit` — без ошибок.
- [ ] **Step 5: Commit** «AURORA-1683 комментарии: тип, запрос, время по Москве, счётчик строки панели».
### Task 2: Экран документа — кнопка «Комментарии (N)» и боковая панель
**Files:**
- Create: `web/src/widgets/DocumentComments/CommentsList.tsx`
- Create: `web/src/widgets/DocumentComments/useDocumentComments.ts`
- Create: `web/src/widgets/DocumentComments/DocumentCommentsDrawer.tsx`
- Modify: `web/src/layouts/DocumentPage.tsx:1-136`
- Delete: `web/src/widgets/DocumentReview/CommentModal.tsx`
**Interfaces:**
- Consumes: `CommentOut`, `getComments`, `postComment`, `formatMoscowDateTime` (Task 1).
- Produces: `type CommentsState = { status: 'loading' } | { status: 'error' } | { status: 'done'; comments: CommentOut[] }`;
`CommentsList({ state, emptyText }: { state: CommentsState | null; emptyText: string })`;
`useDocumentComments(documentId: string | null): { state: CommentsState | null; load: () => void; reset: () => void }` — `load` запрашивает список, ответы устаревших запросов игнорируются (счётчик в `useRef`), `reset` сбрасывает в `null` и отменяет ожидаемый ответ;
`DocumentCommentsDrawer({ documentId, open, onClose, onAdded }: { documentId: string; open: boolean; onClose: () => void; onAdded: () => void })`.
- [ ] **Step 1:** `CommentsList`: `null`/loading — `Spin`; error — «Не удалось загрузить комментарии» (цвет `#cf1322`); пусто — `emptyText` (цвет `#8c8c8c`); иначе на комментарий блок: ФИО жирным + время `formatMoscowDateTime` (secondary, 12px) в строке, текст ниже с `whiteSpace: 'pre-wrap', overflowWrap: 'anywhere'`; ключ — `id`.
- [ ] **Step 2:** `DocumentCommentsDrawer`: antd `Drawer` справа, `title='Комментарии к документу'`, ширина 420; при `open` — `load()`, при закрытии — `reset()`. Тело — `CommentsList` (`emptyText='Комментариев нет'`) с прокруткой, футер — `Input.TextArea` (`maxLength={4000}`, `showCount`, `autoSize={{ minRows: 3, maxRows: 8 }}`) и кнопка «Добавить» (`disabled` при пустом `trim()`, `loading` во время запроса). Успех: очистить поле, `message.success('Комментарий добавлен')`, `load()`, `onAdded()`. Ошибка: `message.error(e instanceof ApiError ? e.message : 'Не удалось добавить комментарий')`, текст остаётся.
- [ ] **Step 3:** `DocumentPage`: кнопка `<Button icon={<CommentOutlined />}>Комментарии ({doc.comments_count})</Button>` на месте «Добавить комментарий»; `DocumentCommentsDrawer` вместо `CommentModal`, `onAdded={load}` (перечитывает документ — счётчик). Удалить `CommentModal.tsx` и его импорт.
- [ ] **Step 4:** `cd web && npx tsc --noEmit && npm run lint && npx biome check src` — чисто; `npm test` — зелёный.
- [ ] **Step 5: Commit** «AURORA-1683 экран документа: список комментариев в боковой панели».
### Task 3: Панель «Первичные документы» — счётчик и поповер
**Files:**
- Create: `web/src/widgets/DocumentComments/CommentsPopover.tsx`
- Modify: `web/src/widgets/FilesDrawer/FilesList.tsx:136-150` (колонка `actions`)
**Interfaces:**
- Consumes: `useDocumentComments`, `CommentsList` (Task 2), `DocumentRow.commentsCount` (Task 1).
- Produces: `CommentsPopover({ documentId, fileName, count }: { documentId: string; fileName: string; count: number })`.
- [ ] **Step 1:** `CommentsPopover`: управляемый antd `Popover` (`trigger='click'`, `open`/`onOpenChange`), `title={\`Комментарии к документу ${fileName}\`}`; при открытии `load()`, при закрытии `reset()`. Содержимое — обёртка с `onClick`/`onKeyDown` `stopPropagation` (как в `FileWarningsPopover`), `maxWidth: 420, maxHeight: 320, overflowY: 'auto'`, `CommentsList` (`emptyText='Комментарий отсутствует'`), справа внизу `Button size='small'` «Закрыть». Триггер — `Button` с `CommentOutlined` и `{count > 0 ? count : null}`, `aria-label={\`Комментарии: ${count}\`}`, `onClick` с `stopPropagation`.
- [ ] **Step 2:** `FilesList`, колонка `actions`: `<div style={{ display: 'flex', gap: 8 }}>` — `CommentsPopover` (только при `r.documentId`), затем существующая кнопка «Удалить».
- [ ] **Step 3:** `npx tsc --noEmit && npm run lint && npx biome check src && npm test` — чисто.
- [ ] **Step 4: Commit** «AURORA-1683 панель документов: счётчик и поповер комментариев».
### Task 4: Проверка в браузере, сверка с макетом, OpenSpec
**Files:**
- Create: `openspec/changes/document-comments-ui/tasks.md`
- [ ] **Step 1:** Стенд по `docs/dev/qa-guide.md` (api + web из worktree). Окно 1600×1000. Сценарии спеки: добавить комментарий на экране документа → «Комментарии (1)», после F5 он виден; ошибка (например, остановить api) — текст в поле остаётся; многострочный и длинный текст без пробелов не ломает панель; в панели «Первичные документы» число у иконки, поповер со списком, клик по иконке и внутри поповера не открывает документ; документ без комментариев — «Комментарий отсутствует»; замена документа с причиной → причина в комментариях заменённого.
- [ ] **Step 2:** Скриншоты сравнить с `../docs/mockup/screens/39-01-edit-documents.png` и `41-document-check.png`; расхождения — списком в отчёт.
- [ ] **Step 3:** `tasks.md` change (группы по задачам плана, отмеченные выполненными); `openspec validate document-comments-ui --strict` — valid.
- [ ] **Step 4:** `make web-check` из корня репозитория — зелёный (вывод — в описание PR).
- [ ] **Step 5: Commit** «AURORA-1683 OpenSpec: tasks, проверки».

View File

@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-10-27

View File

@ -0,0 +1,64 @@
## Context
API комментариев к документу готов (spec `documents-api`, «Комментарии к документу»; design D-11 Среза 3b):
`GET /documents/{id}/comments` → `[{id, text, author: {id, full_name}, created_at}]` по возрастанию `created_at`
(`DOCUMENT_VIEW`), `POST …/comments {text}` 1–4000 символов после обрезки (`DOCUMENT_EDIT`) → 201 + комментарий;
`comments_count` — в `DocumentBrief` (карточка файла, панель) и `DocumentOut` (экран документа). Правки и удаления нет.
Во фронте сейчас: `CommentModal` (экран документа, только добавление) и `postComment` в `FilesDrawer` (причина замены
документа). Макет: [39-01] — иконка комментария в строке панели, поповер «Комментарий к документу <файл>»
(«Комментарий отсутствует», «Закрыть»); [41] — кнопка «Добавить комментарий» в шапке, места под список нет.
## Goals / Non-Goals
Goals: комментарий виден после добавления и после перезагрузки; счётчик в панели совпадает с числом комментариев;
причина замены видна в комментариях заменённого документа. Non-goals — в proposal.
## Decisions
### D-1. Экран документа: кнопка «Комментарии (N)» + боковая панель
Кнопка на месте «Добавить комментарий» (иконка `CommentOutlined`, текст «Комментарии (N)», `N = doc.comments_count`).
Клик открывает antd `Drawer` справа «Комментарии к документу»: список комментариев, под ним поле ввода (до 4000
символов, счётчик символов) и кнопка «Добавить» (неактивна при пустом тексте после обрезки). Список запрашивается при
каждом открытии панели. После успешного добавления: поле очищается, список перечитывается, экран документа перечитывает
`GET /documents/{id}` (счётчик на кнопке). Ошибка добавления — `message.error` с текстом сервера, текст в поле
сохраняется. Ошибка загрузки списка — текст «Не удалось загрузить комментарии» вместо списка.
Почему не список под формой: экран [41] занят сканом и формой по высоте окна, блок комментариев отнимал бы место у
формы; боковая панель не меняет раскладку [41]. Вариант предложен агентом и принят владельцем в чате 27.10.2026.
### D-2. Панель «Первичные документы»: кнопка счётчика + поповер только для чтения
В колонке действий строки документа (`documentId != null`) перед «Удалить» — кнопка с `CommentOutlined` и числом
`comments_count` (при нуле — только иконка; `aria-label` «Комментарии: N»). Клик — antd `Popover` (trigger click)
с заголовком «Комментарии к документу <имя файла>»: список комментариев (запрос при открытии) или «Комментарий
отсутствует»; кнопка «Закрыть». Клики внутри поповера и по кнопке не всплывают к `onClick` строки (иначе открывается
документ) — тот же приём, что в `FileWarningsPopover`. У строки файла без документов кнопки нет.
### D-3. Общий список `CommentsList`
Один компонент для D-1 и D-2: на каждый комментарий — ФИО автора (жирным), дата и время по Москве
(`formatMoscowDateTime`, «dd.mm.yyyy hh:mm»), текст с сохранением переносов строк (`white-space: pre-wrap`,
`overflow-wrap: anywhere`). Состояния: загрузка (`Spin`), ошибка, пусто (текст пустоты задаёт вызывающий: «Комментариев
нет» в D-1, «Комментарий отсутствует» в D-2 — как в макете), список.
### D-4. Счётчик в строке панели — поле `DocumentRow.commentsCount`
`buildDocumentRows` переносит `comments_count` документа (ядро без поля — 0); строка файла без документов — 0.
Панель после замены документа уже перечитывает список файлов (`reload`), поэтому счётчик заменённого документа
обновляется без доработок.
### D-5. `CommentModal` удаляется
Добавление переезжает в панель D-1; второе место добавления на экране не нужно.
## Risks / Trade-offs
- Тестов компонентов в `web/` нет: покрыты чистые функции (`formatMoscowDateTime`, `buildDocumentRows`), экраны
проверяются вручную по сценариям спеки и сверкой с [39-01], [41].
- Поповер в узкой панели: ширина ограничена 420 px, высота — 320 px с прокруткой (как `FileWarningsPopover`).
## Decisions made without discussion
| Дата | Решение | Обоснование | Цена ошибки |
|---|---|---|---|
| 27.10.2026 | R-1: в поповере панели — только чтение, добавление только на экране документа | макет [39-01] показывает поповер без поля ввода; одно место добавления проще | добавить поле в поповер — небольшая правка |
| 27.10.2026 | R-2: при нуле комментариев в панели — иконка без числа | макет [39-01] показывает только иконку; «0» шумит в каждой строке | косметика |
| 27.10.2026 | R-3: формат времени «dd.mm.yyyy hh:mm» по Москве | даты в панели уже по Москве (`formatMoscowDate`), бэкенд считает даты по Москве | косметика |
| 27.10.2026 | R-4: кнопку «Добавить» не прячем без права `DOCUMENT_EDIT`, отказ 403 — сообщением | так работал `CommentModal`; доступ решает сервер (`auth/permissions.ts` — только для меню) | пользователь без права видит кнопку и получает отказ |

View File

@ -0,0 +1,53 @@
## Why
AURORA-1683 (arm-core #180, эпик AURORA-1353): в AURORA-1445 на экране документа [41] сделано только окно «Добавить
комментарий» — список комментариев не запрашивается, добавленный комментарий нигде не виден. В панели «Первичные
документы» [39] нет ни иконки комментария, ни счётчика. Причина замены документа пишется комментарием к заменяемому
документу (`FilesDrawer`), и её тоже негде прочитать. API ядра готов с 07.10.2026 (spec `documents-api`, требование
«Комментарии к документу»): `GET`/`POST /documents/{id}/comments`, `comments_count` в карточке файла и документа.
## What Changes
Репозиторий — только arm-core (`web/`); эндпоинты, бэкенд и DBML без изменений. Срез 2c (документы), правки фронта
по замечаниям спринта 3.
- Экран документа [41]: кнопка «Добавить комментарий» заменяется кнопкой «Комментарии (N)» (`N = comments_count`
документа). Она открывает боковую панель «Комментарии к документу»: список (автор, дата и время по Москве, текст) по
возрастанию времени и поле ввода с кнопкой «Добавить». После добавления список и счётчик обновляются.
- Панель «Первичные документы» [39]: в строке документа — кнопка с иконкой комментария и числом комментариев (при
нуле — только иконка), как в макете [39-01]. По клику — поповер «Комментарии к документу <файл>» со списком только
для чтения; без комментариев — «Комментарий отсутствует», кнопка «Закрыть».
- Окно `CommentModal` удаляется — добавление переезжает в боковую панель экрана документа.
- Дельты: `document-review-ui` — ADDED «Комментарии к документу»; `primary-files-ui` — ADDED «Комментарии документа в
панели».
Таблицы DBML v5.23 (только чтение через API): `comment` (`object_type = 'document'`), `app_user` (ФИО автора).
## Non-goals
- Правка и удаление комментариев — их нет в API и не будет (spec `documents-api`).
- Добавление комментария из панели «Первичные документы» — в поповере только чтение.
- Проверка права `DOCUMENT_EDIT` на фронте: кнопку «Добавить» не прячем, отказ сервера (403) показывается сообщением,
как сейчас в `CommentModal`.
- Комментарии к строкам и ячейкам формы, к консолидации — отдельные сущности, не этот change.
- Изменения бэкенда и DBML.
## Capabilities
### New Capabilities
### Modified Capabilities
- `document-review-ui`: ADDED требование «Комментарии к документу».
- `primary-files-ui`: ADDED требование «Комментарии документа в панели».
## Impact
- `web/src/types/api.ts` — тип `CommentOut`.
- `web/src/services/api/documents.ts` — `getComments`.
- `web/src/utils/dates.ts` — `formatMoscowDateTime` (+ тест).
- `web/src/widgets/FilesDrawer/documentRows.ts` — `commentsCount` в строке (+ тест).
- `web/src/widgets/DocumentComments/` — общий список комментариев, боковая панель экрана документа, поповер панели.
- `web/src/layouts/DocumentPage.tsx`, `web/src/widgets/FilesDrawer/FilesList.tsx`; удаляется
`web/src/widgets/DocumentReview/CommentModal.tsx`.
- Тестов компонентов в `web/` нет (vitest — только чистые функции); экраны сверяются с макетом [39-01], [41] в браузере.

View File

@ -0,0 +1,23 @@
## ADDED Requirements
### Requirement: Комментарии к документу
Экран документа SHALL показывать в шапке кнопку «Комментарии (N)», где N — `comments_count` документа из
`GET /documents/{id}`. Кнопка SHALL открывать боковую панель «Комментарии к документу» со списком
`GET /documents/{id}/comments` (запрос при каждом открытии) по возрастанию времени: ФИО автора, дата и время по Москве
(«dd.mm.yyyy hh:mm»), текст с переносами строк; без комментариев — «Комментариев нет»; ошибка запроса — «Не удалось
загрузить комментарии». Под списком SHALL быть поле ввода (до 4000 символов) и кнопка «Добавить», неактивная при пустом
тексте после обрезки пробелов; добавление — `POST /documents/{id}/comments {text}`. После успешного добавления поле
SHALL очищаться, список — перечитываться, счётчик на кнопке — обновляться из `GET /documents/{id}`. При ошибке
добавления SHALL показываться сообщение сервера, текст в поле сохраняется. Правки и удаления комментариев нет.
#### Scenario: Добавленный комментарий виден после перезагрузки
- **WHEN** аналитик открыл «Комментарии (0)», добавил «нет подписи руководителя» и перезагрузил страницу
- **THEN** на кнопке «Комментарии (1)», в панели — комментарий с его ФИО, датой и временем
#### Scenario: Причина замены документа
- **WHEN** документ заменён из панели «Первичные документы» с причиной «новая редакция от клиента»
- **THEN** в комментариях заменённого документа есть «Замена документа: новая редакция от клиента»
#### Scenario: Ошибка добавления
- **WHEN** сервер отклоняет добавление (403 или 422)
- **THEN** показано сообщение сервера, введённый текст остаётся в поле, список не меняется

View File

@ -0,0 +1,16 @@
## ADDED Requirements
### Requirement: Комментарии документа в панели
В строке документа панели «Первичные документы» [39-01] SHALL быть кнопка с иконкой комментария и числом комментариев
документа (`documents[].comments_count`; при нуле — только иконка). Клик по кнопке SHALL открывать поповер «Комментарии
к документу <имя файла>» со списком `GET /documents/{id}/comments` (запрос при открытии; автор, дата и время по Москве,
текст) только для чтения; без комментариев — «Комментарий отсутствует»; кнопка «Закрыть» закрывает поповер. Клик по
кнопке и внутри поповера SHALL NOT открывать документ. У строки файла без документов кнопки нет.
#### Scenario: Счётчик совпадает с числом комментариев
- **WHEN** к документу добавлены два комментария и панель перечитана
- **THEN** в строке документа у иконки число 2, в поповере — оба комментария по возрастанию времени
#### Scenario: Документ без комментариев
- **WHEN** аналитик нажимает иконку комментария у документа без комментариев
- **THEN** в поповере «Комментарий отсутствует», экран документа не открывается