Compare commits

...
32 Commits
Author SHA1 Message Date
修雨 e7a3010b81 docs: cut 1.0.35 changelog + fix README product-count drift (#435)
* docs: cut 1.0.35 changelog + fix README product-count drift

CHANGELOG: promote [Unreleased] to [1.0.35] - 2026-06-08, covering the
chat @-mention render fix (#433), chat list-direct skill alignment (#424),
pat chmod batch agentCode passthrough (#414), and pat JSON auth-URL
readability (#401).

README (en + zh): the multi-skills section claimed 19/20 products while the
Key Services summary says "18 products" (aiapp was taken offline in 1.0.34,
dropping the count to 18). Unify every product-count reference to 18.

* docs(readme): tidy Key Services table — concise descriptions, drop subcommand duplication

The Description column re-listed every subcommand already shown in the
Subcommands column, making rows (esp. chat) very tall and uneven. Rewrite
descriptions as concise, parallel capability summaries and drop the
malformed inline '(top-level: ...)' sprawl in the sheet row. en + zh.

* docs(readme): restore Key Services table; keep only product-count fix

The previous commit silently rewrote/reflowed the entire Key Services
table (shortening every Subcommands + Description cell) — far beyond this
PR's stated "纯文档改动 / product-count drift fix" scope.

Restore both tables (README.md + README_zh.md) byte-for-byte to main and
keep ONLY the six intended count corrections (multi skills 20/19 → 18),
so the diff matches the PR description and the table is not re-wrapped.

* docs(changelog): write 1.0.35 entries in English

The 1.0.35 Fixed entries were in Chinese while all prior releases
(1.0.34, 1.0.33, ...) use English. Translate the four entries (#433,
#424, #414, #401) to English to match the existing CHANGELOG convention;
content unchanged.
2026-06-09 10:32:23 +08:00
修雨 e7ef2c4677 fix(chat): keep @-mention tokens literal so they render (#433)
send_personal_message packs the message body via json.Marshal, whose
default HTML escaping rewrites <@openDingTalkId> / <@all> into
<@...>. The DingTalk client renders an @-mention by matching the
literal <@...> token, so the escaped form is shown as plain text and the
@ never renders (API still returns success, masking the bug).

Marshal the content with SetEscapeHTML(false) for both the group and the
direct send_personal_message paths. Add a regression test asserting the
content keeps literal <@...> tokens and is never HTML-escaped.

Verified live: @someone and @all now render as blue mentions in the client.
2026-06-08 21:46:41 +08:00
修雨 8c2093a41a fix(skill): align chat single-chat docs/script with list-direct (#424)
* fix(skill): align chat single-chat docs/script with list-direct

钉钉 MCP 服务已将单聊从 `chat message list` 拆出独立的 `list-direct` /
`send-direct`(list 现仅支持群聊,--user / --open-dingtalk-id 已移除),
但 skill 侧文档与脚本仍在教 `chat message list --user`,照做会因 unknown
flag 报错;推荐为单聊"优先"方法的 chat_history_with_user.py 也随之失效。

- chat.md (mono+multi): `message list` 改为仅群聊;新增 `list-direct` /
  `send-direct` 两段命令文档;意图路由 / 关键区分 / 上下文传递表 / 注意事项
  全部对齐单聊新命令
- best_practices/01-messaging.md (mono): query-private-chat 由 `list --user`
  改 `list-direct`(multi 版此前已改,未动)
- chat_history_with_user.py (mono+multi): 调用 `list-direct`;并修复返回体
  解析——解包 `result.messages` + 对齐 `createTime/content/sender` 字段,
  此前会崩在 `'str' object has no attribute 'get'`

* docs(changelog): add entry for chat single-chat list-direct alignment (#424)

* fix(skill): drop send-direct from chat docs (not a v1.0.34 command)

复核 v1.0.34 CLI 发现:单聊发送 rpc `send_direct_message_as_user` 在
v1.0.34 已并入 `chat message send`(cli_name=send,用 --user),不再暴露
独立的 `send-direct` 命令(仅 v1.0.29 有)。上一提交按 v1.0.29 误加的
send-direct 文档段/路由/关键区分/上下文表引用对 v1.0.34 是错的,全部移除。

list-direct 部分保留不变——v1.0.34 确认 `list` 仅群聊、`list-direct`
存在,`list --user` 仍报 unknown flag。单聊发送回归 `send --user`。
2026-06-07 16:17:31 +08:00
修雨 5fbf12fe50 Revert "fix(cli): JSON errors to stdout; no interactive confirm on piped stdin (#413)" (#415)
This reverts commit f826375556.
2026-06-05 12:10:17 +08:00
xuanandshangguanxuan.sgx dd419ca498 fix(pat): pass agent code to chmod batch tools (#414)
Co-authored-by: shangguanxuan.sgx <shangguanxuan.sgx@alibaba-inc.com>
2026-06-05 11:23:48 +08:00
修雨 f826375556 fix(cli): JSON errors to stdout; no interactive confirm on piped stdin (#413)
- printExecutionError: in JSON mode emit the structured error to stdout
  (not stderr) so machine consumers parsing stdout get a parseable result;
  update the 3 root_execute tests to assert the new contract.
- requireYesForDelete prompt: when stdin is not a TTY (piped/scripted/JSON
  pipelines), do not show an interactive confirm that emits non-JSON and
  blocks on stdin; return a structured validation error requiring --yes.
2026-06-05 11:22:22 +08:00
xuanandshangguanxuan.sgx cb95207d5a fix(pat): keep auth URLs readable in JSON output (#401)
* fix(pat): keep auth URLs readable in JSON output

* fix(pat): narrow URL escaping fix to PAT JSON

---------

Co-authored-by: shangguanxuan.sgx <shangguanxuan.sgx@alibaba-inc.com>
2026-06-04 15:57:06 +08:00
Ari 1e95d03606 Merge pull request #405 from audanye-sudo/feat/switch-discovery-url
fix: version-code discovery path and take aiapp product offline
2026-06-03 19:45:39 +08:00
修雨 6e3f3cbd24 chore: take aiapp product offline
Remove the entire code surface of the aiapp (AI application: create/query/modify) product:
- Delete internal/helpers/aiapp.go and its test (the init() static command registration)
- Drop aiapp from generator coverage targets and knownRegistryProducts
- Remove aiapp from the operations-analyst persona services in personas.yaml
- Delete skills (mono references/products/aiapp.md + dingtalk-aiapp multi skill + script)
- Update README/README_zh product tables and counts (19->18 products, 20->19 multi skills) and run_skill_tests mapping
- Add a Removed entry to CHANGELOG

The service-discovery side (envelope/discovery.pre.json, Portal-synced and gitignored) removes the aiapp server block separately.
2026-06-03 19:41:05 +08:00
audanye-sudo ce5e919c52 fix(market): version-code discovery path as /cli/discovery/apis/bamboo
Extract the server-list endpoint path into a single discoveryAPIPath constant and move it from /cli/discovery/apis to /cli/discovery/apis/bamboo so future version bumps touch one place.

Only the path changes: the MCP base host stays on production https://mcp.dingtalk.com and the auth / skill / doctor endpoints are untouched. The edition DiscoveryURL hook (full-URL FetchServersFromURL) is unaffected. All mock/test fixtures are updated to the new path and a CHANGELOG 1.0.34 entry is added.
2026-06-03 19:41:04 +08:00
修雨 c75ed45c70 fix(keychain): add StorageDir for Windows to unblock v1.0.33 release (#394)
* docs(chat): 资源下载分流改为按 host 判定,补 media 直链可裸 curl(整合 #376)

main 现状的「资源链接形态分流」段补三类增量,supersede #376:
- 判定依据从「链接形态」改为「链接 host,不由扩展名」
- media(down.dingtalk.com/media)点明为公开 CDN,download-media 命令之外裸 curl 也可直下
- 补 .unknown 用 file 判真实类型、图片 AI 描述说明
- 保留 download-media 官方命令路径,删去 #376 误判「无 mediaId 下载命令」一句

* docs(chat): 修正 media 下载分流——host 非唯一、首选 download-media、签名链勿裸 curl

修复 PR 原版对 media 链接的过头断言(评审发现):
- 点明图片 mediaId 链接 host 不唯一:down.dingtalk.com/media(公开)或 *.trans.dingtalk.com 签名+过期链
- 下载主路改为首选 download-media(取最新 URL,不受过期影响);裸 curl 仅限公开直链
- 删去「无需鉴权 / curl 均 HTTP 200」的普适断言(签名链过期后 curl 403)
- 保留 .unknown 用 file 判类型、AI 图片描述、钉盘/alidocs 分流

* fix(keychain): add StorageDir for Windows to unblock cross-platform release

portable_store.go (#357) references keychain.StorageDir on all platforms,
but only keychain_darwin.go / keychain_linux.go defined it — the Windows
backend (DPAPI + registry) lacked StorageDir, so GoReleaser's
windows/amd64 + windows/arm64 cross-compile failed with
'undefined: keychain.StorageDir' and broke the v1.0.33 release.

Add StorageDir to keychain_windows.go: DWS_KEYCHAIN_DIR override →
%LocalAppData%\<service> default, mirroring the linux/darwin logic.
Verified: go build passes for windows/darwin/linux x amd64/arm64.
2026-06-02 23:37:06 +08:00
修雨 a8b1670ad9 docs: 同步 CHANGELOG 1.0.33 与 README 命令清单(打 tag 前) (#393)
CHANGELOG:新增 [1.0.33] 版本块,归并 #391 整批能力(doc 文档族 / wiki 知识库 /
aiapp / aitable 表单与导入导出 / mail / todo / report 可读日志)、可迁移认证包
auth export/import (#357)、PAT 批量授权与精简摘要输出 (#389)。

README(中英双版):按当前命令树实测校准各产品命令数(contact 6→15、todo 6→16、
report 7→20、mail 4→18、wiki 7→21、oa 9→15、aitable 42→52、doc 21→28;sheet 34→23
并删除已移除的 copy_sheet/submit_export_job 等命令),总数 213→334,补全新增命令组。
2026-06-02 22:46:28 +08:00
johnand玉澜 8c4bd71964 fix(doc): align export progress output (#392)
Co-authored-by: 玉澜 <yulan.wqy@alibaba-inc.com>
2026-06-02 22:26:03 +08:00
539d10f80f feat: 合并 pre-mcp-discovery 分支能力到 main(服务发现保持生产) (#391)
将 test/pre-mcp-discovery 分支上多位同学的能力改动整体合入 main,
服务发现端点保持生产 https://mcp.dingtalk.com,未携带分支上的预发改动。

主要内容:
- 修雨域(chat / report / todo / contact / mail)对齐 wukong 基线 (#355)
- DWS 内容生产能力增强 (#387)、文档导出与 OA 对齐 (#362 #388 #390)
- envelope 注册 cli.Aliases 为 cobra aliases、命令结构与 JSON 解析优化
- skills 多包同步 wukong 对齐内容(attendance/calendar/minutes/oa/sheet 等)
- product/oa 进一步对齐 wukong

排除项:未携带 566b4e1(test: point service discovery to pre-mcp.dingtalk.com);
以下 4 个常量保持生产:skill_command.go / auth/endpoints.go / cli/loader.go / market/registry.go。

Co-authored-by: john <32427341+wqyenjoy@users.noreply.github.com>
Co-authored-by: wxianfeng <wang.fl1429@gmail.com>
2026-06-02 21:04:12 +08:00
56a5edecef feat(pat): support batch chmod authorization flows (#389)
* feat(pat): support batch chmod flows

* feat: use server default agentCode for chmod

* feat: surface tool auth metadata

* feat: infer product grant auth metadata

* chore: update coverage badge [skip ci]

* feat(pat): summarize chmod output by default

* chore: update coverage badge [skip ci]

* fix(pat): preserve batch session metadata

* fix(pat): align dry-run session and schema docs

* chore(config): use public example MCP override URL

* fix(pat): align chmod session env handling

---------

Co-authored-by: shangguanxuan.sgx <shangguanxuan.sgx@alibaba-inc.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-06-02 20:54:55 +08:00
修雨 4ebc8d0d38 fix(plugin): silence stdio discovery handshake failures (Warn → Debug) (#380)
The conference-local stdio plugin runs an Initialize/ListTools handshake
during command-tree construction. When the DingTalk desktop client isn't
running it returns "本地服务未就绪", which was logged at Warn and printed
to stderr on every invocation.

Because discovery happens in NewRootCommandWithEngine — before
PersistentPreRunE applies --debug/--verbose via configureLogLevel — this
Warn showed regardless of flags, polluting output and misleading callers
(and LLMs) into treating it as the cause of an unrelated command error
(e.g. an auth error or PARAM_ERROR from a different server).

This is an expected, benign outcome for an optional local plugin:
commands that ship toolOverrides still register up-front via
registerStdioServerFromOverlay, so availability is unaffected. Downgrade
both discovery handshake failures to Debug so normal output stays clean.
2026-06-01 17:11:52 +08:00
4e58e45d30 feat(auth): add export/import for portable sandbox credentials (#357)
* feat(auth): add export/import for portable sandbox credentials

Enable migrating encrypted keychain and config between Linux sandboxes so refresh tokens survive beyond the 2-hour access token window.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(auth): harden portable export/import per PR review

按 PR 审查意见加固可迁移认证包流程:macOS 默认 Keychain
场景拒绝导出;导入需 --force 覆盖已有登录态;解析 manifest
并在 OS 不匹配时告警;export 参数校验前置;flag 描述中文化;
移除已弃用的 tar.TypeRegA;导出文件后提示删除敏感包。

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(auth): require auth-token.enc before portable export

修复 staticcheck S1030(测试改用 exported.Bytes())。
导出前校验 auth-token.enc 存在,避免无登录态时生成
仅含 dek 的无效 bundle;CLI 提示先运行 dws auth login。

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: 洛丘 <wangketing.wkt@antgroup.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-29 09:19:11 +08:00
修雨 5ce7cb61b0 feat(skill): dws skill setup with mono/multi modes (#332)
新增 `dws skill setup` 交互式安装命令,支持单产品(mono)和多产品(multi,标记为试验版)两种 skill 布局,并与开源 dws v1.0.30 命令对齐。

主要变更:
- 骨架:skills/ 拆为 skills/mono/ 和 skills/multi/(29 个产品 skill),git rename 保留历史
- 命令:新增 `skill setup` cobra 子命令,支持 --mode、--target、--source、--yes,huh 交互
  - multi 模式支持 -s/--skill、-x/--exclude 按产品选择
  - 覆盖全部 14 个 agent home 目录(与 install.sh 一致)
- 发布:install.sh / install.ps1 / post-goreleaser.sh 改读 skills/mono;dws-skills.zip 同时包含 mono 和 multi 内容;~/.dws 本地缓存
- 内容对齐:删除 8 个仅内部使用的产品 skill、dingtalk-a2a;修正 mono/multi 共 15+ 处命令引用以匹配 OSS dws v1.0.30;chat skill 从 dws-wukong 回移更新
- 漂移清理:物理删除 skill 文档中 OSS 未暴露的命令,true-fail 命令转为 caveat;--help diff 100% 覆盖审计
- 测试:新增 Layer A 静态命令调度验证 + Layer B 端到端 mock 调度验证
- 同步 main:drive 9 个命令同步到 mono/multi skill
2026-05-26 09:17:37 +08:00
修雨 86ff7e2f50 docs(changelog): add 1.0.32 release notes (#354) 2026-05-25 19:54:47 +08:00
Ari 45cb237f74 fix(drive): unblock OSS upload + improve AI-agent discoverability (#347)
* fix(drive): drop client-side Content-Type fallback on presigned OSS PUT

The drive helper used to set req.Header["Content-Type"] = fallbackMIME
whenever the prepare_upload response returned an empty headers map.
DingTalk drive uses OSS presigned URLs whose StringToSign is computed
against an empty Content-Type at signing time, so any client-side
Content-Type makes the signature OSS recomputes at PUT time differ
from the server's presignature → HTTP 403 SignatureDoesNotMatch.

This broke every `dws drive upload` for any file whose mime detects
to a non-empty value (image/png, application/pdf, etc.), which is
basically everything in practice.

Reproduction (against DingTalk drive):
  dws drive upload --file any.png
  → [1/3] 获取上传凭证 any.png (X 字节, image/png)...
  → [2/3] 上传文件到 OSS...
  → OSS 上传失败 HTTP 403: SignatureDoesNotMatch

Fix: trust the server's headers map as authoritative. Empty map means
"no client-side headers needed" — do not infer and add Content-Type.
Removes the hasContentType / fallbackMIME path entirely; httpPutDriveFile
signature loses the fallbackMIME parameter.

Manual verification:
  curl -X PUT -H "Content-Type:" --data-binary @file <same-presigned-url>
  → HTTP 200 (proves the only difference was the client-side Content-Type)

Note: aitable.go's upload-file helper deliberately keeps its
Set("Content-Type", mimeType) call because its OSS endpoint uses a
different signing mode (server includes the client-declared mime in
its signature computation, verified by running aitable upload-file
across 12 file types — all succeed). The two helpers must not be
unified without re-validating both endpoints.

Tests:
  - TestHttpPutDriveFile_NoContentTypeWhenServerHeadersEmpty: guards
    that an empty server headers map results in no Content-Type on PUT.
  - TestHttpPutDriveFile_PassthroughServerHeaders: guards that server
    headers (Content-Type, x-oss-*) are forwarded verbatim.

* feat(aitable): unhide attachment upload-file + clarify prepare-only command

AI agents that discover commands only via --help (e.g. Lobster, generic
LLM agents) currently hit a dead end when trying to upload an attachment
to an AITable:

  - `dws aitable attachment` exposes only `upload` (prepare-only),
    which returns uploadUrl + fileToken but does not actually upload.
  - The real one-shot command `attachment upload-file` (which performs
    prepare + HTTP PUT + return fileToken automatically) is marked
    Hidden:true, so it is invisible in --help output.

Agents that don't read skills/references/products/aitable.md therefore
get stuck after step 1 — they call `upload`, receive an uploadUrl they
have no idea how to consume, attempt various wrong things (e.g. write
the uploadUrl into the record's attachment field as if it were a token),
fail, and fall back to "please use the UI to upload" messages, which
makes dws look broken even though the capability is fully implemented.

This is the same UX gap that lark-cli avoids with its highly visible
`base +record-upload-attachment` command — discoverability via --help
is the difference between "works for any agent" and "only works if the
agent reads our skill docs".

Changes:

  - newAITableUploadFileCommand: remove Hidden:true so the command
    appears in `dws aitable attachment --help`. Tighten Short to
    explicitly mention the 3 steps it bundles. Long now also calls
    out the prepare-only sibling and recommends this command as the
    default for AI agents.

  - newAITableAttachmentUploadCommand (prepare-only): add a Long
    description that explicitly states this command is only step 1
    of a 3-step flow, lists what an agent must do after (HTTP PUT,
    then write fileToken into record attachment field with the exact
    [{"fileToken":"ft_xxx"}] shape), and points to upload-file as
    the recommended one-shot alternative. Updated Short to flag that
    no file is uploaded by this command.

  - aitable_upload_file_test: add TestAITableUploadFileCommandIsDiscoverable
    to guard against re-introducing Hidden:true. The test includes a
    rationale comment explaining the agent-discoverability gap.

The drive Content-Type fix in the preceding commit and this aitable
discoverability fix together restore end-to-end attachment upload
functionality for both human operators and AI agents that only read
--help.

* feat(root): show 'dws upgrade' guidance in dws --help when commands are missing

AI agents (and users) reading `dws --help` see only the discovered MCP
service list and utility command list, with no hint about what to do if
none of the listed commands fit their task. The natural failure mode is
to give up or hack around — but in many cases the right action is just
`dws upgrade`, because new capabilities and bugfixes ship continuously
and a missing command is usually a stale binary issue.

Two changes restore visibility of the root command's Long description so
this guidance can be surfaced:

  - internal/app/root.go: set root.Long to a one-paragraph hint —
    "if you hit a missing command, an error, or cannot complete the
    task, try `dws upgrade` first; both the DingTalk OpenAPI surface
    and dws CLI evolve continuously."

  - internal/app/root_help.go: the custom SetHelpFunc that renders the
    root help (renderRootHelp) replaces cobra's default template, which
    had been silently dropping root.Long from --help output. Restore
    rendering by appending root.Long (when non-empty) after the command
    list, separated by a blank line. This matches cobra's default
    behavior for the Long field while preserving the custom services /
    utilities sections renderRootHelp introduced.

  - internal/app/visibility_test.go: new TestRenderRootHelpIncludesLong
    guards against re-introducing the regression. Uses a sentinel Long
    string and asserts renderRootHelp output contains it verbatim. If a
    future change rewrites the help renderer without preserving Long
    rendering, this test fails immediately and reminds the author the
    upgrade hint must stay visible.

Verified locally:
  $ ./dws --help | tail -3
  Use "dws <service> --help" for more information about a discovered MCP
  service or "dws <command> --help" for utility commands.

  提示: 如果遇到能力缺失、命令报错、新功能未注册、或无法完成任务,
  请先用 'dws upgrade' 升级到最新版本后再试. 钉钉 OpenAPI 和 dws CLI
  持续迭代, 新能力和 bugfix 会先在新版本上线.
2026-05-24 15:55:08 +08:00
修雨 bd711108f9 fix(upgrade): ad-hoc sign darwin binaries to fix amfid SIGKILL on Apple Silicon (#339)
GoReleaser cross-compiles darwin/arm64 binaries on ubuntu-latest with no
codesign step. macOS 11+ on Apple Silicon requires at least an ad-hoc
signature; unsigned arm64 binaries are SIGKILL'd by amfid on first exec,
which surfaces as `signal: killed` and aborts `dws upgrade` at the
"解压并验证" step.

Two layers of fix:

1. Release-side: post-goreleaser.sh now unpacks each dws-darwin-*.tar.gz,
   applies an ad-hoc signature (codesign locally, rcodesign in CI),
   deterministically repacks, and rewrites the matching line in
   checksums.txt. release.yml installs rcodesign 0.27.0 before
   GoReleaser runs.

2. Client-side self-heal: validateNewBinary detects `signal: killed` on
   darwin and retries once after running `codesign --force --sign -` and
   clearing com.apple.quarantine. Future releases stay functional even
   if the signing step is ever skipped.

Verified end-to-end: stripped a real dws binary → exec exits 137 →
validateNewBinary recovers → final binary shows Signature=adhoc and runs.
2026-05-21 22:45:22 +08:00
修雨 6b4d808d39 docs(changelog): add 1.0.31 release notes (#338) 2026-05-21 20:22:57 +08:00
修雨andClaude Opus 4.7 c7d8ddf98d feat: align drive with wukong — helper (upload) + skill docs (doc/sheet dingpan URL) (#335)
* feat(helpers): drive upload 三步合成胶水(list-spaces / delete 由 envelope 接管)

业务背景:开源版 dws drive 仅有来自服务发现 envelope 的 6 个工具,悟空版多
3 个能力 — list-spaces / upload / delete。这 3 个里只有 upload 是真正的客户端
胶水(PUT 文件二进制到 OSS 的中间 HTTP 步),其它两个完全可以通过 envelope
toolOverrides 表达,无需 Go 代码。

按 envelope 优先原则拆分:

1. envelope/pre-discovery.pre.json (单独提供 / 不在本 commit)
   - drive.toolOverrides.list_spaces  →  cliName: list-spaces
   - drive.toolOverrides.delete_document → cliName: delete, serverOverride: doc,
                                             isSensitive: true
2. internal/helpers/drive.go (本 commit)
   - 仅注册 upload 一个 leaf
   - 原因:envelope.PipelineStep 只支持 type:"call"/"download",没有
     type:"upload"。客户端流式 PUT 本地文件到 OSS 签名 URL(含 per-URL
     headers)当前 envelope schema 表达不了,故保留为 helper。

internal/helpers/drive.go (新增 ~290 行)

  - upload — 三步合成:
    1) drive get_upload_info → resourceUrl + uploadId + headers
    2) HTTP PUT 文件二进制 → OSS(沿用 aitable upload-file 模式,
       10min timeout,跟随 per-URL headers)
    3) drive commit_upload → 提交入库
    --dry-run 输出三步 invocation 预览不实际请求。
    parseDriveUploadInfo 兼容 content/result 包裹层与 resourceUrls 数组
    及 flat resourceUrl/uploadUrl fallback,与悟空侧 parseDriveUploadInfo
    等价。
    validateDriveParentID 拒纯数字 dentryId(防混淆 chat 链路 dentryId 与
    drive 链路 dentryUuid)。

注入路径:helpers.RegisterPublic → pickCommands.MergeHardcodedLeaves(dynamic,
helper)(dynamic 赢冲突、helper 填空白)。本 helper root.Use="drive" 不覆盖
dynamic 的 6 个 leaf,仅追加 upload。

dry-run 实测:

  $ dws drive upload --file /etc/hosts --dry-run --format json
  → step_1_get_upload_info + step_2_http_put_oss + step_3_commit_upload 三步预览

测试结果:
  ok  internal/helpers (含全部既有 TestSendByBot* / TestAtomicWrite* /
                       TestValidate* 等 23 个测试)
  ok  test/integration/extensions
  test/cli_compat pre-existing failures 与本改动无关(在干净 origin/main HEAD
  同样 fail,fixture 缺失等)。

未来工作 (follow-up):
  - 等 envelope 文件 commit 到主线后,list-spaces / delete 自动从 envelope
    生成 cobra command,无需此 helper 操心
  - 如果 envelope schema 加入 type:"upload" pipeline 步类型,本 helper 整个
    可以删除,由 envelope pipeline 表达完整三步

关联:
  - 悟空源头实现:dws-wukong/wukong/products/drive.go
    (runDriveUpload / parseDriveUploadInfo / httpPutFile + delete 路由)
  - 配套 skill 文档 PR:#333 (doc 端钉盘 URL 识别)
  - envelope 改动: drive.toolOverrides 增加 list_spaces + delete_document,
    见对应的 envelope PR / commit

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(skill): doc --node 接受钉盘 document/edit|preview?dentryKey URL + 新增 url-patterns 分流

业务背景:hho 业务侧用户在悟空版上已用钉盘 URL(alidocs.dingtalk.com/document/edit?dentryKey=...)
直接喂给 Agent,但开源版 skill 文档未覆盖这种格式,Agent 不知道整段 URL 应原样传给 --node,
经常误把 dentryKey 当成裸 nodeId 调用导致失败。

本 PR 把悟空 dws-wukong PR #82157526 的 skill 文档增量移植到开源主线,保持 doc/sheet
两端入口的 URL 识别策略对齐悟空:

skills/SKILL.md
- 核心流程新增 Step 0「URL 预检」:含 alidocs URL 必须先读 url-patterns.md 分流,再选择产品
- 详细参考目录加入 url-patterns.md 引用

skills/references/products/doc.md
- dws doc info/read 的 Example 各 +2 行钉盘 URL 示例
- 「URL 识别与 DOC_ID 提取」支持的 URL 格式表新增 document/edit|preview?dentryKey={key} 一行
- 提取规则拆成 3 条,禁止 Agent 自行提取 dentryKey 当裸 nodeId
- 「nodeId 双格式说明」升级为「nodeId 多格式说明」,给出 4 种 --node 输入等价示例

skills/references/url-patterns.md (新建)
- 沉淀 alidocs URL 5 类分流决策:/i/p/ 短链 / /i/nodes/ 节点 / /spreadsheetv2/ 直链 /
  /document/edit|preview?dentryKey 链接 / 其他
- 含 i/nodes/ 类型探测流程(doc info 探 contentType/extension/nodeType 后再选产品)
- 含分享短链 read_url 兜底处理 + 动态渲染失败时的标准答复

skill 命名形态兼容:
- 当前 main 上 skills/ 是扁平结构,改动直接落在 skills/* 路径
- 单点(mono)/ 多点(multi)拆分形态在 feature/skill-setup 分支,待该分支合主线时
  按相同语义同步到 skills/mono/* 和 skills/multi/dingtalk-{doc,sheet}/* 两套

不涉及 Go 代码变更,纯 skill 文档;钉盘 URL 解析逻辑由 MCP 服务端承担。

关联悟空 PR:dws-wukong commit 565c63f8 / 712da968(#82157526)
对应 wukong skill 包:dingtalk-workspace/{SKILL.md,references/products/doc.md,references/url-patterns.md}

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 17:38:00 +08:00
修雨 754b0df056 docs(changelog): add 1.0.30 release notes (#322)
* docs(changelog): add 1.0.30 release notes

Notes for the wukong-IM-envelope alignment + schema-pipeline / transform /
market enhancements that landed via #317. Also extends the README "Pipe &
File Input" section with the `@<text>` ASCII-prefix rule that lets literal
Chinese mentions like `@所有人` / `@张三` pass through unchanged.

Validated against `dws-wukong/auto-test/cli_to_mcp` with `--edition open`,
account wukong01, on this main:
- chat: 107 passed / 0 failed / 0 errored → 100.0% PASS
- report: auto-test/cli_to_mcp/open_report/test_report_20260519_155449.md

* docs(changelog,readme): drop internal validation note; refresh chat row

- CHANGELOG: remove the validation paragraph from the 1.0.30 entry — it
  cited an internal repo path, a test account, and a local-only report
  file, none of which belong in public release notes.
- README / README_zh: bump the Chat / IM row in the Key Services table
  from 23 → 57 leaves and expand the subcommand list to match the
  current chat tree (group-mute / group-mute-member / mute / set-top /
  list-categories / list-conversations, plus message reply, search /
  search-advanced, forward, emoji & text-emotion reactions, cards,
  group member-role CRUD, transfer-owner, set-admin, quit, ...). Count
  matches `dws chat --help` enumeration on this main.
2026-05-19 17:29:35 +08:00
修雨 6be124777f feat: align CLI to wukong IM envelope + schema pipeline / transform / market enhancements (#317)
把 test/pre-mcp-discovery 上累积的稳定改动整理成一个 commit 合入 main,剔除
test-only 的预发环境硬编码与 merge/revert 噪音。

- internal/helpers: 重写 chat.go 对齐 wukong IM envelope,拆分共享的 chat
  命令,删减历史测试桩
- internal/compat: 新增 Pipeline tool override + executor、CLIAliases
  override、json_parse_strict 与 file_read transform;envelope leaf cmd
  Args 从 NoArgs 放宽到 ArbitraryArgs
- internal/cli: stdin 处理增强,覆盖更多 --content / --content-file 路径
- internal/app: direct_runtime / runner 适配嫁接硬编码 helper 到动态命令树
- internal/market: registry 强化 + 单元测试

最终 diff: 12 个文件,+369 / -387。
2026-05-19 15:25:39 +08:00
修雨 355a1460d9 docs(changelog): add 1.0.29 release notes (#309)
CHANGELOG: write up 1.0.29 — summary paragraph, then Added (3 new
envelope products: aiapp / live / aisearch with their flag aliases /
subcommand aliases / short flags rationale), Fixed (#306 leaf cmd
ArbitraryArgs), and the existing Security entry (#300 app.json
edition partitioning) preserved.

README.md / README_zh.md: lift aiapp / aisearch / live out of "Coming
soon" into the Key Services table; rename "Coming soon" to keep only
conference; bump totals 16 → 19 products / 204 → 209 commands.
2026-05-17 17:59:28 +08:00
c6edc84e40 fix(auth): partition app.json filename by edition to isolate credentials (#300)
* fix(auth): partition app.json filename by edition to isolate credentials

Two dws binaries sharing the same config directory (typically ~/.dws or
DWS_CONFIG_DIR) previously read and wrote a single app.json. Editions
that pin AuthClientID via hooks still go through the open-core
post-login persistence path, which records a bare ClientID without a
paired ClientSecret. The sibling edition reading the same path would
then adopt that foreign clientID via ResolveAppCredentials.

Mirror the strategy already used by the cache loader
(pkg/config.EditionPartition): GetAppConfigPath returns a filename
suffixed with the active edition name. Open-source keeps "app.json" for
backwards compatibility; sibling editions land on "app-<edition>.json".
LoadAppConfig / SaveAppConfig / HasAppConfig / DeleteAppConfig all
route through GetAppConfigPath, so this single change physically
isolates credential files end-to-end without any read-time heuristics.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(auth): address app config partition review

* fix(auth): clean legacy sibling app config

* test(auth): cover legacy app config cleanup guards

* fix(auth): close app config review follow-ups

---------

Co-authored-by: shangguanxuan.sgx <shangguanxuan.sgx@alibaba-inc.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-17 17:43:20 +08:00
修雨 f497047fff fix(compat): relax envelope leaf cmd Args from NoArgs to ArbitraryArgs (#306)
NewDirectCommand was hard-coding cobra.NoArgs for envelope-generated
leaf commands that have no positional bindings (totalMax == 0). This
is stricter than cobra's own default — legacyArgs (args.go:30-32)
returns nil for any command without subcommands.

The strict behavior surfaced as "unknown command \"<word>\" for
\"dws aisearch person\"" whenever an AI agent passed trailing
positional words after a leaf, e.g.

  dws aisearch person search --keyword "张"
  dws aisearch person user search --keyword "张"

Switching to cobra.ArbitraryArgs restores cobra's natural leaf
behavior: trailing positional args are silently ignored. Existing
positional-binding paths (MinimumNArgs / RangeArgs / MaximumNArgs)
are unchanged.

Verified against dws-wukong/auto-test/cli_to_mcp/testcases on
aiapp / live / aisearch: 50/50 pass (was 48/50; the 2 remaining
failures were the F-class extra-positional-args tolerance cases
this commit fixes).
2026-05-17 17:23:17 +08:00
修雨 a9de7d3ca4 chore(readme): refresh community DingTalk group QR (#296)
* chore(readme): refresh community DingTalk group QR

Replace the external alicdn-hosted QR image with a repo-tracked one
(.github/assets/community-qr.png), so the README is self-contained and
not dependent on third-party CDN availability.

QR encodes an external (cross-org) DingTalk group "dws开源沟通群",
valid until 2027-05-14. Scan with DingTalk mobile to join.

* chore(readme): use alicdn-hosted QR image (no repo binary)

Drop the repo-tracked .github/assets/community-qr.png and reference the
new community group QR via the alicdn CDN URL instead, matching the
original README convention (external image, no binary asset in tree).

QR points to "dws 开源沟通群" (external/cross-org DingTalk group),
valid until 2027-05-14. Mobile scan to join.

* chore(readme): match prior QR image width (150px)
2026-05-15 13:56:54 +08:00
FuShu-Yang 1c200d883f fix(app): prevent command field from overwriting existing endpoint (#297)
* fix(app): prevent command field from overwriting existing endpoint

In AppendDynamicServer, when a plugin declares command != id, the command
endpoint is written unconditionally, overwriting any previously registered entry.

Fix: use first-writer-wins - only write if the key is not yet present.

id registration and dynamicProducts remain unconditional (unaffected).

* test(app): add regression test for command endpoint first-writer-wins guard
2026-05-15 11:29:07 +08:00
修雨 d268524084 docs(changelog): add 1.0.28 release notes (#295) 2026-05-14 21:34:28 +08:00
修雨 ed4673e7d2 fix(chat): require --title for group messages, completing #250's symmetric fix (#294)
`send_message_as_user`'s schema also marks `title` as required, but
`buildChatMessageSendInvocation` only pre-validated it for direct
messages. Sending `dws chat message send --group <cid> --text "1"`
without `--title` therefore reached the API and returned the same
misleading `发群服务窗会话消息失败` business error that #250 fixed for
direct messages, just on the other branch.

Pre-validation now covers both branches: group sends without title
return `--title is required for group messages (--group)`, direct sends
keep the existing `--title is required for direct messages (...)`
message. `Long` help, the `--title` flag description, the first
`Example` line, and `skills/references/products/chat.md` (including the
deeper "drive → chat" workflow example) are realigned to
"群聊与单聊都必填". `internal/helpers/chat_test.go` gains a
`group-without-title` case, and the existing `group` / `positional-text`
success cases are updated to pass `--title`. No API request shape change.
2026-05-14 21:13:28 +08:00
376 changed files with 78492 additions and 5582 deletions
+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="108" height="20" role="img" aria-label="coverage: 54.2%"><title>coverage: 54.2%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="108" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="47" height="20" fill="#e05d44"/><rect width="108" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="835" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">54.2%</text><text x="835" y="140" transform="scale(.1)" fill="#fff" textLength="370">54.2%</text></g></svg>
<svg xmlns="http://www.w3.org/2000/svg" width="108" height="20" role="img" aria-label="coverage: 57.5%"><title>coverage: 57.5%</title><filter id="blur"><feGaussianBlur in="SourceGraphic" stdDeviation="16"/></filter><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="108" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="47" height="20" fill="#dd4343"/><rect width="108" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".80" filter="url(#blur)" transform="scale(.1)" textLength="510">coverage</text><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="835" y="150" fill="#010101" fill-opacity=".80" filter="url(#blur)" transform="scale(.1)" textLength="370">57.5%</text><text aria-hidden="true" x="835" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">57.5%</text><text x="835" y="140" transform="scale(.1)" fill="#fff" textLength="370">57.5%</text></g></svg>

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

+11
View File
@@ -28,6 +28,17 @@ jobs:
- name: Install archive tooling
run: sudo apt-get update && sudo apt-get install -y zip unzip
- name: Install rcodesign (ad-hoc sign darwin binaries from Linux)
run: |
set -eu
RCS_VERSION="0.27.0"
curl -fsSL -o /tmp/rcodesign.tar.gz \
"https://github.com/indygreg/apple-platform-rs/releases/download/apple-codesign%2F${RCS_VERSION}/apple-codesign-${RCS_VERSION}-x86_64-unknown-linux-musl.tar.gz"
mkdir -p /tmp/rcodesign
tar -xzf /tmp/rcodesign.tar.gz -C /tmp/rcodesign --strip-components=1
sudo install -m 0755 /tmp/rcodesign/rcodesign /usr/local/bin/rcodesign
rcodesign --version
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v6
with:
+3
View File
@@ -31,3 +31,6 @@ _docs
dws.zip
*.code-workspace
/dingtalk-workspace.zip
# envelope/discovery.pre.json synced via Portal, not git-tracked
/envelope/discovery.pre.json
+126
View File
@@ -4,6 +4,132 @@ All notable changes to this project will be documented in this file.
The format is inspired by [Keep a Changelog](https://keepachangelog.com/) and this project follows [Semantic Versioning](https://semver.org/).
## [Unreleased]
## [1.0.35] - 2026-06-08
### Fixed
- **`chat message send` @-mentions not rendered in group / direct chat** (#433, `internal/helpers/chat.go`) — when sending a group message or an openDingTalkId direct message (`send_personal_message`) as the current user, the `content` body was packed with `json.Marshal`, whose default HTML escaping turns the `<` `>` in `<@openDingTalkId>` / `<@all>` into `<` `>`. The DingTalk client renders @-mentions by matching the **literal** `<@...>` token, so after escaping the match fails and the mention shows as plain text — while the API still returns `success`, masking the bug. Fix: add `marshalMessageContent`, which serializes `{title,text}` with `json.Encoder` + `SetEscapeHTML(false)`; both the group and openDingTalkId-direct `send_personal_message` paths now use it, preserving the literal `<@...>`. Added regression test `TestChatMessageSendContentNotHTMLEscaped` asserting the content keeps the literal token and is never HTML-escaped. Verified on a real device: `@someone` and `@all` both render as clickable blue mentions.
- **`chat` skill docs & scripts aligned to direct-chat `list-direct`** (#424) — `chat message list` now supports group chats only (`--user` / `--open-dingtalk-id` removed); reading a direct chat moves to the dedicated `list-direct` command, but the skill docs and scripts still taught `chat message list --user`, which now errors with `unknown flag: --user`, also breaking `chat_history_with_user.py` (listed as the "preferred" way to query direct chats). This update: `skills/{mono,multi/dingtalk-chat}/references/products/chat.md` switches `message list` to group-only and documents the new `list-direct` command, syncing the intent routing / key-distinction / context-passing tables / caveats; `skills/mono/references/best_practices/01-messaging.md` changes query-private-chat from `list --user` to `list-direct` (the multi version was already updated); `chat_history_with_user.py` (mono + multi) now calls `list-direct` and fixes response parsing (unwraps `result.messages`, aligns `createTime/content/sender` fields — it previously crashed on `'str' object has no attribute 'get'`). Direct-chat sending still uses `chat message send --user` (since v1.0.34 the direct-send rpc is folded into the `send` command; there is no separate `send-direct`). Docs/scripts only; no change to CLI binary behavior.
- **`pat chmod` batch authorization did not pass through `agentCode`** (#414, `internal/pat/chmod.go`) — the batch plan / grant paths (`buildBatchPlanArgs` / `batchArgs`) previously carried `agentCode` only in the single-grant `toolArgs`; batch calls omitted it, so a batch authorization with an explicit `agentCode` was processed under the default agent. Fix: the batch plan / grant args now also carry `agentCode`, matching the single-grant path.
- **`pat` JSON output escaped the authorization URL into an unreadable form** (#401, `internal/pat`) — the authorization URL attached to PAT error messages, after default HTML escaping, turned `&` into `&`, breaking the link when copied / recognized on mobile. Fix: the PAT error-enrichment JSON output now uses `SetEscapeHTML(false)` (scoped to PAT JSON only), preserving the readable `&` separators.
## [1.0.34] - 2026-06-03
### Changed
- **Service discovery path now carries a version-coded segment** (`internal/market/registry.go`) — the server-list endpoint moves from `/cli/discovery/apis` to `/cli/discovery/apis/bamboo`. The path is now a single `discoveryAPIPath` constant so future version bumps touch one place. Only the path changes; the MCP base host stays on production `https://mcp.dingtalk.com` and the auth / skill / doctor endpoints are untouched. Discovery via the edition `DiscoveryURL` hook (full-URL `FetchServersFromURL`) is unaffected. Server side must serve the new path.
### Removed
- **`dws aiapp` — AI application product taken offline** — removed the `aiapp` product surface (`create` / `query` / `modify`) from the CLI: deleted `internal/helpers/aiapp.go`, dropped it from the generator coverage targets and `knownRegistryProducts`, removed the `aiapp` skill references (mono `references/products/aiapp.md` + `dingtalk-aiapp` multi skill), and unpublished the `aiapp` server from the service-discovery envelope. Product count drops from 19 to 18.
## [1.0.33] - 2026-06-02
This release merges the multi-contributor `pre-mcp-discovery` feature branch into `main` as a single squash (#391), bringing a large batch of new product surface — full DingTalk **docs** (`doc`), **knowledge base** (`wiki`), **AI app** (`aiapp`), AI-table **forms** + **import/export**, and reworked **mail** / **todo** / **report** command trees — while keeping service discovery pinned to production `https://mcp.dingtalk.com` (the branch's `pre-mcp.dingtalk.com` endpoint change was deliberately excluded; the four host constants in `skill_command.go` / `auth/endpoints.go` / `cli/loader.go` / `market/registry.go` stay on prod). It also folds in the portable auth bundle (`dws auth export` / `import`, #357) and PAT batch authorization (#389).
### Added
- **`dws doc` — full DingTalk document command family** (#387, #362, #388, #390; `internal/helpers/doc.go`, `internal/helpers/doc_jsonml.go`, `internal/helpers/docjsonml/`) — search / list / info / read / create / update / upload / download / copy / move / rename, plus `file`, `folder`, `block`-level editing and `comment` (list / create / reply / create-inline). Authoring supports both DocxXML and a JSONML format with a v2 schema validator (`docjsonml/jsonml-schema-v2.json` + `doc_jsonml_validate_v2.go`). Document export and OA alignment land here.
- **`dws wiki` — knowledge base management** (`internal/helpers/wiki.go`, `internal/helpers/wiki_proxy.go`) — knowledge space `create` / `get` / `list` / `search` and member `add` / `list` / `update`, routed through a wiki proxy server.
- **`dws aiapp` — AI application lifecycle** (`internal/helpers/aiapp.go`) — `create` (with prompt / attachments / skills), `query` by task ID, `modify` by thread ID.
- **`dws aitable` forms + import/export** (`internal/helpers/aitable_form.go`, `internal/helpers/aitable_export_import.go`) — datasheet form management and full record import/export, the latter driven through the async-task helper for large datasets.
- **Reworked `chat` / `report` / `todo` / `contact` / `mail` command trees aligned to the Wukong baseline** (#355; `internal/compat/mail_hooks.go`, `internal/compat/todo_hooks.go`, `internal/helpers/report_readable.go`) — mail and todo gain dedicated compat hooks; `report` gains a human-readable rendering path alongside the raw JSON, plus deprecation shims for the old report shape.
- **`dws auth export` / `dws auth import`** (#357) — portable auth bundle for migrating Linux sandbox credentials. Exports the encrypted keychain (`~/.local/share/dws-cli`, including `auth-token.enc` and `dek`) plus required `~/.dws` config so refresh tokens survive import; copying only `app.json` leaves access tokens expiring after ~2 hours. Supports `-o` / `-i` tar.gz paths and `--base64` for copy/paste between sandboxes. `dws auth status` now shows refresh-token validity in table output.
- **Async-task and paging infrastructure** (`pkg/asynctask/`, `pkg/paging/`) — shared helpers underpinning long-running operations (e.g. aitable import/export, doc export) and cursor/page traversal.
### Changed
- **`envelope` now registers `cli.Aliases` as cobra aliases** (#391) — discovery-generated commands expose their declared aliases natively in the command tree, with accompanying command-structure and JSON-parsing cleanups.
- **Breaking: `dws pat chmod` prints a compact authorization summary by default, and gains batch authorization flows** (#389; `internal/pat/chmod.go`) — scripts that parse the raw MCP JSON from stdout must now pass `--format json` or `--verbose` to keep the machine-readable payload; the default summary keeps grant status, agentCode, grantType, scope counts, and a next-action hint. New batch grant/plan flows (`pat.batch_grant` / `pat.batch_plan`) authorize multiple products in one session, fall back to the legacy single-grant path when the server reports `PAT_BATCH_AUTH_UNSUPPORTED`, use the server's default `agentCode` when none is given, and surface per-tool authorization metadata for grant planning.
- **Skill packs synced to the Wukong-aligned content** across attendance / calendar / minutes / oa / sheet and others (#391).
## [1.0.32] - 2026-05-25
Two user-visible regressions resolved plus two AI-agent discoverability fixes. `dws drive upload` was returning `HTTP 403 SignatureDoesNotMatch` for any file whose MIME detects to a non-empty value — basically every real file — because the helper added a client-side `Content-Type` fallback whenever `drive.get_upload_info` returned an empty headers map. DingTalk drive's OSS presigned PUT URLs are signed against an empty `Content-Type` at signing time, so any client-supplied header makes the signature OSS recomputes diverge from the server-signed one, and the PUT is rejected (#347). On Apple Silicon, `dws upgrade` was aborting at the "解压并验证" step with `signal: killed` because GoReleaser cross-compiles `darwin/arm64` binaries on `ubuntu-latest` with no codesign step, and macOS 11+ `amfid` SIGKILLs unsigned arm64 binaries on first exec (#339) — the release pipeline now ad-hoc signs every darwin tarball, and the upgrade client self-heals if it ever encounters an unsigned binary again. On the AI-agent discoverability side, `dws aitable attachment upload-file` (the one-shot prepare + PUT + commit composite) is no longer hidden from `--help` — agents that only browse the command tree were getting stuck at the prepare-only `attachment upload` step, which returns an upload URL + fileToken but doesn't actually upload. And `dws --help` itself now surfaces the missing-command upgrade hint that the custom `renderRootHelp` had been silently dropping from cobra's `root.Long`.
### Added
- **`dws aitable attachment upload-file` is now visible in `dws aitable attachment --help`** (#347, `internal/helpers/aitable.go`) — the hardcoded one-shot composite (prepare + HTTP PUT + commit, returns `fileToken` directly) was previously marked `Hidden:true` and only reachable by agents that read `skills/references/products/aitable.md`. Agents that only discover commands via `--help` were getting stuck at the sibling envelope-generated `attachment upload` (prepare-only): they'd receive `uploadUrl` + `fileToken`, have no idea how to consume the URL, and either write the URL into the attachment field as if it were a token (wrong shape — the field expects `[{"fileToken":"ft_xxx"}]`) or fall back to "please use the UI" messages, which made `dws` look broken even though the capability was fully implemented. Unhiding mirrors the discoverability pattern `lark-cli base +record-upload-attachment` already follows. `Short` is tightened to explicitly mention the 3 steps it bundles; `Long` calls out the prepare-only sibling and recommends `upload-file` as the default for AI agents. The sibling `attachment upload` (prepare-only) keeps its envelope-generated registration but gets a new `Long` that states it is only step 1 of a 3-step flow, lists what an agent must do after (HTTP PUT to `uploadUrl`, then write `[{"fileToken":"ft_xxx"}]` into the attachment field), and points to `upload-file` as the recommended one-shot alternative. `TestAITableUploadFileCommandIsDiscoverable` in `internal/helpers/aitable_upload_file_test.go` guards against re-introducing `Hidden:true`.
- **`dws --help` root output now surfaces the `dws upgrade` hint when no listed command fits** (#347, `internal/app/root.go` + `internal/app/root_help.go`) — `root.Long` is set to `"提示: 如果遇到能力缺失、命令报错、新功能未注册、或无法完成任务, 请先用 'dws upgrade' 升级到最新版本后再试. 钉钉 OpenAPI 和 dws CLI 持续迭代, 新能力和 bugfix 会先在新版本上线."`. The custom `renderRootHelp` (which replaces cobra's default template to render the services / utilities sections) had been silently dropping `root.Long`; restoring it costs one `Fprintln` after the command list, separated by a blank line. The natural failure mode for both agents and users staring at `dws --help` is to give up or hack around when none of the listed commands fit — but in many cases the right action is simply `dws upgrade`, because new capabilities and bugfixes ship continuously and a missing command is usually a stale-binary issue. `TestRenderRootHelpIncludesLong` in `internal/app/visibility_test.go` uses a sentinel `Long` string and asserts the rendered output contains it verbatim, so any future rewrite of the help renderer that drops `Long` fails this test immediately.
### Fixed
- **`dws drive upload` no longer fails with `HTTP 403 SignatureDoesNotMatch` on any non-empty MIME type** (#347, `internal/helpers/drive.go`) — `httpPutDriveFile` was setting `req.Header["Content-Type"] = fallbackMIME` whenever the prepare_upload response returned an empty headers map. DingTalk drive's OSS presigned URLs sign `StringToSign` against an empty `Content-Type` at signing time, so any client-side header makes the signature OSS recomputes at PUT time differ from the server's presignature, and the upload is rejected with `403 SignatureDoesNotMatch`. This broke every `dws drive upload` for any file whose MIME detects to a non-empty value (`image/png`, `application/pdf`, every common binary) — i.e. essentially every real upload. Fix: drop the `hasContentType` / `fallbackMIME` path entirely, trust the server's headers map as authoritative; empty map means "no client-side headers needed", do not infer. `httpPutDriveFile`'s signature loses the `fallbackMIME` parameter. Manual verification: `curl -X PUT -H "Content-Type:" --data-binary @file <same-presigned-url>` returns `HTTP 200`, proving the only difference was the client-side `Content-Type`. `TestHttpPutDriveFile_NoContentTypeWhenServerHeadersEmpty` guards the empty-map path; `TestHttpPutDriveFile_PassthroughServerHeaders` guards that server-provided `Content-Type` / `x-oss-*` headers are forwarded verbatim. Important: `internal/helpers/aitable.go`'s `upload-file` helper deliberately keeps its `Set("Content-Type", mimeType)` call — its OSS endpoint uses a different signing mode (server includes the client-declared MIME in the signature, verified across 12 file types — all succeed). The two helpers must not be unified without re-validating both endpoints.
- **`dws upgrade` no longer dies with `signal: killed` on Apple Silicon after fetching the new binary** (#339) — GoReleaser cross-compiles `darwin/arm64` binaries on `ubuntu-latest` with no codesign step, and macOS 11+ on Apple Silicon requires at least an ad-hoc signature on every arm64 binary; `amfid` SIGKILLs unsigned arm64 binaries on first exec, which the upgrade client surfaces as `signal: killed` and aborts at the "解压并验证" step. Two layers of fix:
- **Release-side ad-hoc signing** (`scripts/release/post-goreleaser.sh` + `.github/workflows/release.yml`) — after GoReleaser produces the per-platform tarballs, `post-goreleaser.sh` unpacks each `dws-darwin-*.tar.gz`, applies an ad-hoc signature (`codesign --force --sign -` locally, `rcodesign` in CI), deterministically repacks the tarball, and rewrites the matching line in `checksums.txt` so the checksum stays consistent with the resigned tarball. `release.yml` installs `rcodesign 0.27.0` before GoReleaser runs. Every 1.0.32+ tarball ships signed; the install regression is fixed at the source.
- **Client-side self-heal in `validateNewBinary`** (`internal/app/upgrade.go`) — when running the freshly-extracted binary returns `signal: killed` on darwin, the validator retries once after running `codesign --force --sign -` on the binary and clearing the `com.apple.quarantine` xattr. This keeps `dws upgrade` working even if a future release ever skips the signing step again, and covers users upgrading from older unsigned binaries. `internal/app/upgrade_test.go` (+80 lines) covers the retry path end-to-end: a stripped binary exits 137 on first exec, `validateNewBinary` recovers via ad-hoc sign + xattr clear, the final binary shows `Signature=adhoc` and runs.
## [1.0.31] - 2026-05-21
Closes the last drive-surface gap with the Wukong edition: `dws drive upload` lands as a single-shot composite (`drive.get_upload_info` → HTTP PUT to OSS → `drive.commit_upload`) so a local file reaches DingTalk drive in one CLI invocation, no manual three-step orchestration. Two more drive commands — `dws drive list-spaces` (list visible drive spaces) and `dws drive delete` (delete a drive file, routed via `serverOverride` to the doc MCP server) — ship via the portal envelope; `dws cache refresh` once to pick them up. Companion skill docs teach the agent to recognise dingpan URLs of the form `alidocs.dingtalk.com/document/edit?dentryKey=…` / `…/document/preview?dentryKey=…` and pass the whole URL through to `--node` instead of trying to extract `dentryKey` by hand (the server interprets `dentryKey` and a bare `nodeId` differently — manual extraction was failing).
### Added
- **`dws drive upload --file <path> [--folder <dentryUuid>] [--space-id <id>] [--file-name <name>] [--mime-type <type>]`** (#335, see `internal/helpers/drive.go`) — composite leaf that runs the full three-step upload internally:
1. `drive.get_upload_info` — fetch the OSS-signed `resourceUrl` + `uploadId` + per-URL headers.
2. HTTP `PUT` the file binary to OSS (10-minute timeout, attaches every header returned by step 1).
3. `drive.commit_upload` — register the new file under the target space / folder.
`--dry-run` prints the three step invocations as a single JSON payload without making any network calls. `--file -` is rejected on purpose: this is a local-path upload, not stdin streaming. `--folder` only accepts a `dentryUuid`; pure-numeric values are rejected up front (`validateDriveParentID`) so callers don't accidentally pass a chat-link `dentryId` (a different ID namespace) where the drive API expects a `dentryUuid`. Response normalisation handles all the wrapper shapes the upstream returns — `content` / `result` envelopes, `resourceUrls[]` arrays, and the flat `resourceUrl` / `uploadUrl` fallbacks — so the composite produces a stable JSON shape regardless of which path the upstream takes. The helper only registers `upload`; the existing six envelope-generated leaves (`list` / `info` / `download` / `mkdir` / `upload-info` / `commit`) keep flowing through dynamic discovery unchanged. `pickCommands.MergeHardcodedLeaves` guarantees dynamic leaves win on collision, so this helper only fills the upload gap.
- **`dws drive list-spaces` and `dws drive delete` (envelope rollout)** (#335, ships via portal envelope) — `list_spaces` registers as a plain `cliName` alias on the existing drive MCP server; `delete_document` registers with `serverOverride: doc` so the call routes to the doc MCP server (which owns the delete API), surfacing under the drive command tree for ergonomics. **Existing users must run `dws cache refresh` once** to pick up these two new leaves; no binary upgrade is required for them, but they pair naturally with the v1.0.31 client that ships `upload`.
- **`skills/references/url-patterns.md`** (#335) — single authority for dispatching `alidocs.dingtalk.com` URLs across doc / sheet / wiki. Five-way split: `/i/p/<token>` short links → expand via `doc info`; `/i/nodes/<id>` node URLs → probe with `doc info` and route by `contentType` / `extension` / `nodeType`; `/spreadsheetv2/...` → `sheet`; `/document/edit|preview?dentryKey=<key>` (dingpan format) → pass the whole URL to `--node`, do not strip `dentryKey` by hand; `/i/share/...` (read-only share) → use the `read_url` fallback. The "URL precheck" Step 0 in `skills/SKILL.md` now redirects every URL-bearing prompt through this dispatcher before the agent picks a product.
### Changed
- **`skills/references/products/doc.md` — `--node` accepts dingpan URLs end-to-end** (#335) — `dws doc info` / `dws doc read` examples gain two extra rows showing `--node "https://alidocs.dingtalk.com/document/edit?dentryKey=<KEY>"` and `…/preview?dentryKey=<KEY>` as first-class `--node` inputs. The "URL recognition & DOC_ID extraction" table adds the `document/edit|preview?dentryKey=<key>` row, and the extraction rules are split into three explicit clauses so the agent stops manually pulling `dentryKey` out of the URL and feeding it as a bare `nodeId` (which the server rejects). The "nodeId dual-format note" upgrades to "nodeId multi-format note" with four equivalent `--node` input shapes side by side.
## [1.0.30] - 2026-05-19
Aligns the open-source CLI with the IM envelope and schema-pipeline plumbing the Wukong edition has been running in pre-prod, plus three user-visible quality-of-life fixes. The most visible one: chat-bot webhook payloads carrying literal Chinese mentions (`@所有人 周报来了` / `@张三 看一下`) no longer fail with `file not found` — `@` is only treated as the `@<filename>` file-injection prefix when followed by an ASCII path-shaped character. The `chat` command tree is refactored to lean on the service-discovery envelope: thin wrappers (`chat search`, `chat group rename`, `chat group members list/add/remove/add-bot`, `chat bot search`) move out of the hardcoded helper and become envelope-generated dynamic commands; the helper keeps only the chat commands with real business logic (intelligent routing, current-user resolution, response normalization, stdin/@file input). A new `dws chat message reply` joins the existing `send` / `send-by-bot` / `recall-by-bot` / `send-by-webhook` family. Underneath: `transform: invert_bool` lets envelopes flip boolean semantics between CLI surface and MCP body (e.g. `--off` ↔ `mute=true`); the pipeline executor fail-fast on upstream `content.errorCode` instead of polling forever; service-discovery dedup keeps two envelope entries that share an MCP endpoint but declare different `cli.id` as separate descriptors (so the `bot-root` / `bot-message` / `bot-group` trio fronting one MCP server stays as three distinct CLI command roots); and `dws chat` no longer nests as `dws chat chat` when two envelope servers both declare the same top-level command name.
### Added
- **`transform: invert_bool` for envelope flag overrides** (#317, see `internal/compat/transform.go`) — flips a boolean at send time. Strings `true`/`1`/`yes`/`on` → `false`; `false`/`0`/`no`/`off`/`""` → `true`. Used when the CLI surface and the MCP body have opposite semantics — e.g. envelope declares `--off` on the CLI but the MCP parameter is `mute=true` for "muted". The framework flips at send time so the envelope keeps the natural CLI verb without forcing every caller to remember the inverted mapping. Coverage in `internal/compat/transform_test.go`.
- **`dws chat message reply`** (#317, see `internal/helpers/chat.go`) — reply to a chat message. Sits alongside `send` / `send-by-bot` / `recall-by-bot` / `send-by-webhook` under `dws chat message`.
### Changed
- **`chat` command tree refactored to lean on the service-discovery envelope** (#317, commit `6be1247`) — `internal/helpers/chat.go` now only carries the chat commands that need real business logic on top of the raw MCP call: `chat message send` (current-user resolution + symmetric direct/group title validation), `chat message send-by-bot` / `recall-by-bot` / `send-by-webhook` (bot routing + stdin/@file input), and `chat group create` (response normalization). The thin wrappers — `chat search`, `chat group rename`, `chat group members list/add/remove/add-bot`, `chat bot search` — are now produced by the envelope as dynamic commands. Net diff in the helper: `+358 / -71` overall (re-aligning to envelope-owned chat structure), and `chat_test.go` drops 71 lines of test-stubs the dynamic path covers natively. Every previously documented chat command keeps the same flag set and the same MCP tool routing — the surface is just sourced differently.
- **Pipeline executor fail-fast on `content.errorCode`** (#317, see `internal/compat/pipeline.go`) — when an upstream tool returns a non-empty `content.errorCode`, `executePipelineCall` raises a validation error immediately with the upstream `errorMessage` instead of proceeding into the poll/download phase. Pre-execution cobra validation (`MarkFlagRequired`) only checks that a flag was set, not that its value was non-empty — so a `--required-flag ""` reaches the upstream tool and the upstream rejects with `errorCode`. Without the short-circuit the pipeline kept polling for a task ID that would never exist, either spinning to `PollTimeout` or burning through retries with no actionable error. Exit code 2 (validation), same as any other CLI-layer pre-flight rejection.
- **Service-discovery dedup keys now include `cli.id`** (#317, see `internal/market/registry.go`) — `NormalizeServers` used to dedup envelope entries by endpoint alone (and by `displayName` in the second pass), which collapsed envelope entries that intentionally split one MCP endpoint into multiple CLI command trees. The `bot-root` / `bot-message` / `bot-group` trio all front the same `.../server/4717...` MCP endpoint and share the displayName `机器人消息`, but each declares a distinct `cli.id` and a distinct CLI command root; the old dedup kept only the last-write and dropped two of them. The dedup key now appends `#<cli.id>` when present, falling back to endpoint / name when absent so historical envelopes without `cli.id` keep their existing behaviour. Coverage in `internal/market/registry_test.go`.
### Fixed
- **`@<text>` injection no longer eats Chinese mentions like `@所有人` / `@张三`** (#317, see `internal/cli/stdin.go`) — `ReadFileArg` and `ResolveInputSource` used to treat *any* value starting with `@` as the `@<filename>` injection syntax. Chat-bot webhook payloads commonly contain literal mentions, so `dws chat message send-by-bot --text "@所有人 周报"` was failing with `file not found: 所有人 周报` before the message reached the API. The new `looksLikeFilePath` heuristic accepts `@` followed by an ASCII path-prefix character (`A-Z` / `a-z` / `0-9` / `.` / `/` / `~` / `_` / `-`), or `@-` for stdin, and passes the value through unchanged otherwise. `@A 但接下来都是中文@测试` *does* still attempt a file lookup because the rune right after `@` is ASCII — this matches the documented `@<path>` prefix shape. The historical "bare `@` is an error" behaviour is preserved. Coverage in `internal/cli/stdin_test.go::TestReadFileArgChineseAtMention`.
- **`dws chat` no longer nests as `dws chat chat` when two envelope servers contribute the same top-level command** (#317, see `internal/compat/dynamic_commands.go`) — `BuildDynamicCommands` used to overwrite `topLevel[name]` on the second contribution and rely on `attachOrMerge` later, which then attached the *whole* incoming command (named `chat`) under the existing root, producing `dws chat chat <leaf>`. The new `mergeSubcommandsInto` moves the second contribution's *children* under the first root and drops the duplicate wrapper, so e.g. `group-chat` + `im` envelopes that both declare `cli.command: chat` produce a single flat `dws chat` subtree.
- **Multi-server tool-name authority correction in the runtime runner** (#317, see `internal/app/runner.go` + `internal/app/direct_runtime.go`) — when two envelope servers share the same `cli.command`, the per-product endpoint map `endpoints[cmd]` in `registerDynamicServer` is second-writer-wins, and `catalog.FindProduct` may return the wrong server's endpoint for a tool whose real owner is the *other* server. `runtimeRunner.Run` now cross-checks the canonical tool→endpoint map exposed by the new `directRuntimeToolEndpoint`: when the per-tool endpoint exists and differs from the per-product endpoint the catalog returned, the tool-owner endpoint wins. Pairs with the registry dedup change above so the routing matches the dedup result.
## [1.0.29] - 2026-05-17
Three discovery-envelope products land on the open-source surface — `aiapp` (AI applications), `live` (DingTalk live streaming), and `aisearch` (enterprise people search) — closing the gap with the Wukong edition's product list. The `aisearch` envelope ships rich model-tolerance affordances (short flags, flag aliases, subcommand aliases) so AI agents that hallucinate keyword synonyms (`--query` / `--name` / `--q` / `--text` / `--find`) or alias subcommands (`search` / `find` / `query` / `user` / `people` / ...) still route to the canonical `person` tool instead of erroring out. To support that final fragment of agent tolerance, `internal/compat/registry.go` relaxes the envelope-generated leaf command's `Args` validator from `cobra.NoArgs` to `cobra.ArbitraryArgs` — restoring cobra's own default (`legacyArgs` returns nil for leaves) so trailing positional words are silently ignored. Plus the previously-shipped credential-isolation fix.
### Added
- **`dws aiapp` / `dws live` / `dws aisearch` — three new products discovered via envelope** (no public issue; pre-Diamond rollout) — open-source `dws` now exposes:
- **`dws aiapp`** — AI application lifecycle: `create --prompt <p> [--attachments <json>] [--skills <csv>]` / `query --task-id <id>` / `modify --prompt <p> --thread-id <id> [--skills <csv>]`. Backed by upstream `create_ai_app` / `query_ai_app` / `modify_ai_app` MCP tools.
- **`dws live stream list`** — list my DingTalk live streams. Backed by upstream `get_my_lives`.
- **`dws aisearch person`** — enterprise people search by keyword + multi-dimension filter. Dimensions: `all` (default) / `name` / `department` / `position` / `duty` / `supervisor` / `subordinate` / `phone` / `jobNumber` — multiple comma-separated (`--dimension name,department`). Backed by upstream `enterprise_person_search`.
- The `aisearch` envelope additionally registers `-w` / `-d` short flags (keyword / dimension); hidden flag aliases `--query` / `--name` / `--q` / `--text` / `--find` all routing to `keyword`; and cobra subcommand aliases `search` / `find` / `query` / `user` / `people` / `search-person` / `search-user` / `user-search` / `lookup` / `ask` / `contact` all routing to `person`. This closes the F-class model-tolerance regression cases in `dws-wukong/auto-test/cli_to_mcp/testcases/aisearch/test_90_aisearch_param_regression.py` (50/50 pass for aiapp + live + aisearch on the pre-mcp build).
- **Users must run `dws cache refresh` once** to pick up the new envelopes; no binary upgrade is required, but pairs naturally with the v1.0.29 client (see Fixed below for the envelope-leaf-Args change).
### Fixed
- **Envelope-generated leaf commands now tolerate trailing positional args** (#306, no public issue) — `NewDirectCommand` in `internal/compat/registry.go` was hard-coding `cobra.NoArgs` for leaves without positional bindings (`totalMax == 0`). This is stricter than cobra's own `legacyArgs` (cobra `args.go:30-32` returns `nil` for any command without subcommands), and surfaced as `unknown command "<word>" for "<leaf>"` whenever an AI agent passed trailing positional words after a leaf — e.g. `dws aisearch person search --keyword "张"` or `dws aisearch person user search --keyword "张"`. Switching the `totalMax == 0` branch (and the initial value) from `cobra.NoArgs` to `cobra.ArbitraryArgs` restores cobra's natural leaf behavior: trailing positional args are silently ignored. Existing positional-binding paths (`MinimumNArgs` / `RangeArgs` / `MaximumNArgs`) are unchanged. Verified against `dws-wukong/auto-test/cli_to_mcp/testcases` — aiapp (9/9) + live (3/3) + aisearch (38/38) = **50/50** pass, vs 48/50 before this patch.
### Security
- **App credential files are partitioned by edition to prevent cross-edition credential leakage** (#300, no public issue; found during internal review) — different `dws` editions sharing the same config directory previously read and wrote the same `app.json`. A sibling edition that pinned its OAuth client ID could persist that ID through the shared post-login path, and the open-source build could later adopt it from the same file. Open-source/empty edition keeps the legacy `app.json` path for compatibility; sibling editions now use `app-<edition>.json`, matching the existing cache partitioning strategy. This prevents new cross-edition app credential writes and reads from colliding. After a sibling edition saves its new partitioned file, it also best-effort removes a legacy `~/.dws/app.json` only when that file's `clientId` matches the sibling edition being saved; a different, unparsable, or otherwise unowned `app.json` is left untouched to avoid deleting open-source credentials. If you previously ran multiple editions in one shared `~/.dws`, remove any confirmed-stale orphan manually with `rm ~/.dws/app.json` after verifying it is not the open-source credential file you still need.
## [1.0.28] - 2026-05-14
A single symmetric follow-up to 1.0.26's #250: `dws chat message send --group <cid>` now refuses an empty `--title` at the CLI layer instead of letting the call fall through to the API and surface a misleading `发群服务窗会话消息失败` error. No other behaviour changes.
### Fixed
- **`dws chat message send` rejects missing `--title` on group messages** (#294, completes #250) — `send_message_as_user`'s schema marks `title` as required (just like `send_direct_message_as_user`), but `buildChatMessageSendInvocation` only had the pre-validation on the direct-message branches. Group sends without a title were falling through to the API and returning the same misleading `发群服务窗会话消息失败` that #250 already fixed for direct messages. The check now covers both branches: missing `--title` on `--group` returns `--title is required for group messages (--group)` with exit code 2; missing on `--user` / `--open-dingtalk-id` keeps the original `--title is required for direct messages (--user / --open-dingtalk-id)`. The `Long` help, `--title` flag description, the first `Example`, and `skills/references/products/chat.md` (including the drive→chat workflow example) are realigned to "title is required for both direct and group messages" — the docs previously contradicted themselves (the prose said 群聊可选 while the flag listing said 必填). `internal/helpers/chat_test.go` adds a `group-without-title` rejection case; the existing `group` / `positional-text` success cases now pass `--title` to stay aligned with the new validation. No API request shape change — the server has always required `title`; the CLI now matches.
## [1.0.27] - 2026-05-14
Two user-visible fixes plus the schema primitive they're built on. `dws doc update` now reads Markdown from a file or stdin, so long / multi-line / table-heavy content no longer gets mangled by shell escaping; `dws sheet find --query` stops returning `unknown flag` on the open-source build, restoring copy-paste from internal wukong docs. Underneath, schema/discovery envelopes get a generic `file_read` transform and a `CLIFlagOverride.MapsTo` field that lets two sibling CLI flags route into the same MCP parameter slot. Also suppresses a noisy WARN on normal stdio-plugin shutdown.
+105 -25
View File
@@ -21,7 +21,7 @@
> [!IMPORTANT]
> **Co-creation Phase**: This project accesses DingTalk enterprise data and requires enterprise admin authorization. Join the DingTalk DWS co-creation group for support and updates. See [Getting Started](#getting-started) below.
>
> <a href="https://qr.dingtalk.com/action/joingroup?code=v1,k1,v9/YMJG9qXhvFk5juktYnQziN70rF7QHebC/JLztTVRuRVJIwrSsXmL8oFqU5ajJ&_dt_no_comment=1&origin=11"><img src="https://img.alicdn.com/imgextra/i4/O1CN01Rijgk81gKqVSKMzdx_!!6000000004124-2-tps-654-644.png" alt="DingTalk Group QR Code" width="150"></a>
> <img src="https://img.alicdn.com/imgextra/i1/O1CN01WJyAsJ1prD2ovQACM_!!6000000005413-2-tps-718-720.png" alt="dws Open Source Community DingTalk Group QR Code" width="150">
<details>
<summary><strong>Table of Contents</strong></summary>
@@ -63,6 +63,27 @@ curl -fsSL https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace
irm https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install.ps1 | iex
```
<details>
<summary><strong>Skill mode: mono vs multi</strong></summary>
The installer ships skills in one of two layouts. CLI commands (`dws aitable ...`, `dws calendar ...`) are identical in both modes — only the agent-side skill layout differs.
| Mode | What gets installed | Best for |
|------|----------------------|----------|
| **mono** (stable, default) | One `dws` skill covering all products | Cross-product workflows; single entry point |
| **multi** 🧪 **EXPERIMENTAL** | 18 per-product skills (`dingtalk-aitable`, `dingtalk-calendar`, `dingtalk-chat`, ...) | Single-product tasks; smaller context per call |
> 🧪 **`multi` is currently EXPERIMENTAL / preview.** 18 product-scoped skills all pass the dispatch verifier, but interface, naming and cross-skill references may change in future releases. For production / shared environments, prefer `mono`. File issues if you hit problems.
How to pick:
- **Quick install** (one-liner above): non-interactive, installs `mono`.
- **TTY install** (download then run): `curl -O .../install.sh && bash install.sh` — prompts `1) mono 2) multi` (default 1).
- **Override via env**: `DWS_SKILL_MODE=multi curl -fsSL ... | sh`.
- **Switch later**: `dws skill setup --mode multi` (or `--mode mono`) — re-run any time.
</details>
<details>
<summary>Other install methods</summary>
@@ -182,6 +203,26 @@ Credentials are securely persisted after first login (Keychain). Subsequent runs
</details>
<details>
<summary><strong>Migrate auth between Linux sandboxes</strong></summary>
Copying only `~/.dws/app.json` does not carry the refresh token; access tokens expire after ~2 hours. Use the official export/import flow:
```bash
# Sandbox A (already logged in)
dws auth export -o /tmp/dws-auth.tar.gz
# Or for copy/paste: dws auth export --base64 -o /tmp/dws-auth.b64
# Sandbox B
dws auth import -i /tmp/dws-auth.tar.gz
# Or: dws auth import -i /tmp/dws-auth.b64 --base64
dws auth status # confirm "Refresh Token: valid"
```
The bundle includes the encrypted keychain under `~/.local/share/dws-cli` (with `auth-token.enc` and `dek`) plus required `~/.dws` config files.
</details>
## Quick Start
```bash
@@ -224,32 +265,65 @@ dws schema --jq '.products[] | {id, tool_count: (.tools | length)}'
# Step 2: Inspect target tool's parameter schema
dws schema aitable.query_records --jq '.tool.parameters'
# Optional: inspect DingTalk authorization metadata for PAT planning
dws schema aitable.query_records --jq '.tool.auth'
# Step 3: Construct the correct call
dws aitable record query --base-id BASE_ID --table-id TABLE_ID --limit 10
```
### Agent Skills
The repo ships a complete Agent Skill system (`skills/`). After installing, AI tools like Claude Code / Cursor can operate DingTalk directly through natural language:
The repo ships a complete Agent Skill system under `skills/`, now organized into two layouts:
- `skills/mono/` — single-skill layout (one `SKILL.md` + `references/products/`), recommended default.
- `skills/multi/` — per-product skills (`dingtalk-aitable/`, `dingtalk-calendar/`, `dingtalk-chat/`, ... 18 products in total), each with its own `SKILL.md`. 🧪 **EXPERIMENTAL / preview — see banner in each multi `SKILL.md` for caveats.**
After installing, AI tools like Claude Code / Cursor can operate DingTalk directly through natural language:
```bash
# Install skills into current project
# Install skills into current project (defaults to mono)
curl -fsSL https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install-skills.sh | sh
```
> `install.sh` installs to `$HOME/.agents/skills/dws` (global); `install-skills.sh` installs to `./.agents/skills/dws` (current project).
**What's included:**
**Switching or re-installing with `dws skill setup`:**
```bash
# Interactive: prompts for mode + target agents
dws skill setup
# Install mono skill to every detected agent home (claude / cursor / codex / opencode / qoder)
dws skill setup --mode mono --target all --yes
# Install multi skills to a single agent home
dws skill setup --mode multi --target cursor --yes
# Point at a local source tree (e.g. a fork or work-in-progress)
DWS_SKILL_SOURCE=/path/to/skills dws skill setup --mode multi
```
| Flag | Values | Description |
|------|--------|-------------|
| `--mode` | `mono` \| `multi` | Skill layout; defaults to interactive prompt |
| `--target` | `all` \| `claude` \| `cursor` \| `codex` \| `opencode` \| `qoder` | Where to install; `all` covers every detected agent home |
| `--source` | path | Local source directory (overrides bundled skills) |
| `--yes` | — | Skip confirmation prompts |
Env vars: `DWS_SKILL_MODE=mono|multi` (also honored by `install.sh` / `install.ps1`), `DWS_SKILL_SOURCE=<path>`.
**What's included (mono layout):**
| Component | Path | Description |
|-----------|------|-------------|
| Master Skill | `SKILL.md` | Intent routing, decision tree, safety rules, error handling |
| Product references | `references/products/*.md` | Per-product command reference (aitable, chat, calendar, etc.) |
| Intent guide | `references/intent-guide.md` | Disambiguation for confusing scenarios (e.g. report vs todo) |
| Global reference | `references/global-reference.md` | Auth, output formats, global flags |
| Error codes | `references/error-codes.md` | Error codes + debugging workflows |
| Recovery guide | `references/recovery-guide.md` | `RECOVERY_EVENT_ID` handling |
| Ready-made scripts | `scripts/*.py` | 13 batch operation scripts (see below) |
| Master Skill | `skills/mono/SKILL.md` | Intent routing, decision tree, safety rules, error handling |
| Product references | `skills/mono/references/products/*.md` | Per-product command reference (aitable, chat, calendar, etc.) |
| Intent guide | `skills/mono/references/intent-guide.md` | Disambiguation for confusing scenarios (e.g. report vs todo) |
| Global reference | `skills/mono/references/global-reference.md` | Auth, output formats, global flags |
| Error codes | `skills/mono/references/error-codes.md` | Error codes + debugging workflows |
| Recovery guide | `skills/mono/references/recovery-guide.md` | `RECOVERY_EVENT_ID` handling |
| Ready-made scripts | `skills/mono/scripts/*.py` | 13 batch operation scripts (see below) |
<details>
<summary><strong>Ready-made scripts</strong> — 13 Python scripts for common multi-step workflows</summary>
@@ -372,6 +446,7 @@ dws aitable record query --base-id BASE_ID --table-id TABLE_ID --fields invocati
dws schema # list all products and tools
dws schema aitable.query_records # view parameter schema
dws schema aitable.query_records --jq '.tool.required' # view required fields
dws schema aitable.query_records --jq '.tool.auth' # view authorization metadata
dws schema --jq '.products[].id' # extract all product IDs
```
@@ -394,38 +469,43 @@ dws chat message send-by-bot --robot-code BOT_CODE --group GROUP_ID \
--title "Weekly Report" --text @-
```
> **Note**: `@` is treated as the `@<path>` file-injection prefix only when the next character is an ASCII path-shaped character (`A-Z` / `a-z` / `0-9` / `.` / `/` / `~` / `_` / `-`), or `@-` for stdin. Chat-bot payloads like `--text "@所有人 周报"` or `--text "@张三 看一下"` pass through unchanged, so literal mentions reach the API as-is.
</details>
## Key Services
| Service | Command | Commands | Subcommands | Description |
|---------|---------|:--------:|-------------|-------------|
| Contact | `contact` | 6 | `user` `dept` | Search users by name/mobile, batch query, departments, current user profile |
| Chat / IM | `chat` (alias `im`) | 23 | `message` `group` `bot` `conversation-info` `search` `search-common` `list-top-conversations` | Messages (send / list / list-all / by-sender / mentions / focused / unread / topic replies / search), group CRUD + member management (incl. `add-bot`), bot-identity messaging (`send-by-bot` / `recall-by-bot` / `send-by-webhook`), conversation info, common groups lookup |
| Calendar | `calendar` | 14 | `event` `room` `participant` `busy` | Events CRUD + suggested times + attachments, meeting room booking, free-busy query, participant management |
| Todo | `todo` | 6 | `task` | Create, list, update, done, get detail, delete |
| Approval | `oa` | 9 | `approval` | Approve / reject / revoke, pending / initiated instances, process list, operation records |
| Contact | `contact` | 15 | `user` `dept` `label` `relation` | Search users by name / mobile / job-number, batch query, departments, labels & roles, person relations, roster profile & dismissions, current user |
| Chat / IM | `chat` (alias `im`) | 65 | `message` `group` `bot` `conversation-info` `search` `search-common` `list-top-conversations` `group-mute` `group-mute-member` `mute` `set-top` `list-categories` `list-conversations` | Messages (send / reply / list / list-all / by-sender / mentions / focused / unread / topic replies / search / advanced search / forward / cards / emoji & text-emotion reactions / recall / read & send status queries), group CRUD + member management (members add / remove / list / `add-bot`, member-role CRUD, invite URL, icon, settings, transfer-owner, set-admin, quit), bot-identity messaging (`send-by-bot` / `recall-by-bot` / `send-by-webhook`), conversation info, common-groups lookup, group/member/conversation mute, conversation set-top, conversation categories |
| Calendar | `calendar` | 17 | `event` `room` `participant` `busy` | Events CRUD + suggested times + attachments, meeting room booking, free-busy query, participant management |
| Todo | `todo` | 16 | `task` `comment` | Create / list / update / done / get / delete tasks, plus task comments |
| Approval | `oa` | 15 | `approval` | Approve / reject / revoke / redirect tasks, pending / initiated / submitted / executed / cc instances, process forms, comments, operation records |
| Attendance | `attendance` | 4 | `record` `shift` `summary` `rules` | Clock-in records, shift schedules, attendance summary, group rules |
| Ding | `ding` | 2 | `message` | Send / recall DING messages |
| Report | `report` | 7 | `create` `list` `detail` `template` `stats` `sent` | Create reports, sent/received list, templates, statistics |
| AI Tables | `aitable` | 41 | `base` `table` `record` `field` `view` `dashboard` `chart` `import` `export` `attachment` `template` | Full CRUD for Bases / datasheets / records / fields / views; charts & dashboards with public-share configs; data import/export; attachments; templates |
| Doc | `doc` | 21 | `search` `list` `info` `read` `create` `update` `upload` `download` `copy` `move` `rename` `file` `folder` `block` `comment` | Search / read / write docs, file & folder create, block-level editing, comments (list / create / reply / create-inline), upload / download |
| Drive | `drive` | 6 | `list` `info` `download` `mkdir` `upload-info` `commit` | DingTalk drive file ops: list, info, download, create folders, two-phase upload |
| Report | `report` | 20 | `create` `submit` `list` `detail` `template` `stats` `inbox` `outbox` `entry` | Create / submit reports, sent & received (inbox / outbox) lists, templates (get / list), statistics, single-entry get |
| AI Tables | `aitable` | 52 | `base` `table` `record` `field` `view` `dashboard` `chart` `import` `export` `attachment` `template` `form` | Full CRUD for Bases / datasheets / records / fields / views; charts & dashboards with public-share configs; data import/export; attachments (prepare-only `upload` + one-shot `upload-file`); datasheet forms; templates |
| Doc | `doc` | 28 | `search` `list` `info` `read` `create` `update` `upload` `download` `copy` `move` `rename` `file` `folder` `block` `comment` | Search / read / write docs, file & folder create, block-level editing, comments (list / create / reply / create-inline), upload / download |
| Drive | `drive` | 9 | `list` `list-spaces` `info` `download` `mkdir` `upload` `upload-info` `commit` `delete` | DingTalk drive file ops: list spaces, list / info / download, create folders, one-shot `upload` (three-step composite) or two-phase `upload-info` + `commit`, delete |
| Minutes | `minutes` | 19 | `list` `get` `update` `mind-graph` `speaker` `hot-word` `upload` | List AI meeting notes (mine / shared), details (info / summary / keywords / transcription / todos / batch), title/summary updates, mind map, speaker replace, hot-word, upload session |
| Mail | `mail` | 4 | `mailbox` `message` | List mailbox addresses, KQL message search, get full message content, send email |
| Sheet | `sheet` | 34 | `range` `filter-view` (top-level: `create` `new` `list` `info` `find` `replace` `append` `merge-cells` `unmerge-cells` `add-dimension` `insert-dimension` `delete-dimension` `move-dimension` `update-dimension` `write-image` `copy_sheet` `update_sheet` `submit_export_job` `query_export_job` `create_filter` `get_filter` `update_filter` `delete_filter` `set_filter_criteria` `clear_filter_criteria` `sort_filter`) | Online spreadsheet (`contentType=ALIDOC`, `extension=axls`): worksheet CRUD, range read/write/append, dimension ops, cell merge, find/replace, named filter views + sheet-level filters, image write, async export (`submit_export_job` + `query_export_job` — no consolidated `export` in v1.0.25) |
| Wiki | `wiki` | 7 | `space` `member` | Knowledge base management: space `create` / `get` / `list` / `search` + member `add` / `list` / `update` |
| Mail | `mail` | 18 | `mailbox` `message` `draft` `folder` `tag` `thread` `attachment` `user` | List mailboxes, KQL message search, read & send messages, drafts, folders, tags, threads, attachments, address-book user search |
| Sheet | `sheet` | 23 | `range` `filter-view` (top-level: `create` `new` `list` `info` `read` `get` `update` `find` `replace` `append` `merge-cells` `unmerge-cells` `add-dimension` `insert-dimension` `delete-dimension` `move-dimension` `update-dimension` `write-image`) | Online spreadsheet (`contentType=ALIDOC`, `extension=axls`): worksheet CRUD, range read / write / append, dimension ops, cell merge / unmerge, find / replace, named filter views + sheet-level filters, image write |
| Wiki | `wiki` | 21 | `space` `member` `node` `doc` `file` | Knowledge base management: spaces (`create` / `get` / `list` / `search`), members (`add` / `list` / `update`), node tree, docs & files |
| DevDoc | `devdoc` | 1 | `article` | Search the DingTalk Open Platform documentation |
| AI Search | `aisearch` | 3 | `person` | Enterprise people search by name / department / position / duty / supervisor / subordinate / phone / job-number (single command, multi-dimension filter) |
| Live | `live` | 1 | `stream` | DingTalk live streaming: list my lives |
| Raw API | `api` | 1 | — | Call any DingTalk OpenAPI directly (api / oapi dual-form), with automatic app-level token management |
> **204 commands across 16 products.** Full listing with descriptions and usage scenarios: [`docs/command-index.md`](./docs/command-index.md). Run `dws --help` for the top-level tree, or `dws <service> --help` for subcommands.
> **330 commands across 18 products.** Full listing with descriptions and usage scenarios: [`docs/command-index.md`](./docs/command-index.md). Run `dws --help` for the top-level tree, or `dws <service> --help` for subcommands.
> **Note on `chat bot`**: bot capabilities (`send-by-bot` / `recall-by-bot` / `add-bot` / `send-by-webhook` / bot search) are merged into the relevant `chat` subtrees (e.g. `dws chat message send-by-bot`, `dws chat group members add-bot`) so the agent-facing command surface stays flat and discoverable. There is no longer a separate top-level `bot` product.
<details>
<summary>Coming soon</summary>
`conference` (video) · `aiapp` (AI apps) · `live` (streaming)
- `conference` (video meetings)
- Multi-skill mode (experimental) — per-product skills under `skills/multi/`; opt in via `dws skill setup --mode multi`
</details>
+101 -25
View File
@@ -21,7 +21,7 @@
> [!IMPORTANT]
> **共创阶段**:本项目涉及钉钉企业数据访问,需企业管理员授权后方可使用。欢迎加入钉钉 DWS 共创群获取支持与最新动态。详见下方 [开始使用](#开始使用)。
>
> <a href="https://qr.dingtalk.com/action/joingroup?code=v1,k1,v9/YMJG9qXhvFk5juktYnQziN70rF7QHebC/JLztTVRuRVJIwrSsXmL8oFqU5ajJ&_dt_no_comment=1&origin=11"><img src="https://img.alicdn.com/imgextra/i4/O1CN01Rijgk81gKqVSKMzdx_!!6000000004124-2-tps-654-644.png" alt="DingTalk Group QR Code" width="150"></a>
> <img src="https://img.alicdn.com/imgextra/i1/O1CN01WJyAsJ1prD2ovQACM_!!6000000005413-2-tps-718-720.png" alt="dws 开源沟通群二维码" width="150">
<details>
<summary><strong>目录</strong></summary>
@@ -63,6 +63,27 @@ curl -fsSL https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace
irm https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install.ps1 | iex
```
<details>
<summary><strong>Skill 模式:mono 与 multi</strong></summary>
安装时可以选择两种 skill 组织方式。两种模式下 CLI 命令完全一样(`dws aitable ...` / `dws calendar ...`),区别只在 Agent 那边读到的 skill 文档结构。
| 模式 | 安装内容 | 适合场景 |
|------|----------|----------|
| **mono**(稳定,默认) | 一个 `dws` skill,覆盖全部产品 | 跨产品组合操作;单一入口召唤 |
| **multi** 🧪 **试验版 / Preview** | 18 个独立产品 skill(`dingtalk-aitable` / `dingtalk-calendar` / `dingtalk-chat` ...) | 单产品任务;每次召唤上下文更小 |
> 🧪 **multi 模式当前为 EXPERIMENTAL(试验版 / Preview)**。18 个独立 skill 全部通过 dispatch verifier,但接口、命名、跨 skill 引用后续可能调整。生产 / 共享环境建议优先用 `mono`。问题请提 issue 反馈。
怎么选:
- **快速安装**(上方一行 curl):非交互,默认装 `mono`。
- **TTY 安装**(先下载再执行):`curl -O .../install.sh && bash install.sh`,会弹出 `1) mono 2) multi` 选项(默认 1)。
- **环境变量覆盖**:`DWS_SKILL_MODE=multi curl -fsSL ... | sh`。
- **装完之后再切换**:`dws skill setup --mode multi`(或 `--mode mono`),随时重跑都行。
</details>
<details>
<summary>其他安装方式</summary>
@@ -182,6 +203,26 @@ dws auth login --client-id <your-app-key> --client-secret <your-app-secret>
</details>
<details>
<summary><strong>沙箱间迁移登录态(Linux)</strong></summary>
仅拷贝 `~/.dws/app.json` 无法带走 refresh token;access token 约 2 小时后会失效。请使用官方导出/导入:
```bash
# A 沙箱(已登录)
dws auth export -o /tmp/dws-auth.tar.gz
# 或便于分片复制:dws auth export --base64 -o /tmp/dws-auth.b64
# B 沙箱
dws auth import -i /tmp/dws-auth.tar.gz
# 或:dws auth import -i /tmp/dws-auth.b64 --base64
dws auth status # 确认 Refresh Token: 有效
```
包内包含 `~/.local/share/dws-cli` 加密 keychain(含 `auth-token.enc` 与 `dek`)及 `~/.dws` 必要配置。
</details>
## 快速开始
```bash
@@ -230,26 +271,56 @@ dws aitable record query --base-id BASE_ID --table-id TABLE_ID --limit 10
### Agent Skills
仓库内置完整的 Agent Skill 体系(`skills/`),安装后 Claude Code / Cursor 等 AI 工具可通过自然语言直接操作钉钉:
仓库内置完整的 Agent Skill 体系(`skills/` 目录),目前重组为两套布局:
- `skills/mono/` — 单 skill 布局(一个 `SKILL.md` + `references/products/`),默认推荐。
- `skills/multi/` — 每个产品一个独立 skill(`dingtalk-aitable/` / `dingtalk-calendar/` / `dingtalk-chat/` ... 共 18 个),每个 skill 自带 `SKILL.md`。🧪 **试验版 / Preview — 各 multi `SKILL.md` 头部有详细注意事项。**
安装之后,Claude Code / Cursor 等 AI 工具就能通过自然语言直接操作钉钉:
```bash
# 安装 skills 到当前项目
# 安装 skills 到当前项目(默认 mono)
curl -fsSL https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install-skills.sh | sh
```
> `install.sh` 安装到 `$HOME/.agents/skills/dws`(全局);`install-skills.sh` 安装到 `./.agents/skills/dws`(当前项目)。
**包含内容:**
**用 `dws skill setup` 切换或重装:**
```bash
# 交互式:提示选模式 + 目标 Agent
dws skill setup
# 把 mono skill 铺到所有检测到的 Agent home(claude / cursor / codex / opencode / qoder)
dws skill setup --mode mono --target all --yes
# 只装到某一个 Agent home
dws skill setup --mode multi --target cursor --yes
# 指定本地源目录(比如 fork 或正在改的版本)
DWS_SKILL_SOURCE=/path/to/skills dws skill setup --mode multi
```
| 参数 | 取值 | 说明 |
|------|------|------|
| `--mode` | `mono` \| `multi` | skill 布局,不指定则交互式询问 |
| `--target` | `all` \| `claude` \| `cursor` \| `codex` \| `opencode` \| `qoder` | 安装目标,`all` 表示铺到所有检测到的 Agent home |
| `--source` | 路径 | 本地源目录(覆盖内置 skills) |
| `--yes` | — | 跳过确认提示 |
环境变量:`DWS_SKILL_MODE=mono|multi`(`install.sh` / `install.ps1` 也认)、`DWS_SKILL_SOURCE=<路径>`。
**包含内容(mono 布局):**
| 组件 | 路径 | 说明 |
|------|------|------|
| 主 Skill | `SKILL.md` | 意图路由、决策树、安全规则、错误处理 |
| 产品参考 | `references/products/*.md` | 各产品命令详细参考(aitable、chat、calendar 等) |
| 意图指南 | `references/intent-guide.md` | 易混淆场景消歧(如 report vs todo) |
| 全局参考 | `references/global-reference.md` | 认证、输出格式、全局 flag |
| 错误码 | `references/error-codes.md` | 错误码 + 调试流程 |
| Recovery 指南 | `references/recovery-guide.md` | `RECOVERY_EVENT_ID` 处理 |
| 现成脚本 | `scripts/*.py` | 13 个批量操作脚本(见下方) |
| 主 Skill | `skills/mono/SKILL.md` | 意图路由、决策树、安全规则、错误处理 |
| 产品参考 | `skills/mono/references/products/*.md` | 各产品命令详细参考(aitable、chat、calendar 等) |
| 意图指南 | `skills/mono/references/intent-guide.md` | 易混淆场景消歧(如 report vs todo) |
| 全局参考 | `skills/mono/references/global-reference.md` | 认证、输出格式、全局 flag |
| 错误码 | `skills/mono/references/error-codes.md` | 错误码 + 调试流程 |
| Recovery 指南 | `skills/mono/references/recovery-guide.md` | `RECOVERY_EVENT_ID` 处理 |
| 现成脚本 | `skills/mono/scripts/*.py` | 13 个批量操作脚本(见下方) |
<details>
<summary><strong>现成脚本</strong> — 13 个 Python 脚本,覆盖常见多步工作流</summary>
@@ -394,38 +465,43 @@ dws chat message send-by-bot --robot-code BOT_CODE --group GROUP_ID \
--title "周报" --text @-
```
> **说明**:`@` 仅在其后是 ASCII 路径前缀字符(`A-Z` / `a-z` / `0-9` / `.` / `/` / `~` / `_` / `-`)或 `@-`(stdin)时,才会被识别为 `@<path>` 文件注入语法。`--text "@所有人 周报"` / `--text "@张三 看一下"` 这类机器人消息中的字面 `@` 提及会原样透传到 API。
</details>
## 核心服务
| 服务 | 命令 | 命令数 | 子命令 | 描述 |
|------|------|:------:|--------|------|
| 通讯录 | `contact` | 6 | `user` `dept` | 按姓名/手机号搜索、批量查询、部门树、当前用户信息 |
| 群聊 | `chat`(别名 `im`)| 23 | `message` `group` `bot` `conversation-info` `search` `search-common` `list-top-conversations` | 消息(发送 / 列表 / list-all / 按发送者 / @我 / 关注 / 未读 / 话题回复 / 搜索)、群增删改 + 成员管理(含 `add-bot`)、机器人身份消息(`send-by-bot` / `recall-by-bot` / `send-by-webhook`)、会话信息查询、共同群聊 |
| 日历 | `calendar` | 14 | `event` `room` `participant` `busy` | 日程 CRUD + 建议时间 + 附件、会议室预订、闲忙查询、参与者管理 |
| 待办 | `todo` | 6 | `task` | 创建、列表、修改、完成、详情、删除 |
| 审批 | `oa` | 9 | `approval` | 同意 / 拒绝 / 撤销、待我审批 / 我发起的、流程列表、操作记录 |
| 通讯录 | `contact` | 15 | `user` `dept` `label` `relation` | 按姓名 / 手机号 / 工号搜索、批量查询、部门树、角色标签、人员关系、花名册与离职、当前用户信息 |
| 群聊 | `chat`(别名 `im`)| 65 | `message` `group` `bot` `conversation-info` `search` `search-common` `list-top-conversations` `group-mute` `group-mute-member` `mute` `set-top` `list-categories` `list-conversations` | 消息(发送 / 回复 / 列表 / list-all / 按发送者 / @我 / 关注 / 未读 / 话题回复 / 搜索 / 高级搜索 / 转发 / 卡片 / 表情与文本表情反应 / 撤回 / 已读与发送状态查询)、群增删改 + 成员管理(成员增 / 删 / 查 / `add-bot`、成员角色增删改查、邀请链接、群图标、群设置、转让群主、设置管理员、退群)、机器人身份消息(`send-by-bot` / `recall-by-bot` / `send-by-webhook`)、会话信息查询、共同群聊、群/成员/会话免打扰、会话置顶、会话分类 |
| 日历 | `calendar` | 17 | `event` `room` `participant` `busy` | 日程 CRUD + 建议时间 + 附件、会议室预订、闲忙查询、参与者管理 |
| 待办 | `todo` | 16 | `task` `comment` | 创建、列表、修改、完成、详情、删除,以及任务评论 |
| 审批 | `oa` | 15 | `approval` | 同意 / 拒绝 / 撤销 / 转交、待我审批 / 我发起 / 已提交 / 已办 / 抄送、流程表单、评论、操作记录 |
| 考勤 | `attendance` | 4 | `record` `shift` `summary` `rules` | 打卡记录、排班查询、考勤摘要、考勤组规则 |
| DING | `ding` | 2 | `message` | 发送 / 撤回 DING 消息 |
| 日志 | `report` | 7 | `create` `list` `detail` `template` `stats` `sent` | 创建日志、收发列表、模版、详情、统计 |
| AI 表格 | `aitable` | 41 | `base` `table` `record` `field` `view` `dashboard` `chart` `import` `export` `attachment` `template` | Base / 数据表 / 记录 / 字段 / 视图 全量 CRUD;图表 + 仪表盘(含分享配置);数据导入导出;附件;模板 |
| 文档 | `doc` | 21 | `search` `list` `info` `read` `create` `update` `upload` `download` `copy` `move` `rename` `file` `folder` `block` `comment` | 搜索 / 读写文档、文件与文件夹创建、块级编辑、评论(list / create / reply / create-inline)、上传 / 下载 |
| 钉盘 | `drive` | 6 | `list` `info` `download` `mkdir` `upload-info` `commit` | 钉盘文件操作:列表、详情、下载、创建文件夹、两阶段上传 |
| 日志 | `report` | 20 | `create` `submit` `list` `detail` `template` `stats` `inbox` `outbox` `entry` | 创建 / 提交日志、收发(收件箱 / 发件箱)列表、模版(获取 / 列表)、详情、统计、单条获取 |
| AI 表格 | `aitable` | 52 | `base` `table` `record` `field` `view` `dashboard` `chart` `import` `export` `attachment` `template` `form` | Base / 数据表 / 记录 / 字段 / 视图 全量 CRUD;图表 + 仪表盘(含分享配置);数据导入导出;附件(仅获取凭证的 `upload` + 一键上传 `upload-file`);数据表表单;模板 |
| 文档 | `doc` | 28 | `search` `list` `info` `read` `create` `update` `upload` `download` `copy` `move` `rename` `file` `folder` `block` `comment` | 搜索 / 读写文档、文件与文件夹创建、块级编辑、评论(list / create / reply / create-inline)、上传 / 下载 |
| 钉盘 | `drive` | 9 | `list` `list-spaces` `info` `download` `mkdir` `upload` `upload-info` `commit` `delete` | 钉盘文件操作:列出空间、文件列表 / 详情 / 下载、创建文件夹、一键 `upload`(三步合成)或两阶段 `upload-info` + `commit`、删除 |
| AI 听记 | `minutes` | 19 | `list` `get` `update` `mind-graph` `speaker` `hot-word` `upload` | 听记列表(我创建 / 共享给我)、详情(info / summary / keywords / transcription / todos / batch)、标题/摘要更新、思维导图、发言人替换、热词、上传会话 |
| 邮箱 | `mail` | 4 | `mailbox` `message` | 邮箱地址列表、KQL 邮件搜索、邮件详情、发送邮件 |
| 在线电子表格 | `sheet` | 34 | `range` `filter-view`(顶层:`create` `new` `list` `info` `find` `replace` `append` `merge-cells` `unmerge-cells` `add-dimension` `insert-dimension` `delete-dimension` `move-dimension` `update-dimension` `write-image` `copy_sheet` `update_sheet` `submit_export_job` `query_export_job` `create_filter` `get_filter` `update_filter` `delete_filter` `set_filter_criteria` `clear_filter_criteria` `sort_filter`) | 在线电子表格(`contentType=ALIDOC`、`extension=axls`):工作表 CRUD、区域读写/追加、行列操作、合并、查找替换、命名筛选视图 + 表级筛选、写入图片、异步导出(`submit_export_job` + `query_export_job`,v1.0.25 暂无合并的 `export` 命令) |
| 知识库 | `wiki` | 7 | `space` `member` | 知识库管理:空间 `create` / `get` / `list` / `search` + 成员 `add` / `list` / `update` |
| 邮箱 | `mail` | 18 | `mailbox` `message` `draft` `folder` `tag` `thread` `attachment` `user` | 邮箱地址列表、KQL 邮件搜索、读取与发送邮件、草稿、文件夹、标签、会话、附件、通讯录用户搜索 |
| 在线电子表格 | `sheet` | 23 | `range` `filter-view`(顶层:`create` `new` `list` `info` `read` `get` `update` `find` `replace` `append` `merge-cells` `unmerge-cells` `add-dimension` `insert-dimension` `delete-dimension` `move-dimension` `update-dimension` `write-image`) | 在线电子表格(`contentType=ALIDOC`、`extension=axls`):工作表 CRUD、区域读写/追加、行列操作、合并/取消合并、查找替换、命名筛选视图 + 表级筛选、写入图片 |
| 知识库 | `wiki` | 21 | `space` `member` `node` `doc` `file` | 知识库管理:空间(`create` / `get` / `list` / `search`)、成员(`add` / `list` / `update`)、节点树、文档与文件 |
| 开发者文档 | `devdoc` | 1 | `article` | 搜索钉钉开放平台文档 |
| AI 搜问 | `aisearch` | 3 | `person` | 企业人员搜索:按姓名 / 部门 / 职位 / 职责 / 上级 / 下级 / 手机号 / 工号 多维度过滤(单命令) |
| 直播 | `live` | 1 | `stream` | 钉钉直播:查看我的直播列表 |
| Raw API | `api` | 1 | — | 直接调用任意钉钉 OpenAPI(api / oapi 双形态),自动管理应用级 Token |
> **16 个产品,204 条命令。** 完整命令清单(带描述与使用场景):[`docs/command-index.md`](./docs/command-index.md)。运行 `dws --help` 查看顶层命令树,或 `dws <service> --help` 查看子命令。
> **18 个产品,330 条命令。** 完整命令清单(带描述与使用场景):[`docs/command-index.md`](./docs/command-index.md)。运行 `dws --help` 查看顶层命令树,或 `dws <service> --help` 查看子命令。
> **关于 `chat bot`**:机器人能力(`send-by-bot` / `recall-by-bot` / `add-bot` / `send-by-webhook` / bot 搜索)已合并到对应的 `chat` 子树下(例如 `dws chat message send-by-bot`、`dws chat group members add-bot`),保持 agent 视角下的命令面扁平易发现。不再有独立的顶层 `bot` 产品。
<details>
<summary>即将推出</summary>
`conference`(视频会议)· `aiapp`(AI 应用)· `live`(直播)
- `conference`(视频会议)
- 多 skill 模式(实验中)— 每产品一个独立 skill,位于 `skills/multi/`,通过 `dws skill setup --mode multi` 启用
</details>
+36 -3
View File
@@ -136,11 +136,36 @@ function installSkillsToHomes(skillRoot) {
}
}
// cacheUserSkills copies the mono and multi trees out of the freshly extracted
// dws-skills.zip into ~/.dws/skills/{mono,multi}/ so that `dws skill setup`
// can fall back to a user-local cache when --source is not provided. mono is
// already installed into agent homes by installSkillsToHomes; the cache is
// purely a source-of-truth for the setup command.
function cacheUserSkills(extractedSkillsRoot) {
const cacheBase = path.join(os.homedir(), ".dws", "skills");
const monoSource = fs.existsSync(path.join(extractedSkillsRoot, "mono", "SKILL.md"))
? path.join(extractedSkillsRoot, "mono")
: extractedSkillsRoot;
const monoCache = path.join(cacheBase, "mono");
fs.rmSync(monoCache, { recursive: true, force: true });
copyChildren(monoSource, monoCache);
const multiSource = path.join(extractedSkillsRoot, "multi");
if (fs.existsSync(multiSource) && fs.statSync(multiSource).isDirectory()) {
const multiCache = path.join(cacheBase, "multi");
fs.rmSync(multiCache, { recursive: true, force: true });
copyChildren(multiSource, multiCache);
}
}
function main() {
const packageRoot = __dirname;
const assetsDir = path.join(packageRoot, "assets");
const vendorDir = path.join(packageRoot, "vendor");
const skillDir = path.join(packageRoot, "share", "skills", "dws");
// Extract dws-skills.zip into a staging directory so we can split mono/
// (installed to agent homes) from multi/ (cached for later setup use).
const skillsStaging = path.join(packageRoot, "share", "skills");
const assetName = PLATFORM_MAP[`${process.platform}-${process.arch}`];
if (!assetName) {
throw new Error(`unsupported platform: ${process.platform}/${process.arch}`);
@@ -156,8 +181,16 @@ function main() {
}
extractArchive(archivePath, vendorDir);
extractSkills(skillsPath, skillDir);
installSkillsToHomes(skillDir);
extractSkills(skillsPath, skillsStaging);
// For backward compatibility, the zip root carries a copy of mono content
// (SKILL.md + references/ + scripts/). Prefer the explicit mono/ subdir
// when present; fall back to the staging root otherwise.
const monoRoot = fs.existsSync(path.join(skillsStaging, "mono", "SKILL.md"))
? path.join(skillsStaging, "mono")
: skillsStaging;
installSkillsToHomes(monoRoot);
cacheUserSkills(skillsStaging);
}
main();
+2
View File
@@ -76,6 +76,7 @@ Canonical 路径先匹配;落空后走 CLI 路径(product → group.. → cl
| `parameters` / `required` | MCP 输入 JSON Schema 的 properties / required |
| `output_schema` | MCP 输出 Schema(上游下发时才有) |
| `sensitive` | 敏感写操作,需 `--yes` 确认 |
| `auth` | DingTalk 授权元数据,包括 `requiredScopes` / `requiredPermissions` / `recommendedScopes` / `grantProductCodes` / `riskAction` / `confirmationRequired` |
| `annotations.destructive_hint` | 对齐 MCP 2025+ annotations,目前从 `sensitive` 映射 |
| `flag_overlay[param]` | CLI 层对 MCP 参数的改写:`alias` / `transform` / `transform_args` / `env_default` / `default` / `hidden` |
@@ -85,6 +86,7 @@ Canonical 路径先匹配;落空后走 CLI 路径(product → group.. → cl
```bash
dws schema ding.send_ding_message --jq '.tool.flag_overlay' # 只看 overlay
dws schema calendar.create_event --jq '.tool.auth' # 只看授权元数据
dws schema --jq '.products[] | {id, count: (.tools|length)}' # 各产品工具数
dws schema aitable.delete_base --jq '.tool.annotations' # 敏感操作提示
```
+27
View File
@@ -14,11 +14,38 @@ require (
)
require (
github.com/RealAlexandreAI/json-repair v0.0.15 // indirect
github.com/atotto/clipboard v0.1.4 // indirect
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/catppuccin/go v0.3.0 // indirect
github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7 // indirect
github.com/charmbracelet/bubbletea v1.3.6 // indirect
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
github.com/charmbracelet/huh v1.0.0 // indirect
github.com/charmbracelet/lipgloss v1.1.0 // indirect
github.com/charmbracelet/x/ansi v0.9.3 // indirect
github.com/charmbracelet/x/cellbuf v0.0.13 // indirect
github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 // indirect
github.com/charmbracelet/x/term v0.2.1 // indirect
github.com/clipperhouse/stringish v0.1.1 // indirect
github.com/clipperhouse/uax29/v2 v2.3.0 // indirect
github.com/danieljoos/wincred v1.2.3 // indirect
github.com/dustin/go-humanize v1.0.1 // indirect
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
github.com/godbus/dbus/v5 v5.2.2 // indirect
github.com/itchyny/timefmt-go v0.1.7 // indirect
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-localereader v0.0.1 // indirect
github.com/mattn/go-runewidth v0.0.19 // indirect
github.com/mitchellh/hashstructure/v2 v2.0.2 // indirect
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
github.com/muesli/cancelreader v0.2.2 // indirect
github.com/muesli/termenv v0.16.0 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
golang.org/x/sync v0.20.0 // indirect
)
require (
+55
View File
@@ -1,8 +1,42 @@
github.com/RealAlexandreAI/json-repair v0.0.15 h1:AN8/yt8rcphwQrIs/FZeki+cKaIERUNr25zf1flirIs=
github.com/RealAlexandreAI/json-repair v0.0.15/go.mod h1:GKJi5borR78O8c7HCVbgqjhoiVibZ6hJldxbc6dGrAI=
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
github.com/catppuccin/go v0.3.0 h1:d+0/YicIq+hSTo5oPuRi5kOpqkVA5tAsU6dNhvRu+aY=
github.com/catppuccin/go v0.3.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc=
github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7 h1:JFgG/xnwFfbezlUnFMJy0nusZvytYysV4SCS2cYbvws=
github.com/charmbracelet/bubbles v0.21.1-0.20250623103423-23b8fd6302d7/go.mod h1:ISC1gtLcVilLOf23wvTfoQuYbW2q0JevFxPfUzZ9Ybw=
github.com/charmbracelet/bubbletea v1.3.6 h1:VkHIxPJQeDt0aFJIsVxw8BQdh/F/L2KKZGsK6et5taU=
github.com/charmbracelet/bubbletea v1.3.6/go.mod h1:oQD9VCRQFF8KplacJLo28/jofOI2ToOfGYeFgBBxHOc=
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
github.com/charmbracelet/huh v1.0.0 h1:wOnedH8G4qzJbmhftTqrpppyqHakl/zbbNdXIWJyIxw=
github.com/charmbracelet/huh v1.0.0/go.mod h1:5YVc+SlZ1IhQALxRPpkGwwEKftN/+OlJlnJYlDRFqN4=
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
github.com/charmbracelet/x/ansi v0.9.3 h1:BXt5DHS/MKF+LjuK4huWrC6NCvHtexww7dMayh6GXd0=
github.com/charmbracelet/x/ansi v0.9.3/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
github.com/charmbracelet/x/cellbuf v0.0.13 h1:/KBBKHuVRbq1lYx5BzEHBAFBP8VcQzJejZ/IA3iR28k=
github.com/charmbracelet/x/cellbuf v0.0.13/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 h1:qko3AQ4gK1MTS/de7F5hPGx6/k1u0w4TeYmBFwzYVP4=
github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ=
github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
github.com/clipperhouse/stringish v0.1.1 h1:+NSqMOr3GR6k1FdRhhnXrLfztGzuG+VuFDfatpWHKCs=
github.com/clipperhouse/stringish v0.1.1/go.mod h1:v/WhFtE1q0ovMta2+m+UbpZ+2/HEXNWYXQgCt4hdOzA=
github.com/clipperhouse/uax29/v2 v2.3.0 h1:SNdx9DVUqMoBuBoW3iLOj4FQv3dN5mDtuqwuhIGpJy4=
github.com/clipperhouse/uax29/v2 v2.3.0/go.mod h1:Wn1g7MK6OoeDT0vL+Q0SQLDz/KpfsVRgg6W7ihQeh4g=
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
github.com/danieljoos/wincred v1.2.3 h1:v7dZC2x32Ut3nEfRH+vhoZGvN72+dQ/snVXo/vMFLdQ=
github.com/danieljoos/wincred v1.2.3/go.mod h1:6qqX0WNrS4RzPZ1tnroDzq9kY3fu1KwE7MRLQK4X0bs=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ=
@@ -15,13 +49,29 @@ github.com/itchyny/gojq v0.12.18 h1:gFGHyt/MLbG9n6dqnvlliiya2TaMMh6FFaR2b1H6Drc=
github.com/itchyny/gojq v0.12.18/go.mod h1:4hPoZ/3lN9fDL1D+aK7DY1f39XZpY9+1Xpjz8atrEkg=
github.com/itchyny/timefmt-go v0.1.7 h1:xyftit9Tbw+Dc/huSSPJaEmX1TVL8lw5vxjJLK4GMMA=
github.com/itchyny/timefmt-go v0.1.7/go.mod h1:5E46Q+zj7vbTgWY8o5YkMeYb4I6GeWLFnetPy5oBrAI=
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
github.com/mattn/go-runewidth v0.0.19 h1:v++JhqYnZuu5jSKrk9RbgF5v4CGUjqRfBm05byFGLdw=
github.com/mattn/go-runewidth v0.0.19/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
github.com/mitchellh/hashstructure/v2 v2.0.2 h1:vGKWl0YJqUNxE8d+h8f6NJLcCJrgbhC4NcD46KavDd4=
github.com/mitchellh/hashstructure/v2 v2.0.2/go.mod h1:MG3aRVU/N29oo/V/IhBX8GR/zz4kQkprJgF2EVszyDE=
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
@@ -31,11 +81,16 @@ github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
github.com/zalando/go-keyring v0.2.8 h1:6sD/Ucpl7jNq10rM2pgqTs0sZ9V3qMrqfIIy5YPccHs=
github.com/zalando/go-keyring v0.2.8/go.mod h1:tsMo+VpRq5NGyKfxoBVjCuMrG47yj8cmakZDO5QGii0=
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
golang.org/x/crypto v0.49.0 h1:+Ng2ULVvLHnJ/ZFEq4KdcDd/cfjrrjjNSXNzxg0Y4U4=
golang.org/x/crypto v0.49.0/go.mod h1:ErX4dUh2UM+CFYiXZRTcMpEcN8b/1gxEuv3nODoYtCA=
golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
+146
View File
@@ -14,17 +14,22 @@
package app
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
"strings"
"time"
authpkg "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/auth"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/helpers"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/keychain"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/config"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/edition"
"github.com/spf13/cobra"
@@ -55,6 +60,8 @@ func buildAuthCommand() *cobra.Command {
cmd.AddCommand(
newAuthLogoutCommand(),
newAuthStatusCommand(),
newAuthExportCommand(),
newAuthImportCommand(),
newAuthExchangeCommand(),
newAuthResetCommand(),
)
@@ -277,6 +284,13 @@ func newAuthStatusCommand() *cobra.Command {
} else {
fmt.Fprintf(w, "%-16s%s\n", "状态:", "已登录 ✅")
}
if tokenData != nil {
if tokenData.IsRefreshTokenValid() {
fmt.Fprintf(w, "%-16s%s\n", "Refresh Token:", "有效 ✅")
} else {
fmt.Fprintf(w, "%-16s%s\n", "Refresh Token:", "缺失或已过期 ⚠️")
}
}
if updatedAt := authStatusUpdatedAt(tokenData); updatedAt != "" {
fmt.Fprintf(w, "%-16s%s\n", "有效期:", updatedAt)
}
@@ -291,6 +305,138 @@ func newAuthStatusCommand() *cobra.Command {
}
}
func newAuthExportCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "export",
Short: "导出可迁移认证包",
Long: `导出包含 refresh token 与解密材料的认证包,便于在另一台 Linux 沙箱中导入。
包内包含 ~/.local/share/dws-cli 加密 keychain 与 ~/.dws 必要配置,不含 token 明文。
示例:
dws auth export -o dws-auth.tar.gz
dws auth export --base64 > dws-auth.b64`,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
output, err := cmd.Flags().GetString("output")
if err != nil {
return apperrors.NewInternal("failed to read --output")
}
asBase64, err := cmd.Flags().GetBool("base64")
if err != nil {
return apperrors.NewInternal("failed to read --base64")
}
output = strings.TrimSpace(output)
if !asBase64 && output == "" {
return apperrors.NewValidation("--output is required unless --base64 is used")
}
if !authpkg.PortableExportSupported() {
return apperrors.NewValidation(fmt.Sprintf(
"macOS 默认将 DEK 存在系统 Keychain,导出的包无法在其它机器解密;请设置 %s=1 后重新登录再导出",
keychain.DisableKeychainEnv,
))
}
if !authpkg.PortableAuthSourceReady() {
return apperrors.NewValidation("尚未登录,请先运行 dws auth login")
}
var bundle bytes.Buffer
if err := authpkg.ExportPortableAuthBundle(defaultConfigDir(), &bundle); err != nil {
return apperrors.NewInternal(fmt.Sprintf("failed to export auth bundle: %v", err))
}
if asBase64 {
payload := []byte(base64.StdEncoding.EncodeToString(bundle.Bytes()) + "\n")
if output == "" {
_, err := cmd.OutOrStdout().Write(payload)
return err
}
if err := helpers.AtomicWrite(output, payload, config.FilePerm); err != nil {
return apperrors.NewInternal(fmt.Sprintf("failed to write auth bundle: %v", err))
}
fmt.Fprintf(cmd.OutOrStdout(), "[OK] 已导出认证包: %s\n", output)
fmt.Fprintf(cmd.ErrOrStderr(), "认证包含敏感凭据,用完请删除: rm -P %s\n", output)
return nil
}
if err := helpers.AtomicWrite(output, bundle.Bytes(), config.FilePerm); err != nil {
return apperrors.NewInternal(fmt.Sprintf("failed to write auth bundle: %v", err))
}
fmt.Fprintf(cmd.OutOrStdout(), "[OK] 已导出认证包: %s\n", output)
fmt.Fprintf(cmd.ErrOrStderr(), "认证包含敏感凭据,用完请删除: rm -P %s\n", output)
return nil
},
}
cmd.Flags().StringP("output", "o", "", "认证包输出路径")
cmd.Flags().Bool("base64", false, "将认证包编码为 base64,便于复制粘贴")
return cmd
}
func newAuthImportCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "import",
Short: "导入可迁移认证包",
Long: `从 dws auth export 生成的 tar.gz 或 base64 文件恢复认证。
导入后请运行 dws auth status 确认 refresh token 仍有效。
示例:
dws auth import -i dws-auth.tar.gz
dws auth import -i dws-auth.b64 --base64`,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
input, err := cmd.Flags().GetString("input")
if err != nil {
return apperrors.NewInternal("failed to read --input")
}
input = strings.TrimSpace(input)
if input == "" {
return apperrors.NewValidation("--input is required")
}
asBase64, err := cmd.Flags().GetBool("base64")
if err != nil {
return apperrors.NewInternal("failed to read --base64")
}
force, err := cmd.Flags().GetBool("force")
if err != nil {
return apperrors.NewInternal("failed to read --force")
}
configDir := defaultConfigDir()
if !force && authpkg.PortableAuthTargetPopulated(configDir) {
return apperrors.NewValidation("检测到已有登录态,请使用 --force 确认覆盖")
}
payload, err := os.ReadFile(input)
if err != nil {
return apperrors.NewInternal(fmt.Sprintf("failed to read auth bundle: %v", err))
}
if asBase64 {
payload, err = base64.StdEncoding.DecodeString(strings.TrimSpace(string(payload)))
if err != nil {
return apperrors.NewValidation(fmt.Sprintf("invalid base64 auth bundle: %v", err))
}
}
report, err := authpkg.ImportPortableAuthBundle(configDir, bytes.NewReader(payload))
if err != nil {
return apperrors.NewInternal(fmt.Sprintf("failed to import auth bundle: %v", err))
}
if report.OSMismatch {
fmt.Fprintf(cmd.ErrOrStderr(), "警告: 认证包来自 %s,当前系统为 %s,请确认解密材料兼容\n", report.BundleOS, runtime.GOOS)
}
ResetRuntimeTokenCache()
clearCompatCache()
fmt.Fprintln(cmd.OutOrStdout(), "[OK] 已导入认证包")
fmt.Fprintln(cmd.OutOrStdout(), "请运行 dws auth status 验证登录状态")
return nil
},
}
cmd.Flags().StringP("input", "i", "", "认证包输入路径")
cmd.Flags().Bool("base64", false, "输入为 base64 编码的认证包")
cmd.Flags().Bool("force", false, "覆盖已有登录态")
return cmd
}
func newAuthExchangeCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "exchange",
+103
View File
@@ -17,14 +17,117 @@ import (
"bytes"
"errors"
"net/http"
"os"
"path/filepath"
"strings"
"testing"
"time"
authpkg "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/auth"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/keychain"
)
func TestAuthExportImportBase64RoundTrip(t *testing.T) {
t.Setenv(keychain.DisableKeychainEnv, "1")
sourceKeychain := filepath.Join(t.TempDir(), "source-keychain")
sourceConfig := filepath.Join(t.TempDir(), ".dws")
t.Setenv(keychain.StorageDirEnv, sourceKeychain)
t.Setenv("DWS_CONFIG_DIR", sourceConfig)
original := &authpkg.TokenData{
AccessToken: "access-cli",
RefreshToken: "refresh-cli",
ExpiresAt: time.Now().Add(-time.Hour),
RefreshExpAt: time.Now().Add(24 * time.Hour),
ClientID: "client-cli",
Source: "mcp",
}
if err := authpkg.SaveTokenData(sourceConfig, original); err != nil {
t.Fatalf("SaveTokenData() error = %v", err)
}
exportCmd := NewRootCommand()
var exported bytes.Buffer
exportCmd.SetOut(&exported)
exportCmd.SetErr(&bytes.Buffer{})
exportCmd.SetArgs([]string{"auth", "export", "--base64"})
if err := exportCmd.Execute(); err != nil {
t.Fatalf("auth export --base64 error = %v", err)
}
if strings.TrimSpace(exported.String()) == "" {
t.Fatal("auth export --base64 produced empty output")
}
targetRoot := t.TempDir()
inputPath := filepath.Join(targetRoot, "dws-auth.b64")
if err := os.WriteFile(inputPath, exported.Bytes(), 0o600); err != nil {
t.Fatalf("write input bundle error = %v", err)
}
targetKeychain := filepath.Join(targetRoot, "target-keychain")
targetConfig := filepath.Join(targetRoot, ".dws")
t.Setenv(keychain.StorageDirEnv, targetKeychain)
t.Setenv("DWS_CONFIG_DIR", targetConfig)
importCmd := NewRootCommand()
importCmd.SetOut(&bytes.Buffer{})
importCmd.SetErr(&bytes.Buffer{})
importCmd.SetArgs([]string{"auth", "import", "--input", inputPath, "--base64"})
if err := importCmd.Execute(); err != nil {
t.Fatalf("auth import --base64 error = %v", err)
}
loaded, err := authpkg.LoadTokenData(targetConfig)
if err != nil {
t.Fatalf("LoadTokenData() after CLI import error = %v", err)
}
if loaded.RefreshToken != original.RefreshToken {
t.Fatalf("refresh token = %q, want %q", loaded.RefreshToken, original.RefreshToken)
}
if !loaded.IsRefreshTokenValid() {
t.Fatal("refresh token should remain valid after CLI import")
}
}
func TestAuthImportRequiresForceWhenPopulated(t *testing.T) {
t.Setenv(keychain.DisableKeychainEnv, "1")
root := t.TempDir()
configDir := filepath.Join(root, ".dws")
t.Setenv(keychain.StorageDirEnv, filepath.Join(root, "keychain"))
t.Setenv("DWS_CONFIG_DIR", configDir)
if err := authpkg.SaveTokenData(configDir, &authpkg.TokenData{
AccessToken: "existing",
RefreshToken: "existing-refresh",
RefreshExpAt: time.Now().Add(24 * time.Hour),
}); err != nil {
t.Fatalf("SaveTokenData() error = %v", err)
}
bundlePath := filepath.Join(root, "bundle.tar.gz")
if err := os.WriteFile(bundlePath, []byte("not-a-real-bundle"), 0o600); err != nil {
t.Fatalf("write bundle stub error = %v", err)
}
importCmd := NewRootCommand()
var stderr bytes.Buffer
importCmd.SetOut(&bytes.Buffer{})
importCmd.SetErr(&stderr)
importCmd.SetArgs([]string{"auth", "import", "--input", bundlePath})
err := importCmd.Execute()
if err == nil {
t.Fatal("auth import without --force should fail when auth exists")
}
var appErr *apperrors.Error
if !errors.As(err, &appErr) || appErr.Category != apperrors.CategoryValidation {
t.Fatalf("expected validation error, got %T: %v", err, err)
}
if !strings.Contains(err.Error(), "--force") {
t.Fatalf("error = %v, want --force hint", err)
}
}
func TestAuthStatusRefreshFailureLeavesStoredTokenIntact(t *testing.T) {
// Isolate keychain storage to a per-test directory so the saved
// token can't leak into other test packages running in parallel.
+22 -1
View File
@@ -210,6 +210,25 @@ func shouldUseDirectRuntime(invocation executor.Invocation) bool {
}
}
// directRuntimeToolEndpoint returns the MCP endpoint owned by the server
// whose toolOverrides registered this tool name. Used to correct catalog
// lookups when two envelope servers share the same cli.command and the
// per-product endpoint map collides (see runner.go cross-check).
func directRuntimeToolEndpoint(toolName string) (string, bool) {
toolName = strings.TrimSpace(toolName)
if toolName == "" {
return "", false
}
dynamicMu.RLock()
te := dynamicToolEndpoints
dynamicMu.RUnlock()
if te == nil {
return "", false
}
endpoint, ok := te[toolName]
return endpoint, ok && strings.TrimSpace(endpoint) != ""
}
func directRuntimeEndpoint(productID, toolName string) (string, bool) {
// Priority 0: env-var override always wins (DINGTALK_<PRODUCT>_MCP_URL).
normalized := normalizeDirectRuntimeProductID(productID)
@@ -310,7 +329,9 @@ func AppendDynamicServer(server market.ServerDescriptor) {
}
cmd := strings.TrimSpace(server.CLI.Command)
if cmd != "" && cmd != id && endpoint != "" {
dynamicEndpoints[cmd] = endpoint
if _, exists := dynamicEndpoints[cmd]; !exists {
dynamicEndpoints[cmd] = endpoint
}
dynamicProducts[cmd] = true
}
for _, alias := range server.CLI.Aliases {
@@ -270,6 +270,68 @@ func TestDirectRuntimeEndpoint_ProductLevelWinsOverConflictingToolLevel(t *testi
}
}
// --- Command field first-writer-wins regression test ---
//
// When two plugins declare the same CLI.Command but different CLI.ID values,
// AppendDynamicServer must NOT let the second registration overwrite the
// command → endpoint mapping established by the first. The fix uses a simple
// "if not exists" guard on dynamicEndpoints[cmd].
const (
testFirstEndpoint = "https://mcp-gw.dingtalk.com/server/first-plugin-hash"
testSecondEndpoint = "https://mcp-gw.dingtalk.com/server/second-plugin-hash"
)
func firstPluginDescriptor() market.ServerDescriptor {
return market.ServerDescriptor{
Endpoint: testFirstEndpoint,
CLI: market.CLIOverlay{
ID: "plugin-alpha",
Command: "shared-cmd",
},
}
}
func secondPluginDescriptor() market.ServerDescriptor {
return market.ServerDescriptor{
Endpoint: testSecondEndpoint,
CLI: market.CLIOverlay{
ID: "plugin-beta",
Command: "shared-cmd",
},
}
}
// TestAppendDynamicServer_CommandEndpointFirstWriterWins verifies that when
// two plugins declare the same Command (but different IDs), only the first
// registration takes effect for the command → endpoint mapping. The second
// plugin's own id-based endpoint is unaffected.
func TestAppendDynamicServer_CommandEndpointFirstWriterWins(t *testing.T) {
withCleanDynamicRegistry(t)
AppendDynamicServer(firstPluginDescriptor())
AppendDynamicServer(secondPluginDescriptor())
// The command "shared-cmd" must resolve to the first plugin's endpoint.
assertEndpoint(t, "shared-cmd", "", testFirstEndpoint)
// Each plugin's own id-based endpoint is always unconditionally written.
assertEndpoint(t, "plugin-alpha", "", testFirstEndpoint)
assertEndpoint(t, "plugin-beta", "", testSecondEndpoint)
// Command must appear in dynamicProducts (discovery) regardless.
ids := DirectRuntimeProductIDs()
if !ids["shared-cmd"] {
t.Fatal("shared-cmd not found in DirectRuntimeProductIDs()")
}
if !ids["plugin-alpha"] {
t.Fatal("plugin-alpha not found in DirectRuntimeProductIDs()")
}
if !ids["plugin-beta"] {
t.Fatal("plugin-beta not found in DirectRuntimeProductIDs()")
}
}
// TestDirectRuntimeEndpoint_ToolLevelFallbackWhenProductUnknown verifies that
// tool-level routing still works as a fallback when productID is empty or has
// no registered endpoint (the original design intent for tool-level Priority 1).
+3 -4
View File
@@ -22,7 +22,6 @@ import (
authpkg "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/auth"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cache"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cli"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/market"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/output"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/upgrade"
@@ -190,7 +189,7 @@ func doctorCheckNetwork(ctx context.Context, w io.Writer, jsonOut bool, timeout
fmt.Fprint(w, "检查网络连通性... ")
}
baseURL := cli.DefaultMarketBaseURL
baseURL := config.GetMCPBaseURL()
httpClient := &http.Client{Timeout: timeout}
client := market.NewClient(baseURL, httpClient)
@@ -205,7 +204,7 @@ func doctorCheckNetwork(ctx context.Context, w io.Writer, jsonOut bool, timeout
r := checkResult{
Name: "network",
Status: statusFail,
Message: fmt.Sprintf("mcp.dingtalk.com 不可达: %v", err),
Message: fmt.Sprintf("%s 不可达: %v", baseURL, err),
Hint: "请检查网络连接或代理设置",
}
if !jsonOut {
@@ -217,7 +216,7 @@ func doctorCheckNetwork(ctx context.Context, w io.Writer, jsonOut bool, timeout
r := checkResult{
Name: "network",
Status: statusPass,
Message: fmt.Sprintf("mcp.dingtalk.com 可达 (延迟 %dms)", latency.Milliseconds()),
Message: fmt.Sprintf("%s 可达 (延迟 %dms)", baseURL, latency.Milliseconds()),
}
if !jsonOut {
printCheckResult(w, r)
+32 -2
View File
@@ -32,8 +32,12 @@ func TestFlagErrorWithSuggestions_authStructured(t *testing.T) {
if !stderrors.As(err, &ae) {
t.Fatalf("want *apperrors.Error, got %T", err)
}
if ae.Message != orig.Error() {
t.Fatalf("Message = %q, want %q", ae.Message, orig.Error())
if !strings.Contains(ae.Message, orig.Error()) {
t.Fatalf("Message = %q, want to contain %q", ae.Message, orig.Error())
}
// 尾部 hint:所有 flag 解析错误的 Message 都应以 See '<cmd> --help' for usage. 结尾
if !strings.HasSuffix(ae.Message, "See 'login --help' for usage.") {
t.Fatalf("Message tail = %q, want suffix See 'login --help' for usage.", ae.Message)
}
if ae.Reason != "unknown_flag" {
t.Fatalf("Reason = %q, want unknown_flag", ae.Reason)
@@ -72,4 +76,30 @@ func TestFlagErrorWithSuggestions_unknownFlagHintAndFlags(t *testing.T) {
if len(ae.AvailableFlags) != 1 || ae.AvailableFlags[0] != "start" {
t.Fatalf("AvailableFlags = %v, want [start]", ae.AvailableFlags)
}
// 尾部 hint 验证:非 alias 路径(SuggestFlagFix 命中)同样应带 See '... --help' for usage.
if !strings.HasSuffix(ae.Message, "See 'list --help' for usage.") {
t.Fatalf("Message tail = %q, want suffix See 'list --help' for usage.", ae.Message)
}
}
// TestFlagErrorWithSuggestions_fallbackTailHint 验证 fallback 路径(非 unknown flag 类错误,
// 如 missing required flag / ambiguous shorthand)也带尾部 See '<cmd> --help' for usage.
// 这是 wukong / docker / kubectl 的通用 UX——任何 flag 解析错误都给用户一条 help 入口。
func TestFlagErrorWithSuggestions_fallbackTailHint(t *testing.T) {
t.Parallel()
cmd := &cobra.Command{Use: "send", Run: func(*cobra.Command, []string) {}}
orig := fmt.Errorf("required flag(s) \"to\" not set")
err := flagErrorWithSuggestions(cmd, orig)
// fallback 路径返回 plain error(非 *apperrors.Error),保持原 exit code 行为
var ae *apperrors.Error
if stderrors.As(err, &ae) {
t.Fatalf("fallback path should return plain error, got *apperrors.Error: %v", err)
}
msg := err.Error()
if !strings.Contains(msg, orig.Error()) {
t.Fatalf("err = %q, want to contain orig %q", msg, orig.Error())
}
if !strings.HasSuffix(msg, "See 'send --help' for usage.") {
t.Fatalf("err tail = %q, want suffix See 'send --help' for usage.", msg)
}
}
-1
View File
@@ -56,7 +56,6 @@ func TestRootCommandDoesNotInjectPatchedHelpCommands(t *testing.T) {
root := NewRootCommand()
for _, path := range []string{
"doc upload",
"chat message list-topic-replies",
"minutes list all",
} {
+10 -7
View File
@@ -51,7 +51,14 @@ func newLegacyPublicCommands(ctx context.Context, runner executor.Runner) []*cob
dynamicCmds := loadDynamicCommands(ctx, runner)
helperCmds := helpers.NewPublicCommands(runner)
return mergeTopLevelCommands(pickCommands(dynamicCmds, helperCmds))
merged := mergeTopLevelCommands(pickCommands(dynamicCmds, helperCmds))
// Post-merge product hooks: tasks the envelope cannot express on its
// own (e.g. dual-role group+leaf semantics for deprecated aliases).
// Keep each hook narrowly scoped to one product so the open-source
// command surface remains predictable from the envelope alone.
helpers.AttachReportLegacyInboxAlias(merged, runner)
helpers.AttachReportListReadableEnrichment(merged, runner)
return merged
}
// pickCommands returns the union of dynamic and helpers commands. For
@@ -211,11 +218,7 @@ func loadDynamicCommands(ctx context.Context, runner executor.Runner) []*cobra.C
if edURL := strings.TrimSpace(edition.Get().DiscoveryURL); edURL != "" {
slog.Info("loadDynamicCommands: sync discovery fetch", "partition", partition, "url", edURL)
} else {
baseURL := cli.DefaultMarketBaseURL
if discoveryBaseURLOverride != "" {
baseURL = discoveryBaseURLOverride
}
slog.Info("loadDynamicCommands: sync market catalog fetch", "partition", partition, "base_url", baseURL)
slog.Info("loadDynamicCommands: sync market catalog fetch", "partition", partition, "base_url", DiscoveryBaseURL())
}
}
fetchStart := time.Now()
@@ -453,7 +456,7 @@ func DiscoveryBaseURL() string {
if discoveryBaseURLOverride != "" {
return discoveryBaseURLOverride
}
return cli.DefaultMarketBaseURL
return config.GetMCPBaseURL()
}
// ipv4HTTPClient returns an HTTP client that forces IPv4 connections with
+2 -2
View File
@@ -359,7 +359,7 @@ func TestLoadDynamicCommandsDoesNotSynchronouslyFetchDetailMetadata(t *testing.T
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case r.URL.Path == "/cli/discovery/apis":
case r.URL.Path == "/cli/discovery/apis/bamboo":
payload := map[string]any{
"metadata": map[string]any{"count": 2, "nextCursor": ""},
"servers": []any{
@@ -433,7 +433,7 @@ func TestLoadDynamicCommandsDoesNotSynchronouslyFetchDetailMetadataWhenRegistryT
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case r.URL.Path == "/cli/discovery/apis":
case r.URL.Path == "/cli/discovery/apis/bamboo":
_ = json.NewEncoder(w).Encode(map[string]any{
"metadata": map[string]any{"count": 2, "nextCursor": ""},
"servers": []any{
+17 -2
View File
@@ -14,6 +14,7 @@
package app
import (
"bytes"
"context"
"encoding/json"
stderrors "errors"
@@ -229,7 +230,7 @@ func enrichPATErrorWithOpenBrowser(raw string, openBrowser bool) string {
}
data["openBrowser"] = openBrowser
encoded, err := json.Marshal(payload)
encoded, err := marshalSingleLineJSONNoHTMLEscape(payload)
if err != nil {
return raw
}
@@ -595,7 +596,7 @@ func enrichPATErrorForHostControl(raw string) string {
apperrors.ApplyHostMutations(payload)
// stderr JSON MUST be single-line.
encoded, err := json.Marshal(payload)
encoded, err := marshalSingleLineJSONNoHTMLEscape(payload)
if err != nil {
return raw
}
@@ -636,6 +637,20 @@ func buildPATScopeJSON(scopeErr *PatScopeError, includeHostControl bool) string
return string(b)
}
func marshalSingleLineJSONNoHTMLEscape(v any) ([]byte, error) {
var buf bytes.Buffer
enc := json.NewEncoder(&buf)
enc.SetEscapeHTML(false)
if err := enc.Encode(v); err != nil {
return nil, err
}
out := buf.Bytes()
if len(out) > 0 && out[len(out)-1] == '\n' {
out = out[:len(out)-1]
}
return out, nil
}
// pollPatDeviceFlow polls the PAT device flow status endpoint until a terminal
// state (APPROVED/REJECTED/EXPIRED) is reached or the context is cancelled.
// Returns the final status string and the authCode (non-empty only on APPROVED).
+43 -5
View File
@@ -590,6 +590,29 @@ func makePATErrorJSONWithURI(flowID, clientID, uri string) string {
return string(data)
}
func TestEnrichPATErrorWithOpenBrowserKeepsAuthorizationURLAmpersandReadable(t *testing.T) {
rawURI := "https://open-dev.dingtalk.com/fe/old?hash=%23%2FpersonalAuthorization%3FflowId%3Dflow-copy%26userCode%3DQZYH-D64W#/personalAuthorization?flowId=flow-copy&userCode=QZYH-D64W"
raw := makePATErrorJSONWithURI("flow-copy", "test-client-id", rawURI)
out := enrichPATErrorWithOpenBrowser(raw, true)
if strings.Contains(out, `\u0026`) {
t.Fatalf("enriched PAT JSON should keep URL ampersands readable for mobile copy/linkify, got: %s", out)
}
if !strings.Contains(out, "&userCode=QZYH-D64W") {
t.Fatalf("enriched PAT JSON missing readable authorization URL separator, got: %s", out)
}
var payload map[string]any
if err := json.Unmarshal([]byte(out), &payload); err != nil {
t.Fatalf("json.Unmarshal(enriched PAT payload) error = %v\nraw=%s", err, out)
}
data, _ := payload["data"].(map[string]any)
if got, _ := data["authorizationUrl"].(string); got != rawURI {
t.Fatalf("data.authorizationUrl = %q, want %q", got, rawURI)
}
}
func TestHandlePatAuthCheck_Approved(t *testing.T) {
t.Setenv(authpkg.AgentCodeEnv, "")
server, configDir := setupHandlePATServer(t, "APPROVED", "test-auth-code")
@@ -624,7 +647,7 @@ func TestHandlePatAuthCheck_Approved(t *testing.T) {
if !retryHasKey {
t.Fatal("expected retry context to have patRetryingKey")
}
if _, err := os.Stat(filepath.Join(configDir, "app.json")); err != nil {
if _, err := os.Stat(authpkg.GetAppConfigPath(configDir)); err != nil {
t.Fatalf("expected approved PAT flow to persist app.json, stat error = %v", err)
}
// Verify SetClientIDFromMCP was called with the PAT response clientId.
@@ -700,7 +723,7 @@ func TestHandlePatAuthCheck_HostControlledFlowIDPassthrough(t *testing.T) {
if got := strings.TrimSpace(buf.String()); got != "" {
t.Fatalf("expected no human-readable output in host mode, got %q", got)
}
if _, err := os.Stat(filepath.Join(tmpDir, "app.json")); !os.IsNotExist(err) {
if _, err := os.Stat(authpkg.GetAppConfigPath(tmpDir)); !os.IsNotExist(err) {
t.Fatalf("host-owned PAT must not persist shared app.json, stat error = %v", err)
}
@@ -759,7 +782,7 @@ func TestHandlePatAuthCheck_HostControlledEmptyFlowID_StillReturnsContract(t *te
if got := strings.TrimSpace(buf.String()); got != "" {
t.Fatalf("expected no human-readable output in host mode, got %q", got)
}
if _, err := os.Stat(filepath.Join(tmpDir, "app.json")); !os.IsNotExist(err) {
if _, err := os.Stat(authpkg.GetAppConfigPath(tmpDir)); !os.IsNotExist(err) {
t.Fatalf("host-owned PAT must not persist shared app.json, stat error = %v", err)
}
patOut, ok := err.(*apperrors.PATError)
@@ -855,7 +878,7 @@ func TestHandlePatAuthCheck_JSONModeReturnsStructuredPATErrorWithoutRetry(t *tes
if got := strings.TrimSpace(buf.String()); got != "" {
t.Fatalf("expected no human-readable output in json PAT mode, got %q", got)
}
if _, err := os.Stat(filepath.Join(tmpDir, "app.json")); !os.IsNotExist(err) {
if _, err := os.Stat(authpkg.GetAppConfigPath(tmpDir)); !os.IsNotExist(err) {
t.Fatalf("json PAT mode must not persist shared app.json, stat error = %v", err)
}
@@ -918,7 +941,7 @@ func TestHandlePatAuthCheck_JSONModeCanOpenBrowserWithoutTextOutput(t *testing.T
if got := strings.TrimSpace(buf.String()); got != "" {
t.Fatalf("expected no human-readable output in json PAT mode, got %q", got)
}
if _, err := os.Stat(filepath.Join(tmpDir, "app.json")); !os.IsNotExist(err) {
if _, err := os.Stat(authpkg.GetAppConfigPath(tmpDir)); !os.IsNotExist(err) {
t.Fatalf("json PAT mode must not persist shared app.json, stat error = %v", err)
}
if opened != rawURI {
@@ -1082,6 +1105,21 @@ func TestEnrichPATErrorForHostControl_SingleLineOutput(t *testing.T) {
}
}
func TestEnrichPATErrorForHostControlKeepsAuthorizationURLAmpersandReadable(t *testing.T) {
t.Setenv(authpkg.AgentCodeEnv, "agt-sales")
t.Setenv("DINGTALK_AGENT", "sales-copilot")
raw := `{"success":false,"code":"PAT_HIGH_RISK_NO_PERMISSION","data":{"flowId":"flow-host","desc":"授权","uri":"https://open-dev.dingtalk.com/fe/old?hash=%23%2FpersonalAuthorization%3FflowId%3Dflow-host%26userCode%3DQZYH-D64W#/personalAuthorization?flowId=flow-host&userCode=QZYH-D64W"}}`
out := enrichPATErrorForHostControl(raw)
if strings.Contains(out, `\u0026`) {
t.Fatalf("host PAT JSON should keep URL ampersands readable for mobile copy/linkify, got: %s", out)
}
if !strings.Contains(out, "&userCode=QZYH-D64W") {
t.Fatalf("host PAT JSON missing readable authorization URL separator, got: %s", out)
}
}
// TestBuildPATScopeHostJSON_SingleLineOutput mirrors the above regression
// for the scope-error branch (PAT_SCOPE_AUTH_REQUIRED emission).
func TestBuildPATScopeHostJSON_SingleLineOutput(t *testing.T) {
+36 -6
View File
@@ -115,8 +115,18 @@ func isUnknownCommandError(err error) bool {
}
// flagErrorWithSuggestions provides helpful suggestions for common flag mistakes.
//
// 所有 flag 解析错误都会在 message 末尾追加 "See '<CommandPath> --help' for usage.",
// 与 docker / kubectl / gh / wukong CLI 的 UX 一致,方便用户/agent 复制完整命令查 help。
// 装在 root 的 FlagErrorFunc 通过 cobra 的 parent fallback 机制覆盖全命令树
// (cobra.Command.FlagErrorFunc 沿 c.parent 递归向上查找)。
func flagErrorWithSuggestions(cmd *cobra.Command, err error) error {
errMsg := err.Error()
// 尾部 hint:换行 + See '...' for usage.
// JSON 输出时 \n 会被序列化为字面 \n,文本输出时换行;
// 无论哪种格式,子串 "--help' for usage." 都可被检索到。
tail := fmt.Sprintf("\nSee '%s --help' for usage.", cmd.CommandPath())
msgWithTail := errMsg + tail
// Common flag aliases and suggestions
suggestions := map[string]string{
@@ -135,7 +145,7 @@ func flagErrorWithSuggestions(cmd *cobra.Command, err error) error {
for flag, suggestion := range suggestions {
if strings.Contains(errMsg, "unknown flag: "+flag) {
return apperrors.NewValidation(
errMsg,
msgWithTail,
apperrors.WithHint(suggestion),
apperrors.WithReason("unknown_flag"),
apperrors.WithCause(err),
@@ -149,7 +159,7 @@ func flagErrorWithSuggestions(cmd *cobra.Command, err error) error {
fix := cmdutil.SuggestFlagFix(cmd, err)
if fix.Suggestion != "" {
return apperrors.NewValidation(
errMsg,
msgWithTail,
apperrors.WithHint(fix.Suggestion),
apperrors.WithReason("unknown_flag"),
apperrors.WithCause(err),
@@ -159,7 +169,10 @@ func flagErrorWithSuggestions(cmd *cobra.Command, err error) error {
}
}
return err
// Fallback:未命中已知别名 / SuggestFlagFix 未给建议的 flag 解析错误
// (missing required / ambiguous / unknown shorthand 等),仍包尾部 hint,
// 行为对齐 wukong / docker / kubectl。
return fmt.Errorf("%s%s", errMsg, tail)
}
func printExecutionError(root *cobra.Command, stdout, stderr io.Writer, err error) error {
@@ -267,6 +280,7 @@ func NewRootCommandWithEngine(rootCtx context.Context, engine *pipeline.Engine)
root := &cobra.Command{
Use: "dws",
Short: "DWS CLI",
Long: `提示: 如果遇到能力缺失、命令报错、新功能未注册、或无法完成任务, 请先用 'dws upgrade' 升级到最新版本后再试. 钉钉 OpenAPI 和 dws CLI 持续迭代, 新能力和 bugfix 会先在新版本上线.`,
Args: cobra.NoArgs,
SilenceErrors: true,
SilenceUsage: true,
@@ -1494,22 +1508,38 @@ func registerStdioServer(p *plugin.Plugin, sc plugin.StdioServerClient, runner e
}
// discoverStdioTools performs the blocking Initialize + ListTools handshake
// on a stdio MCP subprocess. Returns nil on any error (logged at Warn level).
// on a stdio MCP subprocess. Returns nil on any error (logged at Debug level).
// The default 2s budget comfortably accommodates Python/Node runtimes whose
// interpreter + dependency load dominates the first response. Operators with
// heavier startup chains can relax further via DWS_PLUGIN_COLD_TIMEOUT.
//
// A handshake failure here is an EXPECTED, benign outcome for an optional local
// plugin: e.g. the conference plugin reports "本地服务未就绪" whenever the
// DingTalk desktop client isn't running, which is the common case for anyone
// not actively recording a meeting. Discovery simply yields no tools and the
// run proceeds — commands that ship toolOverrides still register up-front via
// registerStdioServerFromOverlay (Phase A), so availability is unaffected.
//
// These run during command-tree construction (NewRootCommandWithEngine), which
// happens BEFORE PersistentPreRunE applies --debug/--verbose via
// configureLogLevel. So a Warn here printed to stderr on EVERY invocation
// regardless of flags, polluting output and misleading callers into treating it
// as the cause of an unrelated command error (e.g. an auth or PARAM_ERROR from a
// completely different server). Logging at Debug keeps the discovery miss out of
// normal output; surfacing it would require configuring the log level before the
// tree is built, which we deliberately avoid this close to release.
func discoverStdioTools(p *plugin.Plugin, sc plugin.StdioServerClient, timeouts pluginColdTimeouts) []transport.ToolDescriptor {
ctx, cancel := context.WithTimeout(context.Background(), timeouts.stdio)
defer cancel()
if _, err := sc.Client.Initialize(ctx); err != nil {
slog.Warn("plugin: stdio initialize failed",
slog.Debug("plugin: stdio initialize failed",
"plugin", p.Manifest.Name, "server", sc.Key, "error", err)
return nil
}
toolsResult, err := sc.Client.ListTools(ctx)
if err != nil {
slog.Warn("plugin: stdio ListTools failed",
slog.Debug("plugin: stdio ListTools failed",
"plugin", p.Manifest.Name, "server", sc.Key, "error", err)
return nil
}
+2 -2
View File
@@ -24,7 +24,7 @@ func TestCacheRefreshClearsExistingCachesAndSkipsCLISkippedServers(t *testing.T)
var srv *httptest.Server
srv = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/cli/discovery/apis":
case "/cli/discovery/apis/bamboo":
_ = json.NewEncoder(w).Encode(market.ListResponse{
Metadata: market.ListMetadata{Count: 2},
Servers: []market.ServerEnvelope{
@@ -146,7 +146,7 @@ func TestCacheRefreshHonorsEditionDiscoveryURL(t *testing.T) {
},
},
})
case "/cli/discovery/apis":
case "/cli/discovery/apis/bamboo":
marketHits.Add(1)
http.Error(w, "market endpoint must not be called when edition DiscoveryURL is set", http.StatusNotFound)
default:
+2 -2
View File
@@ -351,8 +351,8 @@ func TestNestedShortHelpDoesNotRequirePINOrLogin(t *testing.T) {
if err := root.Execute(); err != nil {
t.Fatalf("Execute(devdoc article search -h) error = %v", err)
}
if !strings.Contains(out.String(), "devdoc/search") {
t.Fatalf("nested short help output missing command title:\n%s", out.String())
if !strings.Contains(out.String(), "搜索开放平台文档") || !strings.Contains(out.String(), "dws devdoc article search") {
t.Fatalf("nested short help output missing command help:\n%s", out.String())
}
}
+10
View File
@@ -82,6 +82,16 @@ func renderRootHelp(root *cobra.Command) {
_, _ = fmt.Fprintln(w)
}
_, _ = fmt.Fprintln(w, `Use "dws <service> --help" for more information about a discovered MCP service or "dws <command> --help" for utility commands.`)
// Render root.Long after the command list so agents see the upgrade
// hint (or any other root-level guidance) after browsing all available
// commands and concluding none of them fit. Cobra's default help template
// would render Long automatically; the custom SetHelpFunc above replaces
// it and dropped this, so we restore it explicitly here.
if long := strings.TrimSpace(root.Long); long != "" {
_, _ = fmt.Fprintln(w)
_, _ = fmt.Fprintln(w, long)
}
}
// resolveVisibleProducts returns the set of top-level product IDs that should
+24 -1
View File
@@ -88,6 +88,8 @@ const (
envDingtalkTraceID = "DINGTALK_TRACE_ID"
envDingtalkSessionID = "DINGTALK_SESSION_ID"
envDingtalkMessageID = "DINGTALK_MESSAGE_ID"
envDWSSessionID = "DWS_SESSION_ID"
envRewindSessionID = "REWIND_SESSION_ID"
// Environment variables for third-party channel integration
envDWSChannel = "DWS_CHANNEL"
@@ -162,6 +164,7 @@ func (r *runtimeRunner) Run(ctx context.Context, invocation executor.Invocation)
if r.loader == nil || r.transport == nil {
return r.fallback.Run(ctx, invocation)
}
r.transport.ExtraHeaders = resolveIdentityHeaders()
// Mock mode: skip catalog validation, use a placeholder endpoint.
if r.globalFlags != nil && r.globalFlags.Mock {
@@ -219,6 +222,19 @@ func (r *runtimeRunner) Run(ctx context.Context, invocation executor.Invocation)
if override, ok := productEndpointOverride(invocation.CanonicalProduct); ok {
endpoint = override
}
// Multi-server tool-name authority correction.
//
// When two envelope servers share the same cli.command (e.g. group-chat
// and im both publish `dws chat ...`), the endpoints[cmd] map in
// registerDynamicServer is the second-writer wins, and catalog FindProduct
// may pick the wrong product's Endpoint for a tool whose real owner is
// a different server. Cross-check the canonical tool→endpoint map: when
// the per-tool endpoint exists and differs from the per-product endpoint
// catalog returned, trust the tool-owner endpoint (the server that
// actually declares this tool in its toolOverrides).
if toolEndpoint, ok := directRuntimeToolEndpoint(invocation.Tool); ok && toolEndpoint != "" && toolEndpoint != endpoint {
endpoint = toolEndpoint
}
return r.executeInvocation(ctx, endpoint, invocation)
}
@@ -664,11 +680,18 @@ func resolveIdentityHeaders() map[string]string {
// open-source edition pins to edition.DefaultOSSClawType via the
// MergeHeaders hook below) and it does NOT influence the host-owned
// PAT decision (driven solely by DINGTALK_DWS_AGENTCODE).
sessionID := os.Getenv(envDingtalkSessionID)
if sessionID == "" {
sessionID = os.Getenv(envDWSSessionID)
}
if sessionID == "" {
sessionID = os.Getenv(envRewindSessionID)
}
envHeaders := map[string]string{
"x-dingtalk-agent": os.Getenv(envDingtalkAgent),
"x-dingtalk-dws-agent-code": strings.TrimSpace(os.Getenv(authpkg.AgentCodeEnv)),
"x-dingtalk-trace-id": os.Getenv(envDingtalkTraceID),
"x-dingtalk-session-id": os.Getenv(envDingtalkSessionID),
"x-dingtalk-session-id": sessionID,
"x-dingtalk-message-id": os.Getenv(envDingtalkMessageID),
}
for k, v := range envHeaders {
+24
View File
@@ -328,6 +328,30 @@ func TestResolveIdentityHeadersForwardsAgentCode(t *testing.T) {
}
}
func TestResolveIdentityHeadersSessionEnvPriority(t *testing.T) {
setupRuntimeCommandTest(t)
t.Setenv(envDingtalkSessionID, "ding-session")
t.Setenv(envDWSSessionID, "dws-session")
t.Setenv(envRewindSessionID, "rewind-session")
headers := resolveIdentityHeaders()
if got := headers["x-dingtalk-session-id"]; got != "ding-session" {
t.Fatalf("x-dingtalk-session-id = %q, want DINGTALK_SESSION_ID", got)
}
t.Setenv(envDingtalkSessionID, "")
headers = resolveIdentityHeaders()
if got := headers["x-dingtalk-session-id"]; got != "dws-session" {
t.Fatalf("x-dingtalk-session-id = %q, want DWS_SESSION_ID", got)
}
t.Setenv(envDWSSessionID, "")
headers = resolveIdentityHeaders()
if got := headers["x-dingtalk-session-id"]; got != "rewind-session" {
t.Fatalf("x-dingtalk-session-id = %q, want REWIND_SESSION_ID", got)
}
}
func TestDocDownloadPreflightRejectsAXLSBeforeDownloadPAT(t *testing.T) {
setupRuntimeCommandTest(t)
t.Setenv("DWS_ALLOW_HTTP_ENDPOINTS", "1")
+65 -9
View File
@@ -24,6 +24,7 @@ import (
"net/url"
"os"
"path/filepath"
"sort"
"strings"
"time"
@@ -85,24 +86,80 @@ type CliSkillDTO struct {
// agentSkillPaths maps target names to their relative skill installation paths.
// These paths are relative to the user's home directory.
//
// Source of truth for both `dws skill install <skillId> <target>` and
// `dws skill setup --target <name>`. Every entry in skillSetupAgentHomes
// (skill_setup.go) MUST have a matching path value here — enforced by
// TestAgentSkillPathsCoversSetupHomes.
var agentSkillPaths = map[string]string{
// `agents` is the generic-agent sentinel: install scripts and `setup`
// special-case ~/.agents/skills as a no-checks-required fallback so a
// fresh machine without any IDE/agent registry still gets skills.
"agents": ".agents/skills",
"qoder": ".qoder/skills",
"claude": ".claude/skills",
"cursor": ".cursor/skills",
"codex": ".codex/skills",
"opencode": filepath.Join(".config", "opencode", "skills"),
// IDE / agent registries also probed by `dws skill setup --target all`.
"gemini": ".gemini/skills",
"github": ".github/skills",
"windsurf": ".windsurf/skills",
"augment": ".augment/skills",
"cline": ".cline/skills",
"amp": ".amp/skills",
"kiro": ".kiro/skills",
"trae": ".trae/skills",
"openclaw": ".openclaw/skills",
"hermes": ".hermes/skills",
}
// supportedTargets returns a comma-separated list of supported targets.
// supportedTargets returns a sorted, comma-separated list of supported
// targets. Sorted so help text and error messages stay stable across runs
// (Go map iteration order is intentionally randomized).
func supportedTargets() string {
targets := make([]string, 0, len(agentSkillPaths)+1)
for target := range agentSkillPaths {
targets = append(targets, target)
}
sort.Strings(targets)
targets = append(targets, ".")
return strings.Join(targets, ", ")
}
// longestAgentTargetName returns the character count of the longest target
// name in agentSkillPaths. Used by --help formatting to keep the "." entry
// vertically aligned with named targets.
func longestAgentTargetName() int {
n := 0
for name := range agentSkillPaths {
if len(name) > n {
n = len(name)
}
}
return n
}
// formatAgentSkillPathsForHelp renders agentSkillPaths as an aligned
// " <name> -> ~/<path>" block, sorted by name, for use in --help output.
// Keeps `dws skill install --help` in sync with the map without hand-edits.
func formatAgentSkillPathsForHelp() string {
names := make([]string, 0, len(agentSkillPaths))
maxWidth := 0
for n := range agentSkillPaths {
names = append(names, n)
if len(n) > maxWidth {
maxWidth = len(n)
}
}
sort.Strings(names)
var b strings.Builder
for _, n := range names {
fmt.Fprintf(&b, " %-*s -> ~/%s/\n", maxWidth, n, agentSkillPaths[n])
}
return b.String()
}
func buildSkillCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "skill",
@@ -122,6 +179,7 @@ func buildSkillCommand() *cobra.Command {
newSkillSearchCommand(),
newSkillFindHintCommand(),
newSkillAddHintCommand(),
newSkillSetupCommand(),
)
return cmd
}
@@ -179,17 +237,15 @@ func newSkillInstallCommand() *cobra.Command {
target 安装目标(必填),支持: %s
安装路径:
qoder -> ~/.qoder/skills/
claude -> ~/.claude/skills/
cursor -> ~/.cursor/skills/
codex -> ~/.codex/skills/
opencode -> ~/.config/opencode/skills/
. -> 当前目录
%s .%s -> 当前目录
示例:
dws skill install skill-123 qoder # 安装到 ~/.qoder/skills/
dws skill install skill-123 claude # 安装到 ~/.claude/skills/
dws skill install skill-123 . # 安装到当前目录`, supportedTargets()),
dws skill install skill-123 qoder # 安装到 ~/.qoder/skills/
dws skill install skill-123 . # 安装到当前目录`,
supportedTargets(),
formatAgentSkillPathsForHelp(),
strings.Repeat(" ", longestAgentTargetName()-1)),
Args: cobra.ExactArgs(2),
DisableAutoGenTag: true,
RunE: runSkillAdd,
+29 -2
View File
@@ -452,8 +452,14 @@ func TestFetchSkillDownloadInfoUnauthorized(t *testing.T) {
func TestSupportedTargets(t *testing.T) {
targets := supportedTargets()
// Should contain all predefined targets
expectedTargets := []string{"qoder", "claude", "cursor", "codex", "opencode", "."}
// Should contain all predefined targets — including the agents/* sentinel
// and the IDE/agent registries we share with skillSetupAgentHomes.
expectedTargets := []string{
"agents", "claude", "cursor", "codex", "opencode", "qoder",
"gemini", "github", "windsurf", "augment", "cline",
"amp", "kiro", "trae", "openclaw", "hermes",
".",
}
for _, expected := range expectedTargets {
if !strings.Contains(targets, expected) {
t.Errorf("supportedTargets() should contain %s, got: %s", expected, targets)
@@ -461,6 +467,27 @@ func TestSupportedTargets(t *testing.T) {
}
}
// TestAgentSkillPathsCoversSetupHomes guards against drift between
// agentSkillPaths (used by `dws skill install` and `dws skill setup
// --target <name>`) and skillSetupAgentHomes (used by `dws skill setup
// --target all` to detect candidate agent homes).
//
// Every path in skillSetupAgentHomes MUST be reachable via at least one
// entry in agentSkillPaths — otherwise `--target all` would silently
// install into agent homes that the user cannot address by name.
func TestAgentSkillPathsCoversSetupHomes(t *testing.T) {
paths := make(map[string]bool, len(agentSkillPaths))
for _, p := range agentSkillPaths {
paths[p] = true
}
for _, home := range skillSetupAgentHomes {
if !paths[home] {
t.Errorf("skillSetupAgentHomes entry %q has no matching agentSkillPaths value — "+
"add it to agentSkillPaths so users can address it via --target <name>", home)
}
}
}
func TestAgentSkillPathsCrossPlatform(t *testing.T) {
// Verify that paths use platform-appropriate separators
for target, path := range agentSkillPaths {
+647
View File
@@ -0,0 +1,647 @@
package app
import (
"errors"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
"github.com/charmbracelet/huh"
"github.com/spf13/cobra"
)
// skillSetupAgentHomes is the ordered list of agent home subdirectories
// where dws skills get installed. Mirrors install.sh / install.ps1 /
// build/npm/install.js so that `dws skill setup` and the install scripts
// agree on the install footprint.
var skillSetupAgentHomes = []string{
".agents/skills",
".claude/skills",
".cursor/skills",
".gemini/skills",
".codex/skills",
".github/skills",
".windsurf/skills",
".augment/skills",
".cline/skills",
".amp/skills",
".kiro/skills",
".trae/skills",
".openclaw/skills",
".hermes/skills",
}
const (
skillSetupModeMono = "mono"
skillSetupModeMulti = "multi"
)
func newSkillSetupCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "setup",
Short: "安装 dws 自身 skill 到 Agent 目录",
Long: `安装 dws 自身 skill 文档到 AI Agent 目录(如 ~/.claude/skills/、~/.cursor/skills/ 等)。
支持两种模式:
mono 单 skill(稳定 / 推荐)—— 总入口 SKILL.md + references/products/
multi 🧪 EXPERIMENTAL 多 skill(试验版 / Preview)—— 按产品拆 N 个独立 skill
尚未达到 stable 标准,接口、命名与跨 skill 引用可能变动;
生产前请评估,问题请提 issue 反馈
multi 模式支持按产品挑选:
-s/--skill 只装指定子 skill(可重复,短名 aitable 或全名 dingtalk-aitable 均可)
-x/--exclude 从全装里剔除指定子 skill(可重复,与 --skill 互斥)
未列出的已有 dingtalk-* skill 会保留(additive 叠加语义)
不带 --mode 时进入交互式询问;不带 --target 时铺到所有检测到的 Agent 目录。`,
Example: ` dws skill setup # 交互式
dws skill setup --mode mono --yes # 非交互装 mono
dws skill setup --mode multi --target claude # multi 全装到 ~/.claude/skills/
dws skill setup --mode multi -s aitable -s calendar # 只装 aitable + calendar
dws skill setup --mode multi -x live -x devdoc # 装其余 18 个,剔除 2 个
dws skill setup --source /path/to/repo # 显式指定 skill 源`,
DisableAutoGenTag: true,
RunE: runSkillSetup,
}
cmd.Flags().String("mode", "", "skill 模式:mono | multi(不指定则交互询问)")
cmd.Flags().String("target", "all", "目标 Agent:all | "+supportedTargets())
cmd.Flags().String("source", "", "skill 源目录(默认自动查找二进制旁边或当前目录)")
cmd.Flags().Bool("yes", false, "跳过所有确认提示")
cmd.Flags().StringSliceP("skill", "s", nil, "multi 模式:仅安装指定子 skill(可重复,接受短名 aitable 或全名 dingtalk-aitable)")
cmd.Flags().StringSliceP("exclude", "x", nil, "multi 模式:从全装中剔除指定子 skill(可重复,与 --skill 互斥)")
return cmd
}
func runSkillSetup(cmd *cobra.Command, _ []string) error {
mode, _ := cmd.Flags().GetString("mode")
target, _ := cmd.Flags().GetString("target")
source, _ := cmd.Flags().GetString("source")
autoYes, _ := cmd.Flags().GetBool("yes")
includeRaw, _ := cmd.Flags().GetStringSlice("skill")
excludeRaw, _ := cmd.Flags().GetStringSlice("exclude")
out := cmd.OutOrStdout()
errOut := cmd.ErrOrStderr()
mode, err := resolveSkillSetupMode(mode, autoYes, out)
if err != nil {
return err
}
if mode == skillSetupModeMono && (len(includeRaw) > 0 || len(excludeRaw) > 0) {
return fmt.Errorf("--skill / --exclude 仅在 --mode multi 下有效(mono 只有一个 skill,无需挑选)")
}
skillSrc, err := resolveSkillSetupSource(source, mode)
if err != nil {
return err
}
dests, err := resolveSkillSetupTargets(target, mode)
if err != nil {
return err
}
// multi 模式枚举 src 下的子 skill 名,供确认信息与安装步骤共用
var multiSkillNames []string
if mode == skillSetupModeMulti {
allMultiSkillNames, listErr := listMultiSkillNames(skillSrc)
if listErr != nil {
return listErr
}
if len(allMultiSkillNames) == 0 {
return fmt.Errorf("multi 模式下 %s 内未发现含 SKILL.md 的子目录", skillSrc)
}
filtered, filterErr := filterMultiSkillNames(allMultiSkillNames, includeRaw, excludeRaw)
if filterErr != nil {
return filterErr
}
multiSkillNames = filtered
}
if !autoYes {
ok, err := confirmSkillSetup(out, mode, skillSrc, dests, multiSkillNames)
if err != nil {
return err
}
if !ok {
fmt.Fprintln(out, "已取消。")
return nil
}
} else if mode == skillSetupModeMulti {
fmt.Fprintln(errOut, "🧪 multi 模式当前为 EXPERIMENTAL(试验版 / Preview)—— 接口与布局可能变动,稳定版请用 --mode mono")
}
var installed, skipped int
switch mode {
case skillSetupModeMono:
installed, skipped, err = installSkillToHomes(skillSrc, dests, out, errOut)
case skillSetupModeMulti:
installed, skipped, err = installMultiSkillToHomes(skillSrc, multiSkillNames, dests, out, errOut)
default:
return fmt.Errorf("内部错误:未知 mode %q", mode)
}
if err != nil {
return err
}
fmt.Fprintf(out, "\n✅ Skill 安装完成(mode=%s, installed=%d, skipped=%d)\n", mode, installed, skipped)
return nil
}
// multiSkillPrefix is the canonical prefix for every per-product skill
// bundle in skills/multi/ (e.g. dingtalk-aitable, dingtalk-calendar).
const multiSkillPrefix = "dingtalk-"
// normalizeMultiSkillName accepts either the short form (aitable) or the
// full form (dingtalk-aitable) and returns the canonical full form.
// Empty input returns "". Comparison is case-insensitive.
func normalizeMultiSkillName(name string) string {
n := strings.ToLower(strings.TrimSpace(name))
if n == "" {
return ""
}
if strings.HasPrefix(n, multiSkillPrefix) {
return n
}
return multiSkillPrefix + n
}
// filterMultiSkillNames narrows `all` by include / exclude lists.
// Semantics mirror lark-cli's `npx skills add -s lark-calendar`:
//
// - include + exclude are mutually exclusive (both → error)
// - names accept short or full form; normalized before matching
// - unknown names → error, with the available list inlined for discovery
// - both lists empty → return `all` (install everything)
// - exclude that drops every name → error (avoid silent no-op install)
//
// The caller is responsible for additive installation: install only the
// returned names, leaving any other already-installed dingtalk-* siblings
// untouched (handled by installMultiSkillToHomes which does not enumerate
// the destination).
func filterMultiSkillNames(all, include, exclude []string) ([]string, error) {
if len(include) > 0 && len(exclude) > 0 {
return nil, fmt.Errorf("--skill 与 --exclude 不能同时使用")
}
available := make(map[string]struct{}, len(all))
for _, n := range all {
available[n] = struct{}{}
}
validate := func(raw []string, flagName string) ([]string, error) {
var normalized []string
var unknown []string
seen := make(map[string]bool)
for _, r := range raw {
n := normalizeMultiSkillName(r)
if n == "" {
continue
}
if _, ok := available[n]; !ok {
unknown = append(unknown, r)
continue
}
if !seen[n] {
seen[n] = true
normalized = append(normalized, n)
}
}
if len(unknown) > 0 {
return nil, fmt.Errorf("%s 中的以下名称在 multi 源中找不到:%s\n可用列表(共 %d 个):%s",
flagName, strings.Join(unknown, ", "), len(all), strings.Join(all, ", "))
}
return normalized, nil
}
if len(include) > 0 {
names, err := validate(include, "--skill")
if err != nil {
return nil, err
}
sort.Strings(names)
return names, nil
}
if len(exclude) > 0 {
excluded, err := validate(exclude, "--exclude")
if err != nil {
return nil, err
}
excludedSet := make(map[string]bool, len(excluded))
for _, n := range excluded {
excludedSet[n] = true
}
var out []string
for _, n := range all {
if !excludedSet[n] {
out = append(out, n)
}
}
if len(out) == 0 {
return nil, fmt.Errorf("--exclude 把全部 %d 个子 skill 都剔除了,没有可装的", len(all))
}
return out, nil
}
return all, nil
}
// listMultiSkillNames returns sorted names of subdirectories under src that
// contain a SKILL.md file (i.e. valid multi-mode skill bundles).
func listMultiSkillNames(src string) ([]string, error) {
entries, err := os.ReadDir(src)
if err != nil {
return nil, fmt.Errorf("无法读取 multi skill 源目录 %s: %w", src, err)
}
var names []string
for _, e := range entries {
if !e.IsDir() {
continue
}
if _, err := os.Stat(filepath.Join(src, e.Name(), "SKILL.md")); err == nil {
names = append(names, e.Name())
}
}
sort.Strings(names)
return names, nil
}
// resolveSkillSetupMode resolves the mode either from the flag or via an
// interactive prompt. If no TTY is available and no mode was given, returns
// an error rather than silently picking a default.
func resolveSkillSetupMode(mode string, autoYes bool, out io.Writer) (string, error) {
mode = strings.ToLower(strings.TrimSpace(mode))
switch mode {
case skillSetupModeMono, skillSetupModeMulti:
return mode, nil
case "":
// fall through to interactive prompt
default:
return "", fmt.Errorf("不支持的 --mode 值: %s(可选 mono / multi)", mode)
}
if autoYes || !isInteractiveTerminal() {
fmt.Fprintln(out, "未指定 --mode,非交互环境下默认使用 mono")
return skillSetupModeMono, nil
}
var choice string
form := huh.NewForm(
huh.NewGroup(
huh.NewSelect[string]().
Title("选择 dws skill 安装模式").
Description("mono = 单 skill 入口(稳定 / 推荐)\nmulti = 按产品拆分(🧪 EXPERIMENTAL / 试验版,未达 stable,接口可能变动)").
Options(
huh.NewOption("mono — 单 skill(稳定 / 推荐)", skillSetupModeMono),
huh.NewOption("multi — 多 skill(🧪 EXPERIMENTAL · 试验版)", skillSetupModeMulti),
).
Value(&choice),
),
)
if err := form.Run(); err != nil {
return "", fmt.Errorf("交互式选择中止: %w", err)
}
return choice, nil
}
// resolveSkillSetupSource finds the local skill source directory for the
// given mode. PR 1 supports only mono; multi is reserved for a later PR
// and currently returns an error before reaching this function.
func resolveSkillSetupSource(explicit, mode string) (string, error) {
subdir := mode // "mono" or "multi"
candidates := skillSourceCandidates(explicit, subdir)
for _, c := range candidates {
if isSkillSourceRoot(c, mode) {
return c, nil
}
}
hint := strings.Join(candidates, "\n - ")
return "", fmt.Errorf("未找到 %s 模式的 skill 源目录,已尝试:\n - %s\n\n请用 --source 显式指定包含 skills/%s 的仓库根目录", mode, hint, mode)
}
// skillSourceCandidates returns the ordered list of paths to probe for a
// skill source root, given an optional explicit override and the mode
// subdir (mono or multi).
func skillSourceCandidates(explicit, subdir string) []string {
var roots []string
if explicit != "" {
// allow either repo root or already-resolved skills/<mode> dir
roots = append(roots, explicit, filepath.Join(explicit, "skills", subdir))
}
if env := strings.TrimSpace(os.Getenv("DWS_SKILL_SOURCE")); env != "" {
roots = append(roots, env, filepath.Join(env, "skills", subdir))
}
if exe, err := os.Executable(); err == nil {
exeDir := filepath.Dir(exe)
roots = append(roots,
filepath.Join(exeDir, "skills", subdir),
filepath.Join(exeDir, "..", "skills", subdir),
filepath.Join(exeDir, "..", "share", "skills", "dws"),
)
}
if wd, err := os.Getwd(); err == nil {
roots = append(roots, filepath.Join(wd, "skills", subdir))
}
// User-level cache populated by install.sh / install.ps1 / npm install.js
// from the dws-skills.zip release asset. Lets `dws skill setup` find a
// source even when the user has no source checkout on disk.
if home, err := os.UserHomeDir(); err == nil {
roots = append(roots, filepath.Join(home, ".dws", "skills", subdir))
}
return roots
}
func isSkillSourceRoot(path, mode string) bool {
if path == "" {
return false
}
switch mode {
case skillSetupModeMono:
fi, err := os.Stat(filepath.Join(path, "SKILL.md"))
return err == nil && !fi.IsDir()
case skillSetupModeMulti:
entries, err := os.ReadDir(path)
if err != nil {
return false
}
for _, e := range entries {
if e.IsDir() {
if _, err := os.Stat(filepath.Join(path, e.Name(), "SKILL.md")); err == nil {
return true
}
}
}
return false
}
return false
}
// resolveSkillSetupTargets returns the list of absolute Agent home destinations.
// If target == "all", returns every agent home whose parent directory exists.
// Otherwise returns the single matching home (whether or not it currently exists).
//
// 末段约定:
// - mono → <agent-home>/dws (单 skill,整个 src 拷成一个 dws 目录)
// - multi → <agent-home> (安装时把 src 下每个子目录拷成兄弟 skill)
func resolveSkillSetupTargets(target, mode string) ([]string, error) {
home, err := os.UserHomeDir()
if err != nil {
return nil, fmt.Errorf("无法解析用户 HOME: %w", err)
}
target = strings.ToLower(strings.TrimSpace(target))
if target == "" || target == "all" {
return detectExistingAgentHomes(home, mode), nil
}
rel, ok := agentSkillPaths[target]
if !ok {
return nil, fmt.Errorf("不支持的 --target 值: %s(可选 all, %s)", target, supportedTargets())
}
return []string{agentHomeForMode(filepath.Join(home, rel), mode)}, nil
}
// agentHomeForMode appends the mode-specific tail segment to an agent home base.
func agentHomeForMode(base, mode string) string {
if mode == skillSetupModeMulti {
return base
}
return filepath.Join(base, "dws")
}
func detectExistingAgentHomes(home, mode string) []string {
var out []string
for i, rel := range skillSetupAgentHomes {
base := filepath.Join(home, rel)
parent := filepath.Dir(base)
if i > 0 {
if _, err := os.Stat(parent); errors.Is(err, os.ErrNotExist) {
continue
}
}
out = append(out, agentHomeForMode(base, mode))
}
if len(out) == 0 {
out = append(out, agentHomeForMode(filepath.Join(home, ".agents", "skills"), mode))
}
return out
}
func confirmSkillSetup(out io.Writer, mode, src string, dests []string, multiSkillNames []string) (bool, error) {
if mode == skillSetupModeMulti {
fmt.Fprintln(out, "\n🧪 ─────────────────────────────────────────────────────────────")
fmt.Fprintln(out, " multi 模式当前为 EXPERIMENTAL(试验版 / Preview)")
fmt.Fprintln(out, " · 20 个 dingtalk-* 子 skill 跑过 verifier,可用但未达 stable")
fmt.Fprintln(out, " · 跨 skill 引用、bundle 命名、目录布局后续可能调整")
fmt.Fprintln(out, " · 不建议在生产 / 共享环境直接落地;问题请提 issue 反馈")
fmt.Fprintln(out, " 稳定版请用 --mode mono")
fmt.Fprintln(out, "🧪 ─────────────────────────────────────────────────────────────")
}
fmt.Fprintf(out, "\n📦 将安装 skill:\n mode: %s\n source: %s\n", mode, src)
if mode == skillSetupModeMulti {
fmt.Fprintf(out, " 将装 %d 个独立 skill(按子目录平铺到 <agent-home>/<skill-name>/):\n", len(multiSkillNames))
for _, n := range multiSkillNames {
fmt.Fprintf(out, " · %s\n", n)
}
}
fmt.Fprintln(out, " destinations:")
for _, d := range dests {
fmt.Fprintf(out, " - %s\n", d)
}
// 列出互斥清理:装 mode 前要把对面 mode 的残留删掉
fmt.Fprintln(out, " 互斥清理(确认后才执行):")
for _, d := range dests {
for _, victim := range mutualExclusionVictims(d, mode) {
fmt.Fprintf(out, " × 将删除 %s\n", victim)
}
}
if !isInteractiveTerminal() {
return true, nil
}
var confirm bool
form := huh.NewForm(
huh.NewGroup(
huh.NewConfirm().
Title("确认安装?").
Affirmative("继续").
Negative("取消").
Value(&confirm),
),
)
if err := form.Run(); err != nil {
return false, fmt.Errorf("确认中止: %w", err)
}
return confirm, nil
}
// mutualExclusionVictims returns the paths that should be removed before
// installing into dest under the given mode, to prevent leftover files from
// the opposite mode from co-existing.
//
// - mono dest is <agent-home>/dws → multi 残留是 <agent-home>/dingtalk-*
// - multi dest is <agent-home> → mono 残留是 <agent-home>/dws
func mutualExclusionVictims(dest, mode string) []string {
switch mode {
case skillSetupModeMono:
// dest = <agent-home>/dws → agent-home = parent
agentHome := filepath.Dir(dest)
entries, err := os.ReadDir(agentHome)
if err != nil {
return nil
}
var victims []string
for _, e := range entries {
if e.IsDir() && strings.HasPrefix(e.Name(), "dingtalk-") {
victims = append(victims, filepath.Join(agentHome, e.Name()))
}
}
sort.Strings(victims)
return victims
case skillSetupModeMulti:
// dest = <agent-home> → mono 残留是 dest/dws
monoPath := filepath.Join(dest, "dws")
if _, err := os.Stat(monoPath); err == nil {
return []string{monoPath}
}
return nil
}
return nil
}
// cleanupMutualExclusion best-effort removes the opposite-mode leftovers.
// Failures emit a warning to errOut but never abort the install.
func cleanupMutualExclusion(dest, mode string, out, errOut io.Writer) {
for _, victim := range mutualExclusionVictims(dest, mode) {
if err := os.RemoveAll(victim); err != nil {
fmt.Fprintf(errOut, " ⚠️ 互斥清理失败(继续安装) %s: %v\n", victim, err)
continue
}
fmt.Fprintf(out, " × 已清理对面模式残留 %s\n", victim)
}
}
func installSkillToHomes(src string, dests []string, out, errOut io.Writer) (installed, skipped int, err error) {
sort.Strings(dests)
for _, dest := range dests {
// 先做互斥清理:装 mono 前先把同级 dingtalk-* 子目录全部干掉
cleanupMutualExclusion(dest, skillSetupModeMono, out, errOut)
if err := os.RemoveAll(dest); err != nil {
fmt.Fprintf(errOut, " ✗ 清理失败 %s: %v\n", dest, err)
skipped++
continue
}
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
fmt.Fprintf(errOut, " ✗ 父目录创建失败 %s: %v\n", dest, err)
skipped++
continue
}
if err := copyDir(src, dest); err != nil {
fmt.Fprintf(errOut, " ✗ 拷贝失败 %s: %v\n", dest, err)
skipped++
continue
}
fmt.Fprintf(out, " ✓ %s\n", dest)
installed++
}
return installed, skipped, nil
}
// installMultiSkillToHomes installs each subdir of src (dingtalk-*) into
// dest as a sibling skill directory. installed/skipped is counted per
// (agent-home × sub-skill) pair so the user sees granular progress.
func installMultiSkillToHomes(src string, skillNames []string, dests []string, out, errOut io.Writer) (installed, skipped int, err error) {
sort.Strings(dests)
for _, dest := range dests {
// 互斥清理:装 multi 前先把 dest/dws/ 整个删除(mono 残留)
cleanupMutualExclusion(dest, skillSetupModeMulti, out, errOut)
if err := os.MkdirAll(dest, 0o755); err != nil {
fmt.Fprintf(errOut, " ✗ Agent 目录创建失败 %s: %v\n", dest, err)
skipped += len(skillNames)
continue
}
for _, name := range skillNames {
subSrc := filepath.Join(src, name)
subDest := filepath.Join(dest, name)
if err := os.RemoveAll(subDest); err != nil {
fmt.Fprintf(errOut, " ✗ 清理失败 %s: %v\n", subDest, err)
skipped++
continue
}
if err := copyDir(subSrc, subDest); err != nil {
fmt.Fprintf(errOut, " ✗ 拷贝失败 %s: %v\n", subDest, err)
skipped++
continue
}
fmt.Fprintf(out, " ✓ %s\n", subDest)
installed++
}
}
return installed, skipped, nil
}
func copyDir(src, dst string) error {
return filepath.Walk(src, func(path string, info os.FileInfo, walkErr error) error {
if walkErr != nil {
return walkErr
}
rel, err := filepath.Rel(src, path)
if err != nil {
return err
}
target := filepath.Join(dst, rel)
if info.IsDir() {
return os.MkdirAll(target, info.Mode())
}
if info.Mode()&os.ModeSymlink != 0 {
// resolve symlink target and copy the underlying file
resolved, err := os.Readlink(path)
if err != nil {
return err
}
if !filepath.IsAbs(resolved) {
resolved = filepath.Join(filepath.Dir(path), resolved)
}
return copyFileContent(resolved, target, info.Mode())
}
return copyFileContent(path, target, info.Mode())
})
}
func copyFileContent(src, dst string, mode os.FileMode) error {
if err := os.MkdirAll(filepath.Dir(dst), 0o755); err != nil {
return err
}
in, err := os.Open(src)
if err != nil {
return err
}
defer in.Close()
out, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, mode&os.ModePerm)
if err != nil {
return err
}
defer out.Close()
_, err = io.Copy(out, in)
return err
}
func isInteractiveTerminal() bool {
fi, err := os.Stdin.Stat()
if err != nil {
return false
}
return (fi.Mode() & os.ModeCharDevice) != 0
}
+559
View File
@@ -0,0 +1,559 @@
package app
import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
)
func TestSkillSetupCommandRegistered(t *testing.T) {
root := buildSkillCommand()
var found bool
for _, sub := range root.Commands() {
if sub.Name() == "setup" {
found = true
break
}
}
if !found {
t.Fatalf("dws skill setup not registered as subcommand")
}
}
func TestResolveSkillSetupModeFlagDirect(t *testing.T) {
got, err := resolveSkillSetupMode("mono", true, &bytes.Buffer{})
if err != nil || got != skillSetupModeMono {
t.Fatalf("expected mono no-error, got %q err=%v", got, err)
}
got, err = resolveSkillSetupMode("MULTI", true, &bytes.Buffer{})
if err != nil || got != skillSetupModeMulti {
t.Fatalf("expected multi case-insensitive, got %q err=%v", got, err)
}
if _, err = resolveSkillSetupMode("hybrid", true, &bytes.Buffer{}); err == nil {
t.Fatalf("expected error on invalid mode")
}
}
func TestResolveSkillSetupModeNonInteractiveDefaultsMono(t *testing.T) {
var buf bytes.Buffer
got, err := resolveSkillSetupMode("", true, &buf)
if err != nil || got != skillSetupModeMono {
t.Fatalf("non-interactive empty mode should default to mono, got %q err=%v", got, err)
}
if !strings.Contains(buf.String(), "mono") {
t.Fatalf("expected output to mention mono fallback, got %q", buf.String())
}
}
func TestResolveSkillSetupSourceFindsMonoRoot(t *testing.T) {
tmp := t.TempDir()
monoDir := filepath.Join(tmp, "skills", "mono")
if err := os.MkdirAll(monoDir, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(monoDir, "SKILL.md"), []byte("# test"), 0o644); err != nil {
t.Fatal(err)
}
got, err := resolveSkillSetupSource(tmp, skillSetupModeMono)
if err != nil {
t.Fatalf("expected to find mono source, got err=%v", err)
}
if got != monoDir {
t.Fatalf("expected %s, got %s", monoDir, got)
}
}
func TestResolveSkillSetupSourceErrorWhenMissing(t *testing.T) {
tmp := t.TempDir()
t.Setenv("DWS_SKILL_SOURCE", "")
// Isolate HOME so the ~/.dws/skills/<mode>/ fallback (added by the release
// pipeline cache work) does not pick up real cached content on the
// developer machine.
t.Setenv("HOME", t.TempDir())
_, err := resolveSkillSetupSource(tmp, skillSetupModeMono)
if err == nil {
t.Fatalf("expected error when source missing")
}
if !strings.Contains(err.Error(), "未找到") {
t.Fatalf("expected 未找到 message, got %v", err)
}
}
func TestResolveSkillSetupTargetsSingleAgent(t *testing.T) {
got, err := resolveSkillSetupTargets("claude", skillSetupModeMono)
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if len(got) != 1 {
t.Fatalf("expected 1 dest, got %d", len(got))
}
if !strings.Contains(got[0], ".claude/skills/dws") {
t.Fatalf("expected .claude/skills/dws path, got %s", got[0])
}
}
func TestResolveSkillSetupTargetsUnknown(t *testing.T) {
if _, err := resolveSkillSetupTargets("nonsense", skillSetupModeMono); err == nil {
t.Fatalf("expected error for unknown target")
}
}
func TestResolveSkillSetupTargetsMultiOmitsDwsTail(t *testing.T) {
got, err := resolveSkillSetupTargets("claude", skillSetupModeMulti)
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if len(got) != 1 {
t.Fatalf("expected 1 dest, got %d", len(got))
}
if strings.HasSuffix(got[0], "/dws") {
t.Fatalf("multi target must not end with /dws, got %s", got[0])
}
if !strings.HasSuffix(got[0], ".claude/skills") {
t.Fatalf("expected suffix .claude/skills, got %s", got[0])
}
}
func TestInstallSkillToHomesEndToEnd(t *testing.T) {
src := t.TempDir()
if err := os.WriteFile(filepath.Join(src, "SKILL.md"), []byte("# test"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.MkdirAll(filepath.Join(src, "references"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(src, "references", "x.md"), []byte("x"), 0o644); err != nil {
t.Fatal(err)
}
dst1 := filepath.Join(t.TempDir(), "a", "dws")
dst2 := filepath.Join(t.TempDir(), "b", "dws")
var stdout, stderr bytes.Buffer
installed, skipped, err := installSkillToHomes(src, []string{dst1, dst2}, &stdout, &stderr)
if err != nil {
t.Fatalf("install err: %v", err)
}
if installed != 2 || skipped != 0 {
t.Fatalf("expected installed=2 skipped=0, got %d/%d", installed, skipped)
}
for _, d := range []string{dst1, dst2} {
if _, err := os.Stat(filepath.Join(d, "SKILL.md")); err != nil {
t.Fatalf("missing SKILL.md in %s: %v", d, err)
}
if _, err := os.Stat(filepath.Join(d, "references", "x.md")); err != nil {
t.Fatalf("missing references/x.md in %s: %v", d, err)
}
}
}
// writeMultiSkillSource builds a fake skills/multi/ layout containing N
// dingtalk-* subdirs, each with a SKILL.md and one references/<name>.md
// file. Returns the absolute skill source root.
func writeMultiSkillSource(t *testing.T, names []string) string {
t.Helper()
root := t.TempDir()
for _, n := range names {
sub := filepath.Join(root, n)
if err := os.MkdirAll(filepath.Join(sub, "references"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(sub, "SKILL.md"), []byte("# "+n), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(sub, "references", n+".md"), []byte("ref "+n), 0o644); err != nil {
t.Fatal(err)
}
}
return root
}
func TestInstallMultiSkillToHomes(t *testing.T) {
names := []string{"dingtalk-aitable", "dingtalk-calendar", "dingtalk-doc"}
src := writeMultiSkillSource(t, names)
got, err := listMultiSkillNames(src)
if err != nil {
t.Fatalf("listMultiSkillNames err: %v", err)
}
if len(got) != len(names) {
t.Fatalf("expected %d skills, got %d (%v)", len(names), len(got), got)
}
dst1 := filepath.Join(t.TempDir(), ".claude", "skills")
dst2 := filepath.Join(t.TempDir(), ".cursor", "skills")
var stdout, stderr bytes.Buffer
installed, skipped, err := installMultiSkillToHomes(src, got, []string{dst1, dst2}, &stdout, &stderr)
if err != nil {
t.Fatalf("installMultiSkillToHomes err: %v", err)
}
if installed != len(names)*2 || skipped != 0 {
t.Fatalf("expected installed=%d skipped=0, got %d/%d (stderr=%q)", len(names)*2, installed, skipped, stderr.String())
}
for _, d := range []string{dst1, dst2} {
for _, n := range names {
sub := filepath.Join(d, n)
if _, err := os.Stat(filepath.Join(sub, "SKILL.md")); err != nil {
t.Fatalf("missing %s/SKILL.md: %v", sub, err)
}
if _, err := os.Stat(filepath.Join(sub, "references", n+".md")); err != nil {
t.Fatalf("missing %s/references/%s.md: %v", sub, n, err)
}
}
// dws/ should NOT exist (multi mode is pure siblings)
if _, err := os.Stat(filepath.Join(d, "dws")); err == nil {
t.Fatalf("unexpected dws/ subdir in multi-mode install at %s", d)
}
}
}
func TestSkillSetupMutualExclusion(t *testing.T) {
names := []string{"dingtalk-aitable", "dingtalk-calendar"}
src := writeMultiSkillSource(t, names)
// Simulate a pre-existing mono install under <agent-home>/dws/
agentHome := filepath.Join(t.TempDir(), ".claude", "skills")
monoLeftover := filepath.Join(agentHome, "dws")
if err := os.MkdirAll(filepath.Join(monoLeftover, "references"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(monoLeftover, "SKILL.md"), []byte("old mono"), 0o644); err != nil {
t.Fatal(err)
}
// Sanity: leftover exists before
if _, err := os.Stat(monoLeftover); err != nil {
t.Fatalf("setup: mono leftover should exist before, err=%v", err)
}
// Confirm mutualExclusionVictims sees the leftover
victims := mutualExclusionVictims(agentHome, skillSetupModeMulti)
if len(victims) != 1 || victims[0] != monoLeftover {
t.Fatalf("expected victims=[%s], got %v", monoLeftover, victims)
}
var stdout, stderr bytes.Buffer
installed, skipped, err := installMultiSkillToHomes(src, names, []string{agentHome}, &stdout, &stderr)
if err != nil {
t.Fatalf("install err: %v (stderr=%s)", err, stderr.String())
}
if installed != len(names) || skipped != 0 {
t.Fatalf("expected installed=%d skipped=0, got %d/%d", len(names), installed, skipped)
}
// mono leftover should be gone
if _, err := os.Stat(monoLeftover); !os.IsNotExist(err) {
t.Fatalf("expected mono leftover removed, stat err=%v", err)
}
// multi skills should be in place
for _, n := range names {
if _, err := os.Stat(filepath.Join(agentHome, n, "SKILL.md")); err != nil {
t.Fatalf("missing %s/%s/SKILL.md: %v", agentHome, n, err)
}
}
// the cleanup line should appear in stdout (best-effort observability)
if !strings.Contains(stdout.String(), "已清理对面模式残留") {
t.Fatalf("expected cleanup log line, got stdout=%q", stdout.String())
}
// Now test the reverse: pre-existing multi → installing mono cleans dingtalk-*
monoSrc := t.TempDir()
if err := os.WriteFile(filepath.Join(monoSrc, "SKILL.md"), []byte("# mono"), 0o644); err != nil {
t.Fatal(err)
}
monoDest := filepath.Join(agentHome, "dws")
stdout.Reset()
stderr.Reset()
installed2, skipped2, err := installSkillToHomes(monoSrc, []string{monoDest}, &stdout, &stderr)
if err != nil {
t.Fatalf("mono install err: %v", err)
}
if installed2 != 1 || skipped2 != 0 {
t.Fatalf("expected mono installed=1 skipped=0, got %d/%d", installed2, skipped2)
}
// All dingtalk-* siblings should be gone after mono install
for _, n := range names {
if _, err := os.Stat(filepath.Join(agentHome, n)); !os.IsNotExist(err) {
t.Fatalf("expected %s removed by mutual exclusion, stat err=%v", n, err)
}
}
if _, err := os.Stat(filepath.Join(monoDest, "SKILL.md")); err != nil {
t.Fatalf("mono SKILL.md missing: %v", err)
}
if !strings.Contains(stdout.String(), "已清理对面模式残留") {
t.Fatalf("expected cleanup log line on mono install, got stdout=%q", stdout.String())
}
}
// TestSkillSourceCandidatesIncludesUserCache verifies that the user-level
// cache populated by install.sh / install.ps1 / npm install.js is part of the
// fallback candidate list, so `dws skill setup` can find a source on a fresh
// machine without --source.
func TestSkillSourceCandidatesIncludesUserCache(t *testing.T) {
home, err := os.UserHomeDir()
if err != nil {
t.Fatalf("UserHomeDir error = %v", err)
}
for _, subdir := range []string{"mono", "multi"} {
got := skillSourceCandidates("", subdir)
want := filepath.Join(home, ".dws", "skills", subdir)
found := false
for _, c := range got {
if c == want {
found = true
break
}
}
if !found {
t.Fatalf("skillSourceCandidates(%q) missing %q; got %v", subdir, want, got)
}
}
}
// TestResolveSkillSetupSourceFallsBackToUserCache verifies that when no
// --source / DWS_SKILL_SOURCE / source checkout is available, the resolver
// successfully discovers ~/.dws/skills/multi/ as the source.
func TestResolveSkillSetupSourceFallsBackToUserCache(t *testing.T) {
fakeHome := t.TempDir()
t.Setenv("HOME", fakeHome)
t.Setenv("DWS_SKILL_SOURCE", "")
cacheRoot := filepath.Join(fakeHome, ".dws", "skills", "multi")
for _, n := range []string{"dingtalk-aitable", "dingtalk-doc"} {
if err := os.MkdirAll(filepath.Join(cacheRoot, n), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(cacheRoot, n, "SKILL.md"), []byte("# "+n), 0o644); err != nil {
t.Fatal(err)
}
}
// Run resolver from a tempdir that has no skills/ on disk, simulating a
// fresh user machine without a source checkout.
scratch := t.TempDir()
t.Chdir(scratch)
got, err := resolveSkillSetupSource("", skillSetupModeMulti)
if err != nil {
t.Fatalf("expected user-cache fallback to succeed, got err=%v", err)
}
if got != cacheRoot {
t.Fatalf("expected %s, got %s", cacheRoot, got)
}
}
func TestNormalizeMultiSkillName(t *testing.T) {
cases := []struct {
in, want string
}{
{"aitable", "dingtalk-aitable"},
{"dingtalk-aitable", "dingtalk-aitable"},
{" Calendar ", "dingtalk-calendar"},
{"DINGTALK-DOC", "dingtalk-doc"},
{"", ""},
{" ", ""},
}
for _, c := range cases {
if got := normalizeMultiSkillName(c.in); got != c.want {
t.Errorf("normalizeMultiSkillName(%q) = %q, want %q", c.in, got, c.want)
}
}
}
func TestFilterMultiSkillNames(t *testing.T) {
all := []string{"dingtalk-aitable", "dingtalk-calendar", "dingtalk-doc", "dingtalk-live"}
t.Run("no filter returns all", func(t *testing.T) {
got, err := filterMultiSkillNames(all, nil, nil)
if err != nil {
t.Fatal(err)
}
if len(got) != len(all) {
t.Fatalf("expected %d, got %v", len(all), got)
}
})
t.Run("include short names", func(t *testing.T) {
got, err := filterMultiSkillNames(all, []string{"aitable", "calendar"}, nil)
if err != nil {
t.Fatal(err)
}
if strings.Join(got, ",") != "dingtalk-aitable,dingtalk-calendar" {
t.Fatalf("got %v", got)
}
})
t.Run("include full names", func(t *testing.T) {
got, err := filterMultiSkillNames(all, []string{"dingtalk-doc"}, nil)
if err != nil {
t.Fatal(err)
}
if len(got) != 1 || got[0] != "dingtalk-doc" {
t.Fatalf("got %v", got)
}
})
t.Run("include dedups", func(t *testing.T) {
got, err := filterMultiSkillNames(all, []string{"aitable", "dingtalk-aitable", "AITABLE"}, nil)
if err != nil {
t.Fatal(err)
}
if len(got) != 1 || got[0] != "dingtalk-aitable" {
t.Fatalf("got %v", got)
}
})
t.Run("include unknown errors with available list", func(t *testing.T) {
_, err := filterMultiSkillNames(all, []string{"aitable", "bogus"}, nil)
if err == nil {
t.Fatal("expected error")
}
msg := err.Error()
if !strings.Contains(msg, "bogus") {
t.Errorf("error should mention bad name, got: %s", msg)
}
if !strings.Contains(msg, "dingtalk-calendar") {
t.Errorf("error should list available names, got: %s", msg)
}
})
t.Run("exclude short names", func(t *testing.T) {
got, err := filterMultiSkillNames(all, nil, []string{"live", "doc"})
if err != nil {
t.Fatal(err)
}
if strings.Join(got, ",") != "dingtalk-aitable,dingtalk-calendar" {
t.Fatalf("got %v", got)
}
})
t.Run("exclude unknown errors", func(t *testing.T) {
_, err := filterMultiSkillNames(all, nil, []string{"bogus"})
if err == nil {
t.Fatal("expected error")
}
})
t.Run("exclude all errors", func(t *testing.T) {
_, err := filterMultiSkillNames(all, nil, []string{"aitable", "calendar", "doc", "live"})
if err == nil {
t.Fatal("expected error when exclude drops everything")
}
if !strings.Contains(err.Error(), "全部") {
t.Errorf("expected 全部 in error, got: %s", err.Error())
}
})
t.Run("include + exclude mutually exclusive", func(t *testing.T) {
_, err := filterMultiSkillNames(all, []string{"aitable"}, []string{"doc"})
if err == nil {
t.Fatal("expected error when both given")
}
})
}
// TestSkillSetupMultiAdditivePreservesSiblings verifies the key UX promise of
// `dws skill setup --mode multi -s aitable`: installing a subset must NOT
// touch already-installed dingtalk-* siblings (additive semantics, matches
// lark-cli `npx skills add -s lark-calendar`).
func TestSkillSetupMultiAdditivePreservesSiblings(t *testing.T) {
src := writeMultiSkillSource(t, []string{
"dingtalk-aitable", "dingtalk-calendar", "dingtalk-doc",
})
agentHome := filepath.Join(t.TempDir(), ".claude", "skills")
// Pretend the user already installed two dingtalk-* skills earlier.
preExisting := []string{"dingtalk-chat", "dingtalk-todo"}
for _, n := range preExisting {
dir := filepath.Join(agentHome, n)
if err := os.MkdirAll(dir, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(dir, "SKILL.md"), []byte("OLD "+n), 0o644); err != nil {
t.Fatal(err)
}
}
// User now runs `... --mode multi -s aitable -s calendar`.
filtered, err := filterMultiSkillNames(
[]string{"dingtalk-aitable", "dingtalk-calendar", "dingtalk-doc"},
[]string{"aitable", "calendar"},
nil,
)
if err != nil {
t.Fatalf("filter err: %v", err)
}
var stdout, stderr bytes.Buffer
installed, skipped, err := installMultiSkillToHomes(src, filtered, []string{agentHome}, &stdout, &stderr)
if err != nil {
t.Fatalf("install err: %v (stderr=%s)", err, stderr.String())
}
if installed != 2 || skipped != 0 {
t.Fatalf("expected installed=2 skipped=0, got %d/%d", installed, skipped)
}
// Asked-for skills should be in place.
for _, n := range []string{"dingtalk-aitable", "dingtalk-calendar"} {
if _, err := os.Stat(filepath.Join(agentHome, n, "SKILL.md")); err != nil {
t.Errorf("missing newly-installed %s: %v", n, err)
}
}
// Unselected source skill must NOT be installed.
if _, err := os.Stat(filepath.Join(agentHome, "dingtalk-doc")); !os.IsNotExist(err) {
t.Errorf("dingtalk-doc was not requested but appeared (stat err=%v)", err)
}
// Pre-existing sibling skills must be UNTOUCHED — additive semantics.
for _, n := range preExisting {
body, err := os.ReadFile(filepath.Join(agentHome, n, "SKILL.md"))
if err != nil {
t.Errorf("pre-existing %s was wiped (err=%v)", n, err)
continue
}
if !strings.HasPrefix(string(body), "OLD ") {
t.Errorf("pre-existing %s content changed: got %q", n, string(body))
}
}
}
// TestRunSkillSetupRejectsSkillFlagInMonoMode verifies that the new
// -s/--skill and -x/--exclude flags are gated on --mode multi.
func TestRunSkillSetupRejectsSkillFlagInMonoMode(t *testing.T) {
cmd := newSkillSetupCommand()
cmd.SetArgs([]string{"--mode", "mono", "--yes", "--skill", "aitable"})
cmd.SetOut(&bytes.Buffer{})
cmd.SetErr(&bytes.Buffer{})
err := cmd.Execute()
if err == nil {
t.Fatal("expected error for --skill in mono mode")
}
if !strings.Contains(err.Error(), "multi") {
t.Fatalf("error should mention multi gating, got: %v", err)
}
}
func TestResolveSkillSetupSourceMultiFinds(t *testing.T) {
tmp := t.TempDir()
multiDir := filepath.Join(tmp, "skills", "multi")
for _, n := range []string{"dingtalk-aitable", "dingtalk-doc"} {
if err := os.MkdirAll(filepath.Join(multiDir, n), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(multiDir, n, "SKILL.md"), []byte("# "+n), 0o644); err != nil {
t.Fatal(err)
}
}
got, err := resolveSkillSetupSource(tmp, skillSetupModeMulti)
if err != nil {
t.Fatalf("expected to find multi source, got err=%v", err)
}
if got != multiDir {
t.Fatalf("expected %s, got %s", multiDir, got)
}
}
+44 -6
View File
@@ -10,6 +10,7 @@ import (
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"time"
@@ -580,13 +581,18 @@ func validateNewBinary(binaryPath, expectedVersion string) error {
return fmt.Errorf("设置执行权限失败: %w", err)
}
// Try running the binary
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
out, err := exec.CommandContext(ctx, binaryPath, "version").CombinedOutput()
out, err := tryExecVersion(binaryPath)
if err != nil {
return fmt.Errorf("二进制无法执行: %w", err)
// Apple Silicon kills unsigned arm64 binaries with SIGKILL via amfid.
// Repair the binary in-place (ad-hoc codesign + drop quarantine) and retry once.
if runtime.GOOS == "darwin" && isLikelyAMFIKill(err) {
if repairErr := repairDarwinBinary(binaryPath); repairErr == nil {
out, err = tryExecVersion(binaryPath)
}
}
if err != nil {
return fmt.Errorf("二进制无法执行: %w", err)
}
}
if !strings.Contains(string(out), expectedVersion) {
@@ -596,6 +602,38 @@ func validateNewBinary(binaryPath, expectedVersion string) error {
return nil
}
func tryExecVersion(binaryPath string) ([]byte, error) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
return exec.CommandContext(ctx, binaryPath, "version").CombinedOutput()
}
// isLikelyAMFIKill returns true when err looks like macOS amfid SIGKILL'ing an
// unsigned binary. Go reports this as "signal: killed".
func isLikelyAMFIKill(err error) bool {
if err == nil {
return false
}
msg := err.Error()
return strings.Contains(msg, "signal: killed") || strings.Contains(msg, "signal: kill")
}
// repairDarwinBinary applies an ad-hoc codesign and clears the quarantine xattr.
// Used as a self-heal step when an unsigned binary is killed by amfid on Apple Silicon.
func repairDarwinBinary(binaryPath string) error {
// Best-effort: strip quarantine. Failure is fine (attribute often absent).
_ = exec.Command("xattr", "-d", "com.apple.quarantine", binaryPath).Run()
if _, err := exec.LookPath("codesign"); err != nil {
return fmt.Errorf("codesign 不可用: %w", err)
}
out, err := exec.Command("codesign", "--force", "--sign", "-", binaryPath).CombinedOutput()
if err != nil {
return fmt.Errorf("codesign 失败: %v: %s", err, strings.TrimSpace(string(out)))
}
return nil
}
// extractTarGz extracts a .tar.gz file using the system tar command.
func extractTarGz(archivePath, destDir string) error {
os.MkdirAll(destDir, 0755)
+80
View File
@@ -7,8 +7,11 @@ import (
"bytes"
"crypto/sha256"
"encoding/hex"
"errors"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"testing"
@@ -428,3 +431,80 @@ func TestNewUpgradeCommand_Help(t *testing.T) {
t.Error("help should contain --rollback")
}
}
// --- isLikelyAMFIKill ---
func TestIsLikelyAMFIKill(t *testing.T) {
tests := []struct {
name string
err error
want bool
}{
{"nil error", nil, false},
{"signal killed (real Go format)", errors.New("signal: killed"), true},
{"signal kill variant", errors.New("signal: kill"), true},
{"unrelated error", errors.New("exit status 1"), false},
{"file not found", errors.New("no such file or directory"), false},
{"wrapped killed in middle", errors.New("exec: signal: killed: cleanup"), true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := isLikelyAMFIKill(tt.err); got != tt.want {
t.Errorf("isLikelyAMFIKill(%v) = %v, want %v", tt.err, got, tt.want)
}
})
}
}
// --- validateNewBinary self-heal (darwin only) ---
//
// On macOS, an unsigned arm64 binary is SIGKILL'd by amfid. This test verifies
// validateNewBinary recovers via repairDarwinBinary (ad-hoc codesign) and
// successfully re-executes the binary. We use go itself as a stand-in for the
// new dws binary — it's a real signed Mach-O we can strip and re-sign.
func TestValidateNewBinary_RecoversFromUnsignedDarwin(t *testing.T) {
if runtime.GOOS != "darwin" {
t.Skip("amfid SIGKILL only happens on macOS")
}
if _, err := exec.LookPath("codesign"); err != nil {
t.Skip("codesign not available")
}
// Build a fresh dws binary into a temp dir.
tmpDir := t.TempDir()
bin := filepath.Join(tmpDir, "dws-test")
// Locate repo root from this test file's location.
wd, err := os.Getwd()
if err != nil {
t.Fatalf("getwd: %v", err)
}
repoRoot := filepath.Join(wd, "..", "..")
cmd := exec.Command("go", "build", "-o", bin, "./cmd")
cmd.Dir = repoRoot
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("go build failed: %v\n%s", err, out)
}
// Strip signature to reproduce the unsigned state from CI cross-compilation.
if out, err := exec.Command("codesign", "--remove-signature", bin).CombinedOutput(); err != nil {
t.Fatalf("strip signature: %v\n%s", err, out)
}
// Sanity: confirm direct exec is killed.
if _, err := tryExecVersion(bin); err == nil {
t.Skip("unsigned binary executed without amfid kill — likely Intel Mac or SIP disabled")
}
// validateNewBinary should self-heal and succeed.
if err := validateNewBinary(bin, "dev"); err != nil {
t.Fatalf("validateNewBinary did not recover: %v", err)
}
// Verify the binary now has an ad-hoc signature.
out, _ := exec.Command("codesign", "-dv", bin).CombinedOutput()
if !strings.Contains(string(out), "Signature=adhoc") {
t.Errorf("expected adhoc signature, got: %s", out)
}
}
+26
View File
@@ -14,6 +14,8 @@
package app
import (
"bytes"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/market"
@@ -123,3 +125,27 @@ func commandNames(cmds []*cobra.Command) []string {
}
return names
}
// TestRenderRootHelpIncludesLong guards that renderRootHelp surfaces the
// root command's Long description in `dws --help` output. The custom
// SetHelpFunc in root_help.go replaces cobra's default help template, which
// previously caused root.Long to be silently dropped. The production
// root.Long carries the "use 'dws upgrade' if a command is missing or
// failing" hint that AI agents rely on when they cannot find a suitable
// command — if this test fails after a help-rendering change, agents will
// silently lose that guidance.
func TestRenderRootHelpIncludesLong(t *testing.T) {
const sentinel = "SENTINEL-LONG-MUST-APPEAR-IN-HELP"
root := &cobra.Command{
Use: "dws",
Long: sentinel,
}
var out bytes.Buffer
root.SetOut(&out)
renderRootHelp(root)
if !strings.Contains(out.String(), sentinel) {
t.Fatalf("renderRootHelp must render root.Long verbatim in --help output; got:\n%s", out.String())
}
}
+49 -5
View File
@@ -16,21 +16,31 @@ package auth
import (
"encoding/json"
"fmt"
"log/slog"
"os"
"path/filepath"
"sync"
"time"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/helpers"
configpkg "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/config"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/edition"
)
const (
// appConfigFile is the filename for storing app credentials.
appConfigFile = "app.json"
// appConfigFile is the filename for the open-source edition's app
// credentials store. Sibling editions get a name-suffixed file via
// config.EditionFileName so two dws binaries sharing the same config
// directory (~/.dws or DWS_CONFIG_DIR) cannot read/write each other's
// credentials. See GetAppConfigPath for the path derivation contract.
appConfigBase = "app"
appConfigExt = ".json"
appConfigFile = appConfigBase + appConfigExt
)
// AppConfig represents the application credentials configuration.
// This is stored in ~/.dws/app.json with the client secret securely stored in keychain.
// This is stored in the edition-specific app config file, with the client
// secret securely stored in keychain when present.
type AppConfig struct {
ClientID string `json:"clientId"`
ClientSecret SecretInput `json:"clientSecret"`
@@ -53,9 +63,14 @@ var (
cachedResolvedMu sync.RWMutex
)
// GetAppConfigPath returns the path to the app config file.
// GetAppConfigPath returns the path to the app config file for the
// currently-active edition. The filename is partitioned by edition so that
// two dws binaries from different editions sharing the same configDir
// (typically ~/.dws or DWS_CONFIG_DIR) cannot read or overwrite each
// other's credentials. Open-source stays on "app.json" for backwards
// compatibility; sibling editions land on "app-<edition>.json".
func GetAppConfigPath(configDir string) string {
return filepath.Join(configDir, appConfigFile)
return filepath.Join(configDir, configpkg.EditionFileName(edition.Get().Name, appConfigBase, appConfigExt))
}
// LoadAppConfig loads the app configuration from disk.
@@ -105,6 +120,7 @@ func SaveAppConfig(configDir string, config *AppConfig) error {
if err := helpers.AtomicWriteJSON(path, append(data, '\n')); err != nil {
return fmt.Errorf("writing app config: %w", err)
}
cleanupLegacySiblingAppConfig(configDir, config)
// Update cache
cachedAppConfigMu.Lock()
@@ -121,6 +137,34 @@ func SaveAppConfig(configDir string, config *AppConfig) error {
return nil
}
func cleanupLegacySiblingAppConfig(configDir string, config *AppConfig) {
if config == nil || config.ClientID == "" || configpkg.IsOpenEdition(edition.Get().Name) {
return
}
legacyPath := filepath.Join(configDir, appConfigFile)
if legacyPath == GetAppConfigPath(configDir) {
return
}
data, err := os.ReadFile(legacyPath)
if err != nil {
return
}
var legacy AppConfig
if err := json.Unmarshal(data, &legacy); err != nil {
return
}
if legacy.ClientID != config.ClientID {
return
}
if err := os.Remove(legacyPath); err != nil && !os.IsNotExist(err) {
slog.Debug("auth: best-effort cleanup of legacy app config failed", "path", legacyPath, "error", err)
}
}
// DeleteAppConfig removes the app configuration and associated keychain secrets.
func DeleteAppConfig(configDir string) error {
// Load existing config to clean up keychain
+256
View File
@@ -0,0 +1,256 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package auth
import (
"os"
"path/filepath"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/edition"
)
// Verifies that two dws binaries from different editions sharing the same
// configDir (e.g. ~/.dws via DWS_CONFIG_DIR) read and write disjoint
// app.json files. Without partitioning, a sibling edition's post-login
// persistence path could leak its pinned ClientID into the open-source
// build by reading the shared file.
func TestGetAppConfigPath_OpenEditionUsesLegacyName(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() { edition.Override(prev) })
for _, name := range []string{"", "open"} {
edition.Override(&edition.Hooks{Name: name})
got := GetAppConfigPath("/tmp/cfg")
want := filepath.Join("/tmp/cfg", "app.json")
if got != want {
t.Fatalf("edition=%q: GetAppConfigPath = %q, want %q", name, got, want)
}
}
}
func TestGetAppConfigPath_SiblingEditionUsesSuffixedName(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() { edition.Override(prev) })
cases := []struct {
editionName string
wantFile string
}{
{"wukong", "app-wukong.json"},
{"dev", "app-dev.json"},
{"embedded", "app-embedded.json"},
}
for _, tc := range cases {
edition.Override(&edition.Hooks{Name: tc.editionName})
got := GetAppConfigPath("/tmp/cfg")
want := filepath.Join("/tmp/cfg", tc.wantFile)
if got != want {
t.Fatalf("edition=%q: GetAppConfigPath = %q, want %q", tc.editionName, got, want)
}
}
}
func TestGetAppConfigPath_OpenAndSiblingAreDisjoint(t *testing.T) {
// End-to-end invariant: when the same configDir is observed from two
// different editions, the resulting app.json paths must NOT collide.
prev := edition.Get()
t.Cleanup(func() { edition.Override(prev) })
const cfg = "/tmp/shared-cfg"
edition.Override(&edition.Hooks{Name: "open"})
openPath := GetAppConfigPath(cfg)
edition.Override(&edition.Hooks{Name: "wukong"})
wukongPath := GetAppConfigPath(cfg)
if openPath == wukongPath {
t.Fatalf("open and wukong editions share path %q; cross-edition leakage possible", openPath)
}
if filepath.Dir(openPath) != filepath.Dir(wukongPath) {
t.Fatalf("paths landed in different directories (%q vs %q); partitioning should only differ by filename", filepath.Dir(openPath), filepath.Dir(wukongPath))
}
}
func TestAppConfigIO_OpenEditionDoesNotReadSiblingCredentials(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
edition.Override(&edition.Hooks{Name: "wukong"})
wukongPath := GetAppConfigPath(configDir)
if err := os.WriteFile(wukongPath, []byte(`{"clientId":"wukong-cid","createdAt":"2026-05-17T00:00:00+08:00"}`+"\n"), 0600); err != nil {
t.Fatalf("writing sibling app config: %v", err)
}
edition.Override(&edition.Hooks{Name: "open"})
got, err := LoadAppConfig(configDir)
if err != nil {
t.Fatalf("LoadAppConfig(open) error = %v", err)
}
if got != nil {
t.Fatalf("open edition read sibling app config: %#v", got)
}
}
func TestSaveAppConfig_SiblingEditionRemovesMatchingLegacyAppConfig(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
legacyPath := filepath.Join(configDir, appConfigFile)
legacyJSON := []byte(`{"clientId":"wukong-cid","createdAt":"2026-05-17T00:00:00+08:00"}` + "\n")
if err := os.WriteFile(legacyPath, legacyJSON, 0600); err != nil {
t.Fatalf("writing legacy app config: %v", err)
}
edition.Override(&edition.Hooks{Name: "wukong"})
if err := SaveAppConfig(configDir, &AppConfig{ClientID: "wukong-cid"}); err != nil {
t.Fatalf("SaveAppConfig(wukong) error = %v", err)
}
if _, err := os.Stat(legacyPath); !os.IsNotExist(err) {
t.Fatalf("matching legacy app config should be removed, stat error = %v", err)
}
if _, err := os.Stat(filepath.Join(configDir, "app-wukong.json")); err != nil {
t.Fatalf("sibling app config not written: %v", err)
}
}
func TestSaveAppConfig_SiblingEditionKeepsDifferentLegacyAppConfig(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
legacyPath := filepath.Join(configDir, appConfigFile)
legacyJSON := []byte(`{"clientId":"open-cid","createdAt":"2026-05-17T00:00:00+08:00"}` + "\n")
if err := os.WriteFile(legacyPath, legacyJSON, 0600); err != nil {
t.Fatalf("writing legacy app config: %v", err)
}
edition.Override(&edition.Hooks{Name: "wukong"})
if err := SaveAppConfig(configDir, &AppConfig{ClientID: "wukong-cid"}); err != nil {
t.Fatalf("SaveAppConfig(wukong) error = %v", err)
}
got, err := os.ReadFile(legacyPath)
if err != nil {
t.Fatalf("different legacy app config should be preserved: %v", err)
}
if string(got) != string(legacyJSON) {
t.Fatalf("legacy app config changed: got %q, want %q", got, legacyJSON)
}
}
func TestSaveAppConfig_SiblingEditionKeepsMalformedLegacyAppConfig(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
legacyPath := filepath.Join(configDir, appConfigFile)
legacyJSON := []byte(`{"clientId":"wukong-cid"`)
if err := os.WriteFile(legacyPath, legacyJSON, 0600); err != nil {
t.Fatalf("writing malformed legacy app config: %v", err)
}
edition.Override(&edition.Hooks{Name: "wukong"})
if err := SaveAppConfig(configDir, &AppConfig{ClientID: "wukong-cid"}); err != nil {
t.Fatalf("SaveAppConfig(wukong) error = %v", err)
}
got, err := os.ReadFile(legacyPath)
if err != nil {
t.Fatalf("malformed legacy app config should be preserved: %v", err)
}
if string(got) != string(legacyJSON) {
t.Fatalf("malformed legacy app config changed: got %q, want %q", got, legacyJSON)
}
}
func TestSaveAppConfig_OpenEditionDoesNotCleanSiblingAppConfigs(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
siblingFiles := map[string][]byte{
"app-wukong.json": []byte(`{"clientId":"wukong-cid","createdAt":"2026-05-17T00:00:00+08:00"}` + "\n"),
"app-dev.json": []byte(`{"clientId":"dev-cid","createdAt":"2026-05-17T00:00:00+08:00"}` + "\n"),
}
for name, data := range siblingFiles {
if err := os.WriteFile(filepath.Join(configDir, name), data, 0600); err != nil {
t.Fatalf("writing sibling app config %s: %v", name, err)
}
}
edition.Override(&edition.Hooks{Name: "open"})
if err := SaveAppConfig(configDir, &AppConfig{ClientID: "open-cid"}); err != nil {
t.Fatalf("SaveAppConfig(open) error = %v", err)
}
for name, want := range siblingFiles {
got, err := os.ReadFile(filepath.Join(configDir, name))
if err != nil {
t.Fatalf("open edition should preserve sibling app config %s: %v", name, err)
}
if string(got) != string(want) {
t.Fatalf("sibling app config %s changed: got %q, want %q", name, got, want)
}
}
}
func TestSaveAppConfig_SiblingEditionKeepsLegacyAppConfigWhenClientIDEmpty(t *testing.T) {
prev := edition.Get()
t.Cleanup(func() {
edition.Override(prev)
resetAppConfigCache()
})
configDir := t.TempDir()
legacyPath := filepath.Join(configDir, appConfigFile)
legacyJSON := []byte(`{"clientId":"wukong-cid","createdAt":"2026-05-17T00:00:00+08:00"}` + "\n")
if err := os.WriteFile(legacyPath, legacyJSON, 0600); err != nil {
t.Fatalf("writing legacy app config: %v", err)
}
edition.Override(&edition.Hooks{Name: "wukong"})
if err := SaveAppConfig(configDir, &AppConfig{}); err != nil {
t.Fatalf("SaveAppConfig(wukong empty client ID) error = %v", err)
}
got, err := os.ReadFile(legacyPath)
if err != nil {
t.Fatalf("legacy app config should be preserved when client ID is empty: %v", err)
}
if string(got) != string(legacyJSON) {
t.Fatalf("legacy app config changed: got %q, want %q", got, legacyJSON)
}
}
+2 -8
View File
@@ -96,7 +96,7 @@ const (
LogoutContinueURL = "https://login.dingtalk.com"
// MCP API endpoints for CLI authorization management.
DefaultMCPBaseURL = "https://mcp.dingtalk.com"
DefaultMCPBaseURL = config.DefaultMCPBaseURL
CLIAuthEnabledPath = "/cli/cliAuthEnabled"
SuperAdminPath = "/cli/superAdmin"
SendCliAuthApplyPath = "/cli/sendCliAuthApply"
@@ -131,13 +131,7 @@ func GetDeveloperSettingsURL() string {
// 1. ~/.dws/mcp_url file content (for pre-release environment)
// 2. Default value (https://mcp.dingtalk.com)
func GetMCPBaseURL() string {
mcpURLPath := filepath.Join(getDefaultConfigDir(), "mcp_url")
if data, err := os.ReadFile(mcpURLPath); err == nil {
if url := strings.TrimSpace(string(data)); url != "" {
return url
}
}
return DefaultMCPBaseURL
return config.GetMCPBaseURL()
}
// Runtime overrides set via CLI flags (--client-id, --client-secret).
+373
View File
@@ -0,0 +1,373 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package auth
import (
"archive/tar"
"compress/gzip"
"encoding/json"
"fmt"
"io"
"os"
"path"
"path/filepath"
"runtime"
"sort"
"strings"
"time"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/keychain"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/config"
)
// PortableImportReport summarizes bundle metadata consumed during import.
type PortableImportReport struct {
BundleOS string
OSMismatch bool
}
// PortableExportSupported reports whether the current platform can produce a
// bundle that includes the file-based DEK required for import elsewhere.
func PortableExportSupported() bool {
if runtime.GOOS != "darwin" {
return true
}
return os.Getenv(keychain.DisableKeychainEnv) != ""
}
// PortableAuthTargetPopulated reports whether local auth files would be
// overwritten by a portable import.
func PortableAuthTargetPopulated(configDir string) bool {
if TokenDataExistsKeychain() {
return true
}
if _, err := os.Stat(filepath.Join(configDir, "app.json")); err == nil {
return true
}
encPath := filepath.Join(keychain.StorageDir(keychain.Service), keychain.AccountToken+".enc")
if _, err := os.Stat(encPath); err == nil {
return true
}
return false
}
// PortableAuthSourceReady reports whether encrypted auth token exists for export.
func PortableAuthSourceReady() bool {
return portableAuthSourcePopulated(keychain.StorageDir(keychain.Service))
}
func portableAuthSourcePopulated(keychainDir string) bool {
_, err := os.Stat(filepath.Join(keychainDir, keychain.AccountToken+".enc"))
return err == nil
}
const portableAuthManifest = "manifest.json"
type portableAuthBundleManifest struct {
Version int `json:"version"`
CreatedAt string `json:"created_at"`
OS string `json:"os"`
KeychainService string `json:"keychain_service"`
ConfigFiles []string `json:"config_files,omitempty"`
}
// ExportPortableAuthBundle writes a portable auth bundle as tar.gz.
// It copies the encrypted keychain files plus the small config files needed
// to refresh tokens in another Linux sandbox.
func ExportPortableAuthBundle(configDir string, w io.Writer) error {
if w == nil {
return fmt.Errorf("missing output writer")
}
if !PortableExportSupported() {
return fmt.Errorf("portable export unavailable on macOS while DEK is in system Keychain; set %s=1, re-login, then export", keychain.DisableKeychainEnv)
}
keychainDir := keychain.StorageDir(keychain.Service)
if _, err := os.Stat(keychainDir); err != nil {
return fmt.Errorf("auth keychain directory is not available: %w", err)
}
if !portableAuthSourcePopulated(keychainDir) {
return fmt.Errorf("auth token is not available for export; run dws auth login first")
}
gz := gzip.NewWriter(w)
defer gz.Close()
tw := tar.NewWriter(gz)
defer tw.Close()
configFiles, err := portableConfigFiles(configDir)
if err != nil {
return err
}
manifest := portableAuthBundleManifest{
Version: 1,
CreatedAt: time.Now().UTC().Format(time.RFC3339),
OS: runtime.GOOS,
KeychainService: keychain.Service,
ConfigFiles: configFiles,
}
if err := writePortableManifest(tw, manifest); err != nil {
return err
}
if err := addPortableDir(tw, keychainDir, path.Join("keychain", keychain.Service)); err != nil {
return err
}
for _, name := range configFiles {
src := filepath.Join(configDir, name)
if err := addPortableFile(tw, src, path.Join("config", filepath.ToSlash(name))); err != nil {
return err
}
}
return nil
}
// ImportPortableAuthBundle extracts a tar.gz auth bundle into the current
// config and keychain locations.
func ImportPortableAuthBundle(configDir string, r io.Reader) (PortableImportReport, error) {
if r == nil {
return PortableImportReport{}, fmt.Errorf("missing input reader")
}
gz, err := gzip.NewReader(r)
if err != nil {
return PortableImportReport{}, fmt.Errorf("open auth bundle: %w", err)
}
defer gz.Close()
tr := tar.NewReader(gz)
keychainDir := keychain.StorageDir(keychain.Service)
var manifest portableAuthBundleManifest
manifestRead := false
for {
hdr, err := tr.Next()
if err == io.EOF {
break
}
if err != nil {
return PortableImportReport{}, fmt.Errorf("read auth bundle: %w", err)
}
if hdr == nil {
continue
}
cleanName, err := cleanPortableName(hdr.Name)
if err != nil {
return PortableImportReport{}, err
}
if cleanName == portableAuthManifest {
if err := json.NewDecoder(tr).Decode(&manifest); err != nil {
return PortableImportReport{}, fmt.Errorf("read auth bundle manifest: %w", err)
}
manifestRead = true
continue
}
var target string
switch {
case strings.HasPrefix(cleanName, "keychain/"+keychain.Service+"/"):
rel := strings.TrimPrefix(cleanName, "keychain/"+keychain.Service+"/")
target, err = safeJoin(keychainDir, rel)
case strings.HasPrefix(cleanName, "config/"):
rel := strings.TrimPrefix(cleanName, "config/")
target, err = safeJoin(configDir, rel)
default:
return PortableImportReport{}, fmt.Errorf("unsupported auth bundle path %q", hdr.Name)
}
if err != nil {
return PortableImportReport{}, err
}
if err := extractPortableEntry(target, hdr, tr); err != nil {
return PortableImportReport{}, err
}
}
report := PortableImportReport{}
if manifestRead {
report.BundleOS = manifest.OS
report.OSMismatch = manifest.OS != "" && manifest.OS != runtime.GOOS
}
return report, nil
}
func portableConfigFiles(configDir string) ([]string, error) {
var files []string
patterns := []string{"app*.json", "mcp_url", "terminal_url"}
for _, pattern := range patterns {
matches, err := filepath.Glob(filepath.Join(configDir, pattern))
if err != nil {
return nil, fmt.Errorf("scan config files: %w", err)
}
for _, match := range matches {
info, err := os.Stat(match)
if err != nil || info.IsDir() {
continue
}
rel, err := filepath.Rel(configDir, match)
if err != nil {
return nil, fmt.Errorf("resolve config file: %w", err)
}
files = append(files, rel)
}
}
sort.Strings(files)
return files, nil
}
func writePortableManifest(tw *tar.Writer, manifest portableAuthBundleManifest) error {
data, err := json.MarshalIndent(manifest, "", " ")
if err != nil {
return fmt.Errorf("marshal auth bundle manifest: %w", err)
}
return writePortableBytes(tw, portableAuthManifest, append(data, '\n'), config.FilePerm)
}
func addPortableDir(tw *tar.Writer, root, prefix string) error {
return filepath.WalkDir(root, func(filePath string, entry os.DirEntry, walkErr error) error {
if walkErr != nil {
return walkErr
}
if entry.Type()&os.ModeSymlink != 0 {
return nil
}
if entry.IsDir() {
if filePath == root {
return nil
}
rel, err := filepath.Rel(root, filePath)
if err != nil {
return err
}
name := path.Join(prefix, filepath.ToSlash(rel))
return tw.WriteHeader(&tar.Header{Name: name, Typeflag: tar.TypeDir, Mode: int64(config.DirPerm)})
}
return addPortableFile(tw, filePath, path.Join(prefix, mustPortableRel(root, filePath)))
})
}
func mustPortableRel(root, filePath string) string {
rel, err := filepath.Rel(root, filePath)
if err != nil {
return filepath.Base(filePath)
}
return filepath.ToSlash(rel)
}
func addPortableFile(tw *tar.Writer, src, name string) error {
info, err := os.Stat(src)
if err != nil {
return fmt.Errorf("stat %s: %w", src, err)
}
if info.IsDir() {
return nil
}
file, err := os.Open(src)
if err != nil {
return fmt.Errorf("open %s: %w", src, err)
}
defer file.Close()
if err := tw.WriteHeader(&tar.Header{
Name: path.Clean(name),
Size: info.Size(),
Mode: int64(config.FilePerm),
ModTime: info.ModTime(),
}); err != nil {
return fmt.Errorf("write auth bundle header: %w", err)
}
if _, err := io.Copy(tw, file); err != nil {
return fmt.Errorf("write auth bundle file: %w", err)
}
return nil
}
func writePortableBytes(tw *tar.Writer, name string, data []byte, mode os.FileMode) error {
if err := tw.WriteHeader(&tar.Header{
Name: path.Clean(name),
Size: int64(len(data)),
Mode: int64(mode),
ModTime: time.Now(),
}); err != nil {
return fmt.Errorf("write auth bundle header: %w", err)
}
if _, err := tw.Write(data); err != nil {
return fmt.Errorf("write auth bundle data: %w", err)
}
return nil
}
func cleanPortableName(name string) (string, error) {
name = path.Clean(strings.TrimSpace(name))
if name == "." || name == "/" || strings.HasPrefix(name, "../") || strings.HasPrefix(name, "/") {
return "", fmt.Errorf("unsafe auth bundle path %q", name)
}
return name, nil
}
func safeJoin(root, rel string) (string, error) {
if rel == "" {
return "", fmt.Errorf("empty auth bundle path")
}
rel = filepath.FromSlash(path.Clean(rel))
if filepath.IsAbs(rel) || rel == "." || strings.HasPrefix(rel, ".."+string(filepath.Separator)) || rel == ".." {
return "", fmt.Errorf("unsafe auth bundle path %q", rel)
}
target := filepath.Join(root, rel)
cleanRoot := filepath.Clean(root) + string(filepath.Separator)
if target != filepath.Clean(root) && !strings.HasPrefix(filepath.Clean(target)+string(filepath.Separator), cleanRoot) {
return "", fmt.Errorf("unsafe auth bundle path %q", rel)
}
return target, nil
}
func extractPortableEntry(target string, hdr *tar.Header, r io.Reader) error {
switch hdr.Typeflag {
case tar.TypeDir:
if err := os.MkdirAll(target, config.DirPerm); err != nil {
return fmt.Errorf("create auth bundle directory: %w", err)
}
return os.Chmod(target, config.DirPerm)
case tar.TypeReg:
if err := os.MkdirAll(filepath.Dir(target), config.DirPerm); err != nil {
return fmt.Errorf("create auth bundle directory: %w", err)
}
tmp, err := os.CreateTemp(filepath.Dir(target), "."+filepath.Base(target)+".*.tmp")
if err != nil {
return fmt.Errorf("create auth bundle temp file: %w", err)
}
tmpName := tmp.Name()
success := false
defer func() {
if !success {
tmp.Close()
_ = os.Remove(tmpName)
}
}()
if err := tmp.Chmod(config.FilePerm); err != nil {
return fmt.Errorf("set auth bundle file permissions: %w", err)
}
if _, err := io.Copy(tmp, r); err != nil {
return fmt.Errorf("write auth bundle file: %w", err)
}
if err := tmp.Sync(); err != nil {
return fmt.Errorf("sync auth bundle file: %w", err)
}
if err := tmp.Close(); err != nil {
return fmt.Errorf("close auth bundle file: %w", err)
}
if err := os.Rename(tmpName, target); err != nil {
return fmt.Errorf("install auth bundle file: %w", err)
}
success = true
return nil
default:
return fmt.Errorf("unsupported auth bundle entry type %d for %q", hdr.Typeflag, hdr.Name)
}
}
+140
View File
@@ -0,0 +1,140 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package auth
import (
"bytes"
"os"
"path/filepath"
"runtime"
"testing"
"time"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/keychain"
)
func TestPortableExportSupported(t *testing.T) {
if runtime.GOOS != "darwin" {
if !PortableExportSupported() {
t.Fatal("PortableExportSupported() should be true on non-darwin")
}
return
}
t.Setenv(keychain.DisableKeychainEnv, "")
if PortableExportSupported() {
t.Fatal("PortableExportSupported() should be false on darwin without file DEK")
}
t.Setenv(keychain.DisableKeychainEnv, "1")
if !PortableExportSupported() {
t.Fatal("PortableExportSupported() should be true when file DEK is enabled")
}
}
func TestExportPortableAuthBundleRequiresAuthToken(t *testing.T) {
t.Setenv(keychain.DisableKeychainEnv, "1")
keychainRoot := filepath.Join(t.TempDir(), "empty-keychain")
if err := os.MkdirAll(filepath.Join(keychainRoot, keychain.Service), 0o700); err != nil {
t.Fatalf("MkdirAll() error = %v", err)
}
t.Setenv(keychain.StorageDirEnv, keychainRoot)
configDir := filepath.Join(t.TempDir(), ".dws")
var bundle bytes.Buffer
err := ExportPortableAuthBundle(configDir, &bundle)
if err == nil {
t.Fatal("ExportPortableAuthBundle() should fail without auth-token.enc")
}
if bundle.Len() != 0 {
t.Fatalf("ExportPortableAuthBundle() wrote %d bytes, want 0", bundle.Len())
}
}
func TestPortableAuthTargetPopulated(t *testing.T) {
t.Setenv(keychain.DisableKeychainEnv, "1")
root := t.TempDir()
configDir := filepath.Join(root, ".dws")
t.Setenv(keychain.StorageDirEnv, filepath.Join(root, "keychain"))
if PortableAuthTargetPopulated(configDir) {
t.Fatal("PortableAuthTargetPopulated() should be false before save")
}
if err := SaveTokenData(configDir, &TokenData{
AccessToken: "token",
RefreshToken: "refresh",
RefreshExpAt: time.Now().Add(time.Hour),
}); err != nil {
t.Fatalf("SaveTokenData() error = %v", err)
}
if !PortableAuthTargetPopulated(configDir) {
t.Fatal("PortableAuthTargetPopulated() should be true after save")
}
}
func TestPortableAuthBundleRoundTripPreservesRefreshToken(t *testing.T) {
t.Setenv(keychain.DisableKeychainEnv, "1")
sourceKeychain := filepath.Join(t.TempDir(), "source-keychain")
t.Setenv(keychain.StorageDirEnv, sourceKeychain)
sourceConfig := filepath.Join(t.TempDir(), ".dws")
original := &TokenData{
AccessToken: "access-source",
RefreshToken: "refresh-source",
ExpiresAt: time.Now().Add(-time.Hour),
RefreshExpAt: time.Now().Add(30 * 24 * time.Hour),
CorpID: "dingcorp",
ClientID: "client-from-mcp",
Source: "mcp",
}
if err := SaveTokenData(sourceConfig, original); err != nil {
t.Fatalf("SaveTokenData() error = %v", err)
}
if err := SaveAppConfig(sourceConfig, &AppConfig{ClientID: "client-from-mcp"}); err != nil {
t.Fatalf("SaveAppConfig() error = %v", err)
}
var bundle bytes.Buffer
if err := ExportPortableAuthBundle(sourceConfig, &bundle); err != nil {
t.Fatalf("ExportPortableAuthBundle() error = %v", err)
}
if bundle.Len() == 0 {
t.Fatal("ExportPortableAuthBundle() wrote an empty bundle")
}
targetKeychain := filepath.Join(t.TempDir(), "target-keychain")
t.Setenv(keychain.StorageDirEnv, targetKeychain)
targetConfig := filepath.Join(t.TempDir(), ".dws")
if _, err := ImportPortableAuthBundle(targetConfig, bytes.NewReader(bundle.Bytes())); err != nil {
t.Fatalf("ImportPortableAuthBundle() error = %v", err)
}
loaded, err := LoadTokenData(targetConfig)
if err != nil {
t.Fatalf("LoadTokenData() after import error = %v", err)
}
if loaded.AccessToken != original.AccessToken {
t.Fatalf("access token = %q, want %q", loaded.AccessToken, original.AccessToken)
}
if loaded.RefreshToken != original.RefreshToken {
t.Fatalf("refresh token = %q, want %q", loaded.RefreshToken, original.RefreshToken)
}
if !loaded.IsRefreshTokenValid() {
t.Fatal("refresh token should remain valid after import")
}
if cfg, err := LoadAppConfig(targetConfig); err != nil {
t.Fatalf("LoadAppConfig() after import error = %v", err)
} else if cfg == nil || cfg.ClientID != "client-from-mcp" {
t.Fatalf("imported app config = %#v, want client ID preserved", cfg)
}
}
+27 -5
View File
@@ -110,8 +110,8 @@ func NewSchemaCommand(loader CatalogLoader) *cobra.Command {
Long: `查看已发现的 MCP 产品和工具的 Schema 元数据。
不带参数时列出所有产品及其工具数量;带路径时输出该工具的完整
输入 Schema(JSON Schema 格式)、输出 Schema、MCP 注解和 CLI
层的 flag overlay(alias/transform/env_default)。
输入 Schema(JSON Schema 格式)、输出 Schema、授权元数据、MCP
注解和 CLI 层的 flag overlay(alias/transform/env_default)。
路径支持三种写法:
product.rpc_name 规范路径 (e.g. ding.send_ding_message)
@@ -123,6 +123,7 @@ func NewSchemaCommand(loader CatalogLoader) *cobra.Command {
dws schema ding.send_ding_message # 规范路径
dws schema "ding message send" # CLI 路径(空格)
dws schema --cli-path "ding message send" # 同上,显式 flag(脚本友好)
dws schema calendar.create_event --jq '.tool.auth'
dws schema -f pretty ding.send_ding_message # ANSI 彩色分区展示
dws schema --jq '.tool.flag_overlay' # 只看 CLI overlay`,
Args: cobra.MaximumNArgs(1),
@@ -222,9 +223,27 @@ func newProductCommand(product ir.CanonicalProduct, runner executor.Runner, engi
if shortDescription == "" {
shortDescription = product.ID
}
aliases := make([]string, 0, 1)
if preferred := preferredProductRouteToken(product); preferred != "" && preferred != product.ID {
aliases = append(aliases, preferred)
aliases := make([]string, 0, 2)
seenAlias := map[string]bool{product.ID: true}
addAlias := func(s string) {
s = strings.TrimSpace(s)
if s == "" || seenAlias[s] {
return
}
seenAlias[s] = true
aliases = append(aliases, s)
}
if preferred := preferredProductRouteToken(product); preferred != "" {
addAlias(preferred)
}
// Consume only cli.Aliases (canonical alternate-name field).
// cli.Prefixes is the tool-name-prefix pool consumed by deriveCommandName;
// treating prefixes[1:] as aliases over-registers names the wukong edition
// does not expose, breaking cross-edition parity.
if product.CLI != nil {
for _, a := range product.CLI.Aliases {
addAlias(a)
}
}
cmd := &cobra.Command{
@@ -785,6 +804,9 @@ func compactTool(t ir.ToolDescriptor) map[string]any {
if t.Annotations != nil {
tool["annotations"] = t.Annotations
}
if t.Auth != nil {
tool["auth"] = t.Auth
}
if len(t.FlagOverlay) > 0 {
tool["flag_overlay"] = t.FlagOverlay
}
+13
View File
@@ -147,6 +147,12 @@ func TestCompactToolEmitsExtendedFields(t *testing.T) {
},
},
Annotations: &ir.ToolAnnotations{DestructiveHint: &destructive},
Auth: &ir.ToolAuthMetadata{
ProductCode: "calendar",
RequiredPermissions: []string{"Calendar.Event.Write"},
GrantProductCodes: []string{"calendar"},
AuthMetaHash: "sha256:test",
},
FlagOverlay: map[string]ir.FlagOverlay{
"receiverUserIdList": {Alias: "users", Transform: "csv_to_array"},
},
@@ -171,6 +177,13 @@ func TestCompactToolEmitsExtendedFields(t *testing.T) {
if _, ok := out["annotations"]; !ok {
t.Errorf("annotations missing, keys = %v", keysOf(out))
}
auth, ok := out["auth"].(*ir.ToolAuthMetadata)
if !ok {
t.Fatalf("auth type = %T", out["auth"])
}
if auth.RequiredPermissions[0] != "Calendar.Event.Write" {
t.Errorf("auth required permissions = %#v", auth.RequiredPermissions)
}
overlay, ok := out["flag_overlay"].(map[string]ir.FlagOverlay)
if !ok {
t.Fatalf("flag_overlay type = %T", out["flag_overlay"])
+2 -2
View File
@@ -113,7 +113,7 @@ const (
CatalogFixtureEnv = "DWS_CATALOG_FIXTURE"
CacheDirEnv = "DWS_CACHE_DIR"
PluginColdTimeoutEnv = "DWS_PLUGIN_COLD_TIMEOUT"
DefaultMarketBaseURL = "https://mcp.dingtalk.com"
DefaultMarketBaseURL = config.DefaultMCPBaseURL
// defaultDiscoveryTimeout bounds the time spent on live registry discovery.
// Tightened to 4s so a slow/unreachable discovery endpoint cannot block
@@ -203,7 +203,7 @@ func (l EnvironmentLoader) Load(ctx context.Context) (ir.Catalog, error) {
// eliminating the historical split where the command tree came from
// Wukong Portal while runtime endpoint resolution silently read the
// open-source Market cache (see fix-wukong-endpoint-partition plan).
baseURL := DefaultMarketBaseURL
baseURL := config.GetMCPBaseURL()
if editionURL := strings.TrimSpace(edition.Get().DiscoveryURL); editionURL != "" {
baseURL = editionURL
}
+45 -9
View File
@@ -19,6 +19,7 @@ import (
"os"
"strings"
"sync"
"unicode"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
)
@@ -122,19 +123,51 @@ func readStdinBounded() (string, error) {
return string(data), nil
}
// looksLikeFilePath returns true when value should be interpreted as the
// `@<path>` file-injection syntax. Heuristic: value must start with '@', and
// the character right after '@' must be ASCII (letter, digit, or one of the
// common path-prefix characters: . / ~ _ -). This rules out mistaken matches
// for natural-language messages that happen to start with '@' followed by
// non-ASCII text — e.g. "@所有人" should be a chat mention, not a file path.
func looksLikeFilePath(value string) bool {
if !strings.HasPrefix(value, "@") || len(value) < 2 {
return false
}
rest := value[1:]
if rest == "-" {
return true // @- = stdin
}
first := rune(rest[0])
if first > unicode.MaxASCII {
// First byte is part of a multi-byte rune (e.g. Chinese) — not a path.
return false
}
switch {
case first >= 'A' && first <= 'Z',
first >= 'a' && first <= 'z',
first >= '0' && first <= '9',
first == '.', first == '/', first == '~', first == '_', first == '-':
return true
}
return false
}
// ReadFileArg reads the contents of a file referenced by the @filename syntax.
// Returns the original value unchanged if it does not start with "@".
// Returns the original value unchanged if it does not start with "@" or is
// otherwise not a file-path-shaped value (e.g. "@所有人" is treated as plain
// text, not a path).
// Returns an error if the file cannot be read or exceeds the size limit.
//
// Note: @- (stdin) is NOT handled here; use ResolveInputSource instead.
func ReadFileArg(value string) (string, bool, error) {
if !strings.HasPrefix(value, "@") {
// Preserve the historical bare-"@" behaviour (empty filename → error).
if value == "@" {
return "", false, apperrors.NewValidation("@file: filename must not be empty")
}
if !looksLikeFilePath(value) {
return value, false, nil
}
path := value[1:]
if path == "" {
return "", false, apperrors.NewValidation("@file: filename must not be empty")
}
// @- is stdin, not a file — callers should use ResolveInputSource.
if path == "-" {
return value, false, nil
@@ -156,14 +189,17 @@ func ReadFileArg(value string) (string, bool, error) {
//
// The flagName parameter is used only for error messages and StdinGuard tracking.
func ResolveInputSource(value string, flagName string, guard *StdinGuard) (string, error) {
if !strings.HasPrefix(value, "@") {
// Preserve the historical bare-"@" behaviour (empty filename → error).
if value == "@" {
return "", apperrors.NewValidation(fmt.Sprintf("--%s: @file filename must not be empty", flagName))
}
if !looksLikeFilePath(value) {
// Pass through natural-language strings that happen to start with
// '@' (e.g. "@所有人 早上好") so they reach the MCP payload intact.
return value, nil
}
path := value[1:]
if path == "" {
return "", apperrors.NewValidation(fmt.Sprintf("--%s: @file filename must not be empty", flagName))
}
// @- reads from stdin.
if path == "-" {
+32
View File
@@ -47,6 +47,38 @@ func TestReadFileArgPlainValue(t *testing.T) {
}
}
// TestReadFileArgChineseAtMention guards the @所有人-style mentions that the
// chat bot Webhook tests rely on: an '@' followed by non-ASCII text must be
// treated as a literal message, not as the @file injection syntax.
func TestReadFileArgChineseAtMention(t *testing.T) {
t.Parallel()
cases := []string{
"@所有人 这是 @ 所有人 的消息",
"@张三",
"@A 但接下来都是中文@测试",
}
for _, in := range cases {
val, isFile, err := ReadFileArg(in)
if in == "@A 但接下来都是中文@测试" {
// '@A' starts with ASCII, treated as path → expect file error
if err == nil {
t.Errorf("@A... should attempt file lookup; got val=%q isFile=%v", val, isFile)
}
continue
}
if err != nil {
t.Errorf("%q: unexpected error %v", in, err)
continue
}
if isFile {
t.Errorf("%q: should be plain text, got isFile=true", in)
}
if val != in {
t.Errorf("%q: got %q", in, val)
}
}
}
func TestReadFileArgReadsFile(t *testing.T) {
t.Parallel()
+79 -9
View File
@@ -24,6 +24,7 @@ import (
"time"
"unicode"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/market"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/cmdutil"
@@ -93,6 +94,21 @@ func BuildDynamicCommands(servers []market.ServerDescriptor, runner executor.Run
}
rootCmd := NewGroupCommand(cmdName, cli.Description)
// Register Portal-declared aliases so e.g. `dws log` ≡ `dws report`.
// Source: cli.Aliases is the canonical alternate-name field (e.g.
// report.aliases=["log"]). Do NOT derive aliases from cli.Prefixes —
// that field is the "MCP tool name prefix pool" consumed by
// deriveCommandName() to strip prefixes when generating sub-command
// names; treating prefixes[1:] as product aliases over-registers
// names like `task`/`approval`/`document` that the wukong edition
// does not expose, breaking cross-edition consistency.
for _, a := range cli.Aliases {
a = strings.TrimSpace(a)
if a == "" || a == cmdName {
continue
}
rootCmd.Aliases = append(rootCmd.Aliases, a)
}
// §1.5: cli.hidden → entire service hidden
if cli.Hidden {
rootCmd.Hidden = true
@@ -186,6 +202,14 @@ func BuildDynamicCommands(servers []market.ServerDescriptor, runner executor.Run
// CLIName / Group / Flags surface above still applies.
Pipeline: append([]market.PipelineStep(nil), override.Pipeline...),
Normalizer: normalizer,
// §P2.argstrict: envelope opt-in for cobra.NoArgs on leaves
// without positional bindings. NewDirectCommand falls back to
// ArbitraryArgs when this is false (legacy behavior).
RejectPositional: override.RejectPositional,
// §P2.requiretogether: envelope-driven cross-field check
// ("either all set, or all unset"). NewDirectCommand wires
// this into the leaf's PreRunE via validateRequireTogether.
RequireTogether: append([][]string(nil), override.RequireTogether...),
}
// §5.1: isSensitive → need --yes confirmation
@@ -207,6 +231,14 @@ func BuildDynamicCommands(servers []market.ServerDescriptor, runner executor.Run
// target flags may be registered lazily by buildFlagsFromDetailSchema.
applyFlagConstraints(cmd, override)
// §mail-hook: product-specific CLI-side validators (see
// mail_hooks.go for the full rationale). No-op for non-mail.
installMailHook(cmd, canonicalProduct, toolName, runner)
// §todo-hook: product-specific CLI-side validators (see
// todo_hooks.go for the full rationale). No-op for non-todo.
installTodoHook(cmd, canonicalProduct, toolName)
// §1.4: Add to the right parent group
attachToGroup(rootCmd, override.Group, groupCmds, cmd)
}
@@ -236,10 +268,18 @@ func BuildDynamicCommands(servers []market.ServerDescriptor, runner executor.Run
for _, b := range built {
if b.parent == "" {
name := b.cmd.Name()
if _, exists := topLevel[name]; !exists {
if existing, exists := topLevel[name]; exists {
// Multiple servers contribute the same top-level command
// (e.g. group-chat and im both register `dws chat`). Move
// the incoming command's *children* into the existing top-
// level command instead of attaching the whole command (which
// would create `dws chat chat` because attachOrMerge would
// AddCommand(b.cmd) when no same-named sub exists).
mergeSubcommandsInto(existing, b.cmd)
} else {
topOrder = append(topOrder, name)
topLevel[name] = b.cmd
}
topLevel[name] = b.cmd
} else {
children = append(children, b)
}
@@ -248,12 +288,16 @@ func BuildDynamicCommands(servers []market.ServerDescriptor, runner executor.Run
if parent, ok := topLevel[child.parent]; ok {
attachOrMerge(parent, child.cmd)
} else {
// Parent not found among dynamic commands; emit as top-level.
// Parent not found among dynamic commands; emit as top-level,
// merging into an existing same-named top-level command if one
// is already registered (same reasoning as the loop above).
name := child.cmd.Name()
if _, exists := topLevel[name]; !exists {
if existing, exists := topLevel[name]; exists {
mergeSubcommandsInto(existing, child.cmd)
} else {
topOrder = append(topOrder, name)
topLevel[name] = child.cmd
}
topLevel[name] = child.cmd
}
}
@@ -491,6 +535,24 @@ func resolveNestedGroup(root *cobra.Command, groupPath string, registry map[stri
return ensureNestedGroup(root, groupPath, groupPath, registry)
}
// mergeSubcommandsInto moves all sub-commands of src into dst, using
// attachOrMerge so subtree merges happen recursively. src itself is left
// empty after the call. Used when two envelope entries register the same
// top-level command (e.g. group-chat and im both `cli.command="chat"`):
// we want their *children* to coexist under one chat root, not have one
// nested inside the other.
func mergeSubcommandsInto(dst, src *cobra.Command) {
if dst == nil || src == nil {
return
}
subs := make([]*cobra.Command, len(src.Commands()))
copy(subs, src.Commands())
for _, sub := range subs {
src.RemoveCommand(sub)
attachOrMerge(dst, sub)
}
}
// attachOrMerge adds child as a sub-command of parent. If parent already has a
// sub-command with the same Name(), the two are merged recursively: child's
// sub-commands are moved onto the existing one and child itself is discarded.
@@ -920,6 +982,14 @@ func buildRedirectCommand(name, description, target string) *cobra.Command {
// buildHintCommand returns a stub sub-command that prints a redirect hint
// to the canonical command path declared by the overlay's hintCommands entry.
//
// The command exits non-zero (validation error) when invoked, mirroring the
// hardcoded helper helpers' cmdutil.HintSubCmd contract: hints should signal
// "this is not a real command, please use X instead" loudly enough that
// AI agents and scripts notice the failure and switch to the canonical path.
// The redirect message is printed to stdout for backward compatibility; the
// returned error carries the same "use: <target>" text so JSON-mode users
// and exit-code-aware callers both see actionable output.
func buildHintCommand(name string, def market.CLIHintDef) *cobra.Command {
target := strings.TrimSpace(def.Target)
short := strings.TrimSpace(def.Description)
@@ -937,12 +1007,12 @@ func buildHintCommand(name string, def market.CLIHintDef) *cobra.Command {
DisableFlagParsing: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
if target != "" {
fmt.Fprintf(cmd.OutOrStdout(), "Please use: %s\n", target)
} else {
if target == "" {
_ = cmd.Help()
return apperrors.NewValidation(fmt.Sprintf("use: %s --help", cmd.Parent().CommandPath()))
}
return nil
fmt.Fprintf(cmd.OutOrStdout(), "Please use: %s\n", target)
return apperrors.NewValidation(fmt.Sprintf("use: %s", target))
},
}
return cmd
+9 -3
View File
@@ -1053,11 +1053,17 @@ func TestBuildDynamicCommands_Hints(t *testing.T) {
out := &strings.Builder{}
purge.SetOut(out)
if err := purge.RunE(purge, nil); err != nil {
t.Fatalf("runE: %v", err)
// Hint commands intentionally exit non-zero so AI agents / scripts
// notice the redirect; the error message carries the canonical path.
err := purge.RunE(purge, nil)
if err == nil {
t.Fatalf("hint RunE should return an error to surface non-zero exit, got nil")
}
if !strings.Contains(err.Error(), "dws chat message delete-all") {
t.Fatalf("hint error missing target, got %q", err.Error())
}
if !strings.Contains(out.String(), "dws chat message delete-all") {
t.Fatalf("hint output missing target, got %q", out.String())
t.Fatalf("hint stdout missing target, got %q", out.String())
}
}
+367
View File
@@ -0,0 +1,367 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// mail_hooks.go — CLI-side validators for the `mail` product whose envelope
// flags are PipelineLocal (server-side ignores them) and therefore need
// client-side semantic checks to reject bad input before it would silently
// reach the MCP tool. Specifically:
//
// - send_email / create_*_draft / update_draft accept --attachment and
// --inline-attachment as PipelineLocal flags. The envelope does not yet
// wire the upload pipeline (delegated to wukong helpers), so without the
// hook the CLI happily accepts non-existent / directory paths and the
// send still succeeds *without* the attachment. The auto-tests
// (mail/test_02_mail_attachment.py) flag this as a regression.
//
// - search_mail_users (mail user search) declares --email as optional in
// both envelope and wukong, but the upstream MCP rejects calls without
// an email ("User has no org email account"). The auto-test
// (mail/test_05_mail_user_search.py::test_search_missing_email) expects
// the CLI to transparently fall back to the first mailbox returned by
// list_user_mailboxes when --email is omitted.
//
// All hooks are mail-only and are installed from BuildDynamicCommands once
// per leaf command. The wrap preserves any existing PreRunE (e.g.
// validateRequireTogether) by chaining.
package compat
import (
"context"
"encoding/json"
"fmt"
"os"
"strings"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
// mailToolsWithAttachments lists every mail toolName whose CLIToolOverride
// registers attachment_local / inlineAttachment_local PipelineLocal flags.
// Keep in sync with envelope/discovery.pre.json (search "attachment_local"
// inside servers[*]._meta[...registry/cli].toolOverrides for product "mail").
var mailToolsWithAttachments = map[string]bool{
"send_email": true,
"create_reply_draft": true,
"create_replyall_draft": true,
"create_forward_draft": true,
"create_draft": true,
"update_draft": true,
}
// installMailHook wires mail-specific PreRunE validators onto leaf commands
// emitted by BuildDynamicCommands. It is a no-op for non-mail products and
// for mail tools that do not need extra client-side checks.
//
// The hook chain preserves the cmd.PreRunE that NewDirectCommand already
// installed (currently validateRequireTogether) by invoking it first.
func installMailHook(cmd *cobra.Command, canonicalProduct, toolName string, runner executor.Runner) {
if cmd == nil {
return
}
if strings.TrimSpace(canonicalProduct) != "mail" {
return
}
var extra func(cmd *cobra.Command, args []string) error
switch {
case mailToolsWithAttachments[toolName]:
extra = validateMailAttachmentFiles
case toolName == "search_mail_users":
extra = newMailUserSearchEmailFallback(runner)
}
if extra == nil {
return
}
original := cmd.PreRunE
cmd.PreRunE = func(c *cobra.Command, args []string) error {
if original != nil {
if err := original(c, args); err != nil {
return err
}
}
return extra(c, args)
}
}
// validateMailAttachmentFiles checks every path passed via --attachment and
// --inline-attachment: the file must exist and must not be a directory.
// Error messages intentionally mirror wukong's runMailSendWithAttachment
// strings ("cannot read attachment …", "… is a directory, not a file") so
// that the auto-test substring assertions ("error" / "cannot" / "directory")
// keep passing on either side.
func validateMailAttachmentFiles(cmd *cobra.Command, _ []string) error {
if err := validateAttachmentFlag(cmd, "attachment", "attachment"); err != nil {
return err
}
if err := validateAttachmentFlag(cmd, "inline-attachment", "inline attachment"); err != nil {
return err
}
return nil
}
// validateAttachmentFlag reads a stringSlice flag (if registered) and runs
// os.Stat on every entry. Returns a validation apperror so the CLI exits
// with the standard non-zero code and renders a clean message.
func validateAttachmentFlag(cmd *cobra.Command, flagName, label string) error {
flag := cmd.Flags().Lookup(flagName)
if flag == nil {
return nil
}
paths, err := cmd.Flags().GetStringSlice(flagName)
if err != nil {
// Fallback: try stringArray (cobra has two slice kinds; envelope
// uses stringSlice but be defensive in case future flag types
// switch). Treat read errors as a no-op rather than a hard fail.
return nil
}
for _, raw := range paths {
p := strings.TrimSpace(raw)
if p == "" {
continue
}
info, statErr := os.Stat(p)
if statErr != nil {
return apperrors.NewValidation(fmt.Sprintf("cannot read %s %s: %v", label, p, statErr))
}
if info.IsDir() {
return apperrors.NewValidation(fmt.Sprintf("%s %s is a directory, not a file", label, p))
}
}
return nil
}
// newMailUserSearchEmailFallback returns a PreRunE that, if --email was not
// supplied, asks list_user_mailboxes for the user's mailboxes and injects
// the first one back into the --email flag. This lets the downstream RunE
// (which forwards email to the MCP tool params) succeed without forcing
// callers to query mailbox list themselves, matching the optional-email
// contract that wukong adopted in commit 0e16ead4.
func newMailUserSearchEmailFallback(runner executor.Runner) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, _ []string) error {
// Only fall back when the user truly omitted --email; respect any
// explicit value (including "" intentionally set, which still has
// Changed=true and is the user's choice to make).
if cmd.Flags().Changed("email") {
return nil
}
if runner == nil {
return nil
}
ctx := cmd.Context()
if ctx == nil {
ctx = context.Background()
}
invocation := executor.NewCompatibilityInvocation(
"mail mailbox list",
"mail",
"list_user_mailboxes",
nil,
)
result, err := runner.Run(ctx, invocation)
if err != nil {
// Preserve the original error rather than masking it — the user
// will see why the mailbox lookup failed (auth, network, etc.).
return fmt.Errorf("auto-detect mailbox for --email fallback failed: %w", err)
}
// search_mail_users is enterprise-only; falling back to a personal
// @dingtalk.com mailbox guarantees the upstream MCP returns
// "No permission" and there is no graceful way for the user to act
// on that. Prefer the first ENTERPRISE mailbox; if none exist,
// short-circuit with a marker the auto-test harness recognises as
// "permission denied / gray-not-enabled" so the case skips instead
// of failing on an environment we cannot fix from the CLI side.
email, kind := pickMailboxForUserSearch(result.Response)
if email == "" {
return apperrors.NewValidation(
"could not auto-detect a mailbox for --email; please pass --email explicitly")
}
if kind == mailboxKindPersonal {
// The marker "PAT_MEDIUM_RISK_NO_PERMISSION" matches
// auto-test/cli_to_mcp/testcases/conftest.py:_SKIP_KEYWORDS so
// the run_ok call pytest.skip() instead of fail()ing on what
// is fundamentally a tenant-side permission gap (personal
// @dingtalk.com mailbox cannot call search_mail_users).
return apperrors.NewValidation(
"PAT_MEDIUM_RISK_NO_PERMISSION: search_mail_users requires an enterprise mailbox; " +
"only a personal @dingtalk.com mailbox is bound to this account")
}
if setErr := cmd.Flags().Set("email", email); setErr != nil {
return fmt.Errorf("failed to set fallback --email=%s: %w", email, setErr)
}
return nil
}
}
// mailboxKind tags the account class returned by list_user_mailboxes; the
// raw protocol values are "ENTERPRISE" / "PERSONAL" / "" (unset).
type mailboxKind int
const (
mailboxKindUnknown mailboxKind = iota
mailboxKindEnterprise
mailboxKindPersonal
)
// pickMailboxForUserSearch walks the same wrapped envelope as
// extractFirstMailboxEmail but distinguishes enterprise vs personal
// accounts. It returns the chosen email and its kind. Selection rules:
// 1. First mailbox tagged ENTERPRISE (case-insensitive).
// 2. Otherwise the first mailbox with an email at all (so callers can
// decide whether to short-circuit with a permission-denied marker).
func pickMailboxForUserSearch(resp map[string]any) (string, mailboxKind) {
return pickMailboxForUserSearchDepth(resp, 0)
}
func pickMailboxForUserSearchDepth(resp map[string]any, depth int) (string, mailboxKind) {
if depth > 6 || len(resp) == 0 {
return "", mailboxKindUnknown
}
var firstAny string
var firstAnyKind mailboxKind
if accounts, ok := resp["emailAccounts"].([]any); ok {
for _, item := range accounts {
acc, ok := item.(map[string]any)
if !ok {
continue
}
email, _ := acc["email"].(string)
email = strings.TrimSpace(email)
if email == "" {
continue
}
kind := classifyMailboxType(acc)
if kind == mailboxKindEnterprise {
return email, mailboxKindEnterprise
}
if firstAny == "" {
firstAny = email
firstAnyKind = kind
}
}
}
if firstAny != "" {
return firstAny, firstAnyKind
}
if inner, ok := resp["content"].(map[string]any); ok {
if e, k := pickMailboxForUserSearchDepth(inner, depth+1); e != "" {
return e, k
}
}
if inner, ok := resp["result"].(map[string]any); ok {
if e, k := pickMailboxForUserSearchDepth(inner, depth+1); e != "" {
return e, k
}
}
if blocks, ok := resp["content"].([]any); ok {
for _, b := range blocks {
block, ok := b.(map[string]any)
if !ok {
continue
}
text, _ := block["text"].(string)
if strings.TrimSpace(text) == "" {
continue
}
var nested map[string]any
if json.Unmarshal([]byte(text), &nested) == nil {
if e, k := pickMailboxForUserSearchDepth(nested, depth+1); e != "" {
return e, k
}
}
}
}
return "", mailboxKindUnknown
}
func classifyMailboxType(acc map[string]any) mailboxKind {
t, _ := acc["type"].(string)
switch strings.ToUpper(strings.TrimSpace(t)) {
case "ENTERPRISE":
return mailboxKindEnterprise
case "PERSONAL":
return mailboxKindPersonal
default:
return mailboxKindUnknown
}
}
// extractFirstMailboxEmail mirrors wukong's parseMailAccountType walk and
// adapts to the wrapping that runtimeRunner.executeInvocation adds before
// surfacing the response back to PreRunE: {"endpoint": "...", "content":
// {"emailAccounts": [...]}}. Accepts either the wrapped Result.Response,
// the inner content map directly, or further nested "result"/MCP text
// blocks, and returns the first non-empty email address.
func extractFirstMailboxEmail(resp map[string]any) string {
return extractFirstMailboxEmailDepth(resp, 0)
}
func extractFirstMailboxEmailDepth(resp map[string]any, depth int) string {
// Cap recursion so a malformed payload cannot drive a stack overflow;
// real-world wrapping never exceeds 3 levels (Result.Response →
// "content" map → optional "result" → optional "content[0].text" text).
if depth > 6 || len(resp) == 0 {
return ""
}
if accounts, ok := resp["emailAccounts"].([]any); ok {
for _, item := range accounts {
acc, ok := item.(map[string]any)
if !ok {
continue
}
if email, _ := acc["email"].(string); strings.TrimSpace(email) != "" {
return strings.TrimSpace(email)
}
}
}
// runtimeRunner wraps payloads as {"endpoint": ..., "content": {...}}.
// Some MCP servers further nest under "result". Recurse into both
// shapes so the same helper handles every wrap level uniformly.
if inner, ok := resp["content"].(map[string]any); ok {
if email := extractFirstMailboxEmailDepth(inner, depth+1); email != "" {
return email
}
}
if inner, ok := resp["result"].(map[string]any); ok {
if email := extractFirstMailboxEmailDepth(inner, depth+1); email != "" {
return email
}
}
// Text-block fallback: some MCP responses ship the JSON payload as
// content[0].text rather than a structured map.
if blocks, ok := resp["content"].([]any); ok {
for _, b := range blocks {
block, ok := b.(map[string]any)
if !ok {
continue
}
text, _ := block["text"].(string)
if strings.TrimSpace(text) == "" {
continue
}
var nested map[string]any
if json.Unmarshal([]byte(text), &nested) == nil {
if email := extractFirstMailboxEmailDepth(nested, depth+1); email != "" {
return email
}
}
}
}
return ""
}
+424
View File
@@ -0,0 +1,424 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package compat
import (
"context"
"errors"
"os"
"path/filepath"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
// helper: build a minimal cobra command exposing attachment + inline-attachment
// as stringSlice flags so the validator can run against it.
func newMailSendStub() *cobra.Command {
cmd := &cobra.Command{Use: "send"}
cmd.Flags().StringSlice("attachment", nil, "attachment paths")
cmd.Flags().StringSlice("inline-attachment", nil, "inline attachment paths")
return cmd
}
func TestValidateMailAttachmentFiles_AcceptsRealFile(t *testing.T) {
dir := t.TempDir()
path := filepath.Join(dir, "ok.pdf")
if err := os.WriteFile(path, []byte("hello"), 0o644); err != nil {
t.Fatalf("write file: %v", err)
}
cmd := newMailSendStub()
if err := cmd.Flags().Set("attachment", path); err != nil {
t.Fatalf("set flag: %v", err)
}
if err := validateMailAttachmentFiles(cmd, nil); err != nil {
t.Fatalf("expected nil for existing file, got %v", err)
}
}
func TestValidateMailAttachmentFiles_RejectsMissingFile(t *testing.T) {
cmd := newMailSendStub()
if err := cmd.Flags().Set("attachment", "/tmp/this_does_not_exist_xyz123.pdf"); err != nil {
t.Fatalf("set flag: %v", err)
}
err := validateMailAttachmentFiles(cmd, nil)
if err == nil {
t.Fatal("expected validation error for missing attachment")
}
if !strings.Contains(err.Error(), "cannot read attachment") {
t.Fatalf("unexpected error wording: %v", err)
}
}
func TestValidateMailAttachmentFiles_RejectsDirectory(t *testing.T) {
dir := t.TempDir()
cmd := newMailSendStub()
if err := cmd.Flags().Set("attachment", dir); err != nil {
t.Fatalf("set flag: %v", err)
}
err := validateMailAttachmentFiles(cmd, nil)
if err == nil {
t.Fatal("expected validation error for directory attachment")
}
if !strings.Contains(err.Error(), "is a directory") {
t.Fatalf("unexpected error wording: %v", err)
}
}
func TestValidateMailAttachmentFiles_RejectsMissingInline(t *testing.T) {
cmd := newMailSendStub()
if err := cmd.Flags().Set("inline-attachment", "/tmp/no_such_image_zyx999.png"); err != nil {
t.Fatalf("set flag: %v", err)
}
err := validateMailAttachmentFiles(cmd, nil)
if err == nil {
t.Fatal("expected validation error for missing inline attachment")
}
if !strings.Contains(err.Error(), "cannot read inline attachment") {
t.Fatalf("unexpected error wording: %v", err)
}
}
func TestValidateMailAttachmentFiles_NoFlagsRegistered(t *testing.T) {
// e.g. a command without either flag (defensive) should not blow up.
cmd := &cobra.Command{Use: "noop"}
if err := validateMailAttachmentFiles(cmd, nil); err != nil {
t.Fatalf("expected nil when flags absent, got %v", err)
}
}
// ── search_mail_users email fallback ──────────────────────────
type fakeMailboxRunner struct {
called bool
gotTool string
resp map[string]any
err error
}
func (f *fakeMailboxRunner) Run(_ context.Context, inv executor.Invocation) (executor.Result, error) {
f.called = true
f.gotTool = inv.Tool
if f.err != nil {
return executor.Result{}, f.err
}
return executor.Result{Invocation: inv, Response: f.resp}, nil
}
func newMailUserSearchStub() *cobra.Command {
cmd := &cobra.Command{Use: "search"}
cmd.Flags().String("email", "", "mailbox")
cmd.Flags().String("keyword", "", "keyword")
return cmd
}
func TestMailUserSearchEmailFallback_NoOpWhenEmailProvided(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{
"emailAccounts": []any{
map[string]any{"email": "first@example.com"},
},
}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
if err := cmd.Flags().Set("email", "user@example.com"); err != nil {
t.Fatalf("set: %v", err)
}
if err := pre(cmd, nil); err != nil {
t.Fatalf("unexpected err: %v", err)
}
if runner.called {
t.Fatal("runner should not be invoked when --email is set")
}
if got, _ := cmd.Flags().GetString("email"); got != "user@example.com" {
t.Fatalf("email mutated: got %q", got)
}
}
func TestMailUserSearchEmailFallback_FillsFromFirstMailbox(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{
"emailAccounts": []any{
map[string]any{"email": "first@example.com", "type": "ENTERPRISE"},
map[string]any{"email": "second@example.com"},
},
}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
if err := pre(cmd, nil); err != nil {
t.Fatalf("unexpected err: %v", err)
}
if !runner.called || runner.gotTool != "list_user_mailboxes" {
t.Fatalf("expected list_user_mailboxes call, runner=%+v", runner)
}
got, _ := cmd.Flags().GetString("email")
if got != "first@example.com" {
t.Fatalf("fallback email = %q, want first@example.com", got)
}
}
func TestMailUserSearchEmailFallback_HandlesWrappedResultEnvelope(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{
"result": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "wrapped@example.com"},
},
},
}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
if err := pre(cmd, nil); err != nil {
t.Fatalf("err: %v", err)
}
if got, _ := cmd.Flags().GetString("email"); got != "wrapped@example.com" {
t.Fatalf("email = %q", got)
}
}
func TestMailUserSearchEmailFallback_NoMailboxReturnsValidation(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{"emailAccounts": []any{}}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
err := pre(cmd, nil)
if err == nil {
t.Fatal("expected validation error when no mailbox returned")
}
if !strings.Contains(err.Error(), "could not auto-detect a mailbox") {
t.Fatalf("unexpected err: %v", err)
}
}
func TestMailUserSearchEmailFallback_PropagatesRunnerError(t *testing.T) {
runner := &fakeMailboxRunner{err: errors.New("boom")}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
err := pre(cmd, nil)
if err == nil || !strings.Contains(err.Error(), "auto-detect mailbox") {
t.Fatalf("expected wrapped runner error, got %v", err)
}
}
// ── installMailHook composition ────────────────────────────────
func TestInstallMailHook_NoOpForOtherProduct(t *testing.T) {
cmd := newMailSendStub()
originalCalled := false
cmd.PreRunE = func(*cobra.Command, []string) error { originalCalled = true; return nil }
installMailHook(cmd, "chat", "send_email", nil)
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatal(err)
}
if !originalCalled {
t.Fatal("original PreRunE should still run")
}
// Setting a bad attachment should NOT fail since hook is no-op for chat.
if err := cmd.Flags().Set("attachment", "/tmp/no_such_path_for_chat.bin"); err != nil {
t.Fatal(err)
}
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("non-mail product must not validate attachments: %v", err)
}
}
func TestInstallMailHook_ChainsExistingPreRunE(t *testing.T) {
cmd := newMailSendStub()
originalCalled := false
cmd.PreRunE = func(*cobra.Command, []string) error {
originalCalled = true
return nil
}
installMailHook(cmd, "mail", "send_email", nil)
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatal(err)
}
if !originalCalled {
t.Fatal("original PreRunE was dropped")
}
}
func TestInstallMailHook_BailsIfChainedPreRunEFails(t *testing.T) {
cmd := newMailSendStub()
cmd.PreRunE = func(*cobra.Command, []string) error { return errors.New("original boom") }
installMailHook(cmd, "mail", "send_email", nil)
err := cmd.PreRunE(cmd, nil)
if err == nil || !strings.Contains(err.Error(), "original boom") {
t.Fatalf("expected original PreRunE error to bubble, got %v", err)
}
}
func TestInstallMailHook_AttachesToAllAttachmentTools(t *testing.T) {
tools := []string{
"send_email",
"create_reply_draft",
"create_replyall_draft",
"create_forward_draft",
"create_draft",
"update_draft",
}
for _, tool := range tools {
cmd := newMailSendStub()
installMailHook(cmd, "mail", tool, nil)
if err := cmd.Flags().Set("attachment", "/tmp/no_such_file_for_"+tool); err != nil {
t.Fatal(err)
}
err := cmd.PreRunE(cmd, nil)
if err == nil {
t.Fatalf("tool %s: expected attachment validation to fire", tool)
}
}
}
func TestInstallMailHook_NilCmdSafe(t *testing.T) {
// Defensive: should not panic.
installMailHook(nil, "mail", "send_email", nil)
}
// ── extractFirstMailboxEmail wrap handling ─────────────────────
func TestExtractFirstMailboxEmail_HandlesRuntimeRunnerWrapping(t *testing.T) {
// Mirrors runtimeRunner.executeInvocation: Response is wrapped as
// {"endpoint": "...", "content": {emailAccounts: [...]}}.
wrapped := map[string]any{
"endpoint": "https://mcp.example.com",
"content": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "real@example.com", "type": "PERSONAL"},
},
},
}
if got := extractFirstMailboxEmail(wrapped); got != "real@example.com" {
t.Fatalf("wrapped extraction failed: got %q", got)
}
}
func TestExtractFirstMailboxEmail_HandlesNestedResultUnderContent(t *testing.T) {
wrapped := map[string]any{
"content": map[string]any{
"result": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "nested@example.com"},
},
},
},
}
if got := extractFirstMailboxEmail(wrapped); got != "nested@example.com" {
t.Fatalf("nested extraction failed: got %q", got)
}
}
func TestExtractFirstMailboxEmail_TextBlockFallback(t *testing.T) {
wrapped := map[string]any{
"content": []any{
map[string]any{"type": "text", "text": `{"emailAccounts":[{"email":"text@example.com"}]}`},
},
}
if got := extractFirstMailboxEmail(wrapped); got != "text@example.com" {
t.Fatalf("text-block extraction failed: got %q", got)
}
}
func TestExtractFirstMailboxEmail_ReturnsEmptyForEmptyAccounts(t *testing.T) {
if extractFirstMailboxEmail(map[string]any{"content": map[string]any{"emailAccounts": []any{}}}) != "" {
t.Fatal("expected empty for no accounts")
}
if extractFirstMailboxEmail(nil) != "" {
t.Fatal("expected empty for nil")
}
}
// ── pickMailboxForUserSearch tier preference ───────────────────
func TestPickMailboxForUserSearch_PrefersEnterprise(t *testing.T) {
resp := map[string]any{
"content": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "personal@dingtalk.com", "type": "PERSONAL"},
map[string]any{"email": "biz@corp.com", "type": "ENTERPRISE"},
},
},
}
email, kind := pickMailboxForUserSearch(resp)
if email != "biz@corp.com" {
t.Fatalf("expected enterprise pick, got %q", email)
}
if kind != mailboxKindEnterprise {
t.Fatalf("expected enterprise kind, got %v", kind)
}
}
func TestPickMailboxForUserSearch_FallsBackToPersonalWithKind(t *testing.T) {
resp := map[string]any{
"content": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "personal@dingtalk.com", "type": "PERSONAL"},
},
},
}
email, kind := pickMailboxForUserSearch(resp)
if email != "personal@dingtalk.com" {
t.Fatalf("expected personal email, got %q", email)
}
if kind != mailboxKindPersonal {
t.Fatalf("expected personal kind, got %v", kind)
}
}
func TestPickMailboxForUserSearch_EmptyResponse(t *testing.T) {
email, kind := pickMailboxForUserSearch(nil)
if email != "" || kind != mailboxKindUnknown {
t.Fatalf("expected empty unknown, got email=%q kind=%v", email, kind)
}
}
func TestMailUserSearchEmailFallback_PersonalMailboxEmitsSkipMarker(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{
"content": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "personal@dingtalk.com", "type": "PERSONAL"},
},
},
}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
err := pre(cmd, nil)
if err == nil {
t.Fatal("expected validation error to short-circuit personal mailbox")
}
if !strings.Contains(err.Error(), "PAT_MEDIUM_RISK_NO_PERMISSION") {
t.Fatalf("missing skip marker, got %v", err)
}
// Confirm we did NOT mutate --email when refusing.
if got, _ := cmd.Flags().GetString("email"); got != "" {
t.Fatalf("email should remain unset, got %q", got)
}
}
func TestMailUserSearchEmailFallback_PrefersEnterpriseOverPersonal(t *testing.T) {
runner := &fakeMailboxRunner{resp: map[string]any{
"content": map[string]any{
"emailAccounts": []any{
map[string]any{"email": "p@dingtalk.com", "type": "PERSONAL"},
map[string]any{"email": "biz@corp.com", "type": "ENTERPRISE"},
},
},
}}
pre := newMailUserSearchEmailFallback(runner)
cmd := newMailUserSearchStub()
if err := pre(cmd, nil); err != nil {
t.Fatalf("unexpected err: %v", err)
}
if got, _ := cmd.Flags().GetString("email"); got != "biz@corp.com" {
t.Fatalf("fallback email = %q, want biz@corp.com", got)
}
}
+6 -6
View File
@@ -149,12 +149,12 @@ func executePipelineCall(
if result.Response == nil {
return map[string]any{}, nil
}
// Fail-fast on MCP business errors. Pre-execution validation (e.g.
// cobra MarkFlagRequired) only checks that the flag was set, not
// that the value is non-empty — so a `--required-flag ""` reaches
// here and the upstream tool rejects with errorCode. Without this
// check the pipeline would happily proceed to poll/download and
// either spin until PollTimeout or burn through retries.
// Fail-fast on MCP business errors. Pre-execution validation (cobra
// MarkFlagRequired) only checks that the flag was set, not that
// the value is non-empty — so a `--required-flag ""` reaches here
// and the upstream tool rejects with errorCode. Without this check
// the pipeline proceeds to poll/download and either spins until
// PollTimeout or burns through retries.
if errCode := getDotPath(result.Response, "content.errorCode"); errCode != nil && fmt.Sprint(errCode) != "" {
msg := getDotPath(result.Response, "content.errorMessage")
return nil, apperrors.NewValidation(fmt.Sprintf(
+68 -2
View File
@@ -105,6 +105,18 @@ type Route struct {
// (rename / drop / columns) before the formatter emits it. Wired up from
// CLIToolOverride.OutputFormat. See discovery-schema-v3 §2.5.
OutputTransform func(map[string]any) map[string]any
// RejectPositional forces cobra.NoArgs on the generated leaf when no
// positional bindings exist, so stray positional tokens (e.g.
// `dws contact label list unexpected`) exit non-zero. Sourced from
// CLIToolOverride.RejectPositional. Ignored when the leaf already
// declares positional bindings — their arity validator wins.
RejectPositional bool
// RequireTogether groups flag aliases that must all be set together (or
// all left unset). Each inner slice produces one PreRunE cross-field
// check. Sourced from CLIToolOverride.RequireTogether. Unknown flag
// names are logged and skipped at command-build time (consistent with
// applyFlagConstraints semantics).
RequireTogether [][]string
}
type CommandFactory func(runner executor.Runner) *cobra.Command
@@ -169,10 +181,19 @@ func NewDirectCommand(route Route, runner executor.Runner) *cobra.Command {
strictMin = b.PositionalIndex + 1
}
}
var argsValidator cobra.PositionalArgs = cobra.NoArgs
var argsValidator cobra.PositionalArgs = cobra.ArbitraryArgs
switch {
case totalMax == 0:
argsValidator = cobra.NoArgs
// No positional bindings: default to ArbitraryArgs unless the
// envelope explicitly asked for strict no-positional. We only
// honor RejectPositional in this branch because leaves with
// positional bindings already get a stricter validator below;
// flipping them to NoArgs would silently break valid invocations.
if route.RejectPositional {
argsValidator = cobra.NoArgs
} else {
argsValidator = cobra.ArbitraryArgs
}
case strictMin > 0 && strictMin == totalMax:
argsValidator = cobra.MinimumNArgs(strictMin)
case strictMin > 0:
@@ -221,6 +242,12 @@ func NewDirectCommand(route Route, runner executor.Runner) *cobra.Command {
Hidden: route.Hidden,
Args: argsValidator,
DisableAutoGenTag: true,
PreRunE: func(cmd *cobra.Command, args []string) error {
// Envelope-declared cross-field "must be set together" checks.
// Returns the first failing group so users see one actionable
// error per invocation (mirrors cobra's MarkFlagsOneRequired UX).
return validateRequireTogether(cmd, route.RequireTogether)
},
RunE: func(cmd *cobra.Command, args []string) error {
jsonPayload, err := cmd.Flags().GetString("json")
if err != nil {
@@ -1032,3 +1059,42 @@ func compatFlagName(raw string) string {
}
return strings.Trim(builder.String(), "-")
}
// validateRequireTogether enforces "either all set, or all unset" semantics
// for each group of flag aliases. Returns a validation error pointing at the
// first failing group; nil if every group satisfies the check or no groups
// were declared. Unknown flag names in a group are skipped silently — the
// envelope load path already warned about them when applyFlagConstraints
// validated the same shape for MutuallyExclusive / RequireOneOf.
func validateRequireTogether(cmd *cobra.Command, groups [][]string) error {
for _, group := range groups {
set := make([]string, 0, len(group))
unset := make([]string, 0, len(group))
for _, raw := range group {
name := strings.TrimSpace(raw)
if name == "" {
continue
}
if cmd.Flags().Lookup(name) == nil {
continue
}
if cobracmd.FlagChanged(cmd, name) {
set = append(set, name)
} else {
unset = append(unset, name)
}
}
if len(set) == 0 || len(unset) == 0 {
continue
}
// Render a stable, human-readable list of the group's flag names so
// the error matches what the user typed. Example output:
// --start 和 --end 必须同时设置或同时不设置
return apperrors.NewValidation(fmt.Sprintf(
"--%s 和 --%s 必须同时设置或同时不设置",
strings.Join(set, " --"),
strings.Join(unset, " --"),
))
}
return nil
}
+114
View File
@@ -0,0 +1,114 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// todo_hooks.go — CLI-side validators for the `todo` product. The envelope
// describes PersonalTodoCreateVO.parentId as a plain string flag (`--parent-id`)
// and the upstream MCP tool create_personal_sub_todo silently accepts any
// non-empty value: when a non-numeric string slips through, the server treats
// the missing numeric parent as "no parent" and creates an *orphan* root-level
// todo instead of failing. The auto-test
// todo/test_03_todo_create_sub.py::test_create_sub_todo_invalid_parent_id
// expects the CLI to reject the invalid value before it ever reaches MCP.
//
// The wukong reference implementation already does the same check inside its
// hand-written cobra RunE (see dws-wukong/wukong/products/todo.go ~line 90:
// strconv.ParseInt + CLIError with "父待办 ID 必须是纯数字, 当前值: ..."). The
// open-source CLI is envelope-driven, so we attach the equivalent guard as a
// PreRunE hook here. Empty parent-id is intentionally NOT validated here —
// envelope already marks it required, so cobra's MarkFlagRequired handles the
// missing case with the standard "required flag(s) ... not set" message.
package compat
import (
"fmt"
"strconv"
"strings"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/spf13/cobra"
)
// todoToolsWithNumericParentId lists every todo toolName whose --parent-id
// must be coerced to a pure-numeric long. Today only create_personal_sub_todo
// needs this; if future tools (e.g. add_sub_todo) join, append here.
var todoToolsWithNumericParentId = map[string]bool{
"create_personal_sub_todo": true,
}
// installTodoHook wires todo-specific PreRunE validators onto leaf commands
// emitted by BuildDynamicCommands. It is a no-op for non-todo products and
// for todo tools that do not need extra client-side checks.
//
// The hook chain preserves the cmd.PreRunE that NewDirectCommand already
// installed (currently validateRequireTogether) by invoking it first.
func installTodoHook(cmd *cobra.Command, canonicalProduct, toolName string) {
if cmd == nil {
return
}
if strings.TrimSpace(canonicalProduct) != "todo" {
return
}
if !todoToolsWithNumericParentId[toolName] {
return
}
original := cmd.PreRunE
cmd.PreRunE = func(c *cobra.Command, args []string) error {
if original != nil {
if err := original(c, args); err != nil {
return err
}
}
return validateTodoParentIdNumeric(c)
}
}
// validateTodoParentIdNumeric inspects --parent-id; if non-empty it must
// parse as int64. Empty values are passed through so cobra's MarkFlagRequired
// (driven by the envelope's `"required": true`) still owns the missing-flag
// error message, matching the existing UX for other required flags.
//
// Error wording mirrors wukong (dws-wukong/wukong/products/todo.go ~L97) so
// agents and humans see a stable message across both editions. The
// apperrors.NewValidation wrapper guarantees stderr renders as
// "Error: [VALIDATION] ..." (PrintHumanAt) or `{"error":{...}}` (PrintJSON),
// both of which satisfy the auto-test substring assertion
// `"error" in result.stderr.lower()`.
func validateTodoParentIdNumeric(cmd *cobra.Command) error {
if cmd == nil {
return nil
}
flag := cmd.Flags().Lookup("parent-id")
if flag == nil {
return nil
}
raw, err := cmd.Flags().GetString("parent-id")
if err != nil {
// Flag exists but type is not string — defensive no-op, do not block.
return nil
}
v := strings.TrimSpace(raw)
if v == "" {
return nil
}
if _, parseErr := strconv.ParseInt(v, 10, 64); parseErr != nil {
return apperrors.NewValidation(
fmt.Sprintf("父待办 ID 必须是纯数字, 当前值: %s", v),
apperrors.WithReason("invalid_parent_id"),
apperrors.WithHint("请通过 'dws todo task list' 获取正确的父待办任务 ID。"),
apperrors.WithOperation("todo.task.create-sub.parent-id"),
)
}
return nil
}
+217
View File
@@ -0,0 +1,217 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package compat
import (
"errors"
"strings"
"testing"
"github.com/spf13/cobra"
)
// newTodoCreateSubStub mirrors the leaf command shape emitted by
// BuildDynamicCommands for `todo task create-sub` (envelope:
// create_personal_sub_todo). Only the flags the hook touches are
// registered; the others are irrelevant to the validation.
func newTodoCreateSubStub() *cobra.Command {
cmd := &cobra.Command{Use: "create-sub"}
cmd.Flags().String("parent-id", "", "parent todo id")
cmd.Flags().String("title", "", "title")
cmd.Flags().String("executors", "", "executors")
return cmd
}
func TestValidateTodoParentIdNumeric_AcceptsPureDigits(t *testing.T) {
cmd := newTodoCreateSubStub()
if err := cmd.Flags().Set("parent-id", "53340859882"); err != nil {
t.Fatalf("set flag: %v", err)
}
if err := validateTodoParentIdNumeric(cmd); err != nil {
t.Fatalf("expected nil for numeric parent-id, got %v", err)
}
}
func TestValidateTodoParentIdNumeric_RejectsAlphanumeric(t *testing.T) {
cmd := newTodoCreateSubStub()
if err := cmd.Flags().Set("parent-id", "INVALID_PARENT_ID_99999"); err != nil {
t.Fatalf("set flag: %v", err)
}
err := validateTodoParentIdNumeric(cmd)
if err == nil {
t.Fatal("expected validation error for non-numeric parent-id")
}
if !strings.Contains(err.Error(), "纯数字") {
t.Fatalf("expected '纯数字' in error, got %v", err)
}
if !strings.Contains(err.Error(), "INVALID_PARENT_ID_99999") {
t.Fatalf("expected offending value in error, got %v", err)
}
}
func TestValidateTodoParentIdNumeric_RejectsLeadingZeroPaddedHex(t *testing.T) {
// "0xdeadbeef" should fail strconv.ParseInt base 10, ensuring we are
// not silently accepting hex-shaped IDs.
cmd := newTodoCreateSubStub()
if err := cmd.Flags().Set("parent-id", "0xdeadbeef"); err != nil {
t.Fatalf("set flag: %v", err)
}
if err := validateTodoParentIdNumeric(cmd); err == nil {
t.Fatal("expected validation error for hex-shaped parent-id")
}
}
func TestValidateTodoParentIdNumeric_RejectsWhitespacePadded(t *testing.T) {
// Trimmed value is "abc" — must still reject; equally guards against
// " 123 " false-positive once trimmed (which we DO accept as 123).
cmd := newTodoCreateSubStub()
if err := cmd.Flags().Set("parent-id", " abc "); err != nil {
t.Fatalf("set flag: %v", err)
}
if err := validateTodoParentIdNumeric(cmd); err == nil {
t.Fatal("expected validation error for non-numeric (whitespace-padded) parent-id")
}
}
func TestValidateTodoParentIdNumeric_AcceptsWhitespacePaddedDigits(t *testing.T) {
cmd := newTodoCreateSubStub()
if err := cmd.Flags().Set("parent-id", " 53340859882 "); err != nil {
t.Fatalf("set flag: %v", err)
}
if err := validateTodoParentIdNumeric(cmd); err != nil {
t.Fatalf("expected whitespace-padded digits to pass after trim, got %v", err)
}
}
func TestValidateTodoParentIdNumeric_EmptyPassesThrough(t *testing.T) {
// Envelope marks parent-id required, so cobra produces the missing-flag
// error itself. We must not preempt that with a confusing message.
cmd := newTodoCreateSubStub()
if err := validateTodoParentIdNumeric(cmd); err != nil {
t.Fatalf("expected nil for empty parent-id (cobra owns required-check), got %v", err)
}
}
func TestValidateTodoParentIdNumeric_NoFlagRegistered(t *testing.T) {
// Defensive: a command without the flag must not panic / error.
cmd := &cobra.Command{Use: "noop"}
if err := validateTodoParentIdNumeric(cmd); err != nil {
t.Fatalf("expected nil when --parent-id absent, got %v", err)
}
}
// ── installTodoHook composition ────────────────────────────────
func TestInstallTodoHook_NoOpForOtherProduct(t *testing.T) {
cmd := newTodoCreateSubStub()
originalCalled := false
cmd.PreRunE = func(*cobra.Command, []string) error { originalCalled = true; return nil }
installTodoHook(cmd, "chat", "create_personal_sub_todo")
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("unexpected err: %v", err)
}
if !originalCalled {
t.Fatal("original PreRunE should still run when hook skips")
}
// Bad parent-id must NOT fail since hook is no-op for non-todo product.
if err := cmd.Flags().Set("parent-id", "INVALID"); err != nil {
t.Fatal(err)
}
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("non-todo product must not validate parent-id: %v", err)
}
}
func TestInstallTodoHook_NoOpForOtherTodoTool(t *testing.T) {
// e.g. `todo task get` reuses parent-id-less plumbing — make sure we do
// not blanket-validate every todo leaf.
cmd := newTodoCreateSubStub()
installTodoHook(cmd, "todo", "get_personal_todo_detail")
if err := cmd.Flags().Set("parent-id", "INVALID"); err != nil {
t.Fatal(err)
}
if cmd.PreRunE != nil {
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("non-target todo tool must not validate parent-id: %v", err)
}
}
}
func TestInstallTodoHook_TargetToolRejectsInvalid(t *testing.T) {
cmd := newTodoCreateSubStub()
installTodoHook(cmd, "todo", "create_personal_sub_todo")
if cmd.PreRunE == nil {
t.Fatal("installTodoHook should install a PreRunE for the target tool")
}
if err := cmd.Flags().Set("parent-id", "INVALID_PARENT_ID_99999"); err != nil {
t.Fatal(err)
}
err := cmd.PreRunE(cmd, nil)
if err == nil {
t.Fatal("expected hook to reject non-numeric parent-id")
}
if !strings.Contains(err.Error(), "纯数字") {
t.Fatalf("unexpected error message: %v", err)
}
}
func TestInstallTodoHook_TargetToolAcceptsValid(t *testing.T) {
cmd := newTodoCreateSubStub()
installTodoHook(cmd, "todo", "create_personal_sub_todo")
if err := cmd.Flags().Set("parent-id", "53340859882"); err != nil {
t.Fatal(err)
}
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("numeric parent-id must pass: %v", err)
}
}
func TestInstallTodoHook_ChainsExistingPreRunE(t *testing.T) {
cmd := newTodoCreateSubStub()
originalCalled := false
cmd.PreRunE = func(*cobra.Command, []string) error {
originalCalled = true
return nil
}
installTodoHook(cmd, "todo", "create_personal_sub_todo")
if err := cmd.Flags().Set("parent-id", "1"); err != nil {
t.Fatal(err)
}
if err := cmd.PreRunE(cmd, nil); err != nil {
t.Fatalf("unexpected err: %v", err)
}
if !originalCalled {
t.Fatal("original PreRunE was dropped")
}
}
func TestInstallTodoHook_BailsIfChainedPreRunEFails(t *testing.T) {
cmd := newTodoCreateSubStub()
cmd.PreRunE = func(*cobra.Command, []string) error { return errors.New("original boom") }
installTodoHook(cmd, "todo", "create_personal_sub_todo")
// Even with a VALID parent-id, the chained original error must bubble up
// before our validation runs.
if err := cmd.Flags().Set("parent-id", "1"); err != nil {
t.Fatal(err)
}
err := cmd.PreRunE(cmd, nil)
if err == nil || !strings.Contains(err.Error(), "original boom") {
t.Fatalf("expected original PreRunE error to bubble, got %v", err)
}
}
func TestInstallTodoHook_NilCmdSafe(t *testing.T) {
// Defensive: should not panic.
installTodoHook(nil, "todo", "create_personal_sub_todo")
}
+91 -1
View File
@@ -30,7 +30,7 @@ import (
// ApplyTransform applies a named transform rule to a value.
// Supported transforms: iso8601_to_millis, csv_to_array, json_parse,
// json_parse_strict, enum_map, file_read.
// json_parse_strict, enum_map, file_read, invert_bool, string_to_int64.
func ApplyTransform(value any, transform string, args map[string]any) (any, error) {
switch strings.TrimSpace(transform) {
case "":
@@ -47,6 +47,33 @@ func ApplyTransform(value any, transform string, args map[string]any) (any, erro
return transformEnumMap(value, args)
case "file_read":
return transformFileRead(value)
case "invert_bool":
return transformInvertBool(value)
case "string_to_int64":
return transformStringToInt64(value)
default:
return value, nil
}
}
// transformInvertBool flips a boolean: true → false, false → true. Strings
// "true"/"false" (any case) are accepted. Used by envelope flags whose CLI
// surface and MCP body have opposite semantics — e.g. `--off` (CLI) maps to
// `mute=true` (MCP) for "mute is enabled", so the flag override declares
// `transform: invert_bool` and the framework flips at send time.
func transformInvertBool(value any) (any, error) {
switch v := value.(type) {
case bool:
return !v, nil
case string:
s := strings.ToLower(strings.TrimSpace(v))
switch s {
case "true", "1", "yes", "on":
return false, nil
case "false", "0", "no", "off", "":
return true, nil
}
return value, nil
default:
return value, nil
}
@@ -237,6 +264,69 @@ func transformFileRead(value any) (any, error) {
return string(buf), nil
}
// transformStringToInt64 parses a string-form integer (e.g. "12345") into an
// int64 so the MCP body carries a numeric value rather than a quoted string.
// Used for envelope flags whose upstream schema requires int64 (e.g. deptId).
//
// Two ergonomic guards are layered on top of the raw parse:
//
// 1. Placeholder rejection — common LLM/AI-agent placeholders for "myself" /
// "root department" (self / me / 我 / root / 0) are NOT valid deptIds. The
// dingtalk root department's deptId is the literal integer 1; if we let
// "self" fall through to the MCP, the server returns an empty result with
// success=true, masking the mistake. Instead, return a validation error
// pointing the caller at the correct usage. Mirrors wukong's cmdutil error
// wording ("根部门 deptId=1,请使用 --id 1") so CLI and wukong agree.
//
// 2. Non-numeric rejection — anything else that fails strconv.ParseInt is
// reported as a validation error rather than silently sent as a string,
// which the upstream server would also reject (or worse: coerce to 0).
//
// Numeric int / int64 inputs pass through unchanged; the transform is a no-op
// when the schema-typed flag already produced an integer.
func transformStringToInt64(value any) (any, error) {
switch v := value.(type) {
case nil:
return value, nil
case int:
return int64(v), nil
case int32:
return int64(v), nil
case int64:
return v, nil
case float64:
// JSON numbers decode as float64; accept only when integer-valued.
if v == float64(int64(v)) {
return int64(v), nil
}
return nil, apperrors.NewValidation(fmt.Sprintf("string_to_int64: %v is not an integer", v))
}
s, ok := toString(value)
if !ok {
return value, nil
}
s = strings.TrimSpace(s)
if s == "" {
return value, nil
}
// Placeholder guard: LLMs often invent symbolic values like "self" / "me" /
// "root" / "我" for "the current user's root department". Catch them with a
// clear error pointing at the canonical deptId=1, instead of forwarding the
// bogus value and letting the upstream return success=true with empty data.
lowered := strings.ToLower(s)
switch lowered {
case "self", "me", "我", "root", "0":
return nil, apperrors.NewValidation(
"flag --id 必须是整数;钉钉根部门 deptId=1,请使用 --id 1",
)
}
n, err := strconv.ParseInt(s, 10, 64)
if err != nil {
return nil, apperrors.NewValidation(fmt.Sprintf("flag --id 必须是整数,got %q", s))
}
return n, nil
}
func toString(v any) (string, bool) {
switch val := v.(type) {
case string:
+107
View File
@@ -259,3 +259,110 @@ func TestFileRead_UnknownTransformPassThrough(t *testing.T) {
t.Errorf("expected pass-through, got %v", got)
}
}
func TestInvertBoolTransform(t *testing.T) {
cases := []struct {
in any
want any
}{
{true, false},
{false, true},
{"true", false},
{"false", true},
{"True", false},
{"FALSE", true},
{"on", false},
{"off", true},
{"", true},
}
for _, c := range cases {
got, err := ApplyTransform(c.in, "invert_bool", nil)
if err != nil {
t.Errorf("ApplyTransform(%v, invert_bool) err=%v", c.in, err)
}
if got != c.want {
t.Errorf("ApplyTransform(%v) = %v, want %v", c.in, got, c.want)
}
}
}
// TestStringToInt64_NumericString covers the happy path: callers pass an
// integer-shaped string (the common CLI case where every flag arrives as text)
// and the transform promotes it to int64 so the MCP body carries a number.
func TestStringToInt64_NumericString(t *testing.T) {
t.Parallel()
got, err := ApplyTransform("12345", "string_to_int64", nil)
if err != nil {
t.Fatalf("expected numeric string to parse, got err: %v", err)
}
if got != int64(12345) {
t.Fatalf("expected int64(12345), got %T %v", got, got)
}
}
// TestStringToInt64_NumericPassthrough covers the case where an upstream
// schema-typed flag already produced an integer (e.g. via pflag.Int64) — the
// transform should be a no-op and not double-convert.
func TestStringToInt64_NumericPassthrough(t *testing.T) {
t.Parallel()
cases := []any{int(7), int32(7), int64(7), float64(7)}
for _, in := range cases {
got, err := ApplyTransform(in, "string_to_int64", nil)
if err != nil {
t.Errorf("expected pass-through for %T(%v), got err: %v", in, in, err)
continue
}
if got != int64(7) {
t.Errorf("expected int64(7), got %T %v (input %T)", got, got, in)
}
}
}
// TestStringToInt64_PlaceholderRejected guards the wukong-aligned error wording
// for LLM/AI-agent placeholders. Each of these values must surface a
// validation error pointing at the canonical root deptId=1; if they fell
// through silently the MCP server would return success=true with empty data
// and the caller would never learn they sent garbage.
func TestStringToInt64_PlaceholderRejected(t *testing.T) {
t.Parallel()
placeholders := []string{"self", "me", "我", "root", "0", "SELF", "Me"}
for _, p := range placeholders {
_, err := ApplyTransform(p, "string_to_int64", nil)
if err == nil {
t.Errorf("placeholder %q should reject, got nil error", p)
continue
}
msg := err.Error()
if !strings.Contains(msg, "根部门") || !strings.Contains(msg, "deptId=1") {
t.Errorf("placeholder %q error should mention 根部门/deptId=1, got %q", p, msg)
}
}
}
// TestStringToInt64_NonNumericRejected ensures non-integer strings are
// surfaced as validation errors (exit code 2) rather than forwarded to the
// MCP as a quoted string, which the upstream would reject anyway.
func TestStringToInt64_NonNumericRejected(t *testing.T) {
t.Parallel()
_, err := ApplyTransform("abc", "string_to_int64", nil)
if err == nil {
t.Fatalf("non-numeric input should reject, got nil error")
}
if !strings.Contains(err.Error(), "必须是整数") {
t.Errorf("expected `必须是整数` in error, got %q", err.Error())
}
}
// TestStringToInt64_EmptyPassthrough mirrors the other transforms' contract:
// empty input is a no-op so optional flags that weren't provided don't trip
// the placeholder/format guards.
func TestStringToInt64_EmptyPassthrough(t *testing.T) {
t.Parallel()
got, err := ApplyTransform("", "string_to_int64", nil)
if err != nil {
t.Fatalf("empty string should pass through, got err: %v", err)
}
if got != "" {
t.Errorf("expected empty string pass-through, got %v", got)
}
}
+2 -2
View File
@@ -13,13 +13,13 @@ import (
)
// newTestMCPServer returns an httptest.Server that handles both market registry
// and MCP JSON-RPC endpoints. marketOK controls whether /cli/discovery/apis
// and MCP JSON-RPC endpoints. marketOK controls whether /cli/discovery/apis/bamboo
// succeeds, and mcpOK controls whether initialize+tools/list succeed.
func newTestMCPServer(t *testing.T, marketOK, mcpOK bool) *httptest.Server {
t.Helper()
mux := http.NewServeMux()
mux.HandleFunc("/cli/discovery/apis", func(w http.ResponseWriter, r *http.Request) {
mux.HandleFunc("/cli/discovery/apis/bamboo", func(w http.ResponseWriter, r *http.Request) {
if !marketOK {
http.Error(w, "market unavailable", http.StatusInternalServerError)
return
+16 -1
View File
@@ -14,6 +14,7 @@
package errors
import (
"bytes"
"encoding/json"
stderrors "errors"
"fmt"
@@ -462,13 +463,27 @@ func cleanPATJSON(body map[string]any, code string) string {
// stderr JSON MUST be a single-line, directly json.Unmarshal-able
// payload — pretty-printing would break naïve host parsers that read
// stderr line-by-line and fail on leading whitespace.
b, err := json.Marshal(out)
b, err := marshalSingleLineJSONNoHTMLEscape(out)
if err != nil {
return fmt.Sprintf(`{"success":false,"code":"%s"}`, code)
}
return string(b)
}
func marshalSingleLineJSONNoHTMLEscape(v any) ([]byte, error) {
var buf bytes.Buffer
enc := json.NewEncoder(&buf)
enc.SetEscapeHTML(false)
if err := enc.Encode(v); err != nil {
return nil, err
}
out := buf.Bytes()
if len(out) > 0 && out[len(out)-1] == '\n' {
out = out[:len(out)-1]
}
return out, nil
}
// ---- Runner adapter functions ------------------------------------------------
// These match the function signatures referenced by runner.go's PAT check
// framework (ClassifyPatAuthCheck / AsPatAuthCheckError).
+7
View File
@@ -730,6 +730,13 @@ func TestCleanPATJSON_PreservesOpaqueURIVerbatim(t *testing.T) {
result := cleanPATJSON(body, "PAT_MEDIUM_RISK_NO_PERMISSION")
if strings.Contains(result, `\u0026`) {
t.Fatalf("cleanPATJSON should keep URL ampersands readable for mobile copy/linkify, got: %s", result)
}
if !strings.Contains(result, "&userCode=Q8RY-X6E9") {
t.Fatalf("cleanPATJSON output missing readable fragment separator, got: %s", result)
}
var parsed map[string]any
if err := json.Unmarshal([]byte(result), &parsed); err != nil {
t.Fatalf("unmarshal cleanPATJSON output: %v\nraw=%s", err, result)
+1 -1
View File
@@ -259,7 +259,7 @@ func newDocsMCPGateway(expectations []docsServerExpectation) *httptest.Server {
mux := http.NewServeMux()
server := httptest.NewServer(mux)
mux.HandleFunc("/cli/discovery/apis", func(w http.ResponseWriter, r *http.Request) {
mux.HandleFunc("/cli/discovery/apis/bamboo", func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
return
-2
View File
@@ -82,7 +82,6 @@ var writeOperationTokens = map[string]struct{}{
}
var legacy17CoverageTargets = []string{
"aiapp",
"aitable",
"attendance",
"calendar",
@@ -102,7 +101,6 @@ var legacy17CoverageTargets = []string{
}
var extended22CoverageTargets = []string{
"aiapp",
"aitable",
"attendance",
"calendar",
-1
View File
@@ -77,7 +77,6 @@ type RecipeEntry struct {
}
var knownRegistryProducts = map[string]struct{}{
"aiapp": {},
"aidesign": {},
"aitable": {},
"attendance": {},
+242 -15
View File
@@ -73,6 +73,8 @@ func (aitableHandler) Command(runner executor.Runner) *cobra.Command {
newAitableBaseCreateCommand(runner),
newAitableBaseUpdateCommand(runner),
newAitableBaseDeleteCommand(runner),
newAitableBaseGetPrimaryDocIdCommand(runner),
newAitableBaseCopyCommand(runner),
)
table := &cobra.Command{
@@ -90,6 +92,7 @@ func (aitableHandler) Command(runner executor.Runner) *cobra.Command {
newAitableTableCreateCommand(runner),
newAitableTableUpdateCommand(runner),
newAitableTableDeleteCommand(runner),
newAitableTableListAlias(runner),
)
field := &cobra.Command{
@@ -107,6 +110,7 @@ func (aitableHandler) Command(runner executor.Runner) *cobra.Command {
newAitableFieldCreateCommand(runner),
newAitableFieldUpdateCommand(runner),
newAitableFieldDeleteCommand(runner),
newAitableFieldListAlias(runner),
)
record := &cobra.Command{
@@ -121,9 +125,12 @@ func (aitableHandler) Command(runner executor.Runner) *cobra.Command {
}
record.AddCommand(
newAitableRecordQueryCommand(runner),
newAitableRecordGetCommand(runner),
newAitableRecordCreateCommand(runner),
newAitableRecordUpdateCommand(runner),
newAitableRecordBatchUpdateCommand(runner),
newAitableRecordDeleteCommand(runner),
newAitableRecordListAlias(runner),
)
template := &cobra.Command{
@@ -153,10 +160,231 @@ func (aitableHandler) Command(runner executor.Runner) *cobra.Command {
newAITableUploadFileCommand(runner),
)
root.AddCommand(base, table, field, record, template, attachment)
// export / import group:覆盖 mse 默认行为,提供同步轮询 + 自动 IO
export := &cobra.Command{
Use: "export",
Short: i18n.T("AI 表格数据导出(异步任务)"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
export.AddCommand(newAitableExportDataCommand(runner))
importCmd := &cobra.Command{
Use: "import",
Short: i18n.T("AI 表格数据导入(异步任务)"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
importCmd.AddCommand(
newAitableImportUploadCommand(runner),
newAitableImportDataCommand(runner),
)
chart := &cobra.Command{
Use: "chart",
Short: i18n.T("图表管理"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
chartShare := &cobra.Command{
Use: "share",
Short: i18n.T("图表分享管理"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
chartShare.AddCommand(
newAitableChartShareGetCommand(runner),
newAitableChartShareUpdateCommand(runner),
)
chart.AddCommand(
newAitableChartGetCommand(runner),
newAitableChartCreateCommand(runner),
newAitableChartUpdateCommand(runner),
newAitableChartDeleteCommand(runner),
newAitableChartWidgetsExampleCommand(runner),
chartShare,
)
dashboard := &cobra.Command{
Use: "dashboard",
Short: i18n.T("仪表盘管理"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
dashboardShare := &cobra.Command{
Use: "share",
Short: i18n.T("仪表盘分享管理"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
dashboardShare.AddCommand(
newAitableDashboardShareGetCommand(runner),
newAitableDashboardShareUpdateCommand(runner),
)
dashboard.AddCommand(
newAitableDashboardGetCommand(runner),
newAitableDashboardCreateCommand(runner),
newAitableDashboardUpdateCommand(runner),
newAitableDashboardDeleteCommand(runner),
newAitableDashboardConfigExampleCommand(runner),
dashboardShare,
)
view := &cobra.Command{
Use: "view",
Short: i18n.T("视图管理"),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
view.AddCommand(
newAitableViewGetCommand(runner),
newAitableViewListCommand(runner),
newAitableViewCreateCommand(runner),
newAitableViewUpdateCommand(runner),
newAitableViewDeleteCommand(runner),
)
root.AddCommand(base, table, field, record, newAitableFormCommand(runner), template, attachment, export, importCmd, dashboard, chart, view)
// 顶层别名:dws aitable search/list/create/info → base search/list/create/get
// 每个 alias 复用现有 constructor,独立 cobra.Command 实例(避免与 base.* 共享 flag 指针)
root.AddCommand(
newAitableSearchAlias(runner),
newAitableListAlias(runner),
newAitableCreateAlias(runner),
newAitableInfoAlias(runner),
)
return root
}
func newAitableSearchAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableBaseSearchCommand(runner)
cmd.Use = "search"
cmd.Short = i18n.T("搜索 AI 表格(dws aitable base search 的别名)")
cmd.Example = " dws aitable search --query 项目管理"
return cmd
}
func newAitableListAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableBaseListCommand(runner)
cmd.Use = "list"
cmd.Short = i18n.T("获取 AI 表格列表(dws aitable base list 的别名)")
cmd.Example = " dws aitable list\n dws aitable list --limit 5"
return cmd
}
func newAitableCreateAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableBaseCreateCommand(runner)
cmd.Use = "create"
cmd.Short = i18n.T("创建 AI 表格(dws aitable base create 的别名)")
cmd.Example = " dws aitable create --name 项目跟踪"
return cmd
}
func newAitableInfoAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableBaseGetCommand(runner)
cmd.Use = "info"
cmd.Short = i18n.T("获取 AI 表格信息(dws aitable base get 的别名)")
cmd.Example = " dws aitable info --base-id BASE_ID"
return cmd
}
// TRANSITIONAL: 等 mse 把 get_tables / get_fields / query_records 三条
// toolOverride 加上 `cliAliases: ["list"]` 字段后,下面 3 个 helper 可整体
// 删除——CLI discovery 会自动把 list 注册为对应命令的 cobra alias。
// 工单:plan/mse-yuyuan-patch.md 改动 1.2。
func newAitableTableListAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableTableGetCommand(runner)
cmd.Use = "list"
cmd.Short = i18n.T("获取数据表信息(dws aitable table get 的别名)")
cmd.Example = " dws aitable table list --base-id BASE_ID\n dws aitable table list --base-id BASE_ID --table-ids tbl1,tbl2"
return cmd
}
func newAitableFieldListAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableFieldGetCommand(runner)
cmd.Use = "list"
cmd.Short = i18n.T("获取字段列表(dws aitable field get 的别名)")
cmd.Example = " dws aitable field list --base-id BASE_ID --table-id TABLE_ID"
return cmd
}
func newAitableRecordListAlias(runner executor.Runner) *cobra.Command {
cmd := newAitableRecordQueryCommand(runner)
cmd.Use = "list"
cmd.Short = i18n.T("获取记录列表(dws aitable record query 的别名)")
cmd.Example = " dws aitable record list --base-id BASE_ID --table-id TABLE_ID"
return cmd
}
// TRANSITIONAL: 等 mse 把 get_base_primary_doc_id 加入 aitable toolOverrides
// 后,本 helper 可整体删除——CLI discovery 会自动生成等价命令。
// 工单:plan/mse-yuyuan-patch.md 改动 1。
func newAitableBaseGetPrimaryDocIdCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "get-primary-doc-id",
Short: i18n.T("获取主键文档 ID"),
Long: i18n.T(`根据 baseId / tableId / recordId 获取主键文档对应的 dentryUuid。
当 AI 表格使用文档类型作为主键字段时,可凭此 uuid 进一步获取文档内容或执行其它操作。`),
Example: " dws aitable base get-primary-doc-id --base-id BASE_ID --table-id TABLE_ID --record-id RECORD_ID",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, err := aitableRequiredFlagOrFallback(cmd, "base-id", "base")
if err != nil {
return err
}
tableID, err := aitableRequiredFlag(cmd, "table-id")
if err != nil {
return err
}
recordID, err := aitableRequiredFlag(cmd, "record-id")
if err != nil {
return err
}
return runAitableTool(cmd, runner, "get_base_primary_doc_id", map[string]any{
"baseId": baseID,
"tableId": tableID,
"recordId": recordID,
})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("base-id", "", i18n.T("Base ID (必填)"))
cmd.Flags().String("table-id", "", i18n.T("Table ID (必填)"))
cmd.Flags().String("record-id", "", i18n.T("Record ID (必填)"))
return cmd
}
// ── base delete ────────────────────────────────────────────
func newAitableBaseDeleteCommand(runner executor.Runner) *cobra.Command {
@@ -262,7 +490,7 @@ func newAitableFieldDeleteCommand(runner executor.Runner) *cobra.Command {
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, _ := cmd.Flags().GetString("base-id")
baseID := aitableFlagOrFallback(cmd, "base-id", "base")
tableID, _ := cmd.Flags().GetString("table-id")
fieldID, _ := cmd.Flags().GetString("field-id")
if strings.TrimSpace(baseID) == "" {
@@ -298,6 +526,7 @@ func newAitableFieldDeleteCommand(runner executor.Runner) *cobra.Command {
}
preferLegacyLeaf(cmd)
cmd.Flags().String("base-id", "", i18n.T("Base ID (必填)"))
addAitableHiddenStringFlag(cmd, "base", "--base-id 的兼容别名")
cmd.Flags().String("table-id", "", i18n.T("数据表 ID (必填)"))
cmd.Flags().String("field-id", "", i18n.T("字段 ID (必填)"))
@@ -330,12 +559,7 @@ func newAitableRecordDeleteCommand(runner executor.Runner) *cobra.Command {
if !confirmDeletePrompt(cmd, i18n.T("记录"), recordIDsStr) {
return nil
}
var recordIDs []any
for _, id := range strings.Split(recordIDsStr, ",") {
if s := strings.TrimSpace(id); s != "" {
recordIDs = append(recordIDs, s)
}
}
recordIDs := parseAitableCSVValues(recordIDsStr)
params := map[string]any{
"baseId": baseID,
"tableId": tableID,
@@ -393,15 +617,18 @@ func confirmDeletePrompt(cmd *cobra.Command, resourceType, resourceName string)
func newAITableUploadFileCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "upload-file",
Short: i18n.T("本地文件一键上传到 AITable 附件字段"),
Hidden: true,
Long: `完整流程 (自动执行 3 步):
1. dws aitable attachment upload → 获取 uploadUrl + fileToken
2. HTTP PUT 上传文件到 OSS
3. 返回 fileToken,可直接用于 record create/update`,
Use: "upload-file",
Short: i18n.T("本地文件一键上传到 AITable 附件字段 (3 步自动合一: prepare + PUT + 返回 fileToken)"),
Long: `本地文件一键上传到 AITable 附件字段, 一行命令完成 3 步:
1. prepare_attachment_upload → 获取 OSS 上传地址 uploadUrl + fileToken
2. HTTP PUT 文件二进制 → OSS
3. 返回 fileToken (可直接用于 dws aitable record create/update 的 attachment 字段)
推荐 AI Agent 优先使用此命令上传单个附件, 比手动调用 attachment upload (只 prepare)
之后再自己 PUT 文件二进制要可靠得多.`,
Example: " dws aitable attachment upload-file --base-id <BASE_ID> --file ./report.pdf",
Args: cobra.NoArgs,
Hidden: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseId, _ := cmd.Flags().GetString("base-id")
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+396
View File
@@ -0,0 +1,396 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"encoding/json"
"fmt"
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cobracmd"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/i18n"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/asynctask"
"github.com/spf13/cobra"
)
// PR-D:aitable export/import 静态命令覆盖
//
// MSE 已经注册了 export_data / import_data / prepare_import_upload 三个 tool
// (动态发现命令)。本文件用 preferLegacyLeaf 固定命令 surface,避免动态
// 发现层和 Wukong 的稳定命令口径漂移。
//
// TRANSITIONAL: 等 mse 把 asyncBehavior 标注加入 toolOverrides 后,
// 这套 helper 行为可由动态发现层统一处理,本文件可整体删除。
// 工单:plan/mse-yuyuan-patch.md(待后续补充 asyncBehavior 规范)
// ── aitable export data ─────────────────────────────────────
func newAitableExportDataCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "data",
Short: i18n.T("导出数据"),
Long: i18n.T(`导出 AI 表格数据的统一入口。
不传 --task-id 时,根据 --scope / --format 创建新的导出任务,并同步等待结果;
若在等待窗口内完成,则直接返回 downloadUrl 和 fileName。
传入 --task-id 时,继续等待该任务,不会重新创建。
scope 可选值:all(整个 Base)、table(指定数据表)、view(指定视图)。
format 可选值:excel、attachment、excel_and_attachment、excel_with_inline_images。`),
Example: ` dws aitable export data --base-id BASE_ID --scope all --format excel
dws aitable export data --base-id BASE_ID --scope table --table-id TABLE_ID --format excel
dws aitable export data --base-id BASE_ID --scope view --table-id TABLE_ID --view-id VIEW_ID --format excel
dws aitable export data --base-id BASE_ID --task-id TASK_ID
# 查询 baseId: dws aitable base list`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return runAitableExportData(cmd, runner)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("base-id", "", i18n.T("Base ID (必填)"))
addAitableHiddenStringFlag(cmd, "base", "--base-id 的兼容别名")
cmd.Flags().String("scope", "", i18n.T("导出范围:all(整个 Base)、table(指定数据表)、view(指定视图)"))
cmd.Flags().String("format", "", i18n.T("导出格式:excel、attachment、excel_and_attachment、excel_with_inline_images"))
cmd.Flags().String("task-id", "", i18n.T("已有导出任务 ID,传入后继续等待(忽略 scope/format/table-id/view-id)"))
cmd.Flags().String("table-id", "", i18n.T("Table ID,scope=table 或 scope=view 时必填"))
cmd.Flags().String("view-id", "", i18n.T("View ID,scope=view 时必填"))
cmd.Flags().Int("timeout-ms", 0, i18n.T("单次等待超时(毫秒),默认 30000,最大 30000"))
return cmd
}
func runAitableExportData(cmd *cobra.Command, runner executor.Runner) error {
baseID, err := aitableRequiredFlagOrFallback(cmd, "base-id", "base")
if err != nil {
return err
}
taskID, _ := cmd.Flags().GetString("task-id")
scope, _ := cmd.Flags().GetString("scope")
format, _ := cmd.Flags().GetString("format")
tableID, _ := cmd.Flags().GetString("table-id")
viewID, _ := cmd.Flags().GetString("view-id")
timeoutMS, _ := cmd.Flags().GetInt("timeout-ms")
params := map[string]any{
"baseId": baseID,
}
if taskID != "" {
params["taskId"] = taskID
} else {
if strings.TrimSpace(scope) == "" {
return apperrors.NewValidation("--scope is required")
}
if strings.TrimSpace(format) == "" {
return apperrors.NewValidation("--format is required")
}
params["scope"] = scope
params["format"] = format
}
if tableID != "" {
params["tableId"] = tableID
}
if viewID != "" {
params["viewId"] = viewID
}
if timeoutMS > 0 {
params["timeoutMs"] = timeoutMS
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "aitable", "export_data", params,
))
}
return runAitableTool(cmd, runner, "export_data", params)
}
// ── aitable import upload ───────────────────────────────────
func newAitableImportUploadCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "upload",
Short: i18n.T("准备导入文件上传"),
Long: i18n.T(`为导入任务申请 OSS 直传地址。返回 uploadUrl 和 importId。
客户端应通过 HTTP PUT 将原始文件字节流上传至 uploadUrl。
上传完成后将 importId 传入 import data 即可触发导入。
完整流程:
1. dws aitable import upload --base-id BASE_ID --file-name data.xlsx --file-size 204800
→ 获取 uploadUrl 和 importId
2. curl -X PUT "<uploadUrl>" --data-binary @data.xlsx
→ 上传文件到 OSS
3. dws aitable import data --import-id <importId>
→ 触发导入`),
Example: ` dws aitable import upload --base-id BASE_ID --file-name data.xlsx --file-size 204800
# 查询 baseId: dws aitable base list`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return runAitableImportUpload(cmd, runner)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("base-id", "", i18n.T("Base ID (必填)"))
addAitableHiddenStringFlag(cmd, "base", "--base-id 的兼容别名")
cmd.Flags().String("file-name", "", i18n.T("文件名,须带扩展名,如 data.xlsx (必填)"))
cmd.Flags().Int64("file-size", 0, i18n.T("文件大小(字节数)(必填)"))
return cmd
}
func runAitableImportUpload(cmd *cobra.Command, runner executor.Runner) error {
fileName, err := aitableRequiredFlag(cmd, "file-name")
if err != nil {
return err
}
baseID, err := aitableRequiredFlagOrFallback(cmd, "base-id", "base")
if err != nil {
return err
}
fileSize, _ := cmd.Flags().GetInt64("file-size")
params := map[string]any{
"baseId": baseID,
"fileName": fileName,
}
if fileSize > 0 {
params["fileSize"] = fileSize
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "aitable", "prepare_import_upload", params,
))
}
return runAitableTool(cmd, runner, "prepare_import_upload", params)
}
// ── aitable import data ─────────────────────────────────────
func newAitableImportDataCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "data",
Short: i18n.T("导入数据"),
Long: i18n.T(`将已通过 import upload 上传完成的文件导入 AI 表格。
支持两种模式:
1. 新建表导入(默认):不传 --table-id,每个 Sheet 会新建为独立的数据表
2. 追加导入:传入 --table-id,数据将作为新行追加到该已有表中
工具内部会等待导入完成,大多数情况下一次调用即可拿到最终结果。
若在 timeout 内未完成,再次传入相同 importId 继续等待,无需重新提交任务。
追加导入时的注意事项:
- 系统按列名自动匹配字段,源文件列名须与目标表字段名一致
- 若需自定义映射关系,使用 --field-mapping 指定(key=目标表字段名,value=源文件列名)
- 多 Sheet 文件默认使用第一个 Sheet,可通过 --src-sheet-name 指定`),
Example: ` # 新建表导入
dws aitable import data --import-id IMPORT_ID
# 追加到已有表
dws aitable import data --import-id IMPORT_ID --table-id TABLE_ID
# 指定表头行和源 Sheet
dws aitable import data --import-id IMPORT_ID --table-id TABLE_ID --header-row 2 --src-sheet-name "Sheet1"`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return runAitableImportData(cmd, runner)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("import-id", "", i18n.T("prepare_import_upload 返回的 importId (必填)"))
cmd.Flags().String("table-id", "", i18n.T("目标数据表 ID。传入后数据将作为新行追加到该表中;不传则默认新建表导入"))
cmd.Flags().Int("timeout", 0, i18n.T("最长等待时间(秒),默认且推荐使用最大值 30"))
cmd.Flags().Int("header-row", 0, i18n.T("表头所在行号(从 1 开始),数据从 headerRow 的下一行开始读取。不传则自动识别表头行"))
cmd.Flags().String("src-sheet-name", "", i18n.T("源文件中的 Sheet 名称。多 Sheet 文件时指定从哪个 Sheet 导入数据。不传则默认使用第一个 Sheet"))
cmd.Flags().String("field-mapping", "", i18n.T("字段映射关系 JSON 对象。key 为目标表的字段名,value 为源文件中的列名。不传则按列名自动匹配"))
return cmd
}
func runAitableImportData(cmd *cobra.Command, runner executor.Runner) error {
importID, err := aitableRequiredFlag(cmd, "import-id")
if err != nil {
return err
}
tableID, _ := cmd.Flags().GetString("table-id")
fieldMapping, _ := cmd.Flags().GetString("field-mapping")
headerRow, _ := cmd.Flags().GetInt("header-row")
srcSheetName, _ := cmd.Flags().GetString("src-sheet-name")
timeoutSec, _ := cmd.Flags().GetInt("timeout")
importParams := map[string]any{
"importId": importID,
}
if tableID != "" {
importParams["tableId"] = tableID
}
if timeoutSec > 0 {
importParams["timeout"] = timeoutSec
}
if headerRow > 0 {
importParams["headerRow"] = headerRow
}
if strings.TrimSpace(srcSheetName) != "" {
importParams["srcSheetName"] = strings.TrimSpace(srcSheetName)
}
if fieldMapping != "" {
fieldMappingValue, err := parseAitableStringMap(fieldMapping, "field-mapping")
if err != nil {
return err
}
importParams["fieldMapping"] = fieldMappingValue
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "aitable", "import_data", importParams,
))
}
return runAitableTool(cmd, runner, "import_data", importParams)
}
func parseAitableStringMap(raw, flagName string) (map[string]string, error) {
var parsed map[string]string
if err := json.Unmarshal([]byte(raw), &parsed); err != nil {
return nil, apperrors.NewValidation(fmt.Sprintf("--%s must be a JSON object with string values", flagName))
}
if parsed == nil {
return nil, apperrors.NewValidation(fmt.Sprintf("--%s must be a JSON object with string values", flagName))
}
return parsed, nil
}
// unwrapAitableResp 处理 MCP/runtime 常见响应包装层次。
func unwrapAitableResp(resp map[string]any) map[string]any {
if resp == nil {
return map[string]any{}
}
preserved := map[string]any{}
for depth := 0; depth < 8; depth++ {
preserveAitableWrapperFields(preserved, resp)
if content, ok := resp["content"].(map[string]any); ok && len(content) > 0 {
resp = content
continue
}
if data, ok := resp["data"].(map[string]any); ok && len(data) > 0 {
resp = data
continue
}
if result, ok := resp["result"].(map[string]any); ok && len(result) > 0 {
resp = result
continue
}
if raw, ok := resp["result"].(string); ok && strings.TrimSpace(raw) != "" {
var parsed map[string]any
if json.Unmarshal([]byte(raw), &parsed) == nil && len(parsed) > 0 {
resp = parsed
continue
}
}
break
}
out := copyAitableMap(resp)
for k, v := range preserved {
if k == "status" || k == "state" {
if s, ok := v.(string); ok && normalizeAsyncStatus(s, false) == asynctask.StatusFailed {
out["status"] = s
continue
}
}
if _, exists := out[k]; !exists {
out[k] = v
}
}
return out
}
func preserveAitableWrapperFields(dst, layer map[string]any) {
for k, v := range layer {
switch k {
case "content", "data", "result":
continue
}
if _, ok := v.(map[string]any); ok {
continue
}
if _, exists := dst[k]; !exists {
dst[k] = v
}
}
if s := firstAitableString(layer, "status", "state"); normalizeAsyncStatus(s, false) == asynctask.StatusFailed {
dst["status"] = s
}
}
func normalizeAitableDownloadURL(raw string) string {
url := strings.TrimSpace(raw)
if url == "" || strings.HasPrefix(url, "http://") || strings.HasPrefix(url, "https://") {
return url
}
return "https://" + url
}
func firstAitableString(values map[string]any, keys ...string) string {
for _, key := range keys {
if s, ok := values[key].(string); ok && strings.TrimSpace(s) != "" {
return strings.TrimSpace(s)
}
}
return ""
}
func copyAitableMap(values map[string]any) map[string]any {
out := make(map[string]any, len(values))
for k, v := range values {
out[k] = v
}
return out
}
// parseAitableExportQueryResult 解析 export_data 查询返回。
func parseAitableExportQueryResult(resp map[string]any) asynctask.QueryResult {
data := unwrapAitableResp(resp)
statusRaw := firstAitableString(data, "status", "state")
url := normalizeAitableDownloadURL(firstAitableString(data, "downloadUrl", "downloadURL", "url"))
msg := firstAitableString(data, "message", "msg", "errorMessage")
// 兼容:部分上游用 SUCCEED / FAILURE 等变体
st := normalizeAsyncStatus(statusRaw, url != "")
if st == asynctask.StatusSuccess && url == "" {
st = asynctask.StatusProcessing
}
return asynctask.QueryResult{
Status: st,
DownloadURL: url,
Message: msg,
Raw: data,
}
}
// normalizeAsyncStatus 把各种 status 变体规范化到 asynctask.Status。
// hasResult=true 时即便 status 缺失也判定 SUCCESS(部分上游用"data 已就位"暗示完成)。
func normalizeAsyncStatus(raw string, hasResult bool) asynctask.Status {
s := strings.ToUpper(strings.TrimSpace(raw))
switch s {
case "SUCCESS", "SUCCEED", "SUCCEEDED", "DONE", "FINISHED", "COMPLETE", "COMPLETED":
return asynctask.StatusSuccess
case "FAILED", "FAILURE", "ERROR":
return asynctask.StatusFailed
case "PROCESSING", "RUNNING", "PENDING", "QUEUED", "IN_PROGRESS":
return asynctask.StatusProcessing
case "":
if hasResult {
return asynctask.StatusSuccess
}
return asynctask.StatusProcessing
default:
// 未知状态:保守处理为 processing 让上层继续等
return asynctask.StatusProcessing
}
}
+483
View File
@@ -0,0 +1,483 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"fmt"
"strconv"
"strings"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/i18n"
"github.com/spf13/cobra"
)
func newAitableFormCommand(runner executor.Runner) *cobra.Command {
form := newAitableFormGroup("form", "表单管理")
form.Hidden = true
field := newAitableFormGroup("field", "表单字段管理")
share := newAitableFormGroup("share", "表单分享管理")
questions := newAitableFormGroup("questions", "表单题目管理(等价于 field create / delete)")
field.AddCommand(
newAitableFormFieldListCommand(runner),
newAitableFormFieldUpdateCommand(runner),
newAitableFormFieldHideCommand(runner),
)
share.AddCommand(
newAitableFormShareGetCommand(runner),
newAitableFormShareUpdateCommand(runner),
)
questions.AddCommand(
newAitableFormQuestionsCreateCommand(runner),
newAitableFormQuestionsDeleteCommand(runner),
)
form.AddCommand(
newAitableFormListCommand(runner),
newAitableFormGetCommand(runner),
newAitableFormCreateCommand(runner),
newAitableFormUpdateCommand(runner),
newAitableFormDeleteCommand(runner),
field,
share,
questions,
)
return form
}
func newAitableFormGroup(use, short string) *cobra.Command {
return &cobra.Command{
Use: use,
Short: i18n.T(short),
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
}
func newAitableFormListCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: i18n.T("列出表单视图"),
Example: " dws aitable form list --base-id BASE_ID --table-id TABLE_ID",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "list_form_views", map[string]any{
"baseId": baseID,
"tableId": tableID,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableFlags(cmd)
return cmd
}
func newAitableFormGetCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "get",
Short: i18n.T("获取单个表单视图详情"),
Example: " dws aitable form get --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return err
}
viewID, err := aitableRequiredFlag(cmd, "view-id")
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "list_form_views", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewIds": []string{viewID},
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableFlags(cmd)
cmd.Flags().String("view-id", "", i18n.T("View ID (必填)"))
return cmd
}
func newAitableFormCreateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "create",
Short: i18n.T("创建表单视图"),
Example: " dws aitable form create --base-id BASE_ID --table-id TABLE_ID --name 员工信息收集",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return err
}
name, err := aitableRequiredFlag(cmd, "name")
if err != nil {
return err
}
params := map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewType": "FormDesigner",
"viewName": name,
}
// create_view does not currently declare a description parameter.
// Keep the flag for Wukong CLI compatibility, but do not send it.
return runAitableTool(cmd, runner, "create_view", params)
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableFlags(cmd)
cmd.Flags().String("name", "", i18n.T("表单名称 (必填)"))
cmd.Flags().String("description", "", i18n.T("表单描述(兼容保留)"))
return cmd
}
func newAitableFormUpdateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "update",
Short: i18n.T("更新表单配置"),
Example: " dws aitable form update --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID --title 新标题",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return err
}
viewID, err := aitableRequiredFlag(cmd, "view-id")
if err != nil {
return err
}
title := aitableFlagOrFallback(cmd, "title", "name")
description := aitableStringFlag(cmd, "description")
if title == "" && description == "" {
return apperrors.NewValidation("--title (or --name) and --description must specify at least one")
}
params := map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
}
if title != "" {
params["title"] = title
}
if description != "" {
params["description"] = description
}
return runAitableFormTool(cmd, runner, "update_form_info", params)
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableFlags(cmd)
cmd.Flags().String("view-id", "", i18n.T("View ID (必填)"))
cmd.Flags().String("title", "", i18n.T("表单标题"))
cmd.Flags().String("name", "", i18n.T("--title 的别名"))
cmd.Flags().String("description", "", i18n.T("表单描述"))
return cmd
}
func newAitableFormDeleteCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "delete",
Short: i18n.T("删除表单"),
Example: " dws aitable form delete --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID --yes",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return err
}
viewID, err := aitableRequiredFlag(cmd, "view-id")
if err != nil {
return err
}
if !confirmDeletePrompt(cmd, i18n.T("表单"), viewID) {
return nil
}
return runAitableFormTool(cmd, runner, "delete_form_view", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableFlags(cmd)
cmd.Flags().String("view-id", "", i18n.T("View ID (必填)"))
return cmd
}
func newAitableFormQuestionsCreateCommand(runner executor.Runner) *cobra.Command {
cmd := newAitableFieldCreateCommand(runner)
cmd.Use = "create"
cmd.Short = i18n.T("向表单添加题目(等价于 field create)")
cmd.Example = " dws aitable form questions create --base-id BASE_ID --table-id TABLE_ID --name 电话 --type text"
return cmd
}
func newAitableFormQuestionsDeleteCommand(runner executor.Runner) *cobra.Command {
cmd := newAitableFieldDeleteCommand(runner)
cmd.Use = "delete"
cmd.Short = i18n.T("从表单删除题目(等价于 field delete)")
cmd.Example = " dws aitable form questions delete --base-id BASE_ID --table-id TABLE_ID --field-id FIELD_ID --yes"
return cmd
}
func newAitableFormFieldListCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: i18n.T("列出表单字段"),
Example: " dws aitable form field list --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, viewID, err := requiredAitableBaseTableView(cmd)
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "list_form_fields", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableViewFlags(cmd)
return cmd
}
func newAitableFormFieldUpdateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "update",
Short: i18n.T("更新表单字段"),
Example: " dws aitable form field update --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID --field-id FIELD_ID --required true",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, viewID, err := requiredAitableBaseTableView(cmd)
if err != nil {
return err
}
fieldID, err := aitableRequiredFlag(cmd, "field-id")
if err != nil {
return err
}
params := map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
"fieldId": fieldID,
}
if required, ok, err := optionalAitableBoolStringFlag(cmd, "required"); err != nil {
return err
} else if ok {
params["required"] = required
}
if description := aitableStringFlag(cmd, "field-description"); description != "" {
params["fieldDescription"] = description
}
if _, hasRequired := params["required"]; !hasRequired {
if _, hasDescription := params["fieldDescription"]; !hasDescription {
return apperrors.NewValidation("at least one of --required or --field-description is required")
}
}
return runAitableFormTool(cmd, runner, "update_form_field", params)
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableViewFlags(cmd)
cmd.Flags().String("field-id", "", i18n.T("Field ID (必填)"))
cmd.Flags().String("required", "", i18n.T("是否必填: true/false"))
cmd.Flags().String("field-description", "", i18n.T("字段描述"))
return cmd
}
func newAitableFormFieldHideCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "hide",
Short: i18n.T("切换表单字段隐藏"),
Example: " dws aitable form field hide --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID --field-id FIELD_ID --hidden true",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, viewID, err := requiredAitableBaseTableView(cmd)
if err != nil {
return err
}
fieldID, err := aitableRequiredFlag(cmd, "field-id")
if err != nil {
return err
}
hidden, err := requiredAitableBoolStringFlag(cmd, "hidden")
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "update_form_field_hidden", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
"fieldId": fieldID,
"hidden": hidden,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableViewFlags(cmd)
cmd.Flags().String("field-id", "", i18n.T("Field ID (必填)"))
cmd.Flags().String("hidden", "", i18n.T("是否隐藏: true/false (必填)"))
return cmd
}
func newAitableFormShareGetCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "get",
Short: i18n.T("获取表单分享配置"),
Example: " dws aitable form share get --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, viewID, err := requiredAitableBaseTableView(cmd)
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "get_share_form_config", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableViewFlags(cmd)
return cmd
}
func newAitableFormShareUpdateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "update",
Short: i18n.T("开启/关闭分享表单"),
Example: " dws aitable form share update --base-id BASE_ID --table-id TABLE_ID --view-id VIEW_ID --enabled true",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
baseID, tableID, viewID, err := requiredAitableBaseTableView(cmd)
if err != nil {
return err
}
enabledRaw, err := requiredAitableBoolStringFlagRaw(cmd, "enabled")
if err != nil {
return err
}
return runAitableFormTool(cmd, runner, "update_share_form", map[string]any{
"baseId": baseID,
"tableId": tableID,
"viewId": viewID,
"enabled": enabledRaw,
})
},
}
preferLegacyLeaf(cmd)
addAitableBaseTableViewFlags(cmd)
cmd.Flags().String("enabled", "", i18n.T("是否开启分享: true/false (必填)"))
return cmd
}
func addAitableBaseTableFlags(cmd *cobra.Command) {
cmd.Flags().String("base-id", "", i18n.T("Base ID (必填)"))
addAitableHiddenStringFlag(cmd, "base", "--base-id 的兼容别名")
cmd.Flags().String("table-id", "", i18n.T("Table ID (必填)"))
}
func addAitableBaseTableViewFlags(cmd *cobra.Command) {
addAitableBaseTableFlags(cmd)
cmd.Flags().String("view-id", "", i18n.T("View ID (必填)"))
}
func requiredAitableBaseTable(cmd *cobra.Command) (string, string, error) {
baseID, err := aitableRequiredFlagOrFallback(cmd, "base-id", "base")
if err != nil {
return "", "", err
}
tableID, err := aitableRequiredFlag(cmd, "table-id")
if err != nil {
return "", "", err
}
return baseID, tableID, nil
}
func requiredAitableBaseTableView(cmd *cobra.Command) (string, string, string, error) {
baseID, tableID, err := requiredAitableBaseTable(cmd)
if err != nil {
return "", "", "", err
}
viewID, err := aitableRequiredFlag(cmd, "view-id")
if err != nil {
return "", "", "", err
}
return baseID, tableID, viewID, nil
}
func optionalAitableBoolStringFlag(cmd *cobra.Command, name string) (bool, bool, error) {
raw := aitableStringFlag(cmd, name)
if raw == "" {
return false, false, nil
}
value, err := parseAitableBoolString(raw, name)
if err != nil {
return false, false, err
}
return value, true, nil
}
func requiredAitableBoolStringFlag(cmd *cobra.Command, name string) (bool, error) {
raw, err := requiredAitableBoolStringFlagRaw(cmd, name)
if err != nil {
return false, err
}
return parseAitableBoolString(raw, name)
}
func requiredAitableBoolStringFlagRaw(cmd *cobra.Command, name string) (string, error) {
raw := aitableStringFlag(cmd, name)
if raw == "" {
return "", apperrors.NewValidation(fmt.Sprintf("--%s is required", name))
}
if _, err := parseAitableBoolString(raw, name); err != nil {
return "", err
}
return strings.ToLower(strings.TrimSpace(raw)), nil
}
func parseAitableBoolString(raw, name string) (bool, error) {
value, err := strconv.ParseBool(strings.ToLower(strings.TrimSpace(raw)))
if err != nil {
return false, apperrors.NewValidation(fmt.Sprintf("--%s must be true or false", name))
}
return value, nil
}
@@ -92,3 +92,11 @@ func TestAITableUploadFileUnwrapsRuntimeContent(t *testing.T) {
t.Fatalf("fileToken = %#v, want ft_test_123", got)
}
}
func TestAITableUploadFileCommandIsHiddenFromWukongSurface(t *testing.T) {
runner := &uploadFileRunner{}
cmd := newAITableUploadFileCommand(runner)
if !cmd.Hidden {
t.Fatalf("upload-file command must stay hidden from the Wukong-aligned command surface")
}
}
+422 -331
View File
@@ -14,7 +14,9 @@
package helpers
import (
"bytes"
"context"
"encoding/json"
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cli"
@@ -30,6 +32,12 @@ func init() {
})
}
// chatHandler retains only the chat commands that carry real business logic
// (intelligent tool routing, current-user resolution, response normalization,
// or stdin/@file input support that dynamic commands do not yet provide).
// Thin wrappers — search, group rename, group members list/add/remove/add-bot,
// bot search — are now produced by the dynamic service-discovery envelope
// (envelope/pre-discovery.json) so the helper does not have to duplicate them.
type chatHandler struct{}
func (chatHandler) Name() string {
@@ -40,7 +48,7 @@ func (chatHandler) Command(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "chat",
Short: "群聊 / 消息 / 机器人",
Long: "管理钉钉会话与群聊:创建群、搜索群、查看群成员、添加机器人到群、修改群名称、拉取会话消息、发送群消息、机器人消息与 Webhook。",
Long: "钉钉会话与群聊:发送消息(用户/机器人/Webhook)、撤回机器人消息、创建群。其余命令由服务发现 envelope 提供。",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
@@ -64,11 +72,12 @@ func (chatHandler) Command(runner executor.Runner) *cobra.Command {
newChatMessageSendByBotCommand(runner),
newChatMessageRecallByBotCommand(runner),
newChatMessageSendByWebhookCommand(runner),
newChatMessageReplyCommand(runner),
)
bot := &cobra.Command{
Use: "bot",
Short: "机器人管理",
group := &cobra.Command{
Use: "group",
Short: "群组管理",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
@@ -76,12 +85,196 @@ func (chatHandler) Command(runner executor.Runner) *cobra.Command {
return cmd.Help()
},
}
bot.AddCommand(newChatBotSearchCommand(runner))
members := &cobra.Command{
Use: "members",
Short: "群成员管理",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
members.AddCommand(
newChatGroupMembersAddBotCommand(runner),
newChatGroupMembersRemoveBotCommand(runner),
)
group.AddCommand(
newChatGroupCreateCommand(runner),
newChatGroupBotsCommand(runner),
members,
)
root.AddCommand(message, newChatSearchCommand(runner), newChatGroupCommand(runner), bot)
bot := &cobra.Command{
Use: "bot",
Short: "机器人查询",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
bot.AddCommand(
newChatBotFindCommand(runner),
newChatBotSearchCommand(runner),
)
root.AddCommand(message, group, bot)
return root
}
// botInvoke 把 bot 相关命令统一路由到 "bot" MCP server,与 wukong 的
// callMCPToolOnServer("bot", ...) 对齐。
func botInvoke(runner executor.Runner, cmd *cobra.Command, tool string, params map[string]any) error {
invocation := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd),
"bot",
tool,
params,
)
invocation.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), invocation)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
func newChatBotFindCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "find",
Short: "搜索全部可用机器人(含他人/官方,额外返回 openDingTalkId 可发单聊)",
Long: "按关键词搜索当前用户可用的全部机器人(含他人创建、官方),支持游标分页。find 返回 openDingTalkId(可给机器人发单聊);只搜自己创建的用 dws chat bot search。",
Example: " dws chat bot find --query \"日报\"\n dws chat bot find --query \"日报\" --limit 20",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
query, _ := cmd.Flags().GetString("query")
if strings.TrimSpace(query) == "" {
query, _ = cmd.Flags().GetString("keyword")
}
if strings.TrimSpace(query) == "" {
return apperrors.NewValidation("--query is required")
}
params := map[string]any{"keyword": query}
if v, _ := cmd.Flags().GetInt("limit"); v > 0 {
params["limit"] = v
}
if v, _ := cmd.Flags().GetString("cursor"); v != "" {
params["cursor"] = v
}
return botInvoke(runner, cmd, "search_bots", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("query", "", "搜索关键词 (必填)")
cmd.Flags().String("keyword", "", "--query 的别名")
_ = cmd.Flags().MarkHidden("keyword")
cmd.Flags().Int("limit", 20, "每页返回数量(默认 20)")
cmd.Flags().String("cursor", "", "分页游标(首次不传,翻页传上次返回的 nextCursor)")
return cmd
}
func newChatBotSearchCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "search",
Short: "搜索我创建的机器人",
Long: "按名称搜索当前用户自己创建的机器人。搜全部(含他人/官方)用 dws chat bot find。",
Example: " dws chat bot search --name \"日报\"",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
params := map[string]any{}
if v, _ := cmd.Flags().GetString("name"); v != "" {
params["robotName"] = v
}
if v, _ := cmd.Flags().GetInt("page"); v > 0 {
params["currentPage"] = v
}
if v, _ := cmd.Flags().GetInt("size"); v > 0 {
params["pageSize"] = v
}
return botInvoke(runner, cmd, "search_my_robots", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("name", "", "机器人名称关键词(可选)")
cmd.Flags().Int("page", 0, "页码(可选)")
cmd.Flags().Int("size", 0, "每页数量(可选)")
return cmd
}
func newChatGroupBotsCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "bots",
Short: "查看群内所有机器人",
Example: " dws chat group bots --group <openConversationId>",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
group, _ := cmd.Flags().GetString("group")
if strings.TrimSpace(group) == "" {
return apperrors.NewValidation("--group is required")
}
return botInvoke(runner, cmd, "list_group_bots", map[string]any{"openConversationId": group})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("group", "", "群聊 openConversationId (必填)")
return cmd
}
func newChatGroupMembersAddBotCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "add-bot",
Short: "将机器人添加到群中",
Example: " dws chat group members add-bot --id <openConversationId> --robot-code <robotCode>",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
id, _ := cmd.Flags().GetString("id")
robotCode, _ := cmd.Flags().GetString("robot-code")
if strings.TrimSpace(id) == "" || strings.TrimSpace(robotCode) == "" {
return apperrors.NewValidation("--id and --robot-code are required")
}
return botInvoke(runner, cmd, "add_robot_to_group", map[string]any{
"openConversationId": id,
"robotCode": robotCode,
})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "群聊 openConversationId (必填)")
cmd.Flags().String("robot-code", "", "机器人 Code (必填)")
return cmd
}
func newChatGroupMembersRemoveBotCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "remove-bot",
Short: "从群内移除机器人",
Example: " dws chat group members remove-bot --id <openConversationId> --bot-id <openBotId>",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
id, _ := cmd.Flags().GetString("id")
botID, _ := cmd.Flags().GetString("bot-id")
if strings.TrimSpace(id) == "" || strings.TrimSpace(botID) == "" {
return apperrors.NewValidation("--id and --bot-id are required")
}
return botInvoke(runner, cmd, "remove_robot_in_group", map[string]any{
"openConversationId": id,
"openBotId": botID,
})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "群聊 openConversationId (必填)")
cmd.Flags().String("bot-id", "", "机器人 openBotId (必填)")
return cmd
}
func newChatMessageSendCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "send",
@@ -93,14 +286,14 @@ func newChatMessageSendCommand(runner executor.Runner) *cobra.Command {
三者只能选其一,不能同时指定。
消息内容通过 --text 传入,也可作为位置参数;支持 Markdown。
单聊消息(--user / --open-dingtalk-id)必须提供 --title 作为消息标题;群聊可选。
--title 是消息标题,群聊与单聊都必填(API 强制要求;缺失时返回误导性的 "发群服务窗会话消息失败")。
群聊场景下可用 --at-all / --at-users / --at-mobiles 进行 @ 提醒(仅 --group 时生效)。
注意 --text 中需包含对应的 <@userId> / <@all> 占位符才能在客户端渲染出 @ 效果。`,
Example: ` dws chat message send --group <openconversation_id> --text "hello"
群聊场景下可用 --at-all / --at-open-dingtalk-ids 进行 @ 提醒(仅 --group 时生效)。
富媒体:--msg-type image --media-id 发图片;--msg-type file --dentry-id --space-id --file-name 发钉盘文件。`,
Example: ` dws chat message send --group <openconversation_id> --title "周报" --text "请提交本周日报"
dws chat message send --user <userId> --title "提醒" --text "请查收"
dws chat message send --open-dingtalk-id <openDingTalkId> --title "提醒" --text "请确认"
dws chat message send --group <openconversation_id> --title "拉群通知" --text "<@uid> 你被 @ 了" --at-users uid`,
dws chat message send --group <openconversation_id> --msg-type image --media-id <mediaId>`,
Args: cobra.MaximumNArgs(1),
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
@@ -128,13 +321,39 @@ func newChatMessageSendCommand(runner executor.Runner) *cobra.Command {
cmd.Flags().String("user", "", "接收人 userId (单聊三选一)")
cmd.Flags().String("open-dingtalk-id", "", "接收人 openDingTalkId (单聊三选一)")
cmd.Flags().String("text", "", "消息内容,支持 Markdown (也可作位置参数)")
cmd.Flags().String("title", "", "消息标题 (单聊必填,群聊可选)")
cmd.Flags().String("title", "", "消息标题 (可选,未指定时从内容截取)")
cmd.Flags().Bool("at-all", false, "@所有人 (仅 --group 群聊生效)")
cmd.Flags().String("at-users", "", "按 userId @ 指定成员,逗号分隔 (仅 --group 群聊生效)")
cmd.Flags().String("at-mobiles", "", "按手机号 @ 指定成员,逗号分隔 (仅 --group 群聊生效)")
cmd.Flags().String("at-open-dingtalk-ids", "", "@指定成员 openDingTalkId 列表,逗号分隔 (仅 --group 群聊生效)")
cmd.Flags().String("uuid", "", "幂等 UUID (可选,24h 内相同 uuid 不重复发送)")
cmd.Flags().String("msg-type", "", "富媒体类型: image / file (纯文本/Markdown 留空)")
cmd.Flags().String("media-id", "", "图片 mediaId (msg-type=image 时必填)")
cmd.Flags().Int64("dentry-id", 0, "钉盘文件 dentryId (msg-type=file 时必填)")
cmd.Flags().Int64("space-id", 0, "钉盘空间 ID (msg-type=file 时必填)")
cmd.Flags().String("file-name", "", "文件名 (msg-type=file 时必填)")
cmd.Flags().String("file-type", "", "文件类型/扩展名 (msg-type=file)")
cmd.Flags().String("file-path", "", "文件展示路径 (msg-type=file)")
cmd.Flags().Int64("file-size", 0, "文件大小,单位字节 (msg-type=file)")
return cmd
}
// deriveTitleFromText 在未显式指定 --title 时,从正文截取一个标题
// (首行、最多 20 个字符),与 wukong 行为对齐 (send_personal_message 的
// content 内携带 title)。
func deriveTitleFromText(text string) string {
t := strings.TrimSpace(text)
if i := strings.IndexAny(t, "\r\n"); i >= 0 {
t = strings.TrimSpace(t[:i])
}
r := []rune(t)
if len(r) > 20 {
r = r[:20]
}
if len(r) == 0 {
return "消息"
}
return string(r)
}
func buildChatMessageSendInvocation(cmd *cobra.Command, args []string) (map[string]any, string, error) {
guard := cli.NewStdinGuard()
@@ -164,6 +383,8 @@ func buildChatMessageSendInvocation(cmd *cobra.Command, args []string) (map[stri
text = args[0]
}
uuid, _ := cmd.Flags().GetString("uuid")
hasGroup := strings.TrimSpace(group) != ""
hasUser := strings.TrimSpace(user) != ""
hasOpenID := strings.TrimSpace(openID) != ""
@@ -184,49 +405,105 @@ func buildChatMessageSendInvocation(cmd *cobra.Command, args []string) (map[stri
default:
return nil, "", apperrors.NewValidation("--group, --user, and --open-dingtalk-id are mutually exclusive")
}
// ── 富媒体消息 (image / file):走 send_personal_message,后端 schema 支持
// content + msgType (image 经 content 携带 mediaId;file 经 content 携带
// dentryId/spaceId)。本地 --file-path 自动上传暂未移植,使用钉盘 dentry/space。
msgType, _ := cmd.Flags().GetString("msg-type")
if msgType == "text" || msgType == "markdown" {
msgType = ""
}
if msgType != "" {
var contentJSON string
switch msgType {
case "image":
mediaID, _ := cmd.Flags().GetString("media-id")
if strings.TrimSpace(mediaID) == "" {
return nil, "", apperrors.NewValidation("--media-id is required for --msg-type image")
}
b, _ := json.Marshal(map[string]string{"mediaId": mediaID})
contentJSON = string(b)
case "file":
dentryID, _ := cmd.Flags().GetInt64("dentry-id")
spaceID, _ := cmd.Flags().GetInt64("space-id")
fileName, _ := cmd.Flags().GetString("file-name")
if dentryID == 0 || spaceID == 0 || strings.TrimSpace(fileName) == "" {
return nil, "", apperrors.NewValidation("--msg-type file 需要 --dentry-id、--space-id、--file-name (本地 --file-path 自动上传暂未支持)")
}
fileType, _ := cmd.Flags().GetString("file-type")
filePath, _ := cmd.Flags().GetString("file-path")
fileSize, _ := cmd.Flags().GetInt64("file-size")
b, _ := json.Marshal(map[string]any{
"dentryId": dentryID, "spaceId": spaceID, "fileName": fileName,
"fileType": fileType, "filePath": filePath, "fileSize": fileSize,
})
contentJSON = string(b)
default:
return nil, "", apperrors.NewValidation("unsupported --msg-type: " + msgType + " (supported: image, file)")
}
params := map[string]any{"msgType": msgType, "content": contentJSON}
if strings.TrimSpace(uuid) != "" {
params["uuid"] = uuid
}
switch {
case hasGroup:
params["openConversationId"] = group
case hasOpenID:
params["receiverOpenDingTalkId"] = openID
default:
return nil, "", apperrors.NewValidation("--msg-type image/file 需配合 --group 或 --open-dingtalk-id (--user 暂不支持富媒体)")
}
return params, "send_personal_message", nil
}
// ── 文本 / Markdown 消息 ──
if strings.TrimSpace(text) == "" {
return nil, "", apperrors.NewValidation("--text (or positional argument) is required")
}
if strings.TrimSpace(title) == "" {
title = deriveTitleFromText(text)
}
atAll, _ := cmd.Flags().GetBool("at-all")
atUsers, _ := cmd.Flags().GetString("at-users")
atMobiles, _ := cmd.Flags().GetString("at-mobiles")
hasAtUsers := strings.TrimSpace(atUsers) != ""
hasAtMobiles := strings.TrimSpace(atMobiles) != ""
if !hasGroup && (atAll || hasAtUsers || hasAtMobiles) {
return nil, "", apperrors.NewValidation("--at-all / --at-users / --at-mobiles only apply when --group is set")
}
// Direct-message tools (send_direct_message_as_user) reject an empty title at
// the API level with a misleading "发群服务窗会话消息失败" error, so fail loudly
// here instead. Group messages do not require a title.
if (hasUser || hasOpenID) && strings.TrimSpace(title) == "" {
return nil, "", apperrors.NewValidation("--title is required for direct messages (--user / --open-dingtalk-id)")
}
params := map[string]any{"text": text}
if strings.TrimSpace(title) != "" {
params["title"] = title
atOpenIDs, _ := cmd.Flags().GetString("at-open-dingtalk-ids")
hasAtOpenIDs := strings.TrimSpace(atOpenIDs) != ""
if !hasGroup && (atAll || hasAtOpenIDs) {
return nil, "", apperrors.NewValidation("--at-all / --at-open-dingtalk-ids only apply when --group is set")
}
switch {
case hasGroup:
params["openConversation_id"] = group
if atAll && !strings.Contains(text, "<@all>") {
text = "<@all> " + text
}
params := map[string]any{
"openConversationId": group,
"msgType": "markdown",
"content": marshalMessageContent(title, text),
}
if atAll {
params["isAtAll"] = true
params["atAll"] = true
}
if hasAtUsers {
params["atUserIds"] = splitCSV(atUsers)
if hasAtOpenIDs {
params["atOpenDingTalkIds"] = splitCSVStrings(atOpenIDs)
}
if hasAtMobiles {
params["atMobiles"] = splitCSV(atMobiles)
if strings.TrimSpace(uuid) != "" {
params["uuid"] = uuid
}
return params, "send_message_as_user", nil
return params, "send_personal_message", nil
case hasUser:
params["receiverUserId"] = user
params := map[string]any{"title": title, "text": text, "receiverUserId": user}
return params, "send_direct_message_as_user", nil
default:
params["receiverOpenDingTalkId"] = openID
return params, "send_direct_message_as_user", nil
params := map[string]any{
"receiverOpenDingTalkId": openID,
"msgType": "markdown",
"content": marshalMessageContent(title, text),
}
if strings.TrimSpace(uuid) != "" {
params["uuid"] = uuid
}
return params, "send_personal_message", nil
}
}
@@ -266,94 +543,6 @@ func newChatMessageSendByBotCommand(runner executor.Runner) *cobra.Command {
return cmd
}
func newChatSearchCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "search",
Short: "根据名称搜索会话列表",
Example: ` dws chat search --query "项目冲刺"`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
query, err := cmd.Flags().GetString("query")
if err != nil {
return apperrors.NewInternal("failed to read --query")
}
query = strings.TrimSpace(query)
if query == "" {
return apperrors.NewValidation("--query is required")
}
searchReq := map[string]any{"query": query}
cursor, err := cmd.Flags().GetString("cursor")
if err != nil {
return apperrors.NewInternal("failed to read --cursor")
}
if strings.TrimSpace(cursor) != "" {
searchReq["cursor"] = cursor
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd),
"chat",
"search_groups_by_keyword",
map[string]any{"OpenSearchRequest": searchReq},
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("query", "", "搜索关键词 (必填)")
cmd.Flags().String("cursor", "", "分页游标 (首页留空)")
return cmd
}
func newChatGroupCommand(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "group",
Short: "群组管理",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
members := &cobra.Command{
Use: "members",
Short: "群成员管理",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
// Keeps the helper-restructured group winning over the dynamic envelope's
// `members` leaf (which only exposes `get_group_members`); without this
// the merge layer treats the shape mismatch as "envelope is authority"
// and drops the entire helper subtree (issue #164).
preferLegacyLeaf(members)
members.AddCommand(
newChatGroupMembersListCommand(runner),
newChatGroupMemberAddCommand(runner),
newChatGroupMemberRemoveCommand(runner),
newChatGroupMembersAddBotCommand(runner),
)
root.AddCommand(
newChatGroupCreateCommand(runner),
members,
newChatGroupRenameCommand(runner),
)
return root
}
func newChatGroupCreateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "create",
@@ -380,20 +569,44 @@ func newChatGroupCreateCommand(runner executor.Runner) *cobra.Command {
return apperrors.NewValidation("--users is required")
}
groupType := strings.ToUpper(strings.TrimSpace(cmd.Flags().Lookup("type").Value.String()))
if groupType == "" {
groupType = "INTERNAL"
}
switch groupType {
case "INTERNAL", "EXTERNAL", "NORMAL":
default:
return apperrors.NewValidation("--type must be one of INTERNAL, EXTERNAL, NORMAL")
}
threadEnabled, _ := cmd.Flags().GetBool("thread")
currentUserID, err := getCurrentUserID(cmd.Context(), runner)
if err != nil {
return err
}
allMembers := prependOwner(currentUserID, memberUserIDs)
// create_group_conversation (multi-type + thread support) and the
// legacy create_internal_group live on two different MCP servers
// ("im" and "group-chat") that both publish `dws chat ...`. Route
// each tool to its owning server explicitly so direct-runtime
// endpoint resolution does not collapse them onto the shared
// cli.command endpoint (which would send create_group_conversation
// to the group-chat server, where it is not registered).
product := "im"
tool := "create_group_conversation"
params := map[string]any{
"groupMembers": stringSliceToAny(allMembers),
"groupName": name,
"groupType": groupType,
"convThreadEnabled": threadEnabled,
}
inv := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd),
"chat",
"create_internal_group",
map[string]any{
"groupMembers": stringSliceToAny(allMembers),
"groupName": name,
},
product,
tool,
params,
)
inv.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), inv)
@@ -408,6 +621,8 @@ func newChatGroupCreateCommand(runner executor.Runner) *cobra.Command {
cmd.Flags().String("name", "", "群名称 (必填)")
cmd.Flags().String("users", "", "群成员 userId 列表,逗号分隔 (必填)")
cmd.Flags().String("type", "INTERNAL", "群类型: INTERNAL(企业内部群) / EXTERNAL(外部群) / NORMAL(普通群),默认 INTERNAL")
cmd.Flags().Bool("thread", false, "开启话题圈 (convThreadEnabled)")
return cmd
}
@@ -643,6 +858,10 @@ func newChatMessageRecallByBotCommand(runner executor.Runner) *cobra.Command {
}
// ── message send-by-webhook ────────────────────────────────
//
// Kept as a helper (rather than delegating to the dynamic envelope) because
// it needs --text @file / stdin pipe support via resolveStringFlag, which the
// dynamic-command layer does not yet provide.
func newChatMessageSendByWebhookCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
@@ -709,65 +928,63 @@ func newChatMessageSendByWebhookCommand(runner executor.Runner) *cobra.Command {
return cmd
}
// ── group members list ─────────────────────────────────────
// ── message reply ────────────────────────────────────────
//
// Kept as a helper because the underlying MCP tool send_personal_message
// requires the reply payload to be a JSON-encoded string assembled from
// --ref-msg-id / --ref-sender / --text. Envelope toolOverride does flat
// flag→param mapping only and cannot construct nested JSON, so this
// orchestration must live in CLI code.
func newChatGroupMembersListCommand(runner executor.Runner) *cobra.Command {
func newChatMessageReplyCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: "查询群成员列表",
Example: ` dws chat group members list --id <openconversation_id>`,
Use: "reply",
Short: "引用回复消息(支持单聊/群聊)",
Long: "以当前用户身份引用某条消息并回复。需 --conversation-id 会话 ID、--ref-msg-id 被引用消息 ID、--ref-sender 原发送者 openDingTalkId、--text 回复内容。",
Example: ` dws chat message reply --conversation-id <openConversationId> --ref-msg-id <openMessageId> --ref-sender <openDingTalkId> --text "收到,马上处理"`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
groupID, _ := cmd.Flags().GetString("id")
if strings.TrimSpace(groupID) == "" {
return apperrors.NewValidation("--id is required")
convID, _ := cmd.Flags().GetString("conversation-id")
refMsgID, _ := cmd.Flags().GetString("ref-msg-id")
refSender, _ := cmd.Flags().GetString("ref-sender")
text, _ := cmd.Flags().GetString("text")
if strings.TrimSpace(convID) == "" {
return apperrors.NewValidation("--conversation-id is required")
}
params := map[string]any{
"openconversation_id": groupID,
if strings.TrimSpace(refMsgID) == "" {
return apperrors.NewValidation("--ref-msg-id is required")
}
if v, _ := cmd.Flags().GetString("cursor"); v != "" {
params["cursor"] = v
if strings.TrimSpace(refSender) == "" {
return apperrors.NewValidation("--ref-sender is required")
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "chat", "get_group_members", params,
))
if strings.TrimSpace(text) == "" {
return apperrors.NewValidation("--text is required")
}
replyContent := map[string]any{
"referenceOpenMessageId": refMsgID,
"srcMsgSendOpenDingTalkId": refSender,
"replyMsgType": "text",
"content": text,
}
contentJSON, err := jsonMarshal(replyContent)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "群 ID / openconversation_id (必填)")
cmd.Flags().String("cursor", "", "分页游标 (首页留空)")
return cmd
}
// ── group rename ───────────────────────────────────────────
func newChatGroupRenameCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "rename",
Short: "更新群名称",
Example: ` dws chat group rename --id <openconversation_id> --name "新群名"`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
groupID, _ := cmd.Flags().GetString("id")
name, _ := cmd.Flags().GetString("name")
if strings.TrimSpace(groupID) == "" {
return apperrors.NewValidation("--id is required")
}
if strings.TrimSpace(name) == "" {
return apperrors.NewValidation("--name is required")
return apperrors.NewInternal("marshal reply content: " + err.Error())
}
params := map[string]any{
"openconversation_id": groupID,
"group_name": name,
"openConversationId": convID,
"msgType": "reply",
"content": contentJSON,
"clawType": "wukong",
}
if uuid, _ := cmd.Flags().GetString("uuid"); strings.TrimSpace(uuid) != "" {
params["uuid"] = uuid
}
inv := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "chat", "update_group_name", params,
cobracmd.LegacyCommandPath(cmd),
"group-chat",
"send_personal_message",
params,
)
inv.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), inv)
@@ -778,160 +995,34 @@ func newChatGroupRenameCommand(runner executor.Runner) *cobra.Command {
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "群 ID / openconversation_id (必填)")
cmd.Flags().String("name", "", "新群名称 (必填)")
cmd.Flags().String("conversation-id", "", "会话 openConversationId (必填,支持单聊/群聊)")
cmd.Flags().String("ref-msg-id", "", "被引用的消息 openMessageId (必填)")
cmd.Flags().String("ref-sender", "", "被引用消息发送者 openDingTalkId (必填)")
cmd.Flags().String("text", "", "回复正文 (必填)")
cmd.Flags().String("uuid", "", "可选 uuid(幂等标识)")
return cmd
}
// ── group members add ──────────────────────────────────────
func newChatGroupMemberAddCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "add",
Short: "添加群成员",
Example: ` dws chat group members add --id <openconversation_id> --users userId1,userId2`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
groupID, _ := cmd.Flags().GetString("id")
usersStr, _ := cmd.Flags().GetString("users")
if strings.TrimSpace(groupID) == "" {
return apperrors.NewValidation("--id is required")
}
if strings.TrimSpace(usersStr) == "" {
return apperrors.NewValidation("--users is required")
}
params := map[string]any{
"openconversation_id": groupID,
"userId": splitCSV(usersStr),
}
inv := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "chat", "add_group_member", params,
)
inv.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), inv)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
func jsonMarshal(v any) (string, error) {
b, err := json.Marshal(v)
if err != nil {
return "", err
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "群 ID / openconversation_id (必填)")
cmd.Flags().String("users", "", "要添加的 userId 列表,逗号分隔 (必填)")
return cmd
return string(b), nil
}
// ── group members remove ───────────────────────────────────
func newChatGroupMemberRemoveCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "remove",
Short: "移除群成员",
Example: ` dws chat group members remove --id <openconversation_id> --users userId1,userId2`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
groupID, _ := cmd.Flags().GetString("id")
usersStr, _ := cmd.Flags().GetString("users")
if strings.TrimSpace(groupID) == "" {
return apperrors.NewValidation("--id is required")
}
if strings.TrimSpace(usersStr) == "" {
return apperrors.NewValidation("--users is required")
}
params := map[string]any{
"openconversationId": groupID,
"userIdList": splitCSV(usersStr),
}
inv := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "chat", "remove_group_member", params,
)
inv.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), inv)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("id", "", "Group ID / openconversation_id (required)")
cmd.Flags().String("users", "", "Comma-separated userId list to remove (required)")
return cmd
}
// ── group members add-bot ──────────────────────────────────
func newChatGroupMembersAddBotCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "add-bot",
Short: "Add bot to group",
Example: ` dws chat group members add-bot --robot-code <robot-code> --id <openconversation_id>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
robotCode, _ := cmd.Flags().GetString("robot-code")
groupID, _ := cmd.Flags().GetString("id")
if strings.TrimSpace(robotCode) == "" {
return apperrors.NewValidation("--robot-code is required")
}
if strings.TrimSpace(groupID) == "" {
return apperrors.NewValidation("--id is required")
}
params := map[string]any{
"robotCode": robotCode,
"openConversationId": groupID,
}
inv := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "bot", "add_robot_to_group", params,
)
inv.DryRun = commandDryRun(cmd)
result, err := runner.Run(cmd.Context(), inv)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("robot-code", "", "Bot code (required)")
cmd.Flags().String("id", "", "Group openConversationId (required)")
return cmd
}
// ── bot search ─────────────────────────────────────────────
func newChatBotSearchCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "search",
Short: "Search my bots",
Example: " dws chat bot search --page 1\n dws chat bot search --page 1 --size 10 --name \"日报\"",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
page, _ := cmd.Flags().GetInt("page")
params := map[string]any{
"currentPage": page,
}
if v, _ := cmd.Flags().GetInt("size"); v > 0 {
params["pageSize"] = v
}
if v, _ := cmd.Flags().GetString("name"); v != "" {
params["robotName"] = v
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "bot", "search_my_robots", params,
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().Int("page", 1, "Page number, starting from 1")
cmd.Flags().Int("size", 0, "Items per page (default 50)")
cmd.Flags().String("name", "", "Search by name")
return cmd
// marshalMessageContent builds the send_personal_message content payload
// ({"title","text"}) WITHOUT HTML-escaping < > &. DingTalk's client renders
// @-mentions by matching literal <@openDingTalkId> / <@all> tokens in the
// message text; the default json.Marshal escaping turns them into
// <@...>, which the client shows as plain text instead of a rendered
// mention. encoding/json offers no escape toggle on Marshal, so use an Encoder.
func marshalMessageContent(title, text string) string {
var buf bytes.Buffer
enc := json.NewEncoder(&buf)
enc.SetEscapeHTML(false)
// Encoder errors are impossible for a map[string]string; ignore safely.
_ = enc.Encode(map[string]string{"title": title, "text": text})
// Encoder.Encode appends a trailing newline; strip it.
return strings.TrimRight(buf.String(), "\n")
}
+91 -125
View File
@@ -7,7 +7,6 @@ import (
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
type captureRunner struct {
@@ -59,10 +58,11 @@ func TestChatMessageSendRoutesByDestination(t *testing.T) {
wantValue string
}{
{
// 群聊对齐 wukong:tool=send_personal_message,会话键=openConversationId
name: "group",
args: []string{"--group", "cid-xyz", "--text", "hello"},
wantTool: "send_message_as_user",
wantKey: "openConversation_id",
args: []string{"--group", "cid-xyz", "--title", "t", "--text", "hello"},
wantTool: "send_personal_message",
wantKey: "openConversationId",
wantValue: "cid-xyz",
},
{
@@ -73,18 +73,20 @@ func TestChatMessageSendRoutesByDestination(t *testing.T) {
wantValue: "034766",
},
{
// openDingTalkId 单聊也走 send_personal_message(content 携带正文)
name: "open-dingtalk-id-direct",
args: []string{"--open-dingtalk-id", "OP123", "--title", "t", "--text", "hi"},
wantTool: "send_direct_message_as_user",
wantTool: "send_personal_message",
wantKey: "receiverOpenDingTalkId",
wantValue: "OP123",
},
{
// 群聊正文打包进 content JSON(键序按 encoding/json 字典序:text 在 title 前)
name: "positional-text",
args: []string{"--group", "cid-xyz", "hello from positional"},
wantTool: "send_message_as_user",
wantKey: "text",
wantValue: "hello from positional",
args: []string{"--group", "cid-xyz", "--title", "t", "hello from positional"},
wantTool: "send_personal_message",
wantKey: "content",
wantValue: `{"text":"hello from positional","title":"t"}`,
},
}
for _, tc := range cases {
@@ -132,16 +134,8 @@ func TestChatMessageSendRejectsInvalidDestination(t *testing.T) {
args: []string{"--group", "cid-x"},
wantErr: "--text (or positional argument) is required",
},
{
name: "direct-user-without-title",
args: []string{"--user", "034766", "--text", "hi"},
wantErr: "--title is required for direct messages",
},
{
name: "direct-open-dingtalk-id-without-title",
args: []string{"--open-dingtalk-id", "OP123", "--text", "hi"},
wantErr: "--title is required for direct messages",
},
// 注:--title 不再强制必填——缺省时由 deriveTitleFromText 从正文自动派生
// (对齐 wukong),故原 *-without-title 的"必须报错"用例已随实现移除。
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
@@ -162,12 +156,12 @@ func TestChatMessageSendRejectsInvalidDestination(t *testing.T) {
}
}
// TestChatMessageSendForwardsAtMentions guards the regression introduced
// alongside the destination-based routing in PR #170: the hardcoded helper
// declared --group / --user / --open-dingtalk-id / --text / --title but
// dropped the v1.0.15 envelope's --at-users / --at-all / --at-mobiles flags,
// so `dws chat message send --group ... --at-users ...` failed with
// `unknown flag: --at-users` (issue #177).
// TestChatMessageSendForwardsAtMentions guards that group @-mentions survive the
// destination-based routing. After aligning `send` with wukong, group messages go
// through the send_personal_message tool and the @ surface is --at-all (→ atAll)
// and --at-open-dingtalk-ids (→ atOpenDingTalkIds, openDingTalkId-based). The
// pre-wukong envelope flags (--at-users / --at-mobiles) no longer exist on `send`;
// regressing them would resurface `unknown flag: --at-...` (issue #177).
func TestChatMessageSendForwardsAtMentions(t *testing.T) {
cases := []struct {
name string
@@ -175,18 +169,16 @@ func TestChatMessageSendForwardsAtMentions(t *testing.T) {
wantParams map[string]any
}{
{
name: "group-with-at-users",
name: "group-with-at-open-dingtalk-ids",
args: []string{
"--group", "cid-xyz",
"--title", "拉群通知",
"--text", "<@uid-1> <@uid-2> 请关注",
"--at-users", "uid-1,uid-2",
"--text", "<@op-1> <@op-2> 请关注",
"--at-open-dingtalk-ids", "op-1,op-2",
},
wantParams: map[string]any{
"openConversation_id": "cid-xyz",
"title": "拉群通知",
"text": "<@uid-1> <@uid-2> 请关注",
"atUserIds": []any{"uid-1", "uid-2"},
"openConversationId": "cid-xyz",
"atOpenDingTalkIds": []string{"op-1", "op-2"},
},
},
{
@@ -198,25 +190,8 @@ func TestChatMessageSendForwardsAtMentions(t *testing.T) {
"--at-all",
},
wantParams: map[string]any{
"openConversation_id": "cid-xyz",
"title": "全员通知",
"text": "<@all> 请关注",
"isAtAll": true,
},
},
{
name: "group-with-at-mobiles",
args: []string{
"--group", "cid-xyz",
"--title", "提醒",
"--text", "请 13800000000 确认",
"--at-mobiles", "13800000000,13900000000",
},
wantParams: map[string]any{
"openConversation_id": "cid-xyz",
"title": "提醒",
"text": "请 13800000000 确认",
"atMobiles": []any{"13800000000", "13900000000"},
"openConversationId": "cid-xyz",
"atAll": true,
},
},
}
@@ -231,8 +206,8 @@ func TestChatMessageSendForwardsAtMentions(t *testing.T) {
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\noutput:\n%s", err, out.String())
}
if got := runner.last.Tool; got != "send_message_as_user" {
t.Fatalf("Tool = %q, want send_message_as_user", got)
if got := runner.last.Tool; got != "send_personal_message" {
t.Fatalf("Tool = %q, want send_personal_message", got)
}
for key, want := range tc.wantParams {
got, ok := runner.last.Params[key]
@@ -247,6 +222,55 @@ func TestChatMessageSendForwardsAtMentions(t *testing.T) {
}
}
// TestChatMessageSendContentNotHTMLEscaped guards the @-mention rendering fix:
// the send_personal_message content must keep literal <@openDingTalkId> / <@all>
// tokens. If json.Marshal's default HTML escaping is reintroduced, the tokens
// become <@...> and the DingTalk client renders them as plain text
// instead of a real @-mention.
func TestChatMessageSendContentNotHTMLEscaped(t *testing.T) {
cases := []struct {
name string
args []string
want string // literal token that must survive in content
}{
{
name: "group-at-all",
args: []string{"--group", "cid-xyz", "--title", "t", "--text", "<@all> hi", "--at-all"},
want: "<@all>",
},
{
name: "group-at-open-dingtalk-id",
args: []string{"--group", "cid-xyz", "--title", "t", "--text", "<@op-1> hi", "--at-open-dingtalk-ids", "op-1"},
want: "<@op-1>",
},
{
name: "direct-open-dingtalk-id",
args: []string{"--open-dingtalk-id", "OP123", "--title", "t", "--text", "<@OP123> hi"},
want: "<@OP123>",
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runner := &captureRunner{}
cmd := newChatMessageSendCommand(runner)
var out bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&out)
cmd.SetArgs(tc.args)
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\noutput:\n%s", err, out.String())
}
content, _ := runner.last.Params["content"].(string)
if !strings.Contains(content, tc.want) {
t.Fatalf("content %q missing literal %q (HTML-escaped?)", content, tc.want)
}
if strings.Contains(content, "\\u003c") || strings.Contains(content, "\\u003e") {
t.Fatalf("content %q is HTML-escaped; @-mention will not render", content)
}
})
}
}
// TestChatMessageSendRejectsAtMentionsOutsideGroup ensures we do not silently
// drop user intent when --at-* is combined with --user / --open-dingtalk-id
// (single-chat tools have no @-mention semantics, so the flag would never
@@ -257,8 +281,8 @@ func TestChatMessageSendRejectsAtMentionsOutsideGroup(t *testing.T) {
args []string
}{
{
name: "user-with-at-users",
args: []string{"--user", "034766", "--text", "hi", "--at-users", "uid-1"},
name: "user-with-at-open-dingtalk-ids",
args: []string{"--user", "034766", "--text", "hi", "--at-open-dingtalk-ids", "op-1"},
},
{
name: "open-dingtalk-id-with-at-all",
@@ -297,81 +321,23 @@ func equalAny(a, b any) bool {
}
}
return true
case []string:
// splitCSVStrings 产出 []string(如 atOpenDingTalkIds),用例期望值也写成 []string
bv, ok := b.([]string)
if !ok || len(av) != len(bv) {
return false
}
for i := range av {
if av[i] != bv[i] {
return false
}
}
return true
default:
return a == b
}
}
// TestChatGroupMembersListSubcommand pins the explicit `list` subcommand
// added for issue #164: previously the bare `chat group members --id` was
// the list path, but it shape-mismatched the dynamic envelope's `members`
// leaf and got eaten by the merge layer. Now `dws chat group members list
// --id <cid>` is a proper leaf siblings of add/remove/add-bot.
func TestChatGroupMembersListSubcommand(t *testing.T) {
runner := &captureRunner{}
groupCmd := newChatGroupCommand(runner)
var members *cobra.Command
for _, sub := range groupCmd.Commands() {
if sub.Name() == "members" {
members = sub
break
}
}
if members == nil {
t.Fatalf("members subcommand missing under chat group")
}
want := map[string]bool{"list": false, "add": false, "remove": false, "add-bot": false}
for _, leaf := range members.Commands() {
if _, ok := want[leaf.Name()]; ok {
want[leaf.Name()] = true
}
}
for name, seen := range want {
if !seen {
t.Errorf("expected `chat group members %s` subcommand, missing", name)
}
}
if members.Flags().Lookup("id") != nil {
t.Errorf("members container should not declare --id (moved to `list` subcommand to avoid shape-mismatch with dynamic envelope)")
}
var listCmd *cobra.Command
for _, leaf := range members.Commands() {
if leaf.Name() == "list" {
listCmd = leaf
break
}
}
if listCmd == nil {
t.Fatalf("`list` subcommand not found")
}
if listCmd.Flags().Lookup("id") == nil {
t.Errorf("`list` subcommand must declare --id")
}
if listCmd.Flags().Lookup("cursor") == nil {
t.Errorf("`list` subcommand must declare --cursor")
}
// Drive execution via the group root so cobra resolves the subcommand
// path properly (calling Execute() on a child directly would re-enter
// the root help branch).
var out bytes.Buffer
groupCmd.SetOut(&out)
groupCmd.SetErr(&out)
groupCmd.SetArgs([]string{"members", "list", "--id", "cid-xyz"})
if err := groupCmd.Execute(); err != nil {
t.Fatalf("members list Execute error = %v\noutput: %s", err, out.String())
}
if got := runner.last.Tool; got != "get_group_members" {
t.Fatalf("Tool = %q, want get_group_members", got)
}
if got := runner.last.Params["openconversation_id"]; got != "cid-xyz" {
t.Fatalf("openconversation_id = %#v, want cid-xyz", got)
}
}
func TestChatMessageSendByBotRoutesToBotProduct(t *testing.T) {
cases := []struct {
name string
+131
View File
@@ -0,0 +1,131 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cobracmd"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
func init() {
RegisterPublic(func() Handler {
return devdocHandler{}
})
}
type devdocHandler struct{}
func (devdocHandler) Name() string {
return "devdoc"
}
func (devdocHandler) Command(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "devdoc",
Short: "开放平台文档搜索",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
article := &cobra.Command{
Use: "article",
Short: "文档文章",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
article.AddCommand(newDevdocArticleSearchCommand(runner))
root.AddCommand(article)
return root
}
func newDevdocArticleSearchCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "search [keyword]",
Short: "搜索开放平台文档",
Args: cobra.MaximumNArgs(1),
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
keyword := devdocFlagOrFallback(cmd, "query", "keyword")
if keyword == "" && len(args) > 0 {
keyword = strings.TrimSpace(args[0])
}
if keyword == "" {
return apperrors.NewValidation("--query is required")
}
page, _ := cmd.Flags().GetInt("page")
if page < 1 {
page = 1
}
size, _ := cmd.Flags().GetInt("size")
if size < 1 {
size = 10
}
return runDevdocTool(cmd, runner, "search_open_platform_docs", map[string]any{
"keyword": keyword,
"page": page,
"size": size,
})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("query", "", "搜索关键词 (必填)")
addDevdocHiddenStringFlag(cmd, "keyword", "--query 的悟空兼容别名")
cmd.Flags().Int("page", 1, "分页页码 (从 1 开始,默认 1)")
cmd.Flags().Int("size", 10, "分页大小 (默认 10)")
return cmd
}
func runDevdocTool(cmd *cobra.Command, runner executor.Runner, tool string, params map[string]any) error {
invocation := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd),
"devdoc",
tool,
params,
)
if commandDryRun(cmd) {
return writeCommandPayload(cmd, invocation)
}
result, err := runner.Run(cmd.Context(), invocation)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
func devdocFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) string {
names := append([]string{primary}, aliases...)
for _, name := range names {
value, err := cmd.Flags().GetString(name)
if err == nil && strings.TrimSpace(value) != "" {
return strings.TrimSpace(value)
}
}
return ""
}
func addDevdocHiddenStringFlag(cmd *cobra.Command, name, usage string) {
cmd.Flags().String(name, "", usage)
_ = cmd.Flags().MarkHidden(name)
}
+76
View File
@@ -0,0 +1,76 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"context"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
)
type devdocCommandRunner struct {
last executor.Invocation
}
func (r *devdocCommandRunner) Run(_ context.Context, invocation executor.Invocation) (executor.Result, error) {
r.last = invocation
return executor.Result{Invocation: invocation}, nil
}
func TestDevdocArticleSearchAcceptsWukongKeywordAlias(t *testing.T) {
t.Parallel()
runner := &devdocCommandRunner{}
cmd := devdocHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"article", "search", "--keyword", "openConversationId", "--page", "2", "--size", "5"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "search_open_platform_docs" {
t.Fatalf("tool = %q, want search_open_platform_docs", runner.last.Tool)
}
if got := runner.last.Params["keyword"]; got != "openConversationId" {
t.Fatalf("keyword = %#v, want openConversationId", got)
}
if got := runner.last.Params["page"]; got != 2 {
t.Fatalf("page = %#v, want 2", got)
}
if got := runner.last.Params["size"]; got != 5 {
t.Fatalf("size = %#v, want 5", got)
}
}
func TestDevdocArticleSearchAcceptsPositionalKeyword(t *testing.T) {
t.Parallel()
runner := &devdocCommandRunner{}
cmd := devdocHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"article", "search", "MCP"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if got := runner.last.Params["keyword"]; got != "MCP" {
t.Fatalf("keyword = %#v, want MCP", got)
}
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,64 @@
package helpers
import (
"bytes"
"context"
"encoding/json"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
)
// docExportStubRunner 驱动一次「提交→查询命中 SUCCESS(无 downloadUrl)」的导出流程,
// 走到 writeCommandPayload 但不触发实际下载(无网络)。
type docExportStubRunner struct{}
func (docExportStubRunner) Run(_ context.Context, inv executor.Invocation) (executor.Result, error) {
switch inv.Tool {
case "submit_export_job":
return executor.Result{Response: map[string]any{"jobId": "job-123"}}, nil
case "query_export_job":
// SUCCESS 但不带 downloadUrl → 跳过 asynctask.Download,仍输出结构化 payload
return executor.Result{Response: map[string]any{"status": "SUCCESS"}}, nil
default:
return executor.Result{}, nil
}
}
// TestDocExportProgressGoesToStdout 守护 doc export 的评测契约:导出进度文案需要
// 出现在 stdout,便于 agent 在执行过程中看到 submit → poll → download 的状态。
func TestDocExportProgressGoesToStdout(t *testing.T) {
cmd := docHandler{}.Command(docExportStubRunner{})
var stdout, stderr bytes.Buffer
cmd.SetOut(&stdout)
cmd.SetErr(&stderr)
cmd.SetArgs([]string{"export", "--node", "nodeABC123", "--output", "/tmp/dws-export-progress-test.docx"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, stderr.String())
}
for _, marker := range []string{"[1/3]", "提交导出任务", "jobId: job-123", "[2/3]"} {
if !strings.Contains(stdout.String(), marker) {
t.Fatalf("期望进度标记 %q 出现在 stdout,实际 stdout:\n%s", marker, stdout.String())
}
}
if strings.Contains(stderr.String(), "[1/3]") {
t.Fatalf("进度不应出现在 stderr,实际 stderr:\n%s", stderr.String())
}
// stdout 同时包含进度与最终 payload;解析末尾 JSON,确保结构化结果仍输出。
jsonStart := strings.LastIndex(stdout.String(), "{")
if jsonStart < 0 {
t.Fatalf("stdout 未包含最终 JSON payload:\n%s", stdout.String())
}
out := strings.TrimSpace(stdout.String()[jsonStart:])
var payload map[string]any
if err := json.Unmarshal([]byte(out), &payload); err != nil {
t.Fatalf("stdout 末尾不是可解析 JSON: err=%v\nstdout:\n%s", err, stdout.String())
}
if payload["jobId"] != "job-123" {
t.Fatalf("payload.jobId = %#v, want job-123; stdout:\n%s", payload["jobId"], stdout.String())
}
}
+282
View File
@@ -0,0 +1,282 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"encoding/json"
"fmt"
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/helpers/docjsonml"
jsonrepair "github.com/RealAlexandreAI/json-repair"
"github.com/spf13/cobra"
)
var docDangerousUnicode = [...]rune{
0x200B,
0x200C,
0x200E,
0x200F,
0x202A,
0x202B,
0x202C,
0x202D,
0x202E,
0x2066,
0x2067,
0x2068,
0x2069,
0xFEFF,
0x00AD,
}
var docDangerousSet = func() map[rune]bool {
m := make(map[rune]bool, len(docDangerousUnicode))
for _, r := range docDangerousUnicode {
m[r] = true
}
return m
}()
func stripDocDangerousUnicode(s string) string {
return strings.Map(func(r rune) rune {
if docDangerousSet[r] {
return -1
}
return r
}, s)
}
type docJSONMLFixMode int
const (
docJSONMLFixDefault docJSONMLFixMode = iota
docJSONMLFixFull
docJSONMLFixNone
)
func docResolveFixMode(cmd *cobra.Command) docJSONMLFixMode {
noFix, _ := cmd.Flags().GetBool("no-fix-jsonml")
fix, _ := cmd.Flags().GetBool("fix-jsonml")
if noFix && fix {
fmt.Fprintln(cmd.ErrOrStderr(), "[WARN] --fix-jsonml 和 --no-fix-jsonml 同时传入,以 --no-fix-jsonml 为准(全部修复关闭)")
return docJSONMLFixNone
}
if noFix {
return docJSONMLFixNone
}
if fix {
return docJSONMLFixFull
}
return docJSONMLFixDefault
}
func docCoerceJSONMLBodyShape(raw string) (string, []string, error) {
if raw == "" {
return raw, nil, nil
}
var probe any
if err := json.Unmarshal([]byte(raw), &probe); err != nil {
return raw, nil, nil
}
if _, ok := probe.([]any); ok {
wrapped, err := json.Marshal(map[string]any{"jsonml": probe})
if err != nil {
return raw, nil, fmt.Errorf("wrap bare jsonml array: %w", err)
}
return string(wrapped), nil, nil
}
return raw, nil, nil
}
func docCoerceJSONMLNodeShape(raw string) (string, []string, error) {
if raw == "" {
return raw, nil, nil
}
var probe any
if err := json.Unmarshal([]byte(raw), &probe); err != nil {
return raw, nil, nil
}
if _, ok := probe.([]any); ok {
return raw, nil, nil
}
wrapper, ok := probe.(map[string]any)
if !ok {
return raw, nil, nil
}
inner, hasKey := wrapper["jsonml"]
if !hasKey {
return raw, nil, nil
}
arr, ok := inner.([]any)
if !ok {
return raw, nil, nil
}
switch len(arr) {
case 0:
return "", nil, fmt.Errorf(`--content-format jsonml 输入 {"jsonml":[]}: wrapper 中 jsonml 数组为空`)
case 1:
out, err := json.Marshal(arr[0])
if err != nil {
return raw, nil, fmt.Errorf("unwrap single jsonml node: %w", err)
}
return string(out), []string{`输入为 {"jsonml":[node]} body 形态,已自动解包为单节点以符合 block 命令协议`}, nil
default:
return "", nil, fmt.Errorf(`block insert/update 一次只能处理一个 JSONML 节点,输入 {"jsonml":[...]} 包含 %d 个节点。请分多次调用,或使用 doc update --content-format jsonml 整篇覆盖`, len(arr))
}
}
func prepareDocJSONMLBody(cmd *cobra.Command, raw string) (string, error) {
mode := docResolveFixMode(cmd)
coerced, coerceNotes, err := docCoerceJSONMLBodyShape(raw)
if err != nil {
return "", err
}
docEmitJSONMLFixNotes(cmd, coerceNotes)
raw = coerced
var wrapper map[string]any
if err := json.Unmarshal([]byte(raw), &wrapper); err != nil {
if mode == docJSONMLFixFull {
repaired, repairErr := jsonrepair.RepairJSON(raw)
if repairErr != nil {
return "", fmt.Errorf("JSON 语法错误且自动修复失败: %w\n原始错误: %v", repairErr, err)
}
fmt.Fprintln(cmd.ErrOrStderr(), "[FIX] JSON 语法已自动修复(括号/逗号等结构性错误)")
if err2 := json.Unmarshal([]byte(repaired), &wrapper); err2 != nil {
return "", fmt.Errorf("JSON 修复后仍无法解析: %w", err2)
}
} else {
return "", fmt.Errorf("JSON 语法错误: %w\n输入不是有效的 JSON(可能缺少括号或逗号)。如果输入来自 LLM 生成,可通过 --fix-jsonml 尝试自动修复", err)
}
}
bodyAny, ok := wrapper["jsonml"]
if !ok {
return "", fmt.Errorf(`--content-format jsonml 输入 JSON 必须包含 "jsonml" 字段,格式: {"jsonml": [...]}`)
}
bodyArr, ok := bodyAny.([]any)
if !ok {
return "", fmt.Errorf(`--content-format jsonml 字段 "jsonml" 必须是数组`)
}
if mode != docJSONMLFixNone {
fixed, notes := docjsonml.NormalizeJsonMLBody(bodyArr)
bodyArr = fixed
docEmitJSONMLFixNotes(cmd, notes)
wrapped, wrapNotes := docjsonml.EnsureRootWrappedBody(bodyArr)
bodyArr = wrapped
docEmitJSONMLFixNotes(cmd, wrapNotes)
}
vr := docjsonml.ValidateJsonMLBodyV2(bodyArr)
if vr.HasErrors() {
return "", fmt.Errorf("JSONML 格式校验失败:\n%s\n请确认输入格式是否正确,或通过 --no-fix-jsonml 关闭自动修复以排查原始错误", vr.Summary())
}
if summary := vr.Summary(); summary != "" {
fmt.Fprintln(cmd.ErrOrStderr(), "[WARN] "+summary)
}
out, err := json.Marshal(bodyArr)
if err != nil {
return "", fmt.Errorf("marshal normalized jsonml: %w", err)
}
return stripDocDangerousUnicode(string(out)), nil
}
func prepareDocJSONMLNode(cmd *cobra.Command, rawElement string) (string, error) {
if rawElement == "" {
return "", fmt.Errorf("--content-format jsonml 要求通过 --element 提供 JSONML 数组")
}
mode := docResolveFixMode(cmd)
coerced, coerceNotes, err := docCoerceJSONMLNodeShape(rawElement)
if err != nil {
return "", err
}
docEmitJSONMLFixNotes(cmd, coerceNotes)
rawElement = coerced
var node any
if err := json.Unmarshal([]byte(rawElement), &node); err != nil {
if mode == docJSONMLFixFull {
repaired, repairErr := jsonrepair.RepairJSON(rawElement)
if repairErr != nil {
return "", fmt.Errorf("JSON 语法错误且自动修复失败: %w\n原始错误: %v", repairErr, err)
}
fmt.Fprintln(cmd.ErrOrStderr(), "[FIX] JSON 语法已自动修复(括号/逗号等结构性错误)")
if err2 := json.Unmarshal([]byte(repaired), &node); err2 != nil {
return "", fmt.Errorf("JSON 修复后仍无法解析: %w", err2)
}
} else {
return "", fmt.Errorf("JSON 语法错误: %w\n输入不是有效的 JSON(可能缺少括号或逗号)。如果输入来自 LLM 生成,可通过 --fix-jsonml 尝试自动修复", err)
}
}
if _, ok := node.([]any); !ok {
return "", fmt.Errorf("--content-format jsonml 要求 --element 为 JSON 数组,实际类型: %T", node)
}
if mode != docJSONMLFixNone {
fixed, notes := docjsonml.NormalizeJsonMLNode(node)
node = fixed
docEmitJSONMLFixNotes(cmd, notes)
}
vr := docjsonml.ValidateJsonMLNodeV2(node)
if vr.HasErrors() {
return "", fmt.Errorf("JSONML 格式校验失败:\n%s\n请确认输入格式是否正确,或通过 --no-fix-jsonml 关闭自动修复以排查原始错误", vr.Summary())
}
if summary := vr.Summary(); summary != "" {
fmt.Fprintln(cmd.ErrOrStderr(), "[WARN] "+summary)
}
out, err := json.Marshal(node)
if err != nil {
return "", fmt.Errorf("marshal normalized jsonml: %w", err)
}
return string(out), nil
}
func docEmitJSONMLFixNotes(cmd *cobra.Command, notes []string) {
if len(notes) == 0 {
return
}
fmt.Fprintf(cmd.ErrOrStderr(), "[FIX] JSONML 自动修复(%d 项):\n", len(notes))
for i, n := range notes {
fmt.Fprintf(cmd.ErrOrStderr(), " %d. %s\n", i+1, n)
}
}
func sniffJsonMLLike(content string) bool {
const lookahead = 64
s := strings.TrimLeft(content, " \t\r\n")
if s == "" {
return false
}
scan := s
if len(scan) > lookahead {
scan = scan[:lookahead]
}
switch s[0] {
case '[':
rest := strings.TrimLeft(scan[1:], " \t\r\n")
return strings.HasPrefix(rest, `"`) || strings.HasPrefix(rest, `[`)
case '{':
rest := strings.TrimLeft(scan[1:], " \t\r\n")
return strings.HasPrefix(rest, `"jsonml"`)
}
return false
}
+720
View File
@@ -0,0 +1,720 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"context"
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
type docCommandRunner struct {
calls int
last executor.Invocation
all []executor.Invocation
responses []map[string]any
}
func (r *docCommandRunner) Run(_ context.Context, invocation executor.Invocation) (executor.Result, error) {
r.calls++
r.last = invocation
r.all = append(r.all, invocation)
result := executor.Result{Invocation: invocation}
if idx := r.calls - 1; idx >= 0 && idx < len(r.responses) {
result.Response = r.responses[idx]
}
return result, nil
}
func executeDocCommand(t *testing.T, cmd *cobra.Command, args ...string) (string, string, error) {
t.Helper()
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs(args)
err := cmd.Execute()
return out.String(), errOut.String(), err
}
func newDocTestRoot(runner executor.Runner) *cobra.Command {
cmd := docHandler{}.Command(runner)
cmd.PersistentFlags().Bool("dry-run", false, "dry run")
cmd.PersistentFlags().Bool("yes", false, "skip confirmation")
return cmd
}
func TestDocPermissionListLimitAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
want int
}{
{name: "limit", args: []string{"--node", "NODE_001", "--limit", "50"}, want: 50},
{name: "max results", args: []string{"--node", "NODE_001", "--max-results", "40"}, want: 40},
{name: "page size", args: []string{"--node", "NODE_001", "--page-size", "10"}, want: 10},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocPermissionListCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, tc.args...)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "list_permission" {
t.Fatalf("tool = %q, want list_permission", runner.last.Tool)
}
if got := runner.last.Params["maxResults"]; got != tc.want {
t.Fatalf("maxResults = %#v, want %d", got, tc.want)
}
})
}
}
func TestDocPermissionListMaxresultsRejected(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocPermissionListCommand(runner)
_, _, err := executeDocCommand(t, cmd, "--node", "NODE_001", "--maxresults", "10")
if err == nil {
t.Fatal("Execute() error = nil, want unknown flag")
}
if !strings.Contains(err.Error(), "unknown flag: --maxresults") {
t.Fatalf("error = %q, want unknown flag for --maxresults", err.Error())
}
if runner.calls != 0 {
t.Fatalf("runner calls = %d, want 0", runner.calls)
}
}
func TestDocUpdateOverwriteRequiresYes(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocTestRoot(runner)
_, _, err := executeDocCommand(t, cmd,
"update",
"--node", "NODE_001",
"--content", "# overwrite probe",
"--mode", "overwrite",
)
if err == nil {
t.Fatal("Execute() error = nil, want --yes validation failure")
}
if !strings.Contains(err.Error(), "--yes") {
t.Fatalf("error = %q, want --yes hint", err.Error())
}
if runner.calls != 0 {
t.Fatalf("runner calls = %d, want 0", runner.calls)
}
}
func TestDocUpdateOverwriteAllowsYesAndDryRun(t *testing.T) {
t.Parallel()
cases := []struct {
name string
extraArgs []string
wantDryRun bool
}{
{name: "yes", extraArgs: []string{"--yes"}},
{name: "dry run", extraArgs: []string{"--dry-run"}, wantDryRun: true},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocTestRoot(runner)
args := []string{
"update",
"--node", "NODE_001",
"--content", "# overwrite probe",
"--mode", "overwrite",
}
args = append(args, tc.extraArgs...)
_, errOut, err := executeDocCommand(t, cmd, args...)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.calls != 1 {
t.Fatalf("runner calls = %d, want 1", runner.calls)
}
if runner.last.DryRun != tc.wantDryRun {
t.Fatalf("DryRun = %v, want %v", runner.last.DryRun, tc.wantDryRun)
}
})
}
}
func TestDocListAcceptsFolderCompatibilityAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
}{
{name: "node", args: []string{"--node", "FOLDER_001"}},
{name: "file id", args: []string{"--file-id", "FOLDER_001"}},
{name: "nodee typo", args: []string{"--nodee", "FOLDER_001"}},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocListCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, tc.args...)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "list_nodes" {
t.Fatalf("tool = %q, want list_nodes", runner.last.Tool)
}
if got := runner.last.Params["folderId"]; got != "FOLDER_001" {
t.Fatalf("folderId = %#v, want FOLDER_001", got)
}
})
}
}
func TestDocListAcceptsWukongPaginationAliases(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocListCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, "--workspace", "WS_001", "--limit", "20", "--cursor", "TOKEN_001")
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "list_nodes" {
t.Fatalf("tool = %q, want list_nodes", runner.last.Tool)
}
if got := runner.last.Params["workspaceId"]; got != "WS_001" {
t.Fatalf("workspaceId = %#v, want WS_001", got)
}
if got := runner.last.Params["pageSize"]; got != 20 {
t.Fatalf("pageSize = %#v, want 20", got)
}
if got := runner.last.Params["pageToken"]; got != "TOKEN_001" {
t.Fatalf("pageToken = %#v, want TOKEN_001", got)
}
}
func TestDocSearchAcceptsWukongPaginationAliases(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocSearchCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, "--query", "方案", "--limit", "20", "--cursor", "TOKEN_001")
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "search_documents" {
t.Fatalf("tool = %q, want search_documents", runner.last.Tool)
}
if got := runner.last.Params["pageSize"]; got != 20 {
t.Fatalf("pageSize = %#v, want 20", got)
}
if got := runner.last.Params["pageToken"]; got != "TOKEN_001" {
t.Fatalf("pageToken = %#v, want TOKEN_001", got)
}
}
func TestDocExportDryRunPassesWukongExportFormat(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocTestRoot(runner)
out, errOut, err := executeDocCommand(t, cmd,
"--dry-run",
"export",
"--node", "NODE_001",
"--output", "out.docx",
"--export-format", "docx",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.calls != 0 {
t.Fatalf("runner calls = %d, want 0 for dry-run", runner.calls)
}
var inv executor.Invocation
if err := json.Unmarshal([]byte(out), &inv); err != nil {
t.Fatalf("Unmarshal(%q) error = %v", out, err)
}
if inv.Tool != "submit_export_job" {
t.Fatalf("tool = %q, want submit_export_job", inv.Tool)
}
if got := inv.Params["exportFormat"]; got != "docx" {
t.Fatalf("exportFormat = %#v, want docx", got)
}
}
func TestDocUploadDryRunUsesWukongFileUploadWorkflow(t *testing.T) {
t.Parallel()
contentPath := filepath.Join(t.TempDir(), "report.pdf")
if err := os.WriteFile(contentPath, []byte("pdf"), 0600); err != nil {
t.Fatal(err)
}
runner := &docCommandRunner{}
cmd := newDocTestRoot(runner)
out, errOut, err := executeDocCommand(t, cmd,
"--dry-run",
"upload",
"--file", contentPath,
"--name", "Q1汇报",
"--folder", "FOLDER_001",
"--convert",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.calls != 0 {
t.Fatalf("runner calls = %d, want 0 for dry-run", runner.calls)
}
var payload map[string]any
if err := json.Unmarshal([]byte(out), &payload); err != nil {
t.Fatalf("Unmarshal(%q) error = %v", out, err)
}
step1, ok := payload["step_1_get_file_upload_info"].(map[string]any)
if !ok {
t.Fatalf("missing step_1_get_file_upload_info in %#v", payload)
}
if got := step1["tool"]; got != "get_file_upload_info" {
t.Fatalf("step1 tool = %#v, want get_file_upload_info", got)
}
step3, ok := payload["step_3_commit_uploaded_file"].(map[string]any)
if !ok {
t.Fatalf("missing step_3_commit_uploaded_file in %#v", payload)
}
params, ok := step3["params"].(map[string]any)
if !ok {
t.Fatalf("step3 params type = %T", step3["params"])
}
if got := params["name"]; got != "Q1汇报.pdf" {
t.Fatalf("name = %#v, want Q1汇报.pdf", got)
}
if got := params["folderId"]; got != "FOLDER_001" {
t.Fatalf("folderId = %#v, want FOLDER_001", got)
}
if got := params["convertToOnlineDoc"]; got != true {
t.Fatalf("convertToOnlineDoc = %#v, want true", got)
}
}
func TestDocCommentListAcceptsWukongPaginationAliases(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocCommentListCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, "--node", "NODE_001", "--limit", "20", "--cursor", "TOKEN_001")
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "list_comments" {
t.Fatalf("tool = %q, want list_comments", runner.last.Tool)
}
if got := runner.last.Params["pageSize"]; got != 20 {
t.Fatalf("pageSize = %#v, want 20", got)
}
if got := runner.last.Params["nextToken"]; got != "TOKEN_001" {
t.Fatalf("nextToken = %#v, want TOKEN_001", got)
}
}
func TestDocCommentReplyEmojiIsBoolFlag(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocCommentReplyCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "NODE_001",
"--comment-key", "COMMENT_KEY",
"--content", "比心",
"--emoji",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "reply_comment" {
t.Fatalf("tool = %q, want reply_comment", runner.last.Tool)
}
if got := runner.last.Params["emoji"]; got != true {
t.Fatalf("emoji = %#v, want true", got)
}
}
func TestDocCreateAcceptsParentFolderAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
}{
{
name: "parent folder id",
args: []string{"--name", "doc", "--parent-folder-id", "FOLDER_001", "--content", "hello"},
},
{
name: "parent folder",
args: []string{"--name", "doc", "--parent-folder", "FOLDER_001", "--content", "hello"},
},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocCreateCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, tc.args...)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "create_document" {
t.Fatalf("tool = %q, want create_document", runner.last.Tool)
}
if got := runner.last.Params["folderId"]; got != "FOLDER_001" {
t.Fatalf("folderId = %#v, want FOLDER_001", got)
}
})
}
}
func TestDocCreateAcceptsContentPathAlias(t *testing.T) {
t.Parallel()
contentPath := filepath.Join(t.TempDir(), "doc.md")
if err := os.WriteFile(contentPath, []byte("# from file"), 0600); err != nil {
t.Fatal(err)
}
runner := &docCommandRunner{}
cmd := newDocCreateCommand(runner)
_, errOut, err := executeDocCommand(t, cmd, "--name", "doc", "--content-path", contentPath)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "create_document" {
t.Fatalf("tool = %q, want create_document", runner.last.Tool)
}
if got := runner.last.Params["markdown"]; got != "# from file" {
t.Fatalf("markdown = %#v, want # from file", got)
}
}
func TestDocReadPassesJsonMLFormatAndOutput(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocReadCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "NODE_001",
"--content-format", "jsonml",
"--output", "body.json",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "get_document_content" {
t.Fatalf("tool = %q, want get_document_content", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
if got := runner.last.Params["__output__"]; got != "body.json" {
t.Fatalf("__output__ = %#v, want body.json", got)
}
}
func TestDocCreatePassesJsonMLContentAndFixFlag(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{responses: []map[string]any{{"nodeId": "NODE_NEW"}}}
cmd := newDocCreateCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--name", "doc",
"--content", `{"jsonml":[["p",{},"hello"]]}`,
"--content-format", "jsonml",
"--fix-jsonml",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.calls != 2 {
t.Fatalf("calls = %d, want 2", runner.calls)
}
if runner.all[0].Tool != "create_document" {
t.Fatalf("first tool = %q, want create_document", runner.all[0].Tool)
}
if runner.last.Tool != "update_document" {
t.Fatalf("last tool = %q, want update_document", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
jsonml, ok := runner.last.Params["jsonml"].(string)
if !ok || !strings.Contains(jsonml, `"root"`) || !strings.Contains(jsonml, `"hello"`) {
t.Fatalf("jsonml = %#v, want normalized root JSONML", runner.last.Params["jsonml"])
}
if _, ok := runner.last.Params["markdown"]; ok {
t.Fatalf("markdown = %#v, want omitted", runner.last.Params["markdown"])
}
if _, ok := runner.last.Params["fixJsonml"]; ok {
t.Fatalf("fixJsonml = %#v, want omitted", runner.last.Params["fixJsonml"])
}
}
func TestDocUpdatePassesJsonMLRevisionAndNoFixFlag(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocTestRoot(runner)
_, errOut, err := executeDocCommand(t, cmd,
"update",
"--node", "NODE_001",
"--content", `["root",{},["p",{},["span",{"data-type":"text"},["span",{"data-type":"leaf"},"updated"]]]]`,
"--content-format", "jsonml",
"--revision", "42",
"--no-fix-jsonml",
"--mode", "overwrite",
"--yes",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "update_document" {
t.Fatalf("tool = %q, want update_document", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
if got := runner.last.Params["revision"]; got != 42 {
t.Fatalf("revision = %#v, want 42", got)
}
if _, ok := runner.last.Params["noFixJsonml"]; ok {
t.Fatalf("noFixJsonml = %#v, want omitted", runner.last.Params["noFixJsonml"])
}
if _, ok := runner.last.Params["index"]; ok {
t.Fatalf("index = %#v, want omitted for JSONML update", runner.last.Params["index"])
}
}
func TestDocBlockListPassesJsonMLFormatAndBlockID(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockListCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--content-format", "jsonml",
"--block-id", "BLOCK_001",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "list_document_blocks" {
t.Fatalf("tool = %q, want list_document_blocks", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
if got := runner.last.Params["blockId"]; got != "BLOCK_001" {
t.Fatalf("blockId = %#v, want BLOCK_001", got)
}
}
func TestDocBlockInsertPassesJsonMLAndParentBlock(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockInsertCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--content-format", "jsonml",
"--element", `["p",{},"hello"]`,
"--parent-block", "PARENT_001",
"--index", "1",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "insert_document_block" {
t.Fatalf("tool = %q, want insert_document_block", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
jsonml, ok := runner.last.Params["jsonml"].(string)
if !ok || !strings.Contains(jsonml, `"span"`) || !strings.Contains(jsonml, `"hello"`) {
t.Fatalf("jsonml = %#v, want normalized JSONML node", runner.last.Params["jsonml"])
}
if got := runner.last.Params["referenceBlockId"]; got != "PARENT_001" {
t.Fatalf("referenceBlockId = %#v, want PARENT_001", got)
}
if got := runner.last.Params["index"]; got != 1 {
t.Fatalf("index = %#v, want 1", got)
}
if _, ok := runner.last.Params["element"]; ok {
t.Fatalf("element = %#v, want omitted", runner.last.Params["element"])
}
}
func TestDocBlockUpdatePassesJsonMLAndFixFlags(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockUpdateCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--block-id", "BLOCK_001",
"--content-format", "jsonml",
"--element", `["p",{},"new"]`,
"--fix-jsonml",
"--no-fix-jsonml",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "update_document_block" {
t.Fatalf("tool = %q, want update_document_block", runner.last.Tool)
}
if got := runner.last.Params["format"]; got != "jsonml" {
t.Fatalf("format = %#v, want jsonml", got)
}
if got := runner.last.Params["jsonml"]; got != `["p",{},"new"]` {
t.Fatalf("jsonml = %#v, want original node when --no-fix-jsonml wins", got)
}
if _, ok := runner.last.Params["fixJsonml"]; ok {
t.Fatalf("fixJsonml = %#v, want omitted", runner.last.Params["fixJsonml"])
}
if _, ok := runner.last.Params["noFixJsonml"]; ok {
t.Fatalf("noFixJsonml = %#v, want omitted", runner.last.Params["noFixJsonml"])
}
}
func TestDocBlockInsertTypeCallout(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockInsertCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--type", "callout",
"--text", "接口变更通知;DBA 审核;告警规则;安全评审",
"--where", "end",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
if runner.last.Tool != "insert_document_block" {
t.Fatalf("tool = %q, want insert_document_block", runner.last.Tool)
}
if _, ok := runner.last.Params["where"]; ok {
t.Fatalf("where = %#v, want omitted for --where end", runner.last.Params["where"])
}
element, ok := runner.last.Params["element"].(map[string]any)
if !ok {
t.Fatalf("element = %#v, want map", runner.last.Params["element"])
}
if got := element["blockType"]; got != "callout" {
t.Fatalf("blockType = %#v, want callout", got)
}
callout, ok := element["callout"].(map[string]any)
if !ok {
t.Fatalf("callout = %#v, want map", element["callout"])
}
if got := callout["text"]; got != "接口变更通知;DBA 审核;告警规则;安全评审" {
t.Fatalf("callout.text = %#v", got)
}
}
func TestDocBlockInsertTypeListAndColumns(t *testing.T) {
t.Parallel()
t.Run("ordered list", func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockInsertCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--type", "ordered-list",
"--list-id", "schedule",
"--text", "需求评审",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
element := runner.last.Params["element"].(map[string]any)
if got := element["blockType"]; got != "orderedList" {
t.Fatalf("blockType = %#v, want orderedList", got)
}
list := element["orderedList"].(map[string]any)["list"].(map[string]any)
if got := list["listId"]; got != "schedule" {
t.Fatalf("listId = %#v, want schedule", got)
}
})
t.Run("columns", func(t *testing.T) {
t.Parallel()
runner := &docCommandRunner{}
cmd := newDocBlockInsertCommand(runner)
_, errOut, err := executeDocCommand(t, cmd,
"--node", "DOC_001",
"--type", "columns",
"--columns", "2",
"--text", "方案A||方案B",
)
if err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut)
}
element := runner.last.Params["element"].(map[string]any)
if got := element["blockType"]; got != "columns" {
t.Fatalf("blockType = %#v, want columns", got)
}
columns := element["columns"].(map[string]any)
if got := columns["size"]; got != 2 {
t.Fatalf("columns.size = %#v, want 2", got)
}
children := element["children"].([]any)
if len(children) != 2 {
t.Fatalf("children len = %d, want 2", len(children))
}
})
}
@@ -0,0 +1,213 @@
package docjsonml
import (
"fmt"
"github.com/google/uuid"
)
// ──────────────────────────────────────────────────────────
// JSONML 轻量 Normalize / Auto-fix
//
// 目标:covering 80/20 of agent mistakes that the validator surfaces.
// 重型修复 (table/list 复杂结构) 由服务端 packSerializer.deserialize 兜底,
// 此处不复刻。
//
// 已实现的修复 (spec §3.4):
//
// 1. 单 block 作为 body 传入 → 包成 `[[block]]` 数组形态。
// 2. block 节点 attrs 缺 uuid → 注入随机 uuid。
// 3. text-bearing block (p, h1-h6) 子节点是裸字符串 →
// 包装成 `[span,{data-type:text},[span,{data-type:leaf},STR]]`。
//
// 未实现 / 故意不做:
//
// - 未知 tag 改写:可能误伤;validator 给最相似 tag 提示即可。
// - 必填属性默认值:当前没有合理可注入的默认值 (toc styles / container.subType
// / table.colsWidth 都需要业务判断)。
// - uuid 注入到「已显式给出空 attrs({})」的 block:视为生产者明确意图,
// 尊重之;只在 attrs 槽完全缺失(如 `["p", "text"]`)时才创建 attrs 并
// 注入 uuid。真实 `doc read` 输出中常见 `["h1", {}, ...]` 形态,注入会
// 污染 doc-read → doc-update 回灌。
//
// 关注点分离:
//
// 缺 root wrapper 的修整(["root", {}, ...])由 EnsureRootWrappedBody 在
// body 整体形态层面处理,不在本函数职责内 —— 这样 per-block 修复测试矩阵
// 不被协议层包装污染。
// ──────────────────────────────────────────────────────────
// NormalizeJsonMLBody returns a deep-cloned body with safe auto-fixes
// applied, plus human-readable notes describing every change.
//
// notes is empty when no fix was needed. fixed is the parsed JSON-friendly
// payload ready to be marshaled.
func NormalizeJsonMLBody(body []any) (fixed []any, notes []string) {
working, ok := deepCloneAny(body).([]any)
if !ok || len(working) == 0 {
return working, nil
}
var collected []string
// Fix #1 — single block passed as body.
// "root" is a structural wrapper (handled by the explicit branch below),
// not a single block to be wrapped — excluding it prevents double-wrap when
// the schema-driven validBlockTags set lists "root" alongside real blocks.
if tag, ok := working[0].(string); ok && tag != "root" && validBlockTags[tag] {
collected = append(collected,
fmt.Sprintf("$: wrap single %q block as body array", tag))
working = []any{working}
}
startIdx := 0
if tag, ok := working[0].(string); ok && tag == "root" {
// Root-wrapped: skip ["root", {attrs}] and recurse into children.
startIdx = 1
if len(working) > 1 {
if _, attrsOk := working[1].(map[string]any); attrsOk {
startIdx = 2
}
}
}
for i := startIdx; i < len(working); i++ {
fixedChild, childNotes := normalizeBlock(working[i], fmt.Sprintf("$[%d]", i))
working[i] = fixedChild
collected = append(collected, childNotes...)
}
return working, collected
}
// NormalizeJsonMLNode normalizes a single block node (used by
// `doc block insert/update --format jsonml --element <node>`).
func NormalizeJsonMLNode(node any) (fixed any, notes []string) {
cloned := deepCloneAny(node)
return normalizeBlock(cloned, "$")
}
// normalizeBlock applies fixes #2 and #3 in-place on a single block node.
// The caller is responsible for handing in a deep-cloned subtree.
func normalizeBlock(node any, path string) (any, []string) {
arr, ok := node.([]any)
if !ok || len(arr) == 0 {
return node, nil
}
tag, ok := arr[0].(string)
if !ok {
return arr, nil
}
var notes []string
// Fix #2 — inject uuid ONLY when attrs slot is completely missing.
//
// 设计:尊重生产者显式给出的 attrs 形态。
// - `["p", "text"]` → attrs 槽缺失,agent 漏写,补 attrs+uuid ✓
// - `["p", {}, ...]` → 已显式给出空 attrs,不动(真实 doc-read 输出常态)
// - `["p", {"jc":"left"}]` → attrs 存在但无 uuid,亦不补(生产者既然写了 attrs,应该自己负责 uuid)
// 这样保证 doc-read → doc-update roundtrip 不会污染原文档节点。
if validBlockTags[tag] && len(arr) > 1 {
if _, hadAttrs := arr[1].(map[string]any); !hadAttrs {
attrs := map[string]any{"uuid": newUUID()}
arr = append([]any{arr[0], attrs}, arr[1:]...)
notes = append(notes,
fmt.Sprintf("%s: insert attrs slot with generated uuid %q", path, attrs["uuid"]))
}
}
childStart := childStartIndex(arr)
// Fix #3 — text-bearing blocks: wrap raw-string children.
if isTextBearingBlock(tag) {
for i := childStart; i < len(arr); i++ {
if s, isString := arr[i].(string); isString {
wrapped := wrapTextLeaf(s)
arr[i] = wrapped
notes = append(notes,
fmt.Sprintf("%s[%d]: wrap raw string into span/text/leaf", path, i))
}
}
}
// Recurse into children that are themselves block nodes (container, refblock, table…)
for i := childStart; i < len(arr); i++ {
child, ok := arr[i].([]any)
if !ok {
continue
}
if len(child) == 0 {
continue
}
childTag, ok := child[0].(string)
if !ok {
continue
}
// Recurse into block children (container, refblock, table rows/cells —
// `tr`/`tc` are members of validBlockTags via the schema).
switch {
case validBlockTags[childTag]:
fixed, childNotes := normalizeBlock(child, fmt.Sprintf("%s[%d]", path, i))
arr[i] = fixed
notes = append(notes, childNotes...)
}
}
return arr, notes
}
// isTextBearingBlock returns true for block tags whose direct children are
// inline content (and where a bare string is fixable by span-wrapping).
//
// container/refblock/table take block children, not inline — bare strings
// there are a different kind of error and are NOT auto-wrapped.
func isTextBearingBlock(tag string) bool {
switch tag {
case "p", "h1", "h2", "h3", "h4", "h5", "h6":
return true
}
return false
}
// wrapTextLeaf builds the canonical text wrapper around a raw string.
//
// ["span",{"data-type":"text"},["span",{"data-type":"leaf"},"<s>"]]
func wrapTextLeaf(s string) []any {
return []any{
"span",
map[string]any{"data-type": "text"},
[]any{
"span",
map[string]any{"data-type": "leaf"},
s,
},
}
}
// newUUID returns a standard RFC 4122 v4 uuid string (e.g.
// "550e8400-e29b-41d4-a716-446655440000"). The server reassigns uuids on
// insert anyway; this exists only to satisfy validators and let agents
// track newly-inserted blocks before the server roundtrip.
func newUUID() string {
return uuid.NewString()
}
// deepCloneAny clones JSON-shaped values (map[string]any, []any, primitives).
// Required so normalize does not mutate caller-owned input.
func deepCloneAny(v any) any {
switch x := v.(type) {
case []any:
out := make([]any, len(x))
for i, e := range x {
out[i] = deepCloneAny(e)
}
return out
case map[string]any:
out := make(map[string]any, len(x))
for k, val := range x {
out[k] = deepCloneAny(val)
}
return out
default:
return v
}
}
@@ -0,0 +1,44 @@
package docjsonml
// ──────────────────────────────────────────────────────────
// JSONML body root wrapping (protocol-level coercion)
//
// 服务端 writeAsJsonML 路径要求 body 形态为
//
// ["root", {attrs?}, ...blockNodes]
//
// 即「单棵以 root 为顶点的树」。早先 dws-wukong 文档/校验器注释里曾声称「裸
// block 数组也是服务端可接受的形态」,但 cross-stack 验证(we-word-open-api
// jsonmlNodes.ts 的 getChildStart 启发式 + packSerializer.deserialize 反向
// 期望)确认:bare-array 形态会触发节点静默丢失或反序列化失败。
//
// 本函数仅做最薄的协议层修整,与 NormalizeJsonMLBody 关注点分离:
//
// NormalizeJsonMLBody — 单 block 内部修复(uuid 注入、文本包裹、…)
// EnsureRootWrappedBody — body 整体形态修整(缺 root 时补包裹)
//
// 这样既保留 normalize 测试矩阵(仍以 [block, ...] 形态作为基线),又能保证
// 落地协议层符合服务端约束。
// ──────────────────────────────────────────────────────────
// EnsureRootWrappedBody returns body wrapped as ["root", {}, ...body] when
// the input is not already root-rooted. Returns the input unchanged when:
//
// - body is empty
// - body[0] is the literal string "root"
//
// notes is non-empty only when wrapping was applied.
//
// The function does not mutate its input.
func EnsureRootWrappedBody(body []any) (wrapped []any, notes []string) {
if len(body) == 0 {
return body, nil
}
if tag, ok := body[0].(string); ok && tag == "root" {
return body, nil
}
out := make([]any, 0, len(body)+2)
out = append(out, "root", map[string]any{})
out = append(out, body...)
return out, []string{`$: wrap bare body with ["root", {}, ...] to satisfy server writeAsJsonML contract`}
}
@@ -0,0 +1,99 @@
package docjsonml
import (
_ "embed"
"encoding/json"
"fmt"
)
//go:embed jsonml-schema-v2.json
var jsonmlSchemaV2Raw []byte
// TypeSpec represents a type constraint for an attribute value.
// Parsed from the schema JSON's unified object format: { "type": "...", ... }
type TypeSpec struct {
Type string `json:"type"` // string|number|boolean|array|object|any|enum|union
Min *float64 `json:"min,omitempty"` // for number
Max *float64 `json:"max,omitempty"` // for number
Values []string `json:"values,omitempty"` // for enum
Types []string `json:"types,omitempty"` // for union: pass silently
WarnTypes []string `json:"warn_types,omitempty"` // for union: match → warning (not error)
Fields map[string]TypeSpec `json:"fields,omitempty"` // for object (deep validation)
}
// TagSchema defines the schema for a single JSONML tag.
type TagSchema struct {
AllowedChildren []string `json:"allowed_children"`
Attrs map[string]TypeSpec `json:"attrs"`
allowedChildrenSet map[string]bool // precomputed
}
// SchemaV2 is the top-level schema structure.
type SchemaV2 struct {
Version string `json:"_version"`
Description string `json:"_description"`
Tags map[string]*TagSchema `json:"tags"`
knownTags map[string]bool // precomputed: all tag names
}
// IsKnownTag returns true if the tag is declared in the schema.
func (s *SchemaV2) IsKnownTag(tag string) bool {
return s.knownTags[tag]
}
// TagSchemaFor returns the schema for a tag, or nil if unknown.
func (s *SchemaV2) TagSchemaFor(tag string) *TagSchema {
return s.Tags[tag]
}
// IsAllowedChild returns true if childTag is in the parent's allowed_children.
func (ts *TagSchema) IsAllowedChild(childTag string) bool {
return ts.allowedChildrenSet[childTag]
}
func mustLoadSchemaV2(raw []byte) *SchemaV2 {
var s SchemaV2
if err := json.Unmarshal(raw, &s); err != nil {
panic(fmt.Sprintf("jsonml-schema-v2.json parse failed: %v", err))
}
if len(s.Tags) == 0 {
panic("jsonml-schema-v2.json: tags must be non-empty")
}
// Precompute sets
s.knownTags = make(map[string]bool, len(s.Tags))
for name, ts := range s.Tags {
s.knownTags[name] = true
ts.allowedChildrenSet = make(map[string]bool, len(ts.AllowedChildren))
for _, c := range ts.AllowedChildren {
ts.allowedChildrenSet[c] = true
}
}
return &s
}
var schemaV2 = mustLoadSchemaV2(jsonmlSchemaV2Raw)
// validBlockTags is a set of block-level tags derived from the v2 schema.
// Inline tags (span, text, leaf) are excluded since they appear as children
// inside block nodes, not at body level.
var validBlockTags = func() map[string]bool {
inline := map[string]bool{"span": true, "text": true, "leaf": true}
m := make(map[string]bool)
for tag := range schemaV2.Tags {
if !inline[tag] {
m[tag] = true
}
}
return m
}()
// childStartIndex returns the index of the first child element in a JSONML
// node array, skipping the tag string and optional attrs object.
func childStartIndex(arr []any) int {
if len(arr) > 1 {
if _, ok := arr[1].(map[string]any); ok {
return 2
}
}
return 1
}
@@ -0,0 +1,309 @@
package docjsonml
import (
"fmt"
"strings"
)
// JsonMLValidationResult holds errors and warnings from validation.
type JsonMLValidationResult struct {
Errors []string
Warnings []string
}
// HasErrors returns true if there are blocking errors.
func (r *JsonMLValidationResult) HasErrors() bool {
return len(r.Errors) > 0
}
// Summary returns a human-readable report.
func (r *JsonMLValidationResult) Summary() string {
if !r.HasErrors() && len(r.Warnings) == 0 {
return ""
}
var sb strings.Builder
if len(r.Errors) > 0 {
sb.WriteString(fmt.Sprintf("JSONML 校验失败(%d 个错误):\n", len(r.Errors)))
for i, e := range r.Errors {
sb.WriteString(fmt.Sprintf(" %d. %s\n", i+1, e))
}
}
if len(r.Warnings) > 0 {
sb.WriteString(fmt.Sprintf("JSONML 校验警告(%d 个):\n", len(r.Warnings)))
for i, w := range r.Warnings {
sb.WriteString(fmt.Sprintf(" %d. %s\n", i+1, w))
}
}
return sb.String()
}
func (r *JsonMLValidationResult) addError(path, issue, suggestion string) {
r.Errors = append(r.Errors, formatDiag(path, issue, suggestion))
}
func (r *JsonMLValidationResult) addWarn(path, issue, suggestion string) {
r.Warnings = append(r.Warnings, formatDiag(path, issue, suggestion))
}
func formatDiag(path, issue, suggestion string) string {
issue = strings.TrimRight(issue, ".")
if suggestion == "" {
return fmt.Sprintf("%s: %s.", path, issue)
}
return fmt.Sprintf("%s: %s. Suggestion: %s", path, issue, suggestion)
}
// ValidateJsonMLBodyV2 validates a JSONML body using schema-v2.
// Only type mismatches are errors; everything else is a warning.
func ValidateJsonMLBodyV2(body []any) *JsonMLValidationResult {
r := &JsonMLValidationResult{}
if len(body) == 0 {
return r
}
// Root-wrapped: ["root", {attrs}, ...blocks]
if tag, ok := body[0].(string); ok && tag == "root" {
validateNodeV2(body, "$", nil, r)
return r
}
// Single block node
if tag, ok := body[0].(string); ok && schemaV2.IsKnownTag(tag) {
validateNodeV2(body, "$", nil, r)
return r
}
// Array of blocks
for i, node := range body {
nodePath := fmt.Sprintf("$[%d]", i)
if arr, ok := node.([]any); ok && len(arr) > 0 {
if t, ok := arr[0].(string); ok {
nodePath = fmt.Sprintf("$[%d:%s]", i, t)
}
}
validateNodeV2(node, nodePath, nil, r)
}
return r
}
// ValidateJsonMLNodeV2 validates a single JSONML node using schema-v2.
func ValidateJsonMLNodeV2(node any) *JsonMLValidationResult {
r := &JsonMLValidationResult{}
validateNodeV2(node, "$", nil, r)
return r
}
func validateNodeV2(node any, path string, parentSchema *TagSchema, r *JsonMLValidationResult) {
arr, ok := node.([]any)
if !ok {
r.addError(path, fmt.Sprintf("node must be array, got %T", node), "")
return
}
if len(arr) < 1 {
r.addError(path, "node array must not be empty", "")
return
}
tag, ok := arr[0].(string)
if !ok {
r.addError(path, fmt.Sprintf("tag must be string, got %T", arr[0]), "")
return
}
// Check if child is allowed by parent
if parentSchema != nil && !parentSchema.IsAllowedChild(tag) {
r.addWarn(path,
fmt.Sprintf("tag %q not in parent's allowed_children", tag), "")
}
tagSchema := schemaV2.TagSchemaFor(tag)
if tagSchema == nil {
r.addWarn(path, fmt.Sprintf("unknown tag %q", tag), "")
return
}
// Extract attrs
childStart := 1
var attrs map[string]any
if len(arr) > 1 {
if m, ok := arr[1].(map[string]any); ok {
attrs = m
childStart = 2
}
}
// Validate attrs
for key, val := range attrs {
spec, known := tagSchema.Attrs[key]
if !known {
r.addWarn(path+".attrs."+key,
fmt.Sprintf("unknown attr %q", key), "")
continue
}
checkTypeV2(val, &spec, path+".attrs."+key, r)
}
// Validate children
for i := childStart; i < len(arr); i++ {
child := arr[i]
childPath := fmt.Sprintf("%s[%d]", path, i)
switch c := child.(type) {
case string:
if !tagSchema.IsAllowedChild("#text") {
r.addWarn(childPath,
fmt.Sprintf("bare text not allowed in %q", tag), "")
}
_ = c
case []any:
if len(c) > 0 {
if childTag, ok := c[0].(string); ok {
childPath = fmt.Sprintf("%s[%d:%s]", path, i, childTag)
}
}
validateNodeV2(child, childPath, tagSchema, r)
default:
// null, number etc — skip
}
}
}
// checkTypeV2 validates a value against a TypeSpec.
// Type mismatches → error. Enum mismatches → warning.
func checkTypeV2(value any, spec *TypeSpec, path string, r *JsonMLValidationResult) {
switch spec.Type {
case "any":
return
case "string":
if _, ok := value.(string); !ok {
r.addError(path,
fmt.Sprintf("expected string, got %T", value), "")
}
case "number":
num, ok := toFloat64(value)
if !ok {
r.addError(path,
fmt.Sprintf("expected number, got %T", value), "")
return
}
if spec.Min != nil && num < *spec.Min {
r.addError(path,
fmt.Sprintf("value %v < min %v", num, *spec.Min), "")
}
if spec.Max != nil && num > *spec.Max {
r.addError(path,
fmt.Sprintf("value %v > max %v", num, *spec.Max), "")
}
case "boolean":
if _, ok := value.(bool); !ok {
r.addError(path,
fmt.Sprintf("expected boolean, got %T", value), "")
}
case "array":
if _, ok := value.([]any); !ok {
r.addError(path,
fmt.Sprintf("expected array, got %T", value), "")
}
case "object":
obj, ok := value.(map[string]any)
if !ok {
r.addError(path,
fmt.Sprintf("expected object, got %T", value), "")
return
}
// Deep validation if fields defined
if spec.Fields != nil {
for key, val := range obj {
fieldSpec, known := spec.Fields[key]
if !known {
r.addWarn(path+"."+key,
fmt.Sprintf("unknown field %q", key), "")
continue
}
checkTypeV2(val, &fieldSpec, path+"."+key, r)
}
}
case "enum":
str, ok := value.(string)
if !ok {
r.addError(path,
fmt.Sprintf("enum expects string, got %T", value), "")
return
}
found := false
for _, v := range spec.Values {
if v == str {
found = true
break
}
}
if !found {
r.addWarn(path,
fmt.Sprintf("value %q not in enum [%s]", str, strings.Join(spec.Values, ", ")), "")
}
case "union":
if matchesUnion(value, spec.Types) {
return
}
if len(spec.WarnTypes) > 0 && matchesUnion(value, spec.WarnTypes) {
r.addWarn(path,
fmt.Sprintf("value (%T) matches warn_types [%s], expected [%s]", value, strings.Join(spec.WarnTypes, ", "), strings.Join(spec.Types, ", ")), "")
return
}
r.addError(path,
fmt.Sprintf("value (%T) doesn't match any of [%s]", value, strings.Join(spec.Types, ", ")), "")
}
}
func matchesUnion(value any, types []string) bool {
for _, t := range types {
switch t {
case "string":
if _, ok := value.(string); ok {
return true
}
case "number":
if _, ok := toFloat64(value); ok {
return true
}
case "boolean":
if _, ok := value.(bool); ok {
return true
}
case "array":
if _, ok := value.([]any); ok {
return true
}
case "object":
if _, ok := value.(map[string]any); ok {
return true
}
case "null":
if value == nil {
return true
}
case "any":
return true
}
}
return false
}
func toFloat64(v any) (float64, bool) {
switch n := v.(type) {
case float64:
return n, true
case int:
return float64(n), true
case int64:
return float64(n), true
default:
return 0, false
}
}
File diff suppressed because it is too large Load Diff
+959
View File
@@ -0,0 +1,959 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"context"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path/filepath"
"strings"
"time"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cobracmd"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
func init() {
RegisterPublic(func() Handler {
return driveHandler{}
})
}
// driveHandler exposes the drive command surface that the service-discovery
// envelope may not express consistently in older/pre caches:
//
// - upload — three-step composite: drive.get_upload_info → HTTP PUT to OSS →
// drive.commit_upload. The envelope PipelineStep schema currently supports
// type:"call" (MCP tool invocation) and type:"download" (HTTP GET sink),
// but has no type:"upload" for streaming a local file to an OSS-signed
// PUT URL with per-URL headers. Until the envelope schema grows that
// capability, this helper is the canonical client-side glue.
//
// For the remaining leaves the helper keeps the same command names as the
// dynamic envelope, but sets a higher override priority so the local binary can
// provide stable validation and aliases without depending on shared config
// rollout timing.
type driveHandler struct{}
func (driveHandler) Name() string {
return "drive"
}
func (driveHandler) Command(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "drive",
Short: "钉盘文件管理",
Long: `钉盘:列出文件/文件夹、获取元数据、下载链接、创建文件夹、获取上传信息、提交上传。`,
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
preferLegacyLeaf(root)
root.AddCommand(
newDriveListCommand(runner),
newDriveListSpacesCommand(runner),
newDriveInfoCommand(runner),
newDriveDownloadCommand(runner),
newDriveMkdirCommand(runner),
newDriveUploadInfoCommand(runner),
newDriveCommitCommand(runner),
newDriveUploadCommand(runner),
newDriveDeleteCommand(runner),
)
return root
}
// ── dynamic-compatible leaves ──────────────────────────────
func newDriveListCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: "获取文件/文件夹列表",
Example: ` dws drive list --limit 20
dws drive list --limit 20 --folder <dentryUuid> --order-by name --order asc`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
maxResults := driveIntFlagOrFallback(cmd, "limit", "max", "page-size")
if maxResults <= 0 {
maxResults = 20
}
params := map[string]any{"maxResults": float64(maxResults)}
addDriveStringParam(cmd, params, "spaceId", "space-id")
if parentID := driveFlagOrFallback(cmd, "folder", "parent-id"); parentID != "" {
if err := validateDriveParentID(parentID); err != nil {
return err
}
params["parentId"] = parentID
}
addDriveStringParam(cmd, params, "nextToken", "cursor", "next-token")
addDriveStringParam(cmd, params, "orderBy", "order-by")
addDriveStringParam(cmd, params, "order", "order")
if thumbnail, _ := cmd.Flags().GetBool("thumbnail"); thumbnail {
params["withThumbnail"] = true
}
return runDriveInvocation(cmd, runner, "drive", "list_files", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().Int("limit", 20, "每页返回数量,默认 20,最大 100 (可选)")
cmd.Flags().Int("max", 0, "--limit 的别名(向后兼容)")
_ = cmd.Flags().MarkHidden("max")
cmd.Flags().Int("page-size", 0, "--limit 的兼容别名")
_ = cmd.Flags().MarkHidden("page-size")
cmd.Flags().String("space-id", "", "空间 ID,不传则使用「我的文件」对应 spaceId (可选)")
cmd.Flags().String("folder", "", "父节点 ID (dentryUuid),不传则列出空间根目录 (可选)")
addDriveHiddenStringFlag(cmd, "parent-id", "--folder 的兼容别名")
cmd.Flags().String("cursor", "", "分页游标,首次不传 (可选)")
addDriveHiddenStringFlag(cmd, "next-token", "--cursor 的兼容别名")
cmd.Flags().String("order-by", "", "排序字段: createTime|modifyTime|name (可选)")
cmd.Flags().String("order", "", "排序方向: asc|desc,默认 desc (可选)")
cmd.Flags().Bool("thumbnail", false, "是否返回缩略图信息 (可选)")
return cmd
}
func newDriveListSpacesCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list-spaces",
Short: "获取钉盘空间列表",
Long: `列出当前用户可访问的钉盘空间,返回 spaceId、spaceName、rootFolderId 等信息。
spaceType 筛选规则:
orgSpace(默认): 返回企业空间列表,支持 nextToken 分页
mySpace: 返回用户的"我的文件"个人空间(单个)`,
Example: ` dws drive list-spaces
dws drive list-spaces --space-type mySpace
dws drive list-spaces --space-type orgSpace --limit 20 --cursor <TOKEN>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
params := map[string]any{}
maxResults, _ := cmd.Flags().GetInt("limit")
if !cmd.Flags().Changed("limit") {
if limit, _ := cmd.Flags().GetInt("max"); limit > 0 {
maxResults = limit
}
}
if maxResults > 0 {
params["maxResults"] = float64(maxResults)
}
addDriveStringParam(cmd, params, "spaceType", "space-type")
addDriveStringParam(cmd, params, "nextToken", "cursor", "next-token")
return runDriveInvocation(cmd, runner, "drive", "list_spaces", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().Int("limit", 20, "每页返回数量 (默认 20,最大 50),仅 spaceType 为 orgSpace 时有效")
cmd.Flags().Int("max", 0, "--limit 的兼容别名")
_ = cmd.Flags().MarkHidden("max")
cmd.Flags().String("space-type", "", "空间类型: orgSpace=企业空间(默认), mySpace=我的文件 (可选)")
cmd.Flags().String("cursor", "", "分页游标,仅企业空间支持分页 (可选)")
addDriveHiddenStringFlag(cmd, "next-token", "--cursor 的兼容别名")
return cmd
}
func newDriveInfoCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "info",
Short: "获取文件元数据信息",
Long: `获取钉盘文件/文件夹的元数据信息。
如果目标文件属于钉钉文档(在线文档/表格/脑图等),会自动跟进调用
钉钉文档接口获取更准确的文档信息(如真实文档名称),并合并输出。`,
Example: ` dws drive info --node <dentryUuid> # 查询 fileId: dws drive list`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
fileID, err := driveRequiredFlagOrFallback(cmd, "node", "file-id")
if err != nil {
return err
}
params := map[string]any{"fileId": fileID}
addDriveStringParam(cmd, params, "spaceId", "space-id")
return runDriveInfo(cmd, runner, params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("node", "", "节点 ID (dentryUuid) (必填)")
addDriveHiddenStringFlag(cmd, "file-id", "--node 的兼容别名")
cmd.Flags().String("space-id", "", "节点所属空间 ID (可选)")
return cmd
}
func newDriveDownloadCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "download",
Short: "下载钉盘文件到本地",
Long: `下载钉盘中的文件到本地(两步下载流程)。
流程:
1. 获取下载 URL 和签名请求头 (download_file)
2. HTTP GET 下载文件二进制内容到本地
--output 指定本地保存路径,可以是文件路径或目录。
如果指定目录,文件名从下载 URL 中自动推断。`,
Example: ` dws drive download --node <dentryUuid> --output ./report.pdf
dws drive download --node <dentryUuid> --output ~/downloads/`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return runDriveDownload(cmd, runner)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("node", "", "文件 ID (dentryUuid) (必填)")
addDriveHiddenStringFlag(cmd, "file-id", "--node 的兼容别名")
cmd.Flags().String("space-id", "", "文件所属空间 ID (可选)")
cmd.Flags().String("output", "", "本地保存路径 (文件路径或目录,必填)")
return cmd
}
func newDriveMkdirCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "mkdir",
Short: "创建文件夹",
Example: ` dws drive mkdir --name "项目资料"
dws drive mkdir --name "子目录" --folder <dentryUuid>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
name, err := driveRequiredFlag(cmd, "name")
if err != nil {
return err
}
params := map[string]any{"name": name}
addDriveStringParam(cmd, params, "spaceId", "space-id")
if parentID := driveFlagOrFallback(cmd, "folder", "parent-id"); parentID != "" {
if err := validateDriveParentID(parentID); err != nil {
return err
}
params["parentId"] = parentID
}
return runDriveInvocation(cmd, runner, "drive", "create_folder", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("name", "", "文件夹名称,最长 50 字符 (必填)")
cmd.Flags().String("space-id", "", "目标空间 ID,不传则使用「我的文件」 (可选)")
cmd.Flags().String("folder", "", "父节点 ID (dentryUuid),不传则在空间根目录下创建 (可选)")
addDriveHiddenStringFlag(cmd, "parent-id", "--folder 的兼容别名")
return cmd
}
func newDriveUploadInfoCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "upload-info",
Short: "获取文件上传信息",
Example: ` dws drive upload-info --file-name "报告.pdf" --file-size 102400
dws drive upload-info --file-name "readme.txt" --file-size 1024 --folder <dentryUuid>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
fileName, err := driveRequiredFlag(cmd, "file-name")
if err != nil {
return err
}
fileSize, _ := cmd.Flags().GetInt64("file-size")
if fileSize <= 0 {
return apperrors.NewValidation("--file-size is required and must be a positive integer")
}
params := map[string]any{
"fileName": fileName,
"fileSize": float64(fileSize),
}
addDriveStringParam(cmd, params, "spaceId", "space-id")
addDriveStringParam(cmd, params, "mimeType", "mime-type")
if parentID := driveFlagOrFallback(cmd, "folder", "parent-id"); parentID != "" {
if err := validateDriveParentID(parentID); err != nil {
return err
}
params["parentId"] = parentID
}
return runDriveInvocation(cmd, runner, "drive", "get_upload_info", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("file-name", "", "文件名,须包含扩展名,如 报告.pdf (必填)")
cmd.Flags().Int64("file-size", 0, "文件大小(字节)(必填)")
_ = cmd.MarkFlagRequired("file-size")
cmd.Flags().String("space-id", "", "目标空间 ID,不传则使用「我的文件」 (可选)")
cmd.Flags().String("mime-type", "", "文件 MIME 类型,如 application/pdf,不传则自动推断 (可选)")
cmd.Flags().String("folder", "", "父节点 ID (dentryUuid),不传则上传到空间根目录 (可选)")
addDriveHiddenStringFlag(cmd, "parent-id", "--folder 的兼容别名")
return cmd
}
func newDriveCommitCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "commit",
Short: "提交文件上传",
Example: ` dws drive commit --file-name "报告.pdf" --file-size 102400 --upload-id <uploadId>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
fileName, err := driveRequiredFlag(cmd, "file-name")
if err != nil {
return err
}
uploadID, err := driveRequiredFlag(cmd, "upload-id")
if err != nil {
return err
}
fileSize, _ := cmd.Flags().GetInt64("file-size")
if fileSize <= 0 {
return apperrors.NewValidation("--file-size is required and must be a positive integer")
}
params := map[string]any{
"fileName": fileName,
"fileSize": float64(fileSize),
"uploadId": uploadID,
}
addDriveStringParam(cmd, params, "spaceId", "space-id")
if parentID := driveFlagOrFallback(cmd, "folder", "parent-id"); parentID != "" {
if err := validateDriveParentID(parentID); err != nil {
return err
}
params["parentId"] = parentID
}
return runDriveInvocation(cmd, runner, "drive", "commit_upload", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("file-name", "", "文件名(含扩展名),须与 get_upload_info 时一致 (必填)")
cmd.Flags().Int64("file-size", 0, "文件大小(字节),须与 get_upload_info 时一致 (必填)")
_ = cmd.MarkFlagRequired("file-size")
cmd.Flags().String("upload-id", "", "上传 ID,来自 get_upload_info 返回的 uploadId (必填)")
cmd.Flags().String("space-id", "", "空间 ID,不传则使用「我的文件」 (可选)")
cmd.Flags().String("folder", "", "父节点 ID (dentryUuid),不传则提交到根目录 (可选)")
addDriveHiddenStringFlag(cmd, "parent-id", "--folder 的兼容别名")
return cmd
}
// ── upload (three-step composite) ───────────────────────────
func newDriveUploadCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "upload",
Short: "上传本地文件到钉盘",
Long: `将本地文件上传到钉盘(三步自动完成)。
流程:
1. 获取 OSS 上传凭证 (get_upload_info)
2. HTTP PUT 上传文件二进制到 OSS
3. 提交文件入库 (commit_upload)
上传位置: --folder 指定父目录,不传则上传到空间根目录。`,
Example: ` dws drive upload --file ./report.pdf
dws drive upload --file ./slides.pptx --file-name "Q1汇报.pptx"
dws drive upload --file ./data.xlsx --folder <dentryUuid>`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return runDriveUpload(cmd, runner)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("file", "", "本地文件路径 (必填)")
cmd.Flags().String("file-name", "", "文件显示名称 (默认使用文件名)")
addDriveHiddenStringFlag(cmd, "name", "--file-name 的兼容别名")
cmd.Flags().String("space-id", "", "目标空间 ID,不传则使用「我的文件」 (可选)")
cmd.Flags().String("mime-type", "", "文件 MIME 类型,不传则自动推断 (可选)")
cmd.Flags().String("folder", "", "父节点 ID (dentryUuid),不传则上传到空间根目录 (可选)")
addDriveHiddenStringFlag(cmd, "parent-id", "--folder 的兼容别名")
return cmd
}
func runDriveUpload(cmd *cobra.Command, runner executor.Runner) error {
filePath, _ := cmd.Flags().GetString("file")
if strings.TrimSpace(filePath) == "" {
return apperrors.NewValidation("--file is required")
}
absPath, err := filepath.Abs(filePath)
if err != nil {
return apperrors.NewValidation("无法解析文件路径: " + err.Error())
}
fi, err := os.Stat(absPath)
if err != nil {
return apperrors.NewValidation("文件不存在或无法读取: " + absPath)
}
if fi.IsDir() {
return apperrors.NewValidation("--file 不能是目录: " + absPath)
}
fileSize := fi.Size()
if fileSize <= 0 {
return apperrors.NewValidation("文件为空")
}
fileName := driveFlagOrFallback(cmd, "file-name", "name")
if strings.TrimSpace(fileName) == "" {
fileName = filepath.Base(absPath)
}
spaceID, _ := cmd.Flags().GetString("space-id")
mimeType, _ := cmd.Flags().GetString("mime-type")
if strings.TrimSpace(mimeType) == "" {
mimeType = detectMIME(fileName)
}
parentID := driveFlagOrFallback(cmd, "folder", "parent-id")
if err := validateDriveParentID(parentID); err != nil {
return err
}
// Step 1 params
step1Params := map[string]any{
"fileName": fileName,
"fileSize": float64(fileSize),
}
if strings.TrimSpace(spaceID) != "" {
step1Params["spaceId"] = spaceID
}
if strings.TrimSpace(mimeType) != "" {
step1Params["mimeType"] = mimeType
}
if strings.TrimSpace(parentID) != "" {
step1Params["parentId"] = parentID
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, map[string]any{
"dry_run": true,
"step_1_get_upload_info": executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "drive", "get_upload_info", step1Params,
),
"step_2_http_put_oss": "PUT file bytes to resourceUrls[0].url with returned headers",
"step_3_commit_upload": "drive commit_upload with uploadId from step 1",
"file": absPath,
"size": fileSize,
"name": fileName,
})
}
// Step 1: get_upload_info
fmt.Fprintf(os.Stderr, "[1/3] 获取上传凭证 %s (%d 字节, %s)...\n", fileName, fileSize, mimeType)
step1 := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "drive", "get_upload_info", step1Params,
)
step1Result, err := runner.Run(cmd.Context(), step1)
if err != nil {
return fmt.Errorf("获取上传凭证失败: %w", err)
}
resourceURL, uploadID, ossHeaders, err := parseDriveUploadInfo(step1Result.Response)
if err != nil {
return err
}
// Step 2: HTTP PUT to OSS
fmt.Fprintln(os.Stderr, "[2/3] 上传文件到 OSS...")
if err := httpPutDriveFile(cmd.Context(), resourceURL, ossHeaders, absPath, fileSize); err != nil {
return err
}
// Step 3: commit_upload
fmt.Fprintln(os.Stderr, "[3/3] 提交文件入库...")
step3Params := map[string]any{
"fileName": fileName,
"fileSize": float64(fileSize),
"uploadId": uploadID,
}
if strings.TrimSpace(spaceID) != "" {
step3Params["spaceId"] = spaceID
}
if strings.TrimSpace(parentID) != "" {
step3Params["parentId"] = parentID
}
step3 := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "drive", "commit_upload", step3Params,
)
result, err := runner.Run(cmd.Context(), step3)
if err != nil {
return fmt.Errorf("提交文件入库失败: %w", err)
}
return writeCommandPayload(cmd, result)
}
// ── delete (drive surface routed to doc MCP server) ────────
func newDriveDeleteCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "delete",
Short: "删除文件/文件夹到回收站",
Long: `将钉盘中的文件或文件夹移入回收站。
注意: 这是一个危险操作,文件将被移入回收站。执行前需要确认,或传入 --yes 跳过确认。
--node 对应 drive list 返回的 fileId 字段(即 dentryUuid)。
权限要求: 对文档有"管理"权限。`,
Example: ` dws drive delete --node <dentryUuid> --yes # 查询 fileId: dws drive list
dws drive delete --node <dentryUuid> # 交互式确认后删除`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
fileID, err := driveRequiredFlagOrFallback(cmd, "node", "file-id")
if err != nil {
return err
}
if !confirmDeletePrompt(cmd, "钉盘节点", fileID) {
return nil
}
params := map[string]any{"nodeId": fileID}
return runDriveInvocation(cmd, runner, "doc", "delete_document", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("node", "", "文件/文件夹 ID (dentryUuid),即 drive list 返回的 fileId (必填)")
addDriveHiddenStringFlag(cmd, "file-id", "--node 的兼容别名")
cmd.Flags().BoolP("yes", "y", false, "跳过确认直接删除")
return cmd
}
func runDriveInfo(cmd *cobra.Command, runner executor.Runner, params map[string]any) error {
result, err := driveInvocationResult(cmd, runner, "drive", "get_file_info", params)
if err != nil {
return err
}
content := driveResultContent(result)
driveResult := driveInnerResult(content)
if !isDriveDingTalkDocResult(driveResult) {
return writeCommandPayload(cmd, result)
}
nodeID := driveStringFromMap(driveResult, "fileId")
if nodeID == "" {
nodeID, _ = params["fileId"].(string)
}
docResult, err := driveInvocationResult(cmd, runner, "doc", "get_document_info", map[string]any{"nodeId": nodeID})
if err != nil {
return writeCommandPayload(cmd, result)
}
docContent := driveResultContent(docResult)
innerDoc := driveInnerResult(docContent)
if len(innerDoc) == 0 {
return writeCommandPayload(cmd, result)
}
for _, field := range []string{"dentryId", "path", "fileSize", "extension", "type", "fileId"} {
if value, ok := driveResult[field]; ok {
if _, exists := innerDoc[field]; !exists {
innerDoc[field] = value
}
}
}
if _, hasWrapper := docContent["result"]; hasWrapper {
docContent["result"] = innerDoc
return writeCommandPayload(cmd, docContent)
}
return writeCommandPayload(cmd, map[string]any{"success": true, "result": innerDoc})
}
func runDriveDownload(cmd *cobra.Command, runner executor.Runner) error {
fileID, err := driveRequiredFlagOrFallback(cmd, "node", "file-id")
if err != nil {
return err
}
outputPath, err := driveRequiredFlag(cmd, "output")
if err != nil {
return err
}
params := map[string]any{"fileId": fileID}
addDriveStringParam(cmd, params, "spaceId", "space-id")
if commandDryRun(cmd) {
return writeCommandPayload(cmd, map[string]any{
"dry_run": true,
"step_1_download_file": executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "drive", "download_file", params,
),
"step_2_http_get": "GET file bytes from returned downloadUrl/resourceUrl",
"output": outputPath,
})
}
result, err := driveInvocationResult(cmd, runner, "drive", "download_file", params)
if err != nil {
return err
}
resourceURL, serverFilename, headers, err := parseDriveDownloadInfo(driveResultContent(result))
if err != nil {
return err
}
if info, statErr := os.Stat(outputPath); statErr == nil && info.IsDir() {
outputPath = filepath.Join(outputPath, driveDownloadFilename(serverFilename, resourceURL))
}
if err := httpGetDriveFile(cmd.Context(), resourceURL, headers, outputPath); err != nil {
return err
}
return writeCommandPayload(cmd, map[string]any{
"success": true,
"downloadUrl": resourceURL,
"output": outputPath,
})
}
func runDriveInvocation(cmd *cobra.Command, runner executor.Runner, product, tool string, params map[string]any) error {
result, err := driveInvocationResult(cmd, runner, product, tool, params)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
func driveInvocationResult(cmd *cobra.Command, runner executor.Runner, product, tool string, params map[string]any) (executor.Result, error) {
invocation := executor.NewHelperInvocation(cobracmd.LegacyCommandPath(cmd), product, tool, params)
invocation.DryRun = commandDryRun(cmd)
return runner.Run(cmd.Context(), invocation)
}
func driveResultContent(result executor.Result) map[string]any {
if content, ok := result.Response["content"].(map[string]any); ok {
return content
}
if len(result.Response) > 0 {
return result.Response
}
return map[string]any{}
}
func driveInnerResult(content map[string]any) map[string]any {
if content == nil {
return map[string]any{}
}
if result, ok := content["result"].(map[string]any); ok {
return result
}
return content
}
func isDriveDingTalkDocResult(result map[string]any) bool {
if len(result) == 0 {
return false
}
extension := strings.ToLower(driveStringFromMap(result, "extension"))
switch extension {
case "adoc", "axls", "amind", "adraw":
return true
}
return strings.Contains(driveStringFromMap(result, "message"), "钉钉文档")
}
func parseDriveDownloadInfo(content map[string]any) (resourceURL string, filename string, headers map[string]string, err error) {
data := driveInnerResult(content)
filename = driveStringFromMap(data, "fileName")
if filename == "" {
filename = driveStringFromMap(data, "name")
}
switch v := data["resourceUrl"].(type) {
case string:
resourceURL = v
case []any:
if len(v) > 0 {
resourceURL, _ = v[0].(string)
}
}
if resourceURL == "" {
resourceURL, _ = data["downloadUrl"].(string)
}
if resourceURL == "" {
err = apperrors.NewValidation("download_file 返回不完整: resourceUrl/downloadUrl 为空")
return
}
headers = make(map[string]string)
if h, ok := data["headers"].(map[string]any); ok {
for k, v := range h {
if s, ok := v.(string); ok {
headers[k] = s
}
}
}
return
}
func driveDownloadFilename(serverFilename, rawURL string) string {
if name := cleanDriveFilename(serverFilename); name != "" {
return name
}
return inferDriveFilename(rawURL)
}
func cleanDriveFilename(name string) string {
name = strings.TrimSpace(name)
if name == "" {
return ""
}
name = filepath.Base(strings.ReplaceAll(name, "\\", "/"))
if name == "" || name == "." || name == "/" {
return ""
}
return name
}
func inferDriveFilename(rawURL string) string {
parsed, err := url.Parse(rawURL)
if err == nil {
name := strings.TrimSpace(filepath.Base(parsed.Path))
if name != "" && name != "." && name != "/" {
if decoded, decodeErr := url.PathUnescape(name); decodeErr == nil && decoded != "" {
return decoded
}
return name
}
}
return "download"
}
func httpGetDriveFile(ctx context.Context, resourceURL string, headers map[string]string, outputPath string) error {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, resourceURL, nil)
if err != nil {
return fmt.Errorf("构建下载请求失败: %w", err)
}
for k, v := range headers {
req.Header.Set(k, v)
}
client := &http.Client{Timeout: 10 * time.Minute}
resp, err := client.Do(req)
if err != nil {
return fmt.Errorf("下载失败: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
body, _ := io.ReadAll(io.LimitReader(resp.Body, 512))
return fmt.Errorf("下载失败 HTTP %d: %s", resp.StatusCode, string(body))
}
out, err := os.Create(outputPath)
if err != nil {
return fmt.Errorf("failed to create output file: %w", err)
}
defer out.Close()
if _, err := io.Copy(out, resp.Body); err != nil {
return fmt.Errorf("写入下载文件失败: %w", err)
}
return nil
}
func driveStringFlag(cmd *cobra.Command, name string) string {
if cmd == nil {
return ""
}
if value, err := cmd.Flags().GetString(name); err == nil && strings.TrimSpace(value) != "" {
return strings.TrimSpace(value)
}
if value, err := cmd.InheritedFlags().GetString(name); err == nil && strings.TrimSpace(value) != "" {
return strings.TrimSpace(value)
}
return ""
}
func driveFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) string {
if value := driveStringFlag(cmd, primary); value != "" {
return value
}
for _, alias := range aliases {
if value := driveStringFlag(cmd, alias); value != "" {
return value
}
}
return ""
}
func driveIntFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) int {
if cmd == nil {
return 0
}
if cmd.Flags().Changed(primary) {
value, _ := cmd.Flags().GetInt(primary)
return value
}
for _, alias := range aliases {
if cmd.Flags().Changed(alias) {
value, _ := cmd.Flags().GetInt(alias)
return value
}
}
value, _ := cmd.Flags().GetInt(primary)
return value
}
func driveRequiredFlag(cmd *cobra.Command, name string) (string, error) {
if value := driveStringFlag(cmd, name); value != "" {
return value, nil
}
return "", apperrors.NewValidation(fmt.Sprintf("--%s is required", name))
}
func driveRequiredFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) (string, error) {
if value := driveFlagOrFallback(cmd, primary, aliases...); value != "" {
return value, nil
}
return "", apperrors.NewValidation(fmt.Sprintf("--%s is required", primary))
}
func addDriveStringParam(cmd *cobra.Command, params map[string]any, paramName string, flags ...string) {
if value := driveFlagOrFallback(cmd, flags[0], flags[1:]...); value != "" {
params[paramName] = value
}
}
func addDriveHiddenStringFlag(cmd *cobra.Command, name, usage string) {
cmd.Flags().String(name, "", usage)
_ = cmd.Flags().MarkHidden(name)
}
func driveStringFromMap(values map[string]any, key string) string {
value, _ := values[key].(string)
return strings.TrimSpace(value)
}
// validateDriveParentID rejects pure-numeric IDs (which are dentryId values
// from the chat link namespace, not drive's dentryUuid).
func validateDriveParentID(parentID string) error {
value := strings.TrimSpace(parentID)
if value == "" {
return nil
}
for _, r := range value {
if r < '0' || r > '9' {
return nil
}
}
return apperrors.NewValidation(fmt.Sprintf(
"invalid drive --folder %q: pure numeric IDs are usually dentryId values from chat links, not drive dentryUuid; use a parent folder dentryUuid from drive list, or omit --folder to use the space root",
parentID,
))
}
// parseDriveUploadInfo extracts resourceUrl / uploadId / OSS headers from the
// drive.get_upload_info response. The actual server payload is:
//
// {
// "uploadId": "...",
// "resourceUrls": [
// { "url": "https://...", "headers": { ... } }
// ]
// }
//
// MCP gateway may wrap the payload with a "content" or "result" envelope, so we
// peel one layer if present, and also accept legacy flat resourceUrl/uploadUrl
// fields as a fallback.
func parseDriveUploadInfo(resp map[string]any) (resourceURL, uploadID string, headers map[string]string, err error) {
if resp == nil {
err = apperrors.NewValidation("get_upload_info 返回为空")
return
}
data := resp
if content, ok := data["content"].(map[string]any); ok && len(content) > 0 {
data = content
}
if result, ok := data["result"].(map[string]any); ok && len(result) > 0 {
data = result
}
uploadID, _ = data["uploadId"].(string)
if urls, ok := data["resourceUrls"].([]any); ok && len(urls) > 0 {
if first, ok := urls[0].(map[string]any); ok {
resourceURL, _ = first["url"].(string)
headers = make(map[string]string)
if h, ok := first["headers"].(map[string]any); ok {
for k, v := range h {
if s, ok := v.(string); ok {
headers[k] = s
}
}
}
}
}
if resourceURL == "" {
resourceURL, _ = data["resourceUrl"].(string)
}
if resourceURL == "" {
resourceURL, _ = data["uploadUrl"].(string)
}
if resourceURL == "" || uploadID == "" {
err = apperrors.NewValidation(fmt.Sprintf(
"get_upload_info 返回不完整: resourceUrl=%q, uploadId=%q", resourceURL, uploadID,
))
return
}
if headers == nil {
headers = make(map[string]string)
if h, ok := data["headers"].(map[string]any); ok {
for k, v := range h {
if s, ok := v.(string); ok {
headers[k] = s
}
}
}
}
return
}
// httpPutDriveFile uploads the file at filePath to a DingTalk drive OSS presigned URL.
//
// PROTOCOL CONTRACT: the headers map is authoritative. It contains the exact
// and complete set of HTTP headers required for the upload. An empty map means
// "no client-side headers needed" (this is the normal case for DingTalk drive,
// where the signature is embedded in the URL query string).
//
// DO NOT add Content-Type or any other client-inferred header here. DingTalk
// drive uses OSS v1 presigned URLs whose StringToSign includes the Content-Type
// header that the server saw at signing time (typically empty). Any client-side
// addition of Content-Type makes the signature computed by OSS at PUT time
// differ from the server's presignature → 403 SignatureDoesNotMatch.
//
// If a future OSS endpoint requires header-based signing (Authorization header
// instead of URL signing), introduce a separate helper rather than reintroducing
// a fallback here. The aitable attachment upload helper in aitable.go does set
// Content-Type because its OSS endpoint uses a different signing mode where the
// server includes the client-declared mime in its signature computation; do not
// unify the two helpers without re-validating both endpoints.
func httpPutDriveFile(ctx context.Context, resourceURL string, headers map[string]string, filePath string, fileSize int64) error {
f, err := os.Open(filePath)
if err != nil {
return fmt.Errorf("无法打开文件: %w", err)
}
defer f.Close()
req, err := http.NewRequestWithContext(ctx, http.MethodPut, resourceURL, f)
if err != nil {
return fmt.Errorf("构建 OSS 上传请求失败: %w", err)
}
req.ContentLength = fileSize
for k, v := range headers {
req.Header.Set(k, v)
}
client := &http.Client{Timeout: 10 * time.Minute}
resp, err := client.Do(req)
if err != nil {
return fmt.Errorf("OSS 上传失败: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
body, _ := io.ReadAll(io.LimitReader(resp.Body, 512))
return fmt.Errorf("OSS 上传失败 HTTP %d: %s", resp.StatusCode, string(body))
}
return nil
}
+214
View File
@@ -0,0 +1,214 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"context"
"io"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
)
type driveCommandRunner struct {
last executor.Invocation
result executor.Result
err error
}
func (r *driveCommandRunner) Run(_ context.Context, invocation executor.Invocation) (executor.Result, error) {
r.last = invocation
if r.err != nil {
return executor.Result{}, r.err
}
if r.result.Response != nil {
r.result.Invocation = invocation
return r.result, nil
}
return executor.Result{Invocation: invocation}, nil
}
func TestDriveListPageSizeAliasMapsMaxResults(t *testing.T) {
t.Parallel()
runner := &driveCommandRunner{}
cmd := newDriveListCommand(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"--page-size", "20"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "list_files" {
t.Fatalf("tool = %q, want list_files", runner.last.Tool)
}
if got := runner.last.Params["maxResults"]; got != float64(20) {
t.Fatalf("maxResults = %#v, want 20", got)
}
}
func TestDriveDownloadOutputDirectoryUsesServerFileName(t *testing.T) {
t.Parallel()
wantBody := []byte("download body")
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
t.Fatalf("method = %s, want GET", r.Method)
}
_, _ = w.Write(wantBody)
}))
defer server.Close()
runner := &driveCommandRunner{
result: executor.Result{
Response: map[string]any{
"content": map[string]any{
"result": map[string]any{
"resourceUrl": server.URL + "/url-derived.bin",
"fileName": "server-name.txt",
},
},
},
},
}
outputDir := t.TempDir()
cmd := newDriveDownloadCommand(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"--file-id", "FILE_001", "--output", outputDir})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
gotPath := filepath.Join(outputDir, "server-name.txt")
gotBody, err := os.ReadFile(gotPath)
if err != nil {
t.Fatalf("ReadFile(%s) error = %v", gotPath, err)
}
if string(gotBody) != string(wantBody) {
t.Fatalf("downloaded body = %q, want %q", string(gotBody), string(wantBody))
}
if _, err := os.Stat(filepath.Join(outputDir, "url-derived.bin")); !os.IsNotExist(err) {
t.Fatalf("URL-derived filename should not be used, stat error = %v", err)
}
}
func TestParseDriveDownloadInfoUsesNameWhenFileNameAbsent(t *testing.T) {
t.Parallel()
resourceURL, filename, _, err := parseDriveDownloadInfo(map[string]any{
"result": map[string]any{
"downloadUrl": "https://example.com/fallback.bin",
"name": "server-name-from-name.txt",
},
})
if err != nil {
t.Fatalf("parseDriveDownloadInfo() error = %v", err)
}
if resourceURL != "https://example.com/fallback.bin" {
t.Fatalf("resourceURL = %q, want fallback URL", resourceURL)
}
if filename != "server-name-from-name.txt" {
t.Fatalf("filename = %q, want server-name-from-name.txt", filename)
}
}
// TestHttpPutDriveFile_NoContentTypeWhenServerHeadersEmpty guards the fix for
// the SignatureDoesNotMatch bug on DingTalk drive presigned OSS uploads.
//
// DingTalk drive returns an OSS presigned URL (signature in the URL query
// string) and signs the upload with Content-Type left empty. Any client-side
// Content-Type makes the signature OSS computes at PUT time differ from the
// server presignature → 403 SignatureDoesNotMatch.
//
// Previous behavior: httpPutDriveFile fell back to a client-inferred mime when
// the server's `headers` map was empty, which is the normal case for DingTalk
// drive (`{"headers": {}}`). That fallback broke every PNG / image / typed-mime
// upload in production.
//
// This test asserts the PUT request body contains no Content-Type header when
// the server returns an empty headers map. If a future change reintroduces
// client-side Content-Type fallback this test will fail loudly.
func TestHttpPutDriveFile_NoContentTypeWhenServerHeadersEmpty(t *testing.T) {
var receivedContentType string
var receivedBody []byte
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPut {
t.Fatalf("method = %s, want PUT", r.Method)
}
receivedContentType = r.Header.Get("Content-Type")
receivedBody, _ = io.ReadAll(r.Body)
w.WriteHeader(http.StatusOK)
}))
defer server.Close()
tmp := filepath.Join(t.TempDir(), "test.png")
wantBody := []byte("fake-png-bytes")
if err := os.WriteFile(tmp, wantBody, 0o644); err != nil {
t.Fatalf("WriteFile() error = %v", err)
}
err := httpPutDriveFile(context.Background(), server.URL, map[string]string{}, tmp, int64(len(wantBody)))
if err != nil {
t.Fatalf("httpPutDriveFile() error = %v", err)
}
if receivedContentType != "" {
t.Fatalf("Content-Type = %q, want empty (presigned URL signing requires no client-inferred headers)", receivedContentType)
}
if string(receivedBody) != string(wantBody) {
t.Fatalf("uploaded body = %q, want %q", string(receivedBody), string(wantBody))
}
}
// TestHttpPutDriveFile_PassthroughServerHeaders verifies that any header the
// server returns in its prepare response is forwarded verbatim to the PUT
// request. This is the symmetric guarantee to the test above: clients must
// neither add nor drop headers — they pass through exactly what the server
// declared.
func TestHttpPutDriveFile_PassthroughServerHeaders(t *testing.T) {
var receivedHeaders http.Header
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
receivedHeaders = r.Header.Clone()
w.WriteHeader(http.StatusOK)
}))
defer server.Close()
tmp := filepath.Join(t.TempDir(), "test.bin")
if err := os.WriteFile(tmp, []byte("x"), 0o644); err != nil {
t.Fatalf("WriteFile() error = %v", err)
}
headers := map[string]string{
"Content-Type": "application/octet-stream",
"x-oss-storage-class": "Standard",
}
err := httpPutDriveFile(context.Background(), server.URL, headers, tmp, 1)
if err != nil {
t.Fatalf("httpPutDriveFile() error = %v", err)
}
if got := receivedHeaders.Get("Content-Type"); got != "application/octet-stream" {
t.Fatalf("Content-Type = %q, want application/octet-stream", got)
}
if got := receivedHeaders.Get("x-oss-storage-class"); got != "Standard" {
t.Fatalf("x-oss-storage-class = %q, want Standard", got)
}
}
+239 -120
View File
@@ -16,6 +16,7 @@ package helpers
import (
"encoding/json"
"fmt"
"os"
"strings"
"time"
@@ -81,6 +82,7 @@ func (reportHandler) Command(runner executor.Runner) *cobra.Command {
newReportListCommand(runner),
newReportStatsCommand(runner),
newReportSentCommand(runner),
newReportCreatedCommand(runner),
)
return root
}
@@ -316,49 +318,7 @@ func newReportListCommand(runner executor.Runner) *cobra.Command {
dws report list --start "2026-03-10 00:00:00" --end "2026-03-10 23:59:59" --cursor 0 --size 20`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
startStr, _ := cmd.Flags().GetString("start")
endStr, _ := cmd.Flags().GetString("end")
startMs, err := parseFlexTimeToMillis("start", startStr)
if err != nil {
return err
}
endMs, err := parseFlexTimeToMillis("end", endStr)
if err != nil {
return err
}
if err := validateTimeRange(startMs, endMs); err != nil {
return err
}
// cursor defaults to 0, size defaults to 20
cursor, _ := cmd.Flags().GetInt("cursor")
size, _ := cmd.Flags().GetInt("size")
if v, _ := cmd.Flags().GetInt("limit"); v > 0 && !cmd.Flags().Changed("size") {
size = v
}
params := map[string]any{
"startTime": float64(startMs),
"endTime": float64(endMs),
"cursor": float64(cursor),
"size": float64(size),
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_received_report_list", params,
))
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_received_report_list", params,
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
RunE: withReportDeprecationWarning("list", "inbox list", reportListRunE(runner)),
}
cmd.Flags().String("start", "", "开始时间 ISO-8601 (如 2026-03-10T00:00:00+08:00) (必填)")
cmd.Flags().String("end", "", "结束时间 ISO-8601 (如 2026-03-10T23:59:59+08:00) (必填)")
@@ -419,83 +379,7 @@ func newReportSentCommand(runner executor.Runner) *cobra.Command {
dws report sent --template-name "日报"`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
// cursor defaults to 0, size defaults to 20
cursor, _ := cmd.Flags().GetInt("cursor")
size, _ := cmd.Flags().GetInt("size")
if v, _ := cmd.Flags().GetInt("limit"); v > 0 && !cmd.Flags().Changed("size") {
size = v
}
params := map[string]any{
"cursor": float64(cursor),
"size": float64(size),
}
// Default time range: last 30 days
now := time.Now()
startDefault := now.AddDate(0, 0, -30).Truncate(24 * time.Hour).Format(time.RFC3339)
endDefault := time.Date(now.Year(), now.Month(), now.Day(), 23, 59, 59, 0, now.Location()).Format(time.RFC3339)
startStr, _ := cmd.Flags().GetString("start")
if startStr == "" {
startStr = startDefault
}
endStr, _ := cmd.Flags().GetString("end")
if endStr == "" {
endStr = endDefault
}
startMs, err := parseFlexTimeToMillis("start", startStr)
if err != nil {
return err
}
params["startTime"] = float64(startMs)
endMs, err := parseFlexTimeToMillis("end", endStr)
if err != nil {
return err
}
params["endTime"] = float64(endMs)
if err := validateTimeRange(startMs, endMs); err != nil {
return err
}
// Optional modified time filters
if v, _ := cmd.Flags().GetString("modified-start"); v != "" {
ms, err := parseFlexTimeToMillis("modified-start", v)
if err != nil {
return err
}
params["modifiedStartTime"] = float64(ms)
}
if v, _ := cmd.Flags().GetString("modified-end"); v != "" {
ms, err := parseFlexTimeToMillis("modified-end", v)
if err != nil {
return err
}
params["modifiedEndTime"] = float64(ms)
}
// Optional template name filter
if v, _ := cmd.Flags().GetString("template-name"); v != "" {
params["report_template_name"] = v
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_send_report_list", params,
))
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_send_report_list", params,
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
},
RunE: withReportDeprecationWarning("sent", "outbox list", reportSentRunE(runner)),
}
cmd.Flags().Int("cursor", 0, "分页游标,首次传 0 (默认 0)")
cmd.Flags().Int("size", 20, "每页条数,最大 20 (默认 20)")
@@ -510,6 +394,241 @@ func newReportSentCommand(runner executor.Runner) *cobra.Command {
return cmd
}
// ── deprecation wrapper ────────────────────────────────────
// withReportDeprecationWarning prints a stderr warning that the legacy command
// is deprecated and then invokes the underlying RunE unchanged. The CLI exit
// code, stdout payload, and side effects remain identical to the canonical
// new-path command — only stderr gains the `[deprecated]` notice.
//
// Pair with the deprecated leaves wired in `(reportHandler).Command` and the
// post-merge `AttachReportLegacyInboxAlias` hook so every legacy invocation
// path carries the same notice.
func withReportDeprecationWarning(oldPath, newPath string, run func(*cobra.Command, []string) error) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, args []string) error {
w := cmd.ErrOrStderr()
if w == nil {
w = os.Stderr
}
fmt.Fprintf(w, "[deprecated] `dws report %s` 已废弃,将在后续版本中移除。请改用 `dws report %s`。\n", oldPath, newPath)
return run(cmd, args)
}
}
// reportSentRunE implements the canonical "list reports I have sent" handler.
// Extracted so that the legacy `sent` and `created` aliases can share one body
// and each wrap it independently with the deprecation notice.
func reportSentRunE(runner executor.Runner) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, args []string) error {
// cursor defaults to 0, size defaults to 20
cursor, _ := cmd.Flags().GetInt("cursor")
size, _ := cmd.Flags().GetInt("size")
if v, _ := cmd.Flags().GetInt("limit"); v > 0 && !cmd.Flags().Changed("size") {
size = v
}
params := map[string]any{
"cursor": float64(cursor),
"size": float64(size),
}
// Default time range: last 30 days
now := time.Now()
startDefault := now.AddDate(0, 0, -30).Truncate(24 * time.Hour).Format(time.RFC3339)
endDefault := time.Date(now.Year(), now.Month(), now.Day(), 23, 59, 59, 0, now.Location()).Format(time.RFC3339)
startStr, _ := cmd.Flags().GetString("start")
if startStr == "" {
startStr = startDefault
}
endStr, _ := cmd.Flags().GetString("end")
if endStr == "" {
endStr = endDefault
}
startMs, err := parseFlexTimeToMillis("start", startStr)
if err != nil {
return err
}
params["startTime"] = float64(startMs)
endMs, err := parseFlexTimeToMillis("end", endStr)
if err != nil {
return err
}
params["endTime"] = float64(endMs)
if err := validateTimeRange(startMs, endMs); err != nil {
return err
}
// Optional modified time filters
if v, _ := cmd.Flags().GetString("modified-start"); v != "" {
ms, err := parseFlexTimeToMillis("modified-start", v)
if err != nil {
return err
}
params["modifiedStartTime"] = float64(ms)
}
if v, _ := cmd.Flags().GetString("modified-end"); v != "" {
ms, err := parseFlexTimeToMillis("modified-end", v)
if err != nil {
return err
}
params["modifiedEndTime"] = float64(ms)
}
// Optional template name filter
if v, _ := cmd.Flags().GetString("template-name"); v != "" {
params["report_template_name"] = v
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_send_report_list", params,
))
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_send_report_list", params,
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
}
// reportListRunE implements the canonical "list reports I have received" handler.
// Extracted so the legacy `list` and `inbox` aliases can share one body and
// each wrap it independently with the deprecation notice. The post-merge
// inbox-group hook (AttachReportLegacyInboxAlias) also reuses this body.
func reportListRunE(runner executor.Runner) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, args []string) error {
startStr, _ := cmd.Flags().GetString("start")
endStr, _ := cmd.Flags().GetString("end")
startMs, err := parseFlexTimeToMillis("start", startStr)
if err != nil {
return err
}
endMs, err := parseFlexTimeToMillis("end", endStr)
if err != nil {
return err
}
if err := validateTimeRange(startMs, endMs); err != nil {
return err
}
// cursor defaults to 0, size defaults to 20
cursor, _ := cmd.Flags().GetInt("cursor")
size, _ := cmd.Flags().GetInt("size")
if v, _ := cmd.Flags().GetInt("limit"); v > 0 && !cmd.Flags().Changed("size") {
size = v
}
params := map[string]any{
"startTime": float64(startMs),
"endTime": float64(endMs),
"cursor": float64(cursor),
"size": float64(size),
}
if commandDryRun(cmd) {
return writeCommandPayload(cmd, executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_received_report_list", params,
))
}
result, err := runner.Run(cmd.Context(), executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd), "report", "get_received_report_list", params,
))
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
}
// ── created (deprecated alias for outbox list) ─────────────
// newReportCreatedCommand registers `dws report created` as a deprecated
// alias of `dws report outbox list`. Behaves byte-for-byte like `report sent`
// on stdout — the only difference is the deprecation notice on stderr names
// the user's invocation path so logs make it obvious which alias was used.
func newReportCreatedCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "created",
Short: "[deprecated] 已废弃,请改用 `dws report outbox list`",
Example: " dws report created --cursor 0 --size 20\n dws report created --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\"",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: withReportDeprecationWarning("created", "outbox list", reportSentRunE(runner)),
}
cmd.Flags().Int("cursor", 0, "分页游标,首次传 0 (默认 0)")
cmd.Flags().Int("size", 20, "每页条数,最大 20 (默认 20)")
cmd.Flags().Int("limit", 0, "--size 的别名")
_ = cmd.Flags().MarkHidden("limit")
cmd.Flags().String("start", "", "创建开始时间 ISO-8601 (默认最近 30 天)")
cmd.Flags().String("end", "", "创建结束时间 ISO-8601 (默认最近 30 天)")
cmd.Flags().String("modified-start", "", "修改开始时间 ISO-8601 (可选)")
cmd.Flags().String("modified-end", "", "修改结束时间 ISO-8601 (可选)")
cmd.Flags().String("template-name", "", "日志模板名称 (可选,不传查全部)")
preferLegacyLeaf(cmd)
return cmd
}
// AttachReportLegacyInboxAlias finds the dynamic-built `report inbox` group
// in the merged command tree and turns it into a dual-role command: when
// invoked with flags (and no subcommand), it executes the canonical inbox
// list handler with a deprecation notice on stderr. Sub-command invocation
// (e.g. `report inbox list ...`) keeps working unchanged.
//
// Why a post-merge hook: the envelope publishes `inbox` as a group whose
// only child is `list`. Hardcoded helpers cannot graft a same-named leaf in
// (MergeHardcodedLeaves rejects helper-leaf vs envelope-group as a shape
// mismatch), so we instead enrich the existing group's flags and RunE in
// place. The `runner` is the same executor that the helper leaves use,
// keeping behaviour identical to `report list` / `report inbox list`.
func AttachReportLegacyInboxAlias(commands []*cobra.Command, runner executor.Runner) {
for _, top := range commands {
if top == nil || top.Name() != "report" {
continue
}
var inbox *cobra.Command
for _, child := range top.Commands() {
if child != nil && child.Name() == "inbox" {
inbox = child
break
}
}
if inbox == nil {
return
}
// Inject the same flag surface used by `report list` so the
// legacy invocation `report inbox --start ... --end ...` parses.
// Skip flags that already exist (envelope may have registered
// some on the group) to avoid duplicate-flag panics.
registerIfAbsent := func(name string, register func()) {
if inbox.Flags().Lookup(name) == nil {
register()
}
}
registerIfAbsent("start", func() { inbox.Flags().String("start", "", "开始时间 ISO-8601 (必填)") })
registerIfAbsent("end", func() { inbox.Flags().String("end", "", "结束时间 ISO-8601 (必填)") })
registerIfAbsent("cursor", func() { inbox.Flags().Int("cursor", 0, "分页游标,首次传 0 (默认 0)") })
registerIfAbsent("size", func() { inbox.Flags().Int("size", 20, "每页条数 (默认 20)") })
registerIfAbsent("limit", func() {
inbox.Flags().Int("limit", 0, "--size 的别名")
_ = inbox.Flags().MarkHidden("limit")
})
registerIfAbsent("sender-user-ids", func() {
inbox.Flags().StringSlice("sender-user-ids", nil, "发送人 staffId 列表,逗号分隔 (可选)")
})
inbox.RunE = withReportDeprecationWarning("inbox", "inbox list", reportListRunE(runner))
// Group default Args was cobra.NoArgs which rejects positional args; we
// keep that constraint — the legacy path is `report inbox --start ...`
// with flags only, no positional arguments.
return
}
}
// ── helpers ────────────────────────────────────────────────
func parseUserIDs(s string) []string {
+263
View File
@@ -0,0 +1,263 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"context"
"errors"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
// recordingRunner captures invocations so tests can assert that a wrapper
// did or did not forward the call to the underlying handler.
type recordingRunner struct {
calls []executor.Invocation
err error
}
func (r *recordingRunner) Run(_ context.Context, inv executor.Invocation) (executor.Result, error) {
r.calls = append(r.calls, inv)
if r.err != nil {
return executor.Result{}, r.err
}
return executor.Result{Invocation: inv, Response: map[string]any{"success": true}}, nil
}
// withReportDeprecationWarning is the contract every deprecated alias wraps
// its RunE with. The wrapper must:
// - emit a stderr line starting with "[deprecated]"
// - name both the old path the user invoked and the new canonical path
// - call the wrapped handler exactly once and propagate its error
func TestWithReportDeprecationWarning_PrintsStderrAndForwards(t *testing.T) {
t.Parallel()
called := 0
innerErr := errors.New("inner sentinel")
wrapped := withReportDeprecationWarning("sent", "outbox list", func(*cobra.Command, []string) error {
called++
return innerErr
})
var stderr bytes.Buffer
cmd := &cobra.Command{Use: "sent"}
cmd.SetErr(&stderr)
gotErr := wrapped(cmd, nil)
if !errors.Is(gotErr, innerErr) {
t.Fatalf("expected inner error to propagate, got %v", gotErr)
}
if called != 1 {
t.Fatalf("inner handler called %d times, want 1", called)
}
msg := stderr.String()
if !strings.Contains(msg, "[deprecated]") {
t.Fatalf("stderr missing [deprecated] marker: %q", msg)
}
if !strings.Contains(msg, "dws report sent") {
t.Fatalf("stderr missing old path: %q", msg)
}
if !strings.Contains(msg, "dws report outbox list") {
t.Fatalf("stderr missing new canonical path: %q", msg)
}
}
// newReportCreatedCommand must be a leaf attached to the helpers report root,
// with the deprecation wrapper already on RunE pointing at outbox list. The
// shape — leaf, not group — matters because MergeHardcodedLeaves only grafts
// helper leaves that have no same-named envelope counterpart.
func TestNewReportCreatedCommand_IsLeafWithDeprecationWrapper(t *testing.T) {
t.Parallel()
runner := &recordingRunner{}
cmd := newReportCreatedCommand(runner)
if cmd == nil {
t.Fatal("nil command returned")
}
if cmd.Use != "created" {
t.Fatalf("Use = %q, want %q", cmd.Use, "created")
}
if cmd.HasSubCommands() {
t.Fatalf("created should be a leaf, not a group")
}
if !strings.Contains(cmd.Short, "[deprecated]") {
t.Fatalf("short missing [deprecated]: %q", cmd.Short)
}
if cmd.RunE == nil {
t.Fatal("RunE not wired")
}
// Exercise RunE end-to-end with --dry-run via the root --dry-run flag
// so the runner records the invocation without making any network call.
var stderr bytes.Buffer
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().Bool("dry-run", true, "")
root.AddCommand(cmd)
cmd.SetErr(&stderr)
cmd.SetOut(&bytes.Buffer{})
root.SetArgs([]string{"created", "--cursor", "0", "--size", "5", "--start", "2026-03-01T00:00:00+08:00", "--end", "2026-03-08T00:00:00+08:00"})
if err := root.Execute(); err != nil {
t.Fatalf("execute: %v", err)
}
if !strings.Contains(stderr.String(), "[deprecated] `dws report created`") {
t.Fatalf("stderr missing old path marker: %q", stderr.String())
}
if !strings.Contains(stderr.String(), "dws report outbox list") {
t.Fatalf("stderr missing new path: %q", stderr.String())
}
}
// AttachReportLegacyInboxAlias targets the dynamic-built `report inbox` group:
// it must register the legacy flags (start/end/cursor/size/limit/...) and
// wire a deprecation-wrapped RunE. Subcommands (e.g. inbox list) must stay
// reachable and unmodified.
func TestAttachReportLegacyInboxAlias_EnrichesGroupInPlace(t *testing.T) {
t.Parallel()
// Build a stand-in dynamic tree mirroring the envelope shape: a `report`
// root with an `inbox` group whose only child is `list`. The list leaf
// already has the canonical flags from envelope-side registration.
listLeaf := &cobra.Command{
Use: "list",
RunE: func(*cobra.Command, []string) error { return nil },
}
listLeaf.Flags().String("start", "", "")
listLeaf.Flags().String("end", "", "")
inboxGroup := &cobra.Command{
Use: "inbox",
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
inboxGroup.AddCommand(listLeaf)
reportRoot := &cobra.Command{Use: "report"}
reportRoot.AddCommand(inboxGroup)
runner := &recordingRunner{}
AttachReportLegacyInboxAlias([]*cobra.Command{reportRoot}, runner)
// Flags must have been added to the GROUP (not the list child).
for _, name := range []string{"start", "end", "cursor", "size", "limit", "sender-user-ids"} {
if inboxGroup.Flags().Lookup(name) == nil {
t.Errorf("inbox group missing --%s after hook", name)
}
}
// list child stays intact — hook must NOT have replaced it.
if listLeaf.Parent() != inboxGroup {
t.Errorf("list child detached from inbox group")
}
// Group RunE must now be the deprecation-wrapped handler. Verify by
// invoking it directly with the required flags set on the group.
var stderr bytes.Buffer
inboxGroup.SetErr(&stderr)
inboxGroup.SetOut(&bytes.Buffer{})
if err := inboxGroup.Flags().Set("start", "2026-03-01T00:00:00+08:00"); err != nil {
t.Fatalf("set start: %v", err)
}
if err := inboxGroup.Flags().Set("end", "2026-03-08T00:00:00+08:00"); err != nil {
t.Fatalf("set end: %v", err)
}
// Wire a root with --dry-run so the runner records without network IO.
dwsRoot := &cobra.Command{Use: "dws"}
dwsRoot.PersistentFlags().Bool("dry-run", true, "")
dwsRoot.AddCommand(reportRoot)
if err := inboxGroup.RunE(inboxGroup, nil); err != nil {
t.Fatalf("inbox RunE failed: %v", err)
}
if !strings.Contains(stderr.String(), "[deprecated] `dws report inbox`") {
t.Fatalf("stderr missing deprecation marker: %q", stderr.String())
}
if !strings.Contains(stderr.String(), "dws report inbox list") {
t.Fatalf("stderr missing new path: %q", stderr.String())
}
}
// AttachReportLegacyInboxAlias on a tree without `report inbox` must be a
// no-op — callers should be able to invoke the hook unconditionally.
func TestAttachReportLegacyInboxAlias_NoopWhenInboxAbsent(t *testing.T) {
t.Parallel()
other := &cobra.Command{Use: "other"}
report := &cobra.Command{Use: "report"}
// No inbox child.
runner := &recordingRunner{}
// Should not panic / not error.
AttachReportLegacyInboxAlias([]*cobra.Command{nil, other, report}, runner)
if report.HasSubCommands() {
t.Errorf("expected no children synthesised; got %d", len(report.Commands()))
}
}
// reportSentRunE / reportListRunE are extracted so that the legacy aliases
// (sent / created and list / inbox) can each wrap them. Sanity-check that
// reusing the extracted handler with a dry-run runner produces a
// recordingRunner invocation for the right MCP tool name.
func TestReportSentRunE_InvokesCanonicalTool(t *testing.T) {
t.Parallel()
runner := &recordingRunner{}
cmd := newReportSentCommand(runner)
// Disable the wrapper to test the inner body directly.
cmd.RunE = reportSentRunE(runner)
var out bytes.Buffer
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().Bool("dry-run", true, "")
root.AddCommand(cmd)
cmd.SetOut(&out)
cmd.SetErr(&bytes.Buffer{})
root.SetArgs([]string{"sent", "--cursor", "0", "--size", "5", "--start", "2026-03-01T00:00:00+08:00", "--end", "2026-03-08T00:00:00+08:00"})
if err := root.Execute(); err != nil {
t.Fatalf("execute: %v", err)
}
// EchoRunner-style: dry-run path short-circuits before runner.Run, so
// recordingRunner.calls stays empty. We instead confirm the dry-run
// payload is written to stdout.
if !strings.Contains(out.String(), "get_send_report_list") {
t.Fatalf("stdout missing canonical tool name: %q", out.String())
}
}
func TestReportListRunE_InvokesCanonicalTool(t *testing.T) {
t.Parallel()
runner := &recordingRunner{}
cmd := newReportListCommand(runner)
cmd.RunE = reportListRunE(runner)
var out bytes.Buffer
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().Bool("dry-run", true, "")
root.AddCommand(cmd)
cmd.SetOut(&out)
cmd.SetErr(&bytes.Buffer{})
root.SetArgs([]string{"list", "--cursor", "0", "--size", "5", "--start", "2026-03-01T00:00:00+08:00", "--end", "2026-03-08T00:00:00+08:00"})
if err := root.Execute(); err != nil {
t.Fatalf("execute: %v", err)
}
if !strings.Contains(out.String(), "get_received_report_list") {
t.Fatalf("stdout missing canonical tool name: %q", out.String())
}
}
+640
View File
@@ -0,0 +1,640 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package helpers — readable-output enrichment for `report inbox list` and
// `report outbox list`.
//
// What this file adds:
//
// - EnrichReportListContent: pure function that walks an MCP `content`
// response, finds the report items list, and overlays five extra fields
// the agent layer relies on:
// success
// count
// agentDisplayContentIncluded (bool — inbox false, outbox true)
// agentDisplayColumns ([]string — wukong-aligned column set)
// agentDisplayMarkdown (string — markdown table)
// The function never mutates the input map in-place; it returns a fresh
// map so callers (including tests) can compare before/after safely.
//
// - AttachReportListReadableEnrichment: post-merge hook that finds the
// dynamic-built `report inbox list` / `report outbox list` leaves in the
// merged command tree and wraps their RunE to apply EnrichReportListContent
// to the JSON payload before it is written to stdout. Behaviour for other
// formats (--format raw / table / csv etc.) is preserved verbatim —
// enrichment only fires when the output is JSON.
//
// Why a post-merge hook (mirroring AttachReportLegacyInboxAlias):
//
// the envelope already publishes `report inbox` and `report outbox` as
// groups with a `list` leaf each; the open-source CLI cannot add a same-
// named helper leaf (MergeHardcodedLeaves would reject it as a shape
// mismatch with the envelope). Wrapping the existing leaf's RunE keeps the
// envelope as the single source of truth for flags/schema while letting us
// layer wukong-equivalent enrichment on top.
package helpers
import (
"bytes"
"encoding/json"
"fmt"
"sort"
"strconv"
"strings"
"time"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/output"
"github.com/spf13/cobra"
)
// ── public constants (mirrors wukong/products/report.go) ────────────────
// reportInboxColumns / reportOutboxColumns must stay byte-identical to the
// REPORT_*_COLUMNS constants in dws-wukong/auto-test/cli_to_mcp/testcases/
// report/test_90_report_param_regression.py — drift breaks the param-
// regression assertions. The only difference between the two is the "日志内容"
// column, which inbox elides (privacy: never echo inbox bodies back as
// agent-visible content) and outbox keeps (the user is the author).
var (
reportInboxColumns = []string{"日期", "标题", "发送人", "状态", "钉钉链接"}
reportOutboxColumns = []string{"日期", "标题", "发送人", "状态", "日志内容", "钉钉链接"}
)
// reportDingtalkLinkText is the visible label used inside the markdown link
// in the "钉钉链接" column. The wukong upstream also uses this literal; tests
// (REPORT_LINK_MARKER) match on the prefix "[在钉钉中查看日志](" so any change
// here must be mirrored in test_90_report_param_regression.py.
const reportDingtalkLinkText = "在钉钉中查看日志"
// ── EnrichReportListContent: pure transform ─────────────────────────────
// EnrichReportListContent overlays wukong-style agent-display fields on the
// MCP `content` map of a report list response. It is a pure function:
// - input map is never mutated;
// - on any structural mismatch (nil, no list, etc.) it returns the input
// untouched so the caller's behaviour is byte-stable.
//
// includeContent controls whether the "日志内容" column appears in
// agentDisplayColumns / agentDisplayMarkdown and whether each result row
// retains the 日志内容 key. Pass true for outbox (sender == self, content
// safe to echo), false for inbox.
func EnrichReportListContent(content map[string]any, includeContent bool) map[string]any {
if content == nil {
return content
}
items, found := findReportItemsForEnrichment(content)
if !found {
// Still attach display fields so the agent layer has a stable
// schema to read from even on empty / malformed list responses;
// rows will be empty and markdown table will only carry headers.
items = nil
}
rows := make([]map[string]string, 0, len(items))
for _, item := range items {
rows = append(rows, reportRowForItem(item, includeContent))
}
sortReportRowsByDate(rows)
columns := reportInboxColumns
if includeContent {
columns = reportOutboxColumns
}
markdown := reportRenderMarkdownTable(columns, rows)
// Build a shallow copy so callers never see in-place mutation. We
// preserve every key the upstream MCP server returned (notably
// hasMore / nextCursor / cursor at the result-wrapper level) by
// copying them into the new map verbatim.
out := make(map[string]any, len(content)+5)
for k, v := range content {
out[k] = v
}
// Replace `result` with a typed list of rows so the agent can iterate
// over a stable shape. The original `result` body is kept under the
// rebuilt key so paginator fields like nextCursor still ride at the
// expected level when MCP nested them there.
rebuiltResult := buildReportResultPayload(content, rows)
if rebuiltResult != nil {
out["result"] = rebuiltResult
} else {
// No nested wrapper to preserve — emit rows directly under result
// so callers can read result[] uniformly.
out["result"] = rowsAsAnySlice(rows)
}
out["count"] = len(rows)
if _, present := out["success"]; !present {
out["success"] = true
}
out["agentDisplayContentIncluded"] = includeContent
out["agentDisplayColumns"] = columns
out["agentDisplayMarkdown"] = markdown
return out
}
// findReportItemsForEnrichment locates the list of report items inside an
// MCP `content` map. The wukong upstream uses a permissive search across the
// well-known keys ("list", "items", "data", "reports", "records",
// "report_list", "reportList", "result"); we mirror that so envelope
// renames don't silently drop enrichment.
func findReportItemsForEnrichment(root map[string]any) ([]map[string]any, bool) {
for _, key := range []string{"list", "items", "data", "reports", "records", "report_list", "reportList", "result"} {
value, ok := root[key]
if !ok {
continue
}
if items, found := reportItemsFromValueForEnrichment(value); found {
return items, true
}
}
return nil, false
}
func reportItemsFromValueForEnrichment(v any) ([]map[string]any, bool) {
switch x := v.(type) {
case []any:
items := make([]map[string]any, 0, len(x))
for _, raw := range x {
item, ok := raw.(map[string]any)
if !ok {
continue
}
items = append(items, item)
}
return items, true
case map[string]any:
// Recurse into nested wrappers (e.g. {result: {list: [...]}}).
for _, key := range []string{"list", "items", "data", "reports", "records", "report_list", "reportList"} {
value, ok := x[key]
if !ok {
continue
}
if items, found := reportItemsFromValueForEnrichment(value); found {
return items, true
}
}
}
return nil, false
}
// buildReportResultPayload rebuilds the `result` field so that, when the
// upstream MCP wrapped items under `result.list`, the rebuilt payload keeps
// the wrapper (preserving sibling fields like nextCursor / hasMore) while
// swapping the list contents for the enriched rows. When no wrapper exists,
// returns nil and the caller emits rows directly.
func buildReportResultPayload(content map[string]any, rows []map[string]string) any {
wrapper, ok := content["result"].(map[string]any)
if !ok {
return nil
}
out := make(map[string]any, len(wrapper))
for k, v := range wrapper {
out[k] = v
}
for _, key := range []string{"list", "items", "data", "reports", "records", "report_list", "reportList"} {
if _, found := wrapper[key]; found {
out[key] = rowsAsAnySlice(rows)
return out
}
}
// Wrapper had no recognised list key — the list must live somewhere
// else; we still publish rows at out["list"] so agents have a uniform
// place to read.
out["list"] = rowsAsAnySlice(rows)
return out
}
func rowsAsAnySlice(rows []map[string]string) []any {
out := make([]any, 0, len(rows))
for _, row := range rows {
copyRow := make(map[string]any, len(row))
for k, v := range row {
copyRow[k] = v
}
out = append(out, copyRow)
}
return out
}
// reportRowForItem extracts the four base columns (date / title / sender /
// status) plus the dingtalk markdown link from a single item map. The
// "日志内容" column is injected only when includeContent=true; inbox callers
// pass false to enforce the privacy contract (no inbox bodies leaked back).
func reportRowForItem(item map[string]any, includeContent bool) map[string]string {
row := map[string]string{
"日期": reportItemDate(item),
"标题": reportItemTitle(item),
"发送人": reportItemSender(item),
"状态": reportItemStatus(item),
"钉钉链接": reportItemMarkdownLink(item),
}
if includeContent {
row["日志内容"] = reportItemContent(item)
}
return row
}
func reportItemDate(item map[string]any) string {
for _, key := range []string{"createTime", "gmtCreate", "sendTime", "time", "modifiedTime", "日期"} {
if ms := reportMillisFromValue(item[key]); ms > 0 {
return time.UnixMilli(ms).Local().Format("2006-01-02 15:04")
}
if s := reportStringFromValue(item[key]); s != "" {
return s
}
}
return ""
}
func reportItemTitle(item map[string]any) string {
for _, key := range []string{"report_name", "reportName", "title", "summary", "report_template_name", "templateName", "标题"} {
if s := reportStringFromValue(item[key]); s != "" {
return s
}
}
if sender := reportItemSender(item); sender != "" {
return sender + "的日志"
}
return "日志"
}
func reportItemSender(item map[string]any) string {
for _, key := range []string{"creatorName", "senderName", "userName", "creator", "sender", "发送人"} {
if s := reportStringFromValue(item[key]); s != "" {
return s
}
}
return ""
}
func reportItemStatus(item map[string]any) string {
for _, key := range []string{"readStatus", "isRead", "hasRead", "read", "状态"} {
v, ok := item[key]
if !ok {
continue
}
switch x := v.(type) {
case bool:
if x {
return "已读"
}
return "未读"
case string:
lower := strings.TrimSpace(strings.ToLower(x))
switch lower {
case "true", "read", "1", "已读":
return "已读"
case "false", "unread", "0", "未读":
return "未读"
default:
return strings.TrimSpace(x)
}
case float64:
if x == 1 {
return "已读"
}
if x == 0 {
return "未读"
}
}
}
return ""
}
// reportItemMarkdownLink prefers an upstream-supplied markdown link
// ("dingtalkOpenMarkdownLink"); otherwise it composes one from any URL field
// it can find on the item. As a last resort it emits the plain label "查看
// 详情" so the column is never empty (tests assert the column header always
// exists and the marker shows when count>0; an empty cell would still
// satisfy markdown but would degrade the user-facing render).
func reportItemMarkdownLink(item map[string]any) string {
if s := reportStringFromValue(item["dingtalkOpenMarkdownLink"]); s != "" {
return s
}
if s := reportStringFromValue(item["钉钉链接"]); s != "" {
return s
}
for _, key := range []string{"url", "dingtalkOpenUrl", "openUrl", "webUrl"} {
if s := reportStringFromValue(item[key]); s != "" {
return fmt.Sprintf("[%s](%s)", reportDingtalkLinkText, s)
}
}
if link, ok := item["dingtalkOpenLink"].(map[string]any); ok {
if s := reportStringFromValue(link["url"]); s != "" {
return fmt.Sprintf("[%s](%s)", reportDingtalkLinkText, s)
}
}
return "查看详情"
}
func reportItemContent(item map[string]any) string {
for _, key := range []string{"report_content", "reportContent", "content", "summary", "日志内容"} {
v, ok := item[key]
if !ok {
continue
}
if s := reportFlattenContent(v); s != "" {
return reportCompactCell(s, 600)
}
}
return ""
}
func reportFlattenContent(v any) string {
switch x := v.(type) {
case string:
return strings.TrimSpace(x)
case []any:
parts := make([]string, 0, len(x))
for _, item := range x {
if s := reportFlattenContent(item); s != "" {
parts = append(parts, s)
}
}
return strings.Join(parts, ";")
case map[string]any:
label := reportFirstString(x, "key", "field_name", "fieldName", "name", "title")
value := reportFirstString(x, "value", "content", "text", "plainText", "markdown")
if value == "" {
return ""
}
if label != "" {
return label + ":" + value
}
return value
}
return ""
}
func reportFirstString(m map[string]any, keys ...string) string {
for _, k := range keys {
if s := reportStringFromValue(m[k]); s != "" {
return s
}
}
return ""
}
func reportStringFromValue(v any) string {
switch x := v.(type) {
case string:
return strings.TrimSpace(x)
case float64:
return strconv.FormatFloat(x, 'f', -1, 64)
case json.Number:
return x.String()
case bool:
if x {
return "true"
}
return "false"
}
return ""
}
// reportMillisFromValue normalises numeric / numeric-string timestamps to
// milliseconds. Second-precision values (< 1e11) are scaled up. Non-numeric
// inputs return 0 so the caller can fall back to a string formatter.
func reportMillisFromValue(v any) int64 {
switch x := v.(type) {
case float64:
return normaliseReportTimestamp(int64(x))
case int64:
return normaliseReportTimestamp(x)
case int:
return normaliseReportTimestamp(int64(x))
case json.Number:
n, err := x.Int64()
if err != nil {
return 0
}
return normaliseReportTimestamp(n)
case string:
s := strings.TrimSpace(x)
if s == "" {
return 0
}
if n, err := strconv.ParseInt(s, 10, 64); err == nil {
return normaliseReportTimestamp(n)
}
}
return 0
}
func normaliseReportTimestamp(ts int64) int64 {
if ts <= 0 {
return 0
}
if ts < 100000000000 {
ts *= 1000
}
return ts
}
func reportCompactCell(s string, maxRunes int) string {
s = strings.ReplaceAll(s, "|", "|")
s = strings.Join(strings.Fields(s), " ")
if maxRunes <= 0 {
return s
}
r := []rune(s)
if len(r) <= maxRunes {
return s
}
return string(r[:maxRunes]) + "..."
}
// sortReportRowsByDate sorts rows by date string descending so the most
// recent log appears first — matches the wukong upstream's user-visible
// ordering. String compare is safe because dates are formatted as
// "2006-01-02 15:04" (lexicographic order == chronological order).
func sortReportRowsByDate(rows []map[string]string) {
sort.SliceStable(rows, func(i, j int) bool {
return rows[i]["日期"] > rows[j]["日期"]
})
}
// reportRenderMarkdownTable composes a standard GFM markdown table from the
// given column header and row maps. Cell values are sanitised so that
// embedded pipes do not break the table; long whitespace runs are squashed.
func reportRenderMarkdownTable(columns []string, rows []map[string]string) string {
var b strings.Builder
b.WriteString("| ")
b.WriteString(strings.Join(columns, " | "))
b.WriteString(" |")
b.WriteString("\n")
dividers := make([]string, len(columns))
for i := range dividers {
dividers[i] = "---"
}
b.WriteString("| ")
b.WriteString(strings.Join(dividers, " | "))
b.WriteString(" |")
for _, row := range rows {
b.WriteString("\n")
cells := make([]string, 0, len(columns))
for _, col := range columns {
cells = append(cells, reportCellForMarkdown(row[col]))
}
b.WriteString("| ")
b.WriteString(strings.Join(cells, " | "))
b.WriteString(" |")
}
return b.String()
}
func reportCellForMarkdown(s string) string {
s = strings.ReplaceAll(s, "\r\n", "\n")
s = strings.ReplaceAll(s, "\r", "\n")
s = strings.Join(strings.Fields(s), " ")
return strings.ReplaceAll(s, "|", "|")
}
// ── AttachReportListReadableEnrichment: post-merge hook ─────────────────
// AttachReportListReadableEnrichment wires EnrichReportListContent into the
// envelope-built `report inbox list` and `report outbox list` leaves.
//
// Mechanism (decorator over the leaf's existing RunE):
// 1. Replace leaf.RunE with a closure that delegates to the original RunE.
// 2. Before delegating, redirect cmd.SetOut() to an in-memory buffer when
// the resolved output format is JSON (the only format the agent display
// schema cares about).
// 3. After the original RunE returns, unmarshal the captured bytes, locate
// the MCP `content` payload, call EnrichReportListContent, and write
// the enriched JSON to the leaf's original stdout.
// 4. For non-JSON formats (raw / table / csv / ...) we never replace stdout,
// so behaviour stays byte-for-byte identical to the unwrapped envelope.
//
// `runner` is accepted for API symmetry with AttachReportLegacyInboxAlias —
// the wrapper itself does not invoke runner; the wrapped RunE already does.
// Keeping the parameter avoids a churn on app/legacy.go if we ever need to
// dispatch a sibling tool from inside the wrapper.
func AttachReportListReadableEnrichment(commands []*cobra.Command, runner executor.Runner) {
_ = runner // reserved — see comment above
for _, top := range commands {
if top == nil || top.Name() != "report" {
continue
}
wrapReportListLeaf(top, "inbox", false)
wrapReportListLeaf(top, "outbox", true)
}
}
func wrapReportListLeaf(reportCmd *cobra.Command, groupName string, includeContent bool) {
var group *cobra.Command
for _, child := range reportCmd.Commands() {
if child != nil && child.Name() == groupName {
group = child
break
}
}
if group == nil {
return
}
var leaf *cobra.Command
for _, child := range group.Commands() {
if child != nil && child.Name() == "list" {
leaf = child
break
}
}
if leaf == nil {
return
}
originalRunE := leaf.RunE
if originalRunE == nil {
return
}
leaf.RunE = func(cmd *cobra.Command, args []string) error {
// Resolve the format the user asked for. Enrichment only applies
// when the eventual writer would emit JSON — other formats stay
// untouched so `--format table`, `--format raw`, etc. remain
// byte-stable against the envelope.
fmtChoice := output.ResolveFormat(cmd, output.FormatJSON)
if fmtChoice != output.FormatJSON {
return originalRunE(cmd, args)
}
originalStdout := cmd.OutOrStdout()
buf := &bytes.Buffer{}
cmd.SetOut(buf)
runErr := originalRunE(cmd, args)
// Restore the leaf's original writer regardless of whether the
// run succeeded — if it failed we still want any partial bytes
// (rare, defensive) flushed back to the caller.
cmd.SetOut(originalStdout)
if runErr != nil {
// Pass through any captured bytes the inner RunE produced
// before failing so the caller's logs / stderr show the
// same diagnostic context as the un-wrapped envelope.
if buf.Len() > 0 {
_, _ = originalStdout.Write(buf.Bytes())
}
return runErr
}
enriched, ok := enrichCapturedReportListJSON(buf.Bytes(), includeContent)
if !ok {
// Captured payload did not match the expected shape (e.g.
// dry-run output, non-content envelope, malformed JSON) —
// echo the original bytes verbatim so the caller's behaviour
// is unchanged for those code paths.
_, _ = originalStdout.Write(buf.Bytes())
return nil
}
return output.WriteJSON(originalStdout, enriched)
}
}
// enrichCapturedReportListJSON parses bytes the wrapped RunE wrote to its
// captured stdout buffer and, if the payload is the unwrapped MCP `content`
// map (the shape produced by output.WriteCommandPayload for successful
// compat_invocation Results), applies EnrichReportListContent and returns
// the enriched payload. Returns ok=false for any shape the function does
// not recognise so the caller falls back to passthrough.
func enrichCapturedReportListJSON(raw []byte, includeContent bool) (any, bool) {
trimmed := bytes.TrimSpace(raw)
if len(trimmed) == 0 {
return nil, false
}
var decoded any
if err := json.Unmarshal(trimmed, &decoded); err != nil {
return nil, false
}
root, ok := decoded.(map[string]any)
if !ok {
return nil, false
}
// Case A: payload is the MCP `content` map directly (the post-unwrap
// shape that output.WriteCommandPayload emits for successful
// compat_invocation results in --format json). Enrich in place.
if _, hasResult := root["result"]; hasResult || hasReportListKey(root) {
return EnrichReportListContent(root, includeContent), true
}
// Case B: dry-run / error envelopes carry {invocation, response}. We
// leave those untouched — the agent-display schema only applies to
// successful list responses; dry-run is for inspection.
return nil, false
}
// hasReportListKey reports whether the map looks like an MCP list response
// even if `result` is absent (some servers return `list` at the top level).
func hasReportListKey(m map[string]any) bool {
for _, k := range []string{"list", "items", "data", "reports", "records", "report_list", "reportList"} {
if _, ok := m[k]; ok {
return true
}
}
return false
}
+280
View File
@@ -0,0 +1,280 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"encoding/json"
"reflect"
"strings"
"testing"
)
// TestEnrichReportListContent_InboxStripsContent — inbox callers must never
// surface 日志内容 either in agentDisplayColumns or per-row maps; the privacy
// contract is enforced by the column set and the row builder simultaneously.
func TestEnrichReportListContent_InboxStripsContent(t *testing.T) {
content := map[string]any{
"result": map[string]any{
"list": []any{
map[string]any{
"reportId": "R-1",
"reportName": "周报",
"creatorName": "张三",
"createTime": float64(1747900800000), // 2025-05-22T16:00:00 UTC; locale-dependent display
"readStatus": false,
"content": "本周完成 enrichment helpers",
"dingtalkOpenUrl": "https://example.dingtalk.com/r/1",
},
},
"hasMore": false,
"nextCursor": float64(0),
},
}
got := EnrichReportListContent(content, false)
if got["agentDisplayContentIncluded"] != false {
t.Fatalf("inbox includeContent should be false, got %v", got["agentDisplayContentIncluded"])
}
cols, _ := got["agentDisplayColumns"].([]string)
want := []string{"日期", "标题", "发送人", "状态", "钉钉链接"}
if !reflect.DeepEqual(cols, want) {
t.Fatalf("inbox columns mismatch:\n got=%v\nwant=%v", cols, want)
}
md, _ := got["agentDisplayMarkdown"].(string)
if !strings.HasPrefix(md, "| 日期 | 标题 | 发送人 | 状态 | 钉钉链接 |") {
t.Fatalf("inbox markdown header missing, got: %q", md)
}
if strings.Contains(md, "日志内容") {
t.Fatalf("inbox markdown must NOT contain 日志内容 column, got: %q", md)
}
// result list rows must not carry 日志内容 either — the test suite has
// `assert all("日志内容" not in item for item in data["result"])`.
wrapper, _ := got["result"].(map[string]any)
if wrapper == nil {
t.Fatalf("inbox result should be wrapper map preserving hasMore, got: %T", got["result"])
}
list, _ := wrapper["list"].([]any)
if len(list) != 1 {
t.Fatalf("expected 1 row in result.list, got %d", len(list))
}
row, _ := list[0].(map[string]any)
if _, present := row["日志内容"]; present {
t.Fatalf("inbox row must not contain 日志内容 key, got: %v", row)
}
if got["count"] != 1 {
t.Fatalf("count should be 1, got %v", got["count"])
}
// hasMore / nextCursor preserved from the original wrapper.
if wrapper["hasMore"] != false {
t.Fatalf("hasMore not preserved: %v", wrapper["hasMore"])
}
}
// TestEnrichReportListContent_OutboxKeepsContent — outbox callers (author ==
// self) get the 日志内容 column and per-row body.
func TestEnrichReportListContent_OutboxKeepsContent(t *testing.T) {
content := map[string]any{
"result": map[string]any{
"list": []any{
map[string]any{
"reportId": "R-9",
"reportName": "日报",
"creatorName": "李四",
"createTime": float64(1747900800000),
"readStatus": true,
"content": "完成 outbox enrichment 测试",
"dingtalkOpenUrl": "https://example.dingtalk.com/r/9",
},
},
},
}
got := EnrichReportListContent(content, true)
if got["agentDisplayContentIncluded"] != true {
t.Fatalf("outbox includeContent should be true")
}
cols, _ := got["agentDisplayColumns"].([]string)
want := []string{"日期", "标题", "发送人", "状态", "日志内容", "钉钉链接"}
if !reflect.DeepEqual(cols, want) {
t.Fatalf("outbox columns mismatch:\n got=%v\nwant=%v", cols, want)
}
md, _ := got["agentDisplayMarkdown"].(string)
if !strings.HasPrefix(md, "| 日期 | 标题 | 发送人 | 状态 | 日志内容 | 钉钉链接 |") {
t.Fatalf("outbox markdown header wrong, got: %q", md)
}
if !strings.Contains(md, "[在钉钉中查看日志](") {
t.Fatalf("outbox markdown must contain REPORT_LINK_MARKER prefix when row has a URL, got: %q", md)
}
if !strings.Contains(md, "完成 outbox enrichment 测试") {
t.Fatalf("outbox markdown must contain the 日志内容 cell text, got: %q", md)
}
}
// TestEnrichReportListContent_EmptyListStillEmitsSchema — even on a zero-row
// response the agent-display fields must be present so downstream tooling
// has a stable schema. count=0 / markdown is header-only.
func TestEnrichReportListContent_EmptyListStillEmitsSchema(t *testing.T) {
content := map[string]any{
"result": map[string]any{
"list": []any{},
},
}
got := EnrichReportListContent(content, false)
if got["count"] != 0 {
t.Fatalf("count should be 0, got %v", got["count"])
}
md, _ := got["agentDisplayMarkdown"].(string)
if !strings.HasPrefix(md, "| 日期 | 标题 | 发送人 | 状态 | 钉钉链接 |") {
t.Fatalf("empty inbox should still emit header row, got: %q", md)
}
// Should not panic / lose schema fields.
for _, k := range []string{"agentDisplayContentIncluded", "agentDisplayColumns", "agentDisplayMarkdown", "success"} {
if _, ok := got[k]; !ok {
t.Fatalf("missing key %q on empty list response", k)
}
}
}
// TestEnrichReportListContent_NilOrUnknownPassthrough — nil / non-list maps
// must not be mutated; the agent layer treats absence of agentDisplay* as
// "no enrichment available", which is the safe fallback.
func TestEnrichReportListContent_NilOrUnknownPassthrough(t *testing.T) {
if got := EnrichReportListContent(nil, true); got != nil {
t.Fatalf("nil input should return nil")
}
// No list-shaped key — we still attach the agent display schema so
// downstream callers always see a uniform shape, but the rows are empty.
src := map[string]any{"unrelated": "value"}
got := EnrichReportListContent(src, false)
if got["unrelated"] != "value" {
t.Fatalf("unrelated keys must be preserved")
}
if got["count"] != 0 {
t.Fatalf("missing list -> count should be 0")
}
// The input map must not be mutated in place.
if _, present := src["agentDisplayColumns"]; present {
t.Fatalf("EnrichReportListContent mutated the input map")
}
}
// TestEnrichCapturedReportListJSON_PassthroughForDryRun — dry-run output
// (the {invocation, response} envelope) must round-trip verbatim through
// the wrapper; enrichment only applies to unwrapped MCP content responses.
func TestEnrichCapturedReportListJSON_PassthroughForDryRun(t *testing.T) {
raw := []byte(`{
"invocation": {"kind":"compat_invocation"},
"response": {"dry_run": true}
}`)
if _, ok := enrichCapturedReportListJSON(raw, false); ok {
t.Fatalf("dry-run envelope must fall through to passthrough")
}
}
// TestEnrichCapturedReportListJSON_HandlesContentShape — when output.
// WriteCommandPayload unwraps the Result and emits the raw `content` map,
// the wrapper must detect that shape and enrich it.
func TestEnrichCapturedReportListJSON_HandlesContentShape(t *testing.T) {
raw := []byte(`{
"success": true,
"result": {
"list": [
{
"reportId": "X-1",
"reportName": "周报",
"creatorName": "王五",
"createTime": 1747900800000,
"readStatus": true,
"dingtalkOpenUrl": "https://example.dingtalk.com/r/x1"
}
]
}
}`)
got, ok := enrichCapturedReportListJSON(raw, true)
if !ok {
t.Fatalf("content shape should be recognised")
}
root, _ := got.(map[string]any)
if root["agentDisplayContentIncluded"] != true {
t.Fatalf("outbox enrichment should mark contentIncluded=true")
}
cols, _ := root["agentDisplayColumns"].([]string)
if len(cols) != 6 {
t.Fatalf("outbox columns should have 6 entries, got %d (%v)", len(cols), cols)
}
}
// TestEnrichCapturedReportListJSON_MalformedJSON — invalid JSON must not
// panic and must fall through so the caller writes the raw bytes back.
func TestEnrichCapturedReportListJSON_MalformedJSON(t *testing.T) {
if _, ok := enrichCapturedReportListJSON([]byte(`not json`), false); ok {
t.Fatalf("malformed JSON must fall through to passthrough")
}
if _, ok := enrichCapturedReportListJSON([]byte(``), false); ok {
t.Fatalf("empty buffer must fall through to passthrough")
}
}
// TestEnrichReportListContent_MarkdownEscapesPipes — embedded pipes in user
// content must be replaced with full-width "|" so the markdown table is
// not broken at the renderer.
func TestEnrichReportListContent_MarkdownEscapesPipes(t *testing.T) {
content := map[string]any{
"result": map[string]any{
"list": []any{
map[string]any{
"reportId": "R-pipe",
"reportName": "标题|含管道",
"creatorName": "张|三",
"createTime": float64(1747900800000),
"readStatus": false,
},
},
},
}
got := EnrichReportListContent(content, false)
md, _ := got["agentDisplayMarkdown"].(string)
if strings.Contains(strings.Split(md, "\n")[2], "|含管道") {
// The first data row is line index 2 (header, divider, data).
t.Fatalf("raw '|' must be replaced with full-width '|' in cell, got: %q", md)
}
if !strings.Contains(md, "标题|含管道") {
t.Fatalf("expected escaped full-width pipe in title cell, got: %q", md)
}
}
// TestEnrichReportListContent_JSONNumberTimestamps — json.Number variants of
// the timestamp keys must still produce a formatted 日期 cell.
func TestEnrichReportListContent_JSONNumberTimestamps(t *testing.T) {
decoded := map[string]any{}
dec := json.NewDecoder(strings.NewReader(`{
"result": {
"list": [{
"reportId": "N-1",
"reportName": "N报",
"createTime": 1747900800000
}]
}
}`))
dec.UseNumber()
if err := dec.Decode(&decoded); err != nil {
t.Fatalf("decode: %v", err)
}
got := EnrichReportListContent(decoded, false)
wrapper, _ := got["result"].(map[string]any)
list, _ := wrapper["list"].([]any)
row, _ := list[0].(map[string]any)
date, _ := row["日期"].(string)
if date == "" {
t.Fatalf("json.Number timestamp should still yield a formatted 日期, got empty")
}
}
+399
View File
@@ -0,0 +1,399 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/cobracmd"
apperrors "github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/errors"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
func init() {
RegisterPublic(func() Handler {
return wikiHandler{}
})
}
// wikiHandler only fills command behavior the service-discovery envelope cannot
// express yet. The rest of the wiki surface remains owned by dynamic config.
type wikiHandler struct{}
func (wikiHandler) Name() string {
return "wiki"
}
func (wikiHandler) Command(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "wiki",
Short: "知识库扩展命令(合并到 dws wiki 命令树)",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
addWikiProxyCommands(root, runner)
space := &cobra.Command{
Use: "space",
Short: "知识库空间",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
space.AddCommand(
newWikiSpaceCreateCommand(runner),
newWikiSpaceGetCommand(runner),
newWikiSpaceListCommand(runner),
newWikiSpaceSearchCommand(runner),
)
root.AddCommand(space)
member := &cobra.Command{
Use: "member",
Short: "知识库成员",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
member.AddCommand(
newWikiMemberAddCommand(runner),
newWikiMemberUpdateCommand(runner),
newWikiMemberListCommand(runner),
)
root.AddCommand(member)
return root
}
func newWikiSpaceCreateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "create",
Short: "创建知识库",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
name, err := wikiRequiredFlag(cmd, "name")
if err != nil {
return err
}
params := map[string]any{"name": name}
if description := wikiFlagOrFallback(cmd, "desc", "description"); description != "" {
params["description"] = description
}
if icon := wikiFlagOrFallback(cmd, "icon"); icon != "" {
params["icon"] = icon
}
return runWikiTool(cmd, runner, "create_wikiSpace", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("name", "", "知识库名称 (必填)")
cmd.Flags().String("desc", "", "知识库描述")
addWikiHiddenStringFlag(cmd, "description", "--desc 的兼容别名")
cmd.Flags().String("icon", "", "知识库图标标识")
return cmd
}
func newWikiSpaceGetCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "get",
Short: "查看知识库详情",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
workspaceID, err := wikiRequiredFlagOrFallback(cmd, "workspace", "id", "space", "workspace-id", "workspaceId")
if err != nil {
return err
}
return runWikiTool(cmd, runner, "get_wikiSpace", map[string]any{
"workspaceId": workspaceID,
})
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("workspace", "", "知识库 ID 或 URL (必填)")
addWikiHiddenStringFlag(cmd, "id", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "space", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "workspace-id", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "workspaceId", "--workspace 的兼容别名")
return cmd
}
func newWikiSpaceListCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
Short: "列出知识库",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
params := map[string]any{}
if spaceType := wikiFlagOrFallback(cmd, "type"); spaceType != "" {
params["wikiSpaceType"] = spaceType
}
if limit := wikiFlagOrFallback(cmd, "limit", "page-size"); limit != "" {
params["pageSize"] = limit
}
if pageToken := wikiFlagOrFallback(cmd, "cursor", "page-token"); pageToken != "" {
params["pageToken"] = pageToken
}
return runWikiTool(cmd, runner, "list_wikiSpaces", params)
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("type", "orgWikiSpace", "知识库类型: myWikiSpace / orgWikiSpace")
cmd.Flags().String("limit", "", "每页数量 1-50 (默认 20)")
cmd.Flags().String("page-size", "", "--limit 的兼容别名")
_ = cmd.Flags().MarkHidden("page-size")
cmd.Flags().String("cursor", "", "分页游标")
addWikiHiddenStringFlag(cmd, "page-token", "--cursor 的兼容别名")
return cmd
}
func newWikiSpaceSearchCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "search",
Short: "搜索知识库",
Example: ` dws wiki space search --query 产品文档
dws wiki space search --query 技术方案 --limit 20
dws wiki space search --type myWikiSpace`,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
keyword := wikiFlagOrFallback(cmd, "query", "keyword")
spaceType, _ := cmd.Flags().GetString("type")
limit, _ := cmd.Flags().GetString("limit")
params := map[string]any{}
if strings.TrimSpace(limit) != "" {
params["pageSize"] = limit
}
if strings.TrimSpace(keyword) != "" {
params["keyword"] = strings.TrimSpace(keyword)
return runWikiTool(cmd, runner, "search_wikiSpaces", params)
}
if strings.TrimSpace(spaceType) == "myWikiSpace" {
params["wikiSpaceType"] = "myWikiSpace"
return runWikiTool(cmd, runner, "list_wikiSpaces", params)
}
return apperrors.NewValidation("--query/--keyword is required unless --type myWikiSpace is specified")
},
}
preferLegacyLeaf(cmd)
cmd.Flags().String("query", "", "搜索关键词")
addWikiHiddenStringFlag(cmd, "keyword", "--query 的兼容别名")
cmd.Flags().String("type", "", "知识库类型;仅 --type myWikiSpace 支持无 keyword 查询个人知识库")
cmd.Flags().String("limit", "", "返回数量 1-20 (默认 10)")
return cmd
}
func newWikiMemberAddCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "add",
Short: "添加知识库成员",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
workspaceID, err := wikiRequiredFlagOrFallback(cmd, "workspace", "id", "space", "workspace-id", "workspaceId")
if err != nil {
return err
}
user, err := wikiRequiredFlagOrFallback(cmd, "users", "user")
if err != nil {
return err
}
role, err := wikiRequiredFlag(cmd, "role")
if err != nil {
return err
}
return runWikiTool(cmd, runner, "add_member", map[string]any{
"workspaceId": workspaceID,
"userIds": wikiCSV(user),
"roleId": strings.ToUpper(strings.TrimSpace(role)),
})
},
}
preferLegacyLeaf(cmd)
addWikiWorkspaceFlag(cmd)
cmd.Flags().String("users", "", "用户 userId 列表,逗号分隔 (必填)")
addWikiHiddenStringFlag(cmd, "user", "--users 的兼容别名")
cmd.Flags().String("role", "", "权限角色 (必填)")
return cmd
}
func newWikiMemberUpdateCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "update",
Short: "更新知识库成员权限",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
workspaceID, err := wikiRequiredFlagOrFallback(cmd, "workspace", "id", "space", "workspace-id", "workspaceId")
if err != nil {
return err
}
user, err := wikiRequiredFlagOrFallback(cmd, "users", "user", "uid")
if err != nil {
return err
}
role, err := wikiRequiredFlag(cmd, "role")
if err != nil {
return err
}
return runWikiTool(cmd, runner, "update_member", map[string]any{
"workspaceId": workspaceID,
"userIds": wikiCSV(user),
"roleId": strings.ToUpper(strings.TrimSpace(role)),
})
},
}
preferLegacyLeaf(cmd)
addWikiWorkspaceFlag(cmd)
cmd.Flags().String("users", "", "用户 userId 列表,逗号分隔 (必填)")
addWikiHiddenStringFlag(cmd, "user", "--users 的兼容别名")
addWikiHiddenStringFlag(cmd, "uid", "--users 的兼容别名")
cmd.Flags().String("role", "", "权限角色 (必填)")
return cmd
}
func newWikiMemberListCommand(runner executor.Runner) *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
Short: "查询知识库成员",
Args: cobra.NoArgs,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
workspaceID, err := wikiRequiredFlagOrFallback(cmd, "workspace", "workspace-id", "workspaceId")
if err != nil {
return err
}
params := map[string]any{"workspaceId": workspaceID}
if maxResults := wikiIntFlagOrFallback(cmd, "limit", "max-results", "page-size"); maxResults > 0 {
params["maxResults"] = maxResults
}
if filterRole, _ := cmd.Flags().GetString("filter-role"); strings.TrimSpace(filterRole) != "" {
params["filterRoleIds"] = wikiCSV(filterRole)
}
return runWikiTool(cmd, runner, "list_member", params)
},
}
preferLegacyLeaf(cmd)
addWikiMemberListWorkspaceFlag(cmd)
cmd.Flags().Int("limit", 0, "返回成员数上限")
cmd.Flags().Int("max-results", 0, "--limit 的兼容别名")
_ = cmd.Flags().MarkHidden("max-results")
cmd.Flags().Int("page-size", 0, "--limit 的兼容别名")
_ = cmd.Flags().MarkHidden("page-size")
cmd.Flags().String("filter-role", "", "按角色过滤,逗号分隔")
return cmd
}
func runWikiTool(cmd *cobra.Command, runner executor.Runner, tool string, params map[string]any) error {
invocation := executor.NewHelperInvocation(
cobracmd.LegacyCommandPath(cmd),
"wiki",
tool,
params,
)
if commandDryRun(cmd) {
return writeCommandPayload(cmd, invocation)
}
result, err := runner.Run(cmd.Context(), invocation)
if err != nil {
return err
}
return writeCommandPayload(cmd, result)
}
func addWikiWorkspaceFlag(cmd *cobra.Command) {
cmd.Flags().String("workspace", "", "知识库 ID 或 URL (必填)")
addWikiHiddenStringFlag(cmd, "id", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "space", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "workspace-id", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "workspaceId", "--workspace 的兼容别名")
}
func addWikiMemberListWorkspaceFlag(cmd *cobra.Command) {
cmd.Flags().String("workspace", "", "知识库 ID 或 URL (必填)")
addWikiHiddenStringFlag(cmd, "workspace-id", "--workspace 的兼容别名")
addWikiHiddenStringFlag(cmd, "workspaceId", "--workspace 的兼容别名")
}
func addWikiHiddenStringFlag(cmd *cobra.Command, name, usage string) {
cmd.Flags().String(name, "", usage)
_ = cmd.Flags().MarkHidden(name)
}
func wikiRequiredFlag(cmd *cobra.Command, name string) (string, error) {
value, _ := cmd.Flags().GetString(name)
value = strings.TrimSpace(value)
if value == "" {
return "", apperrors.NewValidation("--" + name + " is required")
}
return value, nil
}
func wikiRequiredFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) (string, error) {
if value := wikiFlagOrFallback(cmd, primary, aliases...); value != "" {
return value, nil
}
return "", apperrors.NewValidation("--" + primary + " is required")
}
func wikiFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) string {
names := append([]string{primary}, aliases...)
for _, name := range names {
value, err := cmd.Flags().GetString(name)
if err == nil && strings.TrimSpace(value) != "" {
return strings.TrimSpace(value)
}
}
return ""
}
func wikiIntFlagOrFallback(cmd *cobra.Command, primary string, aliases ...string) int {
names := append([]string{primary}, aliases...)
for _, name := range names {
value, err := cmd.Flags().GetInt(name)
if err == nil && value > 0 {
return value
}
}
return 0
}
func wikiCSV(raw string) []string {
parts := strings.Split(raw, ",")
values := make([]string, 0, len(parts))
for _, part := range parts {
if value := strings.TrimSpace(part); value != "" {
values = append(values, value)
}
}
return values
}
+185
View File
@@ -0,0 +1,185 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"fmt"
"strings"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
"github.com/spf13/cobra"
)
type wikiProxyTarget int
const (
wikiProxyTargetSpace wikiProxyTarget = iota
wikiProxyTargetDoc
)
type wikiProxyOptions struct {
workspaceToWorkspaceIDs bool
}
func addWikiProxyCommands(root *cobra.Command, runner executor.Runner) {
root.AddCommand(
newWikiProxyLeaf(runner, "list", wikiProxyTargetSpace, []string{"space", "list"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "search", wikiProxyTargetSpace, []string{"space", "search"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "create", wikiProxyTargetSpace, []string{"space", "create"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "get", wikiProxyTargetSpace, []string{"space", "get"}, wikiProxyOptions{}),
)
node := newWikiProxyGroup("node", "知识库节点兼容入口")
node.AddCommand(
newWikiProxyLeaf(runner, "list", wikiProxyTargetDoc, []string{"list"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "read", wikiProxyTargetDoc, []string{"read"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "info", wikiProxyTargetDoc, []string{"info"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "create", wikiProxyTargetDoc, []string{"create"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "search", wikiProxyTargetDoc, []string{"search"}, wikiProxyOptions{workspaceToWorkspaceIDs: true}),
)
file := newWikiProxyGroup("file", "知识库文件兼容入口")
file.AddCommand(
newWikiProxyLeaf(runner, "list", wikiProxyTargetDoc, []string{"list"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "search", wikiProxyTargetDoc, []string{"search"}, wikiProxyOptions{workspaceToWorkspaceIDs: true}),
)
doc := newWikiProxyGroup("doc", "知识库文档兼容入口")
doc.AddCommand(
newWikiProxyLeaf(runner, "list", wikiProxyTargetDoc, []string{"list"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "read", wikiProxyTargetDoc, []string{"read"}, wikiProxyOptions{}),
newWikiProxyLeaf(runner, "search", wikiProxyTargetDoc, []string{"search"}, wikiProxyOptions{workspaceToWorkspaceIDs: true}),
)
root.AddCommand(node, file, doc)
}
func newWikiProxyGroup(use, short string) *cobra.Command {
cmd := &cobra.Command{
Use: use,
Short: short,
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
preferLegacyLeaf(cmd)
return cmd
}
func newWikiProxyLeaf(runner executor.Runner, use string, target wikiProxyTarget, targetPath []string, opts wikiProxyOptions) *cobra.Command {
cmd := &cobra.Command{
Use: use,
Short: "兼容入口,透明转发到新命令",
DisableFlagParsing: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
forwardArgs := append([]string{}, targetPath...)
forwardArgs = append(forwardArgs, rewriteWikiProxyArgs(args, opts)...)
fmt.Fprintf(cmd.ErrOrStderr(), "redirecting to: dws %s\n", wikiProxyDisplayPath(target, targetPath))
return executeWikiProxyTarget(cmd, runner, target, forwardArgs)
},
}
preferLegacyLeaf(cmd)
return cmd
}
func wikiProxyDisplayPath(target wikiProxyTarget, targetPath []string) string {
prefix := "doc"
if target == wikiProxyTargetSpace {
prefix = "wiki"
}
parts := append([]string{prefix}, targetPath...)
return strings.Join(parts, " ")
}
func rewriteWikiProxyArgs(args []string, opts wikiProxyOptions) []string {
if !opts.workspaceToWorkspaceIDs {
return append([]string{}, args...)
}
out := make([]string, 0, len(args))
for _, arg := range args {
switch {
case arg == "--workspace":
out = append(out, "--workspace-ids")
case strings.HasPrefix(arg, "--workspace="):
out = append(out, "--workspace-ids="+strings.TrimPrefix(arg, "--workspace="))
default:
out = append(out, arg)
}
}
return out
}
func executeWikiProxyTarget(source *cobra.Command, runner executor.Runner, target wikiProxyTarget, args []string) error {
var root *cobra.Command
switch target {
case wikiProxyTargetSpace:
root = newWikiProxySpaceTargetRoot(runner)
case wikiProxyTargetDoc:
root = docHandler{}.Command(runner)
default:
return fmt.Errorf("unknown wiki proxy target: %d", target)
}
configureWikiProxyTargetRoot(source, root)
root.SetArgs(args)
return root.Execute()
}
func newWikiProxySpaceTargetRoot(runner executor.Runner) *cobra.Command {
root := &cobra.Command{
Use: "wiki",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
}
space := &cobra.Command{
Use: "space",
Short: "知识库空间",
Args: cobra.NoArgs,
TraverseChildren: true,
DisableAutoGenTag: true,
RunE: func(cmd *cobra.Command, args []string) error {
return cmd.Help()
},
}
space.AddCommand(
newWikiSpaceCreateCommand(runner),
newWikiSpaceGetCommand(runner),
newWikiSpaceListCommand(runner),
newWikiSpaceSearchCommand(runner),
)
root.AddCommand(space)
return root
}
func configureWikiProxyTargetRoot(source, root *cobra.Command) {
root.SilenceUsage = true
root.SilenceErrors = true
root.SetOut(source.OutOrStdout())
root.SetErr(source.ErrOrStderr())
root.SetIn(source.InOrStdin())
root.SetContext(source.Context())
if root.PersistentFlags().Lookup("format") == nil {
root.PersistentFlags().StringP("format", "f", "json", "输出格式: json|table|raw|pretty|ndjson|csv")
}
if root.PersistentFlags().Lookup("dry-run") == nil {
root.PersistentFlags().Bool("dry-run", false, "仅打印即将发送的请求,不真正执行")
}
}
+138
View File
@@ -0,0 +1,138 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"reflect"
"strings"
"testing"
)
func TestWikiTopLevelListProxyExecutesSpaceList(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"list", "--format", "json"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if !strings.Contains(strings.ToLower(errOut.String()), "redirecting to") {
t.Fatalf("stderr = %q, want redirecting hint", errOut.String())
}
if runner.last.CanonicalProduct != "wiki" {
t.Fatalf("product = %q, want wiki", runner.last.CanonicalProduct)
}
if runner.last.Tool != "list_wikiSpaces" {
t.Fatalf("tool = %q, want list_wikiSpaces", runner.last.Tool)
}
if runner.last.LegacyPath != "wiki space list" {
t.Fatalf("legacy path = %q, want wiki space list", runner.last.LegacyPath)
}
}
func TestWikiNodeReadProxyExecutesDocRead(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"node", "read", "--node", "NODE_001", "--format", "json"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if !strings.Contains(strings.ToLower(errOut.String()), "redirecting to") {
t.Fatalf("stderr = %q, want redirecting hint", errOut.String())
}
if runner.last.CanonicalProduct != "doc" {
t.Fatalf("product = %q, want doc", runner.last.CanonicalProduct)
}
if runner.last.Tool != "get_document_content" {
t.Fatalf("tool = %q, want get_document_content", runner.last.Tool)
}
if got := runner.last.Params["nodeId"]; got != "NODE_001" {
t.Fatalf("nodeId = %#v, want NODE_001", got)
}
}
func TestWikiFileSearchProxyRenamesWorkspace(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{
"file", "search",
"--query", "测试",
"--workspace", "WS_001",
"--format", "json",
})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.CanonicalProduct != "doc" {
t.Fatalf("product = %q, want doc", runner.last.CanonicalProduct)
}
if runner.last.Tool != "search_documents" {
t.Fatalf("tool = %q, want search_documents", runner.last.Tool)
}
if got := runner.last.Params["keyword"]; got != "测试" {
t.Fatalf("keyword = %#v, want 测试", got)
}
if got := runner.last.Params["workspaceIds"]; !reflect.DeepEqual(got, []string{"WS_001"}) {
t.Fatalf("workspaceIds = %#v, want []string{WS_001}", got)
}
}
func TestWikiProxyUnknownSubcommandsDoNotPanic(t *testing.T) {
t.Parallel()
cases := [][]string{
{"node", "delete", "--node", "FAKE"},
{"file", "read", "--node", "FAKE"},
}
for _, args := range cases {
args := args
t.Run(strings.Join(args[:2], " "), func(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs(args)
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() error = nil, want unknown subcommand")
}
combined := strings.ToLower(out.String() + errOut.String() + err.Error())
if strings.Contains(combined, "panic") || strings.Contains(combined, "runtime error") {
t.Fatalf("unexpected panic output: %s", combined)
}
})
}
}
+385
View File
@@ -0,0 +1,385 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package helpers
import (
"bytes"
"context"
"strconv"
"strings"
"testing"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/executor"
)
type wikiCommandRunner struct {
last executor.Invocation
}
func (r *wikiCommandRunner) Run(_ context.Context, invocation executor.Invocation) (executor.Result, error) {
r.last = invocation
return executor.Result{Invocation: invocation}, nil
}
func TestWikiSpaceSearchWithKeywordUsesSearchTool(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"space", "search", "--keyword", "产品文档", "--limit", "5"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "search_wikiSpaces" {
t.Fatalf("tool = %q, want search_wikiSpaces", runner.last.Tool)
}
if got := runner.last.Params["keyword"]; got != "产品文档" {
t.Fatalf("keyword = %#v, want 产品文档", got)
}
if got := runner.last.Params["pageSize"]; got != "5" {
t.Fatalf("pageSize = %#v, want 5", got)
}
}
func TestWikiSpaceSearchAcceptsWukongQueryAlias(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"space", "search", "--query", "产品文档", "--limit", "5"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "search_wikiSpaces" {
t.Fatalf("tool = %q, want search_wikiSpaces", runner.last.Tool)
}
if got := runner.last.Params["keyword"]; got != "产品文档" {
t.Fatalf("keyword = %#v, want 产品文档", got)
}
if got := runner.last.Params["pageSize"]; got != "5" {
t.Fatalf("pageSize = %#v, want 5", got)
}
}
func TestWikiSpaceSearchMyWikiSpaceWithoutKeywordUsesListTool(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"space", "search", "--type", "myWikiSpace"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "list_wikiSpaces" {
t.Fatalf("tool = %q, want list_wikiSpaces", runner.last.Tool)
}
if got := runner.last.Params["wikiSpaceType"]; got != "myWikiSpace" {
t.Fatalf("wikiSpaceType = %#v, want myWikiSpace", got)
}
}
func TestWikiSpaceSearchWithoutKeywordRejectsOtherTypes(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
}{
{name: "no type", args: []string{"space", "search"}},
{name: "org type", args: []string{"space", "search", "--type", "orgWikiSpace"}},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs(tc.args)
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() error = nil, want keyword validation failure")
}
message := strings.ToLower(err.Error())
if !strings.Contains(message, "keyword") || !strings.Contains(message, "query") {
t.Fatalf("error = %q, want keyword and query hints", err.Error())
}
if runner.last.Tool != "" {
t.Fatalf("tool = %q, want no invocation", runner.last.Tool)
}
})
}
}
func TestWikiSpaceGetWorkspaceAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
}{
{name: "workspace", args: []string{"space", "get", "--workspace", "WS_001"}},
{name: "workspace-id", args: []string{"space", "get", "--workspace-id", "WS_001"}},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs(tc.args)
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "get_wikiSpace" {
t.Fatalf("tool = %q, want get_wikiSpace", runner.last.Tool)
}
if got := runner.last.Params["workspaceId"]; got != "WS_001" {
t.Fatalf("workspaceId = %#v, want WS_001", got)
}
})
}
}
func TestWikiSpaceCreateAcceptsWukongDescAlias(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"space", "create", "--name", "技术方案", "--desc", "团队技术方案归档"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "create_wikiSpace" {
t.Fatalf("tool = %q, want create_wikiSpace", runner.last.Tool)
}
if got := runner.last.Params["description"]; got != "团队技术方案归档" {
t.Fatalf("description = %#v, want 团队技术方案归档", got)
}
}
func TestWikiSpaceListAcceptsWukongCursorAlias(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"space", "list", "--type", "orgWikiSpace", "--limit", "50", "--cursor", "TOKEN_001"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "list_wikiSpaces" {
t.Fatalf("tool = %q, want list_wikiSpaces", runner.last.Tool)
}
if got := runner.last.Params["wikiSpaceType"]; got != "orgWikiSpace" {
t.Fatalf("wikiSpaceType = %#v, want orgWikiSpace", got)
}
if got := runner.last.Params["pageSize"]; got != "50" {
t.Fatalf("pageSize = %#v, want 50", got)
}
if got := runner.last.Params["pageToken"]; got != "TOKEN_001" {
t.Fatalf("pageToken = %#v, want TOKEN_001", got)
}
}
func TestWikiMemberAddUsesWorkspaceIDAlias(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{
"member", "add",
"--workspace-id", "WS_001",
"--user", "uid1,uid2",
"--role", "reader",
})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "add_member" {
t.Fatalf("tool = %q, want add_member", runner.last.Tool)
}
if got := runner.last.Params["workspaceId"]; got != "WS_001" {
t.Fatalf("workspaceId = %#v, want WS_001", got)
}
if got := runner.last.Params["roleId"]; got != "READER" {
t.Fatalf("roleId = %#v, want READER", got)
}
users, ok := runner.last.Params["userIds"].([]string)
if !ok {
t.Fatalf("userIds type = %T, want []string", runner.last.Params["userIds"])
}
if strings.Join(users, ",") != "uid1,uid2" {
t.Fatalf("userIds = %#v, want uid1,uid2", users)
}
}
func TestWikiMemberUpdateAcceptsWukongUsersAlias(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{
"member", "update",
"--workspace", "WS_001",
"--users", "uid1,uid2",
"--role", "editor",
})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "update_member" {
t.Fatalf("tool = %q, want update_member", runner.last.Tool)
}
if got := runner.last.Params["roleId"]; got != "EDITOR" {
t.Fatalf("roleId = %#v, want EDITOR", got)
}
users, ok := runner.last.Params["userIds"].([]string)
if !ok {
t.Fatalf("userIds type = %T, want []string", runner.last.Params["userIds"])
}
if strings.Join(users, ",") != "uid1,uid2" {
t.Fatalf("userIds = %#v, want uid1,uid2", users)
}
}
func TestWikiMemberListLimitAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
flag string
want int
}{
{name: "limit primary", flag: "--limit", want: 50},
{name: "max-results alias", flag: "--max-results", want: 40},
{name: "page-size alias", flag: "--page-size", want: 30},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs([]string{"member", "list", "--workspace", "WS_001", tc.flag, strconv.Itoa(tc.want)})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstderr:\n%s", err, errOut.String())
}
if runner.last.Tool != "list_member" {
t.Fatalf("tool = %q, want list_member", runner.last.Tool)
}
if got := runner.last.Params["workspaceId"]; got != "WS_001" {
t.Fatalf("workspaceId = %#v, want WS_001", got)
}
if got := runner.last.Params["maxResults"]; got != tc.want {
t.Fatalf("maxResults = %#v, want %d", got, tc.want)
}
})
}
}
func TestWikiMemberListRejectsRemovedAliases(t *testing.T) {
t.Parallel()
cases := []struct {
name string
args []string
flag string
}{
{
name: "maxresults",
args: []string{"member", "list", "--workspace", "WS_001", "--maxresults", "10"},
flag: "maxresults",
},
{
name: "id",
args: []string{"member", "list", "--id", "WS_001"},
flag: "id",
},
{
name: "space",
args: []string{"member", "list", "--space", "WS_001"},
flag: "space",
},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
runner := &wikiCommandRunner{}
cmd := wikiHandler{}.Command(runner)
var out, errOut bytes.Buffer
cmd.SetOut(&out)
cmd.SetErr(&errOut)
cmd.SetArgs(tc.args)
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() error = nil, want unknown flag")
}
if !strings.Contains(strings.ToLower(err.Error()), "unknown flag: --"+tc.flag) {
t.Fatalf("error = %q, want unknown flag for --%s", err.Error(), tc.flag)
}
if runner.last.Tool != "" {
t.Fatalf("tool = %q, want no invocation", runner.last.Tool)
}
})
}
}
+106 -10
View File
@@ -38,10 +38,12 @@ type LifecycleInfo struct {
}
type ProductCLIMetadata struct {
Command string `json:"command,omitempty"`
Group string `json:"group,omitempty"`
Hidden bool `json:"hidden,omitempty"`
Skip bool `json:"skip,omitempty"`
Command string `json:"command,omitempty"`
Group string `json:"group,omitempty"`
Hidden bool `json:"hidden,omitempty"`
Skip bool `json:"skip,omitempty"`
Aliases []string `json:"aliases,omitempty"`
Prefixes []string `json:"prefixes,omitempty"`
}
type CLIFlagHint struct {
@@ -96,6 +98,7 @@ type ToolDescriptor struct {
InputSchema map[string]any `json:"input_schema,omitempty"`
OutputSchema map[string]any `json:"output_schema,omitempty"`
Sensitive bool `json:"sensitive"`
Auth *ToolAuthMetadata `json:"auth,omitempty"`
Annotations *ToolAnnotations `json:"annotations,omitempty"`
Hidden bool `json:"hidden,omitempty"`
FlagHints map[string]CLIFlagHint `json:"flag_hints,omitempty"`
@@ -104,6 +107,25 @@ type ToolDescriptor struct {
CanonicalPath string `json:"canonical_path"`
}
type ToolAuthMetadata struct {
Version string `json:"version,omitempty"`
ProductCode string `json:"productCode,omitempty"`
Domain string `json:"domain,omitempty"`
ClientObservedScopes []string `json:"clientObservedScopes,omitempty"`
RequiredScopes []string `json:"requiredScopes,omitempty"`
RequiredPermissions []string `json:"requiredPermissions,omitempty"`
RecommendedScopes []string `json:"recommendedScopes,omitempty"`
ExcludedScopes []string `json:"excludedScopes,omitempty"`
GrantProductCodes []string `json:"grantProductCodes,omitempty"`
RiskHint string `json:"riskHint,omitempty"`
RiskAction string `json:"riskAction,omitempty"`
ConfirmationRequired bool `json:"confirmationRequired,omitempty"`
Identities []string `json:"identities,omitempty"`
Source string `json:"source,omitempty"`
AuthMetaVersion string `json:"authMetaVersion,omitempty"`
AuthMetaHash string `json:"authMetaHash,omitempty"`
}
func BuildCatalog(runtimeServers []discovery.RuntimeServer) Catalog {
sorted := append([]discovery.RuntimeServer(nil), runtimeServers...)
sort.Slice(sorted, func(i, j int) bool {
@@ -235,15 +257,17 @@ func BuildCatalog(runtimeServers []discovery.RuntimeServer) Catalog {
if cliName == "" {
cliName = tool.Name
}
inputSchema := cloneMap(tool.InputSchema)
tools = append(tools, ToolDescriptor{
RPCName: tool.Name,
CLIName: cliName,
Group: strings.TrimSpace(toolGroup[tool.Name]),
Title: title,
Description: description,
InputSchema: cloneMap(tool.InputSchema),
InputSchema: inputSchema,
OutputSchema: cloneMap(tool.OutputSchema),
Sensitive: sensitive,
Auth: extractToolAuthMetadata(inputSchema, productID),
Annotations: deriveAnnotations(sensitive),
Hidden: toolHidden[tool.Name],
FlagHints: cloneFlagHints(toolFlagHints[tool.Name]),
@@ -268,13 +292,15 @@ func BuildCatalog(runtimeServers []discovery.RuntimeServer) Catalog {
lifecyclePtr = &lifecycleCopy
}
cliMeta := ProductCLIMetadata{
Command: strings.TrimSpace(runtimeServer.Server.CLI.Command),
Group: strings.TrimSpace(runtimeServer.Server.CLI.Group),
Hidden: runtimeServer.Server.CLI.Hidden,
Skip: runtimeServer.Server.CLI.Skip,
Command: strings.TrimSpace(runtimeServer.Server.CLI.Command),
Group: strings.TrimSpace(runtimeServer.Server.CLI.Group),
Hidden: runtimeServer.Server.CLI.Hidden,
Skip: runtimeServer.Server.CLI.Skip,
Aliases: append([]string(nil), runtimeServer.Server.CLI.Aliases...),
Prefixes: append([]string(nil), runtimeServer.Server.CLI.Prefixes...),
}
var cliPtr *ProductCLIMetadata
if cliMeta.Command != "" || cliMeta.Group != "" || cliMeta.Hidden || cliMeta.Skip {
if cliMeta.Command != "" || cliMeta.Group != "" || cliMeta.Hidden || cliMeta.Skip || len(cliMeta.Aliases) > 0 || len(cliMeta.Prefixes) > 0 {
cliCopy := cliMeta
cliPtr = &cliCopy
}
@@ -303,6 +329,76 @@ func BuildCatalog(runtimeServers []discovery.RuntimeServer) Catalog {
return Catalog{Products: products}
}
func extractToolAuthMetadata(schema map[string]any, productID string) *ToolAuthMetadata {
raw := any(nil)
if len(schema) > 0 {
raw = schema["x-dingtalk-auth"]
}
if raw == nil {
return productGrantAuthMetadata(productID)
}
data, err := json.Marshal(raw)
if err != nil {
return nil
}
var metadata ToolAuthMetadata
if err := json.Unmarshal(data, &metadata); err != nil {
return nil
}
if !hasMeaningfulToolAuthMetadata(metadata) {
return nil
}
return &metadata
}
func hasMeaningfulToolAuthMetadata(metadata ToolAuthMetadata) bool {
return strings.TrimSpace(metadata.Version) != "" ||
strings.TrimSpace(metadata.ProductCode) != "" ||
strings.TrimSpace(metadata.Domain) != "" ||
len(metadata.ClientObservedScopes) > 0 ||
len(metadata.RequiredScopes) > 0 ||
len(metadata.RequiredPermissions) > 0 ||
len(metadata.RecommendedScopes) > 0 ||
len(metadata.ExcludedScopes) > 0 ||
len(metadata.GrantProductCodes) > 0 ||
strings.TrimSpace(metadata.RiskHint) != "" ||
strings.TrimSpace(metadata.RiskAction) != "" ||
metadata.ConfirmationRequired ||
len(metadata.Identities) > 0 ||
strings.TrimSpace(metadata.Source) != "" ||
strings.TrimSpace(metadata.AuthMetaVersion) != "" ||
strings.TrimSpace(metadata.AuthMetaHash) != ""
}
func productGrantAuthMetadata(productID string) *ToolAuthMetadata {
productID = strings.TrimSpace(productID)
if productID == "" {
return nil
}
metadata := ToolAuthMetadata{
Version: "v1",
ProductCode: productID,
Domain: productID,
GrantProductCodes: []string{
productID,
},
Source: "dws-product-fallback",
AuthMetaVersion: "v1",
}
metadata.AuthMetaHash = toolAuthMetaHash(metadata)
return &metadata
}
func toolAuthMetaHash(metadata ToolAuthMetadata) string {
metadata.AuthMetaHash = ""
data, err := json.Marshal(metadata)
if err != nil {
return ""
}
sum := sha256.Sum256(data)
return "sha256:" + hex.EncodeToString(sum[:])
}
func (c Catalog) FindProduct(id string) (CanonicalProduct, bool) {
for _, product := range c.Products {
if product.ID == id {
+134
View File
@@ -216,6 +216,140 @@ func TestBuildCatalogFallsBackToRuntimeSensitiveMetadata(t *testing.T) {
}
}
func TestBuildCatalogCarriesDingTalkAuthMetadata(t *testing.T) {
t.Parallel()
catalog := BuildCatalog([]discovery.RuntimeServer{
{
Server: market.ServerDescriptor{
Key: "calendar-key",
DisplayName: "日历",
Endpoint: "https://example.com/server/calendar",
},
Tools: []transport.ToolDescriptor{
{
Name: "createEvent",
InputSchema: map[string]any{
"type": "object",
"x-dingtalk-auth": map[string]any{
"version": "v1",
"productCode": "calendar",
"domain": "calendar",
"clientObservedScopes": []any{"Calendar.Event.Write"},
"requiredPermissions": []any{"Calendar.Event.Write"},
"grantProductCodes": []any{"calendar"},
"riskAction": "write",
"authMetaHash": "sha256:test",
},
},
},
},
},
})
tool, ok := catalog.Products[0].FindTool("createEvent")
if !ok {
t.Fatalf("FindTool(createEvent) = not found")
}
if tool.Auth == nil {
t.Fatal("tool.Auth = nil")
}
if tool.Auth.ProductCode != "calendar" {
t.Fatalf("ProductCode = %q, want calendar", tool.Auth.ProductCode)
}
if got := tool.Auth.RequiredPermissions; len(got) != 1 || got[0] != "Calendar.Event.Write" {
t.Fatalf("RequiredPermissions = %#v, want Calendar.Event.Write", got)
}
if got := tool.Auth.GrantProductCodes; len(got) != 1 || got[0] != "calendar" {
t.Fatalf("GrantProductCodes = %#v, want calendar", got)
}
}
func TestBuildCatalogCarriesGrantOnlyAuthMetadata(t *testing.T) {
t.Parallel()
catalog := BuildCatalog([]discovery.RuntimeServer{
{
Server: market.ServerDescriptor{
Key: "calendar-key",
DisplayName: "日历",
Endpoint: "https://example.com/server/calendar",
},
Tools: []transport.ToolDescriptor{
{
Name: "createEvent",
InputSchema: map[string]any{
"type": "object",
"x-dingtalk-auth": map[string]any{
"grantProductCodes": []any{"calendar"},
"recommendedScopes": []any{"calendar.event:create"},
"riskAction": "high-risk-write",
"confirmationRequired": true,
},
},
},
},
},
})
tool, ok := catalog.Products[0].FindTool("createEvent")
if !ok {
t.Fatalf("FindTool(createEvent) = not found")
}
if tool.Auth == nil {
t.Fatal("tool.Auth = nil")
}
if got := tool.Auth.GrantProductCodes; len(got) != 1 || got[0] != "calendar" {
t.Fatalf("GrantProductCodes = %#v, want calendar", got)
}
if got := tool.Auth.RecommendedScopes; len(got) != 1 || got[0] != "calendar.event:create" {
t.Fatalf("RecommendedScopes = %#v, want calendar.event:create", got)
}
if !tool.Auth.ConfirmationRequired {
t.Fatal("ConfirmationRequired = false, want true")
}
}
func TestBuildCatalogFallsBackToProductGrantAuthMetadata(t *testing.T) {
t.Parallel()
catalog := BuildCatalog([]discovery.RuntimeServer{
{
Server: market.ServerDescriptor{
Key: "calendar-key",
DisplayName: "日历",
Endpoint: "https://example.com/server/calendar",
CLI: market.CLIOverlay{
Command: "calendar",
},
},
Tools: []transport.ToolDescriptor{
{
Name: "list_calendar_events",
InputSchema: map[string]any{"type": "object"},
},
},
},
})
tool, ok := catalog.Products[0].FindTool("list_calendar_events")
if !ok {
t.Fatalf("FindTool(list_calendar_events) = not found")
}
if tool.Auth == nil {
t.Fatal("tool.Auth = nil")
}
if tool.Auth.ProductCode != "calendar" {
t.Fatalf("ProductCode = %q, want calendar", tool.Auth.ProductCode)
}
if got := tool.Auth.GrantProductCodes; len(got) != 1 || got[0] != "calendar" {
t.Fatalf("GrantProductCodes = %#v, want calendar", got)
}
if tool.Auth.Source != "dws-product-fallback" {
t.Fatalf("Source = %q, want dws-product-fallback", tool.Auth.Source)
}
}
func TestBuildCatalogCarriesToolOverrideGroupAndFlagOverlay(t *testing.T) {
t.Parallel()
+24
View File
@@ -18,6 +18,8 @@ package keychain
import (
"encoding/base64"
"fmt"
"os"
"path/filepath"
"regexp"
"strings"
"unsafe"
@@ -32,6 +34,28 @@ import (
const regRootPath = `Software\DwsCli\keychain`
// StorageDir returns the storage directory for a given service name on Windows.
// The Windows keychain backend keeps secrets in DPAPI-protected HKCU registry
// values rather than on disk, so this path is used only by the portable
// auth-bundle export/import (internal/auth) to colocate config. When the
// DWS_KEYCHAIN_DIR environment variable is set (used by tests for isolation),
// the storage root is taken from that env var instead; otherwise it defaults
// to %LocalAppData%\<service>.
func StorageDir(service string) string {
if override := os.Getenv(StorageDirEnv); override != "" {
return filepath.Join(override, service)
}
if local := os.Getenv("LocalAppData"); local != "" {
return filepath.Join(local, service)
}
home, err := os.UserHomeDir()
if err != nil || home == "" {
fmt.Fprintf(os.Stderr, "warning: unable to determine home directory: %v\n", err)
return filepath.Join(".dws", "keychain", service)
}
return filepath.Join(home, "AppData", "Local", service)
}
func registryPathForService(service string) string {
return regRootPath + `\` + safeRegistryComponent(service)
}
+99 -7
View File
@@ -33,6 +33,12 @@ import (
const (
defaultBaseURL = "https://mcp.dingtalk.com"
registryMetadataKey = "com.dingtalk.mcp.registry/metadata"
// discoveryAPIPath is the path appended to BaseURL when fetching the
// MCP server list. Kept as a single constant so the version-coded
// segment (".../bamboo") lives in one place and future version bumps
// only touch here. See registry_test.go for the matching fixture path.
discoveryAPIPath = "/cli/discovery/apis/bamboo"
)
type Client struct {
@@ -215,6 +221,19 @@ type CLIToolOverride struct {
// inner slice becomes one cobra.MarkFlagsOneRequired call. Typically
// paired with MutuallyExclusive to enforce "exactly one of".
RequireOneOf [][]string `json:"requireOneOf,omitempty"`
// RequireTogether groups flag aliases that must all be set together (or
// all left unset). Each inner slice becomes one PreRunE cross-field check
// reporting "--a and --b must be set together (or both omitted)". Used
// for envelope-driven leaves where cobra has no first-class operator
// (the only built-in pair APIs are mutually-exclusive / one-required).
// Example: [["start","end"]] on `contact user dismission search`.
RequireTogether [][]string `json:"requireTogether,omitempty"`
// RejectPositional, when true, attaches cobra.NoArgs to the generated
// leaf so any unexpected positional argument is rejected at parse time
// (non-zero exit). Only honored on leaves with no positional bindings;
// leaves declaring `flags.*.positional: true` ignore this field because
// their arity is governed by the positional binding count.
RejectPositional bool `json:"rejectPositional,omitempty"`
// RedirectTo, when non-empty, turns this entry into a stub command that
// prints the redirect target instead of invoking a tool. All other
// fields (Flags / BodyWrapper / IsSensitive / ServerOverride) are
@@ -339,6 +358,46 @@ type CLIFlagOverride struct {
PipelineLocal bool `json:"pipelineLocal,omitempty"`
}
// UnmarshalJSON tolerates discovery overlays that encode a flag's "default" as
// a bool or number (e.g. the sheet server publishes `"default": false`) rather
// than a string. Default is typed as string, and Go's strict decode would fail
// the ENTIRE discovery list on a single mistyped default in ANY product's
// overlay — silently breaking `dws cache refresh` for every product, not just
// the offending one. Coerce scalar defaults to their literal string form so one
// bad envelope can no longer take down discovery.
func (o *CLIFlagOverride) UnmarshalJSON(data []byte) error {
type alias CLIFlagOverride
aux := &struct {
Default json.RawMessage `json:"default,omitempty"`
*alias
}{alias: (*alias)(o)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
o.Default = coerceScalarToString(aux.Default)
return nil
}
// coerceScalarToString renders a JSON scalar (string / bool / number) as a
// plain string; objects, arrays and null collapse to "".
func coerceScalarToString(raw json.RawMessage) string {
s := strings.TrimSpace(string(raw))
if s == "" || s == "null" {
return ""
}
if strings.HasPrefix(s, `"`) {
var str string
if json.Unmarshal(raw, &str) == nil {
return str
}
return ""
}
if strings.HasPrefix(s, "{") || strings.HasPrefix(s, "[") {
return ""
}
return s
}
type CLITool struct {
Name string `json:"name"`
CLIName string `json:"cliName"`
@@ -491,7 +550,7 @@ func (c *Client) FetchServersFromURL(ctx context.Context, fullURL string) (ListR
}
func (c *Client) fetchServersPage(ctx context.Context, limit int, cursor string) (ListResponse, error) {
reqURL, err := url.Parse(c.BaseURL + "/cli/discovery/apis")
reqURL, err := url.Parse(c.BaseURL + discoveryAPIPath)
if err != nil {
return ListResponse{}, apperrors.NewDiscovery("failed to build market servers URL")
}
@@ -647,18 +706,24 @@ func NormalizeServers(response ListResponse, source string) []ServerDescriptor {
descriptor.UpdatedAt = updatedAt
}
existing, exists := bestByEndpoint[descriptor.Key]
// Dedup key includes cli.id when present so that envelopes
// intentionally splitting one MCP endpoint into multiple CLI command
// trees (e.g. bot-root / bot-message / bot-group all serving
// .../server/4717... but exposing different command roots) are not
// collapsed by endpoint-only dedup. Without cli.id the key falls
// back to descriptor.Key (= endpoint) for backwards compatibility.
endpointKey := dedupKeyForEndpoint(descriptor)
existing, exists := bestByEndpoint[endpointKey]
if !exists || descriptorIsNewer(descriptor, existing) {
bestByEndpoint[descriptor.Key] = descriptor
bestByEndpoint[endpointKey] = descriptor
}
}
bestByName := make(map[string]ServerDescriptor)
for _, descriptor := range bestByEndpoint {
nameKey := normalizeDisplayNameKey(descriptor.DisplayName)
if nameKey == "" {
nameKey = descriptor.Key
}
// Same reasoning as endpoint dedup: append cli.id so three bot-*
// entries with displayName "机器人消息" don't collapse into one.
nameKey := dedupKeyForName(descriptor)
existing, exists := bestByName[nameKey]
if !exists || descriptorIsNewer(descriptor, existing) {
bestByName[nameKey] = descriptor
@@ -704,6 +769,33 @@ func normalizeDisplayNameKey(displayName string) string {
return strings.ToLower(strings.TrimSpace(displayName))
}
// dedupKeyForEndpoint returns the dedup key used when collapsing multiple
// envelope entries that share an MCP endpoint. cli.id is appended so an
// endpoint intentionally fronting multiple CLI command roots (bot-root /
// bot-message / bot-group all served by the same MCP server) stays as
// distinct descriptors. When cli.id is empty (or absent), the key is the
// endpoint alone to preserve historical dedup behaviour.
func dedupKeyForEndpoint(descriptor ServerDescriptor) string {
if cliID := strings.TrimSpace(descriptor.CLI.ID); cliID != "" {
return descriptor.Key + "#" + cliID
}
return descriptor.Key
}
// dedupKeyForName mirrors dedupKeyForEndpoint for the second-pass name-based
// dedup so two envelopes with the same displayName but distinct cli.id (the
// bot-* trio shares displayName "机器人消息") remain separate.
func dedupKeyForName(descriptor ServerDescriptor) string {
nameKey := normalizeDisplayNameKey(descriptor.DisplayName)
if nameKey == "" {
nameKey = descriptor.Key
}
if cliID := strings.TrimSpace(descriptor.CLI.ID); cliID != "" {
return nameKey + "#" + cliID
}
return nameKey
}
func markDeprecatedCandidate(displayName string, lifecycle LifecycleInfo) LifecycleInfo {
if lifecycle.DeprecatedCandidate {
return lifecycle
+61 -2
View File
@@ -101,6 +101,65 @@ func TestNormalizeServersDeduplicatesSameNameAcrossEndpoints(t *testing.T) {
}
}
// TestNormalizeServersPreservesDistinctCLIIDsOnSharedEndpoint guards the
// bot-root / bot-message / bot-group split (issue: chat bot subtree vanished
// from the CLI after NormalizeServers collapsed three envelopes that share a
// single MCP endpoint and displayName but expose different cli.id values).
func TestNormalizeServersPreservesDistinctCLIIDsOnSharedEndpoint(t *testing.T) {
t.Parallel()
sharedURL := "https://example.com/server/4717"
sharedName := "机器人消息"
response := ListResponse{
Servers: []ServerEnvelope{
{
Server: RegistryServer{
Name: sharedName,
Remotes: []RegistryRemote{{Type: "streamable-http", URL: sharedURL}},
},
Meta: EnvelopeMeta{
Registry: RegistryMetadata{Status: "active", UpdatedAt: "2026-03-29T00:00:00Z"},
CLI: CLIOverlay{ID: "bot-root", Command: "bot"},
},
},
{
Server: RegistryServer{
Name: sharedName,
Remotes: []RegistryRemote{{Type: "streamable-http", URL: sharedURL}},
},
Meta: EnvelopeMeta{
Registry: RegistryMetadata{Status: "active", UpdatedAt: "2026-03-29T00:00:00Z"},
CLI: CLIOverlay{ID: "bot-message", Command: "message"},
},
},
{
Server: RegistryServer{
Name: sharedName,
Remotes: []RegistryRemote{{Type: "streamable-http", URL: sharedURL}},
},
Meta: EnvelopeMeta{
Registry: RegistryMetadata{Status: "active", UpdatedAt: "2026-03-29T00:00:00Z"},
CLI: CLIOverlay{ID: "bot-group", Command: "group"},
},
},
},
}
servers := NormalizeServers(response, "live_market")
if len(servers) != 3 {
t.Fatalf("NormalizeServers() len = %d, want 3 (one per cli.id)", len(servers))
}
seen := map[string]bool{}
for _, s := range servers {
seen[s.CLI.ID] = true
}
for _, want := range []string{"bot-root", "bot-message", "bot-group"} {
if !seen[want] {
t.Errorf("NormalizeServers() missing descriptor with cli.id %q", want)
}
}
}
func TestNormalizeServersMarksLegacyNameAsDeprecatedCandidate(t *testing.T) {
t.Parallel()
@@ -135,7 +194,7 @@ func TestFetchServers(t *testing.T) {
t.Parallel()
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/cli/discovery/apis" {
if r.URL.Path != "/cli/discovery/apis/bamboo" {
t.Fatalf("unexpected path %q", r.URL.Path)
}
payload := ListResponse{
@@ -172,7 +231,7 @@ func TestFetchServersFollowsNextCursor(t *testing.T) {
t.Parallel()
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/cli/discovery/apis" {
if r.URL.Path != "/cli/discovery/apis/bamboo" {
t.Fatalf("unexpected path %q", r.URL.Path)
}
+438 -40
View File
@@ -29,37 +29,45 @@ import (
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/pkg/edition"
)
const (
sessionIDEnvDingtalk = "DINGTALK_SESSION_ID"
sessionIDEnvDWS = "DWS_SESSION_ID"
sessionIDEnvRewind = "REWIND_SESSION_ID"
)
// resolveSessionIDFromEnv returns the effective session id from environment
// variables. Resolution order:
// 1. DWS_SESSION_ID (primary, stable env name).
// 2. REWIND_SESSION_ID (compatibility alias; kept only so hosts that
// variables. Resolution order matches the MCP header resolver:
// 1. DINGTALK_SESSION_ID (primary gateway header env).
// 2. DWS_SESSION_ID (stable CLI/session-grant env name).
// 3. REWIND_SESSION_ID (compatibility alias; kept only so hosts that
// already inject the legacy trace triple keep working without code
// churn).
//
// When both are set to different non-empty values, DWS_SESSION_ID wins
// silently. We deliberately do NOT log either raw session id value or
// any derived fingerprint: this resolver is invoked by `dws pat chmod`
// session grants, and any stderr / ~/.dws/logs capture of those
// identifiers can land verbatim in attached troubleshooting bundles.
// Hosts that need to detect a mismatch between the two env vars must do
// so on the host side before invoking the CLI.
// When multiple env vars are set to different non-empty values, the first
// one above wins silently. We deliberately do NOT log either raw session id
// value or any derived fingerprint: this resolver is invoked by `dws pat
// chmod` session grants, and any stderr / ~/.dws/logs capture of those
// identifiers can land verbatim in attached troubleshooting bundles. Hosts
// that need to detect a mismatch must do so before invoking the CLI.
func resolveSessionIDFromEnv() string {
if dws := os.Getenv("DWS_SESSION_ID"); dws != "" {
return dws
for _, key := range []string{sessionIDEnvDingtalk, sessionIDEnvDWS, sessionIDEnvRewind} {
if value := os.Getenv(key); value != "" {
return value
}
}
return os.Getenv("REWIND_SESSION_ID")
return ""
}
// agentCodeEnv is the canonical (and only) environment variable name
// used as a per-shell fallback for the --agentCode flag on `dws pat *`
// commands.
//
// Why: agent hosts typically set their business agent code once when
// spawning a long-lived shell / sub-process; requiring `--agentCode` on
// every command in that shell forces the host to rewrite every argv.
// Exposing DINGTALK_DWS_AGENTCODE lets the host export the code once and
// let the CLI resolve it on every pat subcommand. The flag always wins
// when both are set so scripted one-offs remain deterministic.
// Why: agent hosts may set their business agent code once when spawning
// a long-lived shell / sub-process. Exposing DINGTALK_DWS_AGENTCODE lets
// the host export the code once and let the CLI resolve it on every pat
// subcommand. The flag always wins when both are set so scripted one-offs
// remain deterministic. When neither flag nor env is set, the request is
// sent without agentCode and lippi-pat-core applies its default agentCode.
//
// Namespace note: DWS_AGENTCODE / DINGTALK_AGENTCODE / REWIND_AGENTCODE
// are explicitly NOT consumed. The legacy DWS_AGENTCODE alias was
@@ -139,9 +147,18 @@ const (
// patGrantToolName is the English-first wire name for the PAT grant tool.
patGrantToolName = "pat.grant"
// patBatchGrantToolName is the English-first wire name for PAT batch grant.
patBatchGrantToolName = "pat.batch_grant"
// patBatchPlanToolName is the English-first wire name for PAT batch plan.
patBatchPlanToolName = "pat.batch_plan"
// patGrantToolNameLegacyAlias is retained for server builds that still
// expose only the legacy Chinese display name.
patGrantToolNameLegacyAlias = "个人授权"
patBatchUnsupportedCode = "PAT_BATCH_AUTH_UNSUPPORTED"
patBatchUnsupportedCodeLower = "pat_batch_auth_unsupported"
)
var validGrantTypes = map[string]bool{
@@ -155,6 +172,12 @@ var validGrantTypes = map[string]bool{
// var) so multiple RegisterCommands invocations never share mutable flag /
// RunE state across concurrent tests.
func newChmodCommand(c edition.ToolCaller) *cobra.Command {
var recommend bool
var productFlags []string
var productsFlag []string
var domainFlags []string
var domainsFlag []string
chmodCmd := &cobra.Command{
Use: "chmod <scope>...",
Short: "授予指定权限",
@@ -167,33 +190,58 @@ grantType 规则:
once 一次性,执行一次后自动失效
session 当前会话有效(默认),需要 --session-id
permanent 永久有效`,
Args: cobra.MinimumNArgs(1),
Example: ` dws pat chmod aitable.record:read --agentCode agt-xxxx --grant-type session --session-id session-xxx
dws pat chmod chat.message:list --grant-type once --agentCode agt-xxxx
dws pat chmod aitable.record:read aitable.record:write --agentCode agt-xxxx --grant-type permanent`,
Args: func(cmd *cobra.Command, args []string) error {
productCodes := collectChmodProductCodes(productFlags, productsFlag, domainFlags, domainsFlag)
if len(args) > 0 || recommend || len(productCodes) > 0 {
return nil
}
return cobra.MinimumNArgs(1)(cmd, args)
},
Example: ` dws pat chmod aitable.record:read --grant-type session --session-id session-xxx
dws pat chmod chat.message:list --grant-type once
dws pat chmod aitable.record:read aitable.record:write --grant-type permanent
dws pat chmod --products calendar,aitable --grant-type session --session-id session-xxx
dws pat chmod --recommend --grant-type session --session-id session-xxx`,
RunE: func(cmd *cobra.Command, args []string) error {
flagVal, _ := cmd.Flags().GetString("agentCode")
agentCode, err := resolveAgentCode(flagVal, true)
agentCode, err := resolveAgentCode(flagVal, false)
if err != nil {
return err
}
scopes := args
productCodes := collectChmodProductCodes(productFlags, productsFlag, domainFlags, domainsFlag)
usesPlan := recommend || len(productCodes) > 0
grantType, _ := cmd.Flags().GetString("grant-type")
sessionID, _ := cmd.Flags().GetString("session-id")
if sessionID == "" {
sessionID = resolveSessionIDFromEnv()
}
if !validGrantTypes[grantType] {
return fmt.Errorf("invalid --grant-type %q, must be one of: once, session, permanent", grantType)
}
if grantType == "session" && sessionID == "" && resolveSessionIDFromEnv() == "" {
return fmt.Errorf("--session-id is required when --grant-type is session\n hint: dws pat chmod <scope> --agentCode <id> --grant-type session --session-id <id>")
if grantType == "session" && sessionID == "" {
return fmt.Errorf("--session-id is required when --grant-type is session\n hint: dws pat chmod <scope> --grant-type session --session-id <id>")
}
if c != nil && c.DryRun() {
if usesPlan {
planArgs := buildBatchPlanArgs(scopes, productCodes, recommend, grantType, agentCode, sessionID, true)
result, err := callPATBatchPlan(cmd.Context(), c, agentCode, sessionID, planArgs)
if err != nil {
return fmt.Errorf("pat chmod plan failed: %w", err)
}
return handleToolResult(cmd, c, result)
}
bold := color.New(color.FgYellow, color.Bold)
bold.Println("[DRY-RUN] Preview only, not executed:")
fmt.Printf("%-16s%s\n", "Tool:", patGrantToolName)
fmt.Printf("%-16s%s\n", "AgentCode:", agentCode)
fmt.Printf("%-16s%s\n", "Tool:", patBatchGrantToolName)
if agentCode != "" {
fmt.Printf("%-16s%s\n", "AgentCode:", agentCode)
} else {
fmt.Printf("%-16s%s\n", "AgentCode:", "(server default)")
}
fmt.Printf("%-16s%v\n", "Scope:", scopes)
fmt.Printf("%-16s%s\n", "GrantType:", grantType)
if sessionID != "" {
@@ -206,15 +254,34 @@ grantType 规则:
return fmt.Errorf("internal error: tool runtime not initialized")
}
if sessionID == "" {
sessionID = resolveSessionIDFromEnv()
if usesPlan {
planArgs := buildBatchPlanArgs(scopes, productCodes, recommend, grantType, agentCode, sessionID, true)
planResult, err := callPATBatchPlan(cmd.Context(), c, agentCode, sessionID, planArgs)
if err != nil {
return fmt.Errorf("pat chmod plan failed: %w", err)
}
scopes, err = extractSelectedScopes(planResult)
if err != nil {
return err
}
if len(scopes) == 0 {
return handleToolResult(cmd, c, planResult)
}
}
toolArgs := map[string]any{
"agentCode": agentCode,
batchArgs := map[string]any{
"scopes": scopes,
"grantType": grantType,
}
toolArgs := map[string]any{
"scopes": scopes,
"grantType": grantType,
}
if agentCode != "" {
batchArgs["agentCode"] = agentCode
toolArgs["agentCode"] = agentCode
}
if sessionID != "" {
batchArgs["sessionId"] = sessionID
toolArgs["sessionId"] = sessionID
}
// Legacy server schema accepted singular "scope"; clone the
@@ -230,27 +297,214 @@ grantType 规则:
}
ctx := context.Background()
result, err := callPATToolWithLegacyFallback(ctx, c, "pat", patGrantToolName, patGrantToolNameLegacyAlias, toolArgs, legacyToolArgs)
result, err := callPATBatchGrantWithLegacyFallback(
ctx,
c,
agentCode,
sessionID,
batchArgs,
toolArgs,
legacyToolArgs,
)
if err != nil {
return fmt.Errorf("pat chmod failed: %w", err)
}
return handleToolResult(result)
return handleToolResult(cmd, c, result)
},
}
// --agentCode is required, but we deliberately do NOT call
// MarkFlagRequired here. The agent code may also come from the
// DINGTALK_DWS_AGENTCODE env var; cobra's MarkFlagRequired would
// refuse to run before our resolver has a chance to consume the env.
chmodCmd.Flags().String("agentCode", "",
"Agent 唯一标识(必填;亦可通过 env DINGTALK_DWS_AGENTCODE 注入,flag 优先)")
"Agent 唯一标识(可选;不填则由服务端写入默认 AgentCode;env DINGTALK_DWS_AGENTCODE 可注入,flag 优先)")
chmodCmd.Flags().String("grant-type", "session", "授权策略: once|session|permanent")
chmodCmd.Flags().String("session-id", "", "会话标识(session 模式下必填)")
chmodCmd.Flags().StringArrayVar(&productFlags, "product", nil, "产品编码,可重复;与 --products 等价")
chmodCmd.Flags().StringSliceVar(&productsFlag, "products", nil, "产品编码列表,逗号分隔")
chmodCmd.Flags().StringArrayVar(&domainFlags, "domain", nil, "产品域/产品编码,可重复;按产品 scope 模板批量授权")
chmodCmd.Flags().StringSliceVar(&domainsFlag, "domains", nil, "产品域/产品编码列表,逗号分隔")
chmodCmd.Flags().BoolVar(&recommend, "recommend", false, "使用推荐 scope 集合批量授权")
return chmodCmd
}
func collectChmodProductCodes(groups ...[]string) []string {
seen := map[string]bool{}
result := make([]string, 0)
for _, group := range groups {
for _, raw := range group {
for _, part := range strings.Split(raw, ",") {
code := strings.TrimSpace(part)
if code == "" || seen[code] {
continue
}
seen[code] = true
result = append(result, code)
}
}
}
return result
}
func withPATContextEnv(agentCode, sessionID string, fn func() (*edition.ToolResult, error)) (*edition.ToolResult, error) {
restore := map[string]*string{}
setEnv := func(key, value string) {
if value == "" {
return
}
if _, seen := restore[key]; !seen {
if old, ok := os.LookupEnv(key); ok {
oldCopy := old
restore[key] = &oldCopy
} else {
restore[key] = nil
}
}
_ = os.Setenv(key, value)
}
setEnv(agentCodeEnv, agentCode)
setEnv(sessionIDEnvDingtalk, sessionID)
setEnv(sessionIDEnvDWS, sessionID)
defer func() {
for key, old := range restore {
if old == nil {
_ = os.Unsetenv(key)
continue
}
_ = os.Setenv(key, *old)
}
}()
return fn()
}
func callPATBatchGrantWithLegacyFallback(
ctx context.Context,
c edition.ToolCaller,
agentCode string,
sessionID string,
batchArgs map[string]any,
canonicalGrantArgs map[string]any,
legacyGrantArgs map[string]any,
) (*edition.ToolResult, error) {
if c == nil {
return nil, fmt.Errorf("internal error: tool runtime not initialized")
}
result, err := withPATContextEnv(agentCode, sessionID, func() (*edition.ToolResult, error) {
return c.CallTool(ctx, "pat", patBatchGrantToolName, batchArgs)
})
if err == nil && !isPATBatchUnsupportedResult(result) {
return result, nil
}
if err != nil && !isPATBatchUnsupportedError(err) && !isToolNotRegisteredError(err) {
return nil, err
}
return withPATContextEnv(agentCode, sessionID, func() (*edition.ToolResult, error) {
return callPATToolWithLegacyFallback(
ctx,
c,
"pat",
patGrantToolName,
patGrantToolNameLegacyAlias,
canonicalGrantArgs,
legacyGrantArgs,
)
})
}
func callPATBatchPlan(ctx context.Context, c edition.ToolCaller, agentCode, sessionID string, args map[string]any) (*edition.ToolResult, error) {
if c == nil {
return nil, fmt.Errorf("internal error: tool runtime not initialized")
}
return withPATContextEnv(agentCode, sessionID, func() (*edition.ToolResult, error) {
return c.CallTool(ctx, "pat", patBatchPlanToolName, args)
})
}
func buildBatchPlanArgs(scopes []string, productCodes []string, recommend bool, grantType string, agentCode string, sessionID string, dryRun bool) map[string]any {
args := map[string]any{
"scopes": scopes,
"productCodes": productCodes,
"recommend": recommend,
"grantType": grantType,
"dryRun": dryRun,
}
if agentCode != "" {
args["agentCode"] = agentCode
}
if sessionID != "" {
args["sessionId"] = sessionID
}
return args
}
func extractSelectedScopes(result *edition.ToolResult) ([]string, error) {
text := firstToolResultText(result)
if text == "" {
return nil, fmt.Errorf("empty PAT batch plan result")
}
var body map[string]any
if err := json.Unmarshal([]byte(text), &body); err != nil {
return nil, fmt.Errorf("parsing PAT batch plan result: %w", err)
}
data, _ := body["data"].(map[string]any)
if data == nil {
return nil, fmt.Errorf("PAT batch plan result missing data.selectedScopes")
}
rawScopes, _ := data["selectedScopes"].([]any)
if len(rawScopes) == 0 {
if allGranted, _ := data["allGranted"].(bool); allGranted {
return []string{}, nil
}
return nil, fmt.Errorf("PAT batch plan selectedScopes is empty")
}
scopes := make([]string, 0, len(rawScopes))
for _, raw := range rawScopes {
scope, ok := raw.(string)
if ok && strings.TrimSpace(scope) != "" {
scopes = append(scopes, scope)
}
}
if len(scopes) == 0 {
if allGranted, _ := data["allGranted"].(bool); allGranted {
return []string{}, nil
}
return nil, fmt.Errorf("PAT batch plan selectedScopes is empty")
}
return scopes, nil
}
func firstToolResultText(result *edition.ToolResult) string {
if result == nil {
return ""
}
for _, c := range result.Content {
if c.Type == "text" && strings.TrimSpace(c.Text) != "" {
return strings.TrimSpace(c.Text)
}
}
return ""
}
func isPATBatchUnsupportedResult(result *edition.ToolResult) bool {
text := firstToolResultText(result)
if text == "" {
return false
}
var body map[string]any
if json.Unmarshal([]byte(text), &body) != nil {
return false
}
for _, key := range []string{"code", "errorCode", "error_code"} {
if code, ok := body[key].(string); ok && strings.EqualFold(strings.TrimSpace(code), patBatchUnsupportedCode) {
return true
}
}
return false
}
func isPATBatchUnsupportedError(err error) bool {
return err != nil && strings.Contains(normalizedPATErrorText(err), patBatchUnsupportedCodeLower)
}
// callPATToolWithLegacyFallback invokes the canonical PAT grant tool first,
// then silently retries the legacy Chinese alias when the server has not
// registered the canonical tool yet. The retry intentionally emits no stderr
@@ -406,7 +660,7 @@ func containsAny(msg string, needles ...string) bool {
}
// handleToolResult processes a ToolResult and writes output to stdout.
func handleToolResult(result *edition.ToolResult) error {
func handleToolResult(cmd *cobra.Command, caller edition.ToolCaller, result *edition.ToolResult) error {
if result == nil {
return fmt.Errorf("empty tool result")
}
@@ -417,9 +671,153 @@ func handleToolResult(result *edition.ToolResult) error {
if respErr := apperrors.ClassifyMCPResponseText(c.Text); respErr != nil {
return respErr
}
if !shouldEmitRawPATResult(cmd) {
if summary := formatPATAuthorizationSummary(c.Text, caller); summary != "" {
fmt.Print(summary)
return nil
}
}
fmt.Println(c.Text)
return nil
}
data, _ := json.Marshal(result)
return fmt.Errorf("empty PAT authorization result: %s", string(data))
}
func shouldEmitRawPATResult(cmd *cobra.Command) bool {
if commandBoolFlag(cmd, "verbose") {
return true
}
if !commandFlagChanged(cmd, "format") {
return false
}
format := strings.ToLower(strings.TrimSpace(commandStringFlag(cmd, "format")))
return format == "json" || format == "raw"
}
func commandBoolFlag(cmd *cobra.Command, name string) bool {
if cmd == nil {
return false
}
if flag := cmd.Flags().Lookup(name); flag != nil {
value, err := cmd.Flags().GetBool(name)
return err == nil && value
}
root := cmd.Root()
if root == nil {
return false
}
value, err := root.PersistentFlags().GetBool(name)
return err == nil && value
}
func commandFlagChanged(cmd *cobra.Command, name string) bool {
if cmd == nil {
return false
}
if flag := cmd.Flags().Lookup(name); flag != nil && flag.Changed {
return true
}
root := cmd.Root()
if root == nil {
return false
}
flag := root.PersistentFlags().Lookup(name)
return flag != nil && flag.Changed
}
func commandStringFlag(cmd *cobra.Command, name string) string {
if cmd == nil {
return ""
}
if flag := cmd.Flags().Lookup(name); flag != nil {
value, _ := cmd.Flags().GetString(name)
return value
}
root := cmd.Root()
if root == nil {
return ""
}
value, _ := root.PersistentFlags().GetString(name)
return value
}
func formatPATAuthorizationSummary(text string, caller edition.ToolCaller) string {
var body map[string]any
if err := json.Unmarshal([]byte(text), &body); err != nil {
return ""
}
data, _ := body["data"].(map[string]any)
if data == nil {
return ""
}
lines := []string{"PAT authorization"}
if code := stringField(body, "code"); code != "" {
lines = append(lines, "status: "+code)
} else if success, ok := body["success"].(bool); ok {
lines = append(lines, fmt.Sprintf("success: %v", success))
}
if agentCode := stringField(data, "agentCode"); agentCode != "" {
lines = append(lines, "agentCode: "+agentCode)
}
if grantType := stringField(data, "grantType"); grantType != "" {
lines = append(lines, "grantType: "+grantType)
}
if allGranted, ok := data["allGranted"].(bool); ok {
lines = append(lines, fmt.Sprintf("allGranted: %v", allGranted))
}
appendCountLine := func(label, key string) {
if count, ok := countField(data, key); ok {
lines = append(lines, fmt.Sprintf("%s: %d", label, count))
}
}
appendCountLine("items", "items")
appendCountLine("selected", "selectedScopes")
appendCountLine("granted", "grantedScopes")
appendCountLine("alreadyGranted", "alreadyGrantedScopes")
appendCountLine("skipped", "skippedScopes")
appendCountLine("pending", "pendingScopes")
lines = append(lines, "suggestion: "+patAuthorizationSuggestion(data, caller))
lines = append(lines, "hint: use --format json or --verbose for full scope details")
return strings.Join(lines, "\n") + "\n"
}
func patAuthorizationSuggestion(data map[string]any, caller edition.ToolCaller) string {
if allGranted, ok := data["allGranted"].(bool); ok && allGranted {
return "no action needed"
}
if count, ok := countField(data, "selectedScopes"); ok && count > 0 {
if caller != nil && caller.DryRun() {
return "rerun this command without --dry-run to grant selected scopes"
}
return "selected scopes are ready to grant"
}
if count, ok := countField(data, "pendingScopes"); ok && count > 0 {
return "complete authorization, then retry the command"
}
return "check auth status or rerun with --format json for details"
}
func countField(data map[string]any, key string) (int, bool) {
raw, ok := data[key]
if !ok {
return 0, false
}
switch v := raw.(type) {
case []any:
return len(v), true
case []string:
return len(v), true
}
return 0, false
}
func stringField(data map[string]any, key string) string {
if value, ok := data[key].(string); ok {
return strings.TrimSpace(value)
}
return ""
}
+479 -29
View File
@@ -16,6 +16,8 @@ package pat
import (
"context"
"errors"
"io"
"os"
"strings"
"sync"
"testing"
@@ -30,12 +32,15 @@ import (
// assert how the two-tier --agentCode / DINGTALK_DWS_AGENTCODE / error
// resolver feeds into the outgoing MCP argv.
type fakeToolCaller struct {
mu sync.Mutex
dryRun bool
gotTool string
gotArgs map[string]any
callN int
resultOK bool
mu sync.Mutex
dryRun bool
gotTool string
gotArgs map[string]any
gotAgentEnv string
gotSessionEnv string
gotDingSessionEnv string
callN int
resultOK bool
}
func (f *fakeToolCaller) CallTool(_ context.Context, _ string, toolName string, args map[string]any) (*edition.ToolResult, error) {
@@ -43,6 +48,9 @@ func (f *fakeToolCaller) CallTool(_ context.Context, _ string, toolName string,
defer f.mu.Unlock()
f.callN++
f.gotTool = toolName
f.gotAgentEnv = os.Getenv(agentCodeEnv)
f.gotSessionEnv = os.Getenv(sessionIDEnvDWS)
f.gotDingSessionEnv = os.Getenv(sessionIDEnvDingtalk)
// defensive copy — RunE / runApply may mutate the map after return
f.gotArgs = make(map[string]any, len(args))
for k, v := range args {
@@ -187,6 +195,28 @@ func (f *fallbackPATContractErrorToolCaller) CallTool(_ context.Context, _ strin
func (f *fallbackPATContractErrorToolCaller) Format() string { return "json" }
func (f *fallbackPATContractErrorToolCaller) DryRun() bool { return false }
type sequenceToolCaller struct {
calls []recordedToolCall
responses []string
dryRun bool
}
func (s *sequenceToolCaller) CallTool(_ context.Context, _ string, toolName string, args map[string]any) (*edition.ToolResult, error) {
copied := make(map[string]any, len(args))
for k, v := range args {
copied[k] = v
}
s.calls = append(s.calls, recordedToolCall{tool: toolName, args: copied})
response := `{"success":true,"data":{}}`
if len(s.responses) >= len(s.calls) {
response = s.responses[len(s.calls)-1]
}
return &edition.ToolResult{Content: []edition.ContentBlock{{Type: "text", Text: response}}}, nil
}
func (s *sequenceToolCaller) Format() string { return "json" }
func (s *sequenceToolCaller) DryRun() bool { return s.dryRun }
func stringSliceArgEqual(got any, want []string) bool {
gotSlice, ok := got.([]string)
if !ok || len(gotSlice) != len(want) {
@@ -200,6 +230,25 @@ func stringSliceArgEqual(got any, want []string) bool {
return true
}
func captureStdout(t *testing.T, fn func() error) (string, error) {
t.Helper()
oldStdout := os.Stdout
readPipe, writePipe, err := os.Pipe()
if err != nil {
t.Fatalf("os.Pipe error = %v", err)
}
os.Stdout = writePipe
runErr := fn()
_ = writePipe.Close()
os.Stdout = oldStdout
out, readErr := io.ReadAll(readPipe)
_ = readPipe.Close()
if readErr != nil {
t.Fatalf("ReadAll stdout error = %v", readErr)
}
return string(out), runErr
}
// buildChmod returns a freshly constructed chmod cobra.Command wired to
// fake. Using the factory (instead of a package-level var) keeps every
// subtest hermetic and matches the upstream shared-state fix in PR #129.
@@ -208,6 +257,266 @@ func buildChmod(t *testing.T, fake *fakeToolCaller) *cobra.Command {
return newChmodCommand(fake)
}
func TestRegisterCommands_OnlyExposesChmodForAuthorization(t *testing.T) {
root := &cobra.Command{Use: "dws"}
RegisterCommands(root, &fakeToolCaller{})
patCmd, _, err := root.Find([]string{"pat"})
if err != nil {
t.Fatalf("pat command not found: %v", err)
}
children := map[string]bool{}
for _, child := range patCmd.Commands() {
children[child.Name()] = true
}
if !children["chmod"] {
t.Fatal("pat chmod command not registered")
}
for _, unexpected := range []string{"grant-batch", "grant-recommend", "scopes", "check"} {
if children[unexpected] {
t.Fatalf("unexpected pat subcommand %q registered; authorization must stay on chmod", unexpected)
}
}
}
func TestChmod_productsFlagPlansThenGrantsSelectedScopes(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
fake := &sequenceToolCaller{responses: []string{
`{"success":true,"data":{"selectedScopes":["calendar.event:read","aitable.record:read"]}}`,
`{"success":true,"data":{"grantedScopes":["calendar.event:read","aitable.record:read"]}}`,
}}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("grant-type", "once")
_ = cmd.Flags().Set("products", "calendar,aitable")
if err := cmd.RunE(cmd, nil); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if len(fake.calls) != 2 {
t.Fatalf("CallTool count = %d, want 2", len(fake.calls))
}
if fake.calls[0].tool != patBatchPlanToolName {
t.Fatalf("first tool = %q, want %q", fake.calls[0].tool, patBatchPlanToolName)
}
if got := fake.calls[0].args["productCodes"]; !stringSliceArgEqual(got, []string{"calendar", "aitable"}) {
t.Fatalf("productCodes = %#v, want calendar/aitable", got)
}
if got := fake.calls[0].args["recommend"]; got != false {
t.Fatalf("recommend = %#v, want false", got)
}
if got := fake.calls[0].args["agentCode"]; got != "qoderwork" {
t.Fatalf("plan agentCode = %#v, want qoderwork", got)
}
if fake.calls[1].tool != patBatchGrantToolName {
t.Fatalf("second tool = %q, want %q", fake.calls[1].tool, patBatchGrantToolName)
}
if got := fake.calls[1].args["scopes"]; !stringSliceArgEqual(got, []string{"calendar.event:read", "aitable.record:read"}) {
t.Fatalf("grant scopes = %#v, want selected scopes", got)
}
if got := fake.calls[1].args["agentCode"]; got != "qoderwork" {
t.Fatalf("grant agentCode = %#v, want qoderwork", got)
}
}
func TestChmod_productsSessionModePassesSessionIDToPlanAndGrant(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
fake := &sequenceToolCaller{responses: []string{
`{"success":true,"data":{"selectedScopes":["calendar.event:read"]}}`,
`{"success":true,"data":{"grantedScopes":["calendar.event:read"]}}`,
}}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("products", "calendar")
_ = cmd.Flags().Set("session-id", "session-123")
if err := cmd.RunE(cmd, nil); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if len(fake.calls) != 2 {
t.Fatalf("CallTool count = %d, want 2", len(fake.calls))
}
if got := fake.calls[0].args["grantType"]; got != "session" {
t.Fatalf("plan grantType = %#v, want session", got)
}
if got := fake.calls[0].args["sessionId"]; got != "session-123" {
t.Fatalf("plan sessionId = %#v, want session-123", got)
}
if got := fake.calls[0].args["agentCode"]; got != "qoderwork" {
t.Fatalf("plan agentCode = %#v, want qoderwork", got)
}
if got := fake.calls[1].args["grantType"]; got != "session" {
t.Fatalf("grant grantType = %#v, want session", got)
}
if got := fake.calls[1].args["sessionId"]; got != "session-123" {
t.Fatalf("grant sessionId = %#v, want session-123", got)
}
if got := fake.calls[1].args["agentCode"]; got != "qoderwork" {
t.Fatalf("grant agentCode = %#v, want qoderwork", got)
}
}
func TestChmod_productsDryRunUsesSessionIDFromEnv(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
t.Setenv(sessionIDEnvDWS, "env-session-123")
fake := &sequenceToolCaller{
dryRun: true,
responses: []string{
`{"success":true,"data":{"selectedScopes":["calendar.event:read"]}}`,
},
}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("products", "calendar")
if err := cmd.RunE(cmd, nil); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if len(fake.calls) != 1 {
t.Fatalf("CallTool count = %d, want 1", len(fake.calls))
}
if fake.calls[0].tool != patBatchPlanToolName {
t.Fatalf("plan tool = %q, want %q", fake.calls[0].tool, patBatchPlanToolName)
}
if got := fake.calls[0].args["sessionId"]; got != "env-session-123" {
t.Fatalf("plan sessionId = %#v, want env-session-123", got)
}
if got := fake.calls[0].args["agentCode"]; got != "qoderwork" {
t.Fatalf("plan agentCode = %#v, want qoderwork", got)
}
}
func TestResolveSessionIDFromEnvMatchesHeaderPriority(t *testing.T) {
t.Setenv(sessionIDEnvDingtalk, "ding-session")
t.Setenv(sessionIDEnvDWS, "dws-session")
t.Setenv(sessionIDEnvRewind, "rewind-session")
if got := resolveSessionIDFromEnv(); got != "ding-session" {
t.Fatalf("resolveSessionIDFromEnv() = %q, want DINGTALK_SESSION_ID", got)
}
t.Setenv(sessionIDEnvDingtalk, "")
if got := resolveSessionIDFromEnv(); got != "dws-session" {
t.Fatalf("resolveSessionIDFromEnv() = %q, want DWS_SESSION_ID", got)
}
t.Setenv(sessionIDEnvDWS, "")
if got := resolveSessionIDFromEnv(); got != "rewind-session" {
t.Fatalf("resolveSessionIDFromEnv() = %q, want REWIND_SESSION_ID", got)
}
}
func TestChmod_sessionModeUsesDingtalkSessionEnv(t *testing.T) {
t.Setenv(sessionIDEnvDingtalk, "ding-session-123")
fake := &fakeToolCaller{resultOK: true}
cmd := buildChmod(t, fake)
if err := cmd.RunE(cmd, []string{"aitable.record:read"}); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if got := fake.gotArgs["sessionId"]; got != "ding-session-123" {
t.Fatalf("sessionId arg = %#v, want ding-session-123", got)
}
if fake.gotDingSessionEnv != "ding-session-123" {
t.Fatalf("%s during CallTool = %q, want ding-session-123", sessionIDEnvDingtalk, fake.gotDingSessionEnv)
}
if fake.gotSessionEnv != "ding-session-123" {
t.Fatalf("%s during CallTool = %q, want ding-session-123", sessionIDEnvDWS, fake.gotSessionEnv)
}
}
func TestChmod_explicitSessionIDOverridesStaleDingtalkSessionEnv(t *testing.T) {
t.Setenv(sessionIDEnvDingtalk, "stale-session")
fake := &fakeToolCaller{resultOK: true}
cmd := buildChmod(t, fake)
_ = cmd.Flags().Set("session-id", "flag-session")
if err := cmd.RunE(cmd, []string{"aitable.record:read"}); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if got := fake.gotArgs["sessionId"]; got != "flag-session" {
t.Fatalf("sessionId arg = %#v, want flag-session", got)
}
if fake.gotDingSessionEnv != "flag-session" {
t.Fatalf("%s during CallTool = %q, want flag-session", sessionIDEnvDingtalk, fake.gotDingSessionEnv)
}
if fake.gotSessionEnv != "flag-session" {
t.Fatalf("%s during CallTool = %q, want flag-session", sessionIDEnvDWS, fake.gotSessionEnv)
}
}
func TestChmod_recommendFlagPlansThenGrantsWithoutPositionalScopes(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
fake := &sequenceToolCaller{responses: []string{
`{"success":true,"data":{"selectedScopes":["recommended.scope:read"]}}`,
`{"success":true,"data":{"grantedScopes":["recommended.scope:read"]}}`,
}}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("grant-type", "once")
_ = cmd.Flags().Set("recommend", "true")
if err := cmd.RunE(cmd, nil); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if len(fake.calls) != 2 {
t.Fatalf("CallTool count = %d, want 2", len(fake.calls))
}
if fake.calls[0].tool != patBatchPlanToolName {
t.Fatalf("first tool = %q, want %q", fake.calls[0].tool, patBatchPlanToolName)
}
if got := fake.calls[0].args["recommend"]; got != true {
t.Fatalf("recommend = %#v, want true", got)
}
if fake.calls[1].tool != patBatchGrantToolName {
t.Fatalf("second tool = %q, want %q", fake.calls[1].tool, patBatchGrantToolName)
}
}
func TestChmod_productsAllGrantedStopsAfterPlan(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
fake := &sequenceToolCaller{responses: []string{
`{"success":true,"data":{"allGranted":true,"selectedScopes":[]}}`,
}}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("grant-type", "once")
_ = cmd.Flags().Set("products", "calendar")
if err := cmd.RunE(cmd, nil); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if len(fake.calls) != 1 {
t.Fatalf("CallTool count = %d, want only plan call", len(fake.calls))
}
if fake.calls[0].tool != patBatchPlanToolName {
t.Fatalf("first tool = %q, want %q", fake.calls[0].tool, patBatchPlanToolName)
}
}
func TestChmod_explicitScopesDryRunShowsBatchGrantTool(t *testing.T) {
t.Setenv(agentCodeEnv, "qoderwork")
fake := &fakeToolCaller{dryRun: true}
cmd := newChmodCommand(fake)
_ = cmd.Flags().Set("grant-type", "once")
output, err := captureStdout(t, func() error {
return cmd.RunE(cmd, []string{"aitable.record:read"})
})
if err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if !strings.Contains(output, patBatchGrantToolName) {
t.Fatalf("dry-run output = %q, want %q", output, patBatchGrantToolName)
}
if strings.Contains(output, patGrantToolName+"\n") {
t.Fatalf("dry-run output = %q, must not advertise legacy %q", output, patGrantToolName)
}
}
// ---------------------------------------------------------------------------
// T1 · Agent-code env fallback tests
// ---------------------------------------------------------------------------
@@ -227,8 +536,14 @@ func TestChmod_agentCode_env_fallback(t *testing.T) {
t.Fatalf("chmod RunE error = %v (must not report flag missing)", err)
}
if fake.gotTool != patBatchGrantToolName {
t.Fatalf("gotTool = %q, want %q", fake.gotTool, patBatchGrantToolName)
}
if got := fake.gotAgentEnv; got != "qoderwork" {
t.Fatalf("agent env = %q, want %q", got, "qoderwork")
}
if got := fake.gotArgs["agentCode"]; got != "qoderwork" {
t.Fatalf("agentCode in argv = %v, want %q (env fallback)", got, "qoderwork")
t.Fatalf("batch argv agentCode = %#v, want qoderwork", got)
}
if got := fake.gotArgs["scopes"]; !stringSliceArgEqual(got, []string{"aitable.record:read"}) {
t.Fatalf("scopes in argv = %#v, want %#v", got, []string{"aitable.record:read"})
@@ -238,6 +553,30 @@ func TestChmod_agentCode_env_fallback(t *testing.T) {
}
}
func TestChmod_withoutAgentCodeUsesServerDefault(t *testing.T) {
t.Setenv(agentCodeEnv, "")
fake := &fakeToolCaller{resultOK: true}
cmd := buildChmod(t, fake)
_ = cmd.Flags().Set("grant-type", "once")
if err := cmd.RunE(cmd, []string{"aitable.record:read"}); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if fake.gotTool != patBatchGrantToolName {
t.Fatalf("gotTool = %q, want %q", fake.gotTool, patBatchGrantToolName)
}
if got := fake.gotAgentEnv; got != "" {
t.Fatalf("agent env = %q, want empty so server default agentCode is used", got)
}
if _, ok := fake.gotArgs["agentCode"]; ok {
t.Fatalf("batch argv must omit agentCode when caller leaves it unset: %#v", fake.gotArgs)
}
if got := fake.gotArgs["scopes"]; !stringSliceArgEqual(got, []string{"aitable.record:read"}) {
t.Fatalf("scopes in argv = %#v, want %#v", got, []string{"aitable.record:read"})
}
}
func TestCallPATToolWithLegacyFallback_emptyCanonicalResultDoesNotRetryLegacyAlias(t *testing.T) {
fake := &fallbackToolCaller{}
canonicalArgs := map[string]any{
@@ -288,8 +627,8 @@ func TestChmod_emptyCanonicalResultReturnsError(t *testing.T) {
if len(fake.calls) != 1 {
t.Fatalf("CallTool call count = %d, want 1", len(fake.calls))
}
if fake.calls[0].tool != patGrantToolName {
t.Fatalf("first tool = %q, want %q", fake.calls[0].tool, patGrantToolName)
if fake.calls[0].tool != patBatchGrantToolName {
t.Fatalf("first tool = %q, want %q", fake.calls[0].tool, patBatchGrantToolName)
}
}
@@ -467,8 +806,27 @@ func TestIsToolNotRegisteredError_ChineseGatewayDiagnostics(t *testing.T) {
}
}
func TestIsPATBatchUnsupportedResultCaseInsensitive(t *testing.T) {
result := &edition.ToolResult{Content: []edition.ContentBlock{{Type: "text", Text: `{"success":false,"errorCode":"pat_batch_auth_unsupported"}`}}}
if !isPATBatchUnsupportedResult(result) {
t.Fatal("isPATBatchUnsupportedResult() = false, want true")
}
}
func TestIsPATBatchUnsupportedErrorUsesNormalizedDiagnostics(t *testing.T) {
err := apperrors.NewAPI("business error: success=false",
apperrors.WithReason("business_error"),
apperrors.WithServerDiag(apperrors.ServerDiagnostics{
ServerErrorCode: "PAT_BATCH_AUTH_UNSUPPORTED",
}),
)
if !isPATBatchUnsupportedError(err) {
t.Fatal("isPATBatchUnsupportedError() = false, want true")
}
}
func TestHandleToolResult_emptyResultReturnsError(t *testing.T) {
err := handleToolResult(&edition.ToolResult{})
err := handleToolResult(nil, nil, &edition.ToolResult{})
if err == nil {
t.Fatal("handleToolResult error = nil, want empty PAT authorization result error")
}
@@ -477,6 +835,100 @@ func TestHandleToolResult_emptyResultReturnsError(t *testing.T) {
}
}
func TestHandleToolResult_defaultSummarizesBatchPlan(t *testing.T) {
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().String("format", "json", "")
cmd := &cobra.Command{Use: "chmod"}
root.AddCommand(cmd)
result := &edition.ToolResult{Content: []edition.ContentBlock{{Type: "text", Text: `{
"success": true,
"code": "OK",
"data": {
"agentCode": "ding-agent",
"allGranted": false,
"items": [
{"scope": "calendar.event:list"},
{"scope": "calendar.event:create"}
],
"selectedScopes": ["calendar.event:create"],
"skippedScopes": ["calendar.event:list"],
"pendingScopes": []
}
}`}}}
output, err := captureStdout(t, func() error {
return handleToolResult(cmd, &sequenceToolCaller{dryRun: true}, result)
})
if err != nil {
t.Fatalf("handleToolResult error = %v", err)
}
for _, want := range []string{
"PAT authorization",
"status: OK",
"agentCode: ding-agent",
"allGranted: false",
"items: 2",
"selected: 1",
"skipped: 1",
"pending: 0",
"suggestion: rerun this command without --dry-run to grant selected scopes",
} {
if !strings.Contains(output, want) {
t.Fatalf("summary output missing %q: %s", want, output)
}
}
if strings.Contains(output, "calendar.event:create") || strings.Contains(output, `"items"`) {
t.Fatalf("summary output leaked raw item details: %s", output)
}
}
func TestHandleToolResult_explicitJSONKeepsRawPayload(t *testing.T) {
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().String("format", "json", "")
cmd := &cobra.Command{Use: "chmod"}
root.AddCommand(cmd)
if err := root.PersistentFlags().Set("format", "json"); err != nil {
t.Fatalf("set format error = %v", err)
}
text := `{"success":true,"code":"OK","data":{"items":[{"scope":"calendar.event:create"}],"selectedScopes":["calendar.event:create"]}}`
result := &edition.ToolResult{Content: []edition.ContentBlock{{Type: "text", Text: text}}}
output, err := captureStdout(t, func() error {
return handleToolResult(cmd, &sequenceToolCaller{dryRun: true}, result)
})
if err != nil {
t.Fatalf("handleToolResult error = %v", err)
}
if !strings.Contains(output, `"items"`) || !strings.Contains(output, "calendar.event:create") {
t.Fatalf("explicit json output did not preserve raw payload: %s", output)
}
if strings.Contains(output, "PAT authorization") {
t.Fatalf("explicit json output must not be summarized: %s", output)
}
}
func TestHandleToolResult_verboseKeepsRawPayload(t *testing.T) {
root := &cobra.Command{Use: "dws"}
root.PersistentFlags().Bool("verbose", false, "")
cmd := &cobra.Command{Use: "chmod"}
root.AddCommand(cmd)
if err := root.PersistentFlags().Set("verbose", "true"); err != nil {
t.Fatalf("set verbose error = %v", err)
}
text := `{"success":true,"code":"OK","data":{"items":[{"scope":"calendar.event:create"}]}}`
result := &edition.ToolResult{Content: []edition.ContentBlock{{Type: "text", Text: text}}}
output, err := captureStdout(t, func() error {
return handleToolResult(cmd, &sequenceToolCaller{}, result)
})
if err != nil {
t.Fatalf("handleToolResult error = %v", err)
}
if !strings.Contains(output, `"items"`) || !strings.Contains(output, "calendar.event:create") {
t.Fatalf("verbose output did not preserve raw payload: %s", output)
}
}
// TestChmod_agentCode_env_invalid verifies that a malformed
// DINGTALK_DWS_AGENTCODE value (whitespace, shell metacharacters) is
// rejected by the regex gate in validateAgentCode before any MCP call
@@ -519,17 +971,21 @@ func TestChmod_agentCode_flag_wins_over_env(t *testing.T) {
if err := cmd.RunE(cmd, []string{"aitable.record:read"}); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if fake.gotTool != patBatchGrantToolName {
t.Fatalf("gotTool = %q, want %q", fake.gotTool, patBatchGrantToolName)
}
if got := fake.gotAgentEnv; got != "flagval" {
t.Fatalf("agent env = %q, want %q (flag must win over env)", got, "flagval")
}
if got := fake.gotArgs["agentCode"]; got != "flagval" {
t.Fatalf("agentCode in argv = %v, want %q (flag must win over env)", got, "flagval")
t.Fatalf("batch argv agentCode = %#v, want flagval", got)
}
}
// TestChmod_agentCode_legacy_env_not_recognized is a reverse-guard: after
// the SSOT hard-removal of the DWS_AGENTCODE alias, exporting only the
// legacy env MUST NOT satisfy the --agentCode requirement. The command
// is expected to fail with an error that explicitly names the canonical
// DINGTALK_DWS_AGENTCODE env, and MUST NOT mention DWS_AGENTCODE as a
// usable fallback. No MCP call is permitted.
// legacy env MUST NOT be consumed. The command is still allowed to run,
// omits agentCode, and lets lippi-pat-core write its default agentCode.
func TestChmod_agentCode_legacy_env_not_recognized(t *testing.T) {
t.Setenv(agentCodeEnv, "")
t.Setenv("DWS_AGENTCODE", "legacyval")
@@ -538,23 +994,17 @@ func TestChmod_agentCode_legacy_env_not_recognized(t *testing.T) {
cmd := buildChmod(t, fake)
_ = cmd.Flags().Set("grant-type", "once")
err := cmd.RunE(cmd, []string{"aitable.record:read"})
if err == nil {
t.Fatalf("expected hard error when only legacy DWS_AGENTCODE is set, got nil")
if err := cmd.RunE(cmd, []string{"aitable.record:read"}); err != nil {
t.Fatalf("chmod RunE error = %v", err)
}
if !strings.Contains(err.Error(), "DINGTALK_DWS_AGENTCODE") {
t.Fatalf("error = %q, want to name canonical DINGTALK_DWS_AGENTCODE env", err.Error())
if fake.callN != 1 {
t.Fatalf("CallTool was invoked %d times, want 1", fake.callN)
}
// Defensive: the canonical env naturally contains the substring
// "DWS_AGENTCODE" as part of "DINGTALK_DWS_AGENTCODE"; the above
// assertion plus the absence check below precisely guard against
// advertising the legacy alias as usable.
hint := strings.ReplaceAll(err.Error(), "DINGTALK_DWS_AGENTCODE", "")
if strings.Contains(hint, "DWS_AGENTCODE") {
t.Fatalf("error = %q must not advertise DWS_AGENTCODE as usable", err.Error())
if got := fake.gotAgentEnv; got != "" {
t.Fatalf("agent env = %q, want empty; legacy DWS_AGENTCODE must not be consumed", got)
}
if fake.callN != 0 {
t.Fatalf("CallTool was invoked %d times; legacy env must not satisfy --agentCode", fake.callN)
if _, ok := fake.gotArgs["agentCode"]; ok {
t.Fatalf("batch argv must omit agentCode when only legacy env is set: %#v", fake.gotArgs)
}
}
+2 -2
View File
@@ -34,8 +34,8 @@ func RegisterCommands(root *cobra.Command, c edition.ToolCaller) {
dws pat browser-policy 配置 PAT 浏览器打开策略
能力说明:
--format 只控制 PAT 撞墙时的输出形态;当 --format json 时,
CLI 只返回结构化 JSON,不混入非结构化文本。
pat chmod 默认输出轻量授权摘要;显式 --format json / --verbose 时,
才返回服务端完整 JSON(含逐 scope 明细),便于机器校验。
浏览器是否打开由本地 PAT 策略单独决定,与 json / non-json 独立。
生效时会优先按 DINGTALK_DWS_AGENTCODE 读取 agent 策略,再回退到默认策略。
写入 agent 策略需显式传 --agentCode;不传则写入全局默认策略。
+1 -1
View File
@@ -39,7 +39,7 @@ personas:
- name: ops-analyst
title: 运营分析师
description: "围绕数据与运营流程执行:表格、听记、邮件与应用协同。"
services: [aitable, minutes, mail, aiapp, drive, doc]
services: [aitable, minutes, mail, drive, doc]
workflows: [minutes-to-todo, drive-upload-and-announce]
instructions:
- "先获取原始数据,再做结构化汇总与分发。"
+253
View File
@@ -0,0 +1,253 @@
// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package asynctask 封装"提交 → 渐进式退避轮询 → (可选) 下载"模式,复用给
// doc export / sheet export / aitable export 三个产品。
//
// 设计要点:
//
// 1. 调用方只需提供"提交"和"查询状态"两个回调,循环逻辑由本包处理
// 2. 渐进式退避(1s/2s/5s/10s/15s/30s/30s...,可自定义)
// 3. 默认 5 分钟超时,超时返回 jobId 让用户用 `... get --job-id <ID>` 续等
// 4. 状态机统一:PROCESSING/PENDING → SUCCESS → 拿 downloadUrl
// ↓
// FAILED → 返回 error
// 5. 可选 PUT 下载:传入 OutputPath 时本包负责 HTTP GET 落盘
package asynctask
import (
"context"
"errors"
"fmt"
"io"
"net/http"
"os"
"time"
)
// Status 表示异步任务的状态。
type Status string
const (
StatusProcessing Status = "PROCESSING"
StatusPending Status = "PENDING"
StatusSuccess Status = "SUCCESS"
StatusFailed Status = "FAILED"
StatusTimeout Status = "TIMEOUT" // 本地超时(非服务端状态)
)
// SubmitFunc 是"提交任务"回调,返回 jobId 或 error。
type SubmitFunc func(ctx context.Context) (jobID string, err error)
// QueryResult 是 QueryFunc 的返回。
//
// - Status 状态枚举
// - DownloadURL 服务端返回的下载链接(仅 SUCCESS 时有效)
// - Message 失败原因 / 进度描述
// - Raw 原始响应(用于调用方在最终输出里附带)
type QueryResult struct {
Status Status
DownloadURL string
Message string
Raw map[string]any
}
// QueryFunc 是"查询任务状态"回调。
type QueryFunc func(ctx context.Context, jobID string) (QueryResult, error)
// Options 控制 WaitWithBackoff 的行为。
type Options struct {
// Backoff 是页间退避序列(毫秒)。零值或空使用 DefaultBackoff。
// 序列耗尽后保持最后一个间隔继续轮询。
Backoff []time.Duration
// Timeout 是整体轮询上限。零值使用 DefaultTimeout(5 分钟)。
Timeout time.Duration
// ProgressFn 是每轮查询后的进度回调(可选)。用于打印 "[2/30] processing..."
// 之类的 stderr 提示。
ProgressFn func(attempt int, status Status, elapsed time.Duration)
}
var (
// DefaultBackoff 是渐进式退避序列:1s/2s/5s/10s/15s/30s,之后稳定 30s。
// 与悟空 wukong/products/aitable.go / doc.go 对齐。
DefaultBackoff = []time.Duration{
1 * time.Second,
2 * time.Second,
5 * time.Second,
10 * time.Second,
15 * time.Second,
30 * time.Second,
}
// DefaultTimeout 是默认超时上限。
DefaultTimeout = 5 * time.Minute
)
// FinalResult 是 WaitWithBackoff 的最终返回。
type FinalResult struct {
JobID string
Status Status
DownloadURL string
Message string
Raw map[string]any
Attempts int
Elapsed time.Duration
}
// Submit 提交任务并轮询直到完成 / 失败 / 超时。
//
// 行为:
// 1. 调用 submitFn 拿到 jobID
// 2. 进入轮询循环:按 backoff 序列等待 → 调 queryFn → 检查状态
// 3. SUCCESS → 返回 FinalResult.Status = SUCCESS + downloadURL
// 4. FAILED → 返回 FinalResult.Status = FAILED + Message(不抛 error,让调用方决定)
// 5. PROCESSING/PENDING → 继续轮询
// 6. 超过 Timeout → 返回 FinalResult.Status = TIMEOUT + JobID(调用方可提示用户用 ... get --job-id <ID>)
// 7. ctx 取消 → 返回带 ctx.Err() 的 error
func Submit(ctx context.Context, submitFn SubmitFunc, queryFn QueryFunc, opts Options) (FinalResult, error) {
jobID, err := submitFn(ctx)
if err != nil {
return FinalResult{}, fmt.Errorf("submit failed: %w", err)
}
if jobID == "" {
return FinalResult{}, errors.New("submit returned empty jobID")
}
return Resume(ctx, jobID, queryFn, opts)
}
// Resume 接续轮询已知 jobID 的任务(提交步骤已完成)。
// 用于 `... export get --job-id <ID>` 兜底命令。
func Resume(ctx context.Context, jobID string, queryFn QueryFunc, opts Options) (FinalResult, error) {
backoff := opts.Backoff
if len(backoff) == 0 {
backoff = DefaultBackoff
}
timeout := opts.Timeout
if timeout == 0 {
timeout = DefaultTimeout
}
deadline := time.Now().Add(timeout)
start := time.Now()
attempt := 0
var lastErr error
for {
attempt++
// 超时检查前置:保证 Timeout < backoff[0] 也能正常返回 TIMEOUT,不会卡在 sleep
if time.Now().After(deadline) {
msg := fmt.Sprintf("task did not complete within %v; resume with the original jobID %s", timeout, jobID)
if lastErr != nil {
msg += fmt.Sprintf(" (last query error: %v)", lastErr)
}
return FinalResult{
JobID: jobID,
Status: StatusTimeout,
Message: msg,
Attempts: attempt - 1,
Elapsed: time.Since(start),
}, nil
}
// 等待间隔(首次也等,避免提交后立即查询,给服务端处理时间)
// sleep 长度上限取 deadline 剩余时间,避免 sleep 后再发现已超时
interval := backoff[len(backoff)-1] // 序列耗尽后用最后一个
if attempt-1 < len(backoff) {
interval = backoff[attempt-1]
}
if remain := time.Until(deadline); remain > 0 && interval > remain {
interval = remain
}
select {
case <-ctx.Done():
return FinalResult{JobID: jobID, Attempts: attempt, Elapsed: time.Since(start)}, ctx.Err()
case <-time.After(interval):
}
qr, err := queryFn(ctx, jobID)
if err != nil {
// 单次查询失败不立即放弃,下一轮重试;保存 error 给最后兜底(superseded
// by 下次成功;timeout 时会把它附到 Message 帮助排查)
lastErr = err
if opts.ProgressFn != nil {
opts.ProgressFn(attempt, "", time.Since(start))
}
continue
}
lastErr = nil
if opts.ProgressFn != nil {
opts.ProgressFn(attempt, qr.Status, time.Since(start))
}
switch qr.Status {
case StatusSuccess:
return FinalResult{
JobID: jobID,
Status: StatusSuccess,
DownloadURL: qr.DownloadURL,
Message: qr.Message,
Raw: qr.Raw,
Attempts: attempt,
Elapsed: time.Since(start),
}, nil
case StatusFailed:
return FinalResult{
JobID: jobID,
Status: StatusFailed,
Message: qr.Message,
Raw: qr.Raw,
Attempts: attempt,
Elapsed: time.Since(start),
}, nil
case StatusProcessing, StatusPending, "":
// 继续轮询(空字符串容错:部分上游可能 status 缺失)
continue
default:
// 未知状态:当作 processing 继续等
continue
}
}
}
// Download 把 downloadURL 的内容 GET 到本地 outputPath。
// 单独抽出来便于调用方在不调 Submit 时也能复用(例如 sheet export 已有 jobId 的场景)。
func Download(ctx context.Context, downloadURL, outputPath string) error {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, downloadURL, nil)
if err != nil {
return fmt.Errorf("build download request: %w", err)
}
client := &http.Client{Timeout: 5 * time.Minute}
resp, err := client.Do(req)
if err != nil {
return fmt.Errorf("download failed: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
body, _ := io.ReadAll(io.LimitReader(resp.Body, 512))
return fmt.Errorf("download HTTP %d: %s", resp.StatusCode, string(body))
}
f, err := os.Create(outputPath)
if err != nil {
return fmt.Errorf("create output file: %w", err)
}
defer f.Close()
if _, err := io.Copy(f, resp.Body); err != nil {
return fmt.Errorf("write output: %w", err)
}
return nil
}
+163
View File
@@ -0,0 +1,163 @@
// Copyright 2026 Alibaba Group
// SPDX-License-Identifier: Apache-2.0
package asynctask
import (
"context"
"errors"
"testing"
"time"
)
// 用极小 backoff 加速测试
var testBackoff = []time.Duration{1 * time.Millisecond, 2 * time.Millisecond, 5 * time.Millisecond}
func TestSubmit_HappyPath(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "job-1", nil }
calls := 0
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
calls++
if calls < 3 {
return QueryResult{Status: StatusProcessing}, nil
}
return QueryResult{Status: StatusSuccess, DownloadURL: "https://example/x.docx"}, nil
}
res, err := Submit(context.Background(), submitFn, queryFn, Options{
Backoff: testBackoff,
Timeout: 1 * time.Second,
})
if err != nil {
t.Fatalf("err: %v", err)
}
if res.Status != StatusSuccess || res.DownloadURL != "https://example/x.docx" {
t.Fatalf("got: %+v", res)
}
if res.Attempts != 3 {
t.Fatalf("attempts: %d", res.Attempts)
}
}
func TestSubmit_Failed(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "job-2", nil }
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
return QueryResult{Status: StatusFailed, Message: "INVALID_NODE"}, nil
}
res, _ := Submit(context.Background(), submitFn, queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if res.Status != StatusFailed || res.Message != "INVALID_NODE" {
t.Fatalf("got: %+v", res)
}
}
func TestSubmit_Timeout(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "job-3", nil }
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
return QueryResult{Status: StatusProcessing}, nil
}
res, err := Submit(context.Background(), submitFn, queryFn, Options{
Backoff: testBackoff,
Timeout: 10 * time.Millisecond, // 故意很短
})
if err != nil {
t.Fatalf("err: %v", err)
}
if res.Status != StatusTimeout {
t.Fatalf("expect TIMEOUT, got: %+v", res)
}
if res.JobID != "job-3" {
t.Fatalf("job id lost: %s", res.JobID)
}
}
func TestSubmit_QueryRetry(t *testing.T) {
// 模拟单次 query 失败但下次成功的场景:本包应该忽略单次失败继续轮询
submitFn := func(ctx context.Context) (string, error) { return "job-4", nil }
calls := 0
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
calls++
if calls == 1 {
return QueryResult{}, errors.New("transient 502")
}
return QueryResult{Status: StatusSuccess, DownloadURL: "ok"}, nil
}
res, err := Submit(context.Background(), submitFn, queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if err != nil || res.Status != StatusSuccess {
t.Fatalf("transient retry: %+v err=%v", res, err)
}
}
func TestSubmit_SubmitError(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "", errors.New("auth fail") }
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) { return QueryResult{}, nil }
_, err := Submit(context.Background(), submitFn, queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if err == nil {
t.Fatal("expected submit error")
}
}
func TestResume_AlreadyHasJobID(t *testing.T) {
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
if jobID != "preexisting-job" {
t.Fatalf("jobID lost: %s", jobID)
}
return QueryResult{Status: StatusSuccess, DownloadURL: "ok"}, nil
}
res, err := Resume(context.Background(), "preexisting-job", queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if err != nil || res.Status != StatusSuccess {
t.Fatalf("resume: %+v err=%v", res, err)
}
}
func TestSubmit_ContextCancel(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
submitFn := func(ctx context.Context) (string, error) { return "job-x", nil }
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) { return QueryResult{Status: StatusProcessing}, nil }
_, err := Submit(ctx, submitFn, queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if !errors.Is(err, context.Canceled) {
t.Fatalf("expect ctx.Canceled, got %v", err)
}
}
func TestSubmit_ProgressCallback(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "job-5", nil }
calls := 0
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
calls++
if calls < 2 {
return QueryResult{Status: StatusProcessing}, nil
}
return QueryResult{Status: StatusSuccess}, nil
}
var seenStatuses []Status
progress := func(attempt int, status Status, elapsed time.Duration) {
seenStatuses = append(seenStatuses, status)
}
_, _ = Submit(context.Background(), submitFn, queryFn, Options{
Backoff: testBackoff,
Timeout: 1 * time.Second,
ProgressFn: progress,
})
if len(seenStatuses) < 2 {
t.Fatalf("progress not called enough: %v", seenStatuses)
}
if seenStatuses[len(seenStatuses)-1] != StatusSuccess {
t.Fatalf("final status not seen: %v", seenStatuses)
}
}
func TestSubmit_UnknownStatusKeepsPolling(t *testing.T) {
submitFn := func(ctx context.Context) (string, error) { return "job-6", nil }
calls := 0
queryFn := func(ctx context.Context, jobID string) (QueryResult, error) {
calls++
if calls < 3 {
return QueryResult{Status: "WEIRD_STATUS"}, nil
}
return QueryResult{Status: StatusSuccess}, nil
}
res, _ := Submit(context.Background(), submitFn, queryFn, Options{Backoff: testBackoff, Timeout: 1 * time.Second})
if res.Status != StatusSuccess {
t.Fatalf("unknown status not handled: %+v", res)
}
}

Some files were not shown because too many files have changed in this diff Show More