From 2c5d49645ba1b40f8cd1f896ab8258cfc214ddd1 Mon Sep 17 00:00:00 2001 From: sjw1231 Date: Mon, 21 Sep 2026 11:09:13 +0800 Subject: [PATCH 1/9] docs(ui-deliverables): plan review tab fixes for #4670 --- packages/client/ui-deliverables/README.i18n.yaml | 4 ++-- packages/client/ui-deliverables/README.md | 16 +++++++++++++++- packages/client/ui-deliverables/README.zh.md | 16 +++++++++++++++- 3 files changed, 32 insertions(+), 4 deletions(-) diff --git a/packages/client/ui-deliverables/README.i18n.yaml b/packages/client/ui-deliverables/README.i18n.yaml index 7ea790985c..1e78c569c1 100644 --- a/packages/client/ui-deliverables/README.i18n.yaml +++ b/packages/client/ui-deliverables/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-deliverables/README.md -README.md: 71f3545b8fb3fed3ecd678258e6c50bbfa4b580c -README.zh.md: 3e59ed2b7d4ac7e9d64b7d1f2f3c477e3ca1c50e +README.md: cde375ad0e79db89d89fd19a1d5dbfa16d61dd01 +README.zh.md: eba1733c06b230857d8a71615707020f1d40afb9 diff --git a/packages/client/ui-deliverables/README.md b/packages/client/ui-deliverables/README.md index 71f3545b8f..cde375ad0e 100644 --- a/packages/client/ui-deliverables/README.md +++ b/packages/client/ui-deliverables/README.md @@ -120,7 +120,21 @@ These limits define the current deliverables vocabulary. They are current packag
Working context for maintainers — click to expand -None. +Working draft for Issue #4670, pending implementation and verification. This section does not describe shipped behavior. + +**Reported reproduction.** In macOS Chrome, open a completed turn's changed-file review with enough changed rows and long lines to scroll on both axes. Keep the pointer over either column and flick the trackpad toward each edge. The user reports that the operated column rebounds beyond the edge while the other stays at its limit. A long selected-file path also hides its filename suffix; the document preview provides the requested reference appearance. + +**Planned scrolling behavior.** In the unwrapped split view, suppress elastic overscroll at all four edges of both columns while retaining native momentum within the scrollable range. Start with `overscroll-behavior: none` on the actual column scroll containers in [ReviewTab.module.css](src/client/ReviewTab.module.css). Preserve the position synchronization in [ReviewTab.tsx](src/client/ReviewTab.tsx), including each column's horizontal limit and the long side's offset when the other side fits. The proposal does not introduce wheel cancellation, custom inertia, or shared content widths. Check scroll chaining to the surrounding pane before deciding whether any additional containment is needed. + +**Planned filename behavior.** Give the selected-file title the document preview's path presentation: left-aligned complete text when it fits; preserved trailing characters and extension with a left-edge fade only when clipped; subdued directories and normal filename text; and the complete displayed path on hover. Follow the layout and overflow measurement in [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) and [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css). Recalculate clipping when the selected file or available width changes. Keep the selector arrow, line counts, and action buttons visible. Any shared presentation component belongs in `ui-primitives`, rather than a component import between feature plugins. + +**Acceptance criteria.** + +- From either column, rapid gestures toward the top, bottom, left, and right stop at the corresponding limit without elastic displacement. Releasing a gesture before an edge still permits native momentum, and reversing direction resumes normal synchronized scrolling. +- Equal and unequal horizontal content widths remain usable, including a comparison where only one side needs horizontal scrolling. Vertical scrolling preserves horizontal position. Unified and wrapped views remain usable, and reaching a split-column edge does not move the surrounding pane unexpectedly. +- Short titles remain complete and unfaded. Narrowing the pane preserves long filename endings with a left fade; widening it removes the fade once the path fits. Switching between files with matching prefixes and different suffixes keeps their endings distinguishable. The title remains selectable through the file menu, with the full displayed path available on hover. + +**Verification plan.** Extend the existing [recorded-session browser case](../../../apps/web/tests/changed-files-turn.e2e.ts) for the changed-file title and scroll geometry, and retain its unequal-range regression coverage. Add focused [component coverage](tests/review-tab.client.spec.tsx) for any new title behavior that does not require browser layout. The implementer must verify elastic overscroll and momentum with a real macOS trackpad in Chrome and record the browser version and result; programmatic scroll offsets or synthetic wheel events alone do not establish native rebound behavior. Record desktop validation separately if exercised. After implementation, update the review-tab usage section and affected JSDoc to the verified behavior, then remove this draft.
diff --git a/packages/client/ui-deliverables/README.zh.md b/packages/client/ui-deliverables/README.zh.md index 3e59ed2b7d..eba1733c06 100644 --- a/packages/client/ui-deliverables/README.zh.md +++ b/packages/client/ui-deliverables/README.zh.md @@ -120,7 +120,21 @@ Node 半部注册[模型体验](#model-experience)所述的静态 `ui:deliverabl
维护者的工作上下文——点击展开 -无。 +Issue #4670 的工作草稿，尚待实现与验证。本节不描述已交付行为。 + +**已报告的复现。** 在 macOS Chrome 中打开已完成轮次的改动文件 review，改动行数与单行长度足以支持双轴滚动。鼠标停在任一列，用触控板快速滑向各个边缘。用户报告，接受操作的一列会越过边缘回弹，另一列停在滚动终点。选中文件的路径过长时还会隐藏文件名尾部；文档预览提供了期望的参考效果。 + +**计划中的滚动行为。** 在关闭自动换行的左右对比中，禁止两列在上下左右四个边缘的弹性越界，同时保留可滚动范围内的原生惯性。先在 [ReviewTab.module.css](src/client/ReviewTab.module.css) 中实际承担滚动的列容器上设置 `overscroll-behavior: none`。保留 [ReviewTab.tsx](src/client/ReviewTab.tsx) 的位置同步，包括各列自己的横向终点，以及另一侧无需滚动时长内容一侧的偏移。方案不引入滚轮事件取消、自定义惯性或共享内容宽度。先检查滚动向外围面板传递的行为，再判断是否需要额外限制。 + +**计划中的文件名行为。** 选中文件的标题采用文档预览的路径展示：空间足够时完整靠左显示；裁切时保留尾部字符与扩展名，且仅在左侧渐隐；目录使用弱化颜色，文件名使用正常文字颜色；悬停显示完整的展示路径。沿用 [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) 与 [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css) 的布局和溢出测量方式。所选文件或可用宽度变化时重新判断裁切。选择器箭头、行数统计与操作按钮保持可见。若提取共享展示组件，应放入 `ui-primitives`，而不是在功能插件之间导入组件。 + +**验收条件。** + +- 从任一列快速滑向上、下、左、右边缘，都停在对应终点，不产生弹性位移。在到达边缘前松手仍保留原生惯性，反向操作恢复正常同步滚动。 +- 两侧横向内容等宽或不等宽时均可使用，包括仅一侧需要横向滚动的对比。纵向滚动保留横向位置。单栏和自动换行视图仍可使用，双栏到达边缘时不会意外带动外围面板。 +- 短标题完整显示且不渐隐。缩窄面板时，长文件名保留尾部并在左侧渐隐；加宽到路径可完整显示时渐隐消失。在前缀相同、后缀不同的文件之间切换，仍能辨认各自尾部。文件菜单仍能选择标题对应的文件，悬停可查看完整展示路径。 + +**验证计划。** 扩展现有[录制会话浏览器用例](../../../apps/web/tests/changed-files-turn.e2e.ts)，覆盖改动文件标题与滚动布局，并保留其滚动范围不等的回归覆盖。对不依赖浏览器布局的新标题行为补充聚焦的[组件覆盖](tests/review-tab.client.spec.tsx)。实现者必须在 Chrome 中用真实 macOS 触控板验证弹性越界与惯性，并记录浏览器版本和结果；仅设置滚动偏移或合成滚轮事件不能证明原生回弹行为。若验证桌面端，单独记录结果。实现完成后，把已验证行为写入 review tab 使用说明与相关 JSDoc，再删除本草稿。
From c84c908656da003e62261acaeaba0642fd03c9c2 Mon Sep 17 00:00:00 2001 From: sjw1231 Date: Mon, 21 Sep 2026 11:29:02 +0800 Subject: [PATCH 2/9] fix(ui-deliverables): prevent split diff edge rebound --- apps/web/tests/changed-files-turn.e2e.ts | 64 ++++++++++++++++++- .../client/ui-deliverables/README.i18n.yaml | 4 +- packages/client/ui-deliverables/README.md | 10 ++- packages/client/ui-deliverables/README.zh.md | 10 ++- .../src/client/ReviewTab.module.css | 2 +- .../ui-deliverables/src/client/ReviewTab.tsx | 1 + 6 files changed, 75 insertions(+), 16 deletions(-) diff --git a/apps/web/tests/changed-files-turn.e2e.ts b/apps/web/tests/changed-files-turn.e2e.ts index a5b45a3511..0859d3bad3 100644 --- a/apps/web/tests/changed-files-turn.e2e.ts +++ b/apps/web/tests/changed-files-turn.e2e.ts @@ -5,7 +5,7 @@ import { tmpdir } from 'node:os' import { join } from 'node:path' import { fileURLToPath } from 'node:url' import { chromium, type Browser, type Page } from 'playwright' -import { afterAll, beforeAll, describe, expect, it } from 'vitest' +import { afterAll, beforeAll, describe, expect, it, onTestFinished } from 'vitest' import type {} from '@deepseek-ai/dsh-workspace-changes' import { deriveReplayScript, parseSessionLog } from '@deepseek-ai/dsh-llm-replay' import { @@ -354,6 +354,68 @@ describe('web e2e: a git workspace turn ends with its changed files', () => { expect(tripwire.warnings).toEqual([]) }) + it('keeps edge gestures inside either diff column and accepts reverse scrolling', async () => { + const review = page.locator('[data-changes-review]') + await review.getByRole('button', { name: '自动换行' }).click() + const body = review.locator('[data-review-view="split"]:not([data-review-wrap])') + await body.waitFor({ state: 'visible' }) + // A scrollable parent makes escaped edge gestures observable without native trackpad rebound. + const layout = await page.addStyleTag({ content: ` + [data-changes-review] { height: 220px !important; } + [data-review-view="split"] { display: block; max-width: 220px; } + [data-review-view="split"] > div { width: 160px; height: 60px; margin: 160px; } + ` }) + onTestFinished(async () => { + await layout.evaluate(element => element.parentNode!.removeChild(element)) + await body.evaluate((element) => { element.scrollTo(0, 0) }) + await review.getByRole('button', { name: '自动换行' }).click() + }) + const input = await page.context().newCDPSession(page) + try { + for (const side of ['left', 'right']) { + const column = review.locator(`[data-diff-side="${side}"]`) + for (const axis of ['x', 'y'] as const) { + for (const end of [false, true]) { + const parentPosition = await body.evaluate((element) => { + const x = (element.scrollWidth - element.clientWidth) / 2 + const y = (element.scrollHeight - element.clientHeight) / 2 + element.scrollTo(x, y) + return { x: element.scrollLeft, y: element.scrollTop } + }) + expect(parentPosition.x).toBeGreaterThan(0) + expect(parentPosition.y).toBeGreaterThan(0) + const edge = await column.evaluate((element, { axis, end }) => { + const maximum = axis === 'x' + ? element.scrollWidth - element.clientWidth + : element.scrollHeight - element.clientHeight + element.scrollTo(axis === 'x' && end ? maximum : 0, axis === 'y' && end ? maximum : 0) + return { maximum, offset: end ? maximum : 0 } + }, { axis, end }) + expect(edge.maximum).toBeGreaterThan(0) + const position = () => column.evaluate((element, axis) => axis === 'x' ? element.scrollLeft : element.scrollTop, axis) + await expect.poll(position).toBe(edge.offset) + const box = await column.boundingBox() + if (box === null) throw new Error('diff column has no visible bounds') + const gesture = { x: box.x + box.width / 2, y: box.y + box.height / 2, gestureSourceType: 'mouse' as const } + const distance = end ? -80 : 80 + // CDP acknowledges the completed gesture, including default scrolling, before observation. + await input.send('Input.synthesizeScrollGesture', { + ...gesture, xDistance: axis === 'x' ? distance : 0, yDistance: axis === 'y' ? distance : 0, + }) + expect(await body.evaluate(element => ({ x: element.scrollLeft, y: element.scrollTop }))).toEqual(parentPosition) + expect(await position()).toBe(edge.offset) + await input.send('Input.synthesizeScrollGesture', { + ...gesture, xDistance: axis === 'x' ? -distance : 0, yDistance: axis === 'y' ? -distance : 0, + }) + await expect.poll(position).not.toBe(edge.offset) + } + } + } + } finally { + await input.detach() + } + }) + it.skipIf(MODE === 'record')('replays the workspace and the Chinese conversation', async () => { await assertFinalWorkspaceSnapshot(DIR, cwd, { ignoredRootEntries: ['.git'] }) const aria = await captureExpandedTurnProcessAria(page, '[data-chat-flow]', scaffold.workspaceCwd) diff --git a/packages/client/ui-deliverables/README.i18n.yaml b/packages/client/ui-deliverables/README.i18n.yaml index 1e78c569c1..67d40a19a0 100644 --- a/packages/client/ui-deliverables/README.i18n.yaml +++ b/packages/client/ui-deliverables/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-deliverables/README.md -README.md: cde375ad0e79db89d89fd19a1d5dbfa16d61dd01 -README.zh.md: eba1733c06b230857d8a71615707020f1d40afb9 +README.md: 7f2dd84bdab443c22b23ec62b87b35306e4eb360 +README.zh.md: ab3f351ce1f0499bc6abcbbd18eb7bcc5860d8a1 diff --git a/packages/client/ui-deliverables/README.md b/packages/client/ui-deliverables/README.md index cde375ad0e..7f2dd84bda 100644 --- a/packages/client/ui-deliverables/README.md +++ b/packages/client/ui-deliverables/README.md @@ -44,7 +44,7 @@ The card renders the summary the Host serves for the turn's latest `workspace/ch A row opens the turn's `changes-review` tab, addressed by the viewed Session and the announcing event's sequence and titled by the turn, on that row's file; another row of the same card reveals the same tab on its file. The header's file selector lists every recorded file with its counts and switches the comparison. A new tab starts in the side-by-side view without wrapping. Its controls switch between unified and side-by-side comparison, toggle line wrapping, open the whole current file in the Sidebar, and, with a Host desktop available, open it in the default application with the same pending and retryable-error states as the cards; the view and wrap choices are kept per tab. The tab reads the summary and each comparison once through the authenticated routes. A text comparison lists its hunks with the old and new line numbers of every line, and highlights each rendered hunk side independently with the code preview's filename grammar and Shiki token colours. Additions and deletions use aligned success or error markers and background tints. The tab also shows a note when the file was created or deleted in the turn, when both sides hold the same lines, when the Host's line comparison timed out and every line shows as replaced, or when the tab stopped drawing at 5,000 lines. A binary or oversized file, a comparison the Host no longer serves, and a failed read each show one line instead; a failed read offers Retry. The comparison is the turn's snapshot of the file, not its current content. -Without wrapping, the two columns synchronize vertical scrolling and horizontal offsets up to each side’s available range. Both horizontal scrollbars remain at the bottom of the visible comparison; scrolling vertically preserves a long line’s horizontal offset when the other side fits without horizontal scrolling. +Without wrapping, the two columns synchronize vertical scrolling and horizontal offsets up to each side’s available range. Both columns suppress elastic edge feedback and scroll chaining on both axes; the browser retains control of native momentum within each column’s scrollable range. Both horizontal scrollbars remain at the bottom of the visible comparison; scrolling vertically preserves a long line’s horizontal offset when the other side fits without horizontal scrolling. ### Inline-code links @@ -120,21 +120,19 @@ These limits define the current deliverables vocabulary. They are current packag
Working context for maintainers — click to expand -Working draft for Issue #4670, pending implementation and verification. This section does not describe shipped behavior. +Working context for Issue #4670: filename presentation remains unimplemented. The proposed filename behavior below is not a shipped guarantee. **Reported reproduction.** In macOS Chrome, open a completed turn's changed-file review with enough changed rows and long lines to scroll on both axes. Keep the pointer over either column and flick the trackpad toward each edge. The user reports that the operated column rebounds beyond the edge while the other stays at its limit. A long selected-file path also hides its filename suffix; the document preview provides the requested reference appearance. -**Planned scrolling behavior.** In the unwrapped split view, suppress elastic overscroll at all four edges of both columns while retaining native momentum within the scrollable range. Start with `overscroll-behavior: none` on the actual column scroll containers in [ReviewTab.module.css](src/client/ReviewTab.module.css). Preserve the position synchronization in [ReviewTab.tsx](src/client/ReviewTab.tsx), including each column's horizontal limit and the long side's offset when the other side fits. The proposal does not introduce wheel cancellation, custom inertia, or shared content widths. Check scroll chaining to the surrounding pane before deciding whether any additional containment is needed. +**Scroll verification.** The [recorded-session browser case](../../../apps/web/tests/changed-files-turn.e2e.ts) covers containment at all four edges from either column, reverse scrolling, and unequal horizontal ranges. On 2026-09-21, the reporting user confirmed with a real macOS trackpad in Chrome that edge rebound is absent and normal momentum remains. **Planned filename behavior.** Give the selected-file title the document preview's path presentation: left-aligned complete text when it fits; preserved trailing characters and extension with a left-edge fade only when clipped; subdued directories and normal filename text; and the complete displayed path on hover. Follow the layout and overflow measurement in [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) and [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css). Recalculate clipping when the selected file or available width changes. Keep the selector arrow, line counts, and action buttons visible. Any shared presentation component belongs in `ui-primitives`, rather than a component import between feature plugins. **Acceptance criteria.** -- From either column, rapid gestures toward the top, bottom, left, and right stop at the corresponding limit without elastic displacement. Releasing a gesture before an edge still permits native momentum, and reversing direction resumes normal synchronized scrolling. -- Equal and unequal horizontal content widths remain usable, including a comparison where only one side needs horizontal scrolling. Vertical scrolling preserves horizontal position. Unified and wrapped views remain usable, and reaching a split-column edge does not move the surrounding pane unexpectedly. - Short titles remain complete and unfaded. Narrowing the pane preserves long filename endings with a left fade; widening it removes the fade once the path fits. Switching between files with matching prefixes and different suffixes keeps their endings distinguishable. The title remains selectable through the file menu, with the full displayed path available on hover. -**Verification plan.** Extend the existing [recorded-session browser case](../../../apps/web/tests/changed-files-turn.e2e.ts) for the changed-file title and scroll geometry, and retain its unequal-range regression coverage. Add focused [component coverage](tests/review-tab.client.spec.tsx) for any new title behavior that does not require browser layout. The implementer must verify elastic overscroll and momentum with a real macOS trackpad in Chrome and record the browser version and result; programmatic scroll offsets or synthetic wheel events alone do not establish native rebound behavior. Record desktop validation separately if exercised. After implementation, update the review-tab usage section and affected JSDoc to the verified behavior, then remove this draft. +**Remaining verification.** Extend the browser case for filename clipping, and add focused [component coverage](tests/review-tab.client.spec.tsx) for any new title behavior that does not require browser layout. Once the filename fix is verified, update the review-tab usage section and affected JSDoc, then remove this draft.
diff --git a/packages/client/ui-deliverables/README.zh.md b/packages/client/ui-deliverables/README.zh.md index eba1733c06..ab3f351ce1 100644 --- a/packages/client/ui-deliverables/README.zh.md +++ b/packages/client/ui-deliverables/README.zh.md @@ -44,7 +44,7 @@ Web 的 `standard`、`ptc` 与 `cordis` preset 提供 `present` 用于声明交 行在该行的文件上打开本轮的 `changes-review` tab，其地址由当前查看的 Session 和宣告事件的序号组成，以轮号作标题；同一张卡片的另一行会在其文件上显示同一个 tab。头部的文件选择器列出所有记录的文件及其行数，用于切换对比。新 tab 默认使用不换行的左右对比。其控件用于切换单栏或左右对比、切换自动换行、在 Sidebar 中打开当前完整文件，并在 Host 有桌面时用默认应用打开文件；原生打开的等待与可重试错误状态与卡片一致，视图和换行选择按 tab 保留。tab 通过经过认证的路由各读取一次摘要和每个对比。文本对比逐个列出 hunk，每一行带旧侧和新侧的行号，并按代码预览的文件名 grammar 与 Shiki token 色分别高亮每个已渲染 hunk 的两侧。新增与删除使用对齐的成功色或错误色标记和背景色。文件是本轮新建或删除、两侧内容相同、Host 的逐行对比超时而按整文件替换显示，或 tab 在 5000 行处停止绘制时，tab 还会给出一行说明。二进制或过大的文件、Host 已不再提供的对比，以及读取失败各显示一行提示；读取失败时提供重试。对比是本轮对该文件的快照，不是它当前的内容。 -关闭自动换行时，两列同步纵向滚动，横向偏移同步到各自可滚动范围内。两侧横向滚动条始终位于可见对比区域底部；如果只有一侧需要横向滚动，上下滚动会保留该侧的横向偏移。 +关闭自动换行时，两列同步纵向滚动，横向偏移同步到各自可滚动范围内。两列在双轴上都禁用弹性边缘反馈和向外层传递滚动；各列可滚动范围内的原生惯性仍由浏览器控制。两侧横向滚动条始终位于可见对比区域底部；如果只有一侧需要横向滚动，上下滚动会保留该侧的横向偏移。 ### 行内代码链接 @@ -120,21 +120,19 @@ Node 半部注册[模型体验](#model-experience)所述的静态 `ui:deliverabl
维护者的工作上下文——点击展开 -Issue #4670 的工作草稿，尚待实现与验证。本节不描述已交付行为。 +Issue #4670 的工作上下文：文件名展示尚未实现。下述拟议的文件名行为不是已交付保证。 **已报告的复现。** 在 macOS Chrome 中打开已完成轮次的改动文件 review，改动行数与单行长度足以支持双轴滚动。鼠标停在任一列，用触控板快速滑向各个边缘。用户报告，接受操作的一列会越过边缘回弹，另一列停在滚动终点。选中文件的路径过长时还会隐藏文件名尾部；文档预览提供了期望的参考效果。 -**计划中的滚动行为。** 在关闭自动换行的左右对比中，禁止两列在上下左右四个边缘的弹性越界，同时保留可滚动范围内的原生惯性。先在 [ReviewTab.module.css](src/client/ReviewTab.module.css) 中实际承担滚动的列容器上设置 `overscroll-behavior: none`。保留 [ReviewTab.tsx](src/client/ReviewTab.tsx) 的位置同步，包括各列自己的横向终点，以及另一侧无需滚动时长内容一侧的偏移。方案不引入滚轮事件取消、自定义惯性或共享内容宽度。先检查滚动向外围面板传递的行为，再判断是否需要额外限制。 +**滚动验证。** [录制会话浏览器用例](../../../apps/web/tests/changed-files-turn.e2e.ts)覆盖从任一列向四个边缘滚动时的限制、反向滚动与不等的横向范围。2026-09-21，报告问题的用户在 Chrome 中使用真实 macOS 触控板确认，边缘回弹消失，正常惯性保留。 **计划中的文件名行为。** 选中文件的标题采用文档预览的路径展示：空间足够时完整靠左显示；裁切时保留尾部字符与扩展名，且仅在左侧渐隐；目录使用弱化颜色，文件名使用正常文字颜色；悬停显示完整的展示路径。沿用 [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) 与 [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css) 的布局和溢出测量方式。所选文件或可用宽度变化时重新判断裁切。选择器箭头、行数统计与操作按钮保持可见。若提取共享展示组件，应放入 `ui-primitives`，而不是在功能插件之间导入组件。 **验收条件。** -- 从任一列快速滑向上、下、左、右边缘，都停在对应终点，不产生弹性位移。在到达边缘前松手仍保留原生惯性，反向操作恢复正常同步滚动。 -- 两侧横向内容等宽或不等宽时均可使用，包括仅一侧需要横向滚动的对比。纵向滚动保留横向位置。单栏和自动换行视图仍可使用，双栏到达边缘时不会意外带动外围面板。 - 短标题完整显示且不渐隐。缩窄面板时，长文件名保留尾部并在左侧渐隐；加宽到路径可完整显示时渐隐消失。在前缀相同、后缀不同的文件之间切换，仍能辨认各自尾部。文件菜单仍能选择标题对应的文件，悬停可查看完整展示路径。 -**验证计划。** 扩展现有[录制会话浏览器用例](../../../apps/web/tests/changed-files-turn.e2e.ts)，覆盖改动文件标题与滚动布局，并保留其滚动范围不等的回归覆盖。对不依赖浏览器布局的新标题行为补充聚焦的[组件覆盖](tests/review-tab.client.spec.tsx)。实现者必须在 Chrome 中用真实 macOS 触控板验证弹性越界与惯性，并记录浏览器版本和结果；仅设置滚动偏移或合成滚轮事件不能证明原生回弹行为。若验证桌面端，单独记录结果。实现完成后，把已验证行为写入 review tab 使用说明与相关 JSDoc，再删除本草稿。 +**剩余验证。** 扩展浏览器用例以覆盖文件名裁切，并对不依赖浏览器布局的新标题行为补充聚焦的[组件覆盖](tests/review-tab.client.spec.tsx)。文件名修复通过验证后，更新 review tab 使用说明与相关 JSDoc，再删除本草稿。
diff --git a/packages/client/ui-deliverables/src/client/ReviewTab.module.css b/packages/client/ui-deliverables/src/client/ReviewTab.module.css index 8d9fd9ede4..cb859fb52e 100644 --- a/packages/client/ui-deliverables/src/client/ReviewTab.module.css +++ b/packages/client/ui-deliverables/src/client/ReviewTab.module.css @@ -25,7 +25,7 @@ .status { display: flex; gap: 12px; align-items: center; margin: 0; padding: 16px; font-size: 13px; color: var(--dsw-alias-label-secondary); } .body { display: flex; flex: 1 1 auto; flex-direction: column; min-height: 0; overflow: auto; padding: 8px 0 16px; font: var(--dsw-font-markdown-code-block); } .columns { display: grid; flex: 1 1 auto; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); min-height: 0; } -.column { min-width: 0; overflow-x: scroll; } +.column { min-width: 0; overflow-x: scroll; overscroll-behavior: none; } .column + .column { border-left: 0.5px solid var(--dsw-alias-border-l3); } .sideLine { display: grid; grid-template-columns: 3.5em max-content; box-sizing: border-box; min-width: 100%; width: max-content; min-height: 22px; line-height: 22px; white-space: pre; } .note { margin: 0; padding: 4px 16px 8px; font: var(--dsw-font-xs-13); color: var(--dsw-alias-label-tertiary); } diff --git a/packages/client/ui-deliverables/src/client/ReviewTab.tsx b/packages/client/ui-deliverables/src/client/ReviewTab.tsx index 01ac90f1fa..a0d159f45b 100644 --- a/packages/client/ui-deliverables/src/client/ReviewTab.tsx +++ b/packages/client/ui-deliverables/src/client/ReviewTab.tsx @@ -312,6 +312,7 @@ function hunkHeader(hunk: WorkspaceDiffHunk): string { * lines and scroll together on both axes, so a long line on one side never * runs under the other and both sides show the same rows and columns of text. * Every line is one fixed-height row, which keeps the sides aligned. + * The columns suppress elastic overscroll while retaining native in-range scrolling. */ function SplitColumns({ hunks, highlights }: { hunks: readonly WorkspaceDiffHunk[]; highlights: readonly HunkHighlights[] }): ReactNode { const paired = useMemo(() => hunks.map(hunk => ({ header: hunkHeader(hunk), rows: splitRows(hunk) })), [hunks]) From 60cdd547ae02f6e33d7190c56ea3b2848ef56f61 Mon Sep 17 00:00:00 2001 From: sjw1231 Date: Mon, 21 Sep 2026 14:45:18 +0800 Subject: [PATCH 3/9] fix(ui-deliverables): preserve filename endings in review headers --- apps/web/tests/changed-files-turn.e2e.ts | 84 ++++++++++++++++- .../client/ui-deliverables/README.i18n.yaml | 4 +- packages/client/ui-deliverables/README.md | 21 +---- packages/client/ui-deliverables/README.zh.md | 21 +---- .../src/client/ReviewTab.module.css | 1 - .../ui-deliverables/src/client/ReviewTab.tsx | 4 +- .../client/ui-primitives/README.i18n.yaml | 4 +- packages/client/ui-primitives/README.md | 1 + packages/client/ui-primitives/README.zh.md | 1 + packages/client/ui-primitives/package.json | 1 + .../ui-primitives/src/PathLabel.module.css | 28 ++++++ .../client/ui-primitives/src/PathLabel.tsx | 41 ++++++++ packages/client/ui-primitives/src/index.ts | 1 + .../tests/path-label.client.spec.tsx | 94 +++++++++++++++++++ packages/client/ui-primitives/tsconfig.json | 5 + .../README.i18n.yaml | 4 +- .../ui-sidebar-documentpreview/README.md | 2 +- .../ui-sidebar-documentpreview/README.zh.md | 2 +- .../src/client/TextPreview.module.css | 30 ------ .../src/client/TextPreview.tsx | 53 +---------- .../tests/text-preview.client.spec.tsx | 50 ---------- pnpm-lock.yaml | 3 + 22 files changed, 277 insertions(+), 178 deletions(-) create mode 100644 packages/client/ui-primitives/src/PathLabel.module.css create mode 100644 packages/client/ui-primitives/src/PathLabel.tsx create mode 100644 packages/client/ui-primitives/tests/path-label.client.spec.tsx diff --git a/apps/web/tests/changed-files-turn.e2e.ts b/apps/web/tests/changed-files-turn.e2e.ts index 0859d3bad3..b645d75d63 100644 --- a/apps/web/tests/changed-files-turn.e2e.ts +++ b/apps/web/tests/changed-files-turn.e2e.ts @@ -7,6 +7,7 @@ import { fileURLToPath } from 'node:url' import { chromium, type Browser, type Page } from 'playwright' import { afterAll, beforeAll, describe, expect, it, onTestFinished } from 'vitest' import type {} from '@deepseek-ai/dsh-workspace-changes' +import type { ChangesSummary } from '../../../packages/client/ui-deliverables/src/changes.ts' import { deriveReplayScript, parseSessionLog } from '@deepseek-ai/dsh-llm-replay' import { assertFinalWorkspaceSnapshot, captureExpandedTurnProcessAria, compareOrRefreshGolden, @@ -58,9 +59,10 @@ describe('web e2e: a git workspace turn ends with its changed files', () => { }) await seedRepository(join(scaffold.workspaceCwd, 'workspace')) browser = await chromium.launch() - page = await browser.newPage({ + const context = await browser.newContext({ viewport: { width: 1680, height: 1000 }, locale: ZH_BROWSER_LOCALE, timezoneId: 'Asia/Shanghai', }) + page = await context.newPage() tripwire = watchConsole(page) await page.goto(scaffold.authenticatedUrl, { waitUntil: 'load' }) await page.waitForSelector('[class*="frame"]') @@ -421,4 +423,84 @@ describe('web e2e: a git workspace turn ends with its changed files', () => { const aria = await captureExpandedTurnProcessAria(page, '[data-chat-flow]', scaffold.workspaceCwd) await compareOrRefreshGolden(join(DIR, 'ui.expected.md'), aria, MODE) }) + + it('preserves filename endings when the review narrows and updates the fade after resizing or selecting another file', async () => { + const preview = await page.context().newPage() + onTestFinished(async () => { await preview.close() }) + const prefix = 'src/components/review/' + 'long-filename-'.repeat(8) + const names = [`${prefix}before.ts`, `${prefix}after.ts`] as const + // Project long display names into a separate page; recorded paths, comparisons, and Session data stay intact. + await preview.route('**/api/changes.summary?*', async (route) => { + const response = await route.fetch() + const summary = await response.json() as ChangesSummary + await route.fulfill({ response, json: { + ...summary, files: summary.files.map((file, index) => ({ ...file, display: names[index] ?? file.display })), + } }) + }) + await preview.goto(scaffold.authenticatedUrl, { waitUntil: 'load' }) + await preview.locator('[data-changed-files]').getByRole('button', { name: '在侧边栏查看本轮改动' }).click() + const review = preview.locator('[data-changes-review]') + const selector = review.getByRole('button', { name: '选择要查看的文件' }) + const label = selector.locator('[data-path-label]') + const layout = await preview.addStyleTag({ content: '[data-sidebar-right-panel] { width: 340px !important; }' }) + const resize = async (width: number) => { + await layout.evaluate((element, width) => { + element.textContent = `[data-sidebar-right-panel] { width: ${width}px !important; }` + }, width) + } + const metrics = () => label.evaluate((element) => { + const text = element.firstElementChild! + const box = element.getBoundingClientRect() + const textBox = text.getBoundingClientRect() + const filename = text.lastElementChild! + const suffix = document.createRange() + const node = filename.firstChild! + suffix.setStart(node, Math.max(0, node.textContent!.length - 'before.ts'.length)) + suffix.setEnd(node, node.textContent!.length) + const suffixBox = suffix.getBoundingClientRect() + return { + clipped: element.hasAttribute('data-path-clipped'), mask: getComputedStyle(element).maskImage, + left: textBox.left - box.left, right: box.right - textBox.right, + suffixVisible: suffixBox.left >= box.left && suffixBox.right <= box.right + 0.5, + directoryColor: getComputedStyle(text.firstElementChild!).color, + nameColor: getComputedStyle(filename).color, + } + }) + await expect.poll(async () => (await metrics()).clipped).toBe(true) + const clipped = await metrics() + expect(clipped.left).toBeLessThan(0) + expect(Math.abs(clipped.right)).toBeLessThanOrEqual(0.5) + expect(clipped.suffixVisible).toBe(true) + expect(clipped.mask).toContain('linear-gradient') + expect(clipped.directoryColor).not.toBe(clipped.nameColor) + expect(await label.getAttribute('title')).toBe(names[0]) + const controls = await selector.evaluate((button) => { + const header = button.parentElement!.parentElement! + const bounds = header.getBoundingClientRect() + const caret = button.querySelector('svg')! + const counts = button.parentElement!.nextElementSibling! + return [caret, counts, ...header.querySelectorAll('[data-review-tool]')].map((element) => { + const box = element.getBoundingClientRect() + return box.width > 0 && box.left >= bounds.left && box.right <= bounds.right + }) + }) + expect(controls.every(Boolean)).toBe(true) + await selector.click() + await preview.getByRole('menuitem').filter({ hasText: names[1] }).click() + await expect.poll(() => label.getAttribute('title')).toBe(names[1]) + expect((await metrics()).suffixVisible).toBe(true) + await resize(1400) + await expect.poll(async () => (await metrics()).clipped).toBe(false) + expect((await metrics()).left).toBeCloseTo(0, 1) + expect((await metrics()).mask).toBe('none') + await resize(340) + await expect.poll(async () => (await metrics()).clipped).toBe(true) + await selector.click() + await preview.getByRole('menuitem').filter({ hasText: 'src/util.ts' }).click() + await expect.poll(() => label.getAttribute('title')).toBe('src/util.ts') + await expect.poll(async () => (await metrics()).clipped).toBe(false) + expect((await metrics()).left).toBeCloseTo(0, 1) + expect((await metrics()).mask).toBe('none') + }) + }) diff --git a/packages/client/ui-deliverables/README.i18n.yaml b/packages/client/ui-deliverables/README.i18n.yaml index 67d40a19a0..dbc8d93e71 100644 --- a/packages/client/ui-deliverables/README.i18n.yaml +++ b/packages/client/ui-deliverables/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-deliverables/README.md -README.md: 7f2dd84bdab443c22b23ec62b87b35306e4eb360 -README.zh.md: ab3f351ce1f0499bc6abcbbd18eb7bcc5860d8a1 +README.md: d3f0d391380f6f4ae9c95fdc8c0b4e8c4b00654a +README.zh.md: 1c25199512b5c97f041954995cf45452e58706ff diff --git a/packages/client/ui-deliverables/README.md b/packages/client/ui-deliverables/README.md index 7f2dd84bda..d3f0d39138 100644 --- a/packages/client/ui-deliverables/README.md +++ b/packages/client/ui-deliverables/README.md @@ -44,6 +44,8 @@ The card renders the summary the Host serves for the turn's latest `workspace/ch A row opens the turn's `changes-review` tab, addressed by the viewed Session and the announcing event's sequence and titled by the turn, on that row's file; another row of the same card reveals the same tab on its file. The header's file selector lists every recorded file with its counts and switches the comparison. A new tab starts in the side-by-side view without wrapping. Its controls switch between unified and side-by-side comparison, toggle line wrapping, open the whole current file in the Sidebar, and, with a Host desktop available, open it in the default application with the same pending and retryable-error states as the cards; the view and wrap choices are kept per tab. The tab reads the summary and each comparison once through the authenticated routes. A text comparison lists its hunks with the old and new line numbers of every line, and highlights each rendered hunk side independently with the code preview's filename grammar and Shiki token colours. Additions and deletions use aligned success or error markers and background tints. The tab also shows a note when the file was created or deleted in the turn, when both sides hold the same lines, when the Host's line comparison timed out and every line shows as replaced, or when the tab stopped drawing at 5,000 lines. A binary or oversized file, a comparison the Host no longer serves, and a failed read each show one line instead; a failed read offers Retry. The comparison is the turn's snapshot of the file, not its current content. +The selected-file title uses the document preview’s [`PathLabel`](../ui-primitives/README.md#component-catalog): complete and left-aligned when it fits, otherwise clipped at the left with a fade that preserves trailing characters and the extension. Directories use subdued text, the filename uses primary text, and hovering reveals the complete displayed path. Resizing the pane or selecting another file updates the fade; the dropdown arrow, line counts, and toolbar actions retain their space. + Without wrapping, the two columns synchronize vertical scrolling and horizontal offsets up to each side’s available range. Both columns suppress elastic edge feedback and scroll chaining on both axes; the browser retains control of native momentum within each column’s scrollable range. Both horizontal scrollbars remain at the bottom of the visible comparison; scrolling vertically preserves a long line’s horizontal offset when the other side fits without horizontal scrolling. ### Inline-code links @@ -117,23 +119,4 @@ These limits define the current deliverables vocabulary. They are current packag ### Dev Note -
-Working context for maintainers — click to expand - -Working context for Issue #4670: filename presentation remains unimplemented. The proposed filename behavior below is not a shipped guarantee. - -**Reported reproduction.** In macOS Chrome, open a completed turn's changed-file review with enough changed rows and long lines to scroll on both axes. Keep the pointer over either column and flick the trackpad toward each edge. The user reports that the operated column rebounds beyond the edge while the other stays at its limit. A long selected-file path also hides its filename suffix; the document preview provides the requested reference appearance. - -**Scroll verification.** The [recorded-session browser case](../../../apps/web/tests/changed-files-turn.e2e.ts) covers containment at all four edges from either column, reverse scrolling, and unequal horizontal ranges. On 2026-09-21, the reporting user confirmed with a real macOS trackpad in Chrome that edge rebound is absent and normal momentum remains. - -**Planned filename behavior.** Give the selected-file title the document preview's path presentation: left-aligned complete text when it fits; preserved trailing characters and extension with a left-edge fade only when clipped; subdued directories and normal filename text; and the complete displayed path on hover. Follow the layout and overflow measurement in [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) and [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css). Recalculate clipping when the selected file or available width changes. Keep the selector arrow, line counts, and action buttons visible. Any shared presentation component belongs in `ui-primitives`, rather than a component import between feature plugins. - -**Acceptance criteria.** - -- Short titles remain complete and unfaded. Narrowing the pane preserves long filename endings with a left fade; widening it removes the fade once the path fits. Switching between files with matching prefixes and different suffixes keeps their endings distinguishable. The title remains selectable through the file menu, with the full displayed path available on hover. - -**Remaining verification.** Extend the browser case for filename clipping, and add focused [component coverage](tests/review-tab.client.spec.tsx) for any new title behavior that does not require browser layout. Once the filename fix is verified, update the review-tab usage section and affected JSDoc, then remove this draft. - -
- **Runtime invariant:** No companion is published. Prompt, slot, dictionary, file-action route, and optional service registrations are effect-owned; the Session log owns declarations and the filesystem owns file contents. diff --git a/packages/client/ui-deliverables/README.zh.md b/packages/client/ui-deliverables/README.zh.md index ab3f351ce1..1c25199512 100644 --- a/packages/client/ui-deliverables/README.zh.md +++ b/packages/client/ui-deliverables/README.zh.md @@ -44,6 +44,8 @@ Web 的 `standard`、`ptc` 与 `cordis` preset 提供 `present` 用于声明交 行在该行的文件上打开本轮的 `changes-review` tab，其地址由当前查看的 Session 和宣告事件的序号组成，以轮号作标题；同一张卡片的另一行会在其文件上显示同一个 tab。头部的文件选择器列出所有记录的文件及其行数，用于切换对比。新 tab 默认使用不换行的左右对比。其控件用于切换单栏或左右对比、切换自动换行、在 Sidebar 中打开当前完整文件，并在 Host 有桌面时用默认应用打开文件；原生打开的等待与可重试错误状态与卡片一致，视图和换行选择按 tab 保留。tab 通过经过认证的路由各读取一次摘要和每个对比。文本对比逐个列出 hunk，每一行带旧侧和新侧的行号，并按代码预览的文件名 grammar 与 Shiki token 色分别高亮每个已渲染 hunk 的两侧。新增与删除使用对齐的成功色或错误色标记和背景色。文件是本轮新建或删除、两侧内容相同、Host 的逐行对比超时而按整文件替换显示，或 tab 在 5000 行处停止绘制时，tab 还会给出一行说明。二进制或过大的文件、Host 已不再提供的对比，以及读取失败各显示一行提示；读取失败时提供重试。对比是本轮对该文件的快照，不是它当前的内容。 +当前文件标题使用文档预览页的 [`PathLabel`](../ui-primitives/README.zh.md#component-catalog)：空间足够时完整靠左显示，否则从左侧裁剪并渐隐，保留尾部字符和扩展名。目录使用弱化颜色，文件名使用主色，悬停显示完整路径。调整面板宽度或切换文件时更新渐隐；下拉箭头、行数和工具栏操作保留各自的空间。 + 关闭自动换行时，两列同步纵向滚动，横向偏移同步到各自可滚动范围内。两列在双轴上都禁用弹性边缘反馈和向外层传递滚动；各列可滚动范围内的原生惯性仍由浏览器控制。两侧横向滚动条始终位于可见对比区域底部；如果只有一侧需要横向滚动，上下滚动会保留该侧的横向偏移。 ### 行内代码链接 @@ -117,23 +119,4 @@ Node 半部注册[模型体验](#model-experience)所述的静态 `ui:deliverabl ### 开发备注 -
-维护者的工作上下文——点击展开 - -Issue #4670 的工作上下文：文件名展示尚未实现。下述拟议的文件名行为不是已交付保证。 - -**已报告的复现。** 在 macOS Chrome 中打开已完成轮次的改动文件 review，改动行数与单行长度足以支持双轴滚动。鼠标停在任一列，用触控板快速滑向各个边缘。用户报告，接受操作的一列会越过边缘回弹，另一列停在滚动终点。选中文件的路径过长时还会隐藏文件名尾部；文档预览提供了期望的参考效果。 - -**滚动验证。** [录制会话浏览器用例](../../../apps/web/tests/changed-files-turn.e2e.ts)覆盖从任一列向四个边缘滚动时的限制、反向滚动与不等的横向范围。2026-09-21，报告问题的用户在 Chrome 中使用真实 macOS 触控板确认，边缘回弹消失，正常惯性保留。 - -**计划中的文件名行为。** 选中文件的标题采用文档预览的路径展示：空间足够时完整靠左显示；裁切时保留尾部字符与扩展名，且仅在左侧渐隐；目录使用弱化颜色，文件名使用正常文字颜色；悬停显示完整的展示路径。沿用 [TextPreview.tsx](../ui-sidebar-documentpreview/src/client/TextPreview.tsx) 与 [TextPreview.module.css](../ui-sidebar-documentpreview/src/client/TextPreview.module.css) 的布局和溢出测量方式。所选文件或可用宽度变化时重新判断裁切。选择器箭头、行数统计与操作按钮保持可见。若提取共享展示组件，应放入 `ui-primitives`，而不是在功能插件之间导入组件。 - -**验收条件。** - -- 短标题完整显示且不渐隐。缩窄面板时，长文件名保留尾部并在左侧渐隐；加宽到路径可完整显示时渐隐消失。在前缀相同、后缀不同的文件之间切换，仍能辨认各自尾部。文件菜单仍能选择标题对应的文件，悬停可查看完整展示路径。 - -**剩余验证。** 扩展浏览器用例以覆盖文件名裁切，并对不依赖浏览器布局的新标题行为补充聚焦的[组件覆盖](tests/review-tab.client.spec.tsx)。文件名修复通过验证后，更新 review tab 使用说明与相关 JSDoc，再删除本草稿。 - -
- **运行时不变式：** 不发布伴生入口。提示词、slot、dictionary、文件操作路由与可选 service 注册归 effect 所有；Session 日志拥有声明，文件系统拥有文件内容。 diff --git a/packages/client/ui-deliverables/src/client/ReviewTab.module.css b/packages/client/ui-deliverables/src/client/ReviewTab.module.css index cb859fb52e..ae2c996cbb 100644 --- a/packages/client/ui-deliverables/src/client/ReviewTab.module.css +++ b/packages/client/ui-deliverables/src/client/ReviewTab.module.css @@ -7,7 +7,6 @@ .selectorButton { display: inline-flex; gap: 4px; align-items: center; box-sizing: border-box; max-width: 100%; height: 28px; padding: 0 6px 0 8px; border: 0; border-radius: 8px; background: transparent; color: var(--dsw-alias-label-primary); cursor: pointer; font: inherit; font-size: 12px; line-height: 20px; } .selectorButton:hover, .selectorButton[aria-expanded='true'] { background: var(--dsw-alias-interactive-bg-hover); } .selectorButton svg { display: block; flex: none; } -.selectorText { min-width: 0; overflow: hidden; line-height: 20px; text-overflow: ellipsis; white-space: nowrap; } .item { display: flex; gap: 12px; align-items: center; justify-content: space-between; min-width: 0; } .itemPath { min-width: 0; overflow: hidden; line-height: 20px; text-overflow: ellipsis; white-space: nowrap; } .itemCounts, .counts { display: inline-flex; flex: none; gap: 6px; align-items: center; font-family: var(--ds-font-family-code); font-size: 12px; line-height: 20px; color: var(--dsw-alias-label-tertiary); } diff --git a/packages/client/ui-deliverables/src/client/ReviewTab.tsx b/packages/client/ui-deliverables/src/client/ReviewTab.tsx index a0d159f45b..4828df79fb 100644 --- a/packages/client/ui-deliverables/src/client/ReviewTab.tsx +++ b/packages/client/ui-deliverables/src/client/ReviewTab.tsx @@ -7,7 +7,7 @@ import { useEffect, useMemo, useRef, useState } from 'react' import type { ReactNode, UIEvent } from 'react' import { Button, IconChevronDownOutlineRegular, IconCompareSplitOutlineRegular, IconInspectOutlineRegular, - IconNowrapFillRegular, IconRightUpOutlineRegular, IconWrapFillRegular, Menu, Tooltip, + IconNowrapFillRegular, IconRightUpOutlineRegular, IconWrapFillRegular, Menu, PathLabel, Tooltip, languageForPath, useCodeHighlighter, } from '@deepseek-ai/dsh-client-ui-primitives' import type { CodeHighlighter, HighlightSpan } from '@deepseek-ai/dsh-client-ui-primitives' @@ -239,7 +239,7 @@ export function ReviewTab({ anchor={} items={files.map((entry, at) => ({ id: String(at), label: diff --git a/packages/client/ui-primitives/README.i18n.yaml b/packages/client/ui-primitives/README.i18n.yaml index 52a8d99d49..12730640f8 100644 --- a/packages/client/ui-primitives/README.i18n.yaml +++ b/packages/client/ui-primitives/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-primitives/README.md -README.md: 09950210eaef57a290362037f3d603366fe00168 -README.zh.md: aa95cbf1ce7fa79c3d1d5466ca8ed4d6942ad03e +README.md: 725bb8c10d2f93cb183d03a4ef0eff01921c404b +README.zh.md: b1b6df5ad171a37abbbb8931c728c2c5bd2a6c52 diff --git a/packages/client/ui-primitives/README.md b/packages/client/ui-primitives/README.md index 09950210ea..725bb8c10d 100644 --- a/packages/client/ui-primitives/README.md +++ b/packages/client/ui-primitives/README.md @@ -44,6 +44,7 @@ Check this table before writing a control in a feature package. A plugin cannot | `Pill` | Selectable capsule button for view switchers and filters; takes `active` and `onClick`. | | `SegmentedTabs` | Controlled equal-width tabs with a sliding indicator and Left/Right, Home, and End navigation. The caller supplies labels, tab/panel ids, and panel content. | | `Tag` | Read-only capsule badge; `tone` selects one of eight palettes. | +| `PathLabel` | Single-line file path with subdued directories, a primary filename, and the full path on hover. Fitting paths align left; clipped paths preserve their suffix with a left-edge fade that updates on path and size changes. | | `StateDot` | Solid green `done`, amber `warning`, red `error`, and neutral-grey `idle` marks in a 10px slot, plus a tertiary-grey 14px rotating `ongoing` loader. `aria-hidden`, so the render site owns the name. | | `ConnectionIndicator` | Inline connection-recovery control across outage, retry, and recovered states. | | `DisclosureRow` | 24px compact disclosure that lays title and content side by side. | diff --git a/packages/client/ui-primitives/README.zh.md b/packages/client/ui-primitives/README.zh.md index aa95cbf1ce..b1b6df5ad1 100644 --- a/packages/client/ui-primitives/README.zh.md +++ b/packages/client/ui-primitives/README.zh.md @@ -44,6 +44,7 @@ kind: "package-library" | `Pill` | 可选中的胶囊按钮，用于视图切换与筛选器；接受 `active` 与 `onClick`。 | | `SegmentedTabs` | 受控的等宽分段标签，支持滑动指示条及左／右方向键、Home、End 导航。调用方提供文案、标签与面板 id，以及面板内容。 | | `Tag` | 只读胶囊徽章；`tone` 选择八种配色之一。 | +| `PathLabel` | 单行文件路径：目录使用弱化颜色，文件名使用主色，悬停可查看完整路径。空间足够时靠左显示；溢出时保留尾部并在左侧渐隐，路径或尺寸变化时更新。 | | `StateDot` | 10px 槽内的绿色 `done`、琥珀色 `warning`、红色 `error`、中性灰色 `idle` 圆点，以及 tertiary 灰色 14px 旋转 `ongoing` loading。它是 `aria-hidden` 的，名称由渲染点提供。 | | `ConnectionIndicator` | 行内连接恢复控件，覆盖断线、重试与已恢复三种状态。 | | `DisclosureRow` | 24px 紧凑折叠行，标题与内容左右排列。 | diff --git a/packages/client/ui-primitives/package.json b/packages/client/ui-primitives/package.json index 1e6b7de54e..4b61f4e8ff 100644 --- a/packages/client/ui-primitives/package.json +++ b/packages/client/ui-primitives/package.json @@ -38,6 +38,7 @@ "micromark-util-symbol": "^2.0.1", "micromark-util-types": "^2.0.2", "shiki": "^4.3.1", + "@deepseek-ai/dsh-util-workspace-path": "workspace:^", "@shikijs/langs": "^4.3.1", "@types/mdast": "^4.0.4", "micromark-factory-space": "^2.0.1", diff --git a/packages/client/ui-primitives/src/PathLabel.module.css b/packages/client/ui-primitives/src/PathLabel.module.css new file mode 100644 index 0000000000..add09a8550 --- /dev/null +++ b/packages/client/ui-primitives/src/PathLabel.module.css @@ -0,0 +1,28 @@ +/* Auto margin keeps fitting text at the left. On overflow it becomes zero, + so flex-end preserves the filename suffix at the right edge. */ +.path { + display: flex; + flex: 1 1 auto; + justify-content: flex-end; + min-width: 0; + overflow: hidden; + font-size: 12px; + white-space: nowrap; +} + +.path[data-path-clipped] { + mask-image: linear-gradient(to right, transparent, black 28px); +} + +.text { + flex: none; + margin-right: auto; +} + +.directory { + color: var(--dsw-alias-label-tertiary); +} + +.name { + color: var(--dsw-alias-label-primary); +} diff --git a/packages/client/ui-primitives/src/PathLabel.tsx b/packages/client/ui-primitives/src/PathLabel.tsx new file mode 100644 index 0000000000..386324d21d --- /dev/null +++ b/packages/client/ui-primitives/src/PathLabel.tsx @@ -0,0 +1,41 @@ +/** A single-line file path whose trailing characters remain visible in narrow toolbars. */ +import { useLayoutEffect, useRef, type HTMLAttributes } from 'react' +import clsx from 'clsx' +import { pathPartsOf } from '@deepseek-ai/dsh-util-workspace-path' +import css from './PathLabel.module.css' + +/** + * Render subdued directories and a primary filename, with the complete path on hover. + * Fitting text is left-aligned; overflow clips and fades at the left edge. + * The fade updates on path changes and, when ResizeObserver is available, size changes. + * @param props - File path and attributes for its outer span; callers own toolbar spacing. + * @returns the path label. + */ +export function PathLabel({ path, className, ...attributes }: { + path: string +} & Omit, 'children' | 'title'>) { + const boxRef = useRef(null) + const textRef = useRef(null) + const { directory, name } = pathPartsOf(path) + useLayoutEffect(() => { + const outer = boxRef.current + const inner = textRef.current + if (outer === null || inner === null) return undefined + const apply = (): void => { + outer.toggleAttribute('data-path-clipped', inner.offsetWidth > outer.clientWidth) + } + apply() + const observer = typeof ResizeObserver === 'undefined' ? undefined : new ResizeObserver(apply) + observer?.observe(outer) + observer?.observe(inner) + return () => { observer?.disconnect() } + }, [path]) + return ( + + + {directory !== '' && {directory}} + {name} + + + ) +} diff --git a/packages/client/ui-primitives/src/index.ts b/packages/client/ui-primitives/src/index.ts index 25ba54ea24..affdd22985 100644 --- a/packages/client/ui-primitives/src/index.ts +++ b/packages/client/ui-primitives/src/index.ts @@ -12,6 +12,7 @@ export { Pill } from './Pill.tsx' export { SegmentedTabs } from './SegmentedTabs.tsx' export type { SegmentedTab } from './SegmentedTabs.tsx' export { Tag } from './Tag.tsx' +export { PathLabel } from './PathLabel.tsx' export type { TagTone } from './Tag.tsx' export { Switch } from './Switch.tsx' export { Checkbox } from './Checkbox.tsx' diff --git a/packages/client/ui-primitives/tests/path-label.client.spec.tsx b/packages/client/ui-primitives/tests/path-label.client.spec.tsx new file mode 100644 index 0000000000..3336338b68 --- /dev/null +++ b/packages/client/ui-primitives/tests/path-label.client.spec.tsx @@ -0,0 +1,94 @@ +// @vitest-environment jsdom +/** Path labels retain their full hover text and update clipping with layout and file changes. */ +import { act, cleanup, render } from '@testing-library/react' +import { afterEach, describe, expect, it, vi } from 'vitest' +import { PathLabel } from '../src/PathLabel.tsx' + +afterEach(() => { + cleanup() + vi.unstubAllGlobals() + vi.restoreAllMocks() +}) + +describe('PathLabel', () => { + it.each([ + ['src/filename.ts', 'src/', 'filename.ts'], + ['C:\\src\\filename.ts', 'C:\\src\\', 'filename.ts'], + ['filename.ts', '', 'filename.ts'], + ])('shows %s with a separate filename and full hover text', (path, directory, name) => { + const view = render() + const label = view.getByTestId('path') + expect(label.textContent).toBe(path) + expect(label.title).toBe(path) + expect(label.classList.contains('placement')).toBe(true) + expect(label.firstElementChild?.lastElementChild?.textContent).toBe(name) + expect(label.firstElementChild?.children.length).toBe(directory === '' ? 1 : 2) + }) + + it('marks the path clipped while its text is wider than its box, re-reading on resize', () => { + class FakeResizeObserver implements ResizeObserver { + static latest: FakeResizeObserver | undefined + readonly observe = vi.fn() + readonly unobserve = vi.fn() + readonly disconnect = vi.fn() + constructor(private readonly callback: ResizeObserverCallback) { + FakeResizeObserver.latest = this + } + + fire(): void { + this.callback([], this) + } + } + vi.stubGlobal('ResizeObserver', FakeResizeObserver) + let boxWidth = 300 + const offsetWidth = Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'offsetWidth') + const clientWidth = Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'clientWidth') + Object.defineProperty(HTMLElement.prototype, 'offsetWidth', { configurable: true, get: () => 200 }) + Object.defineProperty(HTMLElement.prototype, 'clientWidth', { configurable: true, get: () => boxWidth }) + try { + const view = render() + const path = view.container.querySelector('[data-path-label]') + const text = path?.firstElementChild + expect(path?.hasAttribute('data-path-clipped')).toBe(false) + const observer = FakeResizeObserver.latest + if (observer === undefined) throw new Error('expected the path to observe its size') + expect(observer.observe).toHaveBeenCalledWith(path) + expect(observer.observe).toHaveBeenCalledWith(text) + + boxWidth = 120 + act(() => { observer.fire() }) + expect(path?.hasAttribute('data-path-clipped')).toBe(true) + + boxWidth = 300 + act(() => { observer.fire() }) + expect(path?.hasAttribute('data-path-clipped')).toBe(false) + view.unmount() + expect(observer.disconnect).toHaveBeenCalledTimes(1) + } finally { + vi.unstubAllGlobals() + for (const [name, descriptor] of [['offsetWidth', offsetWidth], ['clientWidth', clientWidth]] as const) { + if (descriptor === undefined) Reflect.deleteProperty(HTMLElement.prototype, name) + else Object.defineProperty(HTMLElement.prototype, name, descriptor) + } + } + }) + + it('rechecks clipping and hover text immediately when the selected path changes without ResizeObserver', () => { + vi.stubGlobal('ResizeObserver', undefined) + vi.spyOn(HTMLElement.prototype, 'offsetWidth', 'get').mockImplementation(function (this: HTMLElement) { + return (this.textContent?.length ?? 0) * 10 + }) + vi.spyOn(HTMLElement.prototype, 'clientWidth', 'get').mockReturnValue(100) + const view = render() + const label = view.container.querySelector('[data-path-label]')! + expect(label.hasAttribute('data-path-clipped')).toBe(false) + view.rerender() + expect(label.hasAttribute('data-path-clipped')).toBe(true) + expect(label.title).toBe('src/long-filename-before.ts') + view.rerender() + expect(label.textContent).toBe('src/long-filename-after.ts') + view.rerender() + expect(label.hasAttribute('data-path-clipped')).toBe(false) + expect(label.title).toBe('b.ts') + }) +}) diff --git a/packages/client/ui-primitives/tsconfig.json b/packages/client/ui-primitives/tsconfig.json index efd9866d5e..b589ca31b1 100644 --- a/packages/client/ui-primitives/tsconfig.json +++ b/packages/client/ui-primitives/tsconfig.json @@ -9,5 +9,10 @@ ], "exclude": [ "**/*.legacy.*" + ], + "references": [ + { + "path": "../../util/workspace-path" + } ] } diff --git a/packages/client/ui-sidebar-documentpreview/README.i18n.yaml b/packages/client/ui-sidebar-documentpreview/README.i18n.yaml index 141c7e0474..00a5560428 100644 --- a/packages/client/ui-sidebar-documentpreview/README.i18n.yaml +++ b/packages/client/ui-sidebar-documentpreview/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-sidebar-documentpreview/README.md -README.md: 2797d6fd6be8f429043c8de1413f90e64bda3876 -README.zh.md: a04571ed6d76ca812aa0a70ce6f3c403ad80947d +README.md: cda3e8bb4fa2c4228028e48fcd4508a4a343471e +README.zh.md: b4959526beb8d0830d0fce79d60f5da2c6ac73ae diff --git a/packages/client/ui-sidebar-documentpreview/README.md b/packages/client/ui-sidebar-documentpreview/README.md index 2797d6fd6b..cda3e8bb4f 100644 --- a/packages/client/ui-sidebar-documentpreview/README.md +++ b/packages/client/ui-sidebar-documentpreview/README.md @@ -28,7 +28,7 @@ Preview files in the right Sidebar and choose among registered renderers. Markdo ## What it registers - **The type** — `ctx.sidebarRightTabs.register(...)` with id `@deepseek-ai/dsh-client-ui-sidebar-documentpreview` (this implementation's identity in the tab system, and the key its body registers under), kind `text`, pattern `dsh-resource://file/**`, band `fallback`. `canOpen` accepts only Session addresses, whose paths may be relative or absolute; bare `absolute` addresses are not claimed. A type registered at the `extension` or `builtin` band for a narrower pattern (say `*.png`) takes those addresses; other supported files land here. The whole address is the content identity, so two files with one name in different directories, or one path under two sessions, are two tabs; the decoded basename is the tab title, and the keyed `sidebar.right.pane.tab.title` seat places its extension-specific `FileTypeIcon` before that title. -- **The body** — the keyed `sidebar.right.pane.tab` seat under the type's id. Its fixed header shows the Host's absolute path when available, otherwise the requested path; directories use tertiary label colour, the name uses primary label colour, and a clipped path retains and fades toward its final segment while its tooltip exposes the full value. A dropdown appears when multiple supported renderers are available. Plain text is offered only for text-compatible sources; a single renderer shows no viewer control. A known binary container suffix without a registered renderer shows the file-type icon and an unsupported-preview message under the path header, without issuing a read. Two Session-scoped list child slots hand the previewed file to other plugins once its metadata reports a Host path, both with `absolutePath` as the owner prop: `sidebar.right.tab.document.actions` renders after the header's own controls in every state that shows the header, and `sidebar.right.tab.document.unpreviewable` renders in the unsupported empty state and in the empty state of a readable file the preview cannot render (`not-text`, `too-large`), where Retry would otherwise stand; a carrier or unclassified read failure keeps Retry, and a missing or non-regular path offers only its explanation. The shipped occupant of both is [`ui-open-in-app`](../ui-open-in-app/README.md). A wrap toggle appears only when the selected renderer declares `wrap: true`; its glyph describes the mode the click selects, and the per-tab preference starts on. Reload stays in this header, not the Sidebar's tab strip. Automatic refresh defaults to enabled; its separate toggle is hidden, with state, labels, styles, and toggle logic retained. The body reaches every pane edge; each renderer owns its content inset and may own an inner scrollport. This intentionally differs from the Files tab's 2px right-side scrollbar offset: previews keep the full pane width so edge-to-edge HTML and code scrollports end at the pane edge. +- **The body** — the keyed `sidebar.right.pane.tab` seat under the type's id. Its fixed header shows the Host's absolute path when available, otherwise the requested path; the shared [`PathLabel`](../ui-primitives/README.md#component-catalog) subdues directories, preserves a clipped path’s trailing characters with a left-edge fade, and exposes the full value on hover. A dropdown appears when multiple supported renderers are available. Plain text is offered only for text-compatible sources; a single renderer shows no viewer control. A known binary container suffix without a registered renderer shows the file-type icon and an unsupported-preview message under the path header, without issuing a read. Two Session-scoped list child slots hand the previewed file to other plugins once its metadata reports a Host path, both with `absolutePath` as the owner prop: `sidebar.right.tab.document.actions` renders after the header's own controls in every state that shows the header, and `sidebar.right.tab.document.unpreviewable` renders in the unsupported empty state and in the empty state of a readable file the preview cannot render (`not-text`, `too-large`), where Retry would otherwise stand; a carrier or unclassified read failure keeps Retry, and a missing or non-regular path offers only its explanation. The shipped occupant of both is [`ui-open-in-app`](../ui-open-in-app/README.md). A wrap toggle appears only when the selected renderer declares `wrap: true`; its glyph describes the mode the click selects, and the per-tab preference starts on. Reload stays in this header, not the Sidebar's tab strip. Automatic refresh defaults to enabled; its separate toggle is hidden, with state, labels, styles, and toggle logic retained. The body reaches every pane edge; each renderer owns its content inset and may own an inner scrollport. This intentionally differs from the Files tab's 2px right-side scrollbar offset: previews keep the full pane width so edge-to-edge HTML and code scrollports end at the pane edge. - **Shared loading and view state**, session-scoped and bucketed by tab id. The store holds accumulated pages or complete bytes, read and observed versions, pending Resource changes, automatic-refresh state, loading/failure state, renderer choice, scroll offset, wrap, and the answered navigation revision. The ordinary inject face calls Remote readers and writes through declared store actions. Reloads and loading-mode changes retire older requests; the tab's abort signal forgets its state. Document implementations register metadata with `ctx.documentPreviews.register({ id, extensions, binaryExtensions?, priority, title, loading, wrap? })` and a body under the same `id` in the keyed, Session-scoped `sidebar.right.tab.document` child slot. `binaryExtensions` lists suffixes in `extensions` that cannot be read as text and omit the plain-text option. Own both registrations with effects and wait for the child slot through `ctx.slots.inject`. Bodies receive `resourceAddress`, `content`, `wrap`, `scrollportRef`, `addResource`, `setResources`, and the standard `useTabInfo`/`useResource` hooks. Dependency membership belongs to a tab-owned `ResourceGroup`; replacing dependencies always retains the root Resource. An inner scrolling element attaches `scrollportRef`; unmounting restores the shared body as scroll owner. The registry retains all matching alternatives: `extension` (the default) ranks above `builtin`, then longer suffixes rank first, then registration order. The dropdown preserves a selected implementation while it remains available. HTML, SVG, and unmatched extensions retain the plain-text fallback independently of loading mode. diff --git a/packages/client/ui-sidebar-documentpreview/README.zh.md b/packages/client/ui-sidebar-documentpreview/README.zh.md index a04571ed6d..b4959526be 100644 --- a/packages/client/ui-sidebar-documentpreview/README.zh.md +++ b/packages/client/ui-sidebar-documentpreview/README.zh.md @@ -28,7 +28,7 @@ kind: "package-reference" ## 注册了什么 - **类型** —— `ctx.sidebarRightTabs.register(...)`，id 为 `@deepseek-ai/dsh-client-ui-sidebar-documentpreview`（这个实现在 tab 系统中的身份，也是其正文注册所用的键），kind `text`，pattern `dsh-resource://file/**`，档位 `fallback`。`canOpen` 只接受 Session 地址，其中路径可为相对或绝对路径；不认领裸 `absolute` 地址。在 `extension` 或 `builtin` 档以更窄 pattern（比如 `*.png`）注册的类型接走那些地址；其他受支持文件落到这里。整个地址就是内容身份，所以不同目录下同名的两个文件、或同一路径在两个会话之下，是两个 tab；解码后的 basename 是 tab 标题，keyed slot `sidebar.right.pane.tab.title` 会在标题前放置按扩展名选择的 `FileTypeIcon`。 -- **正文** —— keyed slot `sidebar.right.pane.tab`，键为类型的 id。固定头部在可用时显示 Host 的绝对路径，否则显示请求路径；目录使用三级标签色，文件名使用一级标签色，路径过长时保留末段并向开头淡出，提示中仍提供完整值。有多个受支持的渲染器时才显示下拉菜单。仅文本兼容的源文件提供纯文本选项；只有一个渲染器时不显示查看器控件。已知的二进制容器后缀没有注册渲染器时，在路径头部下方显示文件类型图标和不支持预览的说明，并且不会发起读取。两个 Session 作用域的 list 子 slot 在文件元数据报出 Host 路径后把当前文件交给其他插件，owner prop 为 `absolutePath`：`sidebar.right.tab.document.actions` 在每个显示头部的状态里渲染在头部自有控件之后；`sidebar.right.tab.document.unpreviewable` 渲染在不支持预览的空态里，以及可读但本预览无法渲染的文件（`not-text`、`too-large`）的空态里，占据原本放重试的位置；载体或未分类的读取失败仍保留重试，不存在或非普通文件的路径只给说明。两者已发布的占位者都是 [`ui-open-in-app`](../ui-open-in-app/README.zh.md)。仅当所选渲染器声明 `wrap: true` 时显示换行开关；图标表示点击后切换到的模式，该偏好按 tab 保存，初始开启。重新载入仍在此头部，不放入 Sidebar 的 tab 条。自动刷新默认开启；独立开关暂时隐藏，状态、文案、样式与切换逻辑保留。正文贴合格的每条边，各渲染器自行提供内容留白，并可拥有内部滚动区。这与 Files tab 右侧预留 2px 滚动条间距的布局有意不同：Preview 使用格的完整宽度，使贴边 HTML 与代码滚动区终止于格的边缘。 +- **正文** —— keyed slot `sidebar.right.pane.tab`，键为类型的 id。固定头部在可用时显示 Host 的绝对路径，否则显示请求路径；共享的 [`PathLabel`](../ui-primitives/README.zh.md#component-catalog) 弱化目录颜色，以左侧渐隐保留被裁剪路径的尾部字符，并在悬停时展示完整值。有多个受支持的渲染器时才显示下拉菜单。仅文本兼容的源文件提供纯文本选项；只有一个渲染器时不显示查看器控件。已知的二进制容器后缀没有注册渲染器时，在路径头部下方显示文件类型图标和不支持预览的说明，并且不会发起读取。两个 Session 作用域的 list 子 slot 在文件元数据报出 Host 路径后把当前文件交给其他插件，owner prop 为 `absolutePath`：`sidebar.right.tab.document.actions` 在每个显示头部的状态里渲染在头部自有控件之后；`sidebar.right.tab.document.unpreviewable` 渲染在不支持预览的空态里，以及可读但本预览无法渲染的文件（`not-text`、`too-large`）的空态里，占据原本放重试的位置；载体或未分类的读取失败仍保留重试，不存在或非普通文件的路径只给说明。两者已发布的占位者都是 [`ui-open-in-app`](../ui-open-in-app/README.zh.md)。仅当所选渲染器声明 `wrap: true` 时显示换行开关；图标表示点击后切换到的模式，该偏好按 tab 保存，初始开启。重新载入仍在此头部，不放入 Sidebar 的 tab 条。自动刷新默认开启；独立开关暂时隐藏，状态、文案、样式与切换逻辑保留。正文贴合格的每条边，各渲染器自行提供内容留白，并可拥有内部滚动区。这与 Files tab 右侧预留 2px 滚动条间距的布局有意不同：Preview 使用格的完整宽度，使贴边 HTML 与代码滚动区终止于格的边缘。 - **共享加载与视图状态**，会话作用域、按 tab id 分桶。store 持有累计页或完整字节、读取与观察版本、待处理 Resource 变化、自动刷新状态、加载/失败状态、渲染器选择、滚动位置、换行和已响应的导航 revision。普通 inject face 调用 Remote 读取，并经声明的 store action 写入。重新载入和加载模式变化会淘汰旧请求；tab 的中止信号清理其状态。 文档实现在 `ctx.documentPreviews.register({ id, extensions, binaryExtensions?, priority, title, loading, wrap? })` 注册元数据，并以相同 `id` 向 keyed、Session 作用域的子 slot `sidebar.right.tab.document` 注册正文。`binaryExtensions` 列出 `extensions` 中不可按文本阅读的后缀，这些后缀不提供纯文本选项。两处注册都由 effect 持有，通过 `ctx.slots.inject` 等待子 slot。正文接收 `resourceAddress`、`content`、`wrap`、`scrollportRef`、`addResource`、`setResources` 和标准 `useTabInfo`/`useResource` 钩子。依赖成员由 tab 持有的 `ResourceGroup` 管理；替换依赖始终保留根 Resource。内部滚动元素挂载 `scrollportRef`；卸载时恢复共享正文的滚动职责。注册表保留所有匹配备选：`extension`（默认）优先于 `builtin`，随后按更长的后缀、再按注册顺序排列。所选实现仍可用时，下拉选择保持不变。HTML、SVG 和未匹配的扩展名保留纯文本回退，与加载方式无关。 diff --git a/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.module.css b/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.module.css index 490ec8e67c..afc740dc5e 100644 --- a/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.module.css +++ b/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.module.css @@ -28,38 +28,8 @@ border-bottom: 0.5px solid var(--dsw-alias-border-l3); } -/* The path is never ellipsized. Its text sits at the left while it fits: the - auto margin takes the free space. Once it is wider than the box, the auto - margin is zero and `flex-end` holds the name at the right edge, so the - directories run off the left and the box clips them there, faded by the - mask while `data-textpreview-path-clipped` is set. The margin plus the row's - gap put the text 16px clear of the first control. */ .path { - display: flex; - flex: 1 1 auto; - justify-content: flex-end; - min-width: 0; margin-right: 12px; - overflow: hidden; - font-size: 12px; - white-space: nowrap; -} - -.path[data-textpreview-path-clipped] { - mask-image: linear-gradient(to right, transparent, black 28px); -} - -.pathText { - flex: none; - margin-right: auto; -} - -.pathDirectory { - color: var(--dsw-alias-label-tertiary); -} - -.pathName { - color: var(--dsw-alias-label-primary); } /* Announced, not applied: the reader keeps the text they are looking at. */ diff --git a/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.tsx b/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.tsx index 34efd79edb..b9e03e1748 100644 --- a/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.tsx +++ b/packages/client/ui-sidebar-documentpreview/src/client/TextPreview.tsx @@ -9,14 +9,14 @@ * with the same reload. The type's controls, viewer choice, wrap and reload, sit at the end of * the path row; the Sidebar's strip carries none of them. */ -import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react' -import type { ReactNode, RefObject } from 'react' +import { useCallback, useEffect, useMemo, useRef, useState } from 'react' +import type { ReactNode } from 'react' import clsx from 'clsx' import type { ObservableSnapshot } from '@deepseek-ai/dsh-client-store' import type { InjectFace, PropsLocale, PropsRenderSlots, PropsRuntime, PropsStore } from '@deepseek-ai/dsh-client-ui-slots' import { FileTypeIcon, IconNowrapFillRegular, IconPauseOutlineRegular, IconPlayOutlineRegular, - IconRefreshOutlineRegular, IconWrapFillRegular, Menu, Tooltip, classifyFileType, + IconRefreshOutlineRegular, IconWrapFillRegular, Menu, PathLabel, Tooltip, classifyFileType, } from '@deepseek-ai/dsh-client-ui-primitives' import { pathPartsOf } from '@deepseek-ai/dsh-util-workspace-path' import type { TextInjected } from './face.ts' @@ -35,46 +35,6 @@ import css from './TextPreview.module.css' export { linesOf, loadedPages, lastLineLoaded, scrollToLine } from './text/lines.ts' export type { LoadedPage } from './text/lines.ts' -/** Keep the path fade in sync with whether its full text fits the header row. */ -function usePathClipped( - box: RefObject, - text: RefObject, - path: string, - shown: boolean, -): void { - useLayoutEffect(() => { - const outer = box.current - const inner = text.current - if (outer === null || inner === null) return undefined - const apply = (): void => { - if (inner.offsetWidth > outer.clientWidth) outer.dataset.textpreviewPathClipped = '' - else delete outer.dataset.textpreviewPathClipped - } - apply() - const observer = typeof ResizeObserver === 'undefined' ? undefined : new ResizeObserver(apply) - observer?.observe(outer) - observer?.observe(inner) - return () => { observer?.disconnect() } - }, [box, text, path, shown]) -} - -/** The header's path: directories greyed, the final segment in full ink, faded when clipped. */ -function HeaderPath({ pathRef, pathTextRef, path }: { - pathRef: RefObject - pathTextRef: RefObject - path: string -}): ReactNode { - const { directory, name } = pathPartsOf(path) - return ( -
- - {directory !== '' && {directory}} - {name} - -
- ) -} - /** Private registration inputs; the framework binds the registry source to useDocumentPreviews. */ export interface TextPreviewInjected extends TextInjected { readonly hooks: { readonly documentPreviews: ObservableSnapshot } @@ -129,14 +89,11 @@ export function TextPreview({ const bodyRef = useRef(null) const scrollportRef = useRef(null) const storedScrollTopRef = useRef(0) - const pathRef = useRef(null) - const pathTextRef = useRef(null) const [menuOpen, setMenuOpen] = useState(false) const absolutePath = meta.value?.absolutePath ?? current?.complete?.absolutePath const displayPath = absolutePath ?? file.path // Contributions that hand the file to the Host wait for its Host path. const fileOwner = absolutePath === undefined ? undefined : { absolutePath } - usePathClipped(pathRef, pathTextRef, displayPath, state !== undefined) // Every tab of this type is a `file` resource address, so its params are the // `file` type's; the union is narrowed on the one field read, not validated. const line = navigation.params !== undefined && 'line' in navigation.params ? navigation.params.line : undefined @@ -243,7 +200,7 @@ export function TextPreview({ return (
- + {fileOwner !== undefined && renderSlot('sidebar.right.tab.document.actions', fileOwner)}
@@ -305,7 +262,7 @@ export function TextPreview({

)}
- + {candidates.length > 1 && ( { expect(view.container.querySelector('[data-textpreview-path]')?.getAttribute('title')).toBe(ABSOLUTE_PATH) }) - it('marks the path clipped while its text is wider than its box, re-reading on resize', async () => { - class FakeResizeObserver implements ResizeObserver { - static latest: FakeResizeObserver | undefined - readonly observe = vi.fn() - readonly unobserve = vi.fn() - readonly disconnect = vi.fn() - constructor(private readonly callback: ResizeObserverCallback) { - FakeResizeObserver.latest = this - } - - fire(): void { - this.callback([], this) - } - } - vi.stubGlobal('ResizeObserver', FakeResizeObserver) - let boxWidth = 300 - const offsetWidth = Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'offsetWidth') - const clientWidth = Object.getOwnPropertyDescriptor(HTMLElement.prototype, 'clientWidth') - Object.defineProperty(HTMLElement.prototype, 'offsetWidth', { configurable: true, get: () => 200 }) - Object.defineProperty(HTMLElement.prototype, 'clientWidth', { configurable: true, get: () => boxWidth }) - try { - const h = harness({ 1: page(1, ['one'], true) }) - const view = render() - await settle() - const path = view.container.querySelector('[data-textpreview-path]') - const text = path?.firstElementChild - expect(path?.hasAttribute('data-textpreview-path-clipped')).toBe(false) - const observer = FakeResizeObserver.latest - if (observer === undefined) throw new Error('expected the path to observe its size') - expect(observer.observe).toHaveBeenCalledWith(path) - expect(observer.observe).toHaveBeenCalledWith(text) - - boxWidth = 120 - act(() => { observer.fire() }) - expect(path?.hasAttribute('data-textpreview-path-clipped')).toBe(true) - - boxWidth = 300 - act(() => { observer.fire() }) - expect(path?.hasAttribute('data-textpreview-path-clipped')).toBe(false) - view.unmount() - expect(observer.disconnect).toHaveBeenCalledTimes(1) - } finally { - vi.unstubAllGlobals() - for (const [name, descriptor] of [['offsetWidth', offsetWidth], ['clientWidth', clientWidth]] as const) { - if (descriptor === undefined) Reflect.deleteProperty(HTMLElement.prototype, name) - else Object.defineProperty(HTMLElement.prototype, name, descriptor) - } - } - }) - it('reads the first page on first mount and draws its lines, offering the next', async () => { const h = harness({ 1: page(1, ['one', 'two', 'three'], false) }) const view = render() diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b6e9d6331f..5e5b24cd58 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -3836,6 +3836,9 @@ importers: '@deepseek-ai/cordis': specifier: workspace:^ version: link:../../../vendor/cordis + '@deepseek-ai/dsh-util-workspace-path': + specifier: workspace:^ + version: link:../../util/workspace-path '@shikijs/langs': specifier: ^4.3.1 version: 4.3.1 From 795e5024bc6f0da2f7b2c59e33906508a11aa64d Mon Sep 17 00:00:00 2001 From: sjw1231 Date: Mon, 21 Sep 2026 15:05:43 +0800 Subject: [PATCH 4/9] fix(ui-deliverables): fill diff row backgrounds across scroll width --- apps/web/tests/changed-files-turn.e2e.ts | 34 +++++++++++++++++++ .../client/ui-deliverables/README.i18n.yaml | 4 +-- packages/client/ui-deliverables/README.md | 2 +- packages/client/ui-deliverables/README.zh.md | 2 +- .../src/client/ReviewTab.module.css | 3 +- 5 files changed, 40 insertions(+), 5 deletions(-) diff --git a/apps/web/tests/changed-files-turn.e2e.ts b/apps/web/tests/changed-files-turn.e2e.ts index b645d75d63..22b3edaee8 100644 --- a/apps/web/tests/changed-files-turn.e2e.ts +++ b/apps/web/tests/changed-files-turn.e2e.ts @@ -217,6 +217,40 @@ describe('web e2e: a git workspace turn ends with its changed files', () => { return [center(text), center(caret), center(counts)].map(value => Math.abs(value - buttonCenter)) }) for (const offset of headerAlignment) expect(offset).toBeLessThanOrEqual(0.5) + // The appended row has no old-side text; constrain the columns so the hunk header overflows it. + const emptyRowLayout = await page.addStyleTag({ content: ` + [data-diff-side="left"] { width: 90px; } + [data-diff-side="right"] { width: 120px; } + ` }) + try { + const left = review.locator('[data-diff-side="left"]') + const emptyRow = left.locator('[data-diff-line="add"]') + const maximum = await left.evaluate(element => element.scrollWidth - element.clientWidth) + expect(maximum).toBeGreaterThan(0) + await left.evaluate((element) => { element.scrollLeft = element.scrollWidth }) + await expect.poll(() => left.evaluate(element => element.scrollLeft)).toBe(maximum) + const fill = await emptyRow.evaluate((row) => { + const column = row.closest('[data-diff-side]')! + const columnBox = column.getBoundingClientRect() + const rowBox = row.getBoundingClientRect() + const y = rowBox.top + rowBox.height / 2 + return { + rowWidth: rowBox.width, + contentWidth: column.scrollWidth, + background: getComputedStyle(row).backgroundColor, + coversViewport: [columnBox.left + 4, columnBox.right - 4].every(x => + document.elementFromPoint(x, y)?.closest('[data-diff-line]') === row), + } + }) + expect(fill.background).not.toBe('rgba(0, 0, 0, 0)') + expect(fill.rowWidth).toBeGreaterThanOrEqual(fill.contentWidth - 0.5) + expect(fill.coversViewport).toBe(true) + } finally { + await emptyRowLayout.evaluate(element => element.parentNode!.removeChild(element)) + await review.locator('[data-diff-side]').evaluateAll((elements) => { + for (const element of elements) element.scrollLeft = 0 + }) + } const addedLine = review.locator('[data-diff-side="right"] [data-diff-line="add"]') const rightContextLine = review.locator('[data-diff-side="right"] [data-diff-line="context"]') const addedRule = await addedLine.evaluate((line) => { diff --git a/packages/client/ui-deliverables/README.i18n.yaml b/packages/client/ui-deliverables/README.i18n.yaml index dbc8d93e71..7a114571d5 100644 --- a/packages/client/ui-deliverables/README.i18n.yaml +++ b/packages/client/ui-deliverables/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/client/ui-deliverables/README.md -README.md: d3f0d391380f6f4ae9c95fdc8c0b4e8c4b00654a -README.zh.md: 1c25199512b5c97f041954995cf45452e58706ff +README.md: c537911c8ff32239278059c067e86c5775aa0a12 +README.zh.md: 2a0c78ef2c741f65c37f31a53db82c9e7a523853 diff --git a/packages/client/ui-deliverables/README.md b/packages/client/ui-deliverables/README.md index d3f0d39138..c537911c8f 100644 --- a/packages/client/ui-deliverables/README.md +++ b/packages/client/ui-deliverables/README.md @@ -46,7 +46,7 @@ A row opens the turn's `changes-review` tab, addressed by the viewed Session and The selected-file title uses the document preview’s [`PathLabel`](../ui-primitives/README.md#component-catalog): complete and left-aligned when it fits, otherwise clipped at the left with a fade that preserves trailing characters and the extension. Directories use subdued text, the filename uses primary text, and hovering reveals the complete displayed path. Resizing the pane or selecting another file updates the fade; the dropdown arrow, line counts, and toolbar actions retain their space. -Without wrapping, the two columns synchronize vertical scrolling and horizontal offsets up to each side’s available range. Both columns suppress elastic edge feedback and scroll chaining on both axes; the browser retains control of native momentum within each column’s scrollable range. Both horizontal scrollbars remain at the bottom of the visible comparison; scrolling vertically preserves a long line’s horizontal offset when the other side fits without horizontal scrolling. +Without wrapping, the two columns synchronize vertical scrolling and horizontal offsets up to each side’s available range. Line backgrounds, including empty alignment rows, cover each column’s full scrollable width. Both columns suppress elastic edge feedback and scroll chaining on both axes; the browser retains control of native momentum within each column’s scrollable range. Both horizontal scrollbars remain at the bottom of the visible comparison; scrolling vertically preserves a long line’s horizontal offset when the other side fits without horizontal scrolling. ### Inline-code links diff --git a/packages/client/ui-deliverables/README.zh.md b/packages/client/ui-deliverables/README.zh.md index 1c25199512..2a0c78ef2c 100644 --- a/packages/client/ui-deliverables/README.zh.md +++ b/packages/client/ui-deliverables/README.zh.md @@ -46,7 +46,7 @@ Web 的 `standard`、`ptc` 与 `cordis` preset 提供 `present` 用于声明交 当前文件标题使用文档预览页的 [`PathLabel`](../ui-primitives/README.zh.md#component-catalog)：空间足够时完整靠左显示，否则从左侧裁剪并渐隐，保留尾部字符和扩展名。目录使用弱化颜色，文件名使用主色，悬停显示完整路径。调整面板宽度或切换文件时更新渐隐；下拉箭头、行数和工具栏操作保留各自的空间。 -关闭自动换行时，两列同步纵向滚动，横向偏移同步到各自可滚动范围内。两列在双轴上都禁用弹性边缘反馈和向外层传递滚动；各列可滚动范围内的原生惯性仍由浏览器控制。两侧横向滚动条始终位于可见对比区域底部；如果只有一侧需要横向滚动，上下滚动会保留该侧的横向偏移。 +关闭自动换行时，两列同步纵向滚动，横向偏移同步到各自可滚动范围内。各行背景（包括用于对齐的空行）覆盖所在列的完整可滚动宽度。两列在双轴上都禁用弹性边缘反馈和向外层传递滚动；各列可滚动范围内的原生惯性仍由浏览器控制。两侧横向滚动条始终位于可见对比区域底部；如果只有一侧需要横向滚动，上下滚动会保留该侧的横向偏移。 ### 行内代码链接 diff --git a/packages/client/ui-deliverables/src/client/ReviewTab.module.css b/packages/client/ui-deliverables/src/client/ReviewTab.module.css index ae2c996cbb..a62d52e8fb 100644 --- a/packages/client/ui-deliverables/src/client/ReviewTab.module.css +++ b/packages/client/ui-deliverables/src/client/ReviewTab.module.css @@ -24,7 +24,8 @@ .status { display: flex; gap: 12px; align-items: center; margin: 0; padding: 16px; font-size: 13px; color: var(--dsw-alias-label-secondary); } .body { display: flex; flex: 1 1 auto; flex-direction: column; min-height: 0; overflow: auto; padding: 8px 0 16px; font: var(--dsw-font-markdown-code-block); } .columns { display: grid; flex: 1 1 auto; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); min-height: 0; } -.column { min-width: 0; overflow-x: scroll; overscroll-behavior: none; } +/* One intrinsic-width track keeps every hunk and empty row painted across the scrollable content. */ +.column { display: grid; grid-template-columns: minmax(max-content, 100%); align-content: start; min-width: 0; overflow-x: scroll; overscroll-behavior: none; } .column + .column { border-left: 0.5px solid var(--dsw-alias-border-l3); } .sideLine { display: grid; grid-template-columns: 3.5em max-content; box-sizing: border-box; min-width: 100%; width: max-content; min-height: 22px; line-height: 22px; white-space: pre; } .note { margin: 0; padding: 4px 16px 8px; font: var(--dsw-font-xs-13); color: var(--dsw-alias-label-tertiary); } From b20a383a7a63c3a47d09263829f7ac201e3265be Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Mon, 21 Sep 2026 16:15:47 +0800 Subject: [PATCH 5/9] fix(desktop): unpack platform ripgrep executables --- apps/desktop/README.i18n.yaml | 4 ++-- apps/desktop/README.md | 2 +- apps/desktop/README.zh.md | 2 +- .../scripts/electron-builder-config.mjs | 2 +- .../tests/fixtures/runtime-payload-smoke.mjs | 19 ++++++++++++++- .../desktop/tests/windows-asar-unpack.spec.ts | 24 +++++++++++++++++++ 6 files changed, 47 insertions(+), 6 deletions(-) diff --git a/apps/desktop/README.i18n.yaml b/apps/desktop/README.i18n.yaml index 6898608574..8246f79837 100644 --- a/apps/desktop/README.i18n.yaml +++ b/apps/desktop/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write apps/desktop/README.md -README.md: e99f771653c62175655f12d6982c04e5f91055d1 -README.zh.md: 9c7f86e5ab1ad0e42fc0fe2ea643c6ca4bed392f +README.md: d094851a6cfc2d85c6b31c200754f6331375eeb7 +README.zh.md: 4971b3266e2af1355173bd99a0f77dc1b7fab0b6 diff --git a/apps/desktop/README.md b/apps/desktop/README.md index e99f771653..d094851a6c 100644 --- a/apps/desktop/README.md +++ b/apps/desktop/README.md @@ -152,7 +152,7 @@ Desktop packs workspace packages locally and installs external dependencies thro The [Office conversion provider](../../packages/document/office-to-pdf/README.md) carries the target’s declared native engine, or WASM when the kit declares no matching native target. Preparation rejects a missing target engine before packaging. Complete native engine packages, including executables, libraries, data, licenses, and notices, are unpacked under `resources/app.asar.unpacked/dsh/node_modules/@deepseek-ai/`. The Desktop Host resolves engine manifests to these physical directories so native subprocesses can read their resources; the JavaScript API and WASM engine remain in ASAR. On macOS, the native helper receives the JIT entitlement required by [LibreOffice’s UNO bridge](https://github.com/LibreOffice/core/blob/master/sysui/desktop/macosx/hardened_runtime.xcent.in). -The packaged application runs compiled JavaScript and pre-generated Typert metadata; it does not compile TypeScript plugins. Source-level debugger navigation and editor declarations remain available in development packages. [Copy-policy tests](tests/runtime-file-policy.spec.ts) cover exclusions and retained assets; The [payload smoke](tests/fixtures/runtime-payload-smoke.mjs) runs under Electron RunAsNode before the Host smoke and final inventory verification. Signed Windows builds run these checks after dependency signing; other builds run them during `prepare:dsh`. The [Host smoke](scripts/smoke-runtime.ts) creates DOCX, XLSX, and PPTX inputs with bundled Python, converts each through the real Office provider, and checks PDF output. Every assembled application, including directory and unsigned Windows builds, repeats the payload and Host checks against ASAR. Archive integrity checks compare the complete archived descriptor with preparation, file bytes and membership in both archive and unpacked trees, recorded executable flags for archived files, and physical permissions for unpacked files. Conversion failures stop packaging before a release record is written; macOS DMG/ZIP builds run these checks before notarization. +The packaged application runs compiled JavaScript and pre-generated Typert metadata; it does not compile TypeScript plugins. Source-level debugger navigation and editor declarations remain available in development packages. [Copy-policy tests](tests/runtime-file-policy.spec.ts) cover exclusions and retained assets; The [payload smoke](tests/fixtures/runtime-payload-smoke.mjs) runs under Electron RunAsNode before the Host smoke and final inventory verification. The payload smoke resolves the search tool’s ripgrep executable and verifies text search and file enumeration. Signed Windows builds run these checks after dependency signing; other builds run them during `prepare:dsh`. The [Host smoke](scripts/smoke-runtime.ts) creates DOCX, XLSX, and PPTX inputs with bundled Python, converts each through the real Office provider, and checks PDF output. Every assembled application, including directory and unsigned Windows builds, repeats the payload and Host checks against ASAR. Archive integrity checks compare the complete archived descriptor with preparation, file bytes and membership in both archive and unpacked trees, recorded executable flags for archived files, and physical permissions for unpacked files. Conversion failures stop packaging before a release record is written; macOS DMG/ZIP builds run these checks before notarization. Windows release qualification also runs [directory and replacement checks](scripts/smoke-windows.ps1) manually after the Desktop build. Set `$Makensis`, `$SevenZip`, and `$PluginDir` to the pinned builder’s NSIS compiler, 7-Zip executable, and x86-unicode NSIS plugin directory. From the repository root, run the command below. It verifies directory replacement and rollback, and both locked-file replacement modes; it is not part of the unit-test lane. diff --git a/apps/desktop/README.zh.md b/apps/desktop/README.zh.md index 9c7f86e5ab..4971b3266e 100644 --- a/apps/desktop/README.zh.md +++ b/apps/desktop/README.zh.md @@ -152,7 +152,7 @@ Desktop 在本地打包工作区包，并通过目标捆绑的 Node 和 pnpm 安 [Office 转换提供方](../../packages/document/office-to-pdf/README.zh.md)携带目标已声明的原生引擎；kit 未声明匹配原生目标时携带 WASM 引擎。准备阶段在打包前拒绝缺少目标引擎的情况。完整原生引擎包（包括可执行文件、库、数据、许可证和 notices）解包到 `resources/app.asar.unpacked/dsh/node_modules/@deepseek-ai/` 下。Desktop Host 将引擎清单解析到这些物理目录，使原生子进程能读取资源；JavaScript API 和 WASM 引擎保留在 ASAR 中。macOS 上的原生辅助程序获得 [LibreOffice UNO 桥](https://github.com/LibreOffice/core/blob/master/sysui/desktop/macosx/hardened_runtime.xcent.in)所需的 JIT entitlement。 -打包应用运行编译后的 JavaScript 和预生成的 Typert 元数据，不编译 TypeScript 插件。源码级调试导航和编辑器声明仍可从开发包中获取。[复制规则测试](tests/runtime-file-policy.spec.ts)覆盖排除项和保留资源；[产物 smoke](tests/fixtures/runtime-payload-smoke.mjs) 在 Host smoke 和最终清单验证之前，使用 Electron RunAsNode 执行。Windows 签名构建在依赖签名后运行这些检查；其他构建在 `prepare:dsh` 中运行。[Host smoke](scripts/smoke-runtime.ts) 使用捆绑的 Python 创建 DOCX、XLSX 和 PPTX 输入，通过真实 Office 提供方逐一转换并检查 PDF 输出。每个组装后的应用（包括目录包和 Windows 未签名构建）都会针对 ASAR 重复产物和 Host 检查。归档完整性检查将归档内完整描述符与准备结果比对，并核对归档和解包目录中的文件内容与清单、归档内文件记录的执行标志，以及解包文件的物理权限。转换失败会在写入发布记录前终止打包；macOS DMG/ZIP 构建在公证前执行这些检查。 +打包应用运行编译后的 JavaScript 和预生成的 Typert 元数据，不编译 TypeScript 插件。源码级调试导航和编辑器声明仍可从开发包中获取。[复制规则测试](tests/runtime-file-policy.spec.ts)覆盖排除项和保留资源；[产物 smoke](tests/fixtures/runtime-payload-smoke.mjs) 在 Host smoke 和最终清单验证之前，使用 Electron RunAsNode 执行。产物 smoke 解析搜索工具使用的 ripgrep 可执行文件，并验证文本搜索和文件枚举。Windows 签名构建在依赖签名后运行这些检查；其他构建在 `prepare:dsh` 中运行。[Host smoke](scripts/smoke-runtime.ts) 使用捆绑的 Python 创建 DOCX、XLSX 和 PPTX 输入，通过真实 Office 提供方逐一转换并检查 PDF 输出。每个组装后的应用（包括目录包和 Windows 未签名构建）都会针对 ASAR 重复产物和 Host 检查。归档完整性检查将归档内完整描述符与准备结果比对，并核对归档和解包目录中的文件内容与清单、归档内文件记录的执行标志，以及解包文件的物理权限。转换失败会在写入发布记录前终止打包；macOS DMG/ZIP 构建在公证前执行这些检查。 Windows 发布验收还需在 Desktop 构建后手动运行[目录和替换检查](scripts/smoke-windows.ps1)。将 `$Makensis`、`$SevenZip` 和 `$PluginDir` 分别设为锁定版本构建器的 NSIS 编译器、7-Zip 可执行文件和 x86-unicode NSIS 插件目录。从仓库根目录运行以下命令。它验证 目录替换与回滚和两种文件占用替换方式；不属于单元测试通道。 diff --git a/apps/desktop/scripts/electron-builder-config.mjs b/apps/desktop/scripts/electron-builder-config.mjs index 3ce50573d1..2a3d685f54 100644 --- a/apps/desktop/scripts/electron-builder-config.mjs +++ b/apps/desktop/scripts/electron-builder-config.mjs @@ -63,7 +63,7 @@ export function createElectronBuilderConfig( let primaryRuntimeDestination let dshDestination let windowsCode = [] - const unpack = ['**/*.{node,dylib,dll,so,exe}', '**/*.so.*', '**/spawn-helper', '**/@vscode/ripgrep/bin/rg', + const unpack = ['**/*.{node,dylib,dll,so,exe}', '**/*.so.*', '**/spawn-helper', '**/@vscode/ripgrep-*/bin/rg', `**/node_modules/@deepseek-ai/libreoffice-kit-${resolvedPlatform}-${resolvedArch}/**/*`] const windowsSigner = packagesWindows && !unsigned ? createWindowsTokenSigner({ diff --git a/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs b/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs index bb015d3dff..1ca6f0e929 100644 --- a/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs +++ b/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs @@ -7,6 +7,7 @@ import { rm } from 'node:fs/promises' import { createRequire } from 'node:module' import { tmpdir } from 'node:os' import { delimiter, dirname, join, resolve } from 'node:path' +import { pathToFileURL } from 'node:url' const runtime = process.argv[2] assert.ok(runtime, 'Pass the filtered resources/dsh directory') @@ -46,6 +47,21 @@ console.log('desktop-node-script-ok') assert.match(output, /desktop-node-script-ok/u) } +/** Exercise grep and glob operations with the search tool's resolved native executable. */ +async function checkSearch() { + const { resolveRgPath } = await import(pathToFileURL(requireRuntime.resolve('@deepseek-ai/dsh-tool-fs-search')).href) + const executable = await resolveRgPath() + const name = 'ripgrep-smoke.txt' + const marker = 'desktop-ripgrep-smoke' + writeFileSync(join(scratch, name), `${marker}\n`, { flag: 'wx', mode: 0o600 }) + const run = args => execFileSync(executable, ['--no-config', ...args], { + cwd: scratch, encoding: 'utf8', timeout: 45_000, windowsHide: true, + env: Object.fromEntries(Object.entries(process.env).filter(([name]) => /^(?:systemroot|windir)$/iu.test(name))), + }).trim().replaceAll('\\', '/') + assert.equal(run(['--no-heading', '--no-filename', '--line-number', '--fixed-strings', '--', marker, name]), `1:${marker}`) + assert.equal(run(['--files', '--glob', name, '.']), `./${name}`) +} + /** Spawn only a fixed Node program and await the terminal's drained exit event. */ async function checkPty() { const pty = requireRuntime('node-pty') @@ -146,6 +162,7 @@ try { await checkSharp() checkHtml() await checkPty() + await checkSearch() } finally { // This private tree contains only fixture files; Windows may release handles after terminal exit. await rm(scratch, { recursive: true, force: true, maxRetries: 20, retryDelay: 50 }) @@ -154,5 +171,5 @@ try { // Natural event-loop drain includes node-pty's worker and console-list helper teardown. process.once('beforeExit', () => { console.log(JSON.stringify({ node: process.versions.node, platform: process.platform, arch: process.arch, - koffi: true, sharp: true, html: true, pty: true, pnpm: true })) + koffi: true, sharp: true, html: true, pty: true, pnpm: true, grep: true, glob: true })) }) diff --git a/apps/desktop/tests/windows-asar-unpack.spec.ts b/apps/desktop/tests/windows-asar-unpack.spec.ts index 5cbe410105..519f9e8371 100644 --- a/apps/desktop/tests/windows-asar-unpack.spec.ts +++ b/apps/desktop/tests/windows-asar-unpack.spec.ts @@ -188,6 +188,30 @@ it.each([true, false])('validates the real builder hook for unsigned=%s', async } }) +it.each([false, true])('unpacks platform ripgrep executables with external source=%s', async (external) => { + const input = await fixture(external) + const files = ['ripgrep-darwin-arm64/bin/rg', 'ripgrep-darwin-x64/bin/rg', 'ripgrep-win32-x64/bin/rg.exe'] + for (const file of [...files, 'ripgrep/lib/index.js']) { + const path = join(input.source, 'node_modules', '@vscode', file) + await mkdir(dirname(path), { recursive: true }) + await writeFile(path, 'ripgrep fixture') + } + const config = createElectronBuilderConfig({ + DSH_DESKTOP_APP_ID: 'com.example.ripgrep', DSH_DESKTOP_MANDATORY_UPDATE_TEST_ORIGIN: 'https://policy.example.com', + DSH_DESKTOP_MANDATORY_UPDATE_CONFIG: JSON.stringify({ allowedAuthOrigins: ['https://login.example.com'] }), + DSH_DESKTOP_UNSIGNED: '1', + }, 'win32', 'x64', input.source) + input.config.asarUnpack = [...config.asarUnpack] + await packageFixture(input) + const archive = await readAsar(join(input.resources, 'app.asar')) + expect(archive.getFile(join('dsh', 'node_modules', '@vscode', 'ripgrep/lib/index.js')).unpacked).not.toBe(true) + for (const file of files) { + const path = join('dsh', 'node_modules', '@vscode', file) + expect(archive.getFile(path, false).unpacked).toBe(true) + expect(await readFile(join(input.resources, 'app.asar.unpacked', path), 'utf8')).toBe('ripgrep fixture') + } +}) + it.each([false, true])('keeps the complete Office engine outside ASAR with external source=%s', async (external) => { const input = await fixture(external) const engine = join('node_modules', '@deepseek-ai', 'libreoffice-kit-win32-x64') From c1ad3bb4937d8a9c593f173f6b219067a053f4c5 Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Mon, 21 Sep 2026 16:25:03 +0800 Subject: [PATCH 6/9] test(desktop): align ripgrep packaging checks and fixtures --- .../tests/fixtures/runtime-payload-smoke.mjs | 30 +++++++++---------- apps/desktop/tests/macos-signature.spec.ts | 2 +- .../desktop/tests/windows-asar-unpack.spec.ts | 21 ++++++------- 3 files changed, 27 insertions(+), 26 deletions(-) diff --git a/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs b/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs index 1ca6f0e929..d0d7bb94f6 100644 --- a/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs +++ b/apps/desktop/tests/fixtures/runtime-payload-smoke.mjs @@ -47,21 +47,6 @@ console.log('desktop-node-script-ok') assert.match(output, /desktop-node-script-ok/u) } -/** Exercise grep and glob operations with the search tool's resolved native executable. */ -async function checkSearch() { - const { resolveRgPath } = await import(pathToFileURL(requireRuntime.resolve('@deepseek-ai/dsh-tool-fs-search')).href) - const executable = await resolveRgPath() - const name = 'ripgrep-smoke.txt' - const marker = 'desktop-ripgrep-smoke' - writeFileSync(join(scratch, name), `${marker}\n`, { flag: 'wx', mode: 0o600 }) - const run = args => execFileSync(executable, ['--no-config', ...args], { - cwd: scratch, encoding: 'utf8', timeout: 45_000, windowsHide: true, - env: Object.fromEntries(Object.entries(process.env).filter(([name]) => /^(?:systemroot|windir)$/iu.test(name))), - }).trim().replaceAll('\\', '/') - assert.equal(run(['--no-heading', '--no-filename', '--line-number', '--fixed-strings', '--', marker, name]), `1:${marker}`) - assert.equal(run(['--files', '--glob', name, '.']), `./${name}`) -} - /** Spawn only a fixed Node program and await the terminal's drained exit event. */ async function checkPty() { const pty = requireRuntime('node-pty') @@ -114,6 +99,21 @@ async function checkPty() { } } +/** Exercise grep and glob operations with the search tool's resolved native executable. */ +async function checkSearch() { + const { resolveRgPath } = await import(pathToFileURL(requireRuntime.resolve('@deepseek-ai/dsh-tool-fs-search')).href) + const executable = await resolveRgPath() + const name = 'ripgrep-smoke.txt' + const marker = 'desktop-ripgrep-smoke' + writeFileSync(join(scratch, name), `${marker}\n`, { flag: 'wx', mode: 0o600 }) + const run = args => execFileSync(executable, ['--no-config', ...args], { + cwd: scratch, encoding: 'utf8', timeout: 45_000, windowsHide: true, + env: Object.fromEntries(Object.entries(process.env).filter(([name]) => /^(?:systemroot|windir)$/iu.test(name))), + }).trim().replaceAll('\\', '/') + assert.equal(run(['--no-heading', '--no-filename', '--line-number', '--fixed-strings', '--', marker, name]), `1:${marker}`) + assert.equal(run(['--files', '--glob', name, '.']), `./${name}`) +} + /** Resolve one system function through Koffi's packaged native module. */ function checkKoffi() { const koffi = requireRuntime('koffi') diff --git a/apps/desktop/tests/macos-signature.spec.ts b/apps/desktop/tests/macos-signature.spec.ts index 6cd8faeccc..75891f0183 100644 --- a/apps/desktop/tests/macos-signature.spec.ts +++ b/apps/desktop/tests/macos-signature.spec.ts @@ -56,7 +56,7 @@ describe('desktop macOS release signature', () => { expect(dshNodeModules.to).toBe('dsh/node_modules') expect(config.asarUnpack).toEqual(expect.arrayContaining([ '**/*.{node,dylib,dll,so,exe}', - '**/@vscode/ripgrep/bin/rg', + '**/@vscode/ripgrep-*/bin/rg', ])) expect(config).toMatchObject({ appId: RELEASE_ENVIRONMENT.DSH_DESKTOP_APP_ID, diff --git a/apps/desktop/tests/windows-asar-unpack.spec.ts b/apps/desktop/tests/windows-asar-unpack.spec.ts index 519f9e8371..1be1eb6266 100644 --- a/apps/desktop/tests/windows-asar-unpack.spec.ts +++ b/apps/desktop/tests/windows-asar-unpack.spec.ts @@ -46,6 +46,14 @@ afterEach(async () => { for (const root of roots.splice(0)) await rm(root, { recursive: true, force: true }) }) +function unsignedWindowsConfig(appId: string, source: string) { + return createElectronBuilderConfig({ + DSH_DESKTOP_APP_ID: appId, DSH_DESKTOP_MANDATORY_UPDATE_TEST_ORIGIN: 'https://policy.example.com', + DSH_DESKTOP_MANDATORY_UPDATE_CONFIG: JSON.stringify({ allowedAuthOrigins: ['https://login.example.com'] }), + DSH_DESKTOP_UNSIGNED: '1', + }, 'win32', 'x64', source) +} + async function fixture(external: boolean) { const root = await mkdtemp(join(tmpdir(), 'windows-asar-')) roots.push(root) @@ -190,17 +198,14 @@ it.each([true, false])('validates the real builder hook for unsigned=%s', async it.each([false, true])('unpacks platform ripgrep executables with external source=%s', async (external) => { const input = await fixture(external) + // Windows rg.exe uses the general executable rule; macOS rg uses the platform-package rule. const files = ['ripgrep-darwin-arm64/bin/rg', 'ripgrep-darwin-x64/bin/rg', 'ripgrep-win32-x64/bin/rg.exe'] for (const file of [...files, 'ripgrep/lib/index.js']) { const path = join(input.source, 'node_modules', '@vscode', file) await mkdir(dirname(path), { recursive: true }) await writeFile(path, 'ripgrep fixture') } - const config = createElectronBuilderConfig({ - DSH_DESKTOP_APP_ID: 'com.example.ripgrep', DSH_DESKTOP_MANDATORY_UPDATE_TEST_ORIGIN: 'https://policy.example.com', - DSH_DESKTOP_MANDATORY_UPDATE_CONFIG: JSON.stringify({ allowedAuthOrigins: ['https://login.example.com'] }), - DSH_DESKTOP_UNSIGNED: '1', - }, 'win32', 'x64', input.source) + const config = unsignedWindowsConfig('com.example.ripgrep', input.source) input.config.asarUnpack = [...config.asarUnpack] await packageFixture(input) const archive = await readAsar(join(input.resources, 'app.asar')) @@ -224,11 +229,7 @@ it.each([false, true])('keeps the complete Office engine outside ASAR with exter const wasm = join(input.source, 'node_modules/@deepseek-ai/libreoffice-kit-wasm/package.json') await mkdir(dirname(wasm), { recursive: true }) await writeFile(wasm, '{}') - const config = createElectronBuilderConfig({ - DSH_DESKTOP_APP_ID: 'com.example.office', DSH_DESKTOP_MANDATORY_UPDATE_TEST_ORIGIN: 'https://policy.example.com', - DSH_DESKTOP_MANDATORY_UPDATE_CONFIG: JSON.stringify({ allowedAuthOrigins: ['https://login.example.com'] }), - DSH_DESKTOP_UNSIGNED: '1', - }, 'win32', 'x64', input.source) + const config = unsignedWindowsConfig('com.example.office', input.source) input.config.asarUnpack = [...config.asarUnpack] await config.beforePack(input.context) await packageFixture(input) From 910d52f717cc0b37021ea0de17e869ec2ecbf6dd Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Mon, 21 Sep 2026 16:28:18 +0800 Subject: [PATCH 7/9] feat(telemetry): add explicit product event OTLP exporter --- THIRD_PARTY_NOTICES.md | 1 + docs/capability-seams.i18n.yaml | 4 +- docs/capability-seams.md | 4 + docs/capability-seams.zh.md | 4 + docs/config-catalog.i18n.yaml | 4 +- docs/config-catalog.md | 34 ++++ docs/config-catalog.zh.md | 34 ++++ docs/module-graph.i18n.yaml | 4 +- docs/module-graph.md | 2 + docs/module-graph.zh.md | 2 + docs/subsystems/README.i18n.yaml | 4 +- docs/subsystems/README.md | 1 + docs/subsystems/README.zh.md | 1 + docs/subsystems/product-telemetry.i18n.yaml | 6 + docs/subsystems/product-telemetry.md | 35 ++++ docs/subsystems/product-telemetry.zh.md | 35 ++++ .../extensions/tool-cordis/src/api-catalog.ts | 20 +++ packages/host/README.i18n.yaml | 4 +- packages/host/README.md | 7 +- packages/host/README.zh.md | 7 +- .../product-telemetry-otel/README.i18n.yaml | 6 + .../host/product-telemetry-otel/README.md | 104 ++++++++++++ .../host/product-telemetry-otel/README.zh.md | 104 ++++++++++++ .../host/product-telemetry-otel/package.json | 47 ++++++ .../host/product-telemetry-otel/src/index.ts | 154 +++++++++++++++++ .../tests/fixtures/driver.ts | 42 +++++ .../tests/fixtures/telemetry.patch.yml | 15 ++ .../tests/loader-composition.e2e.ts | 23 +++ .../tests/telemetry.spec.ts | 157 ++++++++++++++++++ .../host/product-telemetry-otel/tsconfig.json | 21 +++ pnpm-lock.yaml | 37 +++++ scripts/gen-cordis-catalog.ts | 3 + scripts/gen-doc-graphs.ts | 7 + .../verify-package-readme-model-experience.ts | 1 + tsconfig.base.json | 1 + tsconfig.host.json | 1 + 36 files changed, 922 insertions(+), 14 deletions(-) create mode 100644 docs/subsystems/product-telemetry.i18n.yaml create mode 100644 docs/subsystems/product-telemetry.md create mode 100644 docs/subsystems/product-telemetry.zh.md create mode 100644 packages/host/product-telemetry-otel/README.i18n.yaml create mode 100644 packages/host/product-telemetry-otel/README.md create mode 100644 packages/host/product-telemetry-otel/README.zh.md create mode 100644 packages/host/product-telemetry-otel/package.json create mode 100644 packages/host/product-telemetry-otel/src/index.ts create mode 100644 packages/host/product-telemetry-otel/tests/fixtures/driver.ts create mode 100644 packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml create mode 100644 packages/host/product-telemetry-otel/tests/loader-composition.e2e.ts create mode 100644 packages/host/product-telemetry-otel/tests/telemetry.spec.ts create mode 100644 packages/host/product-telemetry-otel/tsconfig.json diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 096d5ee117..6cd790f7c5 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -53,6 +53,7 @@ External packages installed for runtime use or distributed inside the prebuilt b | [`@openai/codex`](https://github.com/openai/codex) | Apache-2.0 | | [`@opentelemetry/api`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/api-logs`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | +| [`@opentelemetry/core`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/exporter-logs-otlp-http`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/otlp-exporter-base`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/resources`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | diff --git a/docs/capability-seams.i18n.yaml b/docs/capability-seams.i18n.yaml index a1e749da0f..efedaef6c9 100644 --- a/docs/capability-seams.i18n.yaml +++ b/docs/capability-seams.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/capability-seams.md -capability-seams.md: bbd44bce011404ee476131b9f498618a8ef5c708 -capability-seams.zh.md: 4e9f826bc27420ba372ac6feb688cc23bc58e141 +capability-seams.md: f6482d487543a9b1b0d9251c1aa6089b7ca2c558 +capability-seams.zh.md: f9a9d2d92b9d4253bfc00ed4ebbb9433a78138e7 diff --git a/docs/capability-seams.md b/docs/capability-seams.md index bbd44bce01..f6482d4875 100644 --- a/docs/capability-seams.md +++ b/docs/capability-seams.md @@ -7,6 +7,8 @@ A service can be a core spine service, a swappable capability seam, or a bundle/ ```mermaid flowchart LR + pkg_product_telemetry_otel["product-telemetry-otel"] + svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_hmr["hmr"] svc_hmr["ctx.hmr
Serialized module and configuration reloads"] pkg_app_boot["app-boot"] @@ -337,6 +339,7 @@ flowchart LR pkg_plan_mode --> svc_planMode pkg_plugin_manager --> svc_pluginManager pkg_plugin_package_inventory_deepseek --> svc_deepseekLlmApiExtensions + pkg_product_telemetry_otel --> svc_productTelemetry pkg_ptc_runtime --> svc_ptcRuntime pkg_ptc_runtime_node --> svc_ptcRuntime pkg_pwsh_local --> svc_shell @@ -551,6 +554,7 @@ flowchart LR | ctx key | Role | Owner | Implementations | Direct consumers | Companion plugins | Note | | --- | --- | --- | --- | --- | --- | --- | +| `ctx.productTelemetry` | `core` | [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing. | | `ctx.hmr` | `core` | [`hmr`](../packages/boot/hmr) | - | [`app-boot`](../packages/boot/app-boot) | - | Owns module and exact configuration watchers; application mutations share its queue and automatic reloads await the application file lock. | | `ctx.pluginManager` | `core` | [`plugin-manager`](../packages/boot/plugin-manager) | - | [`plugin-manager`](../packages/boot/plugin-manager), `ui-settings-plugin-inventory` | - | Shares profile package operations with the CLI and reports persisted and running state to Web and agent callers. | | `ctx.profileContext` | `core` | [`app-boot`](../packages/boot/app-boot) | - | [`plugin-manager`](../packages/boot/plugin-manager) | - | The dsh launcher supplies data-only profile locations and composition inputs; reload scheduling belongs to dsh-hmr. | diff --git a/docs/capability-seams.zh.md b/docs/capability-seams.zh.md index 4e9f826bc2..f9a9d2d92b 100644 --- a/docs/capability-seams.zh.md +++ b/docs/capability-seams.zh.md @@ -9,6 +9,8 @@ ```mermaid flowchart LR + pkg_product_telemetry_otel["product-telemetry-otel"] + svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_hmr["hmr"] svc_hmr["ctx.hmr
Serialized module and configuration reloads"] pkg_app_boot["app-boot"] @@ -339,6 +341,7 @@ flowchart LR pkg_plan_mode --> svc_planMode pkg_plugin_manager --> svc_pluginManager pkg_plugin_package_inventory_deepseek --> svc_deepseekLlmApiExtensions + pkg_product_telemetry_otel --> svc_productTelemetry pkg_ptc_runtime --> svc_ptcRuntime pkg_ptc_runtime_node --> svc_ptcRuntime pkg_pwsh_local --> svc_shell @@ -553,6 +556,7 @@ flowchart LR | ctx 键 | 角色 | 所属包 | 实现 | 直接消费方 | 配套插件 | 说明 | | --- | --- | --- | --- | --- | --- | --- | +| `ctx.productTelemetry` | `core` | [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | 通过 OTLP/HTTP 发送显式提交的分析事件；仅挂载插件不会采集信息。 | | `ctx.hmr` | `core` | [`hmr`](../packages/boot/hmr) | - | [`app-boot`](../packages/boot/app-boot) | - | 负责模块和精确配置监听；应用修改共用其队列，自动重载等待应用文件锁。 | | `ctx.pluginManager` | `core` | [`plugin-manager`](../packages/boot/plugin-manager) | - | [`plugin-manager`](../packages/boot/plugin-manager), `ui-settings-plugin-inventory` | - | 与 CLI 共享 profile 包操作，并向 Web 和 Agent 调用方分别报告持久状态与运行状态。 | | `ctx.profileContext` | `core` | [`app-boot`](../packages/boot/app-boot) | - | [`plugin-manager`](../packages/boot/plugin-manager) | - | dsh launcher 提供纯数据形式的 profile 位置与组合输入；重载调度由 dsh-hmr 负责。 | diff --git a/docs/config-catalog.i18n.yaml b/docs/config-catalog.i18n.yaml index 7c73a927de..285f1d9a96 100644 --- a/docs/config-catalog.i18n.yaml +++ b/docs/config-catalog.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/config-catalog.md -config-catalog.md: d3d1b4fe47bf6dc745dc9a00ac6ef317ab0d3ca8 -config-catalog.zh.md: 3f204af30d5e973c03cd24c6c2873bb7756d334e +config-catalog.md: fe9edd406fa6305494e0e1f6fc71725278716685 +config-catalog.zh.md: 0a45e6573a94e46fa8d615af8a1f6e459c9cb2d2 diff --git a/docs/config-catalog.md b/docs/config-catalog.md index d3d1b4fe47..fe9edd406f 100644 --- a/docs/config-catalog.md +++ b/docs/config-catalog.md @@ -2064,6 +2064,40 @@ export interface Config { Source: [`packages/llm/plugin-package-inventory-deepseek/src/index.ts:32`](../packages/llm/plugin-package-inventory-deepseek/src/index.ts) + + +## `@deepseek-ai/dsh-product-telemetry-otel` + +```ts config-catalog +/** Collector routing, application identity, and bounded in-memory batch settings. */ +export interface Config { + /** Full HTTP(S) logs URL. */ + endpoint: string + /** Collector routing header. */ + channel: string + /** Resource service.name supplied by the application composition. */ + serviceName: string + /** Resource service.version supplied by the application composition. */ + serviceVersion: string + /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ + compression?: 'none' | 'gzip' + /** Maximum records per export; must not exceed maxQueueSize. */ + maxExportBatchSize: number + /** Maximum queued records; the SDK drops new records when full. */ + maxQueueSize: number + /** Delay before exporting a partial batch. */ + scheduledDelayMillis: number + /** Exporter HTTP deadline, including SDK transient-error retries. */ + timeoutMillis: number + /** Processor deadline for one batch export. */ + exportTimeoutMillis: number + /** Outer shutdown wait; pending exports may be lost after this deadline. */ + shutdownTimeoutMillis: number +} +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts:35`](../packages/host/product-telemetry-otel/src/index.ts) + ## `@deepseek-ai/dsh-ptc-runtime-node` diff --git a/docs/config-catalog.zh.md b/docs/config-catalog.zh.md index 3f204af30d..0a45e6573a 100644 --- a/docs/config-catalog.zh.md +++ b/docs/config-catalog.zh.md @@ -2068,6 +2068,40 @@ export interface Config { 来源：[`packages/llm/plugin-package-inventory-deepseek/src/index.ts:32`](../packages/llm/plugin-package-inventory-deepseek/src/index.ts) + + +## `@deepseek-ai/dsh-product-telemetry-otel` + +```ts config-catalog +/** Collector routing, application identity, and bounded in-memory batch settings. */ +export interface Config { + /** Full HTTP(S) logs URL. */ + endpoint: string + /** Collector routing header. */ + channel: string + /** Resource service.name supplied by the application composition. */ + serviceName: string + /** Resource service.version supplied by the application composition. */ + serviceVersion: string + /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ + compression?: 'none' | 'gzip' + /** Maximum records per export; must not exceed maxQueueSize. */ + maxExportBatchSize: number + /** Maximum queued records; the SDK drops new records when full. */ + maxQueueSize: number + /** Delay before exporting a partial batch. */ + scheduledDelayMillis: number + /** Exporter HTTP deadline, including SDK transient-error retries. */ + timeoutMillis: number + /** Processor deadline for one batch export. */ + exportTimeoutMillis: number + /** Outer shutdown wait; pending exports may be lost after this deadline. */ + shutdownTimeoutMillis: number +} +``` + +来源： [`packages/host/product-telemetry-otel/src/index.ts:35`](../packages/host/product-telemetry-otel/src/index.ts) + ## `@deepseek-ai/dsh-ptc-runtime-node` diff --git a/docs/module-graph.i18n.yaml b/docs/module-graph.i18n.yaml index 9574d6c46b..a11b820d77 100644 --- a/docs/module-graph.i18n.yaml +++ b/docs/module-graph.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/module-graph.md -module-graph.md: 8511f674c84bcfa11fb9e2b137b12025ec540c3e -module-graph.zh.md: 67ba8d7f6b2582200b8a2ecc2215f7b317880081 +module-graph.md: 8976efc78f5c6f10b27c7c20cd4b380821ce3d61 +module-graph.zh.md: d1f770ec1fdebfca93d7fb436d75bee8325633b2 diff --git a/docs/module-graph.md b/docs/module-graph.md index 8511f674c8..8976efc78f 100644 --- a/docs/module-graph.md +++ b/docs/module-graph.md @@ -274,6 +274,7 @@ flowchart TD pkg_host_open_in_app["host-open-in-app"] pkg_host_plugin_inventory["host-plugin-inventory"] pkg_host_webserver["host-webserver"] + pkg_product_telemetry_otel["product-telemetry-otel"] end subgraph group_identity["packages/identity"] pkg_anonymous_user_id["anonymous-user-id"] @@ -1419,6 +1420,7 @@ flowchart TD | [`host-directory-picker-native`](../packages/host/directory-picker-native) | `host` | — | | [`host-open-in-app`](../packages/host/open-in-app) | `host` | — | | [`host-webserver`](../packages/host/webserver) | `host` | — | +| [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`invariants`](../packages/runtime-diagnostics/invariants) | `runtime-diagnostics` | — | | [`session-format`](../packages/session/session-format) | `session` | — | | [`session-format-v0-to-v1`](../packages/session/session-format-v0-to-v1) | `session` | — | diff --git a/docs/module-graph.zh.md b/docs/module-graph.zh.md index 67ba8d7f6b..d1f770ec1f 100644 --- a/docs/module-graph.zh.md +++ b/docs/module-graph.zh.md @@ -276,6 +276,7 @@ flowchart TD pkg_host_open_in_app["host-open-in-app"] pkg_host_plugin_inventory["host-plugin-inventory"] pkg_host_webserver["host-webserver"] + pkg_product_telemetry_otel["product-telemetry-otel"] end subgraph group_identity["packages/identity"] pkg_anonymous_user_id["anonymous-user-id"] @@ -1421,6 +1422,7 @@ flowchart TD | [`host-directory-picker-native`](../packages/host/directory-picker-native) | `host` | — | | [`host-open-in-app`](../packages/host/open-in-app) | `host` | — | | [`host-webserver`](../packages/host/webserver) | `host` | — | +| [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`invariants`](../packages/runtime-diagnostics/invariants) | `runtime-diagnostics` | — | | [`session-format`](../packages/session/session-format) | `session` | — | | [`session-format-v0-to-v1`](../packages/session/session-format-v0-to-v1) | `session` | — | diff --git a/docs/subsystems/README.i18n.yaml b/docs/subsystems/README.i18n.yaml index af12f99e97..49c88f8b26 100644 --- a/docs/subsystems/README.i18n.yaml +++ b/docs/subsystems/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/subsystems/README.md -README.md: db21e0fe6bea366c4d7efc1d96d247dd255f54da -README.zh.md: 4b2b28dbf9a39da0c0ce3a062c4de3261501f7d9 +README.md: 7534586b4bd2686cd75da160fe044806afcff539 +README.zh.md: 1132d9a9e0c0bb945532020b314f87a08b84b933 diff --git a/docs/subsystems/README.md b/docs/subsystems/README.md index db21e0fe6b..7534586b4b 100644 --- a/docs/subsystems/README.md +++ b/docs/subsystems/README.md @@ -6,6 +6,7 @@ One page per subsystem of the DeepSeek Harness: what it is, the data structures | Page | Owns | |---|---| +| [product-telemetry.md](product-telemetry.md) | Explicit product analytics submission and OTLP/HTTP transport | | [boot.md](boot.md) | Current-profile plugin management and launcher reload coordination | | [core.md](core.md) | how `packages/core` controls the agent loop: the package-by-package loop description, agent creation and ownership (`AgentHandle`), the `Agent` handle's delivery/cancellation/interception contracts, and the repo-wide type patterns (`…Map → derived-union`, branded ids) | | [llm-streaming.md](llm-streaming.md) | the `packages/llm` conversation types — `Message`/`ContentBlock`, the assembled model request, the `StreamChunk` wire protocol and adapter contract, `BlockAssembler`, and the `LlmAdapter` provider contract | diff --git a/docs/subsystems/README.zh.md b/docs/subsystems/README.zh.md index 4b2b28dbf9..1132d9a9e0 100644 --- a/docs/subsystems/README.zh.md +++ b/docs/subsystems/README.zh.md @@ -6,6 +6,7 @@ | 页面 | 负责内容 | |---|---| +| [product-telemetry.md](product-telemetry.zh.md) | 显式产品分析事件提交与 OTLP/HTTP 传输 | | [boot.md](boot.zh.md) | 当前 profile 插件管理与 launcher 重载协调 | | [core.md](core.zh.md) | `packages/core` 如何控制 agent loop（智能体循环）：逐包的循环说明、agent 创建与所有权（`AgentHandle`）、`Agent` 句柄的投递/取消/拦截约定，以及全仓通用类型模式（`…Map → derived-union`、品牌化 id） | | [llm-streaming.md](llm-streaming.zh.md) | `packages/llm` 的对话类型——`Message`/`ContentBlock`、组装完成的模型请求、`StreamChunk` wire protocol 和适配器约定（adapter contract）、`BlockAssembler`，以及 `LlmAdapter` 提供方约定 | diff --git a/docs/subsystems/product-telemetry.i18n.yaml b/docs/subsystems/product-telemetry.i18n.yaml new file mode 100644 index 0000000000..326d675316 --- /dev/null +++ b/docs/subsystems/product-telemetry.i18n.yaml @@ -0,0 +1,6 @@ +# Bilingual-pair consistency record (docs/i18n/README.md): the git blob hash of each +# side as of the last confirmed-consistent state. Both languages carry equal authority; +# after editing either side, bring the other along and re-record with: +# pnpm run verify-translation-pairing --write docs/subsystems/product-telemetry.md +product-telemetry.md: b9abdfc3a781ce5dc6237c25f2f7e0b045776125 +product-telemetry.zh.md: de132fec7c7a2e394bb3ee7ab6e8d745c0912b66 diff --git a/docs/subsystems/product-telemetry.md b/docs/subsystems/product-telemetry.md new file mode 100644 index 0000000000..b9abdfc3a7 --- /dev/null +++ b/docs/subsystems/product-telemetry.md @@ -0,0 +1,35 @@ +# Product telemetry + +English | [中文](product-telemetry.zh.md) + +The [product telemetry plugin](../../packages/host/product-telemetry-otel/README.md) sends explicitly selected analytics events through OTLP/HTTP. Its `productTelemetry` service owns submission only; product consumers own when an event occurs and which fields are approved. No Session data or identifiers are collected automatically. + +`ProductTelemetryRecord` requires an event name, string body, and Unix-millisecond timestamp. Attributes accept scalar strings, numbers, booleans, and one-level objects of those values (`ProductTelemetryScalar`). Optional severity uses OTel severity numbers and defaults to INFO. Observation time is assigned when the record is enqueued. + +Enqueue is synchronous and does not acknowledge delivery. The SDK owns batching and retry; local diagnostics report export failures. See the package README for configuration, shutdown, and loss limits. + + + + + +## Cordis API + +Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md). + + + +### `ctx.productTelemetry` — `ProductTelemetry` + +Host analytics sender. Mounting alone sends nothing; the owning fiber drains it on unload. + +```ts cordis-catalog +/** + * Enqueue one selected product event without waiting for network delivery. + * Queue admission and shutdown completion are not collector or warehouse acknowledgements. + * @param record - caller-owned event containing only approved analytics fields. + */ +emit(record: ProductTelemetryRecord): void +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts`](../../packages/host/product-telemetry-otel/src/index.ts) + diff --git a/docs/subsystems/product-telemetry.zh.md b/docs/subsystems/product-telemetry.zh.md new file mode 100644 index 0000000000..de132fec7c --- /dev/null +++ b/docs/subsystems/product-telemetry.zh.md @@ -0,0 +1,35 @@ +# 产品埋点 + +[English](product-telemetry.md) | 中文 + +[产品埋点插件](../../packages/host/product-telemetry-otel/README.zh.md) 通过 OTLP/HTTP 发送明确选定的分析事件。`productTelemetry` 服务仅负责提交；产品消费方决定事件发生时机与获准采集的字段。不自动采集 Session 数据或标识。 + +`ProductTelemetryRecord` 要求事件名称、字符串 body 和 Unix 毫秒时间戳。属性接受字符串、数字、布尔标量，以及这些值组成的单层对象（`ProductTelemetryScalar`）。可选的严重程度使用 OTel 严重程度数字，默认为 INFO。记录入队时填写观测时间。 + +入队同步完成，不代表送达确认。SDK 负责批量发送与重试；发送失败会产生本地诊断。配置、退出和丢失限制见包 README。 + + + + + +## Cordis API + +Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.zh.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md). + + + +### `ctx.productTelemetry` — `ProductTelemetry` + +Host analytics sender. Mounting alone sends nothing; the owning fiber drains it on unload. + +```ts cordis-catalog +/** + * Enqueue one selected product event without waiting for network delivery. + * Queue admission and shutdown completion are not collector or warehouse acknowledgements. + * @param record - caller-owned event containing only approved analytics fields. + */ +emit(record: ProductTelemetryRecord): void +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts`](../../packages/host/product-telemetry-otel/src/index.ts) + diff --git a/packages/extensions/tool-cordis/src/api-catalog.ts b/packages/extensions/tool-cordis/src/api-catalog.ts index 7d2f58ff7a..b7b2cdaac1 100644 --- a/packages/extensions/tool-cordis/src/api-catalog.ts +++ b/packages/extensions/tool-cordis/src/api-catalog.ts @@ -1596,6 +1596,18 @@ export const SERVICE_API: readonly ServiceApiEntry[] = [ }, ], }, + { + key: 'productTelemetry', + summary: 'Host analytics sender.', + description: 'Host analytics sender. Mounting alone sends nothing; the owning fiber drains it on unload.', + methods: [ + { + signature: 'emit(record: ProductTelemetryRecord): void', + description: 'Enqueue one selected product event without waiting for network delivery. Queue admission and shutdown completion are not collector or warehouse acknowledgements.', + parameters: [{ name: 'record', description: 'caller-owned event containing only approved analytics fields.' }], + }, + ], + }, { key: 'profileContext', summary: 'Current profile facts; scheduling and mutation belong to their callers.', @@ -5634,6 +5646,14 @@ export const TYPE_API: readonly TypeApiEntry[] = [ name: 'PreToolDecision', declaration: 'export type PreToolDecision = {\n kind: \'allow\';\n} | {\n kind: \'deny\';\n reason: string;\n info?: ToolErrorInfo;\n} | {\n kind: \'cancel\';\n} | {\n kind: \'ask\';\n reason?: string;\n};', }, + { + name: 'ProductTelemetryRecord', + declaration: 'export interface ProductTelemetryRecord {\n eventName: string;\n body: string;\n timestamp: number;\n severityNumber?: SeverityNumber;\n attributes?: Record>;\n}', + }, + { + name: 'ProductTelemetryScalar', + declaration: 'export type ProductTelemetryScalar = string | number | boolean;', + }, { name: 'ProfilePnpmInvocation', declaration: 'export interface ProfilePnpmInvocation {\n readonly command: string;\n readonly args: readonly string[];\n readonly env: Readonly>;\n}', diff --git a/packages/host/README.i18n.yaml b/packages/host/README.i18n.yaml index 0c7ec8a7e2..2bf03c1e34 100644 --- a/packages/host/README.i18n.yaml +++ b/packages/host/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/host/README.md -README.md: 0b595eb7e63f33ed8e11ec0f39438f5d79b6ab33 -README.zh.md: 6a7507b7d8d2b2d791952783235a80280c8c0408 +README.md: 4de7a5fdd00be392d19a58f4bc424fce53c5e112 +README.zh.md: 80b74e0647c810b900f671d7d1256ab0d46107a9 diff --git a/packages/host/README.md b/packages/host/README.md index 0b595eb7e6..4de7a5fdd0 100644 --- a/packages/host/README.md +++ b/packages/host/README.md @@ -9,7 +9,7 @@ English | [中文](README.zh.md) ## Summary -The `host/` group provides the web GUI's plain HTTP server, the SPA dist server that serves the built Web shell, the workspace-directory picking seam with its native, browse, and adaptive composition packages, the open-in-app application probe and launch routes, and the read-only plugin inventory projection. All eight packages are product packages; the browser transport lives in [`client/`](../client/README.md), and the composed application is [`apps/cli`](../../apps/cli/README.md) booting the [`dsh-base` bundle](../bundle/base/cordis.patch.yml) that serves the web app under `apps/web/`. The picker backends replace one another behind the shared seam. +The `host/` group provides the web GUI's plain HTTP server, the SPA dist server that serves the built Web shell, the workspace-directory picking seam with its native, browse, and adaptive composition packages, the open-in-app application probe and launch routes, and the read-only plugin inventory projection. These packages are product packages; the browser transport lives in [`client/`](../client/README.md), and the composed application is [`apps/cli`](../../apps/cli/README.md) booting the [`dsh-base` bundle](../bundle/base/cordis.patch.yml) that serves the web app under `apps/web/`. The picker backends replace one another behind the shared seam. ## Table of Contents @@ -22,7 +22,7 @@ The `host/` group provides the web GUI's plain HTTP server, the SPA dist server ## Packages -Eight packages play the host roles; each package README owns its contract and configuration. +The packages play the host roles; each package README owns its contract and configuration. | Package | Role | ctx key | |---|---|---| @@ -34,6 +34,7 @@ Eight packages play the host roles; each package README owns its contract and co | [`directory-picker-auto/`](directory-picker-auto/README.md) | Host-adaptive chooser that mounts the matching backend at boot | mounts a backend | | [`open-in-app/`](open-in-app/README.md) | Application probe, icon, and launch routes opening the workspace directory in an installed application | consumes `ctx.webServer` | | [`plugin-inventory/`](plugin-inventory/README.md) | Read-only projection of current Loader entries | Remote `pluginInventory/list` | +| [`product-telemetry-otel/`](product-telemetry-otel/README.md) | Explicit product usage events over OTLP/HTTP | `ctx.productTelemetry` | ----- @@ -46,6 +47,8 @@ Start with the subsystem references for the transport and the workspace records, - [Workspace subsystem](../../docs/subsystems/workspace.md) — the workspace records the directory picker feeds. - [Web config-tree boot and transport layering](../../.agents/notes/implemented/architecture/2026-07-24-web-config-tree-boot-and-transport-layering.md) — ownership of the Web transport layers. +- [Product telemetry](../../docs/subsystems/product-telemetry.md) — explicit analytics event submission. + ## Dev Note diff --git a/packages/host/README.zh.md b/packages/host/README.zh.md index 6a7507b7d8..80b74e0647 100644 --- a/packages/host/README.zh.md +++ b/packages/host/README.zh.md @@ -9,7 +9,7 @@ kind: "package-group" ## 概述 -`host/` 组提供 Web GUI 的普通 HTTP 服务器、服务已构建 Web 壳的 SPA dist 服务器、带原生／浏览／自适应组合包的工作区目录选择 seam、open-in-app 的应用探测与启动路由，以及只读的插件清单投影。这八个包都是产品包；浏览器传输位于 [`client/`](../client/README.zh.md)，组合应用是 [`apps/cli`](../../apps/cli/README.zh.md)，它启动 [`dsh-base` 组合包](../bundle/base/cordis.patch.yml) 来提供 `apps/web/` 下的 Web 应用。选择器后端可在共享 seam 后互相替换。 +`host/` 组提供 Web GUI 的普通 HTTP 服务器、服务已构建 Web 壳的 SPA dist 服务器、带原生／浏览／自适应组合包的工作区目录选择 seam、open-in-app 的应用探测与启动路由，以及只读的插件清单投影。这些包都是产品包；浏览器传输位于 [`client/`](../client/README.zh.md)，组合应用是 [`apps/cli`](../../apps/cli/README.zh.md)，它启动 [`dsh-base` 组合包](../bundle/base/cordis.patch.yml) 来提供 `apps/web/` 下的 Web 应用。选择器后端可在共享 seam 后互相替换。 ## 目录 @@ -22,7 +22,7 @@ kind: "package-group" ## 包 -八个包分别承担 Host 角色；各包的 README 拥有自己的约定与配置。 +各包分别承担 Host 角色；各包的 README 拥有自己的约定与配置。 | 包 | 职责 | ctx 键 | |---|---|---| @@ -34,6 +34,7 @@ kind: "package-group" | [`directory-picker-auto/`](directory-picker-auto/README.zh.md) | 在启动时挂载匹配后端的宿主自适应选择器 | 挂载一个后端 | | [`open-in-app/`](open-in-app/README.zh.md) | 在已安装应用中打开 workspace 目录的应用探测、图标与启动路由 | 消费 `ctx.webServer` | | [`plugin-inventory/`](plugin-inventory/README.zh.md) | 当前 Loader 条目的只读投影 | Remote `pluginInventory/list` | +| [`product-telemetry-otel/`](product-telemetry-otel/README.zh.md) | 通过 OTLP/HTTP 显式上报产品使用事件 | `ctx.productTelemetry` | ----- @@ -46,6 +47,8 @@ kind: "package-group" - [工作区子系统](../../docs/subsystems/workspace.zh.md)——目录选择器所喂给的工作区记录。 - [Web 配置树启动与传输分层](../../.agents/notes/implemented/architecture/2026-07-24-web-config-tree-boot-and-transport-layering.zh.md)——Web 传输各层的所有权。 +- [产品埋点](../../docs/subsystems/product-telemetry.zh.md)——显式提交分析事件。 + ## 开发备注 diff --git a/packages/host/product-telemetry-otel/README.i18n.yaml b/packages/host/product-telemetry-otel/README.i18n.yaml new file mode 100644 index 0000000000..823dcfa244 --- /dev/null +++ b/packages/host/product-telemetry-otel/README.i18n.yaml @@ -0,0 +1,6 @@ +# Bilingual-pair consistency record (docs/i18n/README.md): the git blob hash of each +# side as of the last confirmed-consistent state. Both languages carry equal authority; +# after editing either side, bring the other along and re-record with: +# pnpm run verify-translation-pairing --write packages/host/product-telemetry-otel/README.md +README.md: 4ce0a8744b46391b8dbe3d7d6739f0e0e1d118c5 +README.zh.md: 34075efae80c2e5275fbb782c485bea1b2661745 diff --git a/packages/host/product-telemetry-otel/README.md b/packages/host/product-telemetry-otel/README.md new file mode 100644 index 0000000000..4ce0a8744b --- /dev/null +++ b/packages/host/product-telemetry-otel/README.md @@ -0,0 +1,104 @@ +--- +description: "Configure explicit product usage events, OTLP/HTTP routing, batching, and shutdown limits." +kind: "package-reference" +--- + +# @deepseek-ai/dsh-product-telemetry-otel + +English | [中文](README.zh.md) + +## Summary + +Send selected product usage events to an OTLP/HTTP collector. Events carry a name, string summary, occurrence time, and scalar or one-level object attributes. Mounting the plugin collects nothing automatically; applications explicitly submit each event. Delivery is best effort and does not confirm warehouse ingestion. + +## Table of Contents + +- [Use this package](#use-this-package) +- [Understand the implementation](#understand-the-implementation) +- [Further Exploration](#further-exploration) +- [Model Experience](#model-experience) +- [Known Limitations and Deferred Work](#known-limitations-and-deferred-work) +- [Dev Note](#dev-note) + +----- + + +## Use this package + +Mount the plugin in a Cordis composition with the application identity; override the collector endpoint when needed. The shipped profiles do not mount it. + +```yaml +- name: '@deepseek-ai/dsh-product-telemetry-otel' + config: + endpoint: https://dsh-otel-collector.deepseeksvc.com/v1/logs + serviceName: dsh-telemetry-test + serviceVersion: test + compression: gzip + scheduledDelayMillis: 30000 +``` + +| Field | Default | Meaning | +|---|---|---| +| `endpoint` | `https://dsh-otel-collector.deepseeksvc.com/v1/logs` | Full HTTP(S) logs URL | +| `serviceName`, `serviceVersion` | required | Application identity on the OTel resource | +| `channel` | `dsh_otel_report` | Collector `x-channel` header | +| `compression` | SDK environment | `gzip` or `none`; omission honors OTel compression environment variables | +| `maxExportBatchSize`, `maxQueueSize` | `512`, `2048` | Record-count limits; batch size cannot exceed queue size | +| `scheduledDelayMillis` | `30000` | Partial-batch export interval | +| `timeoutMillis` | `15000` | Exporter HTTP and retry deadline | +| `exportTimeoutMillis` | `20000` | Processor batch export deadline | +| `shutdownTimeoutMillis` | `21000` | Outer wait for shutdown; expiry reports possible loss | + +Consumers inject `productTelemetry` and call `emit()` with explicitly selected analytics fields. Event names and field semantics belong to their product and analytics owners. The plugin reads no Session, account, credential, or device identifier. Callers must exclude prompts, responses, file contents, credentials, and other unapproved values. + +The collector expects a string body and attributes containing strings, numbers, booleans, or objects of those scalars. Callers supply occurrence time in milliseconds; the plugin assigns observation time and defaults severity to INFO. Invalid transport configuration fails at activation. Export failures produce local warnings without making event submission wait for the network. + +----- + + +## Understand the implementation + +
+Implementation internals — click to expand + +A private OTel logger feeds `BatchLogRecordProcessor` and the HTTP JSON exporter. The SDK owns queueing, transient-error retries, and compression; plugin disposal drains pending records with a bounded wait. Export completion is observed separately because SDK shutdown can resolve after a rejected export. No global OTel provider is installed. + +[`src/index.ts`](src/index.ts) owns configuration and submission. No runtime invariant companion is published: delivery has no independent local acknowledgement to compare with the SDK's queue. + +
+ +----- + + +## Further Exploration + +- [Product telemetry](../../../docs/subsystems/product-telemetry.md) — consumer types and service reference. +- [Session telemetry](../../session/session-telemetry-otel/README.md) — separate feedback-authorized Session reporting. +- [Testing policy](../../../docs/testing.md) — Loader composition and network fixtures. + +----- + + +## Model Experience + +None, as the plugin exports explicit analytics records without contributing model context. + +#### KV Cache effect + +None; event submission does not change model requests. + +## Known Limitations and Deferred Work + + + +Delivery and collection remain limited to the following capabilities. + +- No business events, renderer transport, or account/device identity are wired automatically. +- The queue is memory-only; overflow, network failure, and process exit can lose events. There is no durable outbox or warehouse acknowledgement. +- The SDK batches by record count, not encoded bytes. Callers must keep records within the collector's 4 MB limit and choose batch sizes appropriate to the receiver. +- Caller-selected strings are not redacted automatically. This package does not decide product disclosure or consent policy. + + +### Dev Note + +None. diff --git a/packages/host/product-telemetry-otel/README.zh.md b/packages/host/product-telemetry-otel/README.zh.md new file mode 100644 index 0000000000..34075efae8 --- /dev/null +++ b/packages/host/product-telemetry-otel/README.zh.md @@ -0,0 +1,104 @@ +--- +description: "配置显式产品使用事件、OTLP/HTTP 路由、批量发送与退出等待上限。" +kind: "package-reference" +--- + +# @deepseek-ai/dsh-product-telemetry-otel + +[English](README.md) | 中文 + +## 概述 + +将选定的产品使用事件发送到 OTLP/HTTP 接收服务。事件包含名称、字符串摘要、发生时间，以及标量或单层对象属性。挂载插件不会自动采集信息；应用需要显式提交每个事件。发送采用尽力而为方式，不代表数据已入仓。 + +## 目录 + +- [使用本包](#use-this-package) +- [理解实现](#understand-the-implementation) +- [延伸阅读](#further-exploration) +- [模型体验](#model-experience) +- [已知限制与待办工作](#known-limitations-and-deferred-work) +- [开发备注](#dev-note) + +----- + + +## 使用本包 + +在 Cordis 组合中挂载插件并提供应用标识；需要时可覆盖接收地址。内置 profile 不挂载本插件。 + +```yaml +- name: '@deepseek-ai/dsh-product-telemetry-otel' + config: + endpoint: https://dsh-otel-collector.deepseeksvc.com/v1/logs + serviceName: dsh-telemetry-test + serviceVersion: test + compression: gzip + scheduledDelayMillis: 30000 +``` + +| 字段 | 默认值 | 含义 | +|---|---|---| +| `endpoint` | `https://dsh-otel-collector.deepseeksvc.com/v1/logs` | 完整 HTTP(S) 日志地址 | +| `serviceName`, `serviceVersion` | 必填 | OTel resource 中的应用标识 | +| `channel` | `dsh_otel_report` | 接收服务的 `x-channel` 请求头 | +| `compression` | SDK 环境变量 | `gzip` 或 `none`；省略时遵循 OTel 压缩环境变量 | +| `maxExportBatchSize`, `maxQueueSize` | `512`, `2048` | 记录条数上限；批次大小不能超过队列大小 | +| `scheduledDelayMillis` | `30000` | 不满批次时的发送间隔 | +| `timeoutMillis` | `15000` | Exporter HTTP 发送与重试的超时时间 | +| `exportTimeoutMillis` | `20000` | Processor 批次导出的超时时间 | +| `shutdownTimeoutMillis` | `21000` | 退出时的等待上限；超时会提示可能丢失数据 | + +消费方注入 `productTelemetry`，调用 `emit()` 提交明确选定的分析字段。事件名称与字段含义由产品和数据分析负责人定义。插件不读取 Session、账号、凭证或设备标识。调用方必须排除提示词、回答、文件内容、凭证及其他未经批准的数据。 + +接收服务要求 body 为字符串，attributes 的值为字符串、数字、布尔值或由这些标量组成的对象。调用方以毫秒提供发生时间；插件填写观测时间，默认严重程度为 INFO。无效传输配置在激活时报错。发送失败产生本地警告，事件提交不等待网络。 + +----- + + +## 理解实现 + +
+实现细节——点击展开 + +私有 OTel logger 将记录交给 `BatchLogRecordProcessor` 和 HTTP JSON exporter。SDK 负责队列、临时错误重试与压缩；插件卸载时在限定时间内发送剩余记录。发送完成结果单独观测，因为 SDK 在发送被拒绝后仍可能正常完成退出。不安装全局 OTel provider。 + +[`src/index.ts`](src/index.ts) 负责配置与提交。不发布运行时不变量伴随模块：本地没有独立的送达确认可与 SDK 队列比较。 + +
+ +----- + + +## 延伸阅读 + +- [产品埋点](../../../docs/subsystems/product-telemetry.zh.md)——消费方类型与服务参考。 +- [会话上报](../../session/session-telemetry-otel/README.zh.md)——独立的、由反馈授权的 Session 上报。 +- [测试策略](../../../docs/testing.zh.md)——Loader 组合与网络测试夹具。 + +----- + + +## 模型体验 + +无，因为插件仅发送显式分析记录，不提供模型上下文。 + +#### KV Cache 影响 + +无；提交事件不会改变模型请求。 + +## 已知限制与待办工作 + + + +发送和采集受以下能力限制。 + +- 不自动接入业务事件、渲染进程传输或账号与设备标识。 +- 队列仅存在于内存；队列溢出、网络故障和进程退出可能丢失事件。没有持久发件箱或入仓确认。 +- SDK 按记录条数而非编码字节数分批。调用方必须确保记录不超过接收服务的 4 MB 限制，并选择接收服务适用的批次大小。 +- 不自动脱敏调用方选择的字符串。本包不决定产品告知或同意策略。 + + +### 开发备注 + +无。 diff --git a/packages/host/product-telemetry-otel/package.json b/packages/host/product-telemetry-otel/package.json new file mode 100644 index 0000000000..24dff2ab6a --- /dev/null +++ b/packages/host/product-telemetry-otel/package.json @@ -0,0 +1,47 @@ +{ + "name": "@deepseek-ai/dsh-product-telemetry-otel", + "description": "Explicit product usage events exported through OpenTelemetry HTTP logs", + "version": "0.1.6-alpha.2", + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/deepseek-ai/deepseek-harness.git", + "directory": "packages/host/product-telemetry-otel" + }, + "type": "module", + "main": "lib/index.js", + "types": "lib/types/index.d.ts", + "exports": { + ".": { + "types": "./lib/types/index.d.ts", + "default": "./lib/index.js" + }, + "./src/*": "./src/*", + "./package.json": "./package.json" + }, + "files": [ + "lib/index.js", + "lib/types/**/*.d.ts" + ], + "license": "MIT", + "dependencies": { + "@opentelemetry/api-logs": "^0.220.0", + "@opentelemetry/exporter-logs-otlp-http": "^0.220.0", + "@opentelemetry/otlp-exporter-base": "^0.220.0", + "@opentelemetry/resources": "^2.9.0", + "@opentelemetry/sdk-logs": "^0.220.0", + "@deepseek-ai/schemastery": "workspace:^", + "@opentelemetry/core": "2.9.0" + }, + "peerDependencies": { + "@deepseek-ai/cordis": "workspace:^" + }, + "devDependencies": { + "@deepseek-ai/cordis": "workspace:^", + "@deepseek-ai/cordis-plugin-loader": "workspace:^", + "@deepseek-ai/dsh-app-boot": "workspace:^", + "@deepseek-ai/dsh-loader-smoke": "workspace:^" + } +} diff --git a/packages/host/product-telemetry-otel/src/index.ts b/packages/host/product-telemetry-otel/src/index.ts new file mode 100644 index 0000000000..b617702172 --- /dev/null +++ b/packages/host/product-telemetry-otel/src/index.ts @@ -0,0 +1,154 @@ +/** Explicit product usage events over OTLP/HTTP; no automatic collection or Session access. */ +import { Context, Service } from '@deepseek-ai/cordis' +import z from '@deepseek-ai/schemastery' +import { SeverityNumber, type Logger } from '@opentelemetry/api-logs' +import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http' +import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base' +import { ExportResultCode } from '@opentelemetry/core' +import { resourceFromAttributes } from '@opentelemetry/resources' +import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs' + +declare module '@deepseek-ai/cordis' { + interface Context { + productTelemetry: ProductTelemetry + } +} + +/** Scalar values accepted by the collector's Arrow attributes map. */ +export type ProductTelemetryScalar = string | number | boolean + +/** Explicitly selected analytics fields; object values may contain scalars only. */ +export interface ProductTelemetryRecord { + /** Product/DA-owned event name. */ + eventName: string + /** Human-readable summary; never a prompt, response, credential, or file contents. */ + body: string + /** Event occurrence time in Unix milliseconds. Observation time is assigned on enqueue. */ + timestamp: number + /** OTel severity; omitted values use INFO. */ + severityNumber?: SeverityNumber + /** Business fields selected by the caller; no automatic device or account identity. */ + attributes?: Record> +} + +/** Collector routing, application identity, and bounded in-memory batch settings. */ +export interface Config { + /** Full HTTP(S) logs URL. */ + endpoint: string + /** Collector routing header. */ + channel: string + /** Resource service.name supplied by the application composition. */ + serviceName: string + /** Resource service.version supplied by the application composition. */ + serviceVersion: string + /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ + compression?: 'none' | 'gzip' + /** Maximum records per export; must not exceed maxQueueSize. */ + maxExportBatchSize: number + /** Maximum queued records; the SDK drops new records when full. */ + maxQueueSize: number + /** Delay before exporting a partial batch. */ + scheduledDelayMillis: number + /** Exporter HTTP deadline, including SDK transient-error retries. */ + timeoutMillis: number + /** Processor deadline for one batch export. */ + exportTimeoutMillis: number + /** Outer shutdown wait; pending exports may be lost after this deadline. */ + shutdownTimeoutMillis: number +} + +const positiveInteger = () => z.number().step(1).min(1).max(2_147_483_647) + +/** Loader validation; the same schema resolves defaults for direct construction. */ +export const Config: z, Config> = z.object({ + endpoint: z.string().default('https://dsh-otel-collector.deepseeksvc.com/v1/logs'), + channel: z.string().default('dsh_otel_report'), + serviceName: z.string().required(), + serviceVersion: z.string().required(), + compression: z.union(['none', 'gzip']), + maxExportBatchSize: positiveInteger().default(512), + maxQueueSize: positiveInteger().default(2048), + scheduledDelayMillis: positiveInteger().default(30000), + timeoutMillis: positiveInteger().default(15000), + exportTimeoutMillis: positiveInteger().default(20000), + shutdownTimeoutMillis: positiveInteger().default(21000), +}) + +/** Host analytics sender. Mounting alone sends nothing; the owning fiber drains it on unload. */ +export default class ProductTelemetry extends Service { + static Config = Config + private readonly logger: Logger + + constructor(ctx: Context, input: Config) { + const config = Config(input) + const endpoint = new URL(config.endpoint) + if (!['http:', 'https:'].includes(endpoint.protocol)) { + throw new Error('product-telemetry-otel: endpoint must use HTTP or HTTPS') + } + if (config.maxExportBatchSize > config.maxQueueSize) { + throw new Error('product-telemetry-otel: maxExportBatchSize must not exceed maxQueueSize') + } + super(ctx, 'productTelemetry') + const exporter = new OTLPLogExporter({ + url: config.endpoint, + headers: { 'x-channel': config.channel }, + timeoutMillis: config.timeoutMillis, + ...(config.compression === undefined ? {} : { + compression: config.compression === 'gzip' ? CompressionAlgorithm.GZIP : CompressionAlgorithm.NONE, + }), + }) + const provider = new LoggerProvider({ + resource: resourceFromAttributes({ + 'service.name': config.serviceName, + 'service.version': config.serviceVersion, + }), + processors: [new BatchLogRecordProcessor({ + maxExportBatchSize: config.maxExportBatchSize, + maxQueueSize: config.maxQueueSize, + scheduledDelayMillis: config.scheduledDelayMillis, + exportTimeoutMillis: config.exportTimeoutMillis, + exporter: { + export: (records, callback) => { + exporter.export(records, (result) => { + // SDK flush/shutdown can resolve after export failure; observe the actual completion. + if (result.code !== ExportResultCode.SUCCESS) ctx.logger.warn('Product telemetry export failed') + callback(result) + }) + }, + forceFlush: () => exporter.forceFlush(), + shutdown: () => exporter.shutdown(), + }, + })], + }) + this.logger = provider.getLogger('@deepseek-ai/dsh-product-telemetry-otel') + ctx.effect(() => async () => { + let timer!: ReturnType + const deadline = new Promise((resolve) => { + timer = setTimeout(() => { + ctx.logger.warn('Product telemetry shutdown deadline exceeded; pending events may be lost') + resolve() + }, config.shutdownTimeoutMillis) + }) + try { + await Promise.race([provider.shutdown(), deadline]) + } finally { + clearTimeout(timer) + } + }) + } + + /** + * Enqueue one selected product event without waiting for network delivery. + * Queue admission and shutdown completion are not collector or warehouse acknowledgements. + * @param record - caller-owned event containing only approved analytics fields. + */ + emit(record: ProductTelemetryRecord): void { + const severityNumber = record.severityNumber ?? SeverityNumber.INFO + this.logger.emit({ + ...record, + observedTimestamp: Date.now(), + severityNumber, + severityText: SeverityNumber[severityNumber], + }) + } +} diff --git a/packages/host/product-telemetry-otel/tests/fixtures/driver.ts b/packages/host/product-telemetry-otel/tests/fixtures/driver.ts new file mode 100644 index 0000000000..4dfac67960 --- /dev/null +++ b/packages/host/product-telemetry-otel/tests/fixtures/driver.ts @@ -0,0 +1,42 @@ +/** Loader composition with a loopback collector and one explicit synthetic event. */ +import { createServer } from 'node:http' +import { once } from 'node:events' +import { gunzipSync } from 'node:zlib' +import { writeFile } from 'node:fs/promises' +import type {} from '@deepseek-ai/dsh-product-telemetry-otel' +import { bootProductionProfile } from '../../../../test-support/loader-smoke/tests/fixtures/production-profile.ts' + +const configPath = process.argv[2] +if (configPath === undefined) throw new Error('product telemetry fixture requires an overlay') +const captures: unknown[] = [] +const server = createServer((req, res) => { + const chunks: Buffer[] = [] + req.on('data', chunk => chunks.push(chunk as Buffer)) + req.on('end', () => { + const bytes = Buffer.concat(chunks) + const body: unknown = JSON.parse(gunzipSync(bytes).toString()) + captures.push({ channel: req.headers['x-channel'], compression: req.headers['content-encoding'], body }) + res.writeHead(200, { 'content-type': 'application/json' }).end('{}') + }) +}) +try { + server.listen(0, '127.0.0.1') + await once(server, 'listening') + const address = server.address() + if (address === null || typeof address === 'string') throw new Error('collector has no port') + process.env.DSH_PRODUCT_TELEMETRY_TEST_ENDPOINT = `http://127.0.0.1:${address.port}/v1/logs` + const ctx = await bootProductionProfile({ binName: 'product-telemetry-test', profile: 'headless', overlayPaths: [configPath] }) + try { + const telemetry = ctx.get('productTelemetry') + if (telemetry === undefined) throw new Error('product telemetry did not activate') + telemetry.emit({ eventName: 'telemetry.synthetic', timestamp: 1_800_000_000_000, body: 'Synthetic test', attributes: { synthetic: true } }) + } finally { + await ctx.fiber.dispose() + } + await writeFile('captures.json', JSON.stringify(captures)) +} finally { + const closed = once(server, 'close') + server.close() + server.closeAllConnections() + await closed +} diff --git a/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml b/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml new file mode 100644 index 0000000000..c876c3d646 --- /dev/null +++ b/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml @@ -0,0 +1,15 @@ +- id: session-telemetry-otel + disabled: true +- id: headless-startup + disabled: true +- id: headless-runner + disabled: true +- insert: + - id: product-telemetry-otel + name: '@deepseek-ai/dsh-product-telemetry-otel' + config: + endpoint: !!js process.env.DSH_PRODUCT_TELEMETRY_TEST_ENDPOINT + serviceName: dsh-telemetry-test + serviceVersion: test + compression: gzip + scheduledDelayMillis: 60000 diff --git a/packages/host/product-telemetry-otel/tests/loader-composition.e2e.ts b/packages/host/product-telemetry-otel/tests/loader-composition.e2e.ts new file mode 100644 index 0000000000..13acb46e00 --- /dev/null +++ b/packages/host/product-telemetry-otel/tests/loader-composition.e2e.ts @@ -0,0 +1,23 @@ +import { readFile } from 'node:fs/promises' +import { resolve } from 'node:path' +import { expect, it } from 'vitest' +import { runLoaderSmoke, LOADER_SMOKE_TEST_TIMEOUT_MS } from '@deepseek-ai/dsh-loader-smoke' + +it('exports the explicitly submitted event through the headless Loader composition', async () => { + let captures: unknown + const driver = resolve(import.meta.dirname, 'fixtures/driver.ts') + await runLoaderSmoke({ + label: 'product telemetry composition', + tempDirPrefix: 'product-telemetry-', + binScript: driver, + libBinScript: driver, + configPath: resolve(import.meta.dirname, 'fixtures/telemetry.patch.yml'), + tsconfigPath: resolve(import.meta.dirname, '../../../../tsconfig.base.json'), + inspect: async (cwd) => { captures = JSON.parse(await readFile(resolve(cwd, 'captures.json'), 'utf8')) }, + }) + expect(captures).toMatchObject([{ + channel: 'dsh_otel_report', compression: 'gzip', + body: { resourceLogs: [{ scopeLogs: [{ logRecords: [{ eventName: 'telemetry.synthetic', body: { stringValue: 'Synthetic test' } }] }] }] }, + }]) + expect(JSON.stringify(captures).match(/"eventName"/g)).toHaveLength(1) +}, LOADER_SMOKE_TEST_TIMEOUT_MS) diff --git a/packages/host/product-telemetry-otel/tests/telemetry.spec.ts b/packages/host/product-telemetry-otel/tests/telemetry.spec.ts new file mode 100644 index 0000000000..424ec5917a --- /dev/null +++ b/packages/host/product-telemetry-otel/tests/telemetry.spec.ts @@ -0,0 +1,157 @@ +import { createServer, type IncomingHttpHeaders } from 'node:http' +import { once } from 'node:events' +import { gunzipSync } from 'node:zlib' +import { afterEach, describe, expect, it, vi } from 'vitest' +import { Context } from '@deepseek-ai/cordis' +import { LoggerProvider } from '@opentelemetry/sdk-logs' +import { SeverityNumber } from '@opentelemetry/api-logs' +import ProductTelemetry, { Config } from '../src/index.ts' + +interface Capture { + headers: IncomingHttpHeaders + body: { resourceLogs: { resource: unknown; scopeLogs: { logRecords: Record[] }[] }[] } +} +const cleanup: (() => Promise)[] = [] +afterEach(async () => { + try { + for (const dispose of cleanup.splice(0).reverse()) await dispose() + } finally { + vi.restoreAllMocks() + vi.useRealTimers() + } +}) + +async function collector(statuses = [200]) { + const captures: Capture[] = [] + const server = createServer((req, res) => { + const chunks: Buffer[] = [] + req.on('data', chunk => chunks.push(chunk as Buffer)) + req.on('end', () => { + const raw = Buffer.concat(chunks) + const bytes = req.headers['content-encoding'] === 'gzip' ? gunzipSync(raw) : raw + captures.push({ headers: req.headers, body: JSON.parse(bytes.toString()) as Capture['body'] }) + res.writeHead(statuses.shift() ?? 200, { 'content-type': 'application/json' }).end('{}') + }) + }) + cleanup.push(async () => { + const closed = once(server, 'close') + server.close() + server.closeAllConnections() + await closed + }) + server.listen(0, '127.0.0.1') + await once(server, 'listening') + const address = server.address() + if (address === null || typeof address === 'string') throw new Error('collector has no port') + return { captures, endpoint: `http://127.0.0.1:${address.port}/v1/logs` } +} + +function config(endpoint: string, overrides: Partial = {}): Config { + return Config({ endpoint, serviceName: 'synthetic-test', serviceVersion: '1', scheduledDelayMillis: 60_000, ...overrides }) +} + +function context() { + const ctx = new Context() + cleanup.push(() => ctx.fiber.dispose()) + return ctx +} + +const event = { eventName: 'telemetry.synthetic', body: 'Synthetic test', timestamp: 1_800_000_000_000 } + +describe('explicit product telemetry', () => { + it.each(['gzip', 'none', undefined] as const)('drains typed events with %s compression and removes the service', async (compression) => { + const target = await collector() + const ctx = context() + const fiber = await ctx.plugin(ProductTelemetry, config(target.endpoint, compression === undefined ? {} : { compression })) + const service = ctx.productTelemetry + expect(target.captures).toEqual([]) + service.emit({ ...event, attributes: { text: 'test', count: 2, duration: 1.5, synthetic: true, model: { provider: 'test', count: 1, enabled: false } } }) + service.emit({ ...event, severityNumber: SeverityNumber.ERROR }) + await fiber.dispose() + expect(ctx.get('productTelemetry')).toBeUndefined() + service.emit(event) + expect(target.captures).toHaveLength(1) + const [capture] = target.captures + expect(capture?.headers['x-channel']).toBe('dsh_otel_report') + expect(capture?.headers['content-encoding']).toBe(compression === 'gzip' ? 'gzip' : undefined) + const logs = capture?.body.resourceLogs.flatMap(r => r.scopeLogs.flatMap(s => s.logRecords)) + expect(logs).toHaveLength(2) + expect(logs?.[0]).toMatchObject({ + eventName: event.eventName, body: { stringValue: event.body }, severityNumber: 9, + timeUnixNano: '1800000000000000000', + }) + expect(logs?.[0]?.['attributes']).toEqual(expect.arrayContaining([ + { key: 'text', value: { stringValue: 'test' } }, + { key: 'count', value: { intValue: 2 } }, + { key: 'duration', value: { doubleValue: 1.5 } }, + { key: 'synthetic', value: { boolValue: true } }, + { key: 'model', value: { kvlistValue: { values: [{ key: 'provider', value: { stringValue: 'test' } }, { key: 'count', value: { intValue: 1 } }, { key: 'enabled', value: { boolValue: false } }] } } }, + ])) + expect(Number(logs?.[0]?.['observedTimeUnixNano'])).toBeGreaterThan(0) + expect(logs?.[1]?.['severityNumber']).toBe(17) + expect(JSON.stringify(capture)).not.toContain('user.id') + }) + + it('does not export on mount or empty shutdown', async () => { + const target = await collector() + const fiber = await context().plugin(ProductTelemetry, config(target.endpoint)) + await fiber.dispose() + expect(target.captures).toEqual([]) + }) + + it('exports at the batch threshold and retries a transient rejection', async () => { + const target = await collector([503, 200]) + const ctx = context() + await ctx.plugin(ProductTelemetry, config(target.endpoint, { maxExportBatchSize: 1 })) + ctx.productTelemetry.emit(event) + await vi.waitFor(() => { expect(target.captures).toHaveLength(2) }, { timeout: 10_000 }) + expect(target.captures[0]?.body).toEqual(target.captures[1]?.body) + }) + + it('exports a partial batch on its configured interval', async () => { + const target = await collector() + const ctx = context() + await ctx.plugin(ProductTelemetry, config(target.endpoint, { scheduledDelayMillis: 10 })) + ctx.productTelemetry.emit(event) + await vi.waitFor(() => { expect(target.captures).toHaveLength(1) }) + }) + + it('reports a permanent export rejection without failing the caller', async () => { + const target = await collector([400]) + const ctx = context() + const warn = vi.spyOn(ctx.logger, 'warn') + const fiber = await ctx.plugin(ProductTelemetry, config(target.endpoint)) + expect(() => { ctx.productTelemetry.emit(event) }).not.toThrow() + await fiber.dispose() + expect(target.captures).toHaveLength(1) + expect(warn).toHaveBeenCalledWith('Product telemetry export failed') + }) + + it.each([ + { endpoint: 'broken' }, { endpoint: 'ftp://collector.test/logs' }, + { maxExportBatchSize: 0 }, { maxExportBatchSize: 2, maxQueueSize: 1 }, + { maxQueueSize: -1 }, { scheduledDelayMillis: 0 }, { exportTimeoutMillis: Infinity }, + { shutdownTimeoutMillis: 2_147_483_648 }, + ])('rejects invalid configuration %j before exposing the service', (invalid) => { + const ctx = context() + expect(() => new ProductTelemetry(ctx, config('http://collector.test/v1/logs', invalid))).toThrow() + expect(ctx.get('productTelemetry')).toBeUndefined() + }) + + it('bounds a stalled shutdown and observes its later settlement', async () => { + const target = await collector() + const ctx = context() + const warn = vi.spyOn(ctx.logger, 'warn') + const fiber = await ctx.plugin(ProductTelemetry, config(target.endpoint, { shutdownTimeoutMillis: 20 })) + const pending = Promise.withResolvers() + vi.spyOn(LoggerProvider.prototype, 'shutdown').mockReturnValue(pending.promise) + vi.useFakeTimers() + const disposal = fiber.dispose() + await vi.advanceTimersByTimeAsync(20) + await disposal + expect(warn).toHaveBeenCalledWith('Product telemetry shutdown deadline exceeded; pending events may be lost') + pending.resolve(undefined) + await pending.promise + await vi.advanceTimersByTimeAsync(0) + }) +}) diff --git a/packages/host/product-telemetry-otel/tsconfig.json b/packages/host/product-telemetry-otel/tsconfig.json new file mode 100644 index 0000000000..f0063ae28d --- /dev/null +++ b/packages/host/product-telemetry-otel/tsconfig.json @@ -0,0 +1,21 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "lib/types" + }, + "include": [ + "src" + ], + "references": [ + { + "path": "../../../vendor/cosmokit" + }, + { + "path": "../../../vendor/cordis" + }, + { + "path": "../../../vendor/schemastery" + } + ] +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index eaec62559b..c90b706eec 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -8172,6 +8172,43 @@ importers: specifier: workspace:^ version: link:../../typert/protocol + packages/host/product-telemetry-otel: + dependencies: + '@deepseek-ai/schemastery': + specifier: link:../../../vendor/schemastery + version: link:../../../vendor/schemastery + '@opentelemetry/api-logs': + specifier: ^0.220.0 + version: 0.220.0 + '@opentelemetry/core': + specifier: 2.9.0 + version: 2.9.0(@opentelemetry/api@1.9.1) + '@opentelemetry/exporter-logs-otlp-http': + specifier: ^0.220.0 + version: 0.220.0(@opentelemetry/api@1.9.1) + '@opentelemetry/otlp-exporter-base': + specifier: ^0.220.0 + version: 0.220.0(@opentelemetry/api@1.9.1) + '@opentelemetry/resources': + specifier: ^2.9.0 + version: 2.10.0(@opentelemetry/api@1.9.1) + '@opentelemetry/sdk-logs': + specifier: ^0.220.0 + version: 0.220.0(@opentelemetry/api@1.9.1) + devDependencies: + '@deepseek-ai/cordis': + specifier: workspace:^ + version: link:../../../vendor/cordis + '@deepseek-ai/cordis-plugin-loader': + specifier: workspace:^ + version: link:../../../vendor/loader + '@deepseek-ai/dsh-app-boot': + specifier: workspace:^ + version: link:../../boot/app-boot + '@deepseek-ai/dsh-loader-smoke': + specifier: workspace:^ + version: link:../../test-support/loader-smoke + packages/host/webserver: dependencies: '@deepseek-ai/schemastery': diff --git a/scripts/gen-cordis-catalog.ts b/scripts/gen-cordis-catalog.ts index 3600155fcd..637a0c389f 100644 --- a/scripts/gen-cordis-catalog.ts +++ b/scripts/gen-cordis-catalog.ts @@ -56,6 +56,7 @@ export { REGION_BEGIN, REGION_END } export const SERVICE_PAGE: Record = { speechToText: 'voice-input.md', speechController: 'voice-input.md', + productTelemetry: 'product-telemetry.md', connection: 'web-server.md', pluginManager: 'boot.md', profileContext: 'boot.md', @@ -266,6 +267,8 @@ export const EVENT_WALK_EXEMPTIONS: Record = { * appear on more than one page. */ export const LINK_MAP: Readonly> = { + ProductTelemetryRecord: 'product-telemetry.md', + ProductTelemetryScalar: 'product-telemetry.md', WorkspaceChangesSummary: 'deliverables.md', WorkspaceFileDiff: 'deliverables.md', Reload: 'boot.md', diff --git a/scripts/gen-doc-graphs.ts b/scripts/gen-doc-graphs.ts index 1c676c29d7..dd3d68126c 100644 --- a/scripts/gen-doc-graphs.ts +++ b/scripts/gen-doc-graphs.ts @@ -99,6 +99,13 @@ const GROUP_ORDER = [ ] const SERVICE_ROLES: ServiceRole[] = [ + { + key: 'productTelemetry', + pkg: 'product-telemetry-otel', + title: 'Product usage event sender', + mode: 'core', + note: 'Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing.', + }, { key: 'hmr', pkg: 'hmr', diff --git a/scripts/verify-package-readme-model-experience.ts b/scripts/verify-package-readme-model-experience.ts index 5044b71f8b..c0d7106d42 100644 --- a/scripts/verify-package-readme-model-experience.ts +++ b/scripts/verify-package-readme-model-experience.ts @@ -49,6 +49,7 @@ const SENTENCE_MODEL_EXPERIENCE: Readonly> = { 'packages/experimental/speech-to-text-sensevoice': { kind: 'none', reason: 'Local recognition returns transient text without modifying model context.' }, 'packages/experimental/client-ui-voice-input': { kind: 'none', reason: 'Inserts reviewable text into the unsent draft without submitting to the Agent.' }, 'packages/experimental/voice-input-bundle': { kind: 'none', reason: 'Composes dictation and preparation plugins without adding any model-facing contribution.' }, + 'packages/host/product-telemetry-otel': { kind: 'none', reason: 'The plugin exports explicit analytics records without contributing model context.' }, 'packages/api/terminal-controller': { kind: 'none', reason: 'User-owned terminal processes and screen streams never enter model requests or Session events.' }, 'packages/client/ui-sidebar-terminal': { kind: 'none', reason: 'The browser renders user terminal screens without exposing them to the model.' }, 'packages/ssh/ssh': { kind: 'none', reason: 'The connection owner transports private provider operations; consumers own all model-facing content.' }, diff --git a/tsconfig.base.json b/tsconfig.base.json index 6d331689a3..9709e7f5b9 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -396,6 +396,7 @@ "@deepseek-ai/dsh-plan-mode": ["./packages/plan/plan-mode/src"], "@deepseek-ai/dsh-plan-mode/invariant": ["./packages/plan/plan-mode/src/invariant.ts"], "@deepseek-ai/dsh-plugin-package-inventory-deepseek": ["./packages/llm/plugin-package-inventory-deepseek/src"], + "@deepseek-ai/dsh-product-telemetry-otel": ["./packages/host/product-telemetry-otel/src"], "@deepseek-ai/dsh-ptc-runtime": ["./packages/ptc-runtime/ptc-runtime/src"], "@deepseek-ai/dsh-ptc-runtime-node": ["./packages/ptc-runtime/ptc-runtime-node/src"], "@deepseek-ai/dsh-pwsh-sandbox": ["./packages/shell/pwsh-sandbox/src"], diff --git a/tsconfig.host.json b/tsconfig.host.json index 0dd50f4d02..ef20adab36 100644 --- a/tsconfig.host.json +++ b/tsconfig.host.json @@ -177,6 +177,7 @@ { "path": "./packages/experimental/api-speech-to-text" }, { "path": "./packages/experimental/voice-input-bundle" }, + { "path": "./packages/host/product-telemetry-otel" }, { "path": "./packages/client/connection/tsconfig.host.json" }, { "path": "./packages/skill/skill-office" }, { "path": "./packages/skill/tool-workspace-dependencies" }, From 535cb4aae30cf276d32cb6ad051eb736aab98900 Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Mon, 21 Sep 2026 17:45:19 +0800 Subject: [PATCH 8/9] fix(telemetry): isolate collector transport and address review --- THIRD_PARTY_NOTICES.md | 1 + docs/capability-seams.i18n.yaml | 4 +- docs/capability-seams.md | 10 +-- docs/capability-seams.zh.md | 10 +-- docs/config-catalog.i18n.yaml | 4 +- docs/config-catalog.md | 68 +++++++++---------- docs/config-catalog.zh.md | 68 +++++++++---------- docs/subsystems/README.i18n.yaml | 4 +- docs/subsystems/README.md | 2 +- docs/subsystems/README.zh.md | 2 +- docs/subsystems/product-telemetry.i18n.yaml | 4 +- docs/subsystems/product-telemetry.md | 25 +++++++ docs/subsystems/product-telemetry.zh.md | 25 +++++++ packages/README.i18n.yaml | 4 +- packages/README.md | 2 +- packages/README.zh.md | 2 +- packages/host/README.i18n.yaml | 4 +- packages/host/README.md | 5 +- packages/host/README.zh.md | 5 +- .../product-telemetry-otel/README.i18n.yaml | 4 +- .../host/product-telemetry-otel/README.md | 18 +++-- .../host/product-telemetry-otel/README.zh.md | 18 +++-- .../host/product-telemetry-otel/package.json | 15 ++-- .../host/product-telemetry-otel/src/index.ts | 43 ++++++++---- .../tests/fixtures/driver.ts | 3 +- .../tests/fixtures/telemetry.patch.yml | 4 +- .../tests/telemetry.spec.ts | 50 +++++++++++++- pnpm-lock.yaml | 7 +- scripts/gen-doc-graphs.ts | 19 +++--- scripts/type-equiv.manifest.json | 10 +++ tsconfig.base.json | 2 +- 31 files changed, 289 insertions(+), 153 deletions(-) diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index e0e5b174eb..e44344f777 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -57,6 +57,7 @@ External packages installed for runtime use or distributed inside the prebuilt b | [`@opentelemetry/core`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/exporter-logs-otlp-http`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/otlp-exporter-base`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | +| [`@opentelemetry/otlp-transformer`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/resources`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@opentelemetry/sdk-logs`](https://github.com/open-telemetry/opentelemetry-js) | Apache-2.0 | | [`@playwright/mcp`](https://github.com/microsoft/playwright-mcp) | Apache-2.0 | diff --git a/docs/capability-seams.i18n.yaml b/docs/capability-seams.i18n.yaml index 410b06d888..6a71bb9da7 100644 --- a/docs/capability-seams.i18n.yaml +++ b/docs/capability-seams.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/capability-seams.md -capability-seams.md: d9232c12528c274f48b85e725b944e565a5431de -capability-seams.zh.md: 81e6aabc5351b9a0827fbd544e46d704688c9338 +capability-seams.md: 072cb47af420136a08ce182cfa341bb42fc068e0 +capability-seams.zh.md: 138fb3241a00cb2f6ab8853dd9cbf1440fe6d490 diff --git a/docs/capability-seams.md b/docs/capability-seams.md index d9232c1252..072cb47af4 100644 --- a/docs/capability-seams.md +++ b/docs/capability-seams.md @@ -3,12 +3,10 @@ # Capability Seams And Core Services -A service can be a core spine service, a swappable capability seam, or a bundle/composition point. The graph shows the package that owns the service declaration, known implementation packages, and packages that consume the service directly. +A service can be a core spine service, a swappable capability seam, a bundle/composition point, or a standalone service. The graph shows the package that owns the service declaration, known implementation packages, and packages that consume the service directly. ```mermaid flowchart LR - pkg_product_telemetry_otel["product-telemetry-otel"] - svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_hmr["hmr"] svc_hmr["ctx.hmr
Serialized module and configuration reloads"] pkg_app_boot["app-boot"] @@ -106,6 +104,8 @@ flowchart LR pkg_credentials_local["credentials-local"] pkg_authorization["authorization"] svc_authorization["ctx.authorization
Authorization flow registry"] + pkg_host_product_telemetry_otel["host-product-telemetry-otel"] + svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_session_telemetry["session-telemetry"] svc_sessionTelemetry["ctx.sessionTelemetry
Session telemetry seam"] pkg_session_telemetry_otel["session-telemetry-otel"] @@ -320,6 +320,7 @@ flowchart LR pkg_host_directory_picker --> svc_directoryPicker pkg_host_directory_picker_browse --> svc_directoryPicker pkg_host_directory_picker_native --> svc_directoryPicker + pkg_host_product_telemetry_otel --> svc_productTelemetry pkg_host_webserver --> svc_webServer pkg_inspector --> svc_inspector pkg_invariants --> svc_invariants @@ -339,7 +340,6 @@ flowchart LR pkg_plan_mode --> svc_planMode pkg_plugin_manager --> svc_pluginManager pkg_plugin_package_inventory_deepseek --> svc_deepseekLlmApiExtensions - pkg_product_telemetry_otel --> svc_productTelemetry pkg_ptc_runtime --> svc_ptcRuntime pkg_ptc_runtime_node --> svc_ptcRuntime pkg_pwsh_local --> svc_shell @@ -554,7 +554,6 @@ flowchart LR | ctx key | Role | Owner | Implementations | Direct consumers | Companion plugins | Note | | --- | --- | --- | --- | --- | --- | --- | -| `ctx.productTelemetry` | `core` | [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing. | | `ctx.hmr` | `core` | [`hmr`](../packages/boot/hmr) | - | [`app-boot`](../packages/boot/app-boot) | - | Owns module and exact configuration watchers; application mutations share its queue and automatic reloads await the application file lock. | | `ctx.pluginManager` | `core` | [`plugin-manager`](../packages/boot/plugin-manager) | - | [`plugin-manager`](../packages/boot/plugin-manager), `ui-settings-plugin-inventory` | - | Shares profile package operations with the CLI and reports persisted and running state to Web and agent callers. | | `ctx.profileContext` | `core` | [`app-boot`](../packages/boot/app-boot) | - | [`plugin-manager`](../packages/boot/plugin-manager) | - | The dsh launcher supplies data-only profile locations and composition inputs; reload scheduling belongs to dsh-hmr. | @@ -590,6 +589,7 @@ flowchart LR | `ctx.subagentModelSelection` | `core` | [`tool-subagent`](../packages/subagent/tool-subagent) | - | [`tool-subagent`](../packages/subagent/tool-subagent) | - | Owns the default-off settings namespace that Agent-scoped delegation tools sample when composing a new top-level Session. | | `ctx.credentials` | `seam` | [`credentials`](../packages/credentials/credentials) | [`credentials-local`](../packages/credentials/credentials-local) | [`api-settings-controller`](../packages/api/settings-controller), [`llm-deepseek`](../packages/llm/llm-deepseek), [`llm-pi-ai`](../packages/llm/llm-pi-ai) | - | Configuration carries references to secrets; providers own the values. Consumers resolve per operation, so a rotated credential reaches the very next request; the settings controller exposes value-free views and write-only storage. | | `ctx.authorization` | `seam` | [`authorization`](../packages/credentials/authorization) | - | [`llm-pi-ai`](../packages/llm/llm-pi-ai) | - | Flows are registered by the plugin that knows how to obtain one credential and keyed by the record they write; the seam owns the conversation and the one-attempt-per-key lifecycle, never the protocol. | +| `ctx.productTelemetry` | `service` | [`host-product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing. | | `ctx.sessionTelemetry` | `seam` | [`session-telemetry`](../packages/session/session-telemetry) | [`session-telemetry-otel`](../packages/session/session-telemetry-otel) | - | - | The seam captures, redacts, and hands session records to one backend; nothing else consumes the service — its output leaves the process. | | `ctx.storage` | `seam` | [`storage`](../packages/storage/storage) | [`storage-json`](../packages/storage/storage-json), [`storage-sqlite`](../packages/storage/storage-sqlite) | [`storage-domain`](../packages/storage/storage-domain) | - | Backends register side by side under names; data forms (domain first) mount on the hub and translate typed operations into opaque KV-unit primitives. | | `ctx.storageDomain` | `core` | [`storage-domain`](../packages/storage/storage-domain) | - | [`workspace`](../packages/workspace/workspace) | - | Waits for every configured backend, then publishes the domain form as one lifecycle-bound service for typed durable state. | diff --git a/docs/capability-seams.zh.md b/docs/capability-seams.zh.md index 81e6aabc53..138fb3241a 100644 --- a/docs/capability-seams.zh.md +++ b/docs/capability-seams.zh.md @@ -5,12 +5,10 @@ [English](capability-seams.md) | 中文 -服务可以是核心主干服务、可替换的能力 seam，也可以是组合包／组合点。下图展示了拥有服务声明的包、已知实现包，以及直接消费该服务的包。 +服务可以是核心主干服务、可替换的能力 seam、组合包／组合点或独立服务。下图展示了拥有服务声明的包、已知实现包，以及直接消费该服务的包。 ```mermaid flowchart LR - pkg_product_telemetry_otel["product-telemetry-otel"] - svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_hmr["hmr"] svc_hmr["ctx.hmr
Serialized module and configuration reloads"] pkg_app_boot["app-boot"] @@ -108,6 +106,8 @@ flowchart LR pkg_credentials_local["credentials-local"] pkg_authorization["authorization"] svc_authorization["ctx.authorization
Authorization flow registry"] + pkg_host_product_telemetry_otel["host-product-telemetry-otel"] + svc_productTelemetry["ctx.productTelemetry
Product usage event sender"] pkg_session_telemetry["session-telemetry"] svc_sessionTelemetry["ctx.sessionTelemetry
Session telemetry seam"] pkg_session_telemetry_otel["session-telemetry-otel"] @@ -322,6 +322,7 @@ flowchart LR pkg_host_directory_picker --> svc_directoryPicker pkg_host_directory_picker_browse --> svc_directoryPicker pkg_host_directory_picker_native --> svc_directoryPicker + pkg_host_product_telemetry_otel --> svc_productTelemetry pkg_host_webserver --> svc_webServer pkg_inspector --> svc_inspector pkg_invariants --> svc_invariants @@ -341,7 +342,6 @@ flowchart LR pkg_plan_mode --> svc_planMode pkg_plugin_manager --> svc_pluginManager pkg_plugin_package_inventory_deepseek --> svc_deepseekLlmApiExtensions - pkg_product_telemetry_otel --> svc_productTelemetry pkg_ptc_runtime --> svc_ptcRuntime pkg_ptc_runtime_node --> svc_ptcRuntime pkg_pwsh_local --> svc_shell @@ -556,7 +556,6 @@ flowchart LR | ctx 键 | 角色 | 所属包 | 实现 | 直接消费方 | 配套插件 | 说明 | | --- | --- | --- | --- | --- | --- | --- | -| `ctx.productTelemetry` | `core` | [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | 通过 OTLP/HTTP 发送显式提交的分析事件；仅挂载插件不会采集信息。 | | `ctx.hmr` | `core` | [`hmr`](../packages/boot/hmr) | - | [`app-boot`](../packages/boot/app-boot) | - | 负责模块和精确配置监听；应用修改共用其队列，自动重载等待应用文件锁。 | | `ctx.pluginManager` | `core` | [`plugin-manager`](../packages/boot/plugin-manager) | - | [`plugin-manager`](../packages/boot/plugin-manager), `ui-settings-plugin-inventory` | - | 与 CLI 共享 profile 包操作，并向 Web 和 Agent 调用方分别报告持久状态与运行状态。 | | `ctx.profileContext` | `core` | [`app-boot`](../packages/boot/app-boot) | - | [`plugin-manager`](../packages/boot/plugin-manager) | - | dsh launcher 提供纯数据形式的 profile 位置与组合输入；重载调度由 dsh-hmr 负责。 | @@ -592,6 +591,7 @@ flowchart LR | `ctx.subagentModelSelection` | `core` | [`tool-subagent`](../packages/subagent/tool-subagent) | - | [`tool-subagent`](../packages/subagent/tool-subagent) | - | 拥有默认关闭的设置命名空间；Agent 作用域的委派工具会在组合新顶层 Session 时读取它。 | | `ctx.credentials` | `seam` | [`credentials`](../packages/credentials/credentials) | [`credentials-local`](../packages/credentials/credentials-local) | [`api-settings-controller`](../packages/api/settings-controller), [`llm-deepseek`](../packages/llm/llm-deepseek), [`llm-pi-ai`](../packages/llm/llm-pi-ai) | - | 配置携带对机密信息的引用；提供方拥有实际值。消费方按操作解析，因此轮换后的凭据会在紧接着的下一次请求中生效；settings controller 提供不含实际值的视图和只写存储。 | | `ctx.authorization` | `seam` | [`authorization`](../packages/credentials/authorization) | - | [`llm-pi-ai`](../packages/llm/llm-pi-ai) | - | flow 由知道如何取得某份凭据的插件注册，并以其写入的记录为键；seam 拥有这段对话与"每个键同时只跑一次尝试"的生命周期，而非协议本身。 | +| `ctx.productTelemetry` | `service` | [`host-product-telemetry-otel`](../packages/host/product-telemetry-otel) | - | - | - | 通过 OTLP/HTTP 发送显式提交的分析事件；仅挂载插件不会采集信息。 | | `ctx.sessionTelemetry` | `seam` | [`session-telemetry`](../packages/session/session-telemetry) | [`session-telemetry-otel`](../packages/session/session-telemetry-otel) | - | - | 该 seam 捕获会话记录、进行脱敏并交给一个后端；没有其他组件消费该服务，其输出会离开当前进程。 | | `ctx.storage` | `seam` | [`storage`](../packages/storage/storage) | [`storage-json`](../packages/storage/storage-json), [`storage-sqlite`](../packages/storage/storage-sqlite) | [`storage-domain`](../packages/storage/storage-domain) | - | 各后端以不同名称并列注册；数据形态（领域优先）挂载到枢纽上，并将类型化操作转换为不透明的 KV 单元原语。 | | `ctx.storageDomain` | `core` | [`storage-domain`](../packages/storage/storage-domain) | - | [`workspace`](../packages/workspace/workspace) | - | 等待所有已配置后端就绪，然后将领域形态发布为一个受生命周期约束的服务，用于类型化持久状态。 | diff --git a/docs/config-catalog.i18n.yaml b/docs/config-catalog.i18n.yaml index de3cf15b46..4210a71a33 100644 --- a/docs/config-catalog.i18n.yaml +++ b/docs/config-catalog.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/config-catalog.md -config-catalog.md: 821605161613f620ca40e3a8733ee4a613fe3f95 -config-catalog.zh.md: ce811976fded14184f8edd5da5de8d70dbe71d24 +config-catalog.md: 2225721f4adf3e938da7fa74a3b1cb2b159b0ed4 +config-catalog.zh.md: 21e95ea2a3bbbcf3f4667dd3f26fc10e6f607d7b diff --git a/docs/config-catalog.md b/docs/config-catalog.md index 8216051616..2225721f4a 100644 --- a/docs/config-catalog.md +++ b/docs/config-catalog.md @@ -1208,6 +1208,40 @@ export interface Config { Source: [`packages/host/open-in-app/src/index.ts:50`](../packages/host/open-in-app/src/index.ts) + + +## `@deepseek-ai/dsh-host-product-telemetry-otel` + +```ts config-catalog +/** Collector routing, application identity, and bounded in-memory batch settings. */ +export interface Config { + /** Full HTTP(S) logs URL. */ + endpoint: string + /** Collector routing header. */ + channel: string + /** Resource service.name supplied by the application composition. */ + serviceName: string + /** Resource service.version supplied by the application composition. */ + serviceVersion: string + /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ + compression?: 'none' | 'gzip' + /** Maximum records per export; must not exceed maxQueueSize. */ + maxExportBatchSize: number + /** Maximum queued records; the SDK drops new records when full. */ + maxQueueSize: number + /** Delay before exporting a partial batch. */ + scheduledDelayMillis: number + /** Exporter HTTP deadline, including SDK transient-error retries. */ + timeoutMillis: number + /** Processor deadline for one batch export. */ + exportTimeoutMillis: number + /** Outer shutdown wait; pending exports may be lost after this deadline. */ + shutdownTimeoutMillis: number +} +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts:37`](../packages/host/product-telemetry-otel/src/index.ts) + ## `@deepseek-ai/dsh-host-webserver` @@ -2049,40 +2083,6 @@ export interface Config { Source: [`packages/llm/plugin-package-inventory-deepseek/src/index.ts:32`](../packages/llm/plugin-package-inventory-deepseek/src/index.ts) - - -## `@deepseek-ai/dsh-product-telemetry-otel` - -```ts config-catalog -/** Collector routing, application identity, and bounded in-memory batch settings. */ -export interface Config { - /** Full HTTP(S) logs URL. */ - endpoint: string - /** Collector routing header. */ - channel: string - /** Resource service.name supplied by the application composition. */ - serviceName: string - /** Resource service.version supplied by the application composition. */ - serviceVersion: string - /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ - compression?: 'none' | 'gzip' - /** Maximum records per export; must not exceed maxQueueSize. */ - maxExportBatchSize: number - /** Maximum queued records; the SDK drops new records when full. */ - maxQueueSize: number - /** Delay before exporting a partial batch. */ - scheduledDelayMillis: number - /** Exporter HTTP deadline, including SDK transient-error retries. */ - timeoutMillis: number - /** Processor deadline for one batch export. */ - exportTimeoutMillis: number - /** Outer shutdown wait; pending exports may be lost after this deadline. */ - shutdownTimeoutMillis: number -} -``` - -Source: [`packages/host/product-telemetry-otel/src/index.ts:35`](../packages/host/product-telemetry-otel/src/index.ts) - ## `@deepseek-ai/dsh-ptc-runtime-node` diff --git a/docs/config-catalog.zh.md b/docs/config-catalog.zh.md index ce811976fd..21e95ea2a3 100644 --- a/docs/config-catalog.zh.md +++ b/docs/config-catalog.zh.md @@ -1212,6 +1212,40 @@ export interface Config { 来源：[`packages/host/open-in-app/src/index.ts:50`](../packages/host/open-in-app/src/index.ts) + + +## `@deepseek-ai/dsh-host-product-telemetry-otel` + +```ts config-catalog +/** Collector routing, application identity, and bounded in-memory batch settings. */ +export interface Config { + /** Full HTTP(S) logs URL. */ + endpoint: string + /** Collector routing header. */ + channel: string + /** Resource service.name supplied by the application composition. */ + serviceName: string + /** Resource service.version supplied by the application composition. */ + serviceVersion: string + /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ + compression?: 'none' | 'gzip' + /** Maximum records per export; must not exceed maxQueueSize. */ + maxExportBatchSize: number + /** Maximum queued records; the SDK drops new records when full. */ + maxQueueSize: number + /** Delay before exporting a partial batch. */ + scheduledDelayMillis: number + /** Exporter HTTP deadline, including SDK transient-error retries. */ + timeoutMillis: number + /** Processor deadline for one batch export. */ + exportTimeoutMillis: number + /** Outer shutdown wait; pending exports may be lost after this deadline. */ + shutdownTimeoutMillis: number +} +``` + +来源： [`packages/host/product-telemetry-otel/src/index.ts:37`](../packages/host/product-telemetry-otel/src/index.ts) + ## `@deepseek-ai/dsh-host-webserver` @@ -2053,40 +2087,6 @@ export interface Config { 来源：[`packages/llm/plugin-package-inventory-deepseek/src/index.ts:32`](../packages/llm/plugin-package-inventory-deepseek/src/index.ts) - - -## `@deepseek-ai/dsh-product-telemetry-otel` - -```ts config-catalog -/** Collector routing, application identity, and bounded in-memory batch settings. */ -export interface Config { - /** Full HTTP(S) logs URL. */ - endpoint: string - /** Collector routing header. */ - channel: string - /** Resource service.name supplied by the application composition. */ - serviceName: string - /** Resource service.version supplied by the application composition. */ - serviceVersion: string - /** Omit to honor OTEL_EXPORTER_OTLP_LOGS_COMPRESSION / OTEL_EXPORTER_OTLP_COMPRESSION. */ - compression?: 'none' | 'gzip' - /** Maximum records per export; must not exceed maxQueueSize. */ - maxExportBatchSize: number - /** Maximum queued records; the SDK drops new records when full. */ - maxQueueSize: number - /** Delay before exporting a partial batch. */ - scheduledDelayMillis: number - /** Exporter HTTP deadline, including SDK transient-error retries. */ - timeoutMillis: number - /** Processor deadline for one batch export. */ - exportTimeoutMillis: number - /** Outer shutdown wait; pending exports may be lost after this deadline. */ - shutdownTimeoutMillis: number -} -``` - -来源： [`packages/host/product-telemetry-otel/src/index.ts:35`](../packages/host/product-telemetry-otel/src/index.ts) - ## `@deepseek-ai/dsh-ptc-runtime-node` diff --git a/docs/subsystems/README.i18n.yaml b/docs/subsystems/README.i18n.yaml index 49c88f8b26..fbe468ab96 100644 --- a/docs/subsystems/README.i18n.yaml +++ b/docs/subsystems/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/subsystems/README.md -README.md: 7534586b4bd2686cd75da160fe044806afcff539 -README.zh.md: 1132d9a9e0c0bb945532020b314f87a08b84b933 +README.md: d2e8dea206e24ae65676ae50596a3f559239cc21 +README.zh.md: 78c97a016a93415ac1fca1afb6658aa623a61f7a diff --git a/docs/subsystems/README.md b/docs/subsystems/README.md index 7534586b4b..d2e8dea206 100644 --- a/docs/subsystems/README.md +++ b/docs/subsystems/README.md @@ -6,7 +6,6 @@ One page per subsystem of the DeepSeek Harness: what it is, the data structures | Page | Owns | |---|---| -| [product-telemetry.md](product-telemetry.md) | Explicit product analytics submission and OTLP/HTTP transport | | [boot.md](boot.md) | Current-profile plugin management and launcher reload coordination | | [core.md](core.md) | how `packages/core` controls the agent loop: the package-by-package loop description, agent creation and ownership (`AgentHandle`), the `Agent` handle's delivery/cancellation/interception contracts, and the repo-wide type patterns (`…Map → derived-union`, branded ids) | | [llm-streaming.md](llm-streaming.md) | the `packages/llm` conversation types — `Message`/`ContentBlock`, the assembled model request, the `StreamChunk` wire protocol and adapter contract, `BlockAssembler`, and the `LlmAdapter` provider contract | @@ -68,5 +67,6 @@ One page per subsystem of the DeepSeek Harness: what it is, the data structures | [conversation.md](conversation.md) | target-neutral Session-event assembly: Context identity, Location data, replay paths, view builders, and target-owned render nodes | | [session-projection.md](session-projection.md) | the projection seam: `SessionProjectionMap`, the pure `ProjectionDefinition` unit, `ProjectionSnapshot`'s consistent cut, the change feed | | [session-telemetry.md](session-telemetry.md) | the outbound session-reporting capability seam: `SessionTelemetryRecord`/`SessionTelemetrySeverity`, the `SessionTelemetrySink` contract, and the `session-telemetry/record` redact waterfall | +| [product-telemetry.md](product-telemetry.md) | Explicit product analytics submission and OTLP/HTTP transport | > Type declarations and their JSDoc on these pages are source-equivalent and drift-checked by `pnpm run verify-type-equiv` (see [development.md](../development.md#documenting-types-verbatim-ts-type-equiv)). Ordinary blocks preserve complete declarations; `public-api` blocks preserve body-stripped public class declarations. Cordis services and events use each page's generated **Cordis API** section. diff --git a/docs/subsystems/README.zh.md b/docs/subsystems/README.zh.md index 1132d9a9e0..78c97a016a 100644 --- a/docs/subsystems/README.zh.md +++ b/docs/subsystems/README.zh.md @@ -6,7 +6,6 @@ | 页面 | 负责内容 | |---|---| -| [product-telemetry.md](product-telemetry.zh.md) | 显式产品分析事件提交与 OTLP/HTTP 传输 | | [boot.md](boot.zh.md) | 当前 profile 插件管理与 launcher 重载协调 | | [core.md](core.zh.md) | `packages/core` 如何控制 agent loop（智能体循环）：逐包的循环说明、agent 创建与所有权（`AgentHandle`）、`Agent` 句柄的投递/取消/拦截约定，以及全仓通用类型模式（`…Map → derived-union`、品牌化 id） | | [llm-streaming.md](llm-streaming.zh.md) | `packages/llm` 的对话类型——`Message`/`ContentBlock`、组装完成的模型请求、`StreamChunk` wire protocol 和适配器约定（adapter contract）、`BlockAssembler`，以及 `LlmAdapter` 提供方约定 | @@ -68,5 +67,6 @@ | [conversation.md](conversation.zh.md) | 目标无关的会话事件组装：上下文标识、位置数据、回放路径、视图构建器与目标自有的渲染节点 | | [session-projection.md](session-projection.zh.md) | 投影 seam：`SessionProjectionMap`、纯函数 `ProjectionDefinition` 单元、`ProjectionSnapshot` 的一致切面、变更馈送 | | [session-telemetry.md](session-telemetry.zh.md) | 对外会话上报能力 seam：`SessionTelemetryRecord`/`SessionTelemetrySeverity`、`SessionTelemetrySink` 约定和 `session-telemetry/record` 脱敏 waterfall（瀑布式事件） | +| [product-telemetry.md](product-telemetry.zh.md) | 显式产品分析事件提交与 OTLP/HTTP 传输 | > 这些页面上的类型声明及其 JSDoc 与源码等价，并由 `pnpm run verify-type-equiv` 检查漂移（见 [development.md](../development.zh.md#documenting-types-verbatim-ts-type-equiv)）。普通块保留完整声明；`public-api` 块保留去除实现体的公开 class 声明。Cordis 服务与事件使用每页生成的 **Cordis API** 小节。 diff --git a/docs/subsystems/product-telemetry.i18n.yaml b/docs/subsystems/product-telemetry.i18n.yaml index 326d675316..e5e8b34aea 100644 --- a/docs/subsystems/product-telemetry.i18n.yaml +++ b/docs/subsystems/product-telemetry.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/subsystems/product-telemetry.md -product-telemetry.md: b9abdfc3a781ce5dc6237c25f2f7e0b045776125 -product-telemetry.zh.md: de132fec7c7a2e394bb3ee7ab6e8d745c0912b66 +product-telemetry.md: d86540d5a2b75d84f11120b80b7d107788799238 +product-telemetry.zh.md: 52ad1193630fc67f87c9c710027fc1ec5a5db98a diff --git a/docs/subsystems/product-telemetry.md b/docs/subsystems/product-telemetry.md index b9abdfc3a7..d86540d5a2 100644 --- a/docs/subsystems/product-telemetry.md +++ b/docs/subsystems/product-telemetry.md @@ -8,6 +8,31 @@ The [product telemetry plugin](../../packages/host/product-telemetry-otel/README Enqueue is synchronous and does not acknowledge delivery. The SDK owns batching and retry; local diagnostics report export failures. See the package README for configuration, shutdown, and loss limits. +## Record types + +```ts type-equiv +/** Scalar values accepted by the collector's Arrow attributes map. */ +type ProductTelemetryScalar = string | number | boolean +``` + +```ts type-equiv +/** Explicitly selected analytics fields; object values may contain scalars only. */ +interface ProductTelemetryRecord { + /** Product/DA-owned event name. */ + eventName: string + /** Human-readable summary; never a prompt, response, credential, or file contents. */ + body: string + /** Event occurrence time in Unix milliseconds. Observation time is assigned on enqueue. */ + timestamp: number + /** OTel severity; omitted values use INFO. */ + severityNumber?: SeverityNumber + /** Business fields selected by the caller; no automatic device or account identity. */ + attributes?: Record> +} +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts`](../../packages/host/product-telemetry-otel/src/index.ts) + diff --git a/docs/subsystems/product-telemetry.zh.md b/docs/subsystems/product-telemetry.zh.md index de132fec7c..52ad119363 100644 --- a/docs/subsystems/product-telemetry.zh.md +++ b/docs/subsystems/product-telemetry.zh.md @@ -8,6 +8,31 @@ 入队同步完成，不代表送达确认。SDK 负责批量发送与重试；发送失败会产生本地诊断。配置、退出和丢失限制见包 README。 +## 记录类型 + +```ts type-equiv +/** Scalar values accepted by the collector's Arrow attributes map. */ +type ProductTelemetryScalar = string | number | boolean +``` + +```ts type-equiv +/** Explicitly selected analytics fields; object values may contain scalars only. */ +interface ProductTelemetryRecord { + /** Product/DA-owned event name. */ + eventName: string + /** Human-readable summary; never a prompt, response, credential, or file contents. */ + body: string + /** Event occurrence time in Unix milliseconds. Observation time is assigned on enqueue. */ + timestamp: number + /** OTel severity; omitted values use INFO. */ + severityNumber?: SeverityNumber + /** Business fields selected by the caller; no automatic device or account identity. */ + attributes?: Record> +} +``` + +Source: [`packages/host/product-telemetry-otel/src/index.ts`](../../packages/host/product-telemetry-otel/src/index.ts) + diff --git a/packages/README.i18n.yaml b/packages/README.i18n.yaml index 5893d269ed..df718ac1e0 100644 --- a/packages/README.i18n.yaml +++ b/packages/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/README.md -README.md: 5f759989eda6588e707a0c80c3035d0ba51ec950 -README.zh.md: 8a2784f5a3f99c9842b10d98d89b6d40936380b2 +README.md: 0ce8e9202763a2e974300b83239f02c256a2953e +README.zh.md: 8e0650d8f6b00112c4fdb4a4dbc11671a2b3f394 diff --git a/packages/README.md b/packages/README.md index 5f759989ed..0ce8e92027 100644 --- a/packages/README.md +++ b/packages/README.md @@ -77,7 +77,7 @@ Every package lives in exactly one group; new packages join existing groups, and | [`acp/`](acp/README.md) | Automation-only Agent Client Protocol server | | [`interaction/`](interaction/README.md) | Human-collaboration plane: approval/interaction seams, permission preset, commands, ask-user tool | | [`boot/`](boot/README.md) | Shared app-bin boot glue | -| [`host/`](host/README.md) | Web-GUI host half: API gateway + HTTP route server | +| [`host/`](host/README.md) | Web GUI host services, directory picking, application launch, plugin inventory, and product telemetry | | [`client/`](client/README.md) | Web-GUI browser half: shell, wire, object services, slots, `ui-*` plugins | | [`test-support/`](test-support/README.md) | Test infrastructure (testkits, replay, Loader smokes) | | [`runtime-diagnostics/`](runtime-diagnostics/README.md) | Runtime diagnostics: package-owned invariant checks and reports | diff --git a/packages/README.zh.md b/packages/README.zh.md index 8a2784f5a3..8e0650d8f6 100644 --- a/packages/README.zh.md +++ b/packages/README.zh.md @@ -77,7 +77,7 @@ harness 由 `packages/` 下的 npm 包组装而成，按能力系列分组：会 | [`acp/`](acp/README.zh.md) | 仅面向自动化的 ACP（Agent Client Protocol）服务器 | | [`interaction/`](interaction/README.zh.md) | 人机协作平面：批准／交互 seam、权限预设、命令、询问用户的工具 | | [`boot/`](boot/README.zh.md) | 共享的 app bin 启动粘合层 | -| [`host/`](host/README.zh.md) | web GUI 宿主半侧：API 网关 + HTTP 路由服务器 | +| [`host/`](host/README.zh.md) | Web GUI 宿主服务、目录选择、应用启动、插件清单和产品遥测 | | [`client/`](client/README.zh.md) | web GUI 浏览器半侧：shell、协议层、对象服务、slot、`ui-*` 插件 | | [`test-support/`](test-support/README.zh.md) | 测试基础设施（testkit、回放、Loader 冒烟测试） | | [`runtime-diagnostics/`](runtime-diagnostics/README.zh.md) | 运行时诊断：按包归属的运行时不变式检查与报告 | diff --git a/packages/host/README.i18n.yaml b/packages/host/README.i18n.yaml index 2bf03c1e34..c45b78cfa1 100644 --- a/packages/host/README.i18n.yaml +++ b/packages/host/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/host/README.md -README.md: 4de7a5fdd00be392d19a58f4bc424fce53c5e112 -README.zh.md: 80b74e0647c810b900f671d7d1256ab0d46107a9 +README.md: f5e7832539404b8fb1fb856973f08d5dd5c87eb5 +README.zh.md: 402358f4f4097630ba8deda4551d6bc52ff01b11 diff --git a/packages/host/README.md b/packages/host/README.md index 4de7a5fdd0..f5e7832539 100644 --- a/packages/host/README.md +++ b/packages/host/README.md @@ -1,5 +1,5 @@ --- -description: "Package map for the web GUI host half: the HTTP and SPA servers, workspace-directory picking implementations, the open-in-app launch routes, and the plugin inventory projection." +description: "Package map for the web GUI host half: the HTTP and SPA servers, workspace-directory picking implementations, the open-in-app launch routes, the plugin inventory projection, and explicit product event reporting." kind: "package-group" --- @@ -9,7 +9,7 @@ English | [中文](README.zh.md) ## Summary -The `host/` group provides the web GUI's plain HTTP server, the SPA dist server that serves the built Web shell, the workspace-directory picking seam with its native, browse, and adaptive composition packages, the open-in-app application probe and launch routes, and the read-only plugin inventory projection. These packages are product packages; the browser transport lives in [`client/`](../client/README.md), and the composed application is [`apps/cli`](../../apps/cli/README.md) booting the [`dsh-base` bundle](../bundle/base/cordis.patch.yml) that serves the web app under `apps/web/`. The picker backends replace one another behind the shared seam. +The `host/` group provides the web GUI's plain HTTP server, the SPA dist server that serves the built Web shell, the workspace-directory picking seam with its native, browse, and adaptive composition packages, the open-in-app application probe and launch routes, the read-only plugin inventory projection, and explicit product event reporting. These packages are product packages; the browser transport lives in [`client/`](../client/README.md), and the composed application is [`apps/cli`](../../apps/cli/README.md) booting the [`dsh-base` bundle](../bundle/base/cordis.patch.yml) that serves the web app under `apps/web/`. The picker backends replace one another behind the shared seam. ## Table of Contents @@ -46,7 +46,6 @@ Start with the subsystem references for the transport and the workspace records, - [HTTP server subsystem](../../docs/subsystems/web-server.md) — the webserver's routes, matching order, and config. - [Workspace subsystem](../../docs/subsystems/workspace.md) — the workspace records the directory picker feeds. - [Web config-tree boot and transport layering](../../.agents/notes/implemented/architecture/2026-07-24-web-config-tree-boot-and-transport-layering.md) — ownership of the Web transport layers. - - [Product telemetry](../../docs/subsystems/product-telemetry.md) — explicit analytics event submission. diff --git a/packages/host/README.zh.md b/packages/host/README.zh.md index 80b74e0647..402358f4f4 100644 --- a/packages/host/README.zh.md +++ b/packages/host/README.zh.md @@ -1,5 +1,5 @@ --- -description: "Web GUI Host 侧的包映射：HTTP 与 SPA 服务器、工作区目录选择实现、open-in-app 启动路由和插件清单投影。" +description: "Web GUI Host 侧的包映射：HTTP 与 SPA 服务器、工作区目录选择实现、open-in-app 启动路由、插件清单投影和显式产品事件上报。" kind: "package-group" --- @@ -9,7 +9,7 @@ kind: "package-group" ## 概述 -`host/` 组提供 Web GUI 的普通 HTTP 服务器、服务已构建 Web 壳的 SPA dist 服务器、带原生／浏览／自适应组合包的工作区目录选择 seam、open-in-app 的应用探测与启动路由，以及只读的插件清单投影。这些包都是产品包；浏览器传输位于 [`client/`](../client/README.zh.md)，组合应用是 [`apps/cli`](../../apps/cli/README.zh.md)，它启动 [`dsh-base` 组合包](../bundle/base/cordis.patch.yml) 来提供 `apps/web/` 下的 Web 应用。选择器后端可在共享 seam 后互相替换。 +`host/` 组提供 Web GUI 的普通 HTTP 服务器、服务已构建 Web 壳的 SPA dist 服务器、带原生／浏览／自适应组合包的工作区目录选择 seam、open-in-app 的应用探测与启动路由，只读的插件清单投影以及显式产品事件上报。这些包都是产品包；浏览器传输位于 [`client/`](../client/README.zh.md)，组合应用是 [`apps/cli`](../../apps/cli/README.zh.md)，它启动 [`dsh-base` 组合包](../bundle/base/cordis.patch.yml) 来提供 `apps/web/` 下的 Web 应用。选择器后端可在共享 seam 后互相替换。 ## 目录 @@ -46,7 +46,6 @@ kind: "package-group" - [HTTP 服务器子系统](../../docs/subsystems/web-server.zh.md)——webserver 的路由、匹配顺序与配置。 - [工作区子系统](../../docs/subsystems/workspace.zh.md)——目录选择器所喂给的工作区记录。 - [Web 配置树启动与传输分层](../../.agents/notes/implemented/architecture/2026-07-24-web-config-tree-boot-and-transport-layering.zh.md)——Web 传输各层的所有权。 - - [产品埋点](../../docs/subsystems/product-telemetry.zh.md)——显式提交分析事件。 diff --git a/packages/host/product-telemetry-otel/README.i18n.yaml b/packages/host/product-telemetry-otel/README.i18n.yaml index 823dcfa244..ea4a841892 100644 --- a/packages/host/product-telemetry-otel/README.i18n.yaml +++ b/packages/host/product-telemetry-otel/README.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write packages/host/product-telemetry-otel/README.md -README.md: 4ce0a8744b46391b8dbe3d7d6739f0e0e1d118c5 -README.zh.md: 34075efae80c2e5275fbb782c485bea1b2661745 +README.md: af1f2c415fc21db874abc7bb0d9e25c7149fcabf +README.zh.md: ffdb682d9a8a0a4bf406f71322e062f14b666cf2 diff --git a/packages/host/product-telemetry-otel/README.md b/packages/host/product-telemetry-otel/README.md index 4ce0a8744b..af1f2c415f 100644 --- a/packages/host/product-telemetry-otel/README.md +++ b/packages/host/product-telemetry-otel/README.md @@ -3,7 +3,7 @@ description: "Configure explicit product usage events, OTLP/HTTP routing, batchi kind: "package-reference" --- -# @deepseek-ai/dsh-product-telemetry-otel +# @deepseek-ai/dsh-host-product-telemetry-otel English | [中文](README.zh.md) @@ -25,14 +25,14 @@ Send selected product usage events to an OTLP/HTTP collector. Events carry a nam ## Use this package -Mount the plugin in a Cordis composition with the application identity; override the collector endpoint when needed. The shipped profiles do not mount it. +Mount the plugin in a Cordis composition with the application identity; override the collector endpoint when needed. The shipped profiles do not mount it. Set `DSH_APP_VERSION` to the running application release version in the launcher environment; the schema rejects an absent version. ```yaml -- name: '@deepseek-ai/dsh-product-telemetry-otel' +- name: '@deepseek-ai/dsh-host-product-telemetry-otel' config: endpoint: https://dsh-otel-collector.deepseeksvc.com/v1/logs - serviceName: dsh-telemetry-test - serviceVersion: test + serviceName: deepseek-harness + serviceVersion: !!js process.env.DSH_APP_VERSION compression: gzip scheduledDelayMillis: 30000 ``` @@ -49,6 +49,10 @@ Mount the plugin in a Cordis composition with the application identity; override | `exportTimeoutMillis` | `20000` | Processor batch export deadline | | `shutdownTimeoutMillis` | `21000` | Outer wait for shutdown; expiry reports possible loss | +The default endpoint routes explicitly submitted events to the production product collector. Test and custom deployments must override it. Only `x-channel` and SDK protocol headers reach the collector; ambient OTel headers and client certificates are not inherited. + +The 30-second interval batches product events; the exporter has a 15-second retry window inside the processor’s 20-second batch deadline. The outer 21-second wait bounds plugin disposal, including SDK `forceFlush()` work that the processor deadline does not cover. An unreachable collector can delay disposal for the full 21 seconds. A full 2,048-record queue requires four 512-record batches and may not drain before that deadline. Interactive compositions needing a shorter exit should override these budgets; neither configuration guarantees delivery. + Consumers inject `productTelemetry` and call `emit()` with explicitly selected analytics fields. Event names and field semantics belong to their product and analytics owners. The plugin reads no Session, account, credential, or device identifier. Callers must exclude prompts, responses, file contents, credentials, and other unapproved values. The collector expects a string body and attributes containing strings, numbers, booleans, or objects of those scalars. Callers supply occurrence time in milliseconds; the plugin assigns observation time and defaults severity to INFO. Invalid transport configuration fails at activation. Export failures produce local warnings without making event submission wait for the network. @@ -61,7 +65,7 @@ The collector expects a string body and attributes containing strings, numbers,
Implementation internals — click to expand -A private OTel logger feeds `BatchLogRecordProcessor` and the HTTP JSON exporter. The SDK owns queueing, transient-error retries, and compression; plugin disposal drains pending records with a bounded wait. Export completion is observed separately because SDK shutdown can resolve after a rejected export. No global OTel provider is installed. +A private OTel logger feeds `BatchLogRecordProcessor` and the SDK HTTP delegate with its JSON log serializer. The delegate receives explicit headers and an HTTP agent; only shared timeout and compression settings use SDK environment resolution. The direct `@opentelemetry/core` dependency matches `sdk-logs` at 2.9.0 so exporter result enums share one TypeScript identity. The SDK owns queueing, transient-error retries, and compression; plugin disposal drains pending records with a bounded wait. Export completion is observed separately because SDK shutdown can resolve after a rejected export. No global OTel provider is installed. [`src/index.ts`](src/index.ts) owns configuration and submission. No runtime invariant companion is published: delivery has no independent local acknowledgement to compare with the SDK's queue. @@ -93,7 +97,7 @@ None; event submission does not change model requests. Delivery and collection remain limited to the following capabilities. -- No business events, renderer transport, or account/device identity are wired automatically. +- Callers own event selection, renderer-to-host transport, and any permitted identity attributes. - The queue is memory-only; overflow, network failure, and process exit can lose events. There is no durable outbox or warehouse acknowledgement. - The SDK batches by record count, not encoded bytes. Callers must keep records within the collector's 4 MB limit and choose batch sizes appropriate to the receiver. - Caller-selected strings are not redacted automatically. This package does not decide product disclosure or consent policy. diff --git a/packages/host/product-telemetry-otel/README.zh.md b/packages/host/product-telemetry-otel/README.zh.md index 34075efae8..ffdb682d9a 100644 --- a/packages/host/product-telemetry-otel/README.zh.md +++ b/packages/host/product-telemetry-otel/README.zh.md @@ -3,7 +3,7 @@ description: "配置显式产品使用事件、OTLP/HTTP 路由、批量发送 kind: "package-reference" --- -# @deepseek-ai/dsh-product-telemetry-otel +# @deepseek-ai/dsh-host-product-telemetry-otel [English](README.md) | 中文 @@ -25,14 +25,14 @@ kind: "package-reference" ## 使用本包 -在 Cordis 组合中挂载插件并提供应用标识；需要时可覆盖接收地址。内置 profile 不挂载本插件。 +在 Cordis 组合中挂载插件并提供应用标识；需要时可覆盖接收地址。内置 profile 不挂载本插件。启动器环境须将 `DSH_APP_VERSION` 设为运行中应用的发布版本；缺少版本时 schema 会拒绝配置。 ```yaml -- name: '@deepseek-ai/dsh-product-telemetry-otel' +- name: '@deepseek-ai/dsh-host-product-telemetry-otel' config: endpoint: https://dsh-otel-collector.deepseeksvc.com/v1/logs - serviceName: dsh-telemetry-test - serviceVersion: test + serviceName: deepseek-harness + serviceVersion: !!js process.env.DSH_APP_VERSION compression: gzip scheduledDelayMillis: 30000 ``` @@ -49,6 +49,10 @@ kind: "package-reference" | `exportTimeoutMillis` | `20000` | Processor 批次导出的超时时间 | | `shutdownTimeoutMillis` | `21000` | 退出时的等待上限；超时会提示可能丢失数据 | +默认接收地址将显式提交的事件发送到生产产品 collector，测试和自定义部署必须覆盖该地址。只向 collector 发送 `x-channel` 和 SDK 协议请求头，不继承宿主 OTel 请求头或客户端证书。 + +30 秒间隔用于批量发送产品事件；exporter 的 15 秒重试窗口位于 processor 的 20 秒批次期限内。外层 21 秒等待限制插件卸载时间，包括 processor 期限未覆盖的 SDK `forceFlush()`。collector 不可达时，卸载可能等待完整的 21 秒。2,048 条满队列需要四个 512 条批次，可能无法在期限前排空。要求更快退出的交互式应用组合应覆盖这些时间配置；两种配置都不保证送达。 + 消费方注入 `productTelemetry`，调用 `emit()` 提交明确选定的分析字段。事件名称与字段含义由产品和数据分析负责人定义。插件不读取 Session、账号、凭证或设备标识。调用方必须排除提示词、回答、文件内容、凭证及其他未经批准的数据。 接收服务要求 body 为字符串，attributes 的值为字符串、数字、布尔值或由这些标量组成的对象。调用方以毫秒提供发生时间；插件填写观测时间，默认严重程度为 INFO。无效传输配置在激活时报错。发送失败产生本地警告，事件提交不等待网络。 @@ -61,7 +65,7 @@ kind: "package-reference"
实现细节——点击展开 -私有 OTel logger 将记录交给 `BatchLogRecordProcessor` 和 HTTP JSON exporter。SDK 负责队列、临时错误重试与压缩；插件卸载时在限定时间内发送剩余记录。发送完成结果单独观测，因为 SDK 在发送被拒绝后仍可能正常完成退出。不安装全局 OTel provider。 +私有 OTel logger 将记录交给 `BatchLogRecordProcessor`，再由 SDK HTTP delegate 和 JSON 日志序列化器发送。delegate 使用显式请求头和 HTTP agent，只有共享的超时与压缩配置使用 SDK 环境变量解析。直接依赖的 `@opentelemetry/core` 与 `sdk-logs` 对齐为 2.9.0，使导出结果枚举共享同一个 TypeScript 类型身份。SDK 负责队列、临时错误重试与压缩；插件卸载时在限定时间内发送剩余记录。发送完成结果单独观测，因为 SDK 在发送被拒绝后仍可能正常完成退出。不安装全局 OTel provider。 [`src/index.ts`](src/index.ts) 负责配置与提交。不发布运行时不变量伴随模块：本地没有独立的送达确认可与 SDK 队列比较。 @@ -93,7 +97,7 @@ kind: "package-reference" 发送和采集受以下能力限制。 -- 不自动接入业务事件、渲染进程传输或账号与设备标识。 +- 调用方拥有事件选择、渲染进程到宿主的传输以及获准使用的标识属性。 - 队列仅存在于内存；队列溢出、网络故障和进程退出可能丢失事件。没有持久发件箱或入仓确认。 - SDK 按记录条数而非编码字节数分批。调用方必须确保记录不超过接收服务的 4 MB 限制，并选择接收服务适用的批次大小。 - 不自动脱敏调用方选择的字符串。本包不决定产品告知或同意策略。 diff --git a/packages/host/product-telemetry-otel/package.json b/packages/host/product-telemetry-otel/package.json index 24dff2ab6a..2bcdeb691b 100644 --- a/packages/host/product-telemetry-otel/package.json +++ b/packages/host/product-telemetry-otel/package.json @@ -1,5 +1,5 @@ { - "name": "@deepseek-ai/dsh-product-telemetry-otel", + "name": "@deepseek-ai/dsh-host-product-telemetry-otel", "description": "Explicit product usage events exported through OpenTelemetry HTTP logs", "version": "0.1.6-alpha.2", "publishConfig": { @@ -27,13 +27,14 @@ ], "license": "MIT", "dependencies": { - "@opentelemetry/api-logs": "^0.220.0", - "@opentelemetry/exporter-logs-otlp-http": "^0.220.0", - "@opentelemetry/otlp-exporter-base": "^0.220.0", - "@opentelemetry/resources": "^2.9.0", - "@opentelemetry/sdk-logs": "^0.220.0", "@deepseek-ai/schemastery": "workspace:^", - "@opentelemetry/core": "2.9.0" + "@opentelemetry/api": "^1.9.1", + "@opentelemetry/api-logs": "^0.220.0", + "@opentelemetry/core": "2.9.0", + "@opentelemetry/otlp-exporter-base": "^0.220.0", + "@opentelemetry/otlp-transformer": "^0.220.0", + "@opentelemetry/resources": "^2.9.0", + "@opentelemetry/sdk-logs": "^0.220.0" }, "peerDependencies": { "@deepseek-ai/cordis": "workspace:^" diff --git a/packages/host/product-telemetry-otel/src/index.ts b/packages/host/product-telemetry-otel/src/index.ts index b617702172..eef6ec5dce 100644 --- a/packages/host/product-telemetry-otel/src/index.ts +++ b/packages/host/product-telemetry-otel/src/index.ts @@ -2,8 +2,10 @@ import { Context, Service } from '@deepseek-ai/cordis' import z from '@deepseek-ai/schemastery' import { SeverityNumber, type Logger } from '@opentelemetry/api-logs' -import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http' -import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base' +import { validateHeaderValue } from 'node:http' +import { JsonLogsSerializer } from '@opentelemetry/otlp-transformer' +import { createOtlpHttpExportDelegate, getSharedConfigurationFromEnvironment, httpAgentFactoryFromOptions } from '@opentelemetry/otlp-exporter-base/node-http' +import { CompressionAlgorithm, getSharedConfigurationDefaults, mergeOtlpSharedConfigurationWithDefaults, OTLPExporterBase } from '@opentelemetry/otlp-exporter-base' import { ExportResultCode } from '@opentelemetry/core' import { resourceFromAttributes } from '@opentelemetry/resources' import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs' @@ -59,10 +61,10 @@ export interface Config { const positiveInteger = () => z.number().step(1).min(1).max(2_147_483_647) -/** Loader validation; the same schema resolves defaults for direct construction. */ +/** Loader validation and defaults for application compositions. */ export const Config: z, Config> = z.object({ endpoint: z.string().default('https://dsh-otel-collector.deepseeksvc.com/v1/logs'), - channel: z.string().default('dsh_otel_report'), + channel: z.string().min(1).default('dsh_otel_report'), serviceName: z.string().required(), serviceVersion: z.string().required(), compression: z.union(['none', 'gzip']), @@ -79,9 +81,18 @@ export default class ProductTelemetry extends Service { static Config = Config private readonly logger: Logger - constructor(ctx: Context, input: Config) { - const config = Config(input) - const endpoint = new URL(config.endpoint) + constructor(ctx: Context, config: Config) { + let endpoint: URL + try { + endpoint = new URL(config.endpoint) + } catch (cause) { + throw new Error('product-telemetry-otel: endpoint must be a valid HTTP(S) URL', { cause }) + } + try { + validateHeaderValue('x-channel', config.channel) + } catch (cause) { + throw new Error('product-telemetry-otel: channel must be a valid HTTP header value', { cause }) + } if (!['http:', 'https:'].includes(endpoint.protocol)) { throw new Error('product-telemetry-otel: endpoint must use HTTP or HTTPS') } @@ -89,14 +100,20 @@ export default class ProductTelemetry extends Service { throw new Error('product-telemetry-otel: maxExportBatchSize must not exceed maxQueueSize') } super(ctx, 'productTelemetry') - const exporter = new OTLPLogExporter({ - url: config.endpoint, - headers: { 'x-channel': config.channel }, + const shared = mergeOtlpSharedConfigurationWithDefaults({ timeoutMillis: config.timeoutMillis, ...(config.compression === undefined ? {} : { compression: config.compression === 'gzip' ? CompressionAlgorithm.GZIP : CompressionAlgorithm.NONE, }), - }) + }, getSharedConfigurationFromEnvironment('LOGS'), getSharedConfigurationDefaults()) + const transport = { + ...shared, + url: config.endpoint, + // This collector must not inherit another endpoint's headers or TLS client identity. + headers: () => Promise.resolve({ 'Content-Type': 'application/json', 'x-channel': config.channel }), + agentFactory: httpAgentFactoryFromOptions({ keepAlive: true }), + } + const exporter = new OTLPExporterBase(createOtlpHttpExportDelegate(transport, JsonLogsSerializer)) const provider = new LoggerProvider({ resource: resourceFromAttributes({ 'service.name': config.serviceName, @@ -111,7 +128,7 @@ export default class ProductTelemetry extends Service { export: (records, callback) => { exporter.export(records, (result) => { // SDK flush/shutdown can resolve after export failure; observe the actual completion. - if (result.code !== ExportResultCode.SUCCESS) ctx.logger.warn('Product telemetry export failed') + if (result.code !== ExportResultCode.SUCCESS) ctx.logger.warn('Product telemetry export failed', result.error) callback(result) }) }, @@ -120,7 +137,7 @@ export default class ProductTelemetry extends Service { }, })], }) - this.logger = provider.getLogger('@deepseek-ai/dsh-product-telemetry-otel') + this.logger = provider.getLogger('@deepseek-ai/dsh-host-product-telemetry-otel') ctx.effect(() => async () => { let timer!: ReturnType const deadline = new Promise((resolve) => { diff --git a/packages/host/product-telemetry-otel/tests/fixtures/driver.ts b/packages/host/product-telemetry-otel/tests/fixtures/driver.ts index 4dfac67960..a0ad9389d8 100644 --- a/packages/host/product-telemetry-otel/tests/fixtures/driver.ts +++ b/packages/host/product-telemetry-otel/tests/fixtures/driver.ts @@ -3,7 +3,7 @@ import { createServer } from 'node:http' import { once } from 'node:events' import { gunzipSync } from 'node:zlib' import { writeFile } from 'node:fs/promises' -import type {} from '@deepseek-ai/dsh-product-telemetry-otel' +import type {} from '@deepseek-ai/dsh-host-product-telemetry-otel' import { bootProductionProfile } from '../../../../test-support/loader-smoke/tests/fixtures/production-profile.ts' const configPath = process.argv[2] @@ -24,6 +24,7 @@ try { await once(server, 'listening') const address = server.address() if (address === null || typeof address === 'string') throw new Error('collector has no port') + process.env.DSH_APP_VERSION = 'synthetic-release' process.env.DSH_PRODUCT_TELEMETRY_TEST_ENDPOINT = `http://127.0.0.1:${address.port}/v1/logs` const ctx = await bootProductionProfile({ binName: 'product-telemetry-test', profile: 'headless', overlayPaths: [configPath] }) try { diff --git a/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml b/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml index c876c3d646..d9104a0bfb 100644 --- a/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml +++ b/packages/host/product-telemetry-otel/tests/fixtures/telemetry.patch.yml @@ -6,10 +6,10 @@ disabled: true - insert: - id: product-telemetry-otel - name: '@deepseek-ai/dsh-product-telemetry-otel' + name: '@deepseek-ai/dsh-host-product-telemetry-otel' config: endpoint: !!js process.env.DSH_PRODUCT_TELEMETRY_TEST_ENDPOINT serviceName: dsh-telemetry-test - serviceVersion: test + serviceVersion: !!js process.env.DSH_APP_VERSION compression: gzip scheduledDelayMillis: 60000 diff --git a/packages/host/product-telemetry-otel/tests/telemetry.spec.ts b/packages/host/product-telemetry-otel/tests/telemetry.spec.ts index 424ec5917a..22f7df5c30 100644 --- a/packages/host/product-telemetry-otel/tests/telemetry.spec.ts +++ b/packages/host/product-telemetry-otel/tests/telemetry.spec.ts @@ -1,7 +1,7 @@ import { createServer, type IncomingHttpHeaders } from 'node:http' import { once } from 'node:events' import { gunzipSync } from 'node:zlib' -import { afterEach, describe, expect, it, vi } from 'vitest' +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' import { Context } from '@deepseek-ai/cordis' import { LoggerProvider } from '@opentelemetry/sdk-logs' import { SeverityNumber } from '@opentelemetry/api-logs' @@ -16,11 +16,17 @@ afterEach(async () => { try { for (const dispose of cleanup.splice(0).reverse()) await dispose() } finally { + vi.unstubAllEnvs() vi.restoreAllMocks() vi.useRealTimers() } }) +beforeEach(() => { + vi.stubEnv('OTEL_EXPORTER_OTLP_COMPRESSION', undefined) + vi.stubEnv('OTEL_EXPORTER_OTLP_LOGS_COMPRESSION', undefined) +}) + async function collector(statuses = [200]) { const captures: Capture[] = [] const server = createServer((req, res) => { @@ -92,6 +98,22 @@ describe('explicit product telemetry', () => { expect(JSON.stringify(capture)).not.toContain('user.id') }) + it('isolates collector headers from ambient OpenTelemetry credentials', async () => { + vi.stubEnv('OTEL_EXPORTER_OTLP_HEADERS', 'Authorization=Bearer%20synthetic-secret,x-user-id=synthetic-user') + vi.stubEnv('OTEL_EXPORTER_OTLP_LOGS_HEADERS', 'x-log-token=synthetic-token,x-channel=other-collector') + const target = await collector() + const ctx = context() + const fiber = await ctx.plugin(ProductTelemetry, config(target.endpoint)) + ctx.productTelemetry.emit(event) + await fiber.dispose() + expect(target.captures).toHaveLength(1) + expect(target.captures[0]?.headers).toMatchObject({ 'x-channel': 'dsh_otel_report' }) + expect(target.captures[0]?.headers).not.toHaveProperty('authorization') + expect(target.captures[0]?.headers).not.toHaveProperty('x-user-id') + expect(target.captures[0]?.headers).not.toHaveProperty('x-log-token') + expect(process.env['OTEL_EXPORTER_OTLP_HEADERS']).toContain('synthetic-secret') + }) + it('does not export on mount or empty shutdown', async () => { const target = await collector() const fiber = await context().plugin(ProductTelemetry, config(target.endpoint)) @@ -124,11 +146,12 @@ describe('explicit product telemetry', () => { expect(() => { ctx.productTelemetry.emit(event) }).not.toThrow() await fiber.dispose() expect(target.captures).toHaveLength(1) - expect(warn).toHaveBeenCalledWith('Product telemetry export failed') + expect(warn).toHaveBeenCalledWith('Product telemetry export failed', expect.any(Error)) }) it.each([ { endpoint: 'broken' }, { endpoint: 'ftp://collector.test/logs' }, + { channel: '' }, { channel: 'bad\nchannel' }, { channel: '中文' }, { timeoutMillis: 0 }, { maxExportBatchSize: 0 }, { maxExportBatchSize: 2, maxQueueSize: 1 }, { maxQueueSize: -1 }, { scheduledDelayMillis: 0 }, { exportTimeoutMillis: Infinity }, { shutdownTimeoutMillis: 2_147_483_648 }, @@ -138,6 +161,29 @@ describe('explicit product telemetry', () => { expect(ctx.get('productTelemetry')).toBeUndefined() }) + it.each([ + [{ endpoint: 'broken' }, 'endpoint must be a valid HTTP(S) URL'], + [{ channel: 'bad\nchannel' }, 'channel must be a valid HTTP header value'], + ] as const)('names invalid transport fields before registering the service', (invalid, message) => { + const ctx = context() + expect(() => new ProductTelemetry(ctx, config('http://collector.test/v1/logs', invalid))) + .toThrow(`product-telemetry-otel: ${message}`) + expect(ctx.get('productTelemetry')).toBeUndefined() + }) + + it.each([ + ['OTEL_EXPORTER_OTLP_COMPRESSION', 'gzip'], + ['OTEL_EXPORTER_OTLP_LOGS_COMPRESSION', 'gzip'], + ])('honors %s when compression is omitted', async (name, value) => { + vi.stubEnv(name, value) + const target = await collector() + const ctx = context() + const fiber = await ctx.plugin(ProductTelemetry, config(target.endpoint)) + ctx.productTelemetry.emit(event) + await fiber.dispose() + expect(target.captures[0]?.headers['content-encoding']).toBe('gzip') + }) + it('bounds a stalled shutdown and observes its later settlement', async () => { const target = await collector() const ctx = context() diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a4cc9868ac..4868184291 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -8441,16 +8441,19 @@ importers: '@deepseek-ai/schemastery': specifier: link:../../../vendor/schemastery version: link:../../../vendor/schemastery + '@opentelemetry/api': + specifier: ^1.9.1 + version: 1.9.1 '@opentelemetry/api-logs': specifier: ^0.220.0 version: 0.220.0 '@opentelemetry/core': specifier: 2.9.0 version: 2.9.0(@opentelemetry/api@1.9.1) - '@opentelemetry/exporter-logs-otlp-http': + '@opentelemetry/otlp-exporter-base': specifier: ^0.220.0 version: 0.220.0(@opentelemetry/api@1.9.1) - '@opentelemetry/otlp-exporter-base': + '@opentelemetry/otlp-transformer': specifier: ^0.220.0 version: 0.220.0(@opentelemetry/api@1.9.1) '@opentelemetry/resources': diff --git a/scripts/gen-doc-graphs.ts b/scripts/gen-doc-graphs.ts index 2df51d9664..0890e45bd7 100644 --- a/scripts/gen-doc-graphs.ts +++ b/scripts/gen-doc-graphs.ts @@ -31,7 +31,7 @@ interface ServiceRole { key: string pkg: string title: string - mode: 'core' | 'seam' | 'bundle' + mode: 'core' | 'seam' | 'bundle' | 'service' implementations?: string[] consumers?: string[] companions?: string[] @@ -99,13 +99,6 @@ const GROUP_ORDER = [ ] const SERVICE_ROLES: ServiceRole[] = [ - { - key: 'productTelemetry', - pkg: 'product-telemetry-otel', - title: 'Product usage event sender', - mode: 'core', - note: 'Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing.', - }, { key: 'hmr', pkg: 'hmr', @@ -380,6 +373,14 @@ const SERVICE_ROLES: ServiceRole[] = [ consumers: ['llm-pi-ai'], note: 'Flows are registered by the plugin that knows how to obtain one credential and keyed by the record they write; the seam owns the conversation and the one-attempt-per-key lifecycle, never the protocol.', }, + { + key: 'productTelemetry', + pkg: 'host-product-telemetry-otel', + title: 'Product usage event sender', + mode: 'service', + note: 'Exports explicitly submitted analytics events through OTLP/HTTP; mounting alone collects nothing.', + }, + { key: 'sessionTelemetry', pkg: 'session-telemetry', @@ -870,7 +871,7 @@ function renderCapabilitySeams(pkgs: Pkg[], services: readonly ServiceEntry[]): const addEdge = (from: string, to: string): void => { edges.add(` ${from} --> ${to}`) } const lines = generatedHeader('Capability Seams And Core Services') lines.push( - 'A service can be a core spine service, a swappable capability seam, or a bundle/composition point. The graph shows the package that owns the service declaration, known implementation packages, and packages that consume the service directly.', + 'A service can be a core spine service, a swappable capability seam, a bundle/composition point, or a standalone service. The graph shows the package that owns the service declaration, known implementation packages, and packages that consume the service directly.', '', '```mermaid', 'flowchart LR', diff --git a/scripts/type-equiv.manifest.json b/scripts/type-equiv.manifest.json index e36b61fbf7..e1bf5ad4e9 100644 --- a/scripts/type-equiv.manifest.json +++ b/scripts/type-equiv.manifest.json @@ -2256,6 +2256,16 @@ "doc": "docs/subsystems/deliverables.md", "symbol": "WorkspaceChanges", "source": "packages/deliverables/workspace-changes/src/types.ts" + }, + { + "doc": "docs/subsystems/product-telemetry.md", + "symbol": "ProductTelemetryScalar", + "source": "packages/host/product-telemetry-otel/src/index.ts" + }, + { + "doc": "docs/subsystems/product-telemetry.md", + "symbol": "ProductTelemetryRecord", + "source": "packages/host/product-telemetry-otel/src/index.ts" } ] } diff --git a/tsconfig.base.json b/tsconfig.base.json index ff609f43e8..d39dff388c 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -187,6 +187,7 @@ "@deepseek-ai/dsh-host-directory-picker-native/*": ["./packages/host/directory-picker-native/src/*"], "@deepseek-ai/dsh-host-directory-picker-auto": ["./packages/host/directory-picker-auto/src"], "@deepseek-ai/dsh-host-directory-picker-auto/*": ["./packages/host/directory-picker-auto/src/*"], + "@deepseek-ai/dsh-host-product-telemetry-otel": ["./packages/host/product-telemetry-otel/src"], "@deepseek-ai/dsh-host-open-in-app": ["./packages/host/open-in-app/src"], "@deepseek-ai/dsh-host-open-in-app/shared": ["./packages/host/open-in-app/src/shared.ts"], "@deepseek-ai/dsh-host-webserver": ["./packages/host/webserver/src"], @@ -402,7 +403,6 @@ "@deepseek-ai/dsh-plan-mode": ["./packages/plan/plan-mode/src"], "@deepseek-ai/dsh-plan-mode/invariant": ["./packages/plan/plan-mode/src/invariant.ts"], "@deepseek-ai/dsh-plugin-package-inventory-deepseek": ["./packages/llm/plugin-package-inventory-deepseek/src"], - "@deepseek-ai/dsh-product-telemetry-otel": ["./packages/host/product-telemetry-otel/src"], "@deepseek-ai/dsh-ptc-runtime": ["./packages/ptc-runtime/ptc-runtime/src"], "@deepseek-ai/dsh-ptc-runtime-node": ["./packages/ptc-runtime/ptc-runtime-node/src"], "@deepseek-ai/dsh-pwsh-sandbox": ["./packages/shell/pwsh-sandbox/src"], From 6d13819fbced0eb0c148624526d5c58182408714 Mon Sep 17 00:00:00 2001 From: 07akioni <07akioni2@gmail.com> Date: Mon, 21 Sep 2026 17:50:32 +0800 Subject: [PATCH 9/9] docs(telemetry): regenerate module graph after package rename --- docs/module-graph.i18n.yaml | 4 ++-- docs/module-graph.md | 4 ++-- docs/module-graph.zh.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/module-graph.i18n.yaml b/docs/module-graph.i18n.yaml index c697f85817..b3adeb8c42 100644 --- a/docs/module-graph.i18n.yaml +++ b/docs/module-graph.i18n.yaml @@ -2,5 +2,5 @@ # side as of the last confirmed-consistent state. Both languages carry equal authority; # after editing either side, bring the other along and re-record with: # pnpm run verify-translation-pairing --write docs/module-graph.md -module-graph.md: 9157fef798cd1884cd21cd9ce7788f3882ed2dad -module-graph.zh.md: 06d6b1acb38fdd864e745a06fa6e40a018833d42 +module-graph.md: ae55f2bb2cf29f0f6f4ad3c16df9abb7a3511191 +module-graph.zh.md: cef0a09afb07c4f8ee5392899a1cee3f9cadf3ca diff --git a/docs/module-graph.md b/docs/module-graph.md index 9157fef798..ae55f2bb2c 100644 --- a/docs/module-graph.md +++ b/docs/module-graph.md @@ -277,8 +277,8 @@ flowchart TD pkg_host_frontend_static["host-frontend-static"] pkg_host_open_in_app["host-open-in-app"] pkg_host_plugin_inventory["host-plugin-inventory"] + pkg_host_product_telemetry_otel["host-product-telemetry-otel"] pkg_host_webserver["host-webserver"] - pkg_product_telemetry_otel["product-telemetry-otel"] end subgraph group_identity["packages/identity"] pkg_anonymous_user_id["anonymous-user-id"] @@ -1428,8 +1428,8 @@ flowchart TD | [`host-directory-picker-browse`](../packages/host/directory-picker-browse) | `host` | — | | [`host-directory-picker-native`](../packages/host/directory-picker-native) | `host` | — | | [`host-open-in-app`](../packages/host/open-in-app) | `host` | — | +| [`host-product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`host-webserver`](../packages/host/webserver) | `host` | — | -| [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`invariants`](../packages/runtime-diagnostics/invariants) | `runtime-diagnostics` | — | | [`session-format`](../packages/session/session-format) | `session` | — | | [`session-format-v0-to-v1`](../packages/session/session-format-v0-to-v1) | `session` | — | diff --git a/docs/module-graph.zh.md b/docs/module-graph.zh.md index 06d6b1acb3..cef0a09afb 100644 --- a/docs/module-graph.zh.md +++ b/docs/module-graph.zh.md @@ -279,8 +279,8 @@ flowchart TD pkg_host_frontend_static["host-frontend-static"] pkg_host_open_in_app["host-open-in-app"] pkg_host_plugin_inventory["host-plugin-inventory"] + pkg_host_product_telemetry_otel["host-product-telemetry-otel"] pkg_host_webserver["host-webserver"] - pkg_product_telemetry_otel["product-telemetry-otel"] end subgraph group_identity["packages/identity"] pkg_anonymous_user_id["anonymous-user-id"] @@ -1430,8 +1430,8 @@ flowchart TD | [`host-directory-picker-browse`](../packages/host/directory-picker-browse) | `host` | — | | [`host-directory-picker-native`](../packages/host/directory-picker-native) | `host` | — | | [`host-open-in-app`](../packages/host/open-in-app) | `host` | — | +| [`host-product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`host-webserver`](../packages/host/webserver) | `host` | — | -| [`product-telemetry-otel`](../packages/host/product-telemetry-otel) | `host` | — | | [`invariants`](../packages/runtime-diagnostics/invariants) | `runtime-diagnostics` | — | | [`session-format`](../packages/session/session-format) | `session` | — | | [`session-format-v0-to-v1`](../packages/session/session-format-v0-to-v1) | `session` | — |