Files
gitea-agent-testbed/docs/requirements/req-001_project-scaffold.md
T
code-agent 14302a26f9 code-agent: implement issue 6
Approval-Correlation: e5da4592756fb704256d8737d31662e5
Plan-SHA256: 0fbe8b996656fb908c513b31e30706f7521cf76eeac60778a1c28f46bfc19b46
Bundle-SHA256: 29ce1ef1917864f79938459725201e6e74d67e21b1f817ac53d7b294eca8f1a2
Base-SHA: cabd354d71
2000-01-01 00:00:00 +00:00

305 lines
17 KiB
Markdown

---
{
"schema": "proofline.requirement/v1",
"id": "REQ-001",
"title": "프로젝트 스캐폴드의 메시지 작성자 구분",
"revision": "0.1",
"status": "approved",
"depends_on": [],
"applies_to": ["chat-tui-message-rendering"],
"language": "ko"
}
---
# REQ-001 — 프로젝트 스캐폴드의 메시지 작성자 구분
## 1. 목적
대화형 Textual TUI에서 사용자가 입력한 메시지와 에이전트의 응답을 작성자 라벨과 구조적 스타일로 명확하게 구분한다. 각 메시지의 작성자 의미를 명시적인 데이터 역할로 관리하여 화면 표시, 실행 흐름 및 자동 테스트에서 일관되게 검증할 수 있게 한다.
## 2. 배경
현재 애플리케이션은 사용자 메시지와 에이전트 응답을 서로 다른 CSS 클래스를 가진 Label로 표시하지만 화면에 작성자 라벨이 없고 작성자 의미가 데이터 개념으로 표현되지 않는다. 따라서 메시지의 작성자를 화면에서 구분하기 어렵고, 테스트도 표시 순서와 내용만 검증할 뿐 작성자 역할과 구조적 구분을 검증하지 못한다.
이번 요구사항은 외부 API나 LLM 연동 없이 현재 Textual 기반 대화 흐름을 유지하면서 작성자 의미를 명시적으로 모델링하고, 색상에만 의존하지 않는 라벨·테두리·정렬 기반의 구분을 제공하기 위한 것이다.
## 3. 범위
### 포함
- 사용자 메시지와 에이전트 응답을 각각 별도의 Label 대화 항목으로 표시한다.
- 각 메시지에 사용자 또는 에이전트라는 명시적인 작성자 역할을 부여한다.
- 화면에 사용자와 에이전트 작성자 라벨을 표시한다.
- `user-message`와 `response-message` 식별자를 유지하고, 테두리 또는 정렬 차이 같은 구조적 스타일을 적용한다.
- 유효한 입력의 정규화, 응답 선택, 메시지 표시 순서 및 공백 입력 무시 동작을 유지한다.
- 작성자 역할, 라벨, 구조적 스타일 및 기존 동작을 자동 테스트로 검증한다.
- 관련 요구사항, 데이터 모델, 인터페이스 계약 및 실행 흐름 문서와의 추적성을 유지한다.
### 제외
- LLM 연동 또는 외부 API 호출
- 대화 저장, 사용자 인증 또는 사용자별 기록 관리
- 고정 응답 목록과 응답 생성 방식의 변경
- 대화 영역 전체 레이아웃의 재설계
- 색상만으로 작성자를 구분하는 방식
- 별도 영속성 백엔드나 데이터베이스 도입
## 4. 용어와 기준
- **사용자 메시지**: 입력창에 사용자가 제출한 공백 제거 후의 유효한 문자열이다.
- **에이전트 응답**: 유효한 사용자 입력마다 고정된 응답 목록에서 표준 난수 선택으로 생성되는 문자열이다.
- **메시지 역할**: 메시지를 작성한 주체를 나타내는 명시적인 값이며 `user` 또는 `agent` 중 하나다.
- **작성자 라벨**: 사용자 역할을 `사용자`, 에이전트 역할을 `에이전트`로 화면에 표시하는 문자열이다.
- **구조적 스타일**: 색상에만 의존하지 않고 CSS 클래스, 테두리 또는 정렬 차이로 작성자를 구분하는 표현이다.
- **정본 기준**: `ChatMessage.role`과 `ChatMessage.content`의 조합을 메시지 의미의 단일 기준으로 삼고, 라벨과 CSS 클래스는 이 역할에서 파생한다.
## 5. 요구사항
`REQ-001`은 대화 메시지의 작성자 의미를 명시적으로 관리하고 화면 및 검증 절차에서 일관되게 구분하기 위한 요구사항 묶음의 식별자다.
### REQ-001.01 — 명시적인 메시지 역할 관리
시스템은 유효한 사용자 입력과 그에 대응하는 에이전트 응답을 각각 명시적인 작성자 역할을 가진 메시지로 관리해야 한다. 사용자 메시지의 역할은 `user`, 에이전트 응답의 역할은 `agent`여야 하며, 역할과 본문은 하나의 대화 메시지 단위로 보존되어야 한다.
**영향 범위**
- 인터페이스: `ChatMessage`, `MessageRole`, 대화 영역의 Label 렌더링
- 영속성: 없음. 메시지는 애플리케이션 세션 메모리에만 유지한다.
- 후속 사용 주체: UI 렌더러와 자동 테스트
- 마이그레이션: 필요 없음. 기존 저장 데이터가 없다.
- 호환성: 유효한 입력의 정규화, 응답 선택, 입력·응답 배열 및 표시 순서를 유지한다.
- 배포 전제 조건: Python 3.11 이상과 현재 Textual 의존성을 유지한다.
### REQ-001.02 — 작성자 라벨과 구조적 표시
시스템은 각 메시지의 명시적인 역할을 작성자 라벨과 구조적 스타일로 변환하여 표시해야 한다. 사용자 메시지는 `사용자` 라벨과 `user-message` 식별자를 사용하고, 에이전트 응답은 `에이전트` 라벨과 `response-message` 식별자를 사용해야 한다. 구조적 스타일은 색상만으로 작성자를 구분하지 않아야 하며, 역할별 테두리 또는 정렬 차이를 포함해야 한다.
**영향 범위**
- 인터페이스: `#conversation` 내부 Label의 표시 문자열과 CSS 클래스
- 영속성: 없음. 화면 위젯과 세션 메모리만 변경한다.
- 후속 사용 주체: 사용자, UI 검수자 및 자동 회귀 테스트
- 마이그레이션: 필요 없음
- 호환성: 기존 `user-message` 및 `response-message` 식별자와 사용자·응답의 표시 순서를 유지한다.
- 배포 전제 조건: Textual의 Label, VerticalScroll 및 CSS 스타일 기능을 사용할 수 있어야 한다.
## 6. 제약과 불변조건
- Python 3.11 이상과 현재 Textual 기반 TUI 구조를 유지한다.
- 유효한 입력은 앞뒤 공백을 제거한 뒤 사용자 메시지로 한 번만 기록한다.
- 공백만 있거나 빈 입력은 응답을 선택하지 않고 메시지 목록과 화면을 변경하지 않는다.
- 유효한 입력 하나마다 사용자 메시지가 먼저, 그 뒤에 에이전트 응답이 표시되어야 한다.
- 에이전트 응답은 기존 `RESPONSE_MESSAGES`에서 `random.choice(RESPONSE_MESSAGES)`로 선택한다.
- 모든 메시지는 `MessageRole`을 통해 작성자 의미를 가져야 하며 CSS 클래스만으로 역할을 판정하지 않는다.
- 사용자와 에이전트는 화면의 텍스트 라벨로 구분되어야 한다.
- 역할 구분은 색상에만 의존하지 않고 역할별 CSS 식별자와 테두리 또는 정렬 차이를 포함해야 한다.
- 메시지 표시와 테스트에서 사용자 및 에이전트 역할의 순서와 의미가 일치해야 한다.
- 외부 API, 인증, 영속 저장소 및 민감정보 처리는 추가하지 않는다.
## 7. 인수 기준
인수 기준은 소속 요구사항을 포함한 `REQ-001.01-AC01` 형식으로 식별한다.
### REQ-001.01-AC01 — 메시지 역할이 순서대로 보존됨
**판정 기준**
- 유효한 사용자 입력이 제출되면 입력 문자열의 앞뒤 공백이 제거된 사용자 메시지가 `user` 역할로 기록된다.
- 같은 제출에서 선택된 응답이 `agent` 역할로 기록된다.
- 여러 입력을 제출할 때 메시지 목록은 각 입력에 대해 사용자 메시지 다음 에이전트 응답 순서를 유지한다.
- 메시지 역할과 본문이 함께 비교 가능해야 하며, 역할을 CSS 클래스에서 추론하지 않아야 한다.
**검증**
- Textual 테스트 앱에서 두 개의 유효한 입력을 제출한다.
- `submitted_inputs`, `selected_responses`, `messages`의 값과 순서를 비교한다.
- `messages`가 사용자와 에이전트 역할을 번갈아 포함하는지 확인한다.
- 응답 선택을 고정해 입력 정규화와 메시지 역할 보존을 결정적으로 검증한다.
**검증 분류**
- 수준: `integration`
- 백엔드: 없음
- 케이스: `positive`
**상태 불변조건**
- 성공 시 입력과 응답이 각각 올바른 역할의 메시지로 세션 목록에 추가되어야 한다.
- 성공하더라도 기존 입력·응답의 순서와 내용은 변경되면 안 된다.
- 실패 또는 공백 입력 시 응답 선택과 메시지 목록 추가가 발생하지 않아야 한다.
### REQ-001.01-AC02 — 공백 입력이 역할 없는 메시지를 만들지 않음
**판정 기준**
- 빈 문자열 또는 공백·탭·개행만 포함한 입력을 제출해도 사용자 메시지와 에이전트 응답이 추가되지 않아야 한다.
- 공백 입력에서는 응답 선택 함수가 호출되지 않아야 한다.
- 입력창은 기존 동작과 같이 제출 후 비워져야 한다.
**검증**
- 공백만 포함한 입력과 빈 입력을 각각 Textual 테스트 앱에 제출한다.
- 메시지 목록과 대화 영역 Label 개수가 0인지 확인한다.
- `random.choice`가 호출되지 않았는지 확인한다.
- 입력창 값이 비워지는지 확인한다.
**검증 분류**
- 수준: `integration`
- 백엔드: 없음
- 케이스: `boundary`
**상태 불변조건**
- 성공적인 무시 처리에서 메시지 목록, 제출 입력 기록 및 응답 기록은 변경되지 않아야 한다.
- 대화 영역에 작성자 라벨을 포함한 새 Label이 추가되면 안 된다.
- 실패 시 부분적인 사용자 메시지 또는 응답이 남아서는 안 된다.
### REQ-001.02-AC01 — 작성자 라벨과 구조적 스타일이 역할과 일치함
**판정 기준**
- 사용자 메시지는 `사용자: 본문` 형식으로 표시되어야 한다.
- 에이전트 응답은 `에이전트: 본문` 형식으로 표시되어야 한다.
- 사용자 Label에는 `chat-message user-message user-role` 클래스가 포함되어야 한다.
- 에이전트 Label에는 `chat-message response-message agent-role` 클래스가 포함되어야 한다.
- CSS에는 사용자와 에이전트의 구조적 차이를 나타내는 `border-left`, `border-right`, `align: left middle`, `align: right middle` 규칙이 있어야 한다.
**검증**
- 유효한 입력 하나를 제출하고 대화 영역의 Label 두 개를 조회한다.
- Label의 렌더링 문자열과 클래스가 각각 사용자 및 에이전트 역할과 일치하는지 확인한다.
- 애플리케이션 CSS에 양쪽 테두리와 역할별 정렬 규칙이 포함되는지 확인한다.
**검증 분류**
- 수준: `integration`
- 백엔드: 없음
- 케이스: `positive`
**상태 불변조건**
- 성공 시 각 메시지의 라벨과 구조적 클래스가 해당 역할과 일치해야 한다.
- 성공하더라도 메시지 본문, 표시 순서 및 기존 식별자는 변경되면 안 된다.
- 렌더링 실패 시 역할이 다른 라벨이나 일부만 표시된 메시지가 남아서는 안 된다.
### REQ-001.02-AC02 — 기존 응답 선택과 종료 동작을 보존함
**판정 기준**
- 유효한 입력 제출 시 기존 응답 목록을 인자로 하여 표준 `random.choice`가 한 번 호출되어야 한다.
- `Escape` 키 입력은 기존처럼 애플리케이션 종료를 요청해야 한다.
- 작성자 구분 기능을 추가해도 기존 입력·응답 회귀 테스트가 통과해야 한다.
**검증**
- `random.choice`를 모의 처리하여 `RESPONSE_MESSAGES`가 전달되는지 확인한다.
- Textual 테스트 앱에서 `Escape`를 입력하고 `exit()` 호출을 확인한다.
- 유효 입력 두 건의 정규화, 응답 내용, 표시 순서 및 입력창 초기화를 함께 확인한다.
**검증 분류**
- 수준: `integration`
- 백엔드: 없음
- 케이스: `unchanged-state`
**상태 불변조건**
- 유효 입력 성공 시 기존 응답 선택과 종료 바인딩이 계속 동작해야 한다.
- 작성자 라벨 추가로 응답 목록, 난수 선택 방식 또는 종료 정책이 변경되면 안 된다.
- 실패 시 부분적인 응답 선택 기록이나 대화 항목이 남아서는 안 된다.
## 8. 오류 및 충돌 계약
- 입력 오류: 빈 입력과 공백 입력은 오류를 표시하지 않고 무시하며, 응답 선택과 메시지 추가를 수행하지 않는다.
- 상태 충돌: 단일 Textual 이벤트 루프에서 제출 이벤트 순서를 처리하며, 동일 입력을 자동으로 중복 제출하지 않는다.
- 저장 실패: 영속 저장소가 없으므로 저장 실패와 롤백 대상이 없다. 렌더링 실패가 발생하더라도 별도의 부분 영속 기록을 만들지 않는다.
- 역할 오류: 사용자 또는 에이전트로 정의되지 않은 역할은 정상 메시지로 렌더링하지 않으며, 역할 값과 표시 라벨의 매핑은 한 곳의 명시적 기준을 따른다.
## 9. 데이터 및 인터페이스 계약
- `MessageRole`: 문자열 기반 열거형이며 `USER`의 값은 `user`, `AGENT`의 값은 `agent`다.
- `ChatMessage.role`: 필수 `MessageRole` 값으로 메시지 작성자를 나타낸다.
- `ChatMessage.content`: 필수 문자열로 공백 제거가 완료된 사용자 입력 또는 선택된 응답 본문을 담는다.
- `MessageRole.label`: `user`를 `사용자`, `agent`를 `에이전트`로 변환한다.
- `ChatApp.messages`: 제출 순서대로 `ChatMessage`를 보유하며 유효 입력마다 사용자 메시지와 에이전트 응답을 차례로 추가한다.
- 사용자 Label 표시값은 `사용자: 본문` 형식이고 에이전트 Label 표시값은 `에이전트: 본문` 형식이다.
- 사용자 Label은 `user-message`와 `user-role`을 포함하고 에이전트 Label은 `response-message`와 `agent-role`을 포함한다.
- `submitted_inputs`, `selected_responses` 및 기존 `RESPONSE_MESSAGES` 계약은 유지한다.
- 식별자는 세션 내 메모리 객체와 CSS 클래스에 한정되며 시간대·단위·정밀도 계약은 없다.
## 10. 하위 호환성
- Python 3.11 이상에서 실행되는 기존 패키지와 콘솔 진입점 `chat_tui.app:main`을 유지한다.
- `#conversation`, `#user-input`, `user-message`, `response-message` 식별자를 유지한다.
- Enter 제출, 앞뒤 공백 제거, 공백 입력 무시, 고정 응답 목록 선택, `Escape` 및 `Ctrl+Q` 종료 동작을 유지한다.
- 기존의 사용자·응답 Label 두 항목 표시 구조를 유지하되 표시 문자열에 작성자 라벨과 역할 클래스를 추가한다.
- 기존 영속 데이터가 없으므로 데이터 마이그레이션은 필요하지 않다.
- 작성자 라벨과 구조적 스타일은 추가되지만 대화 영역 전체 레이아웃을 재설계하지 않는다.
## 11. 검증 계획
- `tests/test_app.py`의 Textual 비동기 테스트로 정상 입력, 다중 메시지 순서, 역할 객체, 라벨 및 CSS 클래스를 검증한다.
- 공백 입력과 빈 입력 테스트로 응답 선택 미호출, 메시지 미추가 및 화면 미변경을 검증한다.
- `random.choice` 모의 테스트로 기존 응답 선택 계약을 검증한다.
- `Escape` 종료 테스트로 기존 종료 바인딩을 회귀 검증한다.
- 별도 영속성 백엔드와 마이그레이션이 없으므로 저장 후 재조회 검증은 해당 없음으로 판정한다.
- 요구사항, `docs/data-model.md`, `docs/interface-contract.md`, `docs/runtime-flow.md`의 역할·라벨·스타일·순서 설명이 구현 및 테스트와 일치하는지 문서 검토로 확인한다.
### 테스트 추적성 계약
- 요구사항 문서에는 검증 의도와 판정 조건만 기록한다.
- 실행 가능한 테스트 정의는 별도 테스트 카탈로그 산출물에서 관리한다.
- 각 테스트 케이스는 안정적인 식별자를 사용하고 `verifies`로 인수 기준을 참조한다.
- 하나의 테스트가 여러 인수 기준을 검증할 수 있으며, 각 연결을 빠짐없이 기록한다.
- 실행 결과는 요구사항 또는 테스트 정의에 덮어쓰지 않고 별도 증거 산출물에 기록한다.
- 증거는 요구사항 개정 번호, 검증한 커밋, 환경과 실행 시각에 결합한다.
- 테스트 정의의 존재, 자동화 여부, 특정 커밋에서의 실행 여부와 PASS 결과를 서로 다른 상태로 취급한다.
테스트 정의 예시:
```text
Test ID: TC-001-001
Verifies:
- REQ-001.01-AC01
- REQ-001.02-AC01
Test reference: tests/test_app.py::ChatAppTest::test_submitted_input_and_response_are_displayed_in_order
Automated: true
```
실행 증거 예시:
```text
Test ID: TC-001-001
Requirement revision: REQ-001@0.1
Commit: 검증 실행 시점의 커밋 SHA
Environment: Python 3.11 이상, Textual 테스트 앱, 영속 백엔드 없음
Result: PASS | FAIL | BLOCKED
Executed at: 실행 시각
```
## 12. 추적성
- 근거 이슈: Gitea 이슈 #6, 제목 `메세지 표시창에서 메세지 작성자 구분`
- 구현 PR: 없음
- 관련 설계 문서: `docs/data-model.md`, `docs/interface-contract.md`, `docs/runtime-flow.md`, `docs/project-structure.md`
- 관련 요구사항: 없음
## 13. 확정된 결정
- 사용자 메시지와 에이전트 응답은 작성자 라벨과 구조적 스타일로 구분한다.
- 작성자 구분은 색상에만 의존하지 않고 테두리 또는 정렬 차이를 포함한다.
- 작성자 의미는 CSS 클래스에만 두지 않고 명시적인 메시지 역할로 관리한다.
- 기존 사용자·응답 표시 순서, 입력 정규화, 고정 응답 선택 및 종료 동작은 유지한다.
- 외부 API, LLM, 인증 및 영속 저장은 이번 범위에 포함하지 않는다.
## 14. 미결 사항
없음
## 15. 승인 기록
- 상태: `approved`
- 승인 주체: `spec-agent`
- 승인 근거: 승인 댓글 923 및 디스커버리 승인 결과