Skip to content

Memo Architecture

wcorn edited this page Jul 6, 2026 · 2 revisions

시스템 아키텍처: 메모 (Memo)

⚠️ [통합됨] 2026-07-06 — 메모는 노트와 단일 도메인으로 병합되었습니다 (#740, PR #741). note.material_id를 nullable로 완화해 자료 종속 노트(material_id 있음)와 독립 노트(NULL)를 한 테이블/도메인으로 통합했다. API /api/notes, 라우트 /notes, 사이드바 "노트". 아래 설계 문서는 분리 시절(Epic #718)의 기록이다.

범위: 독립 메모장의 BE/FE 구조. Study Planner 노트와 동일한 트리+Tiptap 에디터 패턴을 따르되, 자료 종속이 없는 별도 도메인으로 구성한다.

1. 전체 구조

[FE /memo]  ──HTTP(JWT)──▶  [orino-app-api]  ──JPA──▶  [MySQL: memo]
  트리 사이드바 + Tiptap 에디터        MemoController                (트리 self-FK)
  (노트 에디터 엔진 공유)             MemoService
  • 외부 연동 없음. orino RDB만 사용한다.
  • Planner/Google 모듈과 무관 — 인증(JWT)만 공유한다.

2. BE 패키지 구조

메모는 독립 모듈이므로 planner 하위가 아닌 최상위 memo 패키지에 둔다.

orino-app-api
└─ ds.project.orino.memo
   ├─ controller/  MemoController
   ├─ service/     MemoService
   └─ dto/         MemoCreateRequest, MemoDetailResponse,
                   MemoTreeNode, MemoTreeResponse,
                   MemoUpdateRequest, MemoUpdateResponse

orino-domain-rdb
└─ ds.project.orino.domain.memo
   ├─ entity/      Memo
   └─ repository/  MemoRepository

참고 구현: ds.project.orino.planner.note(Note)의 컨트롤러/서비스/DTO 구조를 그대로 미러링한다. 차이는 material_id가 없다는 점뿐이다.

3. 도메인 규칙

  • member_id로 소유자를 식별한다(단일 사용자지만 노트와 동일하게 비정규화 보유).
  • 트리의 진실은 parent_id 컬럼. sort_order로 형제 순서를 관리한다.
  • 삭제는 부모→자손 CASCADE (DB FK ON DELETE CASCADE + 서비스 방어).
  • 이동(부모 변경)은 순환 참조 금지: 대상 메모의 자손을 새 부모로 지정할 수 없다.

4. 자동 저장 계약

노트와 동일한 idempotent PATCH 계약을 따른다.

  • 본문 저장은 PATCH /api/memos/{id}에 content(Tiptap JSON)를 실어 보낸다.
  • FE는 입력 멈춤 후 2초 debounce로 호출한다.
  • 같은 본문을 여러 번 저장해도 결과가 같아야 한다(idempotent).
  • 빈 doc({"type":"doc","content":[]})이 자동 저장으로 덮어쓰는 사고를 막기 위해, FE는 로드 완료 전 저장을 보내지 않는다(결정 기록 참고, 노트 #410 교훈 승계).

5. FE 구조

fe/src/features/memo
├─ api/          memos.ts        (fetchMemoTree, fetchMemo, createMemo, updateMemo, deleteMemo)
├─ hooks/        useMemoTree, useMemoDetail, useMemoMutations, useAutoSaveMemo
├─ components/   MemoTreeSidebar, MemoPage
└─ (에디터)      features/note 의 Tiptap 에디터 컴포넌트 공유
  • 라우트: /memo (+ 선택된 메모는 상태 또는 /memo/:id).
  • 사이드바(주 메뉴)에 "메모" 항목 추가.
  • 에디터 공유: features/note의 NoteEditor(Tiptap)를 API 바인딩에 독립적인 형태로 승격해 메모에서도 재사용한다. 인라인 하위 페이지(childPage) 노드는 noteId에 결합돼 있으므로 v1 메모에서는 비활성화하고, 트리 사이드바로만 하위를 만든다(childPage 일반화는 M2/차기).

6. 관측성·성능

  • 트리 조회는 멤버 메모 전량을 한 번에 읽어 FE에서 트리로 조립(단일 사용자·소량 데이터 전제).
  • 인덱스: (member_id, parent_id, sort_order).
  • 응답 목표: 트리/단건 조회 200ms, 본문 저장 300ms 이내.

7. 테스트 전략

Test Strategy 준수.

  • BE: MockMvc + TestContainers로 트리 CRUD·CASCADE·순환 참조 거부·타인 메모 404 통합 테스트.
  • FE: RTL + MSW로 트리 렌더·생성/삭제·자동 저장 debounce·빈 상태 통합 테스트.

Clone this wiki locally