Skip to content

Memo Open Items

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)의 기록이다.

메모 모듈의 설계 결정, 보류·차기 항목을 관리한다.

1. 결정 사항

D-1. 노트 겸용이 아닌 별도 memo 테이블·도메인으로 분리

  • 선택: note.material_id를 nullable로 완화해 겸용하지 않고, 독립 memo 테이블·API(/api/memos)·라우트(/memo)를 신설한다.
  • 근거:
    • 노트는 학습 자료(material)에 강결합된 개념(자료 상세의 [노트] 탭). material_id를 NULL 허용하면 "자료 없는 노트"라는 모호한 상태가 note 테이블에 섞여, 자료 노트 트리 조회·삭제 로직이 복잡해진다.
    • 진입점·용도·수명주기가 다르다(자료 필기 vs 범용 캡처). 도메인을 분리하는 편이 각 모듈의 응집도와 장기 유지보수에 유리하다.
    • 비용은 낮다: memo는 note에서 material_id만 제거한 형태라 엔티티·리포지토리·서비스·DTO를 미러링으로 빠르게 구성할 수 있다.
  • 트레이드오프: 트리+에디터 로직이 note/memo 둘로 존재. FE 에디터 엔진은 공유해 중복을 최소화한다(D-2).

D-1 변경 (2026-07-06, #740): 별도 도메인 분리 → 단일 노트로 병합

  • 결정 되돌림: 사용자 관점에서 노트와 메모가 사실상 같은 기능이라 이름이 둘인 것이 혼란을 줬다. 별도 memo 도메인을 폐기하고 노트로 통합한다.
  • 방법: note.material_id를 nullable로 완화(있음=자료 노트, NULL=독립 노트). 당초 우려한 "모호한 상태"는 서비스의 스코프 헬퍼로 자료/독립을 명확히 분기해 해소.
  • API /api/notes(materialId 쿼리로 스코프 구분), 라우트 /notes, memo 테이블·패키지 제거(기존 데이터는 트리 보존하며 note로 무손실 이관).
  • D-2도 함께 해소: 독립 노트가 note의 리치 에디터(childPage·이미지 업로드)를 그대로 사용한다.

D-2. Tiptap 에디터 엔진은 공유, childPage(인라인 하위 페이지)는 v1 제외

  • 선택: features/note의 Tiptap 에디터를 API 바인딩에 독립적인 형태로 승격해 메모에서도 재사용한다. 단, 인라인 하위 페이지(/페이지 childPage 노드)는 v1 메모에서 비활성화하고 트리 사이드바로만 하위를 만든다.
  • 근거: childPage 노드는 noteId를 참조하고 note API에 결합돼 있다. 메모에서 쓰려면 childPage의 데이터 소스를 주입식으로 일반화해야 하며, 이는 별도 리팩터링 범위다. v1은 트리 사이드바만으로 충분한 UX를 제공하고, childPage 일반화는 M2/차기로 미룬다.

D-3. 자동 저장·빈 doc 방지 계약 승계

  • 선택: 노트의 idempotent PATCH + 2초 debounce + "로드 완료 전 저장 금지" 규칙을 그대로 따른다.
  • 근거: 노트에서 빈 doc 자동 저장으로 본문이 유실된 이슈(#410)의 교훈. 메모도 같은 사고를 방지한다.

D-4. 외부 연동 없음

  • 메모는 orino 내부에만 존재한다. Google 등 외부 연동·알림·리마인더는 두지 않는다(메모에 due 개념 없음).

2. 구현 단계 (제안)

단계 범위
M0 (BE) memo 테이블(Liquibase 031) + 엔티티/리포지토리 + 트리 CRUD API + 통합 테스트
M1 (FE) /memo 페이지 — 트리 사이드바 + Tiptap 에디터(노트 엔진 공유) + 자동 저장 + 사이드바 진입
M2 (FE/BE) 트리 이동(부모 변경)·정렬 + (선택) childPage 일반화 + 엣지 테스트·로컬 검증·문서 마감

3. 보류·차기 (v1 범위 외)

  • 인라인 하위 페이지(childPage) — 노트 childPage 엔진 일반화 후
  • 메모 전문 검색, 태그, 즐겨찾기/아이콘/커버
  • 메모 → 학습 자료/노트/카드로 승격·상호 변환
  • 공유·협업, 이미지 외 첨부파일
  • 메모 리마인더/알림

4. 열린 질문

  • Q1. 선택 상태를 URL(/memo/:id)에 둘지 컴포넌트 상태로 둘지 — 딥링크·새로고침 유지가 필요하면 URL 권장(M1에서 확정).
  • Q2. 사이드바 메뉴에서 "메모" 위치 — 학습 자료 인접 vs 최상단. UX 확인 후 확정.
  • Q3. 이미지 업로드 스토리지 키 네임스페이스 — 노트와 분리(memo/…)할지 공용으로 둘지(M1/M2에서 결정).

Clone this wiki locally