feat(plan-35-36): add unit tests and documentation by d-oit · Pull Request #330 · d-oit/do-knowledge-studio

d-oit · 2026-06-19T10:18:38Z

Implements remaining tasks from plans 35 (Test Coverage) and 36 (Documentation).

Plan 35: Test Coverage Expansion

New Tests

useFocusTrap: focus management, tab wrapping, focus restoration, inactive state, empty focusable elements
Markdown renderer: headings (h1-h6), ordered/unordered lists, code blocks, inline code, bold/italic/strikethrough, links, XSS sanitization, empty input, unclosed code blocks
DbProvider: initialization success/error states, context provision, dbReady state
Mind map tree (extracted to src/lib/mindmap-tree.ts): empty arrays, parent-child links, depth limits, relation filtering, null entities, circular references, ARIA attributes

Coverage Thresholds Raised

branches: 30 → 33
functions: 35 → 38
lines: 40 → 43
statements: 40 → 42

Bug Fix

Added <code>, <pre>, and <del> to allowed HTML tags in sanitizeHtml

Plan 36: Documentation

New Documentation

DEPLOYMENT.md: Static hosting (Netlify, Vercel, GitHub Pages), Nginx, Apache, Caddy, Docker, HTTPS, performance optimization
LLM_SETUP.md: Provider configuration (OpenRouter, Kilo, custom), API key management, rate limiting, error handling, security best practices

Files Changed

4 new test files
1 new utility file (mindmap-tree.ts)
1 modified test file (markdown.test.tsx)
1 modified security config
1 modified vitest config
2 new documentation files

Plan 35 (Test Coverage): - Add useFocusTrap tests (focus management, tab wrapping, restoration) - Add markdown renderer tests (headings, lists, code, links, XSS) - Add DbProvider tests (initialization, error handling, context) - Extract buildTree to src/lib/mindmap-tree.ts for isolated testing - Add mindmap-tree tests (tree building, depth limits, circular refs, ARIA) - Raise coverage thresholds (branches: 33, functions: 38, lines: 43, statements: 42) - Add code and del tags to allowed HTML list in sanitizeHtml Plan 36 (Documentation): - Add docs/DEPLOYMENT.md (static hosting, Nginx, Apache, Caddy, Docker) - Add docs/LLM_SETUP.md (providers, configuration, troubleshooting)

deepsource-io · 2026-06-19T10:18:54Z

DeepSource Code Review

We reviewed changes in 5608449...bfbd5c8 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade	Security Reliability Complexity Hygiene

Code Review Summary

Analyzer	Updated (UTC)	Details
JavaScript	Jun 19, 2026 10:27a.m.	Review ↗
Python	Jun 19, 2026 10:27a.m.	Review ↗
Shell	Jun 19, 2026 10:27a.m.	Review ↗
SQL	Jun 19, 2026 10:27a.m.	Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

deepsource-io · 2026-06-19T10:19:25Z

+  });
+
+  it('should render children when database is ready', async () => {
+    const { initDb } = await import('../../db/client');


Useless path segments for "../../db/client", should be "../client"

Unnecessarily complex import statements can be simplified. Complex imports usually result in confusing code. This usually happens as a result of refactoring.

deepsource-io · 2026-06-19T10:19:25Z

+
+  it('should render children when database is ready', async () => {
+    const { initDb } = await import('../../db/client');
+    vi.mocked(initDb).mockResolvedValue(undefined);


Remove redundant `undefined` from function call

When an argument is omitted from a function call, it will default to undefined. It is therefore redundant to explicitly pass an undefined literal as the last argument.

deepsource-io · 2026-06-19T10:19:25Z

+  });
+
+  it('should show error state on failure', async () => {
+    const { initDb } = await import('../../db/client');


Useless path segments for "../../db/client", should be "../client"

Unnecessarily complex import statements can be simplified. Complex imports usually result in confusing code. This usually happens as a result of refactoring.

deepsource-io · 2026-06-19T10:19:26Z

+  });
+
+  it('should provide repository in context', async () => {
+    const { initDb } = await import('../../db/client');


Useless path segments for "../../db/client", should be "../client"

Unnecessarily complex import statements can be simplified. Complex imports usually result in confusing code. This usually happens as a result of refactoring.

deepsource-io · 2026-06-19T10:19:26Z

+
+  it('should provide repository in context', async () => {
+    const { initDb } = await import('../../db/client');
+    vi.mocked(initDb).mockResolvedValue(undefined);


Remove redundant `undefined` from function call

When an argument is omitted from a function call, it will default to undefined. It is therefore redundant to explicitly pass an undefined literal as the last argument.

deepsource-io · 2026-06-19T10:19:26Z

@@ -0,0 +1,125 @@
+import { describe, it, expect } from 'vitest';
+import { buildTree, addAriaToNodes } from '../../lib/mindmap-tree';
+import type { Entity, Link } from '../../lib/validation';


Useless path segments for "../../lib/validation", should be "../validation"

Unnecessarily complex import statements can be simplified. Complex imports usually result in confusing code. This usually happens as a result of refactoring.

deepsource-io · 2026-06-19T10:19:26Z

@@ -1,128 +1,124 @@
 import { describe, it, expect } from 'vitest';
-import { render } from '@testing-library/react';
+import { render, screen } from '@testing-library/react';


'screen' is defined but never used

Unused variables are generally considered a code smell and should be avoided.

deepsource-io · 2026-06-19T10:19:26Z

+      <MarkdownRenderer content={'Some text\n```\nconst x = 1;'} />
+    );
+    // The unclosed code block should still render as a paragraph
+    const p = container.querySelector('p');


Variable name is too small

Short variable names affect code readability and complicate code refactoring, because of the difficulty in searching and replacing such short characters.

deepsource-io · 2026-06-19T10:19:26Z

+export function buildTree(
+  currentId: string,
+  depth: number,
+  maxDepth: number,
+  entities: Entity[],
+  links: Link[],
+  relationFilter: string,
+): MindMapNode | null {
+  const entity = entities.find(e => e.id === currentId);
+  if (!entity || depth > maxDepth) return null;
+
+  const childrenLinks = links.filter(l =>
+    l.source_id === currentId &&
+    (relationFilter === 'all' || l.relation === relationFilter)
+  );
+
+  return {
+    id: entity.id || `node-${Math.random()}`,
+    topic: entity.name,
+    children: childrenLinks
+      .map(l => buildTree(l.target_id, depth + 1, maxDepth, entities, links, relationFilter))
+      .filter((n): n is MindMapNode => n !== null)
+  };
+}


Unexpected function declaration in the global scope, wrap in an IIFE for a local variable, assign as global property for a global variable

It is considered a best practice to avoid 'polluting' the global scope with variables that are intended to be local to the script. Global variables created from a script can produce name collisions with global variables created from another script, which will usually lead to runtime errors or unexpected behavior. It is mostly useful for browser scripts.

deepsource-io · 2026-06-19T10:19:26Z

+export function addAriaToNodes(container: HTMLElement): void {
+  const topics = container.querySelectorAll('me-tpc');
+  topics.forEach(tpc => {
+    const parent = tpc.closest('me-parent');
+    if (parent && !parent.hasAttribute('role')) {
+      parent.setAttribute('role', 'treeitem');
+      parent.setAttribute('aria-label', tpc.textContent?.trim() || 'Mind map node');
+    }
+  });
+}


Unexpected function declaration in the global scope, wrap in an IIFE for a local variable, assign as global property for a global variable

It is considered a best practice to avoid 'polluting' the global scope with variables that are intended to be local to the script. Global variables created from a script can produce name collisions with global variables created from another script, which will usually lead to runtime errors or unexpected behavior. It is mostly useful for browser scripts.

codacy-production · 2026-06-19T10:19:53Z

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 65 complexity · 2 duplication

Metric Results

Complexity 65

Duplication 2

View in Codacy

_{NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer}
_{TIP This summary will be updated as you push new changes.}

github-actions Bot added documentation Documentation improvements config tests Related to automated/manual tests labels Jun 19, 2026

deepsource-io Bot reviewed Jun 19, 2026

View reviewed changes

fix(test): resolve Codacy issues - unused vars/imports, false positives

bfbd5c8

d-oit merged commit 1b19723 into main Jun 19, 2026
23 of 24 checks passed

d-oit deleted the feat/goap-plan-35-36-041-remaining-2026-06-19 branch June 19, 2026 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(plan-35-36): add unit tests and documentation#330

feat(plan-35-36): add unit tests and documentation#330
d-oit merged 2 commits into
mainfrom
feat/goap-plan-35-36-041-remaining-2026-06-19

d-oit commented Jun 19, 2026

Uh oh!

deepsource-io Bot commented Jun 19, 2026 •

edited

Loading

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

deepsource-io Bot Jun 19, 2026

Uh oh!

codacy-production Bot commented Jun 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

d-oit commented Jun 19, 2026

Plan 35: Test Coverage Expansion

New Tests

Coverage Thresholds Raised

Bug Fix

Plan 36: Documentation

New Documentation

Files Changed

Uh oh!

deepsource-io Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DeepSource Code Review

PR Report Card

Code Review Summary

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Useless path segments for "../../db/client", should be "../client"

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Remove redundant `undefined` from function call

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Useless path segments for "../../db/client", should be "../client"

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Useless path segments for "../../db/client", should be "../client"

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Remove redundant `undefined` from function call

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Useless path segments for "../../lib/validation", should be "../validation"

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

'screen' is defined but never used

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Variable name is too small

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Unexpected function declaration in the global scope, wrap in an IIFE for a local variable, assign as global property for a global variable

Uh oh!

deepsource-io Bot Jun 19, 2026

Choose a reason for hiding this comment

Unexpected function declaration in the global scope, wrap in an IIFE for a local variable, assign as global property for a global variable

Uh oh!

codacy-production Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Up to standards ✅

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

deepsource-io Bot commented Jun 19, 2026 •

edited

Loading

codacy-production Bot commented Jun 19, 2026 •

edited

Loading