Files
apes-sidebar/tests/file-tree-search-persist.spec.tsx
T
Menghuan1918 5c95002641 perf(sidebar): fs.tree 22.8ms→3.8ms + 删除工作区路径检测(放开权限)+ 树展开状态按会话
用户实测反馈:

1) `/sidebar/api/fs.tree` 性能极差 —— 先测后改(10k 条目目录、热缓存、中位数):
   - 冷调用 cap=1000:22.76ms → **3.77ms**;TTL 内重复:≈23ms → **0.000ms**
   - 改法:opendir for-await → readdir(withFileTypes) 一次取回;只为 cap 条建行
     (slice + 定长数组);路径用字符串拼接而非 path.join;排序弃 localeCompare
     (14.6ms/10k → 0.35ms)改小写比较 + 原名码点兜底;新增 1.5s 目录级缓存
     (键 绝对路径\0cap,上限 512),由 fs.write/rename/remove/mkdir/upload 与
     fs-watch 的变更通知显式失效
   - 契约逐字不变;新增 tests/fs-tree.spec.ts 6 例 + fs-watch 失效用例(判别性验证)

2) 删除工作区路径检测(默认不检测、放开权限):
   - path-security 变纯词法解析(realpath/包含性判定删除)、fs-operations 去 fence
     分支、所有 fs 路由不再读 fence、403 分支消失、config 删 workspaceFence 字段
     (schemastery 容忍未知键,旧 profile 不会加载失败)、settings 开关删除
   - ⚠️ 安全影响:插件 fs 路由(tree/read/write/rename/remove/mkdir/媒体/HTML/
     upload/archive)现在可读写宿主用户可访问的任意路径,只受 OS 权限约束;
     指南 §8.1 已加醒目声明
   - 死代码清理:FenceErrorNotice 组件 + EditorHost 分支 + 4 个词条(settingsFence*、
     fenceErrorReason、fenceDisableAction)+ isOutsideWorkspace* 助手 + TreePanel 的
     store prop + 相关 CSS 块

3) 批量列举路由 `fs.trees`(单层失败只在该层带 error)+ 客户端批量加载:
   挂载/刷新时的 N+1 请求变为 1 个(8 个展开目录:9 → 1,探针断言)
   refreshTick 不再先清缓存(旧行保留到新答案;失败保留旧行 + warn 提示)

4) 修复「关闭文件后返回文件树,展开状态被重置」:
   原生承载面的展开集合原来存在每个 tab 的记录里(drop 即丢),改为**每会话状态**
   的投影(ensure 从会话态读、toggleExpanded 写回会话态、registerNativeSurface 用
   attachStore 订阅);同一会话多 tab 共享、不同会话隔离;revealed 保持 per-tab

验证:typecheck / lint / test(136 文件 / 1484 通过 / 9 跳过)/ build 全绿;
DSH_CMD='npx -y --package @deepseek-ai/dsh@0.1.7-rc.1 dsh' pnpm test:mount 7/7 通过;
版本镜像同步(dsh.plugin.json + SIDEBAR_SERVICE_VERSION)
2026-09-28 20:37:56 +08:00

187 lines
7.3 KiB
TypeScript

/**
* The files panel's search surface and level-cache life-cycle:
*
* - Typing a query parks the tree (`hidden`) instead of unmounting it, so
* clearing the box restores the SAME level cache — `fs.tree` is not called
* again (the old conditional render dropped the tree and refetched the
* whole visible set on every query change).
* - The refresh affordance wipes the cache and reloads concurrently, and a
* response from the previous generation is DROPPED even when it lands last.
* - A level the host truncated says so instead of silently showing a partial
* directory.
*/
// @vitest-environment jsdom
import { beforeAll, afterEach, describe, expect, it, vi } from 'vitest'
import { createElement } from 'react'
import { createRoot, type Root } from 'react-dom/client'
import { act } from 'react-dom/test-utils'
import { TreePanel } from '../src/client/TreePanel.tsx'
import { setupReactAct } from './test-utils.ts'
setupReactAct()
// vitest 4.1.11+ follows the OS locale; pin en-US so the panel's copy is English.
beforeAll(() => {
Object.defineProperty(window.navigator, 'language', { value: 'en-US', configurable: true })
})
interface Listing {
path: string
entries: { name: string; path: string; isDir: boolean }[]
truncated: boolean
}
/** The default host answer: one file at /tmp. */
function defaultListing(path: string): Listing {
return { path, entries: [{ name: 'a.ts', path: '/tmp/a.ts', isDir: false }], truncated: false }
}
const { fsTrees, fsSearch } = vi.hoisted(() => ({
fsTrees: vi.fn(async (_scope: unknown, paths: readonly string[]) => ({ levels: paths.map(path => defaultListing(path)) })),
fsSearch: vi.fn(async () => ({ matches: ['a.ts'], truncated: false })),
}))
vi.mock('../src/client/api.ts', () => ({
api: {
fsTrees,
fsSearch,
// The tree reads the shared git-status store; a non-repo answer keeps
// every row plain.
gitStatus: async () => ({ isRepo: false, entries: [] }),
},
downloadUrl: () => '/sidebar/file',
isOutsideWorkspaceMessage: () => false,
}))
interface Harness {
container: HTMLDivElement
unmount: () => void
}
function mountPanel(): Harness {
const container = document.createElement('div')
document.body.append(container)
const root: Root = createRoot(container)
act(() => {
root.render(createElement(TreePanel, {
sessionId: 's1',
cwd: '/tmp',
expanded: [],
revealed: [],
onToggle: () => {},
onOpenFile: () => {},
onReferenceFile: () => {},
}))
})
return {
container,
unmount: () => { act(() => { root.unmount() }); container.remove() },
}
}
/**
* The tree surface: the body that carries row-name spans (the search results
* panel is a body too, but its rows are plain buttons with no name span).
* Finding it while parked is itself the "still mounted" probe.
*/
function treeBody(container: HTMLElement): HTMLElement {
const body = [...container.querySelectorAll<HTMLElement>('div[class*="explorerBody"]')]
.find(el => el.querySelector('[class*="explorerName"]') !== null)
if (body === undefined) throw new Error('tree body not mounted')
return body
}
function resultsBody(container: HTMLElement): HTMLElement {
const tree = treeBody(container)
const body = [...container.querySelectorAll<HTMLElement>('div[class*="explorerBody"]')]
.find(el => el !== tree)
if (body === undefined) throw new Error('results body not mounted')
return body
}
/** Type a query the React way and let the 300ms debounce elapse. */
async function search(container: HTMLElement, query: string): Promise<void> {
const input = container.querySelector<HTMLInputElement>('input[class*="editorSearchInput"]')!
const setter = Object.getOwnPropertyDescriptor(window.HTMLInputElement.prototype, 'value')!.set!
await act(async () => {
setter.call(input, query)
input.dispatchEvent(new Event('input', { bubbles: true }))
})
await act(async () => { await new Promise<void>(resolve => { window.setTimeout(resolve, 350) }) })
}
let harness: Harness
afterEach(() => {
harness.unmount()
document.body.innerHTML = ''
fsTrees.mockReset()
fsTrees.mockImplementation(async (_scope: unknown, paths: readonly string[]) => ({ levels: paths.map(path => defaultListing(path)) }))
fsSearch.mockClear()
})
describe('TreePanel search keeps the tree mounted', () => {
it('parks the tree instead of unmounting it, so clearing the query keeps the level cache', async () => {
harness = mountPanel()
await act(async () => {})
expect(fsTrees).toHaveBeenCalledTimes(1)
expect(treeBody(harness.container).hasAttribute('hidden')).toBe(false)
expect(harness.container.textContent).toContain('a.ts')
await search(harness.container, 'a')
expect(fsSearch).toHaveBeenCalledTimes(1)
// The tree is still in the document — just parked.
expect(treeBody(harness.container).hasAttribute('hidden')).toBe(true)
expect(resultsBody(harness.container).hasAttribute('hidden')).toBe(false)
expect(resultsBody(harness.container).textContent).toContain('a.ts')
await search(harness.container, '')
expect(treeBody(harness.container).hasAttribute('hidden')).toBe(false)
expect(resultsBody(harness.container).hasAttribute('hidden')).toBe(true)
// No second listing: the cache (and the expansion state) survived.
expect(fsTrees).toHaveBeenCalledTimes(1)
})
})
describe('TreePanel refresh and truncated levels', () => {
it('drops a level response that lands after the cache was wiped', async () => {
// The FIRST listing never settles until the test resolves it; the refresh
// click starts the second one, which answers immediately.
let resolveStale: (result: { levels: Listing[] }) => void = () => {}
fsTrees.mockImplementationOnce(async () => await new Promise<{ levels: Listing[] }>(resolve => { resolveStale = resolve }))
harness = mountPanel()
await act(async () => {})
// The pending level shows nothing yet (its rows are not known).
expect(harness.container.textContent).not.toContain('a.ts')
// Manual refresh: cache wiped, new generation, concurrent re-list.
const refresh = harness.container.querySelector<HTMLButtonElement>('button[aria-label="Refresh"]')!
await act(async () => {
refresh.dispatchEvent(new MouseEvent('click', { bubbles: true }))
await Promise.resolve()
await Promise.resolve()
})
expect(fsTrees).toHaveBeenCalledTimes(2)
expect(harness.container.textContent).toContain('a.ts')
// The stale first answer arrives LAST and must be discarded.
await act(async () => {
resolveStale({ levels: [{ path: '/tmp', entries: [{ name: 'stale.ts', path: '/tmp/stale.ts', isDir: false }], truncated: false }] })
await Promise.resolve()
await Promise.resolve()
})
expect(harness.container.textContent).not.toContain('stale.ts')
expect(harness.container.textContent).toContain('a.ts')
})
it('surfaces a truncated level instead of hiding it', async () => {
fsTrees.mockImplementation(async (_scope: unknown, paths: readonly string[]) => ({
levels: paths.map(path => ({ path, entries: [{ name: 'a.ts', path: '/tmp/a.ts', isDir: false }], truncated: true })),
}))
harness = mountPanel()
await act(async () => {})
const notice = [...harness.container.querySelectorAll<HTMLElement>('[data-kind="hint"]')]
.find(el => el.textContent?.includes('too many entries'))
expect(notice).toBeDefined()
})
})