refactor: 문서 사람처럼 작성하기
This commit is contained in:
+6
-6
@@ -17,7 +17,7 @@ source:
|
||||
|
||||
Studio 편집기에서는 값이 다 보이는데 공개 화면만 비어 있다면, 작성과 공개 사이의 계약 경계를 먼저 확인할 만한 강한 신호다. 이 저장소에서는 같은 신호가 여덟 번 계약 누락을 가리켰지만, 저장 구조가 종류별로 다른 경우에는 조회 로직이 원인일 수 있다.
|
||||
|
||||
## 관계
|
||||
## Studio에는 보이는데 공개 화면에만 없으면 경계 중 하나가 값을 버린 것이다
|
||||
|
||||
- **공개 Reference 가 통째로 비어 있었다 — 이름이 어긋났고 본문은 다른 테이블에 있었다**
|
||||
이 신호가 처음 잡힌 사건이다.
|
||||
@@ -26,13 +26,13 @@ Studio 편집기에서는 값이 다 보이는데 공개 화면만 비어 있다
|
||||
- **한 경계를 고쳤으면 값의 여정 끝에서 확인한다**
|
||||
칸을 더한 뒤 무엇을 확인할지가 그 기준에 있다.
|
||||
|
||||
## 목적
|
||||
## UI 문제처럼 보여도 먼저 contract와 mapper를 확인한다
|
||||
|
||||
데이터베이스에 값이 있는데 화면이 비어 있을 때 어디를 먼저 볼지 정한다.
|
||||
|
||||
이 부류는 오류를 내지 않으므로 로그에서 출발하면 아무것도 나오지 않는다. undefined 는 빈 문자열로 그려지고 빈 배열은 「항목이 없습니다」로 그려진다.
|
||||
|
||||
## 규칙
|
||||
## DB에서 public response까지 field 이름을 순서대로 대조한다
|
||||
|
||||
### 1. Studio 에서는 보이고 공개 쪽만 비면 그 사이의 계약을 먼저 본다
|
||||
|
||||
@@ -54,13 +54,13 @@ Reference 의 본문은 문서 본문 칸이 아니라 규칙과 예시를 담
|
||||
|
||||
게이트웨이가 읽는 이름이 계약의 타입에 있는지를 묻는다. 값을 비교하는 검사는 픽스처를 게이트웨이가 읽는 이름으로 만들면 그대로 통과한다 — 테스트 작성자와 게이트웨이 작성자가 이름에 대해 합의한 것을 확인할 뿐이다.
|
||||
|
||||
## 적용 조건
|
||||
## 작성 화면에는 값이 있지만 공개 화면에는 없을 때
|
||||
|
||||
- 같은 데이터를 두 표면이 각자의 계약으로 읽고, 한쪽만 비어 보이는 화면. 작성 계약과 조회 계약이 나뉜 구조에서 걸린다.
|
||||
|
||||
- 계약에 칸을 더하거나 화면에 칸을 더하는 변경에서도 건다. 화면이 먼저 늘면 그 칸이 응답에 있는지 확인할 곳이 없다.
|
||||
|
||||
## 예외
|
||||
## 공개 정책상 의도적으로 숨기는 field
|
||||
|
||||
- 두 표면이 같은 계약을 쓰면 이 신호는 성립하지 않는다. 그때는 매퍼나 질의를 먼저 본다.
|
||||
|
||||
@@ -68,7 +68,7 @@ Reference 의 본문은 문서 본문 칸이 아니라 규칙과 예시를 담
|
||||
|
||||
- 값이 있는데 겹쳐 보이는 경우는 이 신호가 아니다. 빈 칸을 다른 값으로 메우면 같은 글이 두 번 나온다.
|
||||
|
||||
## 예시
|
||||
## Reference 본문 field 이름 불일치
|
||||
|
||||
- 공개 Reference 가 통째로 비었을 때 게이트웨이가 읽던 네 이름이 전부 계약에 없었다.
|
||||
|
||||
|
||||
+6
-6
@@ -18,7 +18,7 @@ source:
|
||||
|
||||
값이 여러 경계를 갈아타는 구조에서 한 경계를 고치고 「고쳤다」고 판단해 세 번 틀렸다. 타입 검사도 단위 테스트도 「코드를 읽어 보니 맞다」도 전부 중간 지점이다. 배포본에서 그 값이 실제로 그려지는 곳까지 가서 확인한다.
|
||||
|
||||
## 관계
|
||||
## 중간 경계를 고쳐도 최종 화면까지 값이 도달하지 않을 수 있다
|
||||
|
||||
- **관계의 요약이 경계 세 곳을 지나며 사라졌다**
|
||||
한 경계를 고치고 판단해 두 번 틀린 사건이다. 여기서 요약은 공개 계약의 `ResolvedRelation.summary`다.
|
||||
@@ -27,13 +27,13 @@ source:
|
||||
- **TypeScript 가 검사를 놓아 주는 네 곳**
|
||||
타입 통과가 반영의 증거가 아닌 이유가 그 개념에 있다.
|
||||
|
||||
## 목적
|
||||
## 수정한 값이 실제 사용 지점까지 도착했는지 확인한다
|
||||
|
||||
「고쳤다」는 판단이 틀리는 것을 막는다.
|
||||
|
||||
값이 열한 경계를 지나는 구조에서 한 경계만 보고 판단하면, 다음 경계가 같은 값을 다시 버려도 알 수 없다. 이 저장소에서 그 판단이 세 번 틀렸다.
|
||||
|
||||
## 규칙
|
||||
## 가장 마지막 consumer에서 결과를 재검증한다
|
||||
|
||||
### 1. 고친 값이 실제로 그려지는 곳까지 가서 본다
|
||||
|
||||
@@ -55,19 +55,19 @@ source:
|
||||
|
||||
값이 아니라 이름을 지키는 검사를 두면 여정의 한 구간을 그 검사가 대신한다. 그 구간이 어디까지인지 적어 두지 않으면 다음 사람이 검사를 여정 전체로 읽는다.
|
||||
|
||||
## 적용 조건
|
||||
## mapper나 contract field를 수정한 뒤
|
||||
|
||||
- 값이 계약·매퍼·포트를 여러 번 갈아타는 구조에서 「고쳤다」를 판단할 때. 계약을 소유한 저장소가 따로 있고 생성기를 지나 들어오면 특히 걸린다.
|
||||
|
||||
- 앞선 커밋이 같은 값을 고치려다 못 고친 이력이 있으면 반드시 건다. 그 커밋이 무엇을 근거로 고쳤다고 판단했는지가 대개 중간 지점이다.
|
||||
|
||||
## 예외
|
||||
## 중간 변환 자체가 최종 산출물인 테스트
|
||||
|
||||
- 경계가 하나뿐이거나 고친 그 곳이 여정의 끝이면 중간 확인으로 충분하다.
|
||||
|
||||
- 배포본을 열 수 없는 변경 — 아직 배포되지 않은 경로 — 은 여정의 끝까지 갈 수 없다. 그때는 어디까지 확인했는지를 적는다.
|
||||
|
||||
## 예시
|
||||
## relation summary를 세 경계에서 수정한 뒤 공개 목록 확인
|
||||
|
||||
- 관계 요약을 세 번 고쳤다. 매번 화면을 보고 나서야 다음 경계가 버리는 것을 알았다.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user