test-document-knowledge-base

Testing DocumentKnowledgeBase

This document records the canonical approach for component–testing DocumentKnowledgeBase with Playwright-CT, Apollo Client mocks and Jotai atoms. The component depends on many React-contexts, GraphQL queries, REST calls and external assets – missing any of them will usually surface as silent timeouts or stack-overflows. Follow the checklist below and copy / adapt the helpers that already live in this directory.

---

1. Always mount through DocumentKnowledgeBaseTestWrapper

DocumentKnowledgeBaseTestWrapper.tsx encapsulates everything the component needs:

• MockedProvider with
  • a minimal but type-policy aware InMemoryCache
  • an ApolloLink that • delegates normal requests to MockLink • intercepts wild-card addAnnotation mutations, returning a canned payload
• Jotai’s global <Provider> so every …Atom used inside the component is satisfied
• The optional CorpusStateDebugger that prints the corpus atom whenever it changes

Never mount DocumentKnowledgeBase directly in tests – you will miss at least one of the above.

Example:

await mount(
<DocumentKnowledgeBaseTestWrapper
mocks={graphqlMocks}
documentId={PDF_DOC_ID}
corpusId={CORPUS_ID}
/>
);

---

2. GraphQL mocks – common pitfalls

DocumentKnowledgeBase renders before it knows which tab / layer the user will pick, therefore a surprisingly large set of queries executes immediately.

1. GET_DOCUMENT_KNOWLEDGE_AND_ANNOTATIONS
2. GET_DOCUMENT_ANALYSES_AND_EXTRACTS
3. GET_CONVERSATIONS

Extra refetch calls are triggered when:

• the user selects an analysis (analysisId set)
• the user selects an extract (analysisId replaced by the extract id)

Mandatory mocks

The test file DocumentKnowledgeBase.ct.tsx already includes a complete list that works for:

• a PDF document (PDF_DOC_ID)
• a TXT document (TXT_DOC_ID)
• the unexpected boot call where documentId === ""

When adding new tests, start by copying this array and trimming what you do not need – never delete the empty-string variant unless you are 100 % sure no component code path calls it.