chore: update client contracts and README
This commit is contained in:
parent
4fe5777781
commit
b9aa02c79a
5 changed files with 70 additions and 298 deletions
|
|
@ -1,113 +0,0 @@
|
|||
<!-- task=m-contract-codegen-baseline/04+02_client_parser_map plan=0 tag=API -->
|
||||
|
||||
# Code Review Reference - API
|
||||
|
||||
> **[IMPLEMENTING AGENT — READ FIRST] Filling in this file is the mandatory final step of implementation.**
|
||||
> The task is NOT complete until every implementation-owned section below is filled in.
|
||||
> Complete the `구현 체크리스트`; the final checklist item is mandatory before saving.
|
||||
> Fill implementation-owned sections, then stop with active files in place and report ready for review.
|
||||
> Finalization (`코드리뷰 결과`, log rename, `complete.log`, archive moves, `코드리뷰 전용 체크리스트`) is review-agent-only, even after compaction/resume.
|
||||
> Follow the ownership table at the bottom of this file for which sections you own.
|
||||
|
||||
## 개요
|
||||
|
||||
date=2026-05-28
|
||||
task=m-contract-codegen-baseline/04+02_client_parser_map, plan=0, tag=API
|
||||
|
||||
## 이 파일을 읽는 리뷰 에이전트에게
|
||||
|
||||
> **[REVIEW AGENT ONLY]** 아래 종결 절차는 코드리뷰 에이전트 전용이다. 구현 에이전트는 이 섹션을 실행하지 않는다.
|
||||
|
||||
각 항목의 구현을 실제 소스 파일과 대조하고, `검증 결과` 섹션의 출력이 코드와 일치하는지 확인하세요.
|
||||
리뷰 완료는 아래 순서까지 끝난 상태를 의미합니다.
|
||||
|
||||
1. 판정을 append한다.
|
||||
2. `CODE_REVIEW-cloud-G06.md` → `code_review_cloud_G06_N.log`, `PLAN-cloud-G06.md` → `plan_cloud_G06_M.log`로 아카이브한다.
|
||||
3. PASS이면 `complete.log` 작성 후 active task 디렉터리를 `agent-task/archive/YYYY/MM/m-contract-codegen-baseline/04+02_client_parser_map/`로 이동한다. WARN/FAIL이면 user-review gate를 확인한 뒤 다음 active plan/review 파일 또는 `USER_REVIEW.md`를 작성한다. `USER_REVIEW.md`가 사용자 결정으로 완료/PASS 해소되면 code-review가 `USER_REVIEW.md`를 해소 상태로 갱신하고 `complete.log` 작성 후 archive 이동한다.
|
||||
4. PASS이고 task group이 `m-<milestone-slug>`이면 완료 이벤트 메타데이터를 보고한다. roadmap 상태 체크와 `update-roadmap` 호출은 런타임 책임이다.
|
||||
5. 적용 가능한 `코드리뷰 전용 체크리스트` 항목을 최종 `.log` 위치에서 체크한 뒤 보고한다.
|
||||
|
||||
---
|
||||
|
||||
## 구현 항목별 완료 여부
|
||||
|
||||
| 항목 | 완료 여부 |
|
||||
|------|---------|
|
||||
| [API-1] Flutter parser map helper | [ ] |
|
||||
| [API-2] Client contract location documentation | [ ] |
|
||||
|
||||
## 구현 체크리스트
|
||||
|
||||
- [ ] [API-1] Flutter client contract parser map helper와 unit test를 추가한다.
|
||||
- [ ] [API-2] client README에 generated contract와 parser map 표준 위치를 문서화한다.
|
||||
- [ ] CODE_REVIEW-*-G??.md의 구현 에이전트 소유 섹션을 실제 구현 내용과 검증 출력으로 채운다. 이 항목이 완료되기 전에는 구현이 완료된 것이 아니다.
|
||||
|
||||
## 코드리뷰 전용 체크리스트
|
||||
|
||||
> **[REVIEW AGENT ONLY]** 이 체크리스트는 코드리뷰 에이전트만 사용한다.
|
||||
> 구현 에이전트는 이 섹션을 수정하거나 체크하지 않는다.
|
||||
|
||||
- [ ] `코드리뷰 결과`에 `PASS`, `WARN`, `FAIL` 중 하나의 판정을 append한다.
|
||||
- [ ] 판정과 `차원별 평가`, Required/Suggested/Nit 분류가 서로 일치한다.
|
||||
- [ ] active `CODE_REVIEW-*-G??.md`를 `code_review_cloud_G06_N.log`로 아카이브한다.
|
||||
- [ ] active `PLAN-*-G??.md`를 `plan_cloud_G06_M.log`로 아카이브한다.
|
||||
- [ ] PASS이면 `agent-ops/skills/common/code-review/templates/complete-log-template.md` 기준으로 `complete.log`를 작성하고 active `.md` 파일을 남기지 않는다.
|
||||
- [ ] PASS이면 active task 디렉터리 `agent-task/m-contract-codegen-baseline/04+02_client_parser_map/`를 `agent-task/archive/YYYY/MM/m-contract-codegen-baseline/04+02_client_parser_map/`로 이동하고 최종 archive 경로에서 이 체크리스트를 갱신한다.
|
||||
- [ ] PASS이고 task group이 `m-<milestone-slug>`이면 런타임이 읽을 완료 이벤트 메타데이터를 보고하고, roadmap 수정이나 `update-roadmap` 직접 호출을 하지 않는다.
|
||||
- [ ] PASS split 작업이면 이동 후 빈 active parent `agent-task/m-contract-codegen-baseline/`를 제거하거나, 남은 sibling/file이 있어 유지했다고 확인한다.
|
||||
- [ ] WARN/FAIL이고 user-review gate가 트리거되지 않았으면 다음 active `PLAN-cloud-G06.md`와 `CODE_REVIEW-cloud-G06.md`를 작성하고 `complete.log`를 작성하지 않는다.
|
||||
- [ ] USER_REVIEW이면 `agent-ops/skills/common/code-review/templates/user-review-template.md` 기준으로 `USER_REVIEW.md`를 작성하고 active `PLAN-*.md`, `CODE_REVIEW-*.md`, `complete.log`를 남기지 않는다.
|
||||
- [ ] USER_REVIEW가 사용자 결정으로 완료/PASS 해소되면 `USER_REVIEW.md`를 해소 상태로 갱신하고 `complete.log`를 작성한 뒤 task directory를 archive로 이동한다.
|
||||
|
||||
## 계획 대비 변경 사항
|
||||
|
||||
_구현 에이전트가 계획과 다르게 구현한 부분을 이유와 함께 기록한다._
|
||||
|
||||
## 주요 설계 결정
|
||||
|
||||
_구현 에이전트가 주요 설계 결정 사항을 기록한다._
|
||||
|
||||
## 리뷰어를 위한 체크포인트
|
||||
|
||||
- Client parser map이 generated message qualified names를 key로 쓰는지 확인한다.
|
||||
- Helper가 presentation/UI layer에 의존하지 않는지 확인한다.
|
||||
- Test가 generated Dart files를 실제 import/parse하는지 확인한다.
|
||||
|
||||
## 검증 결과
|
||||
|
||||
_구현 에이전트가 각 중간 검증 및 최종 검증 명령 실행 후 출력을 여기에 붙여 넣는다._
|
||||
|
||||
필수 규칙:
|
||||
- 검증 명령은 고정된 계약이다. 임의로 대체하지 않는다.
|
||||
- 대체가 필요하면 `계획 대비 변경 사항`에 이유와 대체 명령을 기록한다.
|
||||
- `검증 결과`에는 실제 stdout/stderr를 붙여 넣는다.
|
||||
|
||||
### API-1 중간 검증
|
||||
```bash
|
||||
$ cd apps/client && flutter test test/contracts/alt_contracts_test.dart
|
||||
(output)
|
||||
```
|
||||
|
||||
### API-2 중간 검증
|
||||
```bash
|
||||
$ rg --sort path -n "lib/src/generated/alt/v1|lib/src/contracts|contracts-gen" apps/client/README.md
|
||||
(output)
|
||||
```
|
||||
|
||||
### 최종 검증
|
||||
```bash
|
||||
$ cd apps/client && flutter test test/contracts/alt_contracts_test.dart
|
||||
(output)
|
||||
$ rg --sort path -n "lib/src/generated/alt/v1|lib/src/contracts|contracts-gen" apps/client/README.md
|
||||
(output)
|
||||
$ bin/test
|
||||
(output)
|
||||
$ bin/lint
|
||||
(output)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
> **[IMPLEMENTING AGENT — BEFORE SAVING] Have you filled in every implementation-owned section: completion table, implementation checklist, changes from plan, design decisions, and verification output?**
|
||||
> If anything is blank, go back and fill it in before saving this file.
|
||||
> Leave review-agent-only sections unchanged.
|
||||
|
|
@ -1,184 +0,0 @@
|
|||
<!-- task=m-contract-codegen-baseline/04+02_client_parser_map plan=0 tag=API -->
|
||||
|
||||
# Plan - Client Parser Map
|
||||
|
||||
## 이 파일을 읽는 구현 에이전트에게
|
||||
|
||||
`CODE_REVIEW-*-G??.md`의 구현 에이전트 소유 섹션을 실제 구현 내용과 검증 출력으로 반드시 채운다. 검증 명령을 실행하고 실제 stdout/stderr를 기록한 뒤 active 파일을 그대로 두고 리뷰 준비를 보고한다. 최종화는 code-review 스킬 전용이다.
|
||||
|
||||
## 배경
|
||||
|
||||
Flutter client는 generated ALT contracts를 소비해야 하지만 현재 parser map 표준 위치가 없다. `02+01_codegen_check`가 Dart generated output을 만든 뒤, `lib/src/contracts`에 작은 helper를 두면 후속 socket client adoption이 UI와 generated code를 직접 엮지 않아도 된다.
|
||||
|
||||
## 분석 결과
|
||||
|
||||
### 읽은 파일
|
||||
|
||||
- `agent-roadmap/current.md`
|
||||
- `agent-roadmap/phase/foundation-alignment/PHASE.md`
|
||||
- `agent-roadmap/phase/foundation-alignment/milestones/contract-codegen-baseline.md`
|
||||
- `agent-ops/rules/project/domain/client/rules.md`
|
||||
- `agent-ops/rules/project/domain/contracts/rules.md`
|
||||
- `apps/client/pubspec.yaml`
|
||||
- `apps/client/README.md`
|
||||
- `apps/client/lib/main.dart`
|
||||
- `apps/client/lib/src/app/app.dart`
|
||||
- `apps/client/lib/src/app/router.dart`
|
||||
- `apps/client/lib/src/features/dashboard/presentation/dashboard_screen.dart`
|
||||
- `apps/client/test/widget_test.dart`
|
||||
- `packages/contracts/proto/alt/v1/common.proto`
|
||||
- `packages/contracts/proto/alt/v1/market.proto`
|
||||
- `packages/contracts/proto/alt/v1/backtest.proto`
|
||||
- `../proto-socket/dart/lib/src/communicator.dart`
|
||||
- `bin/test`
|
||||
- `bin/lint`
|
||||
|
||||
### 테스트 커버리지 공백
|
||||
|
||||
- Client parser map helper: 기존 테스트 없음. 새 Dart unit test가 qualified message name keys와 fromBuffer parse success를 검증해야 한다.
|
||||
- Generated Dart import stability: 기존 widget test는 generated contracts를 import하지 않는다. 새 parser map test가 generated files를 컴파일 경로에 포함한다.
|
||||
|
||||
### 심볼 참조
|
||||
|
||||
- renamed/removed symbols: none.
|
||||
|
||||
### 분할 판단
|
||||
|
||||
분할 정책을 먼저 평가했다. 이 plan은 `04+02_client_parser_map`이며 `02+01_codegen_check`가 `complete.log`를 만든 뒤 시작한다. API parser map은 별도 `03+02_api_parser_map`으로 분리되어 있고, 두 subtask는 codegen 이후 병렬 가능하다.
|
||||
|
||||
### 범위 결정 근거
|
||||
|
||||
이 subtask는 `apps/client/lib/src/contracts`, generated Dart imports, client tests, client README만 다룬다. Socket connection lifecycle, WebSocket configuration, UI state, Go API 변경은 범위 밖이다.
|
||||
|
||||
### 빌드 등급
|
||||
|
||||
build=`cloud-G06`, review=`cloud-G06`. Generated Dart contracts와 proto-socket wire type conventions를 client boundary에 묶는 protocol/client 작업이다.
|
||||
|
||||
## 의존 관계 및 구현 순서
|
||||
|
||||
`04+02_client_parser_map`은 같은 task group의 `02+01_codegen_check`가 `complete.log`를 만든 뒤 시작한다. 이 의존성은 directory name의 `+02`가 source of truth다.
|
||||
|
||||
## 구현 체크리스트
|
||||
|
||||
- [ ] [API-1] Flutter client contract parser map helper와 unit test를 추가한다.
|
||||
- [ ] [API-2] client README에 generated contract와 parser map 표준 위치를 문서화한다.
|
||||
- [ ] CODE_REVIEW-*-G??.md의 구현 에이전트 소유 섹션을 실제 구현 내용과 검증 출력으로 채운다. 이 항목이 완료되기 전에는 구현이 완료된 것이 아니다.
|
||||
|
||||
### [API-1] Flutter parser map helper
|
||||
|
||||
#### 문제
|
||||
|
||||
`apps/client/README.md:5`는 ALT protobuf bindings를 `lib/src` 아래에 추가하라고만 안내한다. `../proto-socket/dart/lib/src/communicator.dart:45`는 `Map<String, GeneratedMessage Function(List<int>)>` parser map을 요구하고, `../proto-socket/dart/lib/src/communicator.dart:98`은 outgoing `typeName`에 `data.info_.qualifiedMessageName`을 쓴다. Client에는 generated ALT messages의 qualified names를 모으는 helper가 없다.
|
||||
|
||||
Before:
|
||||
|
||||
```markdown
|
||||
<!-- apps/client/README.md:5 -->
|
||||
This app uses Riverpod for state and dependency boundaries, and `go_router` for navigation. ALT protobuf bindings and the proto-socket client layer should be added under `lib/src` after `packages/contracts` generation is introduced.
|
||||
```
|
||||
|
||||
```dart
|
||||
// ../proto-socket/dart/lib/src/communicator.dart:45
|
||||
void initialize(
|
||||
Map<String, GeneratedMessage Function(List<int>)> instanceGenerator,
|
||||
{required Transport transport}) {
|
||||
_instanceGenerator = instanceGenerator;
|
||||
_transport = transport;
|
||||
}
|
||||
```
|
||||
|
||||
해결 후 형태:
|
||||
|
||||
```dart
|
||||
import 'package:protobuf/protobuf.dart';
|
||||
|
||||
Map<String, GeneratedMessage Function(List<int>)> altParserMap() {
|
||||
return {
|
||||
HelloRequest.getDefault().info_.qualifiedMessageName: HelloRequest.fromBuffer,
|
||||
HelloResponse.getDefault().info_.qualifiedMessageName: HelloResponse.fromBuffer,
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
#### 해결 방법
|
||||
|
||||
`apps/client/lib/src/contracts/alt_contracts.dart`를 만들고 generated `common.pb.dart`, `market.pb.dart`, `backtest.pb.dart`의 request/response/result message를 등록한다. helper는 새 map을 반환하고, UI/presentation layer에는 import하지 않는다.
|
||||
|
||||
#### 수정 파일 및 체크리스트
|
||||
|
||||
- [ ] `apps/client/lib/src/contracts/alt_contracts.dart`: `altParserMap()` 추가.
|
||||
- [ ] `apps/client/test/contracts/alt_contracts_test.dart`: qualified key와 parse success 검증.
|
||||
|
||||
#### 테스트 작성
|
||||
|
||||
작성한다. `altParserMap contains generated ALT message parsers`는 `HelloRequest`, `HelloResponse`, `ListInstrumentsRequest`, `ListInstrumentsResponse`, `ListBarsRequest`, `ListBarsResponse`, `StartBacktestRequest`, `StartBacktestResponse`, `GetBacktestRunRequest`, `GetBacktestRunResponse`, `GetBacktestResultRequest`, `GetBacktestResultResponse`, `BacktestResult`를 map에서 찾아 `fromBuffer` round-trip으로 검증한다.
|
||||
|
||||
#### 중간 검증
|
||||
|
||||
```bash
|
||||
cd apps/client && flutter test test/contracts/alt_contracts_test.dart
|
||||
```
|
||||
|
||||
기대 결과: exit 0.
|
||||
|
||||
### [API-2] Client contract location documentation
|
||||
|
||||
#### 문제
|
||||
|
||||
`apps/client/README.md:5`의 문장은 codegen 도입 전 placeholder라서 generated output path와 parser map helper 위치를 알려주지 않는다.
|
||||
|
||||
Before:
|
||||
|
||||
```markdown
|
||||
<!-- apps/client/README.md:5 -->
|
||||
ALT protobuf bindings and the proto-socket client layer should be added under `lib/src` after `packages/contracts` generation is introduced.
|
||||
```
|
||||
|
||||
해결 후 형태:
|
||||
|
||||
```markdown
|
||||
Generated ALT protobuf files live under `lib/src/generated/alt/v1`.
|
||||
Client parser map helpers live under `lib/src/contracts`.
|
||||
Do not edit generated files by hand; run `../../bin/contracts-gen`.
|
||||
```
|
||||
|
||||
#### 해결 방법
|
||||
|
||||
README에 generated output path, parser map helper path, regeneration command만 짧게 남긴다.
|
||||
|
||||
#### 수정 파일 및 체크리스트
|
||||
|
||||
- [ ] `apps/client/README.md`: generated contract and parser map section 추가.
|
||||
|
||||
#### 테스트 작성
|
||||
|
||||
문서 변경이므로 테스트 파일은 작성하지 않는다. deterministic search로 앵커 존재를 확인한다.
|
||||
|
||||
#### 중간 검증
|
||||
|
||||
```bash
|
||||
rg --sort path -n "lib/src/generated/alt/v1|lib/src/contracts|contracts-gen" apps/client/README.md
|
||||
```
|
||||
|
||||
기대 결과: 모든 앵커가 검색된다.
|
||||
|
||||
## 수정 파일 요약
|
||||
|
||||
| 파일 | 항목 |
|
||||
|------|------|
|
||||
| `apps/client/lib/src/contracts/alt_contracts.dart` | API-1 |
|
||||
| `apps/client/test/contracts/alt_contracts_test.dart` | API-1 |
|
||||
| `apps/client/README.md` | API-2 |
|
||||
|
||||
## 최종 검증
|
||||
|
||||
```bash
|
||||
cd apps/client && flutter test test/contracts/alt_contracts_test.dart
|
||||
rg --sort path -n "lib/src/generated/alt/v1|lib/src/contracts|contracts-gen" apps/client/README.md
|
||||
bin/test
|
||||
bin/lint
|
||||
```
|
||||
|
||||
기대 결과: 모든 명령 exit 0. Flutter test cache output은 해당 없음.
|
||||
|
||||
모든 코드 변경 완료 후 반드시 `CODE_REVIEW-*-G??.md`의 구현 에이전트 소유 섹션을 채운다. 이 파일 작성이 구현의 마지막 단계다.
|
||||
|
|
@ -2,7 +2,10 @@
|
|||
|
||||
Flutter client for ALT web, mobile, and desktop targets.
|
||||
|
||||
This app uses Riverpod for state and dependency boundaries, and `go_router` for navigation. ALT protobuf bindings and the proto-socket client layer should be added under `lib/src` after `packages/contracts` generation is introduced.
|
||||
This app uses Riverpod for state and dependency boundaries, and `go_router` for navigation.
|
||||
Generated ALT protobuf files live under `lib/src/generated/alt/v1`.
|
||||
Client parser map helpers live under `lib/src/contracts`.
|
||||
Do not edit generated files by hand; run `../../bin/contracts-gen`.
|
||||
|
||||
```bash
|
||||
flutter pub get
|
||||
|
|
|
|||
23
apps/client/lib/src/contracts/alt_contracts.dart
Normal file
23
apps/client/lib/src/contracts/alt_contracts.dart
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
import 'package:protobuf/protobuf.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/common.pb.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/market.pb.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/backtest.pb.dart';
|
||||
|
||||
/// Returns the map of ALT Protobuf message qualified names to their respective parser functions.
|
||||
Map<String, GeneratedMessage Function(List<int>)> altParserMap() {
|
||||
return {
|
||||
HelloRequest.getDefault().info_.qualifiedMessageName: HelloRequest.fromBuffer,
|
||||
HelloResponse.getDefault().info_.qualifiedMessageName: HelloResponse.fromBuffer,
|
||||
ListInstrumentsRequest.getDefault().info_.qualifiedMessageName: ListInstrumentsRequest.fromBuffer,
|
||||
ListInstrumentsResponse.getDefault().info_.qualifiedMessageName: ListInstrumentsResponse.fromBuffer,
|
||||
ListBarsRequest.getDefault().info_.qualifiedMessageName: ListBarsRequest.fromBuffer,
|
||||
ListBarsResponse.getDefault().info_.qualifiedMessageName: ListBarsResponse.fromBuffer,
|
||||
StartBacktestRequest.getDefault().info_.qualifiedMessageName: StartBacktestRequest.fromBuffer,
|
||||
StartBacktestResponse.getDefault().info_.qualifiedMessageName: StartBacktestResponse.fromBuffer,
|
||||
GetBacktestRunRequest.getDefault().info_.qualifiedMessageName: GetBacktestRunRequest.fromBuffer,
|
||||
GetBacktestRunResponse.getDefault().info_.qualifiedMessageName: GetBacktestRunResponse.fromBuffer,
|
||||
GetBacktestResultRequest.getDefault().info_.qualifiedMessageName: GetBacktestResultRequest.fromBuffer,
|
||||
GetBacktestResultResponse.getDefault().info_.qualifiedMessageName: GetBacktestResultResponse.fromBuffer,
|
||||
BacktestResult.getDefault().info_.qualifiedMessageName: BacktestResult.fromBuffer,
|
||||
};
|
||||
}
|
||||
43
apps/client/test/contracts/alt_contracts_test.dart
Normal file
43
apps/client/test/contracts/alt_contracts_test.dart
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
import 'package:flutter_test/flutter_test.dart';
|
||||
import 'package:alt_client/src/contracts/alt_contracts.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/common.pb.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/market.pb.dart';
|
||||
import 'package:alt_client/src/generated/alt/v1/backtest.pb.dart';
|
||||
|
||||
void main() {
|
||||
group('ALT contracts parser map helper tests', () {
|
||||
test('altParserMap contains all expected parsers and passes round-trip parsing', () {
|
||||
final parsers = altParserMap();
|
||||
|
||||
final expectedMessages = [
|
||||
HelloRequest(),
|
||||
HelloResponse(),
|
||||
ListInstrumentsRequest(),
|
||||
ListInstrumentsResponse(),
|
||||
ListBarsRequest(),
|
||||
ListBarsResponse(),
|
||||
StartBacktestRequest(),
|
||||
StartBacktestResponse(),
|
||||
GetBacktestRunRequest(),
|
||||
GetBacktestRunResponse(),
|
||||
GetBacktestResultRequest(),
|
||||
GetBacktestResultResponse(),
|
||||
BacktestResult(),
|
||||
];
|
||||
|
||||
expect(parsers.length, equals(13));
|
||||
|
||||
for (final msg in expectedMessages) {
|
||||
final qualifiedName = msg.info_.qualifiedMessageName;
|
||||
expect(parsers.containsKey(qualifiedName), isTrue, reason: 'Map should contain parser for $qualifiedName');
|
||||
|
||||
final parser = parsers[qualifiedName]!;
|
||||
final serialized = msg.writeToBuffer();
|
||||
final parsed = parser(serialized);
|
||||
|
||||
expect(parsed.info_.qualifiedMessageName, equals(qualifiedName));
|
||||
expect(parsed.writeToBuffer(), equals(serialized));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
Loading…
Reference in a new issue