git 저장소가 없어 히스토리·협업 기반이 아예 없던 상태를 연다.
함께 문서를 재편했다. 그동안 문서가 있어도 "이 제품이 뭘 푸는가"와
"어떻게 도는가"를 담은 문서가 없어서, 목표 문장이 backend/frontend
README 두 곳에 복붙돼 있었다 — 상위 문서가 없어 아래로 샌 것이다.
신설
README.md 레포 진입점 + 문서 지도 + 문서 규칙 4가지
AGENTS.md 에이전트·신규 합류자용 함정 목록과 규약
(CLAUDE.md 는 여기로 걸린 심볼릭 링크)
docs/PRODUCT.md 제품 정의 — 문제·사용자·원칙·**non-goals**·성공 기준
docs/ARCHITECTURE.md payload 경계·발행 파이프라인·서빙 결정·앱 분리 설계
이동
backend/docs/DECISIONS.md → docs/DECISIONS.md
백엔드만의 결정이 아니다. 게다가 코드 주석 ~25곳이 이미
`docs/DECISIONS.md` 로 적고 있어 레포 루트 기준으로는 그게 맞다.
갱신
docs/DEPLOY.md 서빙 결정 반영 — nginx 정적 서빙이 지금 경로(3절),
Azure 는 나중에 켤 때(4절)로 분리
docs/ARCHITECTURE.md 사이트 = 한 장(2026-08-31) 구조 반영
docs/COLLECTION_SEO_AEO_FLOW.md
robots.txt·sitemap.xml 은 오리진 루트에만 굽는다는 점 명시
frontend/site/scripts/prerender.ts
헤더 주석의 렌더 보고서 경로가 실제(422줄)와 달라 수정
.gitignore
★ CLAUDE.md 를 더 이상 무시하지 않는다. 에이전트 지침은 팀과 모든
에이전트가 공유하는 규약이라 커밋해야 한다 — 무시하면 클론한 사람이
"배포 후 republish_all.py 필수" 같은 함정을 전달받지 못한다.
개인용 오버라이드는 ~/.claude/CLAUDE.md 에 둔다.
176 lines
9.2 KiB
Python
176 lines
9.2 KiB
Python
"""FAQ 조회·승인 e2e.
|
|
|
|
이 도메인이 지켜야 하는 것:
|
|
- LLM 이 만든 FAQ 는 ★ 사람이 승인하기 전엔 사이트에 안 나간다(FAQPage JSON-LD 에도 안 실린다)
|
|
- 상태 전이는 fact 와 같은 표(FACT_STATUS_TRANSITIONS)만 따른다
|
|
- 고쳐서 승인한 FAQ(CORRECTED)는 잠긴다 — 재생성이 사장님 문구를 덮어쓰지 못한다
|
|
- 사장님이 직접 쓴 FAQ 는 바로 노출값이다(사람이 곧 출처)
|
|
"""
|
|
import uuid
|
|
|
|
from sqlalchemy import text
|
|
|
|
from common.enums import ErrorType, FactStatus, SourceType
|
|
|
|
|
|
async def _place(client, headers, name="FAQ펜션"):
|
|
r = await client.post("/v1/place", headers=headers, json={"name": name, "category": 1})
|
|
return r.json()["place"]["place_id"]
|
|
|
|
|
|
async def _seed_generated_faq(db_engine, pid, question="체크인은 몇 시인가요?", answer="15시입니다.", order=0):
|
|
"""COPY 잡이 남기고 간 상태를 그대로 만든다 — LLM 출처 · UNVERIFIED."""
|
|
fid = uuid.uuid4()
|
|
async with db_engine.begin() as conn:
|
|
await conn.execute(
|
|
text("INSERT INTO faqs (faq_id, place_id, question, answer, source_fact_ids, generated_by, status, sort_order) "
|
|
"VALUES (:f, :p, :q, :a, CAST(:k AS jsonb), :g, :st, :o)"),
|
|
{"f": fid, "p": uuid.UUID(pid), "q": question, "a": answer, "k": '["check_in_time"]',
|
|
"g": SourceType.LLM.value, "st": FactStatus.UNVERIFIED.value, "o": order},
|
|
)
|
|
return str(fid)
|
|
|
|
|
|
async def _list(client, headers, pid, **params):
|
|
return (await client.get(f"/v1/place/{pid}/faq/list", headers=headers, params=params)).json()
|
|
|
|
|
|
async def _transition(client, headers, pid, fid, body):
|
|
return (await client.post(f"/v1/place/{pid}/faq/{fid}/transition", headers=headers, json=body)).json()
|
|
|
|
|
|
# ── 조회 ─────────────────────────────────────────────────────────────────
|
|
async def test_generated_faq_is_pending_and_not_publishable(auth_headers, client, db_engine):
|
|
"""검증: LLM 이 만든 UNVERIFIED FAQ 를 조회한다.
|
|
기대결과: 목록엔 보이되 publishable=0 — ★ 승인 전에는 사이트에 나가지 않는다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
await _seed_generated_faq(db_engine, pid)
|
|
|
|
body = await _list(client, h, pid)
|
|
assert len(body["faqs"]) == 1
|
|
assert body["faqs"][0]["status"] == FactStatus.UNVERIFIED.value
|
|
assert body["publishable"] == 0
|
|
assert body["pending_review"] == 1
|
|
# 사이트 빌드가 보는 것과 같은 집합 — 승인 전에는 비어 있어야 한다.
|
|
assert (await _list(client, h, pid, publishable_only=True)).get("faqs", []) == []
|
|
|
|
|
|
async def test_other_company_cannot_read_or_touch_faq(auth_headers, client, db_engine, other_company_id):
|
|
"""검증: 남의 회사 사용자가 place_id 를 알아내 FAQ 를 조회·전이한다.
|
|
기대결과: PLACE_NOT_FOUND — 존재 여부조차 알려주지 않는다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
fid = await _seed_generated_faq(db_engine, pid)
|
|
|
|
other = await auth_headers("u2", other_company_id)
|
|
assert (await _list(client, other, pid))["result"]["code"] == ErrorType.PLACE_NOT_FOUND.value
|
|
body = await _transition(client, other, pid, fid, {"status": FactStatus.VERIFIED.value})
|
|
assert body["result"]["code"] == ErrorType.PLACE_NOT_FOUND.value
|
|
|
|
|
|
# ── 승인 ─────────────────────────────────────────────────────────────────
|
|
async def test_approving_faq_makes_it_publishable(auth_headers, client, db_engine):
|
|
"""검증: UNVERIFIED FAQ 를 VERIFIED 로 승인한다.
|
|
기대결과: 노출 가능해지고 사업장이 재빌드 대상으로 찍힌다(FAQPage 가 바뀌므로)."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
fid = await _seed_generated_faq(db_engine, pid)
|
|
|
|
body = await _transition(client, h, pid, fid, {"status": FactStatus.VERIFIED.value})
|
|
assert body["result"]["success"] is True
|
|
assert body["faq"]["status"] == FactStatus.VERIFIED.value
|
|
assert (await _list(client, h, pid))["publishable"] == 1
|
|
place = (await client.get(f"/v1/place/{pid}", headers=h)).json()["place"]
|
|
assert place["content_updated_at"] is not None
|
|
|
|
|
|
async def test_illegal_transition_is_rejected(auth_headers, client, db_engine):
|
|
"""검증: UNVERIFIED → CORRECTED 처럼 전이표에 없는 이동.
|
|
기대결과: FACT_INVALID_TRANSITION — 확인을 건너뛴 '정정본'은 만들 수 없다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
fid = await _seed_generated_faq(db_engine, pid)
|
|
|
|
body = await _transition(client, h, pid, fid, {"status": FactStatus.CORRECTED.value, "answer": "15:00 입니다."})
|
|
assert body["result"]["code"] == ErrorType.FACT_INVALID_TRANSITION.value
|
|
|
|
|
|
async def test_correction_requires_new_text(auth_headers, client, db_engine):
|
|
"""검증: 고친 문구 없이 CORRECTED 로 보낸다.
|
|
기대결과: INVALID_REQUEST_DATA — 고친 게 없으면 그건 정정이 아니라 승인(VERIFIED)이다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
fid = await _seed_generated_faq(db_engine, pid)
|
|
await _transition(client, h, pid, fid, {"status": FactStatus.VERIFIED.value})
|
|
|
|
body = await _transition(client, h, pid, fid, {"status": FactStatus.CORRECTED.value})
|
|
assert body["result"]["code"] == ErrorType.INVALID_REQUEST_DATA.value
|
|
|
|
|
|
async def test_corrected_faq_is_locked_against_regeneration(auth_headers, client, db_engine):
|
|
"""검증: 사장님이 문구를 고쳐 승인(CORRECTED)한 뒤 COPY 잡이 재생성을 돌린다.
|
|
기대결과: 고친 문구가 그대로 남는다 — ★ 자동 생성이 사람의 판단을 덮어쓰지 않는다."""
|
|
from common.database.db_session_manager import DB_SESSION_MNG
|
|
from common.database.model.models import faqs
|
|
from common.utils.gtime import GTime
|
|
from crud.faq_crud import FaqCRUD
|
|
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
fid = await _seed_generated_faq(db_engine, pid)
|
|
await _transition(client, h, pid, fid, {"status": FactStatus.VERIFIED.value})
|
|
|
|
body = await _transition(client, h, pid, fid, {"status": FactStatus.CORRECTED.value, "answer": "15시 이후 입실입니다."})
|
|
assert body["faq"]["status"] == FactStatus.CORRECTED.value
|
|
assert body["faq"]["answer"] == "15시 이후 입실입니다."
|
|
# 문장의 책임 주체가 사람으로 넘어왔다는 기록.
|
|
assert body["faq"]["generated_by"] == SourceType.OWNER.value
|
|
|
|
# 재생성이 미확인 FAQ 를 내리는 단계(COPY 잡이 실제로 부르는 그 함수).
|
|
await DB_SESSION_MNG.execute_lambda_claim(
|
|
faqs.DBType(),
|
|
lambda s: FaqCRUD().expire_generated(s, uuid.UUID(pid), GTime.UTC()),
|
|
)
|
|
after = await _list(client, h, pid, publishable_only=True)
|
|
assert [f["answer"] for f in after["faqs"]] == ["15시 이후 입실입니다."]
|
|
|
|
|
|
# ── 직접 추가 ────────────────────────────────────────────────────────────
|
|
async def test_owner_written_faq_is_published_immediately(auth_headers, client):
|
|
"""검증: 사장님이 FAQ 를 직접 쓴다.
|
|
기대결과: 바로 노출값(VERIFIED) + 출처는 서버가 OWNER 로 고정 — 사람이 곧 출처다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
|
|
body = (await client.post(f"/v1/place/{pid}/faq", headers=h,
|
|
json={"question": "주차 되나요?", "answer": "무료 주차 가능합니다."})).json()
|
|
assert body["faq"]["status"] == FactStatus.VERIFIED.value
|
|
assert body["faq"]["generated_by"] == SourceType.OWNER.value
|
|
assert body["faq"]["sort_order"] == 0
|
|
assert (await _list(client, h, pid))["publishable"] == 1
|
|
|
|
|
|
async def test_owner_faq_appends_after_existing_ones(auth_headers, client, db_engine):
|
|
"""검증: 이미 FAQ 가 있는 사업장에 순서 없이 추가한다.
|
|
기대결과: 맨 뒤에 붙는다 — 기존 FAQ 순서를 흔들지 않는다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
await _seed_generated_faq(db_engine, pid, order=0)
|
|
await _seed_generated_faq(db_engine, pid, question="와이파이 되나요?", answer="됩니다.", order=1)
|
|
|
|
body = (await client.post(f"/v1/place/{pid}/faq", headers=h,
|
|
json={"question": "주차 되나요?", "answer": "무료 주차 가능합니다."})).json()
|
|
assert body["faq"]["sort_order"] == 2
|
|
|
|
|
|
async def test_blank_faq_is_rejected(auth_headers, client):
|
|
"""검증: 공백만 있는 질문으로 FAQ 를 추가한다.
|
|
기대결과: INVALID_REQUEST_DATA — 빈 문답은 렌더도 안 되고 고유 콘텐츠로도 안 세진다."""
|
|
h = await auth_headers("u1")
|
|
pid = await _place(client, h)
|
|
|
|
body = (await client.post(f"/v1/place/{pid}/faq", headers=h,
|
|
json={"question": " ", "answer": "무료 주차 가능합니다."})).json()
|
|
assert body["result"]["code"] == ErrorType.INVALID_REQUEST_DATA.value
|