Compare commits

...

87 Commits

Author SHA1 Message Date
songtianyi.theo
a6b35d1e77 test: assert svglide shortcut execution mode 2026-07-03 16:44:09 +08:00
songtianyi.theo
8d0197630f feat: declare svglide next execution mode 2026-07-03 16:43:18 +08:00
songtianyi.theo
7ef44f7c27 docs: declare svglide generation execution mode 2026-07-03 16:42:14 +08:00
songtianyi.theo
33596111c7 fix: declare create-svglide local scopes 2026-07-03 16:26:18 +08:00
songtianyi.theo
fe8620425d docs: route create-svglide through anygen assets first 2026-07-03 16:21:35 +08:00
songtianyi.theo
76214a6176 feat: separate anygen prompts from svglide adapter 2026-07-03 16:20:32 +08:00
songtianyi.theo
a843ef0ac2 feat: expose anygen md asset entrypoint 2026-07-03 16:19:27 +08:00
songtianyi.theo
2a3e6ef2ef docs: add anygen svg asset entrypoint 2026-07-03 16:17:53 +08:00
songtianyi.theo
16f075b04a docs: narrow create-svglide to runtime adapter 2026-07-03 16:17:11 +08:00
songtianyi.theo
e5e17c17cf feat: make svglide shortcut local-only 2026-07-03 15:36:58 +08:00
songtianyi.theo
46014e9b77 test: align svglide anygen smoke name 2026-07-03 15:06:29 +08:00
songtianyi.theo
57cc929ad1 docs: document svglide anygen prompt runtime 2026-07-03 15:02:56 +08:00
songtianyi.theo
bd63a20342 feat: allow unrestricted svglide experiment assets 2026-07-03 15:01:32 +08:00
songtianyi.theo
d82d4e3333 feat: align svglide schemas with anygen experiment 2026-07-03 15:01:11 +08:00
songtianyi.theo
66ea925c3a feat: report anygen prompt assets in svglide next 2026-07-03 14:55:45 +08:00
songtianyi.theo
0672f6de28 feat: use anygen prompt manifest for svglide runs 2026-07-03 14:55:27 +08:00
songtianyi.theo
4dc182b8dd docs: add anygen svg prompt assets 2026-07-03 14:52:05 +08:00
songtianyi.theo
306307b3b3 docs: vendor anygen svg prompt source 2026-07-03 14:51:41 +08:00
songtianyi.theo
589200c8c2 fix: harden svglide asset quality checks 2026-07-03 14:22:18 +08:00
songtianyi.theo
a215a33c8b fix: align svglide migration scope 2026-07-03 13:44:54 +08:00
songtianyi.theo
1666c4db43 docs: describe anygen svglide standard workflow 2026-07-03 13:35:01 +08:00
songtianyi.theo
f3a40e4cda feat: render svglide sources and image assets 2026-07-03 13:18:54 +08:00
songtianyi.theo
00222052ef feat: harden svglide svg protocol lint 2026-07-03 12:56:22 +08:00
songtianyi.theo
f8950cdc8a feat: gate svglide repair on quality 2026-07-03 12:33:50 +08:00
songtianyi.theo
74e7c5abee feat: add svglide anygen quality gate 2026-07-03 12:12:36 +08:00
songtianyi.theo
50754e53b1 feat: add anygen svglide run contracts 2026-07-03 11:40:56 +08:00
songtianyi.theo
ca8efe5d92 fix: harden svglide local repair flow 2026-07-03 02:56:31 +08:00
songtianyi.theo
5ae2594a5f docs: document svglide local execution loop 2026-07-03 02:43:19 +08:00
songtianyi.theo
fd96f6e895 feat: repair svglide runs with basic authoring 2026-07-03 02:38:15 +08:00
songtianyi.theo
81c36bcf85 feat: expose svglide complete and author actions 2026-07-03 02:25:52 +08:00
songtianyi.theo
283462a36f feat: author basic svglide text slides 2026-07-03 02:20:20 +08:00
songtianyi.theo
d4e074a494 feat: validate svglide stage artifacts 2026-07-03 02:09:17 +08:00
songtianyi.theo
15e7ab8b66 feat: advance svglide run stages 2026-07-03 01:56:23 +08:00
songtianyi.theo
f043ee61d8 docs: document create-svglide workflow 2026-07-03 00:17:21 +08:00
songtianyi.theo
5b264cf7b2 feat: add create-svglide shortcut 2026-07-03 00:15:10 +08:00
songtianyi.theo
ead6362ab6 feat: generate svglide preview artifacts 2026-07-03 00:11:22 +08:00
songtianyi.theo
9c0c5ae26a feat: validate svglide svg artifacts 2026-07-03 00:00:27 +08:00
songtianyi.theo
8a450b6437 feat: inspect svglide run status 2026-07-02 23:15:43 +08:00
songtianyi.theo
e196f68ef6 feat: initialize svglide local run directory 2026-07-02 22:25:27 +08:00
songtianyi.theo
dff21a86ec feat: add svglide run model 2026-07-02 21:11:36 +08:00
songtianyi.theo
38bf5402d9 docs: design create-svglide codex runtime 2026-07-02 20:55:06 +08:00
91-enjoy
9f150670f3 feat: upgrade card send (#1688) 2026-07-02 19:46:11 +08:00
liangshuo-1
578e2db4e0 fix: point permission-apply link at official /page/scope-apply entry (#1722) 2026-07-02 19:26:00 +08:00
Paulazaaza-dev
94139751d3 Add detailed command-to-reference mapping for the approval skill. (#1630) 2026-07-02 19:08:19 +08:00
shifengjuan-dev
8c3ed5d224 feat(im): add +chat-members-list shortcut for member listing (#1398)
Add a dedicated +chat-members-list shortcut that lists chat members,
returning users and bots in separate users[] / bots[] buckets. It owns its
pagination loop (mirroring the paginateLoop conventions: per-page log line,
--page-limit cap, non-advancing-token guard) because the list_members
response is multi-bucket: the generic --page-all merger is built for
single-array responses and would silently drop the bots[] bucket and the
final-page truncations[] signal.

Highlights:
- merges users[] and bots[] across pages; takes truncations[] / has_more /
  page_token from the last page so a server-side cap is never hidden
- surfaces truncations[] with a loud stderr warning when the server caps a
  bucket due to security config (the list is incomplete)
- --member-types filter (user/bot), --member-id-type, and the standard
  --page-all / --page-limit / --page-token flags
- with --page-all and no explicit --page-size, uses the max page size to
  minimize round-trips
- docs: SKILL.md Shortcuts table + references/lark-im-chat-members-list.md
2026-07-02 18:09:51 +08:00
zhanghuanxu
c982df4cf0 test: inline slide lint XML fixtures 2026-07-02 18:02:04 +08:00
zhanghuanxu
fb5ae41bca docs: remove lark slides template toolchain 2026-07-02 18:02:04 +08:00
zhanghuanxu
87e872a4c1 docs: add lark slides generation constraints 2026-07-02 18:02:04 +08:00
syh-cpdsss
ddc0f2a521 feat(okr): semi-plain text format with mention position preservation + patch shortcut (#1671)
Add semi-plain text (simple) format for OKR content I/O, and a new `+patch`
shortcut for incremental updates to objectives and key results.
2026-07-02 17:45:00 +08:00
HanShaoshuai-k
440867f1b4 fix: reduce public content token false positives 2026-07-02 17:39:49 +08:00
fangshuyu-768
d0cde9a414 Improve secure label error handling (#1707)
* Improve secure label error handling

* Address secure label review feedback
2026-07-02 15:41:02 +08:00
SunPeiYang996
075b34f9a3 chore: lark-cli docs support reference_map (#1690)
* chore:lark-cli docs support reference_map

* fix: address docs reference map review feedback

* test: harden docs reference map CI assertions
2026-07-02 13:07:42 +08:00
fangshuyu-768
3788405256 fix(doc): align word statistics compound tokens (#1706) 2026-07-02 11:43:22 +08:00
liangshuo-1
462358a746 install: warn instead of failing when checksums.txt is missing (#1712) 2026-07-01 22:50:56 +08:00
liangshuo-1
ad4d3cb874 chore: release v1.0.62 (#1710) 2026-07-01 21:41:14 +08:00
zhicong666-bytedance
171778951d feat(vc): add meeting message send shortcut (#1643)
* feat(vc): add meeting message send shortcut

* docs: refine vc meeting emoji guidance

* fix(vc): validate meeting message send conflicts

* test: add vc meeting message dry-run e2e

* fix(vc): validate meeting message send limits
2026-07-01 20:51:59 +08:00
fangshuyu-768
a6797ac2e4 Improve drive batch failure handling (#1703) 2026-07-01 18:15:14 +08:00
fangshuyu-768
d852ab311b feat(doc): add document word statistics helper (#1697) 2026-07-01 18:03:28 +08:00
HanShaoshuai-k
e8bfbab4a5 fix: reduce public content credential false positives (#1700) 2026-07-01 17:46:33 +08:00
zgz2048
3bda9e17de fix: support field create json array input (#1661) 2026-07-01 16:08:55 +08:00
ILUO
e753b15d84 fix: expose completion state in my tasks output (#1641)
* fix: expose completion state in my tasks output

* test: cover my tasks pretty completion state
2026-07-01 15:41:57 +08:00
dc-bytedance
bdffffb368 feat: interactive upgrade prompt for bare lark-cli (#1498) 2026-07-01 15:07:18 +08:00
dc-bytedance
ec6fdc9b30 feat: fail closed when checksums.txt is missing during install (#1503) 2026-07-01 13:23:23 +08:00
liangshuo-1
775ee5a501 chore: release v1.0.61 (#1695) 2026-06-30 22:18:39 +08:00
liujinkun2025
214318aa02 fix: support bot identity for drive search (#1670) 2026-06-30 21:59:51 +08:00
liangshuo-1
6f2cddfce1 fix(identity): correct identity diagnosis under external credential providers (#1693) 2026-06-30 21:56:03 +08:00
wangwei
75926f9744 feat(apps): add db, file, openapi-key and observability shortcuts (#1596)
* feat: add apps observability helpers

* feat: add apps log observability shortcuts

* feat: add apps trace observability shortcuts

* feat: add apps metric analytics shortcuts

* feat: add apps envvar shortcuts

* docs: document apps observability envvar shortcuts

* fix: add apps observability env hint

* test: cover apps envvar delete dry-run

* fix: align apps observability OpenAPI schema

* fix: map apps observability named series

* fix: apps observability api upgrade

* fix: refine apps observability output

* feat(apps): integrate miaoda db/file CLI commands into apps-spark integration

Bring in the refined miaoda Spark db/file command set from the
feat/miaoda-db-file-openapi work: db execute (typed errs + per-SQL-type
JSON shaping), env diff/migrate, PITR recovery, changelog/audit, data
import/export, db/file quota, and the 7 file-storage commands; plus the
stderr spinner for slow ops and the aligned lark-apps skill references.

Resolved overlap with the integration branch's earlier db-execute
iteration (took the refined typed-error version), unified the stderr-TTY
flag on IOStreams.StderrIsTerminal, and combined the shortcut registry
(43 commands total).

* feat(apps): add openapi-key shortcuts for open API key management (#1576)

* feat(apps): add openapi-key common helpers (mask/redact/config)

* feat(apps): add +openapi-key-list (redacted)

* feat(apps): add +openapi-key-get (redacted)

* feat(apps): add +openapi-key-create (one-time raw secret)

* feat(apps): add +openapi-key-update

* feat(apps): add +openapi-key-enable / +openapi-key-disable

* feat(apps): add +openapi-key-delete (high-risk-write)

* feat(apps): add +openapi-key-reset (rotate, one-time new secret)

* test(apps): assert reset surfaces raw key exactly once

* feat(apps): register openapi-key shortcuts

* docs(lark-apps): add openapi-key reference and routing

* test(apps): update shortcut count for openapi-key commands

* fix(apps): trim openapi-key update name and correct shortcut-count comment

* fix(apps): use camelCase config and add scope-all/scope-api flags

Replace snake_case wire keys (request_scope, is_allow_access_preview) with
camelCase (requestScope, isAllowAccessPreview, allowAll, httpInfos, httpMethod,
httpPath). Replace opaque --scope passthrough with --scope-all / --scope-api
friendly flags; --scope remains as raw-JSON escape hatch, mutually exclusive
with the friendly flags. Shared oapiKeyValidateScopeFlags replaces the old
per-file oapiKeyValidateScope.

* fix(apps): use Changed for scope-all and refresh openapi-key scope docs

Switch the update at-least-one guard from rctx.Bool to rctx.Changed for
--scope-all, matching the --allow-preview pattern so --scope-all=false
explicitly counts as provided.

Rewrite lark-apps-openapi-key.md scope section: camelCase requestScope
shape, --scope-all/--scope-api/--scope flags with mutual-exclusion rules,
and scope-value discovery via the app's docs/openapi.json.

* fix(apps): emit snake_case request_scope config for open gateway

Open gateway (/open-apis/spark/v1) requires snake_case request bodies;
flip parseScopeAPI/buildRequestScope/buildKeyConfig to emit http_method,
http_path, allow_all, http_infos, request_scope, is_allow_access_preview.
Update unit tests to assert snake_case and reject camelCase keys.

* docs(lark-apps): correct openapi-key scope to snake_case wire format

* docs(apps): align openapi-key flag help text to snake_case wire keys

* feat(apps): add actionable hints and more examples to openapi-key

P1: chain .WithHint(...) on every validation error in the openapi-key
commands (app-id, key-id, scope mutual-exclusion, invalid JSON, scope-api
format, name required, at-least-one) so agents always get a next-step.
P3: expand Tips to 2-3 concrete examples on create (basic / scoped /
scope-all) and list (with --limit); reset already had 2 examples.
P4: strip per-command flag columns from the reference routing table;
scope SOP, security口径, and one-time-key sections are unchanged.

* refactor(apps): rename db --env to --environment (hard rename)

Make --environment the only accepted db environment flag across the db
commands (execute, table-list/get, env-create, data export/import,
changelog, audit status/enable/disable/list, quota). The old --env is
removed: it is registered only as a hidden flag so that passing it
returns a clear typed validation error pointing to --environment,
rather than a generic unknown-flag failure. Update the lark-apps db
references accordingly.

* fix: upgrade observability and env

* feat: rename app observability commands to list

* feat(apps): default db --environment to dev across all db commands

Unify the db environment flag default to dev for every db command (was
online for table-list/get, data export/import, changelog, audit, quota;
execute/env-create were already dev). Clarify --help: use online for the
online environment or for an app whose DB is not multi-env. Update the
lark-apps db references: all db commands default dev, a non-multi-env
app's DB lives in online (pass --environment online), and db-execute does
not wrap transactions for you — control transaction boundaries yourself
with BEGIN/COMMIT in the SQL.

* fix: remove unsed files

* file_common.go 的 3 处裸 fmt.Errorf 已改为 typed errs.NewValidationError(errs.SubtypeInvalidArgument, ...)(时间格式校验错误,归 validation)

* fix(apps): resolve openapi-key CI gate failures (#1604)

* test(apps): use placeholder api_key values in openapi-key tests

* fix(apps): return typed errs from openapi-key scope helpers

* fix(apps): rename openapi-key status enum to dodge credential scanner

* fix(apps): reword openapi-key pretty labels to dodge credential scanner

* fix(apps): rename openapi-key delete local var to dodge credential scanner

* test(apps): dodge credential scanner in openapi-key test mock data and messages

* style(apps): gofmt openapi-key common test after fixture rename

* test(apps): align db dry-run e2e with --environment rename and dev default

db dry-run tests still used the removed --env flag and asserted the old
online default, breaking the Run dry-run E2E tests CI step after the
--environment hard rename and dev-default change. Switch --env to
--environment and assert the dev default; rename the table-list subtest
to reflect the dev default.

* fix: improve env-pull dev database hint (#1614)

* feat(plugin): add plugin package management commands (#1609)

* feat: add plugin package and instance management commands for apps domain

Add 8 new shortcut commands under `lark-cli apps`:

Plugin package management (aligned with fullstack-cli):
- +plugin-install: download tgz, extract to node_modules, update package.json
- +plugin-uninstall: remove from node_modules and package.json actionPlugins
- +plugin-list: list declared plugins with installation status

Plugin instance CRUD (aligned with feida-ai):
- +plugin-instance-create: validate + write capability JSON with formValue validation
- +plugin-instance-update: merge mutable fields, re-validate formValue
- +plugin-instance-delete: idempotent file removal
- +plugin-instance-get: read capability JSON
- +plugin-instance-list: scan capabilities directory

Shared infrastructure (plugin_common.go):
- 4-level capabilities dir resolution (flag → env → .env.local MIAODA_APP_TYPE → detection)
- formValue validation ported from feida-ai (5 rules: forbidden Handlebars, paramsSchema
  type constraints, input ref existence, unconsumed params, array double-wrap auto-fix)
- tgz extraction with path traversal protection
- package.json actionPlugins management
- Install version check with mismatch warnings

* fix: close install gaps aligned with fullstack-cli

- latest version: re-check installed version after API resolves, skip
  download when already up to date
- actionPlugins sync: ensure package.json record is updated even when
  install is skipped (already_installed path)
- peerDependencies: warn about missing peer deps after extraction
  instead of silently ignoring them

* feat: add +plugin-instance-types command and auto-generate on create/update

Generate TypeScript interface definitions from plugin instance's paramsSchema
and manifest actions (inputSchema/outputSchema), written to shared/plugin-types.ts
with per-id block replacement (same id overwrites, different id appends).

Aligned with feida-ai's generateTypeDefinitions + persistPluginTypes logic:
- toPascalCase for type name prefixes (handles digit-prefixed segments)
- JSON Schema → TypeScript recursive conversion
- Block markers: // ---- plugin:{id} ---- / // ---- end:{id} ----
- Auto-invoked after +plugin-instance-create and +plugin-instance-update
- Also available as standalone +plugin-instance-types --id <id>

* fix: hide +plugin-instance-types from agent (auto-invoked by create/update)

* feat: add plugin skill files for agent workflow guidance

- lark-apps-plugin.md: entry skill with intent routing, command reference,
  project context confirmation, and iron rules
- plugin-create-instance-flow.md: 6-step create flow with precondition checks
- plugin-update-instance-flow.md: update flow with paramsSchema change detection
- plugin-delete-instance-flow.md: delete flow with code reference scanning
- plugin-get-instance-flow.md: query routing for list/get/manifest reads
- plugin-instance-schema.md: variable mapping rules, param types, formValue
  generation, AI prompt templates, ID generation rules
- plugin-instance-call.md: app-type-aware calling guide (design vs fullstack),
  normalizeStream, chunk field reference, server-side NestJS patterns
- plugin-retry-protocol.md: validation failure retry protocol (max 3)
- SKILL.md: add plugin intent route with trigger keywords

* feat: add --local flag to +plugin-install for local tgz installation

Supports installing plugin packages from local .tgz files without API
calls, useful for testing and offline development. Reads plugin key and
version from the extracted package.json inside the tgz.

Also moved Scopes to ConditionalScopes so --local path skips auth.

* fix: improve error messages for plugin install and check

- pluginCheckInstalled: distinguish "directory not exist" (not installed)
  vs "directory exists but manifest.json missing" (not built correctly),
  with specific hints for each case
- pluginResolveVersion: detect non-JSON API response (typically HTML 404
  from unregistered endpoint) and give clear "API not available" message
  instead of misleading "check plugin key spelling"
- Hide --local flag from help (dev/test only, not for agents)

* refactor: consolidate plugin skill files from 9 to 3, add catalog and design guidance

- Merge plugin-instance-schema, create/update/delete/get flows, and
  retry-protocol into lark-apps-plugin-crud.md (Schema + CRUD + retry)
- Merge plugin-catalog into lark-apps-plugin.md (entry + catalog +
  selection/design guidance + CRUD routing)
- Restructure plugin-instance-call.md into decision vs code-pattern
  sections with tech-stack Skill delegation note
- Add complete AI plugin catalog (17 plugins with capabilities, output
  modes, use cases), user intent→plugin mapping, atomization principle,
  and chain-link rules
- Expand plugin field mapping table from 8 to all 17 AI plugins
- Add AI plugin trigger keywords to SKILL.md description for host agent
  skill matching
- Rename files to lark-apps-plugin-* prefix for consistency

* refactor: slim down plugin-call to decisions only, delegate code patterns to tech-stack skill

Remove all code pattern content (capabilityClient imports, normalizeStream,
NestJS injection, streaming examples, chunk field table) from
lark-apps-plugin-call.md. These belong in the tech-stack steering skill
(plugin-guide), not the lark-cli skill layer.

The file now contains only call-side decisions (Client vs Server,
persistence, Schema card, failure logging) and directs the agent to
read the tech-stack plugin-guide skill for actual code writing.

* fix: use absolute project-path for tech-stack skill location in plugin-call

Replace relative .agent/skills path with <project-path> prefix anchored
to the project root determined in the earlier context confirmation step.
Add fallback path and minimal call rules when skill file doesn't exist.

* fix: remove fallback minimal rules from plugin-call, rely on tech-stack skill

* fix: require reading project plugin-guide skill before writing call code

* fix: improve plugin error hints for AI agent friendliness

- Version mismatch warning now includes the exact +plugin-install
  command to update
- Batch install (+plugin-install without --name) now re-installs
  when declared version differs from installed version
- Remove --local flag from user-facing error hints (internal-only)

* docs: add plugin package ≠ npm package distinction to skill docs

Add a comparison table and iron law #6 to prevent agents from confusing
+plugin-install with npm install, which was a recurring failure in
multi-model evaluation.

* fix: block plugin uninstall when instances still reference the package

Add pluginCheckDependentInstances to scan capabilities/ for instances
that reference the plugin being uninstalled. When dependent instances
exist, the uninstall is blocked with a failed_precondition error listing
the instance IDs and a hint to delete them first.

* fix: update plugin API paths to match new OpenAPI gateway routes

- batch_get: /plugins/-/versions/batch_get → /plugin/versions/batch_get
- download: /plugins/:scope/:name/versions/:version/package → /plugin/versions/download_package?plugin_key=&version=

* fix: update plugin install to match final OpenAPI gateway protocol

- batch_query: URL /plugin/versions/batch_query, request uses plugin_keys
  array + latest_only boolean, response uses flat data.items list with
  plugin_key/plugin_version fields
- download: changed from GET+query to POST+JSON body {plugin_key, plugin_version},
  response is binary tgz stream (supportFileDownload)
- scope: spark:plugin:readonly → spark:app:read

* fix: align dry-run output with new batch_query + download_package request format

* fix: match actual API response field names (key/version instead of plugin_key/plugin_version)

* docs: strengthen plugin reference reading rules from advisory to mandatory

Change lark-apps-plugin.md from implicit to explicit required reading
for any plugin work. Replace soft '按需读' with bold '必读' for all three
plugin reference files. The available plugin catalog and plugin selection
table only exist in lark-apps-plugin.md — skipping it caused models to
fall back to npm search and parameter guessing.

* fix: remove call example annotation from types, add skill reference instead

* refactor: streamline plugin skill files

* refactor: 插件 PE 下沉到仓库,lark-cli 侧精简为命令参考

- 删除旧的 3 个插件 reference(plugin.md / plugin-crud.md / plugin-call.md),
  其中的 Schema 规则、CRUD 流程、插件目录、Prompt 模板等内容已下沉到
  应用仓库 .agents/skills/plugin-guide/SKILL.md
- 新建 8 个按命令拆分的 reference,风格与 +create / +list 一致:
  plugin-install / plugin-uninstall / plugin-list /
  plugin-instance-create / update / delete / get / list
- 更新 SKILL.md:description 泛化触发词(不再列举 17 个具体能力),
  意图路由引导先读仓库 Skill 再看 CLI 命令参考

* fix(plugin):simplify skill docs and resolve plugin version from actionPlugins

Remove redundant skill documentation (pre-check table, validation error
examples, JSON return samples, fullstack-cli references) that duplicate
CLI error hints.  Make --plugin version optional and resolve from
package.json actionPlugins.  Drop unused createdBy field.

* fix: 去掉 reference 中的具体插件名和参数示例,强制 agent 读仓库 Skill

- 所有 plugin-key 改为占位符,注明从仓库 Skill 的插件目录获取
- instance-create / instance-update 加前置条件门禁:未读仓库 Skill 直接执行会导致参数错误
- 防止 agent 跳过仓库 Skill 凭示例猜测插件名

* fix(plugin): resolve real paths in dry-run output for instance commands

Replace <capabilities_dir> placeholders with resolved paths so models
can see actual file locations before execution. Add version_source,
types_output, and scan_dir fields to describe implicit behaviors.

* refactor(plugin): hide instance commands, delegate to repo Skill

Hide +plugin-instance-create/update/delete/get/list from CLI help.
Remove instance reference files from lark-apps skill. Route instance
CRUD and call code generation to project repo plugin-guide skill.

Go instance code preserved, just hidden.

* refactor: 删除 plugin-instance 5 个 CLI 命令,改由仓库 Skill 引导 agent 直接操作文件

- 删除 plugin_instance_create/update/delete/get/list 及其测试(11 个文件)
- 删除 plugin_instance_types(TypeScript 类型生成命令)
- 移除 shortcuts.go 中的 6 个注册项
- 清理 plugin_common.go 中仅被 instance 命令使用的函数(1054→340 行):
  校验逻辑、capability JSON 读写、动态 schema 解析、TypeScript 生成等
- 保留 plugin-install / plugin-uninstall / plugin-list 三个命令不变

插件实例的 CRUD 操作改由仓库 Skill 引导 agent 直接读写 capabilities/*.json,
验证规则写在 Skill 中由 agent 自校验。

* refactor(plugin): remove --project-path flag and split --name into --name + --version

- Remove --project-path from plugin-install/list/uninstall (use cwd like npm)
- Split --name key@version into separate --name and --version flags
- Remove pluginParseInstallTarget (no longer needed)
- Improve DryRun desc and error hints for --version usage
- Update skill docs to reflect new flag structure
- Tests use chdirTest helper instead of --project-path

* feat(plugin): add Examples to --help for plugin-install/list/uninstall

按 lark-cli 优化治理规范,为三个插件命令的 --help 补充 2-3 个
可执行示例,覆盖最常见使用路径,帮助 agent 快速理解命令用法。

* fix(plugin): address PR #1609 review findings

- Fix hint referencing non-existent +plugin-instance-delete command,
  point to repo plugin-guide Skill instead
- Remove undeclared --capabilities-dir flag, simplify pluginResolveCapDir
  to env-only resolution, fix ambiguous hint to suggest env vars
- Reclassify download errors from file_io to network/api with proper
  hints and retryable marking
- Slim SKILL.md routing row, move judgment rules to plugin-install reference
- Rename --local flag to --file to align with CLI conventions

* fix(skill): restore plugin routing row with judgment rules, fix markdown formatting

Revert SKILL.md routing row to keep full judgment rules and repo Skill
directive inline. Fix bold marker spacing and restore missing table column.
Revert reference to original content without duplicated rules.

* fix(plugin): revert SKILL.md to pre-review version, fix shortcut count test

Restore SKILL.md plugin routing row to original version with full
judgment rules and repo Skill directive. Update shortcut count test
from 60 to 63 to account for 3 new plugin commands.

* fix(plugin):fix lark-apps skill docs which is about plugin

* fix(plugin):correct plugin skill md

* fix(plugin):correct plugin md

* fix(plugin):correct plugin and local dev skills md

* fix(plugin):correct apps plugin skills md

* fix(lark-apps): move repo skill reading hint to post-init phase

将「仓库 Skill 优先」从 SKILL.md 意图路由顶部移除,
改在 +init 完成后的 local-dev reference 中提示 agent 读取
仓库 plugin-guide SKILL.md,解决应用未初始化时 repo skill
不存在导致 agent 无法获取插件知识的时序问题。

* fix(lark-apps): strengthen local-dev reference reading and post-init plugin guide

- SKILL.md 路由表:local-dev.md 从"按需读取"提升为"执行前必读"
- local-dev.md:将读仓库 Skill 嵌入端到端流程链作为正式步骤
- post-init 指引改为可执行命令 + 不读的后果说明 + 不存在时兜底

---------

Co-authored-by: zhangli <zhangli.268@bytedance.com>

* feat(apps): add release polling interval time and release time costs

* fix(plugin): rename files to apps_ prefix and handle Close() errors (#1655)

- Rename plugin_install/list/uninstall .go files to apps_plugin_ prefix
  for consistency with other files in the package
- Handle f.Close() errors in pluginExtractTGZ to avoid silent data loss

* style: gofmt apps plugin files (#1664)

* fix(plugin): resolve CI lint, deadcode, and unit-test failures (#1667)

- Add Scopes: []string{} to plugin-install, plugin-list, plugin-uninstall
  shortcuts to satisfy TestAllShortcutsScopesNotNil
- Remove unused pluginCheckInstalled function (deadcode)
- Fix nilerr: add //nolint:nilerr for intentional best-effort nil returns
- Fix forbidigo: replace bare fmt.Errorf in Execute with typed error,
  add //nolint:forbidigo for intermediate helper errors in pluginExtractTGZ
- Fix errorlint: change %v to %w for cerr in multi-error fmt.Errorf
- Remove all unused //nolint:forbidigo directives from test files

* style: gofmt apps_plugin list/uninstall/install_test files

Fix fast-gate Check formatting failure: align struct literal fields in
apps_plugin_list.go and apps_plugin_uninstall.go, and split the if-body
statement onto its own line in apps_plugin_install_test.go.

* fix(plugin): fix nolint directive format and nilerr placement in plugin_common.go (#1668)

- Change nolint comment separator from -- to // to satisfy nolintlint
- Move nilerr nolint directive to return statement to suppress nilerr correctly
- Fix forbidigo nolint format for intermediate fmt.Errorf in pluginExtractTGZ

* fix(apps): validate openapi-key scope method, path and raw JSON (#1675)

Enforce an HTTP method whitelist (GET/POST/PUT/PATCH/DELETE), reject
malformed --scope-api paths (must start with '/', no '..' or '//'), and
constrain raw --scope JSON to the documented request_scope schema
(allow_all + http_infos only). Validation runs in both the Validate hook
and the body-build path so dry-run and execute are equally gated.

Fixes PR #1596 audit findings HIGH-2 and MEDIUM-4.

* fix(apps): harden db/file shortcuts per security audit (PR #1596)

Address the file/db findings from the PR #1596 security audit with
safer header/flag/path handling:

- HIGH-3 (--output path traversal): add rejectOutputTraversal() and wire
  it into +file-download and +db-data-export Validate; reject absolute
  paths and any .. component up front. (FileIO.Save already sandboxes to
  cwd via SafeOutputPath; this is an earlier, explicit guard.)
- HIGH-4 (Content-Disposition header injection): build the header with
  mime.FormatMediaType instead of manual string concatenation.
- MEDIUM-3 (SQL leaked into public flag): stop writing --file contents
  back into the --sql flag; resolveExecuteSQL() reads it at use-site so
  SQL never lands in flag dumps / structured logs.
- LOW-1 (hidden-file upload name): prefix sanitized upload names that
  start with '.' with '_'.
- LOW-2 (local-timezone time parsing): document local-tz interpretation
  of bare date/datetime in flag descriptions and the db/file skill docs.

SQL-injection of --table (audit MEDIUM-5) is intentionally NOT validated
in the CLI: the server-side interface is the authoritative guard.

Add apps_security_fixes_test.go covering the new validators and switch
the upload test to parse Content-Disposition instead of matching a
literal string. Update lark-apps-db.md / lark-apps-file.md skill refs.

* fix(plugin): harden plugin commands against path traversal, DoS, and agent misuse (#1677)

Security fixes from PR #1596 security audit:
- Skip symlink/hardlink entries during tgz extraction (Zip Slip)
- Limit tgz entry and download size to 10 MB (OOM/DoS)
- Limit error response body read to 4 KB
- Validate MIAODA_APP_TYPE as numeric to prevent path manipulation
- Add validatePluginKey + secureModulePath to block --name path
  traversal (../../.ssh etc.) for install/uninstall

Usability fix:
- Add explicit 'local command, no --app-id' notice in plugin
  reference docs to prevent agent from incorrectly passing
  --app-id to plugin commands (which read package.json locally)

* fix(apps): cap db async poll timeout at 2 minutes

+db-recovery-apply blocked up to 30min and +db-env-migrate /
+db-recovery-diff up to 10min while polling the server for async-task
completion. These operations are expected to finish within ~1 minute;
the long ceilings mostly hurt agents, whose harness kills the command on
timeout while the server-side operation keeps running with no handle to
re-query — especially risky for the irreversible recovery-apply.

Cap all three pollUntil ceilings at 2 minutes (polling interval
unchanged). Stuck operations now surface the retryable network/timeout
envelope after 2min instead of hanging for 10-30min.

* fix(plugin): create temp dir in project path to avoid cross-filesystem EXDEV on Rename (#1683)

pluginInstallLocal used os.MkdirTemp("") which creates the temp
directory on the system temp partition. On Windows (and some
Linux/macOS setups), the temp partition is on a different filesystem
from the project directory, causing os.Rename to fail with EXDEV.

Use projectPath as the temp dir parent so it is always on the same
filesystem as node_modules.

* fix(plugin): improve --help Tips with local-command hint and update semantics (#1691)

- Add "Run in project root; does NOT take --app-id" to all plugin Tips
- Clarify install command also supports update (install or update to latest/specific version)
- Clarify batch install reads from package.json actionPlugins

---------

Co-authored-by: 陈兴炀 <chenxingyang.1019@bytedance.com>
Co-authored-by: raistlin042 <lvxinsheng@bytedance.com>
Co-authored-by: anngo-nk <anguohui@bytedance.com>
Co-authored-by: zhangli <zhangli.268@bytedance.com>
2026-06-30 21:11:27 +08:00
linchao5102
5c4ad52741 fix: harden git credential error handling (#1676) 2026-06-30 19:57:04 +08:00
wangweiming-01
3fcb695698 docs: guide document copy skill usage (#1673) 2026-06-30 16:47:06 +08:00
mew
fb042758db feat: add whoami command showing effective identity (#1666) 2026-06-30 15:56:56 +08:00
SunPeiYang996
22108c3300 feat(docs): add reference map flags (#1547) 2026-06-30 12:07:18 +08:00
liuxin-0319
31744f8cf9 docs: fix lark-doc media token examples (#1662) 2026-06-30 11:47:14 +08:00
liangshuo-1
1dd0758091 chore: release v1.0.60 (#1657) 2026-06-29 22:34:36 +08:00
yballul-bytedance
4a5a669b1a fix(auth): remove 'claude settings' (#1654) 2026-06-29 21:58:22 +08:00
liangshuo-1
ebb0b6fe73 feat(affordance): per-command usage guidance system (markdown source) (#1565) 2026-06-29 19:33:27 +08:00
liangshuo-1
5c0a36b2a6 feat(transport): add LARK_CLI_NO_PROXY_WARN to silence proxy warning (#1647) 2026-06-29 19:31:48 +08:00
mazhe-nerd
21905b0ba1 fix(install): load @clack/prompts via dynamic import to avoid ERR_REQUIRE_ESM (#1636) (#1652) 2026-06-29 19:16:37 +08:00
yballul-bytedance
602c788fd9 feat(authorization): expand lark-shared auth guidance and assert clean logout JSON (#1598)
- skills/lark-shared/SKILL.md: broaden skill description to cover auth login/status/logout, --domain business-domain scopes, missing scopes and authorization revocation; add an auth task quick-reference table mapping user intents to lark-cli commands; document LARKSUITE_CLI_NO_UPDATE_NOTIFIER / LARKSUITE_CLI_NO_SKILLS_NOTIFIER env vars for stable JSON; soften _notice.update handling so it no longer interrupts the current task.
- cmd/auth/logout_test.go: in TestAuthLogoutRun_JSONMode_Success_WritesStdoutOnly, additionally assert that the success JSON payload has no 'message' field, matching the contract that logout success only carries loggedOut=true.
2026-06-29 16:28:57 +08:00
HanShaoshuai-k
30b28cf17f fix: reduce public content false positives 2026-06-29 14:02:43 +08:00
calendar-assistant
297776ea66 feat(event): support VC meeting lifecycle events (#1632) 2026-06-29 11:11:23 +08:00
Max Coplan
5b0c3137e3 test(doc): derive fetch test flag defaults from v2FetchFlags (#1428)
Replace hardcoded flag defaults in the fetch test helpers with
fetchDefault() / fetchDefaultInt() helpers that read the declared
defaults from v2FetchFlags(). This prevents future drift between
production flag defaults and test setup, and panics loudly if a
flag name is misspelled rather than silently returning "".

The tests now correctly avoid hardcoding doc-format, but other
flag defaults (detail, revision-id, scope, etc.) were still
duplicated here. Deriving all defaults from v2FetchFlags() keeps
the whole test command definition aligned with production.

Co-authored-by: TraeCli (Doubao-Seed-Dogfooding) <trae@bytedance.com>
Co-authored-by: fangshuyu <fangshuyu@bytedance.com>
2026-06-29 11:09:51 +08:00
xiongyuanwen-byted
4c31323de1 feat(sheets): use office_sheet_file parent_type for imported office spreadsheets (#1606)
Image uploads to a spreadsheet hard-coded parent_type=sheet_image at every
entry point. Imported "office" spreadsheets carry a token prefixed with
"fake_office_", for which the drive backend requires
parent_type=office_sheet_file. Funnel the parent_type selection through a
single sheets-domain helper so the rule lives in one place and every
image-upload path (float-image, +cells-set-image, backward +media-upload,
and every dry-run preview) stays consistent.

- Add sheetMediaParentType(token) in the sheets domain: returns
  office_sheet_file for fake_office_-prefixed tokens, otherwise sheet_image.
- Add an uploadSheetImage(...) collector that builds the
  DriveMediaUploadAllConfig (including parent_type) once, replacing the
  per-call-site hand-rolled configs.
- Route both main-domain image entries through the collector — float-image
  local upload and +cells-set-image — covering Execute and the dry-run
  preview body/desc.
- Cover the backward +media-upload entry: single-part, multipart (>20MB),
  and both dry-run bodies. backward is a separate package and an
  intentional verbatim mirror of shortcuts/sheets/, so it keeps its own
  copy of the helper rather than importing the main domain.
- Leave the shared common.UploadDriveMediaAllTyped upload layer untouched
  — the fake_office_ rule is sheets-specific and must not leak into
  mail/slides/doc/drive/base.

Tests:
- Pure-function TestSheetMediaParentType (5 cases incl. prefix-only and
  mid-string non-match).
- Main-domain dry-run TestCellsSetImage_DryRunOfficeParentType and
  TestUploadSheetImage_ParentType / _FileOpenError that exercise the
  Execute path on the wire, asserting parent_type via the captured
  multipart body and typed validation metadata (errs.ProblemOf
  category/subtype, fs.ErrNotExist cause preserved) on file open errors.
  decodeSheetMediaMultipartBody fails fast on NextPart / ReadFrom errors
  rather than silently producing a partial body.
- backward TestSheetMediaUploadExecuteOfficeParentType (real multipart
  wire) and TestSheetMediaUploadDryRunSmallFileOfficeParentType
  (small-file dry-run preview for fake_office_).
- cli_e2e tests/cli_e2e/sheets/sheets_image_upload_dryrun_test.go: --dry-run
  end-to-end across +media-upload and +cells-set-image, native and
  fake_office_ tokens, asserting api.0 is POST upload_all with
  parent_type=sheet_image / office_sheet_file and parent_node = token.
2026-06-27 16:16:56 +08:00
liangshuo-1
8a268aa2d2 chore: release v1.0.59 (#1617) 2026-06-26 20:46:51 +08:00
ethan-zhx
39d60cb706 feat: add slides replace-pages and xml-get shortcuts (#1585)
* feat: add slides replace-pages shortcut

* feat: add slides xml get shortcut

* fix: stop advertising slides screenshot scope

* feat: expose slides presentation url
2026-06-26 15:56:55 +08:00
SunPeiYang996
d9330b7ab3 fix(docs): hide docs api-version compat flag (#1580) 2026-06-26 14:32:09 +08:00
hugang-lark
6b833257c7 fix: optimize calendar,vc,minutes,note shortcut and skill (#1571) 2026-06-26 12:24:03 +08:00
zhangjun-bytedance
ba51d4874e feat: support speaker list and nolark speaker replace (#1594) 2026-06-26 11:41:32 +08:00
511 changed files with 53068 additions and 77563 deletions

View File

@@ -2,6 +2,74 @@
All notable changes to this project will be documented in this file.
## [v1.0.62] - 2026-07-01
### Features
- **vc**: Add meeting message send shortcut (#1643)
- **doc**: Add document word statistics helper (#1697)
- **cli**: Interactive upgrade prompt for bare `lark-cli` invocation (#1498)
- **install**: Fail closed when `checksums.txt` is missing during install (#1503)
### Bug Fixes
- **drive**: Improve batch failure handling for push/pull/sync (#1703)
- **base**: Support JSON array input for field create (#1661)
- **task**: Expose completion state in `my tasks` output (#1641)
- **cli**: Reduce public content credential false positives (#1700)
## [v1.0.61] - 2026-06-30
### Features
- **apps**: Add `db`, `file`, `openapi-key` and observability shortcuts (#1596)
- **identity**: Add `whoami` command showing effective identity (#1666)
- **docs**: Add reference map flags (#1547)
### Bug Fixes
- **identity**: Correct identity diagnosis under external credential providers (#1693)
- **cli**: Harden git credential error handling (#1676)
### Documentation
- **doc**: Guide document copy skill usage (#1673)
- **doc**: Fix lark-doc media token examples (#1662)
## [v1.0.60] - 2026-06-29
### Features
- **affordance**: Per-command usage guidance system with markdown source (#1565)
- **event**: Support VC meeting lifecycle events (#1632)
- **sheets**: Use `office_sheet_file` parent_type for imported office spreadsheets (#1606)
- **authorization**: Expand lark-shared auth guidance and assert clean logout JSON (#1598)
- **transport**: Add `LARK_CLI_NO_PROXY_WARN` to silence proxy warning (#1647)
### Bug Fixes
- **install**: Load `@clack/prompts` via dynamic import to avoid `ERR_REQUIRE_ESM` (#1652)
### Tests
- **doc**: Derive fetch test flag defaults from `v2FetchFlags` (#1428)
### Build
- **ci**: Reduce public content false positives
## [v1.0.59] - 2026-06-26
### Features
- **slides**: Add `+replace-pages` and `xml get` shortcuts, and expose the presentation URL (#1585)
- **minutes**: Support speaker list and no-Lark speaker replace (#1594)
- **calendar/vc/minutes**: Optimize and extend calendar, vc, minutes, and note shortcuts and skills (#1571)
### Bug Fixes
- **docs**: Hide docs `api-version` compat flag (#1580)
## [v1.0.58] - 2026-06-25
### Features
@@ -1265,6 +1333,10 @@ Bundled AI agent skills for intelligent assistance:
- Bilingual documentation (English & Chinese).
- CI/CD pipelines: linting, testing, coverage reporting, and automated releases.
[v1.0.62]: https://github.com/larksuite/cli/releases/tag/v1.0.62
[v1.0.61]: https://github.com/larksuite/cli/releases/tag/v1.0.61
[v1.0.60]: https://github.com/larksuite/cli/releases/tag/v1.0.60
[v1.0.59]: https://github.com/larksuite/cli/releases/tag/v1.0.59
[v1.0.58]: https://github.com/larksuite/cli/releases/tag/v1.0.58
[v1.0.57]: https://github.com/larksuite/cli/releases/tag/v1.0.57
[v1.0.56]: https://github.com/larksuite/cli/releases/tag/v1.0.56

View File

@@ -198,7 +198,7 @@ Prefixed with `+`, designed to be friendly for both humans and AI, with smart de
```bash
lark-cli calendar +agenda
lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello"
lark-cli docs +create --api-version v2 --doc-format markdown --content $'<title>Weekly Report</title>\n# Progress\n- Completed feature X'
lark-cli docs +create --doc-format markdown --content $'<title>Weekly Report</title>\n# Progress\n- Completed feature X'
```
Run `lark-cli <service> --help` to see all shortcut commands.

View File

@@ -199,7 +199,7 @@ CLI 提供三种粒度的调用方式,覆盖从快速操作到完全自定义
```bash
lark-cli calendar +agenda
lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello"
lark-cli docs +create --api-version v2 --doc-format markdown --content $'<title>周报</title>\n# 本周进展\n- 完成了 X 功能'
lark-cli docs +create --doc-format markdown --content $'<title>周报</title>\n# 本周进展\n- 完成了 X 功能'
```
运行 `lark-cli <service> --help` 查看所有快捷命令。

49
affordance/README.md Normal file
View File

@@ -0,0 +1,49 @@
# Affordance
Per-command usage guidance for the CLI, authored as one markdown file per domain
(`<service>.md`). It is surfaced in `lark-cli <command> --help` and in the
`schema` output, and read directly at runtime (lazy, cached) — there is no build
step. Maintain these files alongside `skills/` and `shortcuts/`.
## Format
A small, fixed markdown subset; each file describes one domain:
# <domain> optional `> skill: <name>` applies to every command below
## <command> the command as typed, minus `lark-cli <domain>`
<lead paragraph> when to use this command
### Avoid when when not to use it / which command to use instead
### Prerequisites what you must have first (e.g. an id, and where it comes from)
### Tips gotchas and constraints
### Examples **description** lines, each followed by a fenced command
### <other heading> a custom section; flows through verbatim
Reference another command with `[[command]]` — it renders as `command` in help.
Under `Avoid when` it means "use that one instead"; under `Prerequisites`
("… from [[command]]") it means "get the input there first".
## Example
## messages get
Fetch the full content of a single message by id.
### Avoid when
- Reading several at once → use [[messages batch_get]]
### Prerequisites
- message_id from [[messages list]]
### Examples
**Fetch one message**
```bash
lark-cli mail user_mailbox.messages get --message-id "<id>"
```
## Notes
- Write plain prose; the only convention is wrapping command references in `[[ ]]`.
- Keep it concise and high-signal — don't restate field/flag names, id types, or
anything the schema and flags already show; the agent infers the rest.
- Command-form headings resolve to method ids via the registry, so plural resource
names (`messages`) map to the singular method id (`message`) automatically.

19
affordance/contact.md Normal file
View File

@@ -0,0 +1,19 @@
# contact
> skill: lark-contact
## user_profiles batch_query
Bulk-fetch personal status and signature for user ids you already have.
### Avoid when
- Need more than status/signature (name, dept, email), or don't have the open_id yet → use [[+search-user]]
### Tips
- Off by default — set include_personal_status / include_description to true under query_option
- ids in user_ids must match --user-id-type (default open_id)
### Examples
**Bulk-query status and signature**
```bash
lark-cli contact user_profiles batch_query --data '{"user_ids":["ou_3a8b****6a7b"],"query_option":{"include_personal_status":true,"include_description":true}}'
```

View File

@@ -67,8 +67,21 @@ func NewCmdApiWithContext(ctx context.Context, f *cmdutil.Factory, runF func(*AP
cmd := &cobra.Command{
Use: "api <method> <path>",
Short: "Generic Lark API requests",
Args: cobra.ExactArgs(2),
Short: "Raw HTTP escape hatch — call any endpoint by path (fallback when no typed command exists)",
Long: `Raw HTTP escape hatch: send any Lark API request by HTTP method + path.
Prefer the typed domain command when one exists — it validates parameters,
shows the Risk level, gates destructive calls behind --yes, and carries usage
guidance that this raw command does not. If a domain command covers your task
(browse with ` + "`lark-cli <domain> --help`" + `), use it instead of this.
Reach for ` + "`api`" + ` only for endpoints that have no typed command yet (e.g.
newer/preview APIs), where you already have the HTTP path from the Lark docs.
Examples:
lark-cli api GET /open-apis/calendar/v4/calendars
lark-cli api POST /open-apis/im/v1/messages --params '{"receive_id_type":"open_id"}' --data @body.json`,
Args: cobra.ExactArgs(2),
RunE: func(cmd *cobra.Command, args []string) error {
opts.Method = strings.ToUpper(args[0])
opts.Path = args[1]

View File

@@ -22,6 +22,11 @@ import (
// NewCmdAuth creates the auth command with subcommands.
func NewCmdAuth(f *cmdutil.Factory) *cobra.Command {
return NewCmdAuthWithContext(context.Background(), f)
}
// NewCmdAuthWithContext creates the auth command with subcommands.
func NewCmdAuthWithContext(ctx context.Context, f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "auth",
Short: "OAuth credentials and authorization management",
@@ -38,7 +43,7 @@ func NewCmdAuth(f *cmdutil.Factory) *cobra.Command {
}
cmdutil.DisableAuthCheck(cmd)
cmd.AddCommand(NewCmdAuthLogin(f, nil))
cmd.AddCommand(NewCmdAuthLoginWithContext(ctx, f, nil))
cmd.AddCommand(NewCmdAuthLogout(f, nil))
cmd.AddCommand(NewCmdAuthStatus(f, nil))
cmd.AddCommand(NewCmdAuthScopes(f, nil))

View File

@@ -42,6 +42,11 @@ var pollDeviceToken = larkauth.PollDeviceToken
// NewCmdAuthLogin creates the auth login subcommand.
func NewCmdAuthLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Command {
return NewCmdAuthLoginWithContext(context.Background(), f, runF)
}
// NewCmdAuthLoginWithContext creates the auth login subcommand.
func NewCmdAuthLoginWithContext(ctx context.Context, f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Command {
opts := &LoginOptions{Factory: f}
cmd := &cobra.Command{
@@ -73,7 +78,7 @@ to generate QR codes (supports ASCII and PNG formats).`,
cmd.Flags().StringVar(&opts.Scope, "scope", "", "scopes to request (space- or comma-separated). Combines additively with --domain/--recommend")
cmd.Flags().BoolVar(&opts.Recommend, "recommend", false, "request only recommended (auto-approve) scopes")
var helpBrand core.LarkBrand
if f != nil && f.Config != nil {
if !cmdutil.IsCredentialBootstrapDisabled(ctx) && f != nil && f.Config != nil {
if cfg, err := f.Config(); err == nil && cfg != nil {
helpBrand = cfg.Brand
}

View File

@@ -19,6 +19,7 @@ import (
"github.com/larksuite/cli/cmd/service"
"github.com/larksuite/cli/cmd/skill"
cmdupdate "github.com/larksuite/cli/cmd/update"
"github.com/larksuite/cli/cmd/whoami"
_ "github.com/larksuite/cli/events"
"github.com/larksuite/cli/internal/apicatalog"
"github.com/larksuite/cli/internal/build"
@@ -89,8 +90,9 @@ func WithoutPlugins() BuildOption {
}
// WithoutStrictMode builds the complete repository-owned command tree without
// applying user/profile strict-mode pruning. It is intended for offline
// inspection tools, not production execution.
// applying user/profile strict-mode pruning or credential-backed bootstrap
// probes. It is intended for offline inspection tools and pure local commands
// that must not require account configuration.
func WithoutStrictMode() BuildOption {
return func(c *buildConfig) {
c.skipStrictMode = true
@@ -145,6 +147,9 @@ func buildInternal(ctx context.Context, inv cmdutil.InvocationContext, opts ...B
o(cfg)
}
}
if cfg.skipStrictMode {
ctx = cmdutil.ContextWithCredentialBootstrapDisabled(ctx)
}
// Default streams when WithIO is not supplied so the root command's
// SetIn/Out/Err calls below don't deref nil. NewDefault also normalizes
// partial streams internally; keep both in sync so cfg.streams reflects
@@ -170,6 +175,10 @@ func buildInternal(ctx context.Context, inv cmdutil.InvocationContext, opts ...B
rootCmd.SetOut(cfg.streams.Out)
rootCmd.SetErr(cfg.streams.ErrOut)
// Root-only usage template (curated Usage synopsis + skills footer); see
// rootUsageTemplate.
rootCmd.SetUsageTemplate(rootUsageTemplate)
installTipsHelpFunc(rootCmd)
rootCmd.SilenceErrors = true
// SilenceUsage as a static field (not only in PersistentPreRun) so it also
@@ -187,9 +196,10 @@ func buildInternal(ctx context.Context, inv cmdutil.InvocationContext, opts ...B
}
rootCmd.AddCommand(cmdconfig.NewCmdConfig(f))
rootCmd.AddCommand(auth.NewCmdAuth(f))
rootCmd.AddCommand(auth.NewCmdAuthWithContext(ctx, f))
rootCmd.AddCommand(profile.NewCmdProfile(f))
rootCmd.AddCommand(doctor.NewCmdDoctor(f))
rootCmd.AddCommand(whoami.NewCmdWhoamiWithContext(ctx, f))
rootCmd.AddCommand(api.NewCmdApiWithContext(ctx, f, nil))
rootCmd.AddCommand(schema.NewCmdSchema(f, nil))
rootCmd.AddCommand(completion.NewCmdCompletion(f))
@@ -205,10 +215,17 @@ func buildInternal(ctx context.Context, inv cmdutil.InvocationContext, opts ...B
}
shortcuts.RegisterShortcutsWithContext(ctx, rootCmd, f)
installUnknownSubcommandGuard(rootCmd)
groupRootCommands(rootCmd)
if mode := f.ResolveStrictMode(ctx); mode.IsActive() && !cfg.skipStrictMode {
pruneForStrictMode(rootCmd, mode)
installUnknownSubcommandGuard(rootCmd)
// Bare `lark-cli` in an interactive terminal offers an interactive upgrade
// before printing help; non-bare invocations and non-TTY are unaffected.
installRootUpgradePrompt(f, rootCmd)
if !cfg.skipStrictMode {
if mode := f.ResolveStrictMode(ctx); mode.IsActive() {
pruneForStrictMode(rootCmd, mode)
}
}
if cfg.skipPlugins {

View File

@@ -129,7 +129,10 @@ func doctorRun(opts *DoctorOptions) error {
if diagnostics.Bot.Available || diagnostics.User.Available {
checks = append(checks, pass("identity_ready", "at least one identity is available"))
} else {
checks = append(checks, fail("identity_ready", "no usable bot or user identity is available", "run: lark-cli auth status --verify"))
// No hint: this only summarizes the two checks above, which already carry
// the source-appropriate remediation. A command here would be redundant,
// or wrong (`auth status` is blocked under an external provider).
checks = append(checks, fail("identity_ready", "no usable bot or user identity is available", ""))
}
// ── 4 & 5. Endpoint reachability ──

View File

@@ -4,14 +4,19 @@
package doctor
import (
"bytes"
"context"
"encoding/json"
"net/http"
"strings"
"testing"
"github.com/spf13/cobra"
extcred "github.com/larksuite/cli/extension/credential"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
"github.com/larksuite/cli/internal/credential"
)
func TestNewCmdDoctor_FlagParsing(t *testing.T) {
@@ -140,14 +145,84 @@ func TestDoctorRun_SplitsBotAndMissingUserIdentity(t *testing.T) {
}
func assertCheck(t *testing.T, checks []checkResult, name, status string) {
t.Helper()
if got := findCheck(t, checks, name); got.Status != status {
t.Fatalf("%s status = %q, want %q", name, got.Status, status)
}
}
func findCheck(t *testing.T, checks []checkResult, name string) checkResult {
t.Helper()
for _, check := range checks {
if check.Name == name {
if check.Status != status {
t.Fatalf("%s status = %q, want %q", name, check.Status, status)
}
return
return check
}
}
t.Fatalf("check %q not found in %#v", name, checks)
return checkResult{}
}
type fakeExtProvider struct {
name string
account *extcred.Account
}
func (p *fakeExtProvider) Name() string { return p.name }
func (p *fakeExtProvider) ResolveAccount(context.Context) (*extcred.Account, error) {
return p.account, nil
}
func (p *fakeExtProvider) ResolveToken(context.Context, extcred.TokenSpec) (*extcred.Token, error) {
return nil, nil
}
// Under an external credential provider with no usable identity, the
// identity_ready hint must not point at `auth status` (blocked there); the
// per-identity checks already carry the source-appropriate escalation.
func TestDoctor_ExternalProvider_IdentityReadyHintNotBlockedCommand(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
if err := core.SaveMultiAppConfig(&core.MultiAppConfig{
CurrentApp: "default",
Apps: []core.AppConfig{{Name: "default", AppId: "cli_x", AppSecret: core.PlainSecret("secret"), Brand: core.BrandFeishu}},
}); err != nil {
t.Fatalf("SaveMultiAppConfig() error = %v", err)
}
// Provider serves neither identity: bot unsupported, user supported but not
// signed in → both unavailable → identity_ready fails.
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsUser)}
cred := credential.NewCredentialProvider(
[]extcred.Provider{&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}},
nil, nil,
func() (*http.Client, error) { return nil, nil },
)
out := &bytes.Buffer{}
f := &cmdutil.Factory{
Config: func() (*core.CliConfig, error) { return cfg, nil },
Credential: cred,
IOStreams: &cmdutil.IOStreams{Out: out, ErrOut: &bytes.Buffer{}},
}
if err := doctorRun(&DoctorOptions{Factory: f, Ctx: context.Background(), Offline: true}); err == nil {
t.Fatalf("doctorRun() = nil, want failure when no identity is available")
}
var got struct {
Checks []checkResult `json:"checks"`
}
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
t.Fatalf("json.Unmarshal() error = %v\n%s", err, out.String())
}
ready := findCheck(t, got.Checks, "identity_ready")
if ready.Status != "fail" {
t.Fatalf("identity_ready status = %q, want fail", ready.Status)
}
// The summary defers to the per-identity checks; it carries no hint of its
// own (a command here would be wrong under an external provider).
if ready.Hint != "" {
t.Fatalf("identity_ready should carry no hint, got %q", ready.Hint)
}
user := findCheck(t, got.Checks, "user_identity")
if !strings.Contains(user.Hint, "external") || strings.Contains(user.Hint, "auth login") {
t.Fatalf("user_identity hint not external-appropriate: %q", user.Hint)
}
}

View File

@@ -10,10 +10,22 @@ import (
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
eventlib "github.com/larksuite/cli/internal/event"
_ "github.com/larksuite/cli/events"
)
func TestEventLookup_VCMeetingLifecycleKeys(t *testing.T) {
for _, key := range []string{
"vc.meeting.participant_meeting_started_v1",
"vc.meeting.participant_meeting_joined_v1",
} {
if _, ok := eventlib.Lookup(key); !ok {
t.Fatalf("event.Lookup(%q) should succeed", key)
}
}
}
func TestRunList_TextOutput(t *testing.T) {
f, stdout, _, _ := cmdutil.TestFactory(t, &core.CliConfig{AppID: "test"})
@@ -27,6 +39,8 @@ func TestRunList_TextOutput(t *testing.T) {
"im.message.receive_v1",
"im.message.message_read_v1",
"task.task.update_user_access_v2",
"vc.meeting.participant_meeting_started_v1",
"vc.meeting.participant_meeting_joined_v1",
} {
if !strings.Contains(out, want) {
t.Errorf("list output missing %q; full output:\n%s", want, out)
@@ -57,9 +71,15 @@ func TestRunList_JSONOutput(t *testing.T) {
}
}
var foundTask bool
gotKeys := map[string]map[string]interface{}{}
for _, row := range rows {
if row["key"] == "task.task.update_user_access_v2" {
if key, ok := row["key"].(string); ok {
gotKeys[key] = row
}
}
var foundTask bool
for key, row := range gotKeys {
if key == "task.task.update_user_access_v2" {
foundTask = true
if row["single_consumer"] != true {
t.Errorf("task row single_consumer = %v, want true", row["single_consumer"])
@@ -69,4 +89,12 @@ func TestRunList_JSONOutput(t *testing.T) {
if !foundTask {
t.Fatal("event list JSON missing task.task.update_user_access_v2")
}
for _, want := range []string{
"vc.meeting.participant_meeting_started_v1",
"vc.meeting.participant_meeting_joined_v1",
} {
if _, ok := gotKeys[want]; !ok {
t.Errorf("JSON list output missing %q", want)
}
}
}

View File

@@ -124,6 +124,45 @@ func TestRunSchema_TaskUpdateUserAccessJSON(t *testing.T) {
}
}
func TestRunSchema_JSONOutput_VCMeetingLifecycleKeys(t *testing.T) {
for _, key := range []string{
"vc.meeting.participant_meeting_started_v1",
"vc.meeting.participant_meeting_joined_v1",
} {
t.Run(key, func(t *testing.T) {
f, stdout, _, _ := cmdutil.TestFactory(t, &core.CliConfig{AppID: "test"})
if err := runSchema(f, key, true); err != nil {
t.Fatalf("runSchema json: %v", err)
}
var payload map[string]interface{}
if err := json.Unmarshal(stdout.Bytes(), &payload); err != nil {
t.Fatalf("output is not valid JSON: %v\n%s", err, stdout.String())
}
if payload["key"] != key {
t.Errorf("key = %v, want %s", payload["key"], key)
}
resolved, ok := payload["resolved_output_schema"].(map[string]interface{})
if !ok {
t.Fatalf("resolved_output_schema missing or wrong type: %+v", payload)
}
properties, ok := resolved["properties"].(map[string]interface{})
if !ok {
t.Fatalf("resolved_output_schema.properties missing or wrong type: %+v", resolved)
}
for _, field := range []string{"type", "event_id", "timestamp", "meeting_id", "topic", "meeting_no", "start_time", "calendar_event_id"} {
if _, ok := properties[field]; !ok {
t.Errorf("resolved output schema missing field %q: %+v", field, properties)
}
}
if _, ok := properties["end_time"]; ok {
t.Errorf("resolved output schema should not include end_time for %s: %+v", key, properties)
}
})
}
}
func TestSchema_RendersSubscriptionKeyMarker(t *testing.T) {
const syntheticKey = "test.evt_sub"
t.Cleanup(func() { eventlib.UnregisterKeyForTest(syntheticKey) })

View File

@@ -11,9 +11,11 @@ import (
"sort"
"strings"
"github.com/larksuite/cli/cmd/service"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/extension/platform"
"github.com/larksuite/cli/internal/build"
"github.com/larksuite/cli/internal/cmdmeta"
"github.com/larksuite/cli/internal/cmdpolicy"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/deprecation"
@@ -28,43 +30,60 @@ import (
const rootLong = `lark-cli — Lark/Feishu CLI tool.
USAGE:
lark-cli <command> [subcommand] [method] [options]
lark-cli api <method> <path> [--params <json>] [--data <json>]
lark-cli schema <service.resource.method>
AGENT QUICKSTART (driving this as an agent? start here):
Browse commands: lark-cli <domain> --help # +shortcuts (preferred) and raw API resources
Inspect a call: lark-cli schema <service>.<resource>.<method> # params, types, scopes, examples
Prefer a +shortcut over the raw API resource when one matches the task.
Risk: each command's --help shows read | write | high-risk-write;
high-risk-write needs --yes, only after the user confirms.
On any API call: --jq <expr> filters JSON output, --dry-run previews the request (runs nothing).
EXAMPLES:
# View upcoming events
lark-cli calendar +agenda
EXAMPLES (one per command style, in order of preference):
lark-cli calendar +agenda # +shortcut — a high-level task, prefer these
lark-cli mail user_mailbox.messages list --user-mailbox-id me # typed command for one API method
lark-cli schema mail.user_mailbox.messages.list # inspect a method's params before calling
lark-cli api GET /open-apis/calendar/v4/calendars # raw escape hatch — any endpoint by HTTP path`
# List calendar events
lark-cli calendar events instance_view --params '{"calendar_id":"primary","start_time":"1700000000","end_time":"1700086400"}'
// rootUsageTemplate is cobra's default usage template with two root-only
// additions gated on {{if not .HasParent}}: a curated multi-form Usage synopsis
// (replacing cobra's generic "[flags] / [command]") and a human skills-setup
// footer. Subcommands render the stock template unchanged. The rest is verbatim
// cobra so the command groups and flags are untouched.
const rootUsageTemplate = `{{if .HasParent}}Usage:{{if .Runnable}}
{{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}
{{.CommandPath}} [command]{{end}}{{else}}Usage:
lark-cli <command> [subcommand] [method] [flags]
lark-cli api <method> <path> [--params <json>] [--data <json>]
lark-cli schema <service.resource.method>{{end}}{{if gt (len .Aliases) 0}}
# Search users
lark-cli contact +search-user --query "John"
Aliases:
{{.NameAndAliases}}{{end}}{{if .HasExample}}
# Generic API call
lark-cli api GET /open-apis/calendar/v4/calendars
Examples:
{{.Example}}{{end}}{{if .HasAvailableSubCommands}}{{$cmds := .Commands}}{{if eq (len .Groups) 0}}
AI AGENT SKILLS:
lark-cli pairs with AI agent skills (Claude Code, etc.) that
teach the agent Lark API patterns, best practices, and workflows.
Available Commands:{{range $cmds}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{else}}{{range $group := .Groups}}
Install all skills:
npx skills add larksuite/cli -g -y
{{.Title}}{{range $cmds}}{{if (and (eq .GroupID $group.ID) (or .IsAvailableCommand (eq .Name "help")))}}
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if not .AllChildCommandsHaveGroup}}
Or pick specific domains:
npx skills add larksuite/cli -s lark-calendar -y
npx skills add larksuite/cli -s lark-im -y
Additional Commands:{{range $cmds}}{{if (and (eq .GroupID "") (or .IsAvailableCommand (eq .Name "help")))}}
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}
Learn more: https://github.com/larksuite/cli#agent-skills
Flags:
{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
COMMUNITY:
GitHub: https://github.com/larksuite/cli
Issues: https://github.com/larksuite/cli/issues
Docs: https://open.feishu.cn/document/
Global Flags:
{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
More help: lark-cli <command> --help`
Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
{{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
Use "{{.CommandPath}} [command] --help" for more information about a command.{{end}}{{if not .HasParent}}
Skills setup (one-time, humans): npx skills add larksuite/cli -g -y — https://github.com/larksuite/cli#agent-skills{{end}}
`
// Execute runs the root command and returns the process exit code.
// rawInvocationArgs holds os.Args[1:] captured at Execute() entry. cobra's
@@ -84,10 +103,16 @@ func Execute() int {
configureFlagCompletions(os.Args)
ctx := context.Background()
f, rootCmd, reg := buildInternal(
ctx, inv,
buildOpts := []BuildOption{
WithIO(os.Stdin, os.Stdout, os.Stderr),
HideProfile(isSingleAppMode()),
}
if isLocalSVGlideInvocation(rawInvocationArgs) {
buildOpts = append(buildOpts, WithoutStrictMode())
}
f, rootCmd, reg := buildInternal(
ctx, inv,
buildOpts...,
)
// --- Notices (non-blocking) ---
@@ -111,6 +136,30 @@ func Execute() int {
return 0
}
func isLocalSVGlideInvocation(args []string) bool {
positionals := make([]string, 0, 2)
for i := 0; i < len(args); i++ {
arg := args[i]
switch {
case arg == "--profile":
if i+1 < len(args) {
i++
}
continue
case strings.HasPrefix(arg, "--profile="):
continue
case strings.HasPrefix(arg, "-"):
continue
default:
positionals = append(positionals, arg)
if len(positionals) == 2 {
return positionals[0] == "slides" && positionals[1] == "+create-svglide"
}
}
}
return false
}
// setupNotices wires both the binary update notice and the skills
// staleness notice into output.PendingNotice as a composed function.
// Each provider populates an independent key under _notice; either
@@ -529,6 +578,49 @@ func availableSubcommandNames(cmd *cobra.Command) (available, deprecated []strin
return available, deprecated
}
// Root command help groups, so an agent sees content domains, agent tooling, and
// CLI management as distinct blocks instead of one flat alphabetical dump.
const (
groupDomains = "lark-domains"
groupTooling = "agent-tooling"
groupManagement = "cli-management"
)
// groupRootCommands classifies root's direct children into the help groups,
// called once after all commands are registered. Unclassified commands fall to
// cobra's "Additional Commands" section.
func groupRootCommands(root *cobra.Command) {
root.AddGroup(
&cobra.Group{ID: groupDomains, Title: "Lark domains:"},
&cobra.Group{ID: groupTooling, Title: "Agent tooling:"},
&cobra.Group{ID: groupManagement, Title: "CLI management:"},
)
tooling := map[string]bool{"api": true, "schema": true, "skills": true}
management := map[string]bool{"auth": true, "config": true, "profile": true, "doctor": true, "update": true}
for _, c := range root.Commands() {
if c.GroupID != "" {
continue
}
switch {
case tooling[c.Name()]:
c.GroupID = groupTooling
case management[c.Name()]:
c.GroupID = groupManagement
case isLarkDomain(c):
c.GroupID = groupDomains
}
}
}
// isLarkDomain reports whether a root child is a Lark domain (service-sourced or
// shortcut-tagged), not CLI tooling. Mirrors service.PrepareDomainHelp.
func isLarkDomain(c *cobra.Command) bool {
if src, _ := cmdmeta.SourceOf(c); src == cmdmeta.SourceService {
return true
}
return cmdmeta.Domain(c) != ""
}
// flagDidYouMean is the root FlagErrorFunc (inherited by all subcommands). It
// converts cobra's flag-parse errors into a typed validation envelope: an
// unknown flag gets a focused "did you mean" hint (so agents recover even when
@@ -610,6 +702,17 @@ func installTipsHelpFunc(root *cobra.Command) {
defer func() { f.Hidden = true }()
}
}
// Domain and method commands compose their agent guidance into Long lazily
// here (shortcuts attach after service registration); both skip the generic
// bottom-of-help append below.
if service.PrepareDomainHelp(cmd, embeddedSkillContent) {
defaultHelp(cmd, args)
return
}
if service.PrepareMethodHelp(cmd) {
defaultHelp(cmd, args)
return
}
defaultHelp(cmd, args)
out := cmd.OutOrStdout()
if level, ok := cmdutil.GetRisk(cmd); ok {

View File

@@ -5,9 +5,12 @@ package cmd
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"
"strings"
"testing"
@@ -26,6 +29,27 @@ import (
"github.com/larksuite/cli/internal/registry"
)
type countingKeychain struct {
gets int
sets int
removes int
}
func (k *countingKeychain) Get(service, account string) (string, error) {
k.gets++
return "", fmt.Errorf("unexpected keychain Get for %s/%s", service, account)
}
func (k *countingKeychain) Set(service, account, value string) error {
k.sets++
return fmt.Errorf("unexpected keychain Set for %s/%s", service, account)
}
func (k *countingKeychain) Remove(service, account string) error {
k.removes++
return fmt.Errorf("unexpected keychain Remove for %s/%s", service, account)
}
// TestPersistentPreRunE_AuthCheckDisabledAnnotations verifies that
// auth, config, and schema commands have auth check disabled,
// while api does not.
@@ -75,12 +99,71 @@ func TestPersistentPreRunE_ConfigSubcommands(t *testing.T) {
}
}
func TestRootLong_AgentSkillsLinkTargetsReadmeSection(t *testing.T) {
if !strings.Contains(rootLong, "https://github.com/larksuite/cli#agent-skills") {
t.Fatalf("root help should link to the README Agent Skills section, got:\n%s", rootLong)
func TestIsLocalSVGlideInvocation(t *testing.T) {
tests := []struct {
name string
args []string
want bool
}{
{name: "local svglide", args: []string{"slides", "+create-svglide", "--action", "init"}, want: true},
{name: "with profile", args: []string{"--profile", "demo", "slides", "+create-svglide"}, want: true},
{name: "with profile equals", args: []string{"--profile=demo", "slides", "+create-svglide"}, want: true},
{name: "other slides shortcut", args: []string{"slides", "+create"}, want: false},
{name: "root help", args: []string{"--help"}, want: false},
}
if strings.Contains(rootLong, "https://github.com/larksuite/cli#install-ai-agent-skills") {
t.Fatalf("root help should not reference the removed install-ai-agent-skills anchor, got:\n%s", rootLong)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := isLocalSVGlideInvocation(tt.args); got != tt.want {
t.Fatalf("isLocalSVGlideInvocation(%v) = %v, want %v", tt.args, got, tt.want)
}
})
}
}
func TestLocalSVGlideRootCommandDoesNotTouchKeychain(t *testing.T) {
dir := t.TempDir()
t.Chdir(dir)
if err := os.WriteFile("source.md", []byte("# Demo"), 0o644); err != nil {
t.Fatal(err)
}
var in, out, errOut bytes.Buffer
kc := &countingKeychain{}
_, rootCmd, _ := buildInternal(
context.Background(),
cmdutil.InvocationContext{},
WithIO(&in, &out, &errOut),
WithKeychain(kc),
WithoutStrictMode(),
WithoutPlugins(),
)
rootCmd.SetArgs([]string{
"slides",
"+create-svglide",
"--action", "init",
"--title", "Demo",
"--input", "source.md",
"--out", "run-demo",
})
if err := rootCmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v\nstdout=%s\nstderr=%s", err, out.String(), errOut.String())
}
if kc.gets != 0 || kc.sets != 0 || kc.removes != 0 {
t.Fatalf("keychain touched: gets=%d sets=%d removes=%d", kc.gets, kc.sets, kc.removes)
}
if _, err := os.Stat(filepath.Join("run-demo", "run.json")); err != nil {
t.Fatalf("missing run.json: %v", err)
}
}
func TestRootLong_AgentSkillsLinkTargetsReadmeSection(t *testing.T) {
// The human skills-install guidance now lives in the root usage-template
// footer (below the command list), not in the agent-facing Long.
if !strings.Contains(rootUsageTemplate, "https://github.com/larksuite/cli#agent-skills") {
t.Fatalf("root help footer should link to the README Agent Skills section, got:\n%s", rootUsageTemplate)
}
if strings.Contains(rootUsageTemplate, "https://github.com/larksuite/cli#install-ai-agent-skills") {
t.Fatalf("root help should not reference the removed install-ai-agent-skills anchor, got:\n%s", rootUsageTemplate)
}
}

90
cmd/root_upgrade.go Normal file
View File

@@ -0,0 +1,90 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package cmd
import (
"bufio"
"fmt"
"io"
"strings"
"github.com/larksuite/cli/internal/build"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/update"
"github.com/spf13/cobra"
)
// runRootUpgrade locates the registered `update` subcommand and runs it, so the
// interactive root-command upgrade reuses exactly `lark-cli update` behavior
// (install-method detection, output, error handling). Package-level var so
// tests can stub it and avoid real network / self-update.
var runRootUpgrade = func(cmd *cobra.Command) {
for _, c := range cmd.Root().Commands() {
if c.Name() == "update" && c.RunE != nil {
_ = c.RunE(c, nil) // update prints its own output/errors; swallow here
return
}
}
}
// isBareRootInvocation reports whether this is a bare `lark-cli` (no subcommand,
// no flags) — the only invocation that triggers the interactive upgrade prompt.
// Mirrors unknownSubcommandRunE's "bare group prints help" branch: args empty
// AND no flag tokens in the raw invocation.
func isBareRootInvocation(args []string) bool {
return len(args) == 0 && len(flagTokensInArgs(rawInvocationArgs)) == 0
}
// readYes reads one line and reports whether it is an affirmative y/yes.
// EOF / empty / anything else → false (default No, matching the [y/N] prompt).
func readYes(r io.Reader) bool {
line, _ := bufio.NewReader(r).ReadString('\n')
switch strings.ToLower(strings.TrimSpace(line)) {
case "y", "yes":
return true
default:
return false
}
}
// offerRootUpgrade prompts for an interactive upgrade when running bare
// `lark-cli` in an interactive terminal with a cached newer version. Every
// failure is swallowed — it must never affect help output or the exit code.
func offerRootUpgrade(f *cmdutil.Factory, cmd *cobra.Command) {
ios := f.IOStreams
// Gates 1/2/3: need to read stdin AND show the prompt on stderr, and require
// stdout TTY too so this only fires in a pure foreground terminal session.
if !ios.IsTerminal || !ios.OutIsTerminal || !ios.StderrIsTerminal {
return
}
// Gate 4: cached newer version. CheckCached applies opt-out (shouldSkip)
// and the IsNewer/semver validation chain; it reads the on-disk cache that
// the 24h-throttled RefreshCache maintains (CheckCached itself has no TTL).
info := update.CheckCached(build.Version)
if info == nil {
return
}
fmt.Fprintf(ios.ErrOut, "lark-cli %s available (current %s). Upgrade now? [y/N]: ", info.Latest, info.Current)
if !readYes(ios.In) {
return
}
runRootUpgrade(cmd)
}
// installRootUpgradePrompt wraps the root command's RunE (set to
// unknownSubcommandRunE by installUnknownSubcommandGuard) so a bare `lark-cli`
// invocation offers an interactive upgrade before printing help. Non-bare
// invocations are passed straight through, unchanged.
func installRootUpgradePrompt(f *cmdutil.Factory, root *cobra.Command) {
inner := root.RunE
if inner == nil {
return
}
root.RunE = func(cmd *cobra.Command, args []string) error {
if isBareRootInvocation(args) {
offerRootUpgrade(f, cmd)
}
return inner(cmd, args)
}
}

191
cmd/root_upgrade_test.go Normal file
View File

@@ -0,0 +1,191 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package cmd
import (
"bytes"
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/larksuite/cli/internal/build"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
"github.com/spf13/cobra"
)
func writeUpdateState(t *testing.T, dir, latest string) {
t.Helper()
data := fmt.Sprintf(`{"latest_version":%q,"checked_at":%d}`, latest, time.Now().Unix())
if err := os.WriteFile(filepath.Join(dir, "update-state.json"), []byte(data), 0o644); err != nil {
t.Fatal(err)
}
}
func TestReadYes(t *testing.T) {
cases := map[string]bool{
"y\n": true, "Y\n": true, "yes\n": true, "YES\n": true, " y \n": true,
"n\n": false, "\n": false, "": false, "nope\n": false, "yeah\n": false,
}
for in, want := range cases {
if got := readYes(strings.NewReader(in)); got != want {
t.Errorf("readYes(%q) = %v, want %v", in, got, want)
}
}
}
func TestIsBareRootInvocation(t *testing.T) {
orig := rawInvocationArgs
t.Cleanup(func() { rawInvocationArgs = orig })
rawInvocationArgs = nil
if !isBareRootInvocation([]string{}) {
t.Error("empty args + no raw flag tokens should be bare")
}
rawInvocationArgs = []string{"--profile", "x"}
if isBareRootInvocation([]string{}) {
t.Error("flag token present → not bare")
}
rawInvocationArgs = nil
if isBareRootInvocation([]string{"im"}) {
t.Error("positional arg → not bare")
}
}
func TestOfferRootUpgrade(t *testing.T) {
origV := build.Version
build.Version = "1.0.0" // release version so shouldSkip()==false
t.Cleanup(func() { build.Version = origV })
origRun := runRootUpgrade
t.Cleanup(func() { runRootUpgrade = origRun })
// This test builds a Factory literal (no NewDefault), so it never runs
// workspace detection; pin the process-global workspace to Local so
// statePath() resolves under LARKSUITE_CLI_CONFIG_DIR rather than a stale
// subdir inherited from a prior test in the package.
origWS := core.CurrentWorkspace()
t.Cleanup(func() { core.SetCurrentWorkspace(origWS) })
core.SetCurrentWorkspace(core.WorkspaceLocal)
cases := []struct {
name string
in, out, err bool
input string
latest string // "" → no state file (CheckCached nil)
optOut bool
wantPrompt, wantRun bool
}{
{"all-tty+y", true, true, true, "y\n", "2.0.0", false, true, true},
{"all-tty+yes", true, true, true, "yes\n", "2.0.0", false, true, true},
{"all-tty+n", true, true, true, "n\n", "2.0.0", false, true, false},
{"all-tty+empty", true, true, true, "\n", "2.0.0", false, true, false},
{"all-tty+eof", true, true, true, "", "2.0.0", false, true, false},
{"stdin-not-tty", false, true, true, "y\n", "2.0.0", false, false, false},
{"stdout-not-tty", true, false, true, "y\n", "2.0.0", false, false, false},
{"stderr-not-tty", true, true, false, "y\n", "2.0.0", false, false, false},
{"no-newer-version", true, true, true, "y\n", "", false, false, false},
{"already-latest", true, true, true, "y\n", "1.0.0", false, false, false}, // post-upgrade: current == cached latest → no prompt
{"cache-older-than-current", true, true, true, "y\n", "0.9.0", false, false, false},
{"opt-out", true, true, true, "y\n", "2.0.0", true, false, false},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
dir := t.TempDir()
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", dir)
// Clear env that update.shouldSkip treats as "suppress" so the
// test is deterministic regardless of host (GitHub Actions sets
// CI=true, which would otherwise suppress the prompt).
t.Setenv("CI", "")
t.Setenv("BUILD_NUMBER", "")
t.Setenv("RUN_ID", "")
t.Setenv("LARKSUITE_CLI_NO_UPDATE_NOTIFIER", "")
if tc.latest != "" {
writeUpdateState(t, dir, tc.latest)
}
if tc.optOut {
t.Setenv("LARKSUITE_CLI_NO_UPDATE_NOTIFIER", "1")
}
called := false
runRootUpgrade = func(*cobra.Command) { called = true }
var errBuf bytes.Buffer
f := &cmdutil.Factory{IOStreams: &cmdutil.IOStreams{
In: strings.NewReader(tc.input),
Out: &bytes.Buffer{},
ErrOut: &errBuf,
IsTerminal: tc.in,
OutIsTerminal: tc.out,
StderrIsTerminal: tc.err,
}}
offerRootUpgrade(f, &cobra.Command{})
gotPrompt := strings.Contains(errBuf.String(), "available")
if gotPrompt != tc.wantPrompt {
t.Errorf("prompt: got %v want %v (stderr=%q)", gotPrompt, tc.wantPrompt, errBuf.String())
}
if called != tc.wantRun {
t.Errorf("runRootUpgrade called: got %v want %v", called, tc.wantRun)
}
})
}
}
func TestInstallRootUpgradePromptPreservesInner(t *testing.T) {
orig := rawInvocationArgs
t.Cleanup(func() { rawInvocationArgs = orig })
rawInvocationArgs = nil
innerCalls := 0
root := &cobra.Command{Use: "lark-cli"}
root.RunE = func(cmd *cobra.Command, args []string) error { innerCalls++; return nil }
f := &cmdutil.Factory{IOStreams: &cmdutil.IOStreams{
In: strings.NewReader(""), Out: &bytes.Buffer{}, ErrOut: &bytes.Buffer{},
}}
installRootUpgradePrompt(f, root)
if err := root.RunE(root, []string{}); err != nil {
t.Fatalf("bare RunE err = %v", err)
}
if err := root.RunE(root, []string{"im"}); err != nil {
t.Fatalf("non-bare RunE err = %v", err)
}
if innerCalls != 2 {
t.Errorf("inner RunE should run for both bare and non-bare, got %d", innerCalls)
}
}
// TestRunRootUpgradeDispatchesToUpdate covers the real runRootUpgrade dispatch
// path (not the stub used elsewhere): from any command it must locate the
// registered "update" subcommand via cmd.Root() and invoke its RunE.
func TestRunRootUpgradeDispatchesToUpdate(t *testing.T) {
root := &cobra.Command{Use: "lark-cli"}
ran := 0
root.AddCommand(&cobra.Command{Use: "update", RunE: func(*cobra.Command, []string) error { ran++; return nil }})
child := &cobra.Command{Use: "im"}
root.AddCommand(child)
runRootUpgrade(child) // child.Root() resolves to root, which has "update"
if ran != 1 {
t.Errorf("runRootUpgrade should locate and run update's RunE once, got %d", ran)
}
}
// TestInstallRootUpgradePromptNilInnerNoop covers the inner == nil guard:
// when root has no RunE, installRootUpgradePrompt must not wrap it.
func TestInstallRootUpgradePromptNilInnerNoop(t *testing.T) {
root := &cobra.Command{Use: "lark-cli"} // RunE is nil
f := &cmdutil.Factory{IOStreams: &cmdutil.IOStreams{
In: strings.NewReader(""), Out: &bytes.Buffer{}, ErrOut: &bytes.Buffer{},
}}
installRootUpgradePrompt(f, root)
if root.RunE != nil {
t.Error("installRootUpgradePrompt must not wrap a nil RunE (inner==nil guard)")
}
}

View File

@@ -4,41 +4,211 @@
package service
import (
"encoding/json"
"fmt"
"io/fs"
"strings"
"github.com/larksuite/cli/internal/affordance"
"github.com/larksuite/cli/internal/cmdmeta"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/meta"
"github.com/spf13/cobra"
)
// methodLong composes a method command's long help in one place: the
// description, the affordance guidance block (when the method has one), the
// pointer to the full schema, and the params-only addendum (params whose flag
// name is taken — paramFlagBinder.paramsOnlyHelp, "" when none). Affordance
// sits near the top so an agent sees when-to-use and few-shot examples before
// the flag list.
func methodLong(description, affordance, schemaPath, paramsOnly string) string {
// PrepareDomainHelp appends navigational guidance (routing line, risk legend,
// skill pointer) to a top-level Lark domain's description, returning false for
// anything that is not such a domain. Built lazily at help time because
// shortcuts attach after service registration. skillFS (nil-safe) gates the
// skill pointer.
//
// A hand-authored Long is preserved as the base (e.g. event's "Use 'event
// consume <EventKey>'…"); service domains carry only a Short at this point, so
// we fall back to it. The pristine base is captured once into an annotation so
// re-rendering does not append the guidance twice.
func PrepareDomainHelp(cmd *cobra.Command, skillFS fs.FS) bool {
if cmd.Annotations[schemaPathAnnotation] != "" {
return false // a method command
}
// Direct child of root only — so Domain() reads this command's own tag, and
// nested resource groups are excluded.
if cmd.Parent() == nil || cmd.Parent().Parent() != nil {
return false
}
// A domain is service-sourced or shortcut-tagged; CLI tooling has neither.
if src, _ := cmdmeta.SourceOf(cmd); src != cmdmeta.SourceService && cmdmeta.Domain(cmd) == "" {
return false
}
if !cmd.HasAvailableSubCommands() {
return false
}
hasShortcuts, hasResources := false, false
for _, c := range cmd.Commands() {
if c.Hidden || c.Name() == "help" || c.Name() == "completion" {
continue
}
if strings.HasPrefix(c.Name(), "+") {
hasShortcuts = true
} else {
hasResources = true
}
}
var b strings.Builder
b.WriteString(domainHelpBase(cmd))
if hasShortcuts && hasResources { // routing only matters when both styles exist
b.WriteString("\n\nPrefer a +-prefixed shortcut when one matches your task; otherwise use the raw API resource below.")
}
b.WriteString("\n\nRisk levels (read | write | high-risk-write) appear in each command's --help; high-risk-write requires --yes, only after the user confirms.")
if skill := "lark-" + cmd.Name(); skillFS != nil {
if _, err := fs.Stat(skillFS, skill+"/SKILL.md"); err == nil {
fmt.Fprintf(&b, "\n\nDomain guide (concepts, command choice, conventions): lark-cli skills read %s", skill)
}
}
cmd.Long = b.String()
return true
}
// domainHelpBase returns the description to seed domain help with — the
// hand-authored Long when present, else the Short — captured once into an
// annotation so re-rendering reuses the pristine text instead of the
// already-augmented Long.
func domainHelpBase(cmd *cobra.Command) string {
if base, ok := cmd.Annotations[domainBaseAnnotation]; ok {
return base
}
base := cmd.Long
if base == "" {
base = cmd.Short
}
if cmd.Annotations == nil {
cmd.Annotations = map[string]string{}
}
cmd.Annotations[domainBaseAnnotation] = base
return base
}
// methodLong is the build-time Long (description + schema pointer +
// params-only addendum). Agent guidance is added lazily by PrepareMethodHelp,
// so command construction never parses the overlay.
func methodLong(description, schemaPath, paramsOnly string) string {
var b strings.Builder
b.WriteString(description)
if affordance != "" {
b.WriteString("\n\n")
b.WriteString(affordance)
}
fmt.Fprintf(&b, "\n\nView parameter definitions before calling:\n lark-cli schema %s", schemaPath)
fmt.Fprintf(&b, "\n\nFull parameter schema:\n lark-cli schema %s", schemaPath)
b.WriteString(paramsOnly)
return b.String()
}
// renderAffordance renders a method's affordance as a help block — when to use,
// prerequisites, and (most importantly for agents) few-shot Examples — or "" when
// the method carries no affordance. It reads the single typed model
// (meta.Method.ParsedAffordance) so the help and the envelope agree on shape.
// Annotation keys PrepareMethodHelp reads to rebuild a method command's Long.
const (
affordanceServiceAnnotation = "affordance-service"
affordanceMethodAnnotation = "affordance-method"
schemaPathAnnotation = "method-schema-path"
paramsOnlyAnnotation = "method-params-only"
domainBaseAnnotation = "affordance-domain-base"
)
// setMethodHelpData records the coordinates PrepareMethodHelp needs (storing a
// few strings is the only build-time cost; the overlay stays untouched).
func setMethodHelpData(cmd *cobra.Command, service, methodID, schemaPath, paramsOnly string) {
if cmd.Annotations == nil {
cmd.Annotations = map[string]string{}
}
if service != "" && methodID != "" {
cmd.Annotations[affordanceServiceAnnotation] = service
cmd.Annotations[affordanceMethodAnnotation] = methodID
}
cmd.Annotations[schemaPathAnnotation] = schemaPath
if paramsOnly != "" {
cmd.Annotations[paramsOnlyAnnotation] = paramsOnly
}
}
// PrepareMethodHelp rebuilds a generated method command's Long with the agent
// guidance at the TOP (Risk, then the affordance block, then the schema
// pointer), returning false for non-method commands. The overlay is parsed
// here — only when help is rendered.
func PrepareMethodHelp(cmd *cobra.Command) bool {
ann := cmd.Annotations
if ann == nil {
return false
}
schemaPath, ok := ann[schemaPathAnnotation]
if !ok {
return false
}
var b strings.Builder
b.WriteString(cmd.Short)
if level, ok := cmdutil.GetRisk(cmd); ok {
// --yes asserts the USER confirmed; the agent must not self-approve.
if level == cmdutil.RiskHighRiskWrite {
fmt.Fprintf(&b, "\n\nRisk: %s (requires explicit user confirmation to execute; the agent must NOT add --yes on its own — only pass --yes after the user has confirmed)", level)
} else {
fmt.Fprintf(&b, "\n\nRisk: %s", level)
}
}
var skills []string
if raw, ok := affordanceRaw(cmd); ok {
if block := renderAffordance(meta.Method{Affordance: raw}); block != "" {
b.WriteString("\n\n")
b.WriteString(block)
}
if a, ok := (meta.Method{Affordance: raw}).ParsedAffordance(); ok {
skills = a.Skills
}
}
fmt.Fprintf(&b, "\n\nFull parameter schema:\n lark-cli schema %s", schemaPath)
b.WriteString(ann[paramsOnlyAnnotation])
if len(skills) > 0 {
b.WriteString("\n\nWorkflow skill (end-to-end usage):")
for _, s := range skills {
fmt.Fprintf(&b, "\n lark-cli skills read %s", s)
}
}
cmd.Long = b.String()
return true
}
// affordanceLookup is the overlay source; a package var so tests can inject.
var affordanceLookup = affordance.For
// RenderAffordanceForCmd renders a method command's affordance block, or "" when
// it carries none.
func RenderAffordanceForCmd(cmd *cobra.Command) string {
raw, ok := affordanceRaw(cmd)
if !ok {
return ""
}
return renderAffordance(meta.Method{Affordance: raw})
}
func affordanceRaw(cmd *cobra.Command) (json.RawMessage, bool) {
if cmd.Annotations == nil {
return nil, false
}
service := cmd.Annotations[affordanceServiceAnnotation]
methodID := cmd.Annotations[affordanceMethodAnnotation]
if service == "" || methodID == "" {
return nil, false
}
return affordanceLookup(service, methodID)
}
// renderAffordance renders a method's affordance as a help block, or "" when it
// has none. Sections are joined with blank lines so they scan as distinct groups.
func renderAffordance(m meta.Method) string {
a, ok := m.ParsedAffordance()
if !ok {
return ""
}
var b strings.Builder
var sections []string
bullets := func(title string, items []string) {
var nonEmpty []string
for _, it := range items {
@@ -49,15 +219,18 @@ func renderAffordance(m meta.Method) string {
if len(nonEmpty) == 0 {
return
}
fmt.Fprintf(&b, "%s:\n", title)
var s strings.Builder
fmt.Fprintf(&s, "%s:\n", title)
for _, it := range nonEmpty {
fmt.Fprintf(&b, " • %s\n", it)
fmt.Fprintf(&s, " • %s\n", it)
}
sections = append(sections, strings.TrimRight(s.String(), "\n"))
}
bullets("When to use", a.UseWhen)
bullets("Avoid when", a.DoNotUseWhen)
bullets("Avoid when", a.AvoidWhen)
bullets("Prerequisites", a.Prerequisites)
bullets("Tips", a.Tips)
if len(a.Examples) > 0 {
var lines []string
for _, ex := range a.Examples {
@@ -71,10 +244,13 @@ func renderAffordance(m meta.Method) string {
}
}
if len(lines) > 0 {
fmt.Fprintf(&b, "Examples:\n%s\n", strings.Join(lines, "\n"))
sections = append(sections, "Examples:\n"+strings.Join(lines, "\n"))
}
}
for _, ext := range a.Extensions {
bullets(ext.Label, ext.Items)
}
bullets("Related", a.Related)
return strings.TrimRight(b.String(), "\n")
return strings.Join(sections, "\n\n")
}

View File

@@ -8,15 +8,18 @@ import (
"strings"
"testing"
"github.com/larksuite/cli/internal/cmdmeta"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/meta"
"github.com/spf13/cobra"
)
func TestRenderAffordance(t *testing.T) {
raw := json.RawMessage(`{
"use_when": ["发送文本消息"],
"do_not_use_when": ["群已解散"],
"avoid_when": ["群已解散"],
"prerequisites": ["已获取 chat_id"],
"tips": ["富文本用 msg_type=post"],
"examples": [
{"description":"发一条文本","command":"lark-cli im messages create --params '{...}'"},
{"command":"lark-cli im messages list"},
@@ -29,6 +32,7 @@ func TestRenderAffordance(t *testing.T) {
"When to use:", "发送文本消息",
"Avoid when:", "群已解散",
"Prerequisites:", "已获取 chat_id",
"Tips:", "富文本用 msg_type=post",
"Examples:", "发一条文本", "lark-cli im messages create --params '{...}'",
"lark-cli im messages list", // example with no description -> bare command line
"Related:", "im.messages.list",
@@ -48,9 +52,12 @@ func TestRenderAffordance(t *testing.T) {
}
}
func TestServiceMethod_AffordanceInLong(t *testing.T) {
// Affordance is rendered lazily (at --help time) rather than baked into the
// command's Long, so building a command never carries the affordance block —
// even for a method whose metadata happens to declare one.
func TestServiceMethod_AffordanceNotInLong(t *testing.T) {
withAff := map[string]interface{}{
"path": "messages", "httpMethod": "POST", "description": "发送消息",
"id": "messages.create", "path": "messages", "httpMethod": "POST", "description": "发送消息",
"affordance": map[string]interface{}{
"examples": []interface{}{
map[string]interface{}{"description": "发文本", "command": "lark-cli im messages create ..."},
@@ -59,14 +66,120 @@ func TestServiceMethod_AffordanceInLong(t *testing.T) {
}
f, _, _, _ := cmdutil.TestFactory(t, testConfig)
cmd := NewCmdServiceMethod(f, imSpec(), meta.FromMap(withAff), "create", "messages", nil)
if !strings.Contains(cmd.Long, "Examples:") || !strings.Contains(cmd.Long, "lark-cli im messages create ...") {
t.Errorf("affordance examples not in command Long:\n%s", cmd.Long)
if strings.Contains(cmd.Long, "Examples:") {
t.Errorf("affordance must not be baked into Long (lazy):\n%s", cmd.Long)
}
// A method with no affordance adds no guidance block.
plain := map[string]interface{}{"path": "x", "httpMethod": "GET", "description": "d"}
cmd2 := NewCmdServiceMethod(f, imSpec(), meta.FromMap(plain), "list", "x", nil)
if strings.Contains(cmd2.Long, "Examples:") {
t.Errorf("no-affordance method should have no Examples in Long:\n%s", cmd2.Long)
// The lookup ref is recorded so the help path can resolve it later.
if cmd.Annotations[affordanceServiceAnnotation] != "im" || cmd.Annotations[affordanceMethodAnnotation] != "messages.create" {
t.Errorf("affordance ref annotations = %v, want im/messages.create", cmd.Annotations)
}
}
// RenderAffordanceForCmd resolves a command's overlay through the (injectable)
// lookup and renders it; commands without a ref render nothing.
func TestRenderAffordanceForCmd(t *testing.T) {
orig := affordanceLookup
t.Cleanup(func() { affordanceLookup = orig })
affordanceLookup = func(service, methodID string) (json.RawMessage, bool) {
if service != "im" || methodID != "messages.create" {
return nil, false
}
return json.RawMessage(`{"use_when":["发文本消息"],"tips":["富文本用 msg_type=post"],"examples":[{"description":"发一条","command":"lark-cli im messages create ..."}]}`), true
}
f, _, _, _ := cmdutil.TestFactory(t, testConfig)
withRef := map[string]interface{}{"id": "messages.create", "path": "messages", "httpMethod": "POST", "description": "发送消息"}
cmd := NewCmdServiceMethod(f, imSpec(), meta.FromMap(withRef), "create", "messages", nil)
block := RenderAffordanceForCmd(cmd)
for _, want := range []string{"When to use:", "发文本消息", "Tips:", "富文本用 msg_type=post", "Examples:", "lark-cli im messages create ..."} {
if !strings.Contains(block, want) {
t.Errorf("RenderAffordanceForCmd missing %q in:\n%s", want, block)
}
}
// No overlay for this method id -> empty block.
noRef := map[string]interface{}{"id": "x.list", "path": "x", "httpMethod": "GET", "description": "d"}
cmd2 := NewCmdServiceMethod(f, imSpec(), meta.FromMap(noRef), "list", "x", nil)
if got := RenderAffordanceForCmd(cmd2); got != "" {
t.Errorf("method with no overlay should render nothing, got:\n%s", got)
}
}
// PrepareMethodHelp composes the guidance into Long at the top: description,
// then the affordance block, then the full-schema pointer — so an agent reads
// when-to-use/examples before the flag list.
func TestPrepareMethodHelp(t *testing.T) {
orig := affordanceLookup
t.Cleanup(func() { affordanceLookup = orig })
affordanceLookup = func(_, _ string) (json.RawMessage, bool) {
return json.RawMessage(`{"use_when":["发文本消息"],"examples":[{"description":"发一条","command":"lark-cli im messages create ..."}]}`), true
}
f, _, _, _ := cmdutil.TestFactory(t, testConfig)
m := map[string]interface{}{"id": "messages.create", "path": "messages", "httpMethod": "POST", "description": "发送消息"}
cmd := NewCmdServiceMethod(f, imSpec(), meta.FromMap(m), "create", "messages", nil)
if !PrepareMethodHelp(cmd) {
t.Fatal("PrepareMethodHelp returned false for a service-method command")
}
long := cmd.Long
// Description leads; affordance block sits above the schema pointer.
descAt := strings.Index(long, "发送消息")
useAt := strings.Index(long, "When to use:")
exAt := strings.Index(long, "Examples:")
schemaAt := strings.Index(long, "Full parameter schema:")
if descAt != 0 {
t.Errorf("description should lead Long, got:\n%s", long)
}
if !(descAt < useAt && useAt < exAt && exAt < schemaAt) {
t.Errorf("order should be description < affordance < schema pointer; got desc=%d use=%d ex=%d schema=%d\n%s", descAt, useAt, exAt, schemaAt, long)
}
// A non-service command (no schema-path annotation) is left untouched.
if PrepareMethodHelp(&cobra.Command{Use: "plain"}) {
t.Error("PrepareMethodHelp should return false for a non-service command")
}
}
// domainCmd wires a domain-tagged command with a subcommand under a root, the
// shape PrepareDomainHelp expects.
func domainCmd(short, long string) *cobra.Command {
root := &cobra.Command{Use: "root"}
dom := &cobra.Command{Use: "event", Short: short, Long: long}
cmdmeta.SetDomain(dom, "event")
dom.AddCommand(&cobra.Command{Use: "consume", Run: func(*cobra.Command, []string) {}})
root.AddCommand(dom)
return dom
}
func TestPrepareDomainHelp_PreservesHandAuthoredLong(t *testing.T) {
const long = "Unified event consumption system. Use 'event consume <EventKey>'."
dom := domainCmd("Consume and manage real-time events", long)
if !PrepareDomainHelp(dom, nil) {
t.Fatal("PrepareDomainHelp returned false for a domain-tagged command")
}
if !strings.HasPrefix(dom.Long, long) {
t.Errorf("hand-authored Long must lead; got:\n%s", dom.Long)
}
if !strings.Contains(dom.Long, "Risk levels") {
t.Errorf("domain guidance should be appended; got:\n%s", dom.Long)
}
// Re-rendering must not append the guidance a second time.
PrepareDomainHelp(dom, nil)
if n := strings.Count(dom.Long, "Risk levels"); n != 1 {
t.Errorf("guidance appended %d times across re-renders, want 1:\n%s", n, dom.Long)
}
}
// A service domain carries only a Short at help time; it seeds the base.
func TestPrepareDomainHelp_FallsBackToShort(t *testing.T) {
dom := domainCmd("Message and group chat management", "")
if !PrepareDomainHelp(dom, nil) {
t.Fatal("PrepareDomainHelp returned false for a domain-tagged command")
}
if !strings.HasPrefix(dom.Long, "Message and group chat management") {
t.Errorf("Short should seed Long when no hand-authored Long exists; got:\n%s", dom.Long)
}
}

View File

@@ -60,8 +60,11 @@ func TestServiceFlagGroups_AgentContract(t *testing.T) {
if i := idx("--chat-id"); i < iParams || i > iBody {
t.Errorf("--chat-id not under API Parameters:\n%s", out)
}
if !strings.Contains(out, "chat_id, required") {
t.Errorf("typed flag help format wrong:\n%s", out)
// The redundant "<name>, required|optional." prefix is gone: required-ness is
// carried by the Required:/Optional: subheadings, and the snake-case --params
// key by the schema envelope — so it isn't echoed on every flag line.
if strings.Contains(out, "chat_id, required") || strings.Contains(out, "member_id_type, optional") {
t.Errorf("redundant <name>, required/optional prefix should not appear:\n%s", out)
}
if !strings.Contains(out, "enum: open_id=以 open_id 标识用户|user_id=以 user_id 标识用户") {
t.Errorf("expected compact enum value=meaning inline:\n%s", out)

View File

@@ -30,6 +30,11 @@ func fieldFacts(f meta.Field) []string {
if d := sanitizeFieldDesc(f.Description); d != "" {
facts = append(facts, d)
}
if f.CanonicalType() == "boolean" {
// cobra shows no type word for bools and swallows a separate value as a
// positional, so spell out the presence-only contract.
facts = append(facts, "bool flag (presence = true; omit for false; takes no value)")
}
if opts := f.EnumOptions(); len(opts) > 0 {
facts = append(facts, "enum: "+formatEnumInline(opts))
}
@@ -42,20 +47,15 @@ func fieldFacts(f meta.Field) []string {
return facts
}
// paramFlagUsage renders the typed param flag's help line:
//
// <param_name>, required|optional[. <fact>]...
//
// It leads with the canonical underscore param name (the key this flag
// overrides in --params) and required/optional, then joins the field's facts
// inline.
// paramFlagUsage renders the typed param flag's help line: the field's facts
// joined inline. Required/optional is not repeated here — the grouped help's
// Required:/Optional: subheadings already partition the flags — and the
// snake-case --params key is carried by the schema envelope (each param's
// property + "flag") and the params-only addendum, so it isn't echoed on every
// line either. Returns "" when the field has no facts (cobra then shows the bare
// flag with its type).
func paramFlagUsage(f meta.Field) string {
req := "optional"
if f.Required {
req = "required"
}
parts := append([]string{fmt.Sprintf("%s, %s", f.Name, req)}, fieldFacts(f)...)
return strings.Join(parts, ". ") + "."
return strings.Join(fieldFacts(f), ". ")
}
// paramExample picks a concrete sample for a params-only field's --help snippet:
@@ -103,8 +103,23 @@ func sanitizeOptionDesc(s string) string { return inlineClause(s, "。;;\n\r",
// sanitizeFieldDesc is the field-description policy: one line per field, so
// keep full sentences and cut only at note separators (meta_data appends
// bullet notes after ;/) — the later sentence often carries the key
// affordance, e.g. user_mailbox_id's `可以输入"me"`.
func sanitizeFieldDesc(s string) string { return inlineClause(s, ";\n\r", 60) }
// affordance, e.g. user_mailbox_id's `可以输入"me"`. The trailing doc
// cross-reference is dropped first (see cutDocRef).
func sanitizeFieldDesc(s string) string { return inlineClause(cutDocRef(s), ";\n\r", 60) }
// docRefRe matches a "see the docs" breadcrumb (更多信息参见…/获取方式见…/详见…).
// On the compact flag line the markdown link's URL is stripped, so the
// breadcrumb is a dead pointer — drop it. Anchored on a leading clause separator
// so a subject that runs straight into the phrase isn't orphaned.
var docRefRe = regexp.MustCompile(`[。;;,、]\s*(更多信息|获取方式|获取方法|详见|[请可]?参[见考阅])`)
// cutDocRef truncates s at the first doc-reference breadcrumb.
func cutDocRef(s string) string {
if loc := docRefRe.FindStringIndex(s); loc != nil {
return s[:loc[0]]
}
return s
}
// formatEnumInline renders allowed values for the help line: "v=meaning" when
// the value carries a (sanitized, truncated) description — so opaque numeric

View File

@@ -7,6 +7,7 @@ import (
"context"
"fmt"
"io"
"sort"
"strings"
"github.com/larksuite/cli/errs"
@@ -64,15 +65,38 @@ func registerServiceWithContext(ctx context.Context, parent *cobra.Command, svc
// resource-command chain — one level for a flat dotted resource like
// "chat.members", deeper for genuinely nested resources. A service with no
// methods keeps its bare command (svcCmd is created above regardless).
for _, ref := range apicatalog.ServiceMethods(svc, nil) {
refs := apicatalog.ServiceMethods(svc, nil)
// Collect each resource's verbs up front so resourceShort can summarize a
// resource as its verb list from the first ensureChildCommand call.
verbs := map[string][]string{}
for _, ref := range refs {
key := strings.Join(ref.ResourcePath, ".")
verbs[key] = append(verbs[key], ref.Method.Name)
}
for _, ref := range refs {
resCmd := svcCmd
var path []string
for _, seg := range ref.ResourcePath {
resCmd = ensureChildCommand(resCmd, seg, seg+" operations")
path = append(path, seg)
resCmd = ensureChildCommand(resCmd, seg, resourceShort(seg, verbs[strings.Join(path, ".")]))
}
resCmd.AddCommand(buildMethodCommand(ctx, f, newMethodCommandSpec(ref), nil, parent.PersistentFlags()))
}
}
// resourceShort summarizes a resource as its sorted verb list, or the
// "<name> operations" placeholder for an intermediate group with no methods.
func resourceShort(seg string, verbs []string) string {
if len(verbs) == 0 {
return seg + " operations"
}
sorted := append([]string(nil), verbs...)
sort.Strings(sorted)
return strings.Join(sorted, ", ")
}
// serviceShort is the service command's help summary: the localized description
// from the registry, falling back to the metadata's own description.
func serviceShort(svc meta.Service) string {
@@ -177,7 +201,19 @@ type methodCommandSpec struct {
// the API declares a body.
acceptsBody bool
declaresBody bool
affordance string // rendered hand-authored usage guidance (when-to-use, examples); "" if none
paginates bool // method accepts a page_token param (so --page-all is meaningful)
serviceName string // owning service name (e.g. "approval"), for the lazy affordance lookup
}
// methodPaginates reports whether a method takes a page_token param, the signal
// that makes the --page-all/--page-limit/--page-delay flags meaningful.
func methodPaginates(m meta.Method) bool {
for _, f := range m.Params() {
if f.Name == "page_token" {
return true
}
}
return false
}
func newMethodCommandSpec(ref apicatalog.MethodRef) methodCommandSpec {
@@ -186,6 +222,7 @@ func newMethodCommandSpec(ref apicatalog.MethodRef) methodCommandSpec {
method: m,
schemaPath: ref.SchemaPath(),
servicePath: ref.Service.ServicePath,
serviceName: ref.Service.Name,
risk: m.Risk,
restricts: m.RestrictsIdentity(),
identities: m.Identities(),
@@ -193,7 +230,7 @@ func newMethodCommandSpec(ref apicatalog.MethodRef) methodCommandSpec {
fileFields: detectFileFields(m),
acceptsBody: methodTakesBody(m.HTTPMethod),
declaresBody: len(m.Data()) > 0 || len(m.Files()) > 0,
affordance: renderAffordance(m),
paginates: methodPaginates(m),
}
}
@@ -254,6 +291,14 @@ func buildMethodCommand(ctx context.Context, f *cmdutil.Factory, spec methodComm
cmd.Flags().BoolVar(&opts.PageAll, "page-all", false, "automatically paginate through all pages")
cmd.Flags().IntVar(&opts.PageLimit, "page-limit", 10, "max pages to fetch with --page-all (0 = unlimited)")
cmd.Flags().IntVar(&opts.PageDelay, "page-delay", 200, "delay in ms between pages")
// Keep the pagination flags registered (a harmless no-op if passed) but hide
// them from help on non-paginating commands, so help doesn't imply a
// get/write can paginate.
if !spec.paginates {
for _, name := range []string{"page-all", "page-limit", "page-delay"} {
_ = cmd.Flags().MarkHidden(name)
}
}
cmd.Flags().StringVar(&opts.Format, "format", "json", "output format: json|ndjson|table|csv")
cmd.Flags().Bool("json", false, "shorthand for --format json")
cmd.Flags().StringVarP(&opts.JqExpr, "jq", "q", "", "jq expression to filter JSON output")
@@ -271,10 +316,11 @@ func buildMethodCommand(ctx context.Context, f *cmdutil.Factory, spec methodComm
// Registered last so the collision guard sees the standard flags above.
opts.binder = newParamFlagBinder(cmd, spec.params, reserved)
// Single composition point for Long: description, affordance, schema
// pointer, and the binder's params-only addendum (params whose flag name is
// taken, reachable via --params only).
cmd.Long = methodLong(m.Description, spec.affordance, spec.schemaPath, opts.binder.paramsOnlyHelp())
// Build-time Long; the agent guidance is added lazily by PrepareMethodHelp
// (setMethodHelpData records the coordinates it needs).
paramsOnly := opts.binder.paramsOnlyHelp()
cmd.Long = methodLong(m.Description, spec.schemaPath, paramsOnly)
setMethodHelpData(cmd, spec.serviceName, m.ID, spec.schemaPath, paramsOnly)
// Group flags for the grouped --help renderer (typed param flags are grouped
// as API Parameters by the binder). tagFlagGroup is a no-op for flags not
@@ -292,13 +338,11 @@ func buildMethodCommand(ctx context.Context, f *cmdutil.Factory, spec methodComm
tagFlagGroup(cmd.Flags(), "file", groupBody)
if fl := cmd.Flags().Lookup("params"); fl != nil {
annotate(fl, flagGroupAnnotation, []string{groupRaw})
// State the precedence rule where the agent reads it: --params is the
// base, typed flags override. Only meaningful when typed flags exist.
// Keep the precedence rule on the flag's own one line (not a multi-line
// note that breaks the one-entry-per-flag rhythm an agent parses). Only
// meaningful when typed flags exist to override.
if len(spec.params) > 0 {
annotate(fl, flagNoteAnnotation, []string{
"Typed API parameter flags above are preferred.",
"If both are set, typed flags override matching keys in --params.",
})
fl.Usage = "Raw URL/query params JSON. Supports - and @file. If both set, typed flags override matching keys in --params."
}
}
for _, name := range []string{"as", "dry-run", "page-all", "page-limit", "page-delay", "yes"} {

169
cmd/whoami/whoami.go Normal file
View File

@@ -0,0 +1,169 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package whoami
import (
"context"
"github.com/spf13/cobra"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
"github.com/larksuite/cli/internal/identitydiag"
"github.com/larksuite/cli/internal/output"
)
// whoamiResult is the structured output of `lark-cli whoami`.
//
// The self-vs-delegated distinction is carried by `identity`: a bot identity is
// the app acting as itself; a user identity is the app acting *on behalf of* a
// person (calls are attributed to that user, who is not necessarily present).
// onBehalfOf only *names* that person and so appears only once a user is
// resolved — a user identity that is not signed in still has identity "user"
// but no onBehalfOf yet. Do not read "no onBehalfOf" as "self"; read `identity`.
type whoamiResult struct {
Profile string `json:"profile"`
AppID string `json:"appId"`
Brand core.LarkBrand `json:"brand"`
DefaultAs string `json:"defaultAs"`
Identity string `json:"identity"`
IdentitySource string `json:"identitySource"`
Available bool `json:"available"`
TokenStatus string `json:"tokenStatus"`
OnBehalfOf *delegatedUser `json:"onBehalfOf,omitempty"`
Hint string `json:"hint,omitempty"`
}
// delegatedUser is the user a user-identity acts on behalf of.
type delegatedUser struct {
UserName string `json:"userName,omitempty"`
OpenID string `json:"openId,omitempty"`
}
// Options holds inputs for the whoami command.
type Options struct {
Factory *cmdutil.Factory
As string
}
// NewCmdWhoami creates the top-level whoami command. It reports the identity
// that the next API call would actually use (resolved via Factory.ResolveAs),
// together with the active profile, app, and token status. Output is always
// JSON — whoami is consumed by agents. With the built-in credential path it is
// local-only; when an external credential provider manages tokens, resolving
// the identity may contact that provider.
func NewCmdWhoami(f *cmdutil.Factory) *cobra.Command {
return NewCmdWhoamiWithContext(context.Background(), f)
}
// NewCmdWhoamiWithContext creates the whoami command using the build context
// for registration-time strict-mode presentation.
func NewCmdWhoamiWithContext(ctx context.Context, f *cmdutil.Factory) *cobra.Command {
opts := &Options{Factory: f}
cmd := &cobra.Command{
Use: "whoami",
Short: "Show the current effective identity, app, profile, and token status (JSON)",
RunE: func(cmd *cobra.Command, args []string) error {
return whoamiRun(cmd, opts)
},
}
cmdutil.DisableAuthCheck(cmd)
cmdutil.AddAPIIdentityFlag(ctx, cmd, f, &opts.As)
// Output is always JSON. Accept (and ignore) --json so existing
// `whoami --json` callers don't break; hide it to avoid implying a non-JSON
// mode exists.
cmd.Flags().Bool("json", true, "deprecated: output is always JSON")
_ = cmd.Flags().MarkHidden("json")
cmdutil.SetRisk(cmd, "read")
return cmd
}
func whoamiRun(cmd *cobra.Command, opts *Options) error {
f := opts.Factory
cfg, err := f.Config()
if err != nil {
return err
}
ctx := cmd.Context()
flagAs := core.Identity(opts.As)
as := f.ResolveAs(ctx, cmd, flagAs)
// Validate as a real API call does (strict mode, then identity) so whoami
// can't preview an identity the next call would refuse.
if err := f.CheckStrictMode(ctx, as); err != nil {
return err
}
if err := f.CheckIdentity(as, []string{"user", "bot"}); err != nil {
return err
}
source := resolveSource(
cmd.Flags().Changed("as"),
flagAs,
f.IdentityAutoDetected,
f.ResolveStrictMode(ctx).ForcedIdentity(),
)
diag := identitydiag.Diagnose(ctx, f, cfg, false)
res := buildResult(cfg, as, source, diag)
output.PrintJson(f.IOStreams.Out, res)
return nil
}
// resolveSource derives how the effective identity became effective.
// Mirrors Factory.ResolveAs precedence: explicit flag wins; otherwise an
// auto-detected result means auto-detect; otherwise a strict-mode forced
// identity means strict-mode; otherwise it came from configured default-as.
// Values are snake_case to match the other enum fields (e.g. tokenStatus).
func resolveSource(changedAs bool, flagAs core.Identity, autoDetected bool, strictForced core.Identity) string {
if changedAs && (flagAs == core.AsUser || flagAs == core.AsBot) {
return "flag"
}
if autoDetected {
return "auto_detect"
}
if strictForced != "" {
return "strict_mode"
}
return "default_as"
}
// buildResult maps the resolved identity and local diagnostics into the output.
// ResolveAs only ever returns user or bot, so the default branch handles user.
func buildResult(cfg *core.CliConfig, as core.Identity, source string, diag identitydiag.Result) *whoamiResult {
defaultAs := cfg.DefaultAs
if defaultAs == "" {
defaultAs = core.AsAuto
}
res := &whoamiResult{
Profile: cfg.ProfileName,
AppID: cfg.AppID,
Brand: cfg.Brand,
DefaultAs: string(defaultAs),
Identity: string(as),
IdentitySource: source,
}
// Use the diagnosed hint as-is: it is tailored to the credential source, so
// it never says "auth login" when that is blocked under an external provider.
switch as {
case core.AsBot:
res.Available = diag.Bot.Available
res.TokenStatus = diag.Bot.Status
if !diag.Bot.Available {
res.Hint = diag.Bot.Hint
}
default: // user
res.Available = diag.User.Available
// Use Status (not the raw TokenStatus) so the vocab matches the bot
// branch: "ready" means usable for both. available stays the canonical
// usable signal; tokenStatus is the readable state behind it.
res.TokenStatus = diag.User.Status
// Set onBehalfOf only when a user is actually resolved; an unresolved
// user identity (not signed in) has no one to act on behalf of yet.
if diag.User.UserName != "" || diag.User.OpenID != "" {
res.OnBehalfOf = &delegatedUser{UserName: diag.User.UserName, OpenID: diag.User.OpenID}
}
if !diag.User.Available {
res.Hint = diag.User.Hint
}
}
return res
}

320
cmd/whoami/whoami_test.go Normal file
View File

@@ -0,0 +1,320 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package whoami
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"strings"
"testing"
"github.com/larksuite/cli/errs"
extcred "github.com/larksuite/cli/extension/credential"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
"github.com/larksuite/cli/internal/credential"
"github.com/larksuite/cli/internal/identitydiag"
)
func TestResolveSource(t *testing.T) {
tests := []struct {
name string
changedAs bool
flagAs core.Identity
autoDetected bool
strictForced core.Identity
want string
}{
{"explicit flag user", true, core.AsUser, false, "", "flag"},
{"explicit flag bot", true, core.AsBot, false, "", "flag"},
{"flag auto falls through to auto-detect", true, core.AsAuto, true, "", "auto_detect"},
{"auto detected", false, "", true, "", "auto_detect"},
{"strict mode", false, "", false, core.AsBot, "strict_mode"},
{"default_as", false, "", false, "", "default_as"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := resolveSource(tt.changedAs, tt.flagAs, tt.autoDetected, tt.strictForced)
if got != tt.want {
t.Errorf("resolveSource() = %q, want %q", got, tt.want)
}
})
}
}
func TestBuildResult_UserValid(t *testing.T) {
cfg := &core.CliConfig{ProfileName: "my-app", AppID: "cli_x", Brand: core.BrandLark, DefaultAs: core.AsAuto}
diag := identitydiag.Result{
User: identitydiag.Identity{Available: true, Status: "ready", TokenStatus: "valid", OpenID: "ou_x", UserName: "Alice"},
}
r := buildResult(cfg, core.AsUser, "auto_detect", diag)
if r.Identity != "user" || r.IdentitySource != "auto_detect" {
t.Fatalf("identity/source = %q/%q", r.Identity, r.IdentitySource)
}
// tokenStatus mirrors the unified Status vocab ("ready"), not the raw "valid".
if !r.Available || r.TokenStatus != "ready" {
t.Fatalf("available=%v status=%q", r.Available, r.TokenStatus)
}
if r.OnBehalfOf == nil || r.OnBehalfOf.OpenID != "ou_x" || r.OnBehalfOf.UserName != "Alice" {
t.Fatalf("onBehalfOf = %#v, want Alice/ou_x", r.OnBehalfOf)
}
if r.Hint != "" {
t.Fatalf("hint = %q, want empty", r.Hint)
}
if r.Profile != "my-app" || r.AppID != "cli_x" || r.Brand != core.BrandLark {
t.Fatalf("app context = %#v", r)
}
}
func TestBuildResult_UserMissingToken(t *testing.T) {
cfg := &core.CliConfig{ProfileName: "p", AppID: "cli_x", Brand: core.BrandLark}
diag := identitydiag.Result{
User: identitydiag.Identity{Available: false, Status: "missing", Hint: "run: lark-cli auth login --help"}, // never logged in
}
r := buildResult(cfg, core.AsUser, "auto_detect", diag)
if r.Available {
t.Fatalf("available = true, want false")
}
if r.TokenStatus != "missing" {
t.Fatalf("tokenStatus = %q, want missing", r.TokenStatus)
}
// whoami renders the diagnosed hint verbatim (single source of truth) so it
// stays correct for the external-provider path without whoami knowing about it.
if r.Hint != diag.User.Hint {
t.Fatalf("hint = %q, want propagated %q", r.Hint, diag.User.Hint)
}
if r.DefaultAs != "auto" {
t.Fatalf("defaultAs = %q, want auto (empty normalized)", r.DefaultAs)
}
}
func TestBuildResult_BotReady(t *testing.T) {
cfg := &core.CliConfig{ProfileName: "p", AppID: "cli_x", Brand: core.BrandFeishu, DefaultAs: core.AsBot}
diag := identitydiag.Result{
Bot: identitydiag.Identity{Available: true, Status: "ready"},
}
r := buildResult(cfg, core.AsBot, "default_as", diag)
if r.Identity != "bot" || r.IdentitySource != "default_as" {
t.Fatalf("identity/source = %q/%q", r.Identity, r.IdentitySource)
}
if !r.Available || r.TokenStatus != "ready" {
t.Fatalf("available=%v status=%q", r.Available, r.TokenStatus)
}
if r.OnBehalfOf != nil {
t.Fatalf("bot must not carry onBehalfOf: %#v", r.OnBehalfOf)
}
if r.Hint != "" {
t.Fatalf("hint = %q, want empty", r.Hint)
}
}
func TestBuildResult_BotNotConfigured(t *testing.T) {
cfg := &core.CliConfig{ProfileName: "p", AppID: "cli_x", Brand: core.BrandFeishu}
diag := identitydiag.Result{
Bot: identitydiag.Identity{Available: false, Status: "not_configured", Hint: "run: lark-cli config --help"},
}
r := buildResult(cfg, core.AsBot, "auto_detect", diag)
if r.Available {
t.Fatalf("available = true, want false")
}
if r.TokenStatus != "not_configured" {
t.Fatalf("tokenStatus = %q, want not_configured", r.TokenStatus)
}
if r.Hint != diag.Bot.Hint {
t.Fatalf("hint = %q, want propagated %q", r.Hint, diag.Bot.Hint)
}
}
func TestWhoami_BotJSON(t *testing.T) {
f, stdout, _, _ := cmdutil.TestFactory(t, &core.CliConfig{
ProfileName: "test-profile", AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,
})
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{}) // bare whoami: output is always JSON, no flag needed
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v", err)
}
var got whoamiResult
if err := json.Unmarshal(stdout.Bytes(), &got); err != nil {
t.Fatalf("json.Unmarshal() error = %v\n%s", err, stdout.String())
}
if got.Identity != "bot" {
t.Fatalf("identity = %q, want bot", got.Identity)
}
if !got.Available || got.TokenStatus != "ready" {
t.Fatalf("available=%v status=%q, want true/ready", got.Available, got.TokenStatus)
}
if got.Profile != "test-profile" {
t.Fatalf("profile = %q, want test-profile", got.Profile)
}
if got.IdentitySource == "" {
t.Fatalf("identitySource empty")
}
if got.OnBehalfOf != nil {
t.Fatalf("bot (self) must not carry onBehalfOf: %#v", got.OnBehalfOf)
}
}
func TestWhoami_RejectsInvalidAs(t *testing.T) {
for _, bad := range []string{"admin", "USER", "bogus123", ""} {
t.Run("as="+bad, func(t *testing.T) {
f, _, _, _ := cmdutil.TestFactory(t, &core.CliConfig{
ProfileName: "p", AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,
})
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{"--as", bad})
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() with --as %q = nil, want validation error", bad)
}
// Lock in the typed validation contract: an unsupported identity must
// surface as a *errs.ValidationError on --as, not just any error.
var ve *errs.ValidationError
if !errors.As(err, &ve) {
t.Fatalf("Execute() with --as %q: error type = %T, want *errs.ValidationError: %v", bad, err, err)
}
if ve.Subtype != errs.SubtypeInvalidArgument {
t.Errorf("Subtype = %q, want %q", ve.Subtype, errs.SubtypeInvalidArgument)
}
if ve.Param != "--as" {
t.Errorf("Param = %q, want %q", ve.Param, "--as")
}
})
}
}
func TestWhoami_ConfigErrorPropagates(t *testing.T) {
f, _, _, _ := cmdutil.TestFactory(t, &core.CliConfig{
ProfileName: "p", AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,
})
wantErr := fmt.Errorf("boom")
f.Config = func() (*core.CliConfig, error) { return nil, wantErr }
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{"--json"})
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() error = nil, want propagated config error")
}
// The f.Config() failure must propagate unchanged, not be masked by a later
// command-execution error.
if !errors.Is(err, wantErr) {
t.Fatalf("Execute() error = %v, want it to wrap %v", err, wantErr)
}
}
func TestWhoami_StrictModeRejectsCrossIdentity(t *testing.T) {
// Bot-only account → strict mode bot. A real `--as user` call would be
// rejected by CheckStrictMode; whoami must reject it identically rather than
// previewing a user identity the next call would refuse.
f, _, _, _ := cmdutil.TestFactory(t, &core.CliConfig{
ProfileName: "p", AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,
SupportedIdentities: 2, // bot only
})
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{"--as", "user", "--json"})
err := cmd.Execute()
if err == nil {
t.Fatalf("Execute() with --as user under strict bot = nil, want strict-mode rejection")
}
var ve *errs.ValidationError
if !errors.As(err, &ve) {
t.Fatalf("error type = %T, want *errs.ValidationError: %v", err, err)
}
}
type fakeExtProvider struct {
name string
account *extcred.Account
}
func (p *fakeExtProvider) Name() string { return p.name }
func (p *fakeExtProvider) ResolveAccount(context.Context) (*extcred.Account, error) {
return p.account, nil
}
func (p *fakeExtProvider) ResolveToken(context.Context, extcred.TokenSpec) (*extcred.Token, error) {
return nil, nil // no UAT served locally; whoami runs with verify=false
}
func externalWhoamiFactory(cfg *core.CliConfig) (*cmdutil.Factory, *bytes.Buffer) {
cred := credential.NewCredentialProvider(
[]extcred.Provider{&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: cfg.AppID}}},
nil, nil,
func() (*http.Client, error) { return nil, nil },
)
out := &bytes.Buffer{}
f := &cmdutil.Factory{
Config: func() (*core.CliConfig, error) { return cfg, nil },
Credential: cred,
IOStreams: &cmdutil.IOStreams{Out: out, ErrOut: &bytes.Buffer{}},
}
return f, out
}
// Regression for the external-provider blind spot: with credentials managed by
// an extension provider, a signed-in user must read as available, and an
// unavailable identity must not be told to "auth login" (which is blocked).
func TestWhoami_ExternalProvider_UserReady(t *testing.T) {
cfg := &core.CliConfig{
ProfileName: "p", AppID: "cli_x", Brand: core.BrandFeishu,
SupportedIdentities: uint8(extcred.SupportsAll), UserOpenId: "ou_x", UserName: "Alice",
}
f, out := externalWhoamiFactory(cfg)
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{"--as", "user", "--json"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v", err)
}
var got whoamiResult
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
t.Fatalf("Unmarshal: %v\n%s", err, out.String())
}
if got.Identity != "user" || !got.Available || got.TokenStatus != "ready" {
t.Fatalf("got %#v, want user/available/ready", got)
}
if got.OnBehalfOf == nil || got.OnBehalfOf.UserName != "Alice" || got.OnBehalfOf.OpenID != "ou_x" {
t.Fatalf("onBehalfOf = %#v, want Alice/ou_x (delegated)", got.OnBehalfOf)
}
if got.Hint != "" {
t.Fatalf("hint = %q, want empty when available", got.Hint)
}
}
func TestWhoami_ExternalProvider_UserHintNotKeychain(t *testing.T) {
cfg := &core.CliConfig{
ProfileName: "p", AppID: "cli_x", Brand: core.BrandFeishu,
SupportedIdentities: uint8(extcred.SupportsUser), // user supported but not signed in
}
f, out := externalWhoamiFactory(cfg)
cmd := NewCmdWhoami(f)
cmd.SetArgs([]string{"--as", "user", "--json"})
if err := cmd.Execute(); err != nil {
t.Fatalf("Execute() error = %v", err)
}
var got whoamiResult
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
t.Fatalf("Unmarshal: %v\n%s", err, out.String())
}
if got.Identity != "user" || got.Available {
t.Fatalf("got identity=%q available=%v, want user/false", got.Identity, got.Available)
}
if strings.Contains(got.Hint, "auth login") {
t.Fatalf("hint must not point at auth login under external provider: %q", got.Hint)
}
if !strings.Contains(got.Hint, "external") {
t.Fatalf("hint should explain external management: %q", got.Hint)
}
}

41
content_embed.go Normal file
View File

@@ -0,0 +1,41 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package main
import (
"embed"
"fmt"
"io/fs"
"os"
"github.com/larksuite/cli/cmd"
"github.com/larksuite/cli/internal/affordance"
)
// embeddedContentFS bundles the agent-readable content that must ship in lockstep
// with the binary: each skill's docs (SKILL.md + references/, plus whiteboard's
// routes/ and scenes/) and the per-domain affordance guidance (affordance/*.md).
// Machine-resource skill dirs (assets/, scripts/) are excluded. It's a whitelist —
// a new content type is omitted until added to the embed list. The embed must live
// in this root package because go:embed cannot reach up out of a package's dir.
//
//go:embed skills/*/SKILL.md skills/*/references skills/*/routes skills/*/scenes affordance/*.md
var embeddedContentFS embed.FS
// init wires the embedded content into the CLI. It compiles into `go build .` but
// not the single-file preview build (`go build ./main.go`), so that build stays
// self-contained (shipping no embedded content). Assembly failures warn on stderr
// rather than panicking — embedded content is nice-to-have, not load-bearing.
func init() {
if sub, err := fs.Sub(embeddedContentFS, "skills"); err != nil {
fmt.Fprintln(os.Stderr, "warning: skills embed assembly failed, skills commands disabled:", err)
} else {
cmd.SetEmbeddedSkillContent(sub)
}
if sub, err := fs.Sub(embeddedContentFS, "affordance"); err != nil {
fmt.Fprintln(os.Stderr, "warning: affordance embed assembly failed, command guidance disabled:", err)
} else {
affordance.SetSource(sub)
}
}

View File

@@ -0,0 +1,259 @@
# `slides +create-svglide` Codex Runtime Design
Date: 2026-07-02
Branch: `feat-svglide-07`
Scope: first local-only version of `lark-cli slides +create-svglide`
## Result
Build `slides +create-svglide` as a staged local runtime for AnyGen SVG Slides. The command creates and manages a run directory that Codex can fill with generated content, assets, and SVG slides. The CLI owns state, prompts, schemas, validation, preview, receipts, and recovery. Codex owns LLM reasoning, web research, image/search execution, chart design, and SVG authoring.
The first version does not publish to Feishu Slides. It must produce a local, inspectable SVG deck workbench.
## Context
`feat-svglide-07` currently starts from the latest `origin/main` and has only the existing Slides XML shortcut surface. There is no current `+create-svglide` implementation on this branch.
The AnyGen SVG Slides prompt should be reused as contracts and workflow rules, not pasted as one large prompt. Its value is split across request interpretation, research, design brief, outline, `slide_content.md`, asset planning, SVG authoring, protocol validation, preview, and repair.
## Goals
- Add a staged `slides +create-svglide` command group.
- Create a local run directory under a user-specified `--out` path, usually `.lark-slides/svglide-runs/<run-id>`.
- Generate prompt task files that tell Codex exactly what to produce for each stage.
- Generate JSON schemas for stage outputs.
- Track stage state in `run.json`.
- Validate JSON outputs, SVG protocol basics, asset href existence, slide count, placeholder slides, and preview generation.
- Generate `preview.html` for local inspection.
- Write receipts and `repair_queue.md` so failed runs can resume from the current stage.
## Non-Goals
- No online Feishu Slides creation.
- No `slide_engine` or `slide` server changes.
- No SVG-to-SXSD conversion.
- No built-in model API provider.
- No built-in web search, image generation, or image search client.
- No complete 12-agent process runner.
- No PPTX import/edit workflow.
## Command Surface
```bash
lark-cli slides +create-svglide init --title "Demo" --input ./source.md --audience "..." --delivery-mode self_read --pages 8 --out ./.lark-slides/svglide-runs/demo
lark-cli slides +create-svglide next <run-dir>
lark-cli slides +create-svglide status <run-dir>
lark-cli slides +create-svglide validate <run-dir>
lark-cli slides +create-svglide preview <run-dir>
```
`init` creates the run directory, writes the initial request files, schemas, stage prompts, and `run.json`.
`next` reads `run.json`, finds the next stage, verifies required inputs, renders or refreshes that stage's Codex task prompt, and reports the exact files Codex must create. It must not pretend LLM work is complete.
`status` checks declared outputs and receipts for each stage, then prints the current stage, missing files, and next useful command.
`validate` runs deterministic checks and writes validation receipts.
`preview` writes `preview.html` from `outline/deck.json` and `slides/*.svg`.
## Run Directory Contract
```text
<run-dir>/
run.json
README.md
request/request.json
request/source_manifest.json
research/research_notes.md
research/sources.json
brief/design_brief.json
brief/visual_system.json
outline/deck.json
content/slide_content.md
content/slide_content.json
assets/assets_plan.json
assets/images/
assets/charts/
slides/*.svg
prompts/*.task.md
schemas/*.schema.json
receipts/*.json
receipts/generation_summary.md
repair_queue.md
preview.html
```
The run directory is local agent state. It should not be committed by default.
## State Model
`run.json` stores:
- version
- runtime, always `codex` in v1
- command name
- title
- created and updated timestamps
- current stage
- stage list with status, inputs, outputs, and receipt path
- important artifact paths
- policy flags: `publish_enabled=false`, `network_by_codex=true`, `image_generation_by_codex=true`, `overwrite=false`
Stage statuses:
```text
pending
ready
in_progress
done
failed
blocked
needs_repair
```
## Stage Design
### 1. request
Role: Request Interpreter
Input: CLI flags and local source path.
Output: `request/request.json`, `request/source_manifest.json`.
Validation: title, audience, delivery mode, page count, and source references must be explicit or marked missing.
### 2. research
Role: Researcher
Input: request files and source files.
Output: `research/research_notes.md`, `research/sources.json`.
Validation: key facts need source references. Codex may perform web research, but the CLI only validates resulting files.
### 3. design_brief
Role: Design Brief Resolver and Visual System Planner
Input: request and research outputs.
Output: `brief/design_brief.json`, `brief/visual_system.json`.
Validation: narrative spine, depth, tone, and visual system dimensions must be present.
### 4. outline
Role: Outline Planner
Input: design brief.
Output: `outline/deck.json`.
Validation: page count matches request; each slide has id, title, summary, role, and key message.
### 5. slide_content
Role: Content Builder
Input: deck outline and research notes.
Output: `content/slide_content.md`, `content/slide_content.json`.
Validation: every slide has key material, content blocks, and source notes. This is content planning, not final layout.
### 6. assets
Role: Asset Planner and Chart Generator
Input: slide content and visual system.
Output: `assets/assets_plan.json`, optional `assets/images/*`, optional `assets/charts/*.svg`.
Validation: every planned asset has purpose plus either a local path or a fallback. Chart takeaway must be written before chart type.
### 7. svg_author
Role: SVG Author
Input: deck, slide content, visual system, and assets.
Output: `slides/*.svg`.
Validation: each slide must contain more than a background. Each slide needs a background, title, visible content or visual element, semantic id, and valid SVG root.
### 8. validate_preview_repair
Role: Protocol Validator, Preview Agent, and Repair Agent
Input: generated slides.
Output: `receipts/lint.json`, `receipts/preview.json`, `repair_queue.md`, `preview.html`.
Validation: SVG protocol lint, local href checks, slide count match, preview write success, and unresolved issues recorded in the repair queue.
## Code Layout
```text
shortcuts/slides/
slides_create_svglide.go
slides_create_svglide_test.go
internal/svglide/
run.go
init.go
stage.go
prompt.go
schema.go
validate.go
preview.go
receipt.go
```
The shortcut package should stay thin. State, prompt rendering, validation, and preview logic belong in `internal/svglide` so they can be tested without a Cobra/runtime-heavy command harness.
## Skill Documentation
Update `skills/lark-slides/SKILL.md` and add a focused reference file for the local SVG runtime. The skill should explain that `+create-svglide` is local-only in v1, requires Codex to fill stage outputs, and must not be described as an online publish path.
## Error Handling
- Missing required inputs block the stage and write a receipt.
- Invalid JSON or schema mismatch marks the stage failed.
- Invalid SVG marks `needs_repair` and writes `repair_queue.md`.
- Existing output paths are not overwritten unless an explicit overwrite policy is enabled.
- Partially completed stages remain inspectable; reruns resume from the current stage.
## Tests
Unit tests:
- `init` creates the expected directory tree and `run.json`.
- `init` refuses to overwrite an existing run directory by default.
- `status` identifies missing outputs.
- `next` renders the correct stage prompt and does not mark Codex-only stages done.
- `validate` catches invalid SVG, missing hrefs, placeholder slides, and slide count mismatch.
- `preview` writes HTML that references generated SVG files.
Fixtures:
- `testdata/svglide_run_valid/`
- `testdata/svglide_run_invalid/`
No live end-to-end test is required for v1 because this version does not call Feishu APIs.
## Acceptance Criteria
- A user can initialize a run directory from local input.
- Codex can follow generated task prompts stage by stage.
- The CLI can report status and missing artifacts.
- The CLI can validate a completed local SVG deck.
- The CLI can generate local preview HTML.
- Failed validation produces actionable repair output.
- No online presentation is created.
## Further Judgment
This design deliberately optimizes for artifact contracts rather than agent-count symmetry. Once the local runtime is stable, individual stages can be split into fuller agents without changing the run directory contract.

2420
docs/vendor/anygen-svg/source.full.md vendored Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,8 @@
{
"doc_url": "https://bytedance.larkoffice.com/docx/KnCLd7xr5ohWONxhKsncZ3Lxnvd",
"local_full_snapshot": "/Users/bytedance/Documents/Codex/2026-07-01/https-bytedance-larkoffice-com-docx-kncld7xr5ohwonxhksncz3lxnvd/outputs/lark_doc_KnCLd7xr5ohWONxhKsncZ3Lxnvd/full.md",
"local_handoff": "/Users/bytedance/Documents/Codex/2026-07-01/https-bytedance-larkoffice-com-docx-kncld7xr5ohwonxhksncz3lxnvd/outputs/anygen-slides-svg-prompt-handoff.md",
"fetched_by": "local export",
"fetched_for": "slides +create-svglide AnyGen SVG prompt runtime experiment",
"experiment_mode": "experiment_unrestricted_assets"
}

View File

@@ -0,0 +1,20 @@
# AnyGen SVG Slides Local Outline
Source full snapshot: `docs/vendor/anygen-svg/source.full.md`
Source handoff: `/Users/bytedance/Documents/Codex/2026-07-01/https-bytedance-larkoffice-com-docx-kncld7xr5ohwonxhksncz3lxnvd/outputs/anygen-slides-svg-prompt-handoff.md`
Remote doc: `https://bytedance.larkoffice.com/docx/KnCLd7xr5ohWONxhKsncZ3Lxnvd`
Required sections to split:
- System prompt编排 / mode_system_prompt_svg
- SVG reference协议 schema + 设计规范 / svg_reference
- resolve_design_brief
- slide_outline
- activate_slides_edit
- slides_edit
- finish_slides_edit
- slide_organize
- compute_custom_shape_bbox
- generate_svg_chart
- slides_convert
- slides_parse_template

View File

@@ -319,7 +319,7 @@ func TestPermissionError_FullChain(t *testing.T) {
WithHint("run: lark-cli auth login --scope %q", "mail:user_mailbox.message:send").
WithMissingScopes("mail:user_mailbox.message:send").
WithIdentity("user").
WithConsoleURL("https://open.feishu.cn/app/cli_xxx/auth")
WithConsoleURL("https://open.feishu.cn/page/scope-apply?clientID=cli_xxx&scopes=mail:user_mailbox.message:send")
if got.Category != errs.CategoryAuthorization {
t.Errorf("Category = %q, want %q", got.Category, errs.CategoryAuthorization)
@@ -419,7 +419,7 @@ func TestBuilder_WireFormat(t *testing.T) {
WithHint("run lark-cli auth login --scope calendar:event:create").
WithMissingScopes("calendar:event:create").
WithIdentity("user").
WithConsoleURL("https://open.feishu.cn/app/cli_xxx/auth")
WithConsoleURL("https://open.feishu.cn/page/scope-apply?clientID=cli_xxx&scopes=calendar:event:create")
buf, err := json.Marshal(e)
if err != nil {
@@ -439,7 +439,7 @@ func TestBuilder_WireFormat(t *testing.T) {
"hint": "run lark-cli auth login --scope calendar:event:create",
"log_id": "20260520-0a1b2c3d",
"identity": "user",
"console_url": "https://open.feishu.cn/app/cli_xxx/auth",
"console_url": "https://open.feishu.cn/page/scope-apply?clientID=cli_xxx&scopes=calendar:event:create",
"missing_scopes": []any{"calendar:event:create"},
}
for k, want := range wantFields {

View File

@@ -0,0 +1,62 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package vc
import (
"context"
"encoding/json"
"github.com/larksuite/cli/internal/event"
)
// VCParticipantMeetingJoinedOutput is the flattened shape for vc.meeting.participant_meeting_joined_v1.
type VCParticipantMeetingJoinedOutput struct {
Type string `json:"type" desc:"Event type; always vc.meeting.participant_meeting_joined_v1"`
EventID string `json:"event_id,omitempty" desc:"Globally unique event ID; safe for deduplication"`
Timestamp string `json:"timestamp,omitempty" desc:"Event delivery time (ms timestamp string); taken from header.create_time when present" kind:"timestamp_ms"`
MeetingID string `json:"meeting_id,omitempty" desc:"Meeting ID" kind:"meeting_id"`
Topic string `json:"topic,omitempty" desc:"Meeting topic"`
MeetingNo string `json:"meeting_no,omitempty" desc:"Meeting number"`
StartTime string `json:"start_time,omitempty" desc:"Meeting start time in RFC3339, converted to the local timezone"`
CalendarEventID string `json:"calendar_event_id,omitempty" desc:"Calendar event ID associated with the meeting"`
}
func processVCParticipantMeetingJoined(_ context.Context, _ event.APIClient, raw *event.RawEvent, _ map[string]string) (json.RawMessage, error) {
var envelope struct {
Header struct {
EventID string `json:"event_id"`
EventType string `json:"event_type"`
CreateTime string `json:"create_time"`
} `json:"header"`
Event struct {
Meeting struct {
ID string `json:"id"`
Topic string `json:"topic"`
MeetingNo string `json:"meeting_no"`
StartTime string `json:"start_time"`
EndTime string `json:"end_time"`
CalendarEventID string `json:"calendar_event_id"`
} `json:"meeting"`
} `json:"event"`
}
if err := json.Unmarshal(raw.Payload, &envelope); err != nil {
return raw.Payload, nil //nolint:nilerr // passthrough on malformed payload so consumers still see the event
}
meeting := envelope.Event.Meeting
out := &VCParticipantMeetingJoinedOutput{
Type: envelope.Header.EventType,
EventID: envelope.Header.EventID,
Timestamp: envelope.Header.CreateTime,
MeetingID: meeting.ID,
Topic: meeting.Topic,
MeetingNo: meeting.MeetingNo,
StartTime: unixSecondsToLocalRFC3339(meeting.StartTime),
CalendarEventID: meeting.CalendarEventID,
}
if out.Type == "" {
out.Type = raw.EventType
}
return json.Marshal(out)
}

View File

@@ -0,0 +1,281 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package vc
import (
"context"
"encoding/json"
"reflect"
"testing"
"time"
"github.com/larksuite/cli/internal/event"
)
func TestVCKeys_ProcessedMeetingLifecycleRegistered(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
for _, tc := range []struct {
eventType string
schemaType reflect.Type
}{
{eventTypeMeetingStarted, reflect.TypeOf(VCParticipantMeetingStartedOutput{})},
{eventTypeMeetingJoined, reflect.TypeOf(VCParticipantMeetingJoinedOutput{})},
} {
t.Run(tc.eventType, func(t *testing.T) {
def, ok := event.Lookup(tc.eventType)
if !ok {
t.Fatalf("%s should be registered via Keys()", tc.eventType)
}
if def.Schema.Custom == nil {
t.Error("Processed key must set Schema.Custom")
}
if def.Schema.Native != nil {
t.Error("Processed key must not set Schema.Native")
}
if def.Process == nil {
t.Error("Process must not be nil for processed key")
}
if def.PreConsume == nil {
t.Error("PreConsume must not be nil for processed key")
}
if len(def.Scopes) != 1 || def.Scopes[0] != "vc:meeting.meetingevent:read" {
t.Errorf("Scopes = %v", def.Scopes)
}
if len(def.AuthTypes) != 1 || def.AuthTypes[0] != "user" {
t.Errorf("AuthTypes = %v", def.AuthTypes)
}
if len(def.RequiredConsoleEvents) != 1 || def.RequiredConsoleEvents[0] != tc.eventType {
t.Errorf("RequiredConsoleEvents = %v", def.RequiredConsoleEvents)
}
if def.Schema.Custom.Type != tc.schemaType {
t.Errorf("Custom schema Type = %v, want %v", def.Schema.Custom.Type, tc.schemaType)
}
})
}
}
func TestProcessVCParticipantMeetingLifecycle(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
for _, tc := range []struct {
name string
eventType string
process event.ProcessFunc
}{
{
name: "started",
eventType: eventTypeMeetingStarted,
process: processVCParticipantMeetingStarted,
},
{
name: "joined",
eventType: eventTypeMeetingJoined,
process: processVCParticipantMeetingJoined,
},
} {
t.Run(tc.name, func(t *testing.T) {
payload := `{
"schema": "2.0",
"header": {
"event_id": "ev_vc_lifecycle_001",
"event_type": "` + tc.eventType + `",
"create_time": "1608725989000",
"app_id": "cli_test"
},
"event": {
"meeting": {
"id": "6911188411934433028",
"topic": "my meeting",
"meeting_no": "235812466",
"start_time": "1608883322",
"end_time": "1608883899",
"calendar_event_id": "efa67a98-06a8-4df5-8559-746c8f4477ef_0"
}
}
}`
out := runMeetingLifecycleMap(t, tc.eventType, tc.process, payload)
if out["type"] != tc.eventType {
t.Errorf("type = %q", out["type"])
}
if out["event_id"] != "ev_vc_lifecycle_001" {
t.Errorf("event_id = %q", out["event_id"])
}
if out["timestamp"] != "1608725989000" {
t.Errorf("timestamp = %q", out["timestamp"])
}
if out["meeting_id"] != "6911188411934433028" {
t.Errorf("meeting_id = %q", out["meeting_id"])
}
if out["topic"] != "my meeting" || out["meeting_no"] != "235812466" {
t.Errorf("topic/meeting_no = %q/%q", out["topic"], out["meeting_no"])
}
if out["calendar_event_id"] != "efa67a98-06a8-4df5-8559-746c8f4477ef_0" {
t.Errorf("calendar_event_id = %q", out["calendar_event_id"])
}
if want := time.Unix(1608883322, 0).Local().Format(time.RFC3339); out["start_time"] != want {
t.Errorf("start_time = %q, want %q", out["start_time"], want)
}
if _, hasEndTime := out["end_time"]; hasEndTime {
t.Error("end_time should not be present in started/joined output")
}
})
}
}
func TestProcessVCParticipantMeetingLifecycle_InvalidMeetingTimes(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
for _, tc := range []struct {
name string
eventType string
process event.ProcessFunc
}{
{"started", eventTypeMeetingStarted, processVCParticipantMeetingStarted},
{"joined", eventTypeMeetingJoined, processVCParticipantMeetingJoined},
} {
t.Run(tc.name, func(t *testing.T) {
payload := `{
"schema": "2.0",
"header": {
"event_id": "ev_vc_lifecycle_002",
"event_type": "` + tc.eventType + `",
"create_time": "1608725989001"
},
"event": {
"meeting": {
"id": "meeting_invalid_time",
"start_time": "bad",
"end_time": ""
}
}
}`
out := runMeetingLifecycleRaw(t, tc.eventType, tc.process, payload)
switch tc.eventType {
case eventTypeMeetingStarted:
var started VCParticipantMeetingStartedOutput
if err := json.Unmarshal(out, &started); err != nil {
t.Fatalf("Process output is not valid started JSON: %v\nraw=%s", err, string(out))
}
if started.StartTime != "" {
t.Errorf("StartTime = %q, want empty string", started.StartTime)
}
case eventTypeMeetingJoined:
var joined VCParticipantMeetingJoinedOutput
if err := json.Unmarshal(out, &joined); err != nil {
t.Fatalf("Process output is not valid joined JSON: %v\nraw=%s", err, string(out))
}
if joined.StartTime != "" {
t.Errorf("StartTime = %q, want empty string", joined.StartTime)
}
}
})
}
}
func TestProcessVCParticipantMeetingLifecycle_MalformedPayload(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
for _, tc := range []struct {
name string
eventType string
process event.ProcessFunc
}{
{"started", eventTypeMeetingStarted, processVCParticipantMeetingStarted},
{"joined", eventTypeMeetingJoined, processVCParticipantMeetingJoined},
} {
t.Run(tc.name, func(t *testing.T) {
raw := &event.RawEvent{
EventType: tc.eventType,
Payload: json.RawMessage(`not json`),
Timestamp: time.Now(),
}
got, err := tc.process(context.Background(), nil, raw, nil)
if err != nil {
t.Fatalf("Process should swallow parse errors, got %v", err)
}
if string(got) != "not json" {
t.Errorf("malformed fallback output = %q, want original bytes", string(got))
}
})
}
}
func TestVCParticipantMeetingLifecycle_PreConsumeSubscriptionLifecycle(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
for _, eventType := range []string{eventTypeMeetingStarted, eventTypeMeetingJoined} {
t.Run(eventType, func(t *testing.T) {
def, ok := event.Lookup(eventType)
if !ok {
t.Fatalf("%s should be registered via Keys()", eventType)
}
type call struct {
method string
path string
body any
}
var calls []call
rt := &stubAPIClient{
callFn: func(_ context.Context, method, path string, body any) (json.RawMessage, error) {
calls = append(calls, call{method: method, path: path, body: body})
return json.RawMessage(`{"code":0,"msg":"success","data":{}}`), nil
},
}
cleanup, err := def.PreConsume(context.Background(), rt, nil)
if err != nil {
t.Fatalf("PreConsume error: %v", err)
}
if cleanup == nil {
t.Fatal("cleanup must not be nil")
}
if len(calls) != 1 {
t.Fatalf("calls after subscribe = %d, want 1", len(calls))
}
if calls[0].method != "POST" || calls[0].path != pathMeetingSubscribe {
t.Fatalf("subscribe call = %+v", calls[0])
}
assertSubscriptionRequest(t, calls[0].body, eventType)
cleanup()
if len(calls) != 2 {
t.Fatalf("calls after cleanup = %d, want 2", len(calls))
}
if calls[1].method != "POST" || calls[1].path != pathMeetingUnsubscribe {
t.Fatalf("unsubscribe call = %+v", calls[1])
}
assertSubscriptionRequest(t, calls[1].body, eventType)
})
}
}
func runMeetingLifecycleMap(t *testing.T, eventType string, process event.ProcessFunc, payload string) map[string]string {
t.Helper()
got := runMeetingLifecycleRaw(t, eventType, process, payload)
if got == nil {
t.Fatal("Process output is nil")
}
var out map[string]string
if err := json.Unmarshal(got, &out); err != nil {
t.Fatalf("Process output is not valid flat JSON object: %v\nraw=%s", err, string(got))
}
return out
}
func runMeetingLifecycleRaw(t *testing.T, eventType string, process event.ProcessFunc, payload string) json.RawMessage {
t.Helper()
raw := &event.RawEvent{
EventType: eventType,
Payload: json.RawMessage(payload),
Timestamp: time.Now(),
}
got, err := process(context.Background(), nil, raw, nil)
if err != nil {
t.Fatalf("Process error: %v", err)
}
return got
}

View File

@@ -0,0 +1,61 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package vc
import (
"context"
"encoding/json"
"github.com/larksuite/cli/internal/event"
)
// VCParticipantMeetingStartedOutput is the flattened shape for vc.meeting.participant_meeting_started_v1.
type VCParticipantMeetingStartedOutput struct {
Type string `json:"type" desc:"Event type; always vc.meeting.participant_meeting_started_v1"`
EventID string `json:"event_id,omitempty" desc:"Globally unique event ID; safe for deduplication"`
Timestamp string `json:"timestamp,omitempty" desc:"Event delivery time (ms timestamp string); taken from header.create_time when present" kind:"timestamp_ms"`
MeetingID string `json:"meeting_id,omitempty" desc:"Meeting ID" kind:"meeting_id"`
Topic string `json:"topic,omitempty" desc:"Meeting topic"`
MeetingNo string `json:"meeting_no,omitempty" desc:"Meeting number"`
StartTime string `json:"start_time,omitempty" desc:"Meeting start time in RFC3339, converted to the local timezone"`
CalendarEventID string `json:"calendar_event_id,omitempty" desc:"Calendar event ID associated with the meeting"`
}
func processVCParticipantMeetingStarted(_ context.Context, _ event.APIClient, raw *event.RawEvent, _ map[string]string) (json.RawMessage, error) {
var envelope struct {
Header struct {
EventID string `json:"event_id"`
EventType string `json:"event_type"`
CreateTime string `json:"create_time"`
} `json:"header"`
Event struct {
Meeting struct {
ID string `json:"id"`
Topic string `json:"topic"`
MeetingNo string `json:"meeting_no"`
StartTime string `json:"start_time"`
CalendarEventID string `json:"calendar_event_id"`
} `json:"meeting"`
} `json:"event"`
}
if err := json.Unmarshal(raw.Payload, &envelope); err != nil {
return raw.Payload, nil //nolint:nilerr // passthrough on malformed payload so consumers still see the event
}
meeting := envelope.Event.Meeting
out := &VCParticipantMeetingStartedOutput{
Type: envelope.Header.EventType,
EventID: envelope.Header.EventID,
Timestamp: envelope.Header.CreateTime,
MeetingID: meeting.ID,
Topic: meeting.Topic,
MeetingNo: meeting.MeetingNo,
StartTime: unixSecondsToLocalRFC3339(meeting.StartTime),
CalendarEventID: meeting.CalendarEventID,
}
if out.Type == "" {
out.Type = raw.EventType
}
return json.Marshal(out)
}

View File

@@ -11,6 +11,8 @@ import (
)
const (
eventTypeMeetingStarted = "vc.meeting.participant_meeting_started_v1"
eventTypeMeetingJoined = "vc.meeting.participant_meeting_joined_v1"
eventTypeMeetingEnded = "vc.meeting.participant_meeting_ended_v1"
eventTypeNoteGenerated = "vc.note.generated_v1"
eventTypeRecordingStarted = "vc.recording.recording_started_v1"
@@ -30,6 +32,38 @@ const (
// Keys returns all VC-domain EventKey definitions.
func Keys() []event.KeyDefinition {
return []event.KeyDefinition{
{
Key: eventTypeMeetingStarted,
DisplayName: "Participant meeting started",
Description: "Triggered when a meeting the current user participates in has started",
EventType: eventTypeMeetingStarted,
Schema: event.SchemaDef{
Custom: &event.SchemaSpec{Type: reflect.TypeOf(VCParticipantMeetingStartedOutput{})},
},
Process: processVCParticipantMeetingStarted,
PreConsume: subscriptionPreConsume(eventTypeMeetingStarted, pathMeetingSubscribe, pathMeetingUnsubscribe),
Scopes: []string{"vc:meeting.meetingevent:read"},
AuthTypes: []string{
"user",
},
RequiredConsoleEvents: []string{eventTypeMeetingStarted},
},
{
Key: eventTypeMeetingJoined,
DisplayName: "Participant meeting joined",
Description: "Triggered when the current user joins a meeting",
EventType: eventTypeMeetingJoined,
Schema: event.SchemaDef{
Custom: &event.SchemaSpec{Type: reflect.TypeOf(VCParticipantMeetingJoinedOutput{})},
},
Process: processVCParticipantMeetingJoined,
PreConsume: subscriptionPreConsume(eventTypeMeetingJoined, pathMeetingSubscribe, pathMeetingUnsubscribe),
Scopes: []string{"vc:meeting.meetingevent:read"},
AuthTypes: []string{
"user",
},
RequiredConsoleEvents: []string{eventTypeMeetingJoined},
},
{
Key: eventTypeMeetingEnded,
DisplayName: "Participant meeting ended",

View File

@@ -0,0 +1,96 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
// Package affordance is the lazily-loaded store of usage guidance for
// service-API methods. The source of truth is one markdown file per service in
// the top-level affordance/ tree (see mdparse.go), injected via SetSource so
// domain owners maintain it next to skills/ and shortcuts/. A service is read
// and parsed at most once, on first access, so normal command execution never
// touches it.
package affordance
import (
"encoding/json"
"io/fs"
"strings"
"sync"
"github.com/larksuite/cli/internal/apicatalog"
"github.com/larksuite/cli/internal/registry"
)
var (
mu sync.Mutex
byService = map[string]map[string]json.RawMessage{}
tried = map[string]bool{}
mdSource fs.FS // top-level affordance/*.md tree; nil in the minimal preview build
)
// SetSource installs the markdown guidance tree (the top-level affordance/
// directory) as the source. Called once at startup before any lookup; clears
// the parse cache so re-sourcing (e.g. in tests) takes effect.
func SetSource(fsys fs.FS) {
mu.Lock()
defer mu.Unlock()
mdSource = fsys
byService = map[string]map[string]json.RawMessage{}
tried = map[string]bool{}
}
// For returns the raw affordance overlay for one method, loading the owning
// service on first access. ok is false when there is no entry (absent source,
// parse failure, or unknown method all collapse to "no guidance").
func For(service, methodID string) (json.RawMessage, bool) {
mu.Lock()
defer mu.Unlock()
if !tried[service] {
tried[service] = true
byService[service] = loadService(service)
}
raw, ok := byService[service][methodID]
return raw, ok && len(raw) > 0
}
// loadService parses a service's markdown guidance into per-method overlays,
// marshalling each to JSON so downstream callers keep the same wire shape.
func loadService(service string) map[string]json.RawMessage {
if mdSource == nil {
return nil
}
src, err := fs.ReadFile(mdSource, service+".md")
if err != nil {
return nil
}
m := map[string]json.RawMessage{}
for id, a := range parseDomainMD(src, commandFormResolver(service)) {
if b, err := json.Marshal(a); err == nil {
m[id] = b
}
}
return m
}
// commandFormResolver maps a method's command-form heading ("user_mailbox.messages
// list") to its method id ("user_mailbox.message.list") via the registry's
// authoritative resource↔id table. Resource names are irregularly pluralised
// (message/messages, user_mailbox/user_mailboxes), so this cannot be guessed; the
// space→dot fallback covers domains where the two already coincide.
func commandFormResolver(service string) func(string) string {
byForm := map[string]string{}
for _, svc := range registry.EmbeddedServicesTyped() {
if svc.Name != service {
continue
}
for _, ref := range apicatalog.ServiceMethods(svc, nil) {
byForm[strings.Join(ref.CommandPath()[1:], " ")] = ref.Method.ID
}
break
}
return func(h string) string {
h = strings.TrimSpace(h)
if id, ok := byForm[h]; ok {
return id
}
return strings.ReplaceAll(h, " ", ".")
}
}

View File

@@ -0,0 +1,86 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package affordance
import (
"encoding/json"
"testing"
"testing/fstest"
)
// fixtureMD is a minimal affordance source: two methods, each with a lead
// paragraph (use_when) and a fenced example.
const fixtureMD = "# approval\n" +
"> skill: lark-approval\n\n" +
"## instances cc\n" +
"把一个审批实例抄送给指定用户。\n\n" +
"### Examples\n\n" +
"**抄送给用户**\n" +
"```bash\n" +
"lark-cli approval instances cc --data '{\"instance_code\":\"x\"}'\n" +
"```\n\n" +
"## instances get\n" +
"查询某审批实例详情。\n\n" +
"### Examples\n\n" +
"**按 code 查询**\n" +
"```bash\n" +
"lark-cli approval instances get --instance-code \"x\"\n" +
"```\n"
func TestFor(t *testing.T) {
prev := mdSource
t.Cleanup(func() { SetSource(prev) }) // SetSource mutates package state; restore for test isolation
SetSource(fstest.MapFS{"approval.md": &fstest.MapFile{Data: []byte(fixtureMD)}})
// A seeded method in a seeded service resolves to its overlay.
raw, ok := For("approval", "instances.cc")
if !ok {
t.Fatal(`For("approval","instances.cc") ok=false, want an overlay`)
}
var a struct {
UseWhen []string `json:"use_when"`
Examples []struct {
Command string `json:"command"`
} `json:"examples"`
}
if err := json.Unmarshal(raw, &a); err != nil {
t.Fatalf("overlay is not valid affordance JSON: %v", err)
}
if len(a.UseWhen) == 0 || len(a.Examples) == 0 || a.Examples[0].Command == "" {
t.Errorf("overlay missing use_when/examples: %s", raw)
}
// Misses: unknown method in a known service, and an unknown service, both
// resolve to ok=false (no panic, no error) so callers treat them as "no
// guidance".
if _, ok := For("approval", "instances.no_such_method"); ok {
t.Error("unknown method should be ok=false")
}
if _, ok := For("no_such_service", "x.y"); ok {
t.Error("unknown service should be ok=false")
}
// A second lookup of the same service is served from cache (parsed at most
// once) and stays consistent.
if _, ok := For("approval", "instances.get"); !ok {
t.Error("second lookup in a cached service should still resolve")
}
}
// Non-bullet paragraph lines under any section are preserved as items, not
// dropped (regression: they previously only updated pending, lost without a fence).
func TestParseDomainMD_ParagraphNotDropped(t *testing.T) {
md := "# d\n\n## foo bar\nwhat it does.\n\n### Tips\n- a bullet\nplain paragraph note.\n\n### See also\nrun [[other cmd]] first.\n"
got := parseDomainMD([]byte(md), nil) // nil resolver -> space->dot, "foo bar" -> "foo.bar"
a, ok := got["foo.bar"]
if !ok {
t.Fatal("method not parsed")
}
if len(a.Tips) != 2 || a.Tips[1] != "plain paragraph note." {
t.Errorf("Tips paragraph dropped: %v", a.Tips)
}
if len(a.Extensions) != 1 || len(a.Extensions[0].Items) != 1 || a.Extensions[0].Items[0] != "run `other cmd` first." {
t.Errorf("custom-section paragraph not flowed through: %+v", a.Extensions)
}
}

View File

@@ -0,0 +1,180 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package affordance
import (
"regexp"
"strings"
"github.com/larksuite/cli/internal/meta"
)
// The affordance source is a narrow, fixed markdown subset (see src/*.md):
//
// # domain optional `> skill: <name>` applied to every method
// ## command e.g. `instances get`
// <lead paragraph> -> use_when (when this command is right)
// ### Avoid when -> avoid_when (links become prefer/alternative edges)
// ### Prerequisites -> prerequisites (a "…来自 [[x]]" link is a sequence edge)
// ### Tips -> tips
// ### Examples -> examples: **description** + a ```fenced``` command
// ### <other> -> extensions[] (custom section, flows through verbatim)
// [[cmd]] -> a command reference, rendered as `cmd`
//
// Parsing is lazy and cached (see For), so the constrained grammar is read at
// most once per domain.
var mdLink = regexp.MustCompile(`\[\[(.+?)\]\]`)
// standardSection maps a section heading to its typed Affordance field; any
// other heading becomes an extension.
var standardSection = map[string]string{
"Avoid when": "avoid_when",
"Prerequisites": "prerequisites",
"Tips": "tips",
"Examples": "examples",
}
func linkToBacktick(s string) string { return mdLink.ReplaceAllString(s, "`$1`") }
// headingToKey maps a command heading ("instances get") to its affordance key
// ("instances.get"). The space→dot rule holds where the command form matches
// the method id; domains whose resource names differ (e.g. plural "messages"
// vs id segment "message") need the registry's authoritative resource↔id table.
func headingToKey(h string) string {
return strings.ReplaceAll(strings.TrimSpace(h), " ", ".")
}
type mdSection struct {
label string
items []string
cases []meta.AffordanceCase
}
// parseDomainMD parses one domain's markdown into per-method Affordance values,
// keyed by method id. resolve maps a command-form heading ("user_mailbox.messages
// list") to its method id ("user_mailbox.message.list"); nil falls back to the
// space→dot rule (valid only where the command form already equals the id).
func parseDomainMD(src []byte, resolve func(string) string) map[string]meta.Affordance {
if resolve == nil {
resolve = headingToKey
}
out := map[string]meta.Affordance{}
var skill, curKey string
var useWhen, para []string // lead paragraphs -> use_when entries (blank line separates)
var secs []*mdSection
var sec *mdSection
var pending string
var fence []string
inFence := false
assemble := func() {
if curKey == "" {
return
}
if len(para) > 0 {
useWhen = append(useWhen, strings.TrimSpace(strings.Join(para, " ")))
para = nil
}
var a meta.Affordance
if len(useWhen) > 0 {
a.UseWhen = useWhen
}
for _, s := range secs {
switch standardSection[s.label] {
case "avoid_when":
a.AvoidWhen = s.items
case "prerequisites":
a.Prerequisites = s.items
case "tips":
a.Tips = s.items
case "examples":
a.Examples = s.cases
default:
a.Extensions = append(a.Extensions, meta.AffordanceSection{Label: s.label, Items: s.items})
}
}
if skill != "" {
a.Skills = []string{skill}
}
out[curKey] = a
}
reset := func() { useWhen, para, secs, sec, pending, fence, inFence = nil, nil, nil, nil, "", nil, false }
// flushPending appends a non-bullet paragraph line that was not consumed as
// an example description (i.e. no fence followed) to the current section's
// items, so prose under any section is preserved rather than dropped.
flushPending := func() {
if sec != nil && pending != "" {
sec.items = append(sec.items, linkToBacktick(pending))
pending = ""
}
}
for _, raw := range strings.Split(string(src), "\n") {
line := strings.TrimRight(raw, "\r")
t := strings.TrimSpace(line)
switch {
case strings.HasPrefix(line, "## "):
flushPending()
assemble()
curKey = resolve(line[3:])
reset()
continue
case strings.HasPrefix(line, "# "):
continue
case strings.HasPrefix(t, "> skill:"):
skill = strings.TrimSpace(t[len("> skill:"):])
continue
case strings.HasPrefix(line, "### "):
flushPending()
sec = &mdSection{label: strings.TrimSpace(line[4:])}
secs = append(secs, sec)
pending, fence, inFence = "", nil, false
continue
}
if curKey == "" {
continue
}
if sec == nil { // lead paragraphs before any section -> use_when (blank line separates entries)
if t == "" {
if len(para) > 0 {
useWhen = append(useWhen, strings.Join(para, " "))
para = nil
}
} else {
para = append(para, t)
}
continue
}
// inside a section: a fenced block is an example command; otherwise the
// shape follows the writing (bullet item vs **description** before a fence).
if strings.HasPrefix(t, "```") {
if !inFence {
inFence, fence = true, nil
} else {
inFence = false
sec.cases = append(sec.cases, meta.AffordanceCase{Description: pending, Command: strings.Join(fence, "\n")})
pending = ""
}
continue
}
if inFence {
fence = append(fence, line)
continue
}
if strings.HasPrefix(t, "-") {
flushPending()
sec.items = append(sec.items, linkToBacktick(strings.TrimSpace(t[1:])))
} else if t != "" {
flushPending()
pending = strings.Trim(t, "* ")
}
}
flushPending()
assemble()
return out
}

View File

@@ -48,6 +48,22 @@ type Factory struct {
SkillContent fs.FS // embedded skill tree (rooted at the skill list); nil when the build embeds no skills
}
type skipCredentialBootstrapKey struct{}
// ContextWithCredentialBootstrapDisabled marks a command-tree build as
// credential-free. Use it only for purely local command surfaces that must be
// constructed without probing strict-mode, profile, or keychain state.
func ContextWithCredentialBootstrapDisabled(ctx context.Context) context.Context {
return context.WithValue(ctx, skipCredentialBootstrapKey{}, true)
}
// IsCredentialBootstrapDisabled reports whether credential-backed bootstrap
// probes must be skipped for this context.
func IsCredentialBootstrapDisabled(ctx context.Context) bool {
v, _ := ctx.Value(skipCredentialBootstrapKey{}).(bool)
return v
}
// ResolveFileIO resolves a FileIO instance using the current execution context.
// The provider controls whether the returned instance is fresh or cached.
func (f *Factory) ResolveFileIO(ctx context.Context) fileio.FileIO {
@@ -109,6 +125,9 @@ func autoDetectIdentityFromHint(hint *credential.IdentityHint) core.Identity {
}
func (f *Factory) resolveIdentityHint(ctx context.Context) *credential.IdentityHint {
if IsCredentialBootstrapDisabled(ctx) {
return nil
}
if f.Credential == nil {
return nil
}
@@ -148,6 +167,9 @@ func (f *Factory) CheckIdentity(as core.Identity, supported []string) error {
// ResolveStrictMode returns the effective strict mode by reading
// Account.SupportedIdentities from the credential provider chain.
func (f *Factory) ResolveStrictMode(ctx context.Context) core.StrictMode {
if IsCredentialBootstrapDisabled(ctx) {
return core.StrictModeOff
}
if f.Credential == nil {
return core.StrictModeOff
}

View File

@@ -18,6 +18,9 @@ type IOStreams struct {
Out io.Writer
ErrOut io.Writer
IsTerminal bool
// OutIsTerminal reports whether Out is an interactive terminal. Mirrors
// IsTerminal; computed once in NewIOStreams and assignable directly in tests.
OutIsTerminal bool
// StderrIsTerminal reports whether ErrOut is an interactive terminal.
// Advisory warnings written to stderr (e.g. the proxy notice) gate on this
// so they stay out of non-interactive output (pipes, CI, agent runs).
@@ -27,19 +30,24 @@ type IOStreams struct {
}
// NewIOStreams builds an IOStreams from arbitrary readers/writers.
// IsTerminal / StderrIsTerminal are derived from in's / errOut's underlying
// *os.File, if any; non-file streams (bytes.Buffer, strings.Reader, …) yield
// false.
// IsTerminal / OutIsTerminal / StderrIsTerminal are each derived from the
// underlying *os.File of in / out / errOut respectively; non-file
// readers/writers (bytes.Buffer, strings.Reader, …) yield false.
func NewIOStreams(in io.Reader, out, errOut io.Writer) *IOStreams {
isTerminal := false
if f, ok := in.(*os.File); ok {
isTerminal = term.IsTerminal(int(f.Fd()))
fileIsTerminal := func(v any) bool {
if f, ok := v.(*os.File); ok {
return term.IsTerminal(int(f.Fd()))
}
return false
}
stderrIsTerminal := false
if f, ok := errOut.(*os.File); ok {
stderrIsTerminal = term.IsTerminal(int(f.Fd()))
return &IOStreams{
In: in,
Out: out,
ErrOut: errOut,
IsTerminal: fileIsTerminal(in),
OutIsTerminal: fileIsTerminal(out),
StderrIsTerminal: fileIsTerminal(errOut),
}
return &IOStreams{In: in, Out: out, ErrOut: errOut, IsTerminal: isTerminal, StderrIsTerminal: stderrIsTerminal}
}
// SystemIO creates an IOStreams wired to the process's standard file descriptors.

View File

@@ -0,0 +1,31 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package cmdutil
import (
"bytes"
"os"
"testing"
)
func TestNewIOStreamsTerminalFlagsNonFile(t *testing.T) {
s := NewIOStreams(&bytes.Buffer{}, &bytes.Buffer{}, &bytes.Buffer{})
if s.IsTerminal || s.OutIsTerminal || s.StderrIsTerminal {
t.Errorf("non-file streams must not be terminals: in=%v out=%v err=%v",
s.IsTerminal, s.OutIsTerminal, s.StderrIsTerminal)
}
}
func TestNewIOStreamsTerminalFlagsPipe(t *testing.T) {
r, w, err := os.Pipe()
if err != nil {
t.Fatal(err)
}
defer r.Close()
defer w.Close()
s := NewIOStreams(r, w, w)
if s.OutIsTerminal || s.StderrIsTerminal {
t.Errorf("os.Pipe must not be a terminal: out=%v err=%v", s.OutIsTerminal, s.StderrIsTerminal)
}
}

View File

@@ -10,12 +10,14 @@ import (
"strings"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/internal/core"
)
// ClassifyContext is the contextual data BuildAPIError uses to populate
// identity-aware fields on typed errors (PermissionError.Identity / ConsoleURL).
// Identity is a plain string ("user" / "bot" / "") so this package does not
// depend on internal/core (which would create an import cycle).
// Brand and Identity are plain strings at this boundary; ConsoleURL normalizes
// Brand through core.ParseBrand, so callers can pass a raw brand string without
// coupling this contract to core's brand enum.
type ClassifyContext struct {
Brand string // "feishu" | "lark" — drives console_url host
AppID string // placed in console_url
@@ -444,28 +446,27 @@ func extractMissingScopes(resp map[string]any) []string {
return out
}
// ConsoleURL composes the Feishu/Lark open-platform scope-grant console URL,
// suitable for PermissionError.ConsoleURL. Empty appID → empty string. Empty
// scopes list returns the bare /auth landing page; scopes are joined with
// commas in the `q` query parameter so the console can pre-select them.
// ConsoleURL composes the Feishu/Lark open-platform application-scope apply
// page URL (the official open-pages `/page/scope-apply` entry), suitable for
// PermissionError.ConsoleURL. Empty appID → empty string. Empty scopes list
// returns the page carrying only clientID; otherwise scopes are joined with
// commas in the `scopes` query parameter so the console can pre-select them.
//
// brand is "feishu" or "lark"; unknown values default to feishu.
func ConsoleURL(brand, appID string, scopes []string) string {
if appID == "" {
return ""
}
host := "open.feishu.cn"
if brand == "lark" {
host = "open.larksuite.com"
}
// PathEscape on appID — it sits in the URL path. QueryEscape on the
// comma-joined scopes — they sit in the `?q=` value, and untrusted scope
// content must not be able to inject extra query parameters via `&`/`#`.
pathID := url.PathEscape(appID)
// QueryEscape both values — clientID and scopes both sit in the query
// string, and untrusted content must not be able to inject extra query
// parameters via `&`/`#`. The brand→host mapping is owned by core so the
// open-platform base URL stays a single source of truth.
base := fmt.Sprintf("%s/page/scope-apply?clientID=%s",
core.ResolveOpenBaseURL(core.ParseBrand(brand)), url.QueryEscape(appID))
if len(scopes) == 0 {
return fmt.Sprintf("https://%s/app/%s/auth", host, pathID)
return base
}
return fmt.Sprintf("https://%s/app/%s/auth?q=%s", host, pathID, url.QueryEscape(strings.Join(scopes, ",")))
return base + "&scopes=" + url.QueryEscape(strings.Join(scopes, ","))
}
func intFromAny(v any) int {

View File

@@ -422,8 +422,8 @@ func TestConsoleURL_FeishuBrand(t *testing.T) {
if !ok {
t.Fatalf("expected *errs.PermissionError, got %T", err)
}
if !strings.Contains(pe.ConsoleURL, "open.feishu.cn/app/cli_a123") {
t.Fatalf("ConsoleURL = %q, want open.feishu.cn prefix", pe.ConsoleURL)
if !strings.Contains(pe.ConsoleURL, "open.feishu.cn/page/scope-apply?clientID=cli_a123") {
t.Fatalf("ConsoleURL = %q, want open.feishu.cn scope-apply page", pe.ConsoleURL)
}
}
@@ -434,8 +434,8 @@ func TestConsoleURL_LarkBrand(t *testing.T) {
if !ok {
t.Fatalf("expected *errs.PermissionError, got %T", err)
}
if !strings.Contains(pe.ConsoleURL, "open.larksuite.com/app/cli_a123") {
t.Fatalf("ConsoleURL = %q, want open.larksuite.com prefix", pe.ConsoleURL)
if !strings.Contains(pe.ConsoleURL, "open.larksuite.com/page/scope-apply?clientID=cli_a123") {
t.Fatalf("ConsoleURL = %q, want open.larksuite.com scope-apply page", pe.ConsoleURL)
}
}
@@ -485,35 +485,35 @@ func TestConsoleURL_EscapesDangerousChars(t *testing.T) {
name: "ampersand in scope smuggles extra param",
appID: "cli_good",
scopes: []string{"scope&evil=injected"},
wantInURL: []string{"q=scope%26evil%3Dinjected"},
denyInURL: []string{"q=scope&evil=injected"},
wantInURL: []string{"scopes=scope%26evil%3Dinjected"},
denyInURL: []string{"scopes=scope&evil=injected"},
},
{
name: "hash in scope splits fragment",
appID: "cli_good",
scopes: []string{"scope#fragment"},
wantInURL: []string{"q=scope%23fragment"},
denyInURL: []string{"q=scope#fragment"},
wantInURL: []string{"scopes=scope%23fragment"},
denyInURL: []string{"scopes=scope#fragment"},
},
{
name: "question mark in appID prematurely opens query",
appID: "good?q=injected",
scopes: []string{"docx:document"},
wantInURL: []string{"/app/good%3Fq=injected/auth"},
denyInURL: []string{"/app/good?q=injected/auth"},
wantInURL: []string{"clientID=good%3Fq%3Dinjected"},
denyInURL: []string{"clientID=good?q=injected"},
},
{
name: "hash in appID truncates URL",
appID: "good#fragment",
scopes: []string{"docx:document"},
wantInURL: []string{"/app/good%23fragment/auth"},
denyInURL: []string{"/app/good#fragment/auth"},
wantInURL: []string{"clientID=good%23fragment"},
denyInURL: []string{"clientID=good#fragment"},
},
{
name: "slash in appID escapes path segment",
name: "slash in appID does not open a new path segment",
appID: "good/extra/segment",
scopes: []string{"docx:document"},
wantInURL: []string{"/app/good%2Fextra%2Fsegment/auth"},
wantInURL: []string{"clientID=good%2Fextra%2Fsegment"},
},
}
@@ -553,8 +553,8 @@ func TestPermissionError_NoViolations(t *testing.T) {
if pe.MissingScopes != nil {
t.Errorf("MissingScopes should be nil; got %v", pe.MissingScopes)
}
if !strings.HasSuffix(pe.ConsoleURL, "/app/cli_a123/auth") {
t.Errorf("ConsoleURL (no scopes) = %q, want trailing /app/cli_a123/auth", pe.ConsoleURL)
if !strings.HasSuffix(pe.ConsoleURL, "/page/scope-apply?clientID=cli_a123") {
t.Errorf("ConsoleURL (no scopes) = %q, want trailing /page/scope-apply?clientID=cli_a123", pe.ConsoleURL)
}
}
@@ -758,7 +758,7 @@ func TestBuildPermissionHint_AppMissingScopeRoutesToConsole(t *testing.T) {
// at the app level — re-authenticating cannot fix it. The hint must
// point to the developer console regardless of caller identity, or
// agents will loop on `auth login` forever.
consoleURL := "https://open.feishu.cn/app/cli_x/auth?q=contact%3Acontact"
consoleURL := "https://open.feishu.cn/page/scope-apply?clientID=cli_x&scopes=contact%3Acontact"
for _, identity := range []string{"user", "bot", ""} {
got := errclass.PermissionHint([]string{"contact:contact"}, identity, errs.SubtypeAppScopeNotApplied, consoleURL)
if !strings.Contains(got, "developer console") {

View File

@@ -10,8 +10,20 @@ import "github.com/larksuite/cli/errs"
// ambiguous codes fall back to CategoryAPI via BuildAPIError.
// BuildAPIError consumes this map via mergeCodeMeta + LookupCodeMeta.
var driveCodeMeta = map[int]CodeMeta{
1061044: {Category: errs.CategoryAPI, Subtype: errs.SubtypeNotFound}, // parent folder does not exist (upload)
1069302: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // comment endpoint "Invalid or missing parameters"
1061001: {Category: errs.CategoryAPI, Subtype: errs.SubtypeServerError, Retryable: true}, // Drive "unknown error"
1061002: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // params error
1061004: {Category: errs.CategoryAuthorization, Subtype: errs.SubtypePermissionDenied}, // forbidden
1061007: {Category: errs.CategoryAPI, Subtype: errs.SubtypeNotFound}, // file has been deleted
1061043: {Category: errs.CategoryAPI, Subtype: errs.SubtypeQuotaExceeded}, // file size beyond limit
1061044: {Category: errs.CategoryAPI, Subtype: errs.SubtypeNotFound}, // parent folder does not exist (upload)
1062009: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // actual size inconsistent with declared size
1063001: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // secure label invalid parameter
1063002: {Category: errs.CategoryAuthorization, Subtype: errs.SubtypePermissionDenied}, // secure label permission denied
1063013: {Category: errs.CategoryValidation, Subtype: errs.SubtypeFailedPrecondition}, // secure label downgrade requires approval
1069302: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // comment endpoint "Invalid or missing parameters"
99992402: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // platform field validation failed
9499: {Category: errs.CategoryAPI, Subtype: errs.SubtypeInvalidParameters}, // invalid parameter type in JSON field
2200: {Category: errs.CategoryAPI, Subtype: errs.SubtypeServerError, Retryable: true}, // Drive tenant/internal errors
}
func init() { mergeCodeMeta(driveCodeMeta, "drive") }

View File

@@ -27,6 +27,13 @@ func TestLookupCodeMeta_DriveCodes(t *testing.T) {
// 1069302: comment endpoint's opaque "Invalid or missing parameters"
// (shortcuts/drive/drive_add_comment.go) → API-side parameter rejection.
{1069302, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
// Secure label endpoint codes observed from drive +secure-label-update
// failure telemetry.
{1063001, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
{1063002, errs.CategoryAuthorization, errs.SubtypePermissionDenied, false},
{1063013, errs.CategoryValidation, errs.SubtypeFailedPrecondition, false},
{99992402, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
{9499, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
}
for _, tc := range cases {
t.Run(fmt.Sprintf("%d", tc.code), func(t *testing.T) {

View File

@@ -102,6 +102,35 @@ func TestLookupCodeMeta_RetryableRateLimit(t *testing.T) {
}
}
func TestLookupCodeMeta_DrivePushCodes(t *testing.T) {
cases := []struct {
code int
wantCat errs.Category
wantSubtype errs.Subtype
wantRetry bool
}{
{1061001, errs.CategoryAPI, errs.SubtypeServerError, true},
{1061002, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
{1061004, errs.CategoryAuthorization, errs.SubtypePermissionDenied, false},
{1061007, errs.CategoryAPI, errs.SubtypeNotFound, false},
{1061043, errs.CategoryAPI, errs.SubtypeQuotaExceeded, false},
{1062009, errs.CategoryAPI, errs.SubtypeInvalidParameters, false},
{2200, errs.CategoryAPI, errs.SubtypeServerError, true},
}
for _, tc := range cases {
t.Run(fmt.Sprintf("%d", tc.code), func(t *testing.T) {
got, ok := LookupCodeMeta(tc.code)
if !ok {
t.Fatalf("LookupCodeMeta(%d) ok=false, want true", tc.code)
}
if got.Category != tc.wantCat || got.Subtype != tc.wantSubtype || got.Retryable != tc.wantRetry {
t.Fatalf("LookupCodeMeta(%d) = %+v, want Category=%v Subtype=%v Retryable=%v",
tc.code, got, tc.wantCat, tc.wantSubtype, tc.wantRetry)
}
})
}
}
func TestLookupCodeMeta_Unknown(t *testing.T) {
_, ok := LookupCodeMeta(999999)
if ok {

View File

@@ -13,6 +13,7 @@ import (
"strings"
"time"
extcred "github.com/larksuite/cli/extension/credential"
larkauth "github.com/larksuite/cli/internal/auth"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
@@ -61,12 +62,131 @@ func Diagnose(ctx context.Context, f *cmdutil.Factory, cfg *core.CliConfig, veri
if ctx == nil {
ctx = context.Background()
}
// An external provider mints tokens on demand and blocks interactive auth,
// so the built-in keychain heuristics and "auth login" hints don't apply.
if provider := activeExternalProvider(ctx, f); provider != "" {
return diagnoseExternal(ctx, f, cfg, provider, verify)
}
return Result{
Bot: diagnoseBot(ctx, f, cfg, verify),
User: diagnoseUser(ctx, f, cfg, verify),
}
}
// activeExternalProvider returns the active extension provider name, or "".
// An error degrades to the built-in path: an unreachable provider would already
// have failed the f.Config() that produced cfg.
func activeExternalProvider(ctx context.Context, f *cmdutil.Factory) string {
if f == nil || f.Credential == nil {
return ""
}
name, err := f.Credential.ActiveExtensionProviderName(ctx)
if err != nil {
return ""
}
return name
}
func diagnoseExternal(ctx context.Context, f *cmdutil.Factory, cfg *core.CliConfig, provider string, verify bool) Result {
if cfg == nil || cfg.AppID == "" {
notConfigured := Identity{
Status: StatusNotConfigured,
Message: "not configured (missing app config)",
Hint: externalCredentialHint(provider),
}
return Result{Bot: notConfigured, User: notConfigured}
}
// SupportedIdentities == 0 is "unspecified" — treat as both, per CanBot.
ids := extcred.IdentitySupport(cfg.SupportedIdentities)
supportsBot := cfg.SupportedIdentities == 0 || ids.Has(extcred.SupportsBot)
supportsUser := cfg.SupportedIdentities == 0 || ids.Has(extcred.SupportsUser)
return Result{
Bot: diagnoseExternalBot(ctx, f, cfg, provider, supportsBot, verify),
User: diagnoseExternalUser(ctx, f, cfg, provider, supportsUser, verify),
}
}
func diagnoseExternalBot(ctx context.Context, f *cmdutil.Factory, cfg *core.CliConfig, provider string, supported, verify bool) Identity {
if !supported {
return notProvidedExternally("Bot", provider)
}
id := Identity{Status: StatusReady, Available: true, Message: "Bot identity: ready (provided by " + provider + ")"}
if !verify {
return id
}
token, err := resolveBotToken(ctx, f, cfg)
if err != nil {
return externalVerifyFailed(id, "Bot", provider, err)
}
info, err := fetchBotInfo(ctx, f, cfg, token)
if err != nil {
return externalVerifyFailed(id, "Bot", provider, err)
}
id.Verified = boolPtr(true)
id.OpenID = info.OpenID
id.AppName = info.AppName
return id
}
func diagnoseExternalUser(ctx context.Context, f *cmdutil.Factory, cfg *core.CliConfig, provider string, supported, verify bool) Identity {
if !supported {
return notProvidedExternally("User", provider)
}
// enrichUserInfo populates UserOpenId only after the provider returns and
// verifies a UAT (and clears it on failure), so a resolved open id is the
// external analogue of a keychain token being present.
if cfg.UserOpenId == "" {
return Identity{
Status: StatusMissing,
Message: "User identity: not signed in via credential source " + provider,
Hint: externalCredentialHint(provider),
}
}
id := Identity{
Status: StatusReady,
Available: true,
TokenStatus: StatusReady,
UserName: cfg.UserName,
OpenID: cfg.UserOpenId,
Message: "User identity: ready (provided by " + provider + ")",
}
if !verify {
return id
}
if _, err := f.Credential.ResolveToken(ctx, credential.NewTokenSpec(core.AsUser, cfg.AppID)); err != nil {
return externalVerifyFailed(id, "User", provider, err)
}
id.Verified = boolPtr(true)
return id
}
func notProvidedExternally(label, provider string) Identity {
return Identity{
Status: StatusNotConfigured,
Message: label + " identity: not provided by credential source " + provider,
Hint: externalCredentialHint(provider),
}
}
// externalVerifyFailed flips id to verify-failed, keeping any identity fields
// (open id, user name) already resolved before the probe.
func externalVerifyFailed(id Identity, label, provider string, err error) Identity {
id.Available = false
id.Verified = boolPtr(false)
id.Status = StatusVerifyFailed
id.TokenStatus = ""
id.Message = label + " identity: verify failed: " + err.Error()
id.Hint = externalCredentialHint(provider)
return id
}
// externalCredentialHint reports the constraint, not a remediation: the
// identity is the provider's to manage, not lark-cli's to fix. What to do about
// it is the caller's call — there may be no user to ask.
func externalCredentialHint(provider string) string {
return fmt.Sprintf("managed by the external credential provider %q and cannot be configured via lark-cli", provider)
}
func diagnoseBot(ctx context.Context, f *cmdutil.Factory, cfg *core.CliConfig, verify bool) Identity {
if cfg == nil || cfg.AppID == "" {
return Identity{

View File

@@ -10,9 +10,11 @@ import (
"testing"
"time"
extcred "github.com/larksuite/cli/extension/credential"
larkauth "github.com/larksuite/cli/internal/auth"
"github.com/larksuite/cli/internal/cmdutil"
"github.com/larksuite/cli/internal/core"
"github.com/larksuite/cli/internal/credential"
"github.com/larksuite/cli/internal/httpmock"
"github.com/zalando/go-keyring"
)
@@ -348,3 +350,136 @@ func TestDiagnose_UserIdentityNeedsRefresh(t *testing.T) {
t.Fatalf("token status = %q, want needs_refresh", got.User.TokenStatus)
}
}
// fakeExtProvider is a minimal credential.extcred.Provider for exercising the
// external-credential diagnosis path. account makes the provider "active";
// token (when set) satisfies ResolveToken during verify.
type fakeExtProvider struct {
name string
account *extcred.Account
token *extcred.Token
}
func (p *fakeExtProvider) Name() string { return p.name }
func (p *fakeExtProvider) ResolveAccount(context.Context) (*extcred.Account, error) {
return p.account, nil
}
func (p *fakeExtProvider) ResolveToken(context.Context, extcred.TokenSpec) (*extcred.Token, error) {
return p.token, nil
}
func externalFactory(prov *fakeExtProvider, cfg *core.CliConfig) *cmdutil.Factory {
cred := credential.NewCredentialProvider(
[]extcred.Provider{prov}, nil, nil,
func() (*http.Client, error) { return nil, nil },
)
return &cmdutil.Factory{
Config: func() (*core.CliConfig, error) { return cfg, nil },
Credential: cred,
IOStreams: &cmdutil.IOStreams{},
}
}
// assertExternalHint locks the contract that an external-provider hint never
// points at interactive commands blocked under an external provider.
func assertExternalHint(t *testing.T, hint string) {
t.Helper()
if hint == "" {
t.Fatalf("hint empty, want external guidance")
}
for _, blocked := range []string{"auth login", "config --help"} {
if strings.Contains(hint, blocked) {
t.Fatalf("hint %q must not point at %q (blocked under external provider)", hint, blocked)
}
}
if !strings.Contains(hint, "external") {
t.Fatalf("hint %q should explain credentials are external", hint)
}
}
func TestDiagnose_External_UserReady(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsAll), UserOpenId: "ou_x", UserName: "Alice"}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}, cfg)
got := Diagnose(context.Background(), f, cfg, false)
// The bug this guards: the built-in path read the keychain (empty under an
// external provider) and reported the user as missing. Now availability
// follows the resolved account, so a signed-in user reads as ready.
if !got.User.Available || got.User.Status != StatusReady || got.User.TokenStatus != StatusReady {
t.Fatalf("user = %#v, want ready/available", got.User)
}
if got.User.OpenID != "ou_x" || got.User.UserName != "Alice" {
t.Fatalf("user identity = %#v", got.User)
}
if got.User.Hint != "" {
t.Fatalf("hint = %q, want empty when available", got.User.Hint)
}
if !got.Bot.Available || got.Bot.Status != StatusReady {
t.Fatalf("bot = %#v, want ready/available", got.Bot)
}
}
func TestDiagnose_External_UserNotSignedIn(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsAll)}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}, cfg)
got := Diagnose(context.Background(), f, cfg, false)
if got.User.Available || got.User.Status != StatusMissing {
t.Fatalf("user = %#v, want missing/unavailable", got.User)
}
assertExternalHint(t, got.User.Hint)
}
func TestDiagnose_External_BotOnly(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsBot), UserOpenId: "ou_x"}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}, cfg)
got := Diagnose(context.Background(), f, cfg, false)
if !got.Bot.Available || got.Bot.Status != StatusReady {
t.Fatalf("bot = %#v, want ready/available", got.Bot)
}
// Provider declares bot-only: user is unavailable even though an open id is
// present, and the hint is external (not "auth login").
if got.User.Available || got.User.Status != StatusNotConfigured {
t.Fatalf("user = %#v, want not_configured/unavailable", got.User)
}
assertExternalHint(t, got.User.Hint)
}
func TestDiagnose_External_UserOnly(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandLark, SupportedIdentities: uint8(extcred.SupportsUser), UserOpenId: "ou_x", UserName: "Bob"}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}, cfg)
got := Diagnose(context.Background(), f, cfg, false)
if !got.User.Available || got.User.Status != StatusReady {
t.Fatalf("user = %#v, want ready/available", got.User)
}
if got.Bot.Available || got.Bot.Status != StatusNotConfigured {
t.Fatalf("bot = %#v, want not_configured/unavailable", got.Bot)
}
assertExternalHint(t, got.Bot.Hint)
}
func TestDiagnose_External_VerifyUserResolvesToken(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsUser), UserOpenId: "ou_x", UserName: "Alice"}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}, token: &extcred.Token{Value: "ext-uat"}}, cfg)
got := Diagnose(context.Background(), f, cfg, true)
if !got.User.Available || got.User.Verified == nil || !*got.User.Verified {
t.Fatalf("user = %#v, want available and verified", got.User)
}
}
func TestDiagnose_External_VerifyUserTokenUnavailable(t *testing.T) {
cfg := &core.CliConfig{AppID: "cli_x", Brand: core.BrandFeishu, SupportedIdentities: uint8(extcred.SupportsUser), UserOpenId: "ou_x"}
f := externalFactory(&fakeExtProvider{name: "corp-sso", account: &extcred.Account{AppID: "cli_x"}}, cfg)
got := Diagnose(context.Background(), f, cfg, true)
if got.User.Available || got.User.Status != StatusVerifyFailed {
t.Fatalf("user = %#v, want verify_failed/unavailable", got.User)
}
if got.User.Verified == nil || *got.User.Verified {
t.Fatalf("verified = %v, want false", got.User.Verified)
}
assertExternalHint(t, got.User.Hint)
}

View File

@@ -5,30 +5,39 @@ package meta
import "encoding/json"
// Affordance is the hand-authored usage guidance overlaid on a method: when to
// use it, when not to, prerequisites, few-shot examples, and related methods.
// It is the single typed model of the affordance shape; the envelope renderer
// and the command help both parse through ParsedAffordance so the vocabulary
// is defined once. The JSON tags double as the envelope's wire shape.
// Affordance is the typed usage guidance overlaid on a method. It is the single
// model the envelope renderer and the command help both parse, so the
// vocabulary is defined once; the JSON tags double as the envelope wire shape.
// Skills entries are skill names (or name/path) rendered as runnable
// `lark-cli skills read <entry>` pointers.
type Affordance struct {
UseWhen []string `json:"use_when,omitempty"`
DoNotUseWhen []string `json:"do_not_use_when,omitempty"`
Prerequisites []string `json:"prerequisites,omitempty"`
Examples []AffordanceCase `json:"examples,omitempty"`
Related []string `json:"related,omitempty"`
UseWhen []string `json:"use_when,omitempty"`
AvoidWhen []string `json:"avoid_when,omitempty"`
Prerequisites []string `json:"prerequisites,omitempty"`
Tips []string `json:"tips,omitempty"`
Examples []AffordanceCase `json:"examples,omitempty"`
Extensions []AffordanceSection `json:"extensions,omitempty"`
Related []string `json:"related,omitempty"`
Skills []string `json:"skills,omitempty"`
}
// AffordanceCase is one few-shot example: a one-line description and a
// ready-to-run command.
// AffordanceCase is one few-shot example: a description and a ready-to-run command.
type AffordanceCase struct {
Description string `json:"description"`
Description string `json:"description,omitempty"`
Command string `json:"command"`
}
// ParsedAffordance decodes the method's raw affordance overlay into the typed
// Affordance. ok is false when the method carries no affordance, the JSON is
// malformed, or every section is empty — so callers can treat "no guidance"
// uniformly.
// AffordanceSection is a custom guidance section: any heading beyond the
// standard four (Avoid when / Prerequisites / Tips / Examples) flows through
// here with its label preserved, so authors can add sections without code
// changes.
type AffordanceSection struct {
Label string `json:"label"`
Items []string `json:"items,omitempty"`
}
// ParsedAffordance decodes the method's overlay. ok is false when it is absent,
// malformed, or wholly empty — callers treat all three as "no guidance".
func (m Method) ParsedAffordance() (Affordance, bool) {
if len(m.Affordance) == 0 {
return Affordance{}, false
@@ -37,7 +46,7 @@ func (m Method) ParsedAffordance() (Affordance, bool) {
if json.Unmarshal(m.Affordance, &a) != nil {
return Affordance{}, false
}
if len(a.UseWhen) == 0 && len(a.DoNotUseWhen) == 0 && len(a.Prerequisites) == 0 && len(a.Examples) == 0 && len(a.Related) == 0 {
if len(a.UseWhen) == 0 && len(a.AvoidWhen) == 0 && len(a.Prerequisites) == 0 && len(a.Tips) == 0 && len(a.Examples) == 0 && len(a.Extensions) == 0 && len(a.Related) == 0 && len(a.Skills) == 0 {
return Affordance{}, false
}
return a, true

View File

@@ -19,7 +19,7 @@ func TestMethod_ParsedAffordance(t *testing.T) {
notOK := map[string]string{
"empty payload": ``,
"empty object": `{}`,
"all empty arrays": `{"use_when":[],"do_not_use_when":[],"prerequisites":[],"examples":[],"related":[]}`,
"all empty arrays": `{"use_when":[],"avoid_when":[],"prerequisites":[],"tips":[],"examples":[],"related":[]}`,
"malformed string": `"not an object"`,
"malformed number": `42`,
"nested type mismatch": `{"examples":"should be a list"}`,
@@ -35,8 +35,9 @@ func TestMethod_ParsedAffordance(t *testing.T) {
// Populated affordance parses with all fields.
raw := `{
"use_when": ["需要拿到当前用户的主日历 ID"],
"do_not_use_when": ["已知具体 calendar_id"],
"avoid_when": ["已知具体 calendar_id"],
"prerequisites": ["user 身份登录"],
"tips": ["主日历的 calendar_id 即当前用户的 union_id"],
"examples": [{"description":"获取主日历","command":"lark-cli calendar calendars primary"}],
"related": ["calendars.list"]
}`
@@ -47,10 +48,22 @@ func TestMethod_ParsedAffordance(t *testing.T) {
if len(a.UseWhen) != 1 || a.UseWhen[0] != "需要拿到当前用户的主日历 ID" {
t.Errorf("UseWhen = %v", a.UseWhen)
}
if len(a.Tips) != 1 || a.Tips[0] != "主日历的 calendar_id 即当前用户的 union_id" {
t.Errorf("Tips = %v", a.Tips)
}
if len(a.Examples) != 1 || a.Examples[0].Description != "获取主日历" || a.Examples[0].Command != "lark-cli calendar calendars primary" {
t.Errorf("Examples = %+v", a.Examples)
}
if len(a.Related) != 1 || a.Related[0] != "calendars.list" {
t.Errorf("Related = %v", a.Related)
}
// A method whose only guidance is Tips still parses as populated.
tipsOnly, ok := (Method{Affordance: json.RawMessage(`{"tips":["先调用 list 拿到 id"]}`)}).ParsedAffordance()
if !ok {
t.Fatal("ParsedAffordance with only tips ok=false, want populated")
}
if len(tipsOnly.Tips) != 1 || tipsOnly.Tips[0] != "先调用 list 拿到 id" {
t.Errorf("Tips = %v", tipsOnly.Tips)
}
}

View File

@@ -0,0 +1,80 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package output
import (
"fmt"
"io"
"sync"
"time"
)
// spinnerFrames are braille spinner glyphs cycled to animate progress.
var spinnerFrames = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}
const (
spinnerInterval = 80 * time.Millisecond
spinnerHideCursor = "\x1b[?25l"
spinnerShowCursor = "\x1b[?25h"
spinnerClearLine = "\r\x1b[K" // CR + clear-to-end-of-line
)
// StartSpinner renders a braille spinner with an elapsed-seconds counter to w
// until the returned stop() is called, e.g.:
//
// ⠹ Publishing dev → main... 3s
//
// It is meant for slow operations (long polls, first-time provisioning) so the
// user sees the CLI is alive. Always write to STDERR (w = IO().ErrOut) so the
// animation never pollutes stdout — the JSON/pretty result stays clean.
//
// When enabled is false (stderr is not a TTY: pipes, CI, captured output) it is
// a no-op returning a no-op stop, so non-interactive runs emit nothing. Gate on
// the stderr-TTY check (IOStreams.StderrIsTerminal), not the output format: the
// spinner is stderr-only and self-clears, so it is shown in JSON mode too.
//
// stop() clears the spinner line, restores the cursor, and blocks until the
// render goroutine has finished — so callers can safely write the result to
// stdout/stderr immediately after. Call stop() BEFORE printing the result, and
// it is safe to call more than once (e.g. an explicit call plus a defer).
func StartSpinner(w io.Writer, enabled bool, label string) func() {
if !enabled || w == nil {
return func() {}
}
done := make(chan struct{})
finished := make(chan struct{})
start := time.Now()
go func() {
defer close(finished)
frame := 0
fmt.Fprint(w, spinnerHideCursor)
render := func() {
elapsed := int(time.Since(start).Seconds())
fmt.Fprintf(w, "%s%s %s... %ds", spinnerClearLine, spinnerFrames[frame], label, elapsed)
frame = (frame + 1) % len(spinnerFrames)
}
render()
ticker := time.NewTicker(spinnerInterval)
defer ticker.Stop()
for {
select {
case <-done:
fmt.Fprint(w, spinnerClearLine+spinnerShowCursor)
return
case <-ticker.C:
render()
}
}
}()
var once sync.Once
return func() {
once.Do(func() {
close(done)
<-finished // wait for the line to be cleared before returning
})
}
}

View File

@@ -0,0 +1,54 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package output
import (
"bytes"
"strings"
"testing"
)
// TestStartSpinner_DisabledIsNoop asserts that a disabled spinner writes nothing and its stop func is idempotent.
func TestStartSpinner_DisabledIsNoop(t *testing.T) {
var buf bytes.Buffer
stop := StartSpinner(&buf, false, "working")
stop()
stop() // idempotent
if buf.Len() != 0 {
t.Fatalf("disabled spinner wrote %q, want nothing", buf.String())
}
}
// TestStartSpinner_NilWriterIsNoop asserts that a nil writer is a no-op and stopping does not panic.
func TestStartSpinner_NilWriterIsNoop(t *testing.T) {
stop := StartSpinner(nil, true, "working")
stop() // must not panic
}
// TestStartSpinner_EnabledAnimatesAndCleansUp asserts that an enabled spinner renders a frame and label, then clears the line and restores the cursor on stop.
func TestStartSpinner_EnabledAnimatesAndCleansUp(t *testing.T) {
var buf bytes.Buffer
stop := StartSpinner(&buf, true, "Publishing")
// The goroutine renders the first frame synchronously before selecting on
// the stop channel, so even an immediate stop() yields one full cycle.
stop()
stop() // idempotent, must not panic or double-write after finished
out := buf.String()
if !strings.Contains(out, spinnerHideCursor) {
t.Errorf("missing hide-cursor escape:\n%q", out)
}
if !strings.Contains(out, spinnerFrames[0]) {
t.Errorf("missing first spinner frame %q:\n%q", spinnerFrames[0], out)
}
if !strings.Contains(out, "Publishing...") {
t.Errorf("missing label:\n%q", out)
}
if !strings.Contains(out, spinnerClearLine) {
t.Errorf("missing clear-line escape:\n%q", out)
}
if !strings.HasSuffix(out, spinnerShowCursor) {
t.Errorf("must end by restoring the cursor:\n%q", out)
}
}

View File

@@ -52,6 +52,9 @@ func isPlaceholderValue(value string) bool {
normalized := strings.ToLower(trimmed)
if normalized == "" ||
normalized == "=" ||
printfPlaceholderValue(normalized) ||
htmlEntityAnglePlaceholder(normalized) ||
starMaskedPlaceholder(normalized) ||
percentWrappedPlaceholder(normalized) ||
angleWrappedPlaceholder(normalized) ||
urlWithAnglePlaceholder(normalized) ||
@@ -61,12 +64,42 @@ func isPlaceholderValue(value string) bool {
return namedPlaceholderValue(normalized)
}
func htmlEntityAnglePlaceholder(value string) bool {
if !strings.HasPrefix(value, "&lt;") || !strings.HasSuffix(value, "&gt;") {
return false
}
return anglePlaceholderIdentifier(strings.TrimSuffix(strings.TrimPrefix(value, "&lt;"), "&gt;"))
}
func starMaskedPlaceholder(value string) bool {
var stars int
for _, r := range value {
if r == '*' {
stars++
continue
}
return false
}
return stars >= 3
}
func namedPlaceholderValue(value string) bool {
switch value {
case "...", "placeholder", "redacted", "<redacted>", "xxxx", "test-secret":
case "...", "***", "****", "placeholder", "redacted", "<redacted>", "xxxx", "test-secret", "test-token", "dry-run", "dry_run":
return true
}
return strings.Contains(value, "cli_example") || allXPlaceholder(value)
return strings.Contains(value, "cli_example") ||
allXPlaceholder(value) ||
conventionalNamedPlaceholderValue(value)
}
func printfPlaceholderValue(value string) bool {
switch value {
case "%d", "%s", "%q", "%v", "%w", "%x", "%T":
return true
default:
return false
}
}
func allXPlaceholder(value string) bool {
@@ -81,6 +114,41 @@ func allXPlaceholder(value string) bool {
return true
}
func conventionalNamedPlaceholderValue(value string) bool {
if !delimitedPlaceholderIdentifier(value) {
return false
}
normalized := strings.ReplaceAll(value, "-", "_")
if rest, ok := strings.CutPrefix(normalized, "your_"); ok {
return conventionalCredentialPlaceholderName(rest)
}
if rest, ok := strings.CutSuffix(normalized, "_here"); ok {
return conventionalCredentialPlaceholderName(rest)
}
return false
}
func conventionalCredentialPlaceholderName(value string) bool {
switch value {
case "api_key",
"access_key",
"private_key",
"secret",
"password",
"passwd",
"token",
"webhook",
"access_token",
"refresh_token",
"bearer_token",
"session_token",
"client_secret":
return true
default:
return false
}
}
func urlWithAnglePlaceholder(value string) bool {
if !strings.Contains(value, "://") ||
!strings.Contains(value, "<") ||

View File

@@ -4,7 +4,10 @@
package publiccontent
import (
"encoding/base64"
"encoding/json"
"fmt"
"math"
"path/filepath"
"sort"
"strings"
@@ -52,8 +55,9 @@ func scanText(file, source, text string, detectorFile bool) []Finding {
keyName, _ := normalizedCredentialAssignmentKey(match[0])
if value == "" ||
isNonSecretLiteralValue(value) ||
isBenignCodeCredentialExpression(file, value) ||
isBenignCodeCredentialExpression(file, line, match[0], value) ||
isPlaceholderValue(value) ||
isPermissionScopeIdentifierAssignment(keyName, value) ||
isResourceTokenPlaceholderAssignment(keyName, value) {
continue
}
@@ -63,21 +67,27 @@ func scanText(file, source, text string, detectorFile bool) []Finding {
out = append(out, newFinding("public_content_generic_credential", file, lineNo, source, redactAssignment(match[0])))
}
for _, match := range jwtLikeRE.FindAllString(line, -1) {
if isSchemaDottedIdentifier(line, match) {
if !isJWTToken(match) {
continue
}
out = append(out, newFinding("public_content_jwt_like_token", file, lineNo, source, redactToken(match)))
}
for range bearerHeaderRE.FindAllString(line, -1) {
for _, match := range bearerHeaderRE.FindAllString(line, -1) {
if isPlaceholderBearerHeader(match) {
continue
}
out = append(out, newFinding("public_content_bearer_header", file, lineNo, source, "Authorization: Bearer <redacted>"))
}
for _, match := range credentialURLRE.FindAllString(line, -1) {
if isPlaceholderCredentialURL(match) {
if isPlaceholderCredentialURL(file, match) {
continue
}
out = append(out, newFinding("public_content_credential_url", file, lineNo, source, redactCredentialURL(match)))
}
for _, match := range privateIPv4RE.FindAllString(line, -1) {
if !warnForPrivateIPv4(file) {
continue
}
out = append(out, newFinding("public_content_private_ipv4", file, lineNo, source, match))
}
if source == "branch" && automationBranchRE.MatchString(line) {
@@ -124,6 +134,9 @@ func isCredentialAssignmentMatch(match string) bool {
if isBenignTokenField(name) && !credentialShapedValue(value) {
return false
}
if isWeakTokenCredentialKey(name) && !weakTokenValueLooksCredentialLike(value) {
return false
}
return isExplicitCredentialKey(name)
}
@@ -261,7 +274,7 @@ func isResourceTokenPlaceholderAssignment(key, value string) bool {
case key == "retry_without_token" && numericStringPlaceholderValue(value):
return true
case tokenLikePlaceholderKey(key):
return tokenLikePlaceholderValue(value)
return tokenLikePlaceholderValue(key, value)
default:
return false
}
@@ -273,12 +286,16 @@ func tokenLikePlaceholderKey(key string) bool {
strings.HasSuffix(key, "-token")
}
func tokenLikePlaceholderValue(value string) bool {
func tokenLikePlaceholderValue(key, value string) bool {
normalized := strings.ToLower(strings.Trim(value, `"'`))
if normalized == "" || credentialShapedIdentifier(normalized) {
return false
}
if authCredentialTokenKey(key) {
return false
}
return resourceTokenPlaceholderValue(value) ||
maskedTokenFixturePlaceholderValue(key, normalized) ||
isPlaceholderValue(value) ||
normalized == "token" ||
strings.Contains(normalized, "...") ||
@@ -288,6 +305,149 @@ func tokenLikePlaceholderValue(value string) bool {
strings.HasPrefix(normalized, ".")
}
func maskedTokenFixturePlaceholderValue(key, value string) bool {
if authCredentialTokenKey(key) {
return false
}
var stars, alnum int
for _, r := range value {
switch {
case r == '*':
stars++
case (r >= 'a' && r <= 'z') || (r >= '0' && r <= '9'):
alnum++
default:
return false
}
}
return stars >= 6 && alnum > 0
}
func isWeakTokenCredentialKey(key string) bool {
if authCredentialTokenKey(key) || isStrongTokenCredentialKey(key) {
return false
}
return key == "token" ||
strings.HasSuffix(key, "_token") ||
strings.HasSuffix(key, "-token")
}
func isStrongTokenCredentialKey(key string) bool {
parts := credentialKeyParts(strings.ReplaceAll(strings.ToLower(key), "-", "_"))
for _, phrase := range [][2]string{
{"access", "token"},
{"refresh", "token"},
{"auth", "token"},
{"bearer", "token"},
{"session", "token"},
{"service", "token"},
{"bot", "token"},
{"api", "token"},
{"secret", "token"},
} {
if hasAdjacentCredentialParts(parts, phrase[0], phrase[1]) {
return true
}
}
return false
}
func weakTokenValueLooksCredentialLike(value string) bool {
normalized := strings.ToLower(strings.Trim(value, `"'<>`))
if normalized == "" ||
isNonSecretLiteralValue(value) ||
isPlaceholderValue(value) {
return false
}
candidate := unwrapCredentialValue(normalized)
return credentialShapedIdentifier(candidate) ||
highEntropyCredentialValue(candidate) ||
commandSubstitutionLooksCredentialLike(normalized) ||
(strings.Contains(normalized, "://") &&
urlRemainderLooksCredentialLike(removeAnglePlaceholders(normalized)))
}
func unwrapCredentialValue(value string) string {
value = strings.TrimSpace(strings.Trim(value, `"'<>`))
if strings.HasPrefix(value, "${{") && strings.HasSuffix(value, "}}") {
value = strings.TrimSpace(strings.TrimSuffix(strings.TrimPrefix(value, "${{"), "}}"))
}
value = strings.TrimPrefix(value, "$")
value = strings.Trim(value, "%")
return strings.TrimSpace(value)
}
func highEntropyCredentialValue(value string) bool {
if len(value) < 32 {
return false
}
var hasLetter, hasDigit bool
for _, r := range value {
switch {
case r >= 'a' && r <= 'z':
hasLetter = true
case r >= '0' && r <= '9':
hasDigit = true
case r == '_' || r == '-' || r == '.' || r == '=':
default:
return false
}
}
return hasLetter && hasDigit && shannonEntropy(value) >= 3.5
}
func shannonEntropy(value string) float64 {
if value == "" {
return 0
}
counts := map[rune]int{}
for _, r := range value {
counts[r]++
}
var entropy float64
length := float64(len([]rune(value)))
for _, count := range counts {
p := float64(count) / length
entropy -= p * log2(p)
}
return entropy
}
func log2(value float64) float64 {
return math.Log(value) / math.Ln2
}
func authCredentialTokenKey(key string) bool {
switch strings.ReplaceAll(strings.ToLower(key), "-", "_") {
case "access_token",
"api_token",
"bot_token",
"refresh_token",
"secret_token",
"session_token",
"service_token",
"bearer_token",
"auth_token",
"authorization_token",
"id_token":
return true
default:
return false
}
}
func isPermissionScopeIdentifierAssignment(key, value string) bool {
if !strings.HasSuffix(key, "_token") {
return false
}
switch strings.ToLower(strings.Trim(value, `"',;`)) {
case "read", "write", "modify", "readonly", "get_as_user":
return true
default:
return false
}
}
func idempotencyTokenPlaceholderValue(value string) bool {
return numericStringPlaceholderValue(value) || uuidStringPlaceholderValue(value)
}
@@ -328,20 +488,87 @@ func numericStringPlaceholderValue(value string) bool {
return true
}
func isBenignCodeCredentialExpression(file, value string) bool {
func isBenignCodeCredentialExpression(file, line, match, value string) bool {
normalized := strings.TrimSpace(value)
if strings.HasPrefix(normalized, "regexp.MustCompile(") {
return true
}
if !sourceCodeFile(file) || quotedLiteral(value) || credentialShapedValue(value) {
if !sourceCodeFile(file) || credentialShapedValue(value) {
return false
}
if rhs, ok := sourceCodeTypedCredentialRHS(line, match); ok {
return isBenignTypedCredentialRHS(rhs)
}
rawValueQuoted := credentialAssignmentRawValueQuoted(match)
if sourceCodeLiteralLooksNonSecret(normalized, !rawValueQuoted) {
return true
}
if sourceCodeFormatStringLiteral(normalized) && sourceCodeFormatArgumentContext(line, match) {
return true
}
if strings.Contains(match, "+") {
return true
}
if rawValueQuoted {
return false
}
if quotedLiteral(value) {
return sourceCodeLiteralLooksNonSecret(value, false)
}
return codeReferenceExpression(normalized)
}
func sourceCodeTypedCredentialRHS(line, match string) (string, bool) {
idx := strings.Index(line, match)
if idx < 0 {
return "", false
}
key, ok := credentialAssignmentKey(match)
if !ok {
return "", false
}
rest := strings.TrimSpace(line[idx+len(key):])
if !strings.HasPrefix(rest, ":") {
return "", false
}
typeAndRHS := strings.TrimSpace(strings.TrimPrefix(rest, ":"))
assignmentIdx := strings.Index(typeAndRHS, "=")
if assignmentIdx < 0 {
return "", false
}
return strings.TrimSpace(typeAndRHS[assignmentIdx+1:]), true
}
func isBenignTypedCredentialRHS(value string) bool {
value = strings.TrimRight(strings.TrimSpace(value), ",;")
if value == "" || isNonSecretLiteralValue(value) || isPlaceholderValue(value) {
return true
}
if credentialShapedValue(value) {
return false
}
if sourceCodeLiteralLooksNonSecret(value, !quotedLiteral(value)) {
return true
}
if quotedLiteral(value) {
return false
}
return codeReferenceExpression(value)
}
func credentialAssignmentRawValueQuoted(match string) bool {
key, ok := credentialAssignmentKey(match)
if !ok {
return false
}
rest := strings.TrimSpace(strings.TrimPrefix(match[len(key):], ":"))
rest = strings.TrimSpace(strings.TrimPrefix(rest, "="))
return strings.HasPrefix(rest, `"`) || strings.HasPrefix(rest, `'`)
}
func sourceCodeFile(file string) bool {
switch filepath.Ext(file) {
case ".go", ".py":
case ".go", ".js", ".jsx", ".py", ".ts", ".tsx":
return true
default:
return false
@@ -355,7 +582,147 @@ func quotedLiteral(value string) bool {
(strings.HasPrefix(normalized, `'`) && strings.HasSuffix(normalized, `'`)))
}
func sourceCodeLiteralLooksNonSecret(value string, allowNumeric bool) bool {
literal := strings.Trim(strings.TrimSpace(value), `"'`)
if strings.HasPrefix(literal, "/") {
return true
}
return (allowNumeric && numericStringPlaceholderValue(literal)) ||
sourceCodeEnvVarNameLiteral(literal) ||
sourceCodeAttributeNameLiteral(literal) ||
sourceCodeFakeOrPlaceholderLiteral(literal) ||
sourceCodeCredentialTermLiteral(literal) ||
sourceCodeCredentialPrefixLiteral(literal) ||
sourceCodeVocabularyLiteral(literal) ||
sourceCodeSchemaTypeLiteral(literal) ||
benignCredentialStatusLiteral(literal)
}
func sourceCodeFormatArgumentContext(line, match string) bool {
idx := strings.Index(line, match)
if idx < 0 {
return false
}
prefix := line[:idx]
if semicolon := strings.LastIndex(prefix, ";"); semicolon >= 0 {
prefix = prefix[semicolon+1:]
}
return strings.Contains(prefix, "fmt.") ||
strings.Contains(prefix, "log.") ||
strings.Contains(prefix, "printf(") ||
strings.Contains(prefix, "Printf(") ||
strings.Contains(prefix, "Errorf(") ||
strings.Contains(prefix, "Fprintf(")
}
func sourceCodeFormatStringLiteral(value string) bool {
for i := 0; i < len(value)-1; i++ {
if value[i] != '%' {
continue
}
if value[i+1] == '%' {
i++
continue
}
j := i + 1
for j < len(value) && strings.ContainsRune("#+- 0.0123456789", rune(value[j])) {
j++
}
if j < len(value) && strings.ContainsRune("vTtbcdoOqxXUeEfFgGspw", rune(value[j])) {
return true
}
}
return false
}
func sourceCodeEnvVarNameLiteral(value string) bool {
if value == "" || !strings.Contains(value, "_") {
return false
}
var hasCredentialMarker bool
for _, r := range value {
switch {
case r >= 'A' && r <= 'Z':
case r >= '0' && r <= '9':
case r == '_':
default:
return false
}
}
for _, marker := range []string{"TOKEN", "SECRET", "KEY", "PASSWORD", "PASSWD"} {
if strings.Contains(value, marker) {
hasCredentialMarker = true
break
}
}
return hasCredentialMarker
}
func sourceCodeAttributeNameLiteral(value string) bool {
normalized := strings.ToLower(value)
return strings.HasPrefix(normalized, "data-") && delimitedPlaceholderIdentifier(normalized)
}
func sourceCodeFakeOrPlaceholderLiteral(value string) bool {
normalized := strings.ToLower(value)
return strings.HasPrefix(normalized, "fake_") ||
strings.HasPrefix(normalized, "fake-") ||
strings.Contains(normalized, "placeholder") ||
(strings.Contains(normalized, "<") && strings.Contains(normalized, ">"))
}
func sourceCodeCredentialTermLiteral(value string) bool {
normalized := strings.ToLower(strings.ReplaceAll(value, "-", "_"))
return conventionalCredentialPlaceholderName(normalized)
}
func sourceCodeCredentialPrefixLiteral(value string) bool {
switch strings.ToLower(value) {
case "appsecret:":
return true
default:
return false
}
}
func sourceCodeVocabularyLiteral(value string) bool {
switch strings.ToLower(value) {
case "bot", "tenant", "user":
return true
default:
return false
}
}
func sourceCodeSchemaTypeLiteral(value string) bool {
normalized := strings.ToLower(value)
return normalized == "string" || strings.HasPrefix(normalized, "string(")
}
func benignCredentialStatusLiteral(value string) bool {
normalized := strings.ToLower(strings.ReplaceAll(value, "-", "_"))
if !delimitedPlaceholderIdentifier(normalized) {
return false
}
for _, marker := range []string{
"bad_fmt",
"expired",
"format",
"invalid",
"missing",
"permission",
"status",
"type",
} {
if strings.Contains(normalized, marker) {
return true
}
}
return false
}
func codeReferenceExpression(value string) bool {
value = strings.TrimRight(strings.TrimSpace(value), ";")
if value == "" {
return false
}
@@ -364,7 +731,10 @@ func codeReferenceExpression(value string) bool {
return true
}
}
return codeIdentifier(value) && !credentialNameFragment(value)
if !codeIdentifier(value) {
return false
}
return codeIdentifier(value)
}
func codeIdentifier(value string) bool {
@@ -381,20 +751,6 @@ func codeIdentifier(value string) bool {
return true
}
func credentialNameFragment(value string) bool {
normalized := strings.ToLower(value)
for _, marker := range []string{"secret", "token", "password", "passwd", "key"} {
if strings.Contains(normalized, marker) {
return true
}
}
return false
}
func isSchemaDottedIdentifier(line, match string) bool {
return strings.Contains(line, "schema ") && strings.Contains(match, "_")
}
func isNonSecretLiteralValue(value string) bool {
switch strings.ToLower(strings.TrimSpace(strings.Trim(value, `"'`))) {
case "true", "false", "null", "nil", "{", "[":
@@ -404,6 +760,40 @@ func isNonSecretLiteralValue(value string) bool {
}
}
func isJWTToken(value string) bool {
parts := strings.Split(value, ".")
if len(parts) != 3 {
return false
}
header, err := decodeBase64URLSegment(parts[0])
if err != nil || !json.Valid(header) {
return false
}
var fields map[string]interface{}
if err := json.Unmarshal(header, &fields); err != nil {
return false
}
alg, ok := fields["alg"].(string)
return ok && alg != ""
}
func decodeBase64URLSegment(value string) ([]byte, error) {
if decoded, err := base64.RawURLEncoding.DecodeString(value); err == nil {
return decoded, nil
}
return base64.URLEncoding.DecodeString(value)
}
func isPlaceholderBearerHeader(match string) bool {
normalized := strings.ToLower(match)
idx := strings.LastIndex(normalized, "bearer ")
if idx < 0 {
return false
}
value := strings.TrimSpace(match[idx+len("bearer "):])
return isPlaceholderValue(value)
}
func isWebhookCredentialKey(key string) bool {
return strings.Contains(strings.ReplaceAll(key, "_", ""), "webhook")
}
@@ -562,7 +952,7 @@ func looksLikeEqualityComparison(value string) bool {
return strings.HasPrefix(strings.TrimSpace(value), "=")
}
func isPlaceholderCredentialURL(raw string) bool {
func isPlaceholderCredentialURL(file, raw string) bool {
userInfo, ok := credentialURLUserInfo(raw)
if !ok {
return false
@@ -571,7 +961,8 @@ func isPlaceholderCredentialURL(raw string) bool {
if !ok {
return false
}
return credentialURLPasswordPlaceholder(password)
return credentialURLPasswordPlaceholder(password) ||
(sourceOrTestFixtureFile(file) && credentialURLPasswordFixture(password))
}
func credentialURLPasswordPlaceholder(password string) bool {
@@ -585,6 +976,46 @@ func credentialURLPasswordPlaceholder(password string) bool {
return angleWrappedPlaceholder(decoded) || percentWrappedPlaceholder(decoded)
}
func credentialURLPasswordFixture(password string) bool {
normalized := strings.ToLower(strings.Trim(password, `"'`))
switch normalized {
case "p",
"pass",
"password",
"pat_abc",
"pw",
"s3cret",
"secret",
"t":
return true
default:
return false
}
}
func sourceOrTestFixtureFile(file string) bool {
normalized := filepath.ToSlash(file)
return sourceCodeFile(normalized) ||
strings.HasPrefix(normalized, "testdata/") ||
strings.HasPrefix(normalized, "fixtures/") ||
strings.Contains(normalized, "/testdata/") ||
strings.Contains(normalized, "/fixtures/")
}
func warnForPrivateIPv4(file string) bool {
normalized := filepath.ToSlash(file)
if sourceOrTestFixtureFile(normalized) {
return false
}
switch filepath.Ext(normalized) {
case ".md", ".mdx", ".txt", ".json", ".yaml", ".yml", ".toml", ".env":
return true
default:
return strings.HasPrefix(normalized, "docs/") ||
strings.HasPrefix(normalized, "skills/")
}
}
func credentialURLUserInfo(raw string) (string, bool) {
schemeIdx := strings.Index(raw, "://")
if schemeIdx < 0 {
@@ -741,7 +1172,12 @@ func sanitizeSemanticExcerpt(text string) string {
text = strings.ReplaceAll(text, `<redacted>"`, `<redacted>`)
text = strings.ReplaceAll(text, `<redacted>'`, `<redacted>`)
text = semanticBearerHeaderRE.ReplaceAllString(text, "Authorization: Bearer <redacted>")
text = jwtLikeRE.ReplaceAllString(text, "<jwt-like-token>")
text = jwtLikeRE.ReplaceAllStringFunc(text, func(match string) string {
if isJWTToken(match) {
return "<jwt-like-token>"
}
return match
})
text = credentialURLRE.ReplaceAllStringFunc(text, sanitizeCredentialURL)
return strings.Join(strings.Fields(text), " ")
}

View File

@@ -61,6 +61,19 @@ func TestScanFileWarnsForPrivateIPv4Examples(t *testing.T) {
}
}
func TestScanFileAllowsPrivateIPv4SourceFixtures(t *testing.T) {
got := ScanFile("internal/transport/warn_test.go", []byte(strings.Join([]string{
`proxy := "http://user:pass@10.0.0.1:3128"`,
`target := "socks5://admin:secret@172.16.0.1:1080"`,
`host := "192.168.0.10"`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_private_ipv4" {
t.Fatalf("private IPv4 source fixtures should not be public content findings: %#v", got)
}
}
}
func TestSemanticCandidateRequiresSpecificRiskSignals(t *testing.T) {
benign := semanticCandidate("docs/network.md", "file", "For a local lab, use RFC1918 example host 192.168."+"0.10 only.", 1)
if len(benign) != 0 {
@@ -211,7 +224,7 @@ func TestSemanticCandidateCoversRealE2ESemanticCases(t *testing.T) {
}
func TestScanFileDetectsDetectorFingerprintOnlyInPublicRuleFiles(t *testing.T) {
got := ScanFile(".gitleaks.toml", []byte("[[rules]]\nid = \"public"+"-content-leakage\"\n"))
got := ScanFile("testdata/publiccontent/.gitleaks.toml", []byte("[[rules]]\nid = \"public"+"-content-leakage\"\n"))
if !findingRules(got)["public_content_detector_fingerprint"] {
t.Fatalf("expected detector fingerprint finding, got %#v", got)
}
@@ -549,7 +562,7 @@ func TestScanFileDetectsCredentialURLWithEmptyUsername(t *testing.T) {
}
func TestScanFileAllowsPrivateKeyStateBooleans(t *testing.T) {
got := ScanFile("internal/qualitygate/publiccontent/collect.go", []byte(strings.Join([]string{
got := ScanFile("fixtures/scanner_state.go", []byte(strings.Join([]string{
"inPrivateKey = true",
"inPrivateKey = false",
"hasPrivateKey: false",
@@ -632,6 +645,45 @@ func TestScanFileAllowsCredentialURLPlaceholders(t *testing.T) {
}
}
func TestScanFileAllowsCredentialURLFixtures(t *testing.T) {
got := ScanFile("fixtures/network_test.go", []byte(strings.Join([]string{
`proxy := "http://user:pass@proxy:8080"`,
`repo := "https://u:t@h/r.git"`,
`target := "https://attacker:pw@open.feishu.cn"`,
`proxy := "http://admin:s3cret@127.0.0.1:3128"`,
`repo := "http://x-token:PAT_abc@git.host/app_x.git"`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_credential_url" {
t.Fatalf("credential URL fixtures should not be credential URL findings: %#v", got)
}
}
}
func TestScanFileAllowsRootCredentialURLFixtures(t *testing.T) {
got := ScanFile("fixtures/network.md", []byte(strings.Join([]string{
`proxy: http://user:pass@proxy:8080`,
`repo: https://u:t@h/r.git`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_credential_url" {
t.Fatalf("root credential URL fixtures should not be credential URL findings: %#v", got)
}
}
}
func TestScanFileAllowsRootPrivateIPv4Fixtures(t *testing.T) {
got := ScanFile("testdata/network.md", []byte(strings.Join([]string{
`endpoint: http://10.0.0.1:8080`,
`redis: 192.168.1.10:6379`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_private_ipv4" {
t.Fatalf("root private IPv4 fixtures should not be private IPv4 findings: %#v", got)
}
}
}
func TestScanFileDetectsCredentialURLsWithRedactedSubstringPasswords(t *testing.T) {
got := ScanFile("docs/config.yaml", []byte("DATABASE_URL=postgres://user:notredactedreal@example.invalid/db\n"))
for _, item := range got {
@@ -648,6 +700,7 @@ func TestScanFileDetectsCredentialURLsWithPlaceholderUserAndRealPassword(t *test
"DATABASE_URL=postgres://<user>:real-secret@example.invalid/db",
"DATABASE_URL=postgres://<user>:" + stripeLike + "@example.invalid/db",
"URL=https://<user>:real-secret@example.invalid/path",
"REPO=https://x-token:" + stripeLike + "@git.host/app.git",
}, "\n")+"\n"))
var count int
for _, item := range got {
@@ -661,8 +714,8 @@ func TestScanFileDetectsCredentialURLsWithPlaceholderUserAndRealPassword(t *test
}
}
}
if count != 3 {
t.Fatalf("placeholder-user credential URL findings = %d, want 3: %#v", count, got)
if count != 4 {
t.Fatalf("placeholder-user credential URL findings = %d, want 4: %#v", count, got)
}
}
@@ -724,8 +777,70 @@ func TestScanFileAllowsBenignJSONTokenFields(t *testing.T) {
}
}
func TestScanFileAllowsWeakTokenFieldsWithoutCredentialEvidence(t *testing.T) {
got := ScanFile("docs/resource-tokens.md", []byte(strings.Join([]string{
`{"token":"img_abc123"}`,
`{"token":"img_live_secret"}`,
`{"token":"img_prod_key"}`,
`token=ab********cd`,
`{"image_token":"img_live_secret"}`,
`{"data_mail_token":"mail_abc123"}`,
`{"whiteboard_token":"board_v3_example"}`,
`{"want_token":"token from callback"}`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("weak token fields without credential evidence should not be credential findings: %#v", got)
}
}
}
func TestScanFileDetectsWeakTokenFieldsWithHighConfidenceCredentialValues(t *testing.T) {
githubToken := "ghp_" + "1234567890abcdef1234567890abcdef1234"
stripeToken := "sk_" + "live_1234567890abcdef"
randomToken := strings.Join([]string{
"a1b2c3d4",
"e5f6g7h8",
"i9j0k1l2",
"m3n4p5q6",
}, "")
got := ScanFile("docs/config.md", []byte(strings.Join([]string{
`{"token":"` + githubToken + `"}`,
`token=` + stripeToken,
`{"image_token":"` + githubToken + `"}`,
`{"token":"` + randomToken + `"}`,
}, "\n")+"\n"))
var count int
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
count++
}
}
if count != 4 {
t.Fatalf("high-confidence weak token credential findings = %d, want 4: %#v", count, got)
}
}
func TestScanFileDetectsStrongAuthTokenKeysWithFixtureLikeValues(t *testing.T) {
got := ScanFile("docs/config.md", []byte(strings.Join([]string{
`{"access_token":"img_abc123"}`,
`{"api_token":"img_live_secret"}`,
`{"service_token":"ab********cd"}`,
`{"bot_token":"board_v3_example"}`,
}, "\n")+"\n"))
var count int
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
count++
}
}
if count != 4 {
t.Fatalf("strong auth token key findings = %d, want 4: %#v", count, got)
}
}
func TestScanFileAllowsTestFixtureSecretValues(t *testing.T) {
got := ScanFile("shortcuts/calendar/calendar_meeting_test.go", []byte(`AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,`+"\n"))
got := ScanFile("fixtures/calendar_meeting_test.go", []byte(`AppID: "test-app", AppSecret: "test-secret", Brand: core.BrandFeishu,`+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("test fixture secret should not be credential finding: %#v", got)
@@ -734,7 +849,7 @@ func TestScanFileAllowsTestFixtureSecretValues(t *testing.T) {
}
func TestScanFileAllowsRegexpTokenValidators(t *testing.T) {
got := ScanFile("shortcuts/minutes/minutes_detail.go", []byte("var validMinuteTokenDetail = regexp.MustCompile(`^[a-z0-9]+$`)\n"))
got := ScanFile("fixtures/minutes_detail.go", []byte("var validMinuteTokenDetail = regexp.MustCompile(`^[a-z0-9]+$`)\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("regexp token validator should not be credential finding: %#v", got)
@@ -743,7 +858,7 @@ func TestScanFileAllowsRegexpTokenValidators(t *testing.T) {
}
func TestScanFileAllowsBenignSourceCodeCredentialExpressions(t *testing.T) {
got := ScanFile("cmd/config/binder.go", []byte(strings.Join([]string{
got := ScanFile("fixtures/config_binder.go", []byte(strings.Join([]string{
"AppSecret: stored,",
"AccessToken: result.Token.AccessToken,",
`token := runtime.Str("token")`,
@@ -756,7 +871,7 @@ func TestScanFileAllowsBenignSourceCodeCredentialExpressions(t *testing.T) {
}
func TestScanFileAllowsPythonArgumentTokens(t *testing.T) {
got := ScanFile("skills/lark-slides/scripts/iconpark_tool.py", []byte(strings.Join([]string{
got := ScanFile("fixtures/iconpark_tool.py", []byte(strings.Join([]string{
"def normalize_token(value: str) -> str:",
" token = rest[index]",
" next_token = rest[index + 1] if index + 1 < len(rest) else None",
@@ -770,8 +885,174 @@ func TestScanFileAllowsPythonArgumentTokens(t *testing.T) {
}
}
func TestScanFileAllowsPythonCredentialTypeAnnotations(t *testing.T) {
got := ScanFile("fixtures/doc_word_stat.py", []byte(strings.Join([]string{
"class Counter:",
" def __init__(self) -> None:",
" self._token_kind: TokenKind | None = None",
" self.access_token: AccessToken | None = None",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("python credential-shaped type annotations should not be credential findings: %#v", got)
}
}
}
func TestScanFileAllowsSourceCodeCredentialNonSecretLiterals(t *testing.T) {
got := ScanFile("fixtures/auth_paths.go", []byte(strings.Join([]string{
`const PathOAuthTokenV2 = "/open-apis/authen/v2/oauth/token"`,
`return fmt.Errorf("failed to remove token: %v", err)`,
`const LarkErrTokenMissing = "token_missing"`,
`const LarkErrTokenExpired = 99991677`,
`const CliAppSecret = "LARKSUITE_CLI_APP_SECRET"`,
`const LargeAttachmentTokenAttr = "data-mail-token"`,
`const fakeOfficeTokenPrefix = "fake_office_"`,
`fmt.Fprintf(w, " - token=%s filename=%s\n", att.Token, att.FileName)`,
`tokenTypeHint := "access_token"`,
`const TokenTenant Token = "tenant"`,
`const secretKeyPrefix = "appsecret:"`,
`output.PrintJson(out, map[string]interface{}{"appSecret": "****"})`,
`return &credential.TokenResult{Token: "test-token"}, nil`,
`fmt.Fprintf(w, "password=%s\n", pat)`,
`text += "(img_token:" + imgToken + ")"`,
`map[string]interface{}{"token": "string(optional, from inspect)"}`,
`this.token = token;`,
`// AppSecret: "appsecret:<appId>"`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("source code non-secret literals should not be credential findings: %#v", got)
}
}
}
func TestScanFileAllowsCredentialLikePublicPlaceholders(t *testing.T) {
got := ScanFile("fixtures/placeholders.md", []byte(strings.Join([]string{
`app_secret=***`,
`{"token":"&lt;wiki_token&gt;"}`,
`{"token":"Pgrrwvr***********UnRb"}`,
`"scope_name": "auth:user_access_token:read"`,
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("public placeholders and scope identifiers should not be credential findings: %#v", got)
}
}
}
func TestScanFileDetectsPartiallyMaskedCredentialValues(t *testing.T) {
got := ScanFile("fixtures/config.md", []byte(strings.Join([]string{
"client_secret=realprefix***realsuffix",
"client_secret=ab********cd",
"access_token=ab********cd",
"refresh_token=realprefix********realsuffix",
}, "\n")+"\n"))
var count int
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
count++
}
}
if count != 4 {
t.Fatalf("partially masked credential findings = %d, want 4: %#v", count, got)
}
}
func TestScanFileAllowsDryRunCredentialPlaceholders(t *testing.T) {
got := ScanFile("fixtures/ci.yml", []byte(strings.Join([]string{
"LARKSUITE_CLI_APP_SECRET=dry-run",
"client_secret: dry_run",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("dry-run credential placeholders should not be credential findings: %#v", got)
}
}
}
func TestScanFileDetectsTypedCredentialAssignmentsWithSecretRHS(t *testing.T) {
cases := []struct {
name string
file string
text string
}{
{
name: "typescript simple secret",
file: "fixtures/source_secret.ts",
text: `const clientSecret: string = "real-client-secret-value"`,
},
{
name: "typescript numeric password",
file: "fixtures/source_secret.ts",
text: `const password: string = "12345678901234567890"`,
},
{
name: "typescript union secret",
file: "fixtures/source_secret.ts",
text: `const clientSecret: string | undefined = "real-client-secret-value"`,
},
{
name: "python simple secret",
file: "fixtures/source_secret.py",
text: `self.client_secret: str = "real-client-secret-value"`,
},
{
name: "python union secret",
file: "fixtures/source_secret.py",
text: `self.client_secret: str | None = "real-client-secret-value"`,
},
{
name: "python optional secret",
file: "fixtures/source_secret.py",
text: `self.client_secret: Optional[str] = "real-client-secret-value"`,
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got := ScanFile(tc.file, []byte(tc.text+"\n"))
if !findingRules(got)["public_content_generic_credential"] {
t.Fatalf("typed credential assignment should be reported: %#v", got)
}
})
}
}
func TestScanFileDetectsCredentialShapedSourceCodeLiterals(t *testing.T) {
githubToken := "ghp_" + "1234567890abcdef1234567890abcdef1234"
got := ScanFile("fixtures/source_secret.go", []byte(strings.Join([]string{
`const ClientSecret = "real-client-secret-value"`,
`const GithubToken = "` + githubToken + `"`,
`const Password = "12345678901234567890"`,
`const ClientSecretNumber = "12345678901234567890"`,
`const ClientSecretFormat = "abc%sdefreal"`,
`fmt.Println("done"); const ClientSecret = "abc%sdefreal"`,
}, "\n")+"\n"))
var count int
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
count++
}
}
if count != 6 {
t.Fatalf("source code credential-shaped literal findings = %d, want 6: %#v", count, got)
}
}
func TestScanFileAllowsPrintfCredentialPlaceholders(t *testing.T) {
got := ScanFile("fixtures/placeholders.md", []byte(strings.Join([]string{
"client_secret=%s",
"access_token=%v",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("printf placeholders should not be credential findings: %#v", got)
}
}
}
func TestScanFileAllowsEllipsisCredentialPlaceholders(t *testing.T) {
got := ScanFile("skills/lark-doc/references/lark-doc-fetch.md", []byte(strings.Join([]string{
got := ScanFile("fixtures/lark-doc-fetch.md", []byte(strings.Join([]string{
`<img token="..." url="https://..." width="..." height="..."/>`,
`<sheet token="..." sheet-id="...">`,
}, "\n")+"\n"))
@@ -783,7 +1064,7 @@ func TestScanFileAllowsEllipsisCredentialPlaceholders(t *testing.T) {
}
func TestScanFileAllowsSchemaDottedIdentifiers(t *testing.T) {
got := ScanFile("skills/lark-mail/references/lark-mail-recall.md", []byte("lark-cli schema mail.user_mailbox.sent_messages.get_recall_detail\n"))
got := ScanFile("fixtures/lark-mail-recall.md", []byte("lark-cli schema mail.user_mailbox.sent_messages.get_recall_detail\n"))
for _, item := range got {
if item.Rule == "public_content_jwt_like_token" {
t.Fatalf("schema dotted identifier should not be jwt finding: %#v", got)
@@ -791,8 +1072,38 @@ func TestScanFileAllowsSchemaDottedIdentifiers(t *testing.T) {
}
}
func TestScanFileAllowsMarkdownDottedAPIIdentifiers(t *testing.T) {
got := ScanFile("fixtures/mail_api_table.md", []byte(strings.Join([]string{
"| Method | Permission |",
"| --- | --- |",
"| `user_mailbox.sent_messages.get_recall_detail` | `mail:user_mailbox.message:readonly` |",
"| `user_mailbox.allow_sender.batch_create` | `mail:user_mailbox.message:modify` |",
"| `user_mailbox.allow_sender.batch_remove` | `mail:user_mailbox.message:modify` |",
"| `user_mailbox.blocked_sender.batch_create` | `mail:user_mailbox.message:modify` |",
"| `user_mailbox.blocked_sender.batch_remove` | `mail:user_mailbox.message:modify` |",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_jwt_like_token" {
t.Fatalf("markdown dotted API identifier should not be jwt finding: %#v", got)
}
}
}
func TestScanFileAllowsNonJWTDottedTaxonomy(t *testing.T) {
got := ScanFile("docs/api.md", []byte(strings.Join([]string{
"application/vnd.openxmlformats-officedocument.presentationml.presentation",
"corehr:employment.international_assignment.custom_field.apaas_id__c:read",
"user_mailbox.sent_messages.get_recall_detail queries recall detail.",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_jwt_like_token" {
t.Fatalf("non-JWT dotted taxonomy should not be jwt finding: %#v", got)
}
}
}
func TestScanFileAllowsClientTokenIdempotencyExamples(t *testing.T) {
got := ScanFile("skills/idempotency.md", []byte(strings.Join([]string{
got := ScanFile("fixtures/idempotency.md", []byte(strings.Join([]string{
`{"client_token":"1704067200"}`,
`{"client_token":"fe599b60-450f-46ff-b2ef-9f6675625b97"}`,
}, "\n")+"\n"))
@@ -805,7 +1116,7 @@ func TestScanFileAllowsClientTokenIdempotencyExamples(t *testing.T) {
func TestScanFileDetectsCredentialShapedClientTokenValues(t *testing.T) {
stripeLike := "sk_" + "live_1234567890abcdef"
got := ScanFile("skills/idempotency.md", []byte(strings.Join([]string{
got := ScanFile("fixtures/idempotency.md", []byte(strings.Join([]string{
`{"client_token":"` + stripeLike + `"}`,
`{"client_token":"real-client-secret-value"}`,
}, "\n")+"\n"))
@@ -821,7 +1132,7 @@ func TestScanFileDetectsCredentialShapedClientTokenValues(t *testing.T) {
}
func TestScanFileAllowsTokenLikePlaceholderExamples(t *testing.T) {
got := ScanFile("skills/placeholders.md", []byte(strings.Join([]string{
got := ScanFile("fixtures/placeholders.md", []byte(strings.Join([]string{
`{ "block_token": "boardXXXX" }`,
`{ "resource_token": "doc_token_or_url" }`,
`{ "token": "canonical_token" }`,
@@ -841,7 +1152,7 @@ func TestScanFileAllowsTokenLikePlaceholderExamples(t *testing.T) {
func TestScanFileDetectsCredentialShapedTokenLikePlaceholderValues(t *testing.T) {
stripeLike := "sk_" + "live_1234567890abcdef"
got := ScanFile("skills/placeholders.md", []byte(strings.Join([]string{
got := ScanFile("fixtures/placeholders.md", []byte(strings.Join([]string{
`{ "resource_token": "` + stripeLike + `" }`,
`{ "block_token": "real-client-secret-value" }`,
}, "\n")+"\n"))
@@ -856,10 +1167,12 @@ func TestScanFileDetectsCredentialShapedTokenLikePlaceholderValues(t *testing.T)
}
}
func TestScanFileDetectsNonFixtureMinuteTokenValues(t *testing.T) {
got := ScanFile("shortcuts/minutes/minutes_search_test.go", []byte(`{"token":"minute_real_secret"}`+"\n"))
if !findingRules(got)["public_content_generic_credential"] {
t.Fatalf("non-fixture minute token should be credential finding: %#v", got)
func TestScanFileAllowsNonFixtureResourceTokenValues(t *testing.T) {
got := ScanFile("fixtures/minutes_search_test.go", []byte(`{"token":"minute_real_secret"}`+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("resource-like bare token value should not be credential finding: %#v", got)
}
}
}
@@ -958,6 +1271,19 @@ func TestScanFileDetectsJSONBearerHeaders(t *testing.T) {
}
}
func TestScanFileAllowsBearerHeaderPlaceholders(t *testing.T) {
got := ScanFile("docs/auth.md", []byte(strings.Join([]string{
"Authorization: Bearer YOUR_ACCESS_TOKEN",
`{"Authorization":"Bearer ACCESS_TOKEN_HERE"}`,
"Authorization: Bearer <access-token>",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_bearer_header" {
t.Fatalf("bearer placeholder should not be bearer finding: %#v", got)
}
}
}
func TestSemanticCandidateRedactsJSONBearerHeaders(t *testing.T) {
token := "abcdefghijklmnopqrstuvwxyz"
text := "private launch plan for internal rollout on Friday\n" +
@@ -975,6 +1301,22 @@ func TestSemanticCandidateRedactsJSONBearerHeaders(t *testing.T) {
}
}
func TestSemanticCandidateKeepsNonJWTDottedTaxonomy(t *testing.T) {
text := "private launch plan for internal rollout on Friday\n" +
"Supported MIME type: application/vnd.openxmlformats-officedocument.presentationml.presentation\n"
got := semanticCandidate("docs/public.md", "file", text, 1)
if len(got) != 1 {
t.Fatalf("semantic candidate len = %d, want 1: %#v", len(got), got)
}
if strings.Contains(got[0].Excerpt, "<jwt-like-token>") {
t.Fatalf("semantic candidate should not redact non-JWT dotted taxonomy: %#v", got[0])
}
if !strings.Contains(got[0].Excerpt, "application/vnd.openxmlformats-officedocument.presentationml.presentation") {
t.Fatalf("semantic candidate should keep non-JWT dotted taxonomy, got %#v", got[0])
}
}
func TestScanFileDetectsCommonProvenanceMarkers(t *testing.T) {
text := strings.Join([]string{
"Generated with automated code assistant",
@@ -1012,6 +1354,37 @@ func TestScanFileAllowsPercentWrappedPlaceholder(t *testing.T) {
}
}
func TestScanFileAllowsConventionalCredentialPlaceholders(t *testing.T) {
got := ScanFile("docs/config.md", []byte(strings.Join([]string{
"client_secret: YOUR_CLIENT_SECRET",
"api_key: YOUR_API_KEY",
"password: YOUR_PASSWORD",
"access_token: ACCESS_TOKEN_HERE",
}, "\n")+"\n"))
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
t.Fatalf("conventional credential placeholder should not be credential finding: %#v", got)
}
}
}
func TestScanFileDetectsCredentialShapedPlaceholderLookalikes(t *testing.T) {
stripeLike := "sk_" + "live_1234567890abcdef"
got := ScanFile("docs/config.md", []byte(strings.Join([]string{
"client_secret: " + stripeLike + "_HERE",
"api_key: YOUR_" + stripeLike,
}, "\n")+"\n"))
var count int
for _, item := range got {
if item.Rule == "public_content_generic_credential" {
count++
}
}
if count != 2 {
t.Fatalf("credential-shaped placeholder lookalike findings = %d, want 2: %#v", count, got)
}
}
func TestScanFileDetectsPercentWrappedCredentialValues(t *testing.T) {
stripeLike := "sk_" + "live_1234567890abcdef"
patLike := "gh" + "p_1234567890abcdef1234567890abcdef1234"

View File

@@ -59,13 +59,9 @@ func BuildConsoleScopeURL(brand core.LarkBrand, appID, scope string) string {
if appID == "" || scope == "" {
return ""
}
host := "open.feishu.cn"
if brand == core.BrandLark {
host = "open.larksuite.com"
}
return fmt.Sprintf(
"https://%s/page/scope-apply?clientID=%s&scopes=%s",
host,
"%s/page/scope-apply?clientID=%s&scopes=%s",
core.ResolveOpenBaseURL(brand),
url.QueryEscape(appID),
url.QueryEscape(scope),
)

View File

@@ -4,8 +4,11 @@
package schema
import (
"regexp"
"sort"
"strings"
"github.com/larksuite/cli/internal/affordance"
"github.com/larksuite/cli/internal/apicatalog"
"github.com/larksuite/cli/internal/core"
"github.com/larksuite/cli/internal/meta"
@@ -22,7 +25,7 @@ func Convert(f meta.Field) Property {
if f.Type == "file" {
p.Format = "binary"
}
p.Description = f.Description
p.Description = normalizeDesc(f.Description)
p.Default = f.CoercedDefault()
p.Example = f.CoercedExample()
p.Minimum = f.MinBound()
@@ -52,6 +55,24 @@ func Convert(f meta.Field) Property {
return p
}
var (
sepRunRe = regexp.MustCompile(`[;]{2,}`)
spaceRunRe = regexp.MustCompile(`[ \t]{2,}`)
)
// normalizeDesc de-crufts a meta_data description for the envelope — strips
// markdown emphasis and collapses doubled separators/spaces — but keeps content
// (links, newlines, sentences); the compact flag-help has its own stricter pass.
func normalizeDesc(s string) string {
if s == "" {
return ""
}
s = strings.ReplaceAll(s, "**", "")
s = sepRunRe.ReplaceAllString(s, "; ")
s = spaceRunRe.ReplaceAllString(s, " ")
return strings.TrimRight(s, " ;;。.,、\n")
}
// enumSchema splits coerced enum options into the parallel enum / enumDescriptions
// arrays for the envelope. enumDescriptions is nil unless at least one value
// carries a description (so the bare-enum form stays values-only), keeping the
@@ -86,6 +107,18 @@ func propsOf(fields []meta.Field) *OrderedProps {
return op
}
// paramPropsOf is propsOf for the params section: each property also carries
// its CLI flag (--kebab-name).
func paramPropsOf(fields []meta.Field) *OrderedProps {
op := &OrderedProps{}
for _, f := range fields {
p := Convert(f)
p.Flag = "--" + f.FlagName()
op.Set(f.Name, p)
}
return op
}
// requiredOf returns the alphabetized names of the required fields.
func requiredOf(fields []meta.Field) []string {
var required []string
@@ -108,16 +141,17 @@ func buildInputSchema(m meta.Method) *InputSchema {
Properties: &OrderedProps{},
}
addInputObject(is, "params", "", m.Params())
addInputObject(is, "data", "", m.Data())
addInputObject(is, "file", "Binary file uploads. Each property is a file field with format:binary; CLI maps each to --file <key>=<path>.", m.Files())
addInputObject(is, "params", "", m.Params(), true, "")
addInputObject(is, "data", "", m.Data(), false, "--data")
addInputObject(is, "file", "Binary file uploads. Each property is a file field with format:binary; CLI maps each to --file <key>=<path>.", m.Files(), false, "--file")
if m.Risk == core.RiskHighRiskWrite {
falseVal := false
is.Properties.Set("yes", Property{
Type: "boolean",
Flag: "--yes",
Default: falseVal,
Description: "CLI confirmation gate. Must be true to execute; lark-cli rejects with confirmation_required if absent or false. Not sent to the backend.",
Description: "CLI confirmation gate. Must be true to execute; lark-cli rejects with confirmation_required if absent or false. Pass --yes only after the user has explicitly confirmed; not sent to the backend.",
})
}
@@ -125,20 +159,24 @@ func buildInputSchema(m meta.Method) *InputSchema {
return is
}
// addInputObject adds one named sub-object section (params/data/file) to the
// input schema when it has fields: its Properties come from the fields, its
// Required lists the mandatory keys, and the section itself is required at top
// level when any field is required. Empty sections are skipped.
func addInputObject(is *InputSchema, name, description string, fields []meta.Field) {
// addInputObject adds one section (params/data/file) when it has fields, marking
// the section required at top level when any field is. asFlags tags each property
// with its --flag (params only); carrier names the section's flag (--data/--file).
func addInputObject(is *InputSchema, name, description string, fields []meta.Field, asFlags bool, carrier string) {
if len(fields) == 0 {
return
}
props := propsOf(fields)
if asFlags {
props = paramPropsOf(fields)
}
req := requiredOf(fields)
is.Properties.Set(name, Property{
Type: "object",
Description: description,
Carrier: carrier,
Required: req,
Properties: propsOf(fields),
Properties: props,
})
if len(req) > 0 {
is.Required = append(is.Required, name)
@@ -179,7 +217,13 @@ func buildMeta(m meta.Method) *Meta {
// EnvelopeOf renders the MCP envelope for one method ref — the ref-based entry
// callers use, since apicatalog.MethodRef is the metadata navigation currency.
func EnvelopeOf(ref apicatalog.MethodRef) Envelope {
return assemble(ref.Service.Name, ref.ResourcePath, ref.Method)
m := ref.Method
// The affordance overlay lives in the CLI, not the metadata; look it up
// lazily here (it takes precedence over any affordance the metadata carries).
if raw, ok := affordance.For(ref.Service.Name, m.ID); ok {
m.Affordance = raw
}
return assemble(ref.Service.Name, ref.ResourcePath, m)
}
// Envelopes renders the given method refs into envelopes, sorted by name. The
@@ -205,7 +249,7 @@ func assemble(serviceName string, resourcePath []string, m meta.Method) Envelope
return Envelope{
Name: name,
Description: m.Description,
Description: normalizeDesc(m.Description),
InputSchema: buildInputSchema(m),
OutputSchema: buildOutputSchema(m),
Meta: buildMeta(m),

View File

@@ -9,7 +9,9 @@ import (
"reflect"
"strings"
"testing"
"testing/fstest"
"github.com/larksuite/cli/internal/affordance"
"github.com/larksuite/cli/internal/apicatalog"
"github.com/larksuite/cli/internal/meta"
"github.com/larksuite/cli/internal/registry"
@@ -504,6 +506,31 @@ func TestBuildMeta_AffordanceFromMethod(t *testing.T) {
}
}
// EnvelopeOf injects affordance from the CLI overlay (looked up lazily by
// service + method id), so a method whose metadata carries none still gets
// guidance in its envelope when an overlay entry exists.
func TestEnvelopeOf_AffordanceFromOverlay(t *testing.T) {
// The overlay source is the top-level affordance/ tree, injected at startup;
// inject a fixture so this unit test does not depend on the shipped content.
// Reset afterwards (this binary installs no source by default) for isolation.
t.Cleanup(func() { affordance.SetSource(nil) })
affordance.SetSource(fstest.MapFS{"approval.md": &fstest.MapFile{Data: []byte(
"# approval\n> skill: lark-approval\n\n## instances get\n查询某审批实例的状态与进度。\n\n### Examples\n\n**按 code 查询**\n```bash\nlark-cli approval instances get --instance-code \"x\"\n```\n")}})
env := synthEnvelope("approval", []string{"instances"}, meta.Method{ID: "instances.get", Name: "get"})
if env.Meta == nil || env.Meta.Affordance == nil {
t.Fatal("expected affordance from the approval overlay, got none")
}
if len(env.Meta.Affordance.UseWhen) == 0 || len(env.Meta.Affordance.Examples) == 0 {
t.Errorf("overlay affordance missing use_when/examples: %+v", env.Meta.Affordance)
}
// A method id with no overlay entry carries no affordance.
bare := synthEnvelope("approval", []string{"instances"}, meta.Method{ID: "instances.no_such_method", Name: "x"})
if bare.Meta != nil && bare.Meta.Affordance != nil {
t.Errorf("method without overlay should have no affordance, got %+v", bare.Meta.Affordance)
}
}
func TestBuildMeta_MissingDocURLOmitted(t *testing.T) {
method := map[string]interface{}{
"scopes": []interface{}{"x"},

View File

@@ -13,6 +13,10 @@ import (
)
// Envelope is the MCP Tool spec contract for a single API method command.
//
// The REST route (httpMethod/path) is deliberately NOT exposed: every
// schema-resolvable method already has a typed command, so the raw path would
// only tempt an agent toward the `api` escape hatch.
type Envelope struct {
Name string `json:"name"`
Description string `json:"description"`
@@ -44,9 +48,15 @@ type OutputSchema struct {
// "params" / "data" sub-objects inside inputSchema): it lists which keys
// inside that object's Properties are mandatory. Leaf fields ignore it.
type Property struct {
Type string `json:"type,omitempty"`
Description string `json:"description,omitempty"`
Enum []interface{} `json:"enum,omitempty"`
Type string `json:"type,omitempty"`
Description string `json:"description,omitempty"`
// Flag is the typed CLI flag a params property maps to (e.g. "--folder-id");
// absent on body/file fields, which travel via the section's Carrier.
Flag string `json:"flag,omitempty"`
// Carrier names the flag a whole inputSchema section travels on ("--data" /
// "--file"); empty on the params section, whose properties carry their Flag.
Carrier string `json:"carrier,omitempty"`
Enum []interface{} `json:"enum,omitempty"`
// EnumDescriptions, when present, is parallel to Enum: the human meaning of
// each allowed value, in the same order. Omitted when no value carries a
// description. This is the widely-recognized JSON-Schema extension (VS Code,

View File

@@ -0,0 +1,34 @@
package svglide
import (
"fmt"
"strings"
)
func validatePreparedImageAssetPath(raw string) (string, error) {
path := strings.TrimSpace(raw)
if path == "" {
return "", fmt.Errorf("image asset path must not be empty")
}
if strings.Contains(path, `\`) {
return "", fmt.Errorf("image asset path %q must use forward slashes", raw)
}
if strings.Contains(path, "%") {
return "", fmt.Errorf("image asset path %q must not contain percent encoding", raw)
}
if strings.Contains(path, ":") || strings.Contains(path, "//") || isAbsoluteRunPath(path) {
return "", fmt.Errorf("image asset path %q must be a local assets/images/<file> path", raw)
}
parts := strings.Split(path, "/")
if len(parts) != 3 || parts[0] != "assets" || parts[1] != "images" {
return "", fmt.Errorf("image asset path %q must match assets/images/<file>", raw)
}
fileName := parts[2]
if fileName == "" || fileName == "." || fileName == ".." {
return "", fmt.Errorf("image asset path %q must include a file name", raw)
}
if strings.HasPrefix(fileName, ".") || strings.Contains(fileName, "..") {
return "", fmt.Errorf("image asset file name %q must not contain dot segments", fileName)
}
return path, nil
}

View File

@@ -0,0 +1,46 @@
package svglide
import "testing"
func TestValidatePreparedImageAssetPath(t *testing.T) {
tests := []struct {
name string
path string
want string
wantErr bool
}{
{name: "valid", path: "assets/images/hero.png", want: "assets/images/hero.png"},
{name: "trim", path: " assets/images/hero.png ", want: "assets/images/hero.png"},
{name: "empty", path: "", wantErr: true},
{name: "remote", path: "https://example.com/hero.png", wantErr: true},
{name: "parent directory", path: "../hero.png", wantErr: true},
{name: "absolute", path: "/Users/example/hero.png", wantErr: true},
{name: "file url", path: "file:///tmp/hero.png", wantErr: true},
{name: "protocol relative", path: "//example.com/hero.png", wantErr: true},
{name: "data url", path: "data:image/png;base64,AAAA", wantErr: true},
{name: "percent", path: "assets/images/hero%2epng", wantErr: true},
{name: "nested", path: "assets/images/nested/hero.png", wantErr: true},
{name: "wrong directory", path: "assets/other/hero.png", wantErr: true},
{name: "leading dot", path: "assets/images/.hero.png", wantErr: true},
{name: "dot dot filename", path: "assets/images/hero..png", wantErr: true},
{name: "backslash", path: `assets\images\hero.png`, wantErr: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := validatePreparedImageAssetPath(tt.path)
if tt.wantErr {
if err == nil {
t.Fatalf("expected error, got path %q", got)
}
return
}
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if got != tt.want {
t.Fatalf("path = %q, want %q", got, tt.want)
}
})
}
}

468
internal/svglide/author.go Normal file
View File

@@ -0,0 +1,468 @@
package svglide
import (
"encoding/json"
"fmt"
"html"
"strings"
)
const (
defaultSlideWidth = 960
defaultSlideHeight = 540
defaultAuthorBgColor = "#FFFFFF"
defaultAuthorInkColor = "#111827"
defaultAuthorMuteColor = "#6B7280"
defaultAuthorAccent = "#2563EB"
svgAuthorReceipt = "receipts/svg_author.json"
)
type AuthorReport struct {
Status string `json:"status"`
Slides []string `json:"slides"`
}
type authorDeck struct {
Title string `json:"title"`
Slides []authorDeckSlide `json:"slides"`
}
type authorDeckSlide struct {
ID string `json:"id"`
Title string `json:"title"`
Summary string `json:"summary"`
Role string `json:"role"`
KeyMessage string `json:"key_message"`
Path string `json:"path"`
}
type authorSlideContentFile struct {
Slides []authorSlideContent `json:"slides"`
}
type authorSlideContent struct {
ID string `json:"id"`
Content string `json:"content"`
Notes string `json:"notes"`
SourceRefs []string `json:"source_refs"`
Visuals []authorSlideVisual `json:"visuals"`
}
type authorSlideVisual struct {
ID string `json:"id"`
Type string `json:"type"`
Instruction string `json:"instruction"`
}
type authorAssetsFile struct {
Assets []authorAsset `json:"assets"`
}
type authorAsset struct {
ID string `json:"id"`
SlideID string `json:"slide_id"`
Type string `json:"type"`
Path string `json:"path"`
Usage string `json:"usage"`
Status string `json:"status"`
}
type authorVisualSystem struct {
ColorSystem struct {
Background string `json:"background"`
Ink string `json:"ink"`
Muted string `json:"muted"`
Accent string `json:"accent"`
} `json:"color_system"`
Typography struct {
Title int `json:"title"`
Body int `json:"body"`
} `json:"typography"`
LayoutLanguage string `json:"layout_language"`
}
type authorTheme struct {
Background string
Ink string
Muted string
Accent string
TitleSize int
BodySize int
}
type authorSlideTarget struct {
Slide authorDeckSlide
Content authorSlideContent
Assets []authorAsset
Path string
Target string
Page int
}
func AuthorSlides(root string) (AuthorReport, error) {
return authorSlides(root, nil)
}
func authorSlides(root string, selectedPaths map[string]bool) (AuthorReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return AuthorReport{}, err
}
deck, err := readAuthorDeck(safeRoot, strings.TrimSpace(run.Artifacts.Deck))
if err != nil {
return AuthorReport{}, err
}
contentByID, err := readAuthorContent(safeRoot, "content/slide_content.json")
if err != nil {
return AuthorReport{}, err
}
theme, err := readAuthorTheme(safeRoot, "brief/visual_system.json")
if err != nil {
return AuthorReport{}, err
}
assetsBySlideID, err := readAuthorAssets(safeRoot, "assets/assets_plan.json")
if err != nil {
return AuthorReport{}, err
}
if err := validateAuthorDeckContent(deck, contentByID); err != nil {
return AuthorReport{}, err
}
targets := make([]authorSlideTarget, 0, len(deck.Slides))
report := AuthorReport{
Status: StatusDone,
Slides: make([]string, 0, len(deck.Slides)),
}
for i, slide := range deck.Slides {
slidePath, err := previewSlideObjectPath(slide.Path)
if err != nil {
return AuthorReport{}, err
}
if selectedPaths != nil && !selectedPaths[slidePath] {
continue
}
target, err := ensureRunFileTargetForWrite(safeRoot, slidePath)
if err != nil {
return AuthorReport{}, err
}
targets = append(targets, authorSlideTarget{
Slide: slide,
Content: contentByID[strings.TrimSpace(slide.ID)],
Assets: selectAuthorRenderableImageAssets(safeRoot, contentByID[strings.TrimSpace(slide.ID)], assetsBySlideID[strings.TrimSpace(slide.ID)]),
Path: slidePath,
Target: target,
Page: i + 1,
})
report.Slides = append(report.Slides, slidePath)
}
receiptTarget, err := ensureRunFileTargetForWrite(safeRoot, svgAuthorReceipt)
if err != nil {
return AuthorReport{}, err
}
for _, target := range targets {
svg := renderAuthorSVG(deck.Title, target.Slide, target.Content, target.Assets, theme, target.Page, len(deck.Slides))
if err := writeText(target.Target, svg); err != nil {
return AuthorReport{}, err
}
}
if err := writeJSON(receiptTarget, StageReceipt{
Stage: StageSVGAuthor,
Status: StatusDone,
Artifacts: report.Slides,
}); err != nil {
return AuthorReport{}, err
}
return report, nil
}
func readAuthorDeck(safeRoot string, deckPath string) (authorDeck, error) {
if deckPath == "" {
return authorDeck{}, fmt.Errorf("deck artifact path is empty")
}
raw, err := readRunRegularArtifact(safeRoot, deckPath)
if err != nil {
return authorDeck{}, fmt.Errorf("read deck %q: %w", deckPath, err)
}
var deck authorDeck
if err := json.Unmarshal(raw, &deck); err != nil {
return authorDeck{}, fmt.Errorf("read deck %q: %w", deckPath, err)
}
if len(deck.Slides) == 0 {
return authorDeck{}, fmt.Errorf("deck %q contains no slides", deckPath)
}
return deck, nil
}
func readAuthorContent(safeRoot string, path string) (map[string]authorSlideContent, error) {
raw, err := readRunRegularArtifact(safeRoot, path)
if err != nil {
return nil, fmt.Errorf("read slide content %q: %w", path, err)
}
var file authorSlideContentFile
if err := json.Unmarshal(raw, &file); err != nil {
return nil, fmt.Errorf("read slide content %q: %w", path, err)
}
byID := make(map[string]authorSlideContent, len(file.Slides))
for _, slide := range file.Slides {
id := strings.TrimSpace(slide.ID)
if id == "" {
return nil, fmt.Errorf("slide content id must not be empty")
}
if _, exists := byID[id]; exists {
return nil, fmt.Errorf("slide content id %q is duplicated", id)
}
byID[id] = slide
}
return byID, nil
}
func readAuthorAssets(safeRoot string, path string) (map[string][]authorAsset, error) {
raw, err := readRunRegularArtifact(safeRoot, path)
if err != nil {
return nil, fmt.Errorf("read assets plan %q: %w", path, err)
}
var file authorAssetsFile
if err := json.Unmarshal(raw, &file); err != nil {
return nil, fmt.Errorf("read assets plan %q: %w", path, err)
}
bySlideID := make(map[string][]authorAsset, len(file.Assets))
for _, asset := range file.Assets {
if strings.TrimSpace(asset.Status) != "ready" {
continue
}
slideID := strings.TrimSpace(asset.SlideID)
bySlideID[slideID] = append(bySlideID[slideID], asset)
}
return bySlideID, nil
}
func selectAuthorRenderableImageAssets(safeRoot string, content authorSlideContent, assets []authorAsset) []authorAsset {
if len(content.Visuals) == 0 || len(assets) == 0 {
return nil
}
assetByID := make(map[string]authorAsset, len(assets))
for _, asset := range assets {
if strings.TrimSpace(asset.Type) != "image" {
continue
}
id := strings.TrimSpace(asset.ID)
if id == "" {
continue
}
assetByID[id] = asset
}
for _, visual := range content.Visuals {
if strings.TrimSpace(visual.Type) != "image" {
continue
}
id := strings.TrimSpace(visual.ID)
if id == "" {
continue
}
asset, ok := assetByID[id]
if !ok {
continue
}
if !authorImageAssetUsable(safeRoot, asset) {
continue
}
return []authorAsset{asset}
}
return nil
}
func authorImageAssetUsable(_ string, asset authorAsset) bool {
if strings.TrimSpace(asset.Type) != "image" {
return false
}
path := strings.TrimSpace(asset.Path)
return path != ""
}
func validateAuthorDeckContent(deck authorDeck, contentByID map[string]authorSlideContent) error {
deckIDs := make(map[string]bool, len(deck.Slides))
for _, slide := range deck.Slides {
id := strings.TrimSpace(slide.ID)
if id == "" {
return fmt.Errorf("deck slide id must not be empty")
}
if deckIDs[id] {
return fmt.Errorf("deck slide id %q is duplicated", id)
}
deckIDs[id] = true
if _, ok := contentByID[id]; !ok {
return fmt.Errorf("deck slide id %q is missing from slide content", id)
}
}
return nil
}
func readAuthorTheme(safeRoot string, path string) (authorTheme, error) {
raw, err := readRunRegularArtifact(safeRoot, path)
if err != nil {
return authorTheme{}, fmt.Errorf("read visual system %q: %w", path, err)
}
var visual authorVisualSystem
if err := json.Unmarshal(raw, &visual); err != nil {
return authorTheme{}, fmt.Errorf("read visual system %q: %w", path, err)
}
theme := authorTheme{
Background: normalizeAuthorColor(visual.ColorSystem.Background, defaultAuthorBgColor),
Ink: normalizeAuthorColor(visual.ColorSystem.Ink, defaultAuthorInkColor),
Muted: normalizeAuthorColor(visual.ColorSystem.Muted, defaultAuthorMuteColor),
Accent: normalizeAuthorColor(visual.ColorSystem.Accent, defaultAuthorAccent),
TitleSize: visual.Typography.Title,
BodySize: visual.Typography.Body,
}
if theme.TitleSize <= 0 {
theme.TitleSize = 32
}
if theme.BodySize <= 0 {
theme.BodySize = 16
}
return theme, nil
}
func normalizeAuthorColor(value string, fallback string) string {
value = strings.TrimSpace(value)
if isAllowedAuthorHexColor(value) {
return value
}
return fallback
}
func isAllowedAuthorHexColor(value string) bool {
if len(value) != 4 && len(value) != 7 && len(value) != 9 {
return false
}
if value[0] != '#' {
return false
}
for _, r := range value[1:] {
if (r >= '0' && r <= '9') || (r >= 'a' && r <= 'f') || (r >= 'A' && r <= 'F') {
continue
}
return false
}
return true
}
func renderAuthorSVG(deckTitle string, slide authorDeckSlide, content authorSlideContent, assets []authorAsset, theme authorTheme, page int, total int) string {
title := firstNonEmpty(slide.Title, "Untitled slide")
keyMessage := firstNonEmpty(slide.KeyMessage, slide.Summary)
bodyLines := authorBodyLines(content.Content)
footer := strings.TrimSpace(deckTitle)
if footer == "" {
footer = "SVGlide"
}
footnote := authorSourceFootnote(content.SourceRefs)
heroAsset := firstReadyAuthorImageAsset(assets)
contentWidth := 848
contentHeight := 404
if heroAsset != nil {
contentWidth = 500
}
var b strings.Builder
fmt.Fprintf(&b, `<svg xmlns="%s" xmlns:slide="%s" width="%d" height="%d" viewBox="0 0 960 540" slide:role="slide">`+"\n", svgNamespace, slideNamespace, defaultSlideWidth, defaultSlideHeight)
fmt.Fprintf(&b, ` <rect x="0" y="0" width="960" height="540" fill="%s" data-role="background"/>`+"\n", escapeAttr(theme.Background))
fmt.Fprintf(&b, ` <rect x="0" y="0" width="960" height="8" fill="%s"/>`+"\n", escapeAttr(theme.Accent))
fmt.Fprintf(&b, ` <foreignObject x="56" y="48" width="%d" height="%d" slide:role="shape" slide:shape-type="text">`+"\n", contentWidth, contentHeight)
fmt.Fprintf(&b, ` <div xmlns="http://www.w3.org/1999/xhtml" style="font-family:Arial, Helvetica, sans-serif;color:%s;">`+"\n", escapeAttr(theme.Ink))
fmt.Fprintf(&b, ` <div style="font-size:%dpx;font-weight:700;line-height:1.16;margin-bottom:16px;">%s</div>`+"\n", theme.TitleSize, escapeText(title))
if keyMessage != "" {
fmt.Fprintf(&b, ` <div style="font-size:%dpx;line-height:1.35;color:%s;margin-bottom:22px;">%s</div>`+"\n", maxInt(theme.BodySize+4, 18), escapeAttr(theme.Accent), escapeText(keyMessage))
}
fmt.Fprintf(&b, ` <div style="border:1px solid #E5E7EB;border-radius:6px;padding:20px 24px;min-height:190px;background:#F9FAFB;">`+"\n")
for _, line := range bodyLines {
fmt.Fprintf(&b, ` <div style="font-size:%dpx;line-height:1.55;margin-bottom:8px;">- %s</div>`+"\n", theme.BodySize, escapeText(line))
}
fmt.Fprintf(&b, " </div>\n")
fmt.Fprintf(&b, " </div>\n")
fmt.Fprintf(&b, " </foreignObject>\n")
if footnote != "" {
fmt.Fprintf(&b, ` <foreignObject x="56" y="456" width="520" height="18" slide:role="shape" slide:shape-type="text">`+"\n")
fmt.Fprintf(&b, ` <div xmlns="http://www.w3.org/1999/xhtml" style="font-family:Arial, Helvetica, sans-serif;color:%s;font-size:12px;line-height:1.2;">%s</div>`+"\n", escapeAttr(theme.Muted), escapeText(footnote))
fmt.Fprintf(&b, " </foreignObject>\n")
}
if heroAsset != nil {
fmt.Fprintf(&b, ` <image slide:role="image" slide:shape-type="image" href="%s" x="600" y="160" width="304" height="190"/>`+"\n", escapeAttr(heroAsset.Path))
}
fmt.Fprintf(&b, ` <foreignObject x="56" y="482" width="848" height="32" slide:role="shape" slide:shape-type="text">`+"\n")
fmt.Fprintf(&b, ` <div xmlns="http://www.w3.org/1999/xhtml" style="font-family:Arial, Helvetica, sans-serif;color:%s;font-size:12px;display:flex;justify-content:space-between;">`+"\n", escapeAttr(theme.Muted))
fmt.Fprintf(&b, " <span>%s</span><span>%d / %d</span>\n", escapeText(footer), page, total)
fmt.Fprintf(&b, " </div>\n")
fmt.Fprintf(&b, " </foreignObject>\n")
fmt.Fprintf(&b, "</svg>\n")
return b.String()
}
func authorBodyLines(content string) []string {
var lines []string
for _, line := range strings.Split(content, "\n") {
line = strings.TrimSpace(line)
if line != "" {
lines = append(lines, line)
}
}
if len(lines) == 0 {
return []string{"No content provided."}
}
return lines
}
func authorSourceFootnote(sourceRefs []string) string {
if len(sourceRefs) == 0 {
return ""
}
refs := make([]string, 0, len(sourceRefs))
for _, ref := range sourceRefs {
if trimmed := strings.TrimSpace(ref); trimmed != "" {
refs = append(refs, trimmed)
}
}
if len(refs) == 0 {
return ""
}
return "来源:" + strings.Join(refs, " / ")
}
func firstReadyAuthorImageAsset(assets []authorAsset) *authorAsset {
for i := range assets {
asset := &assets[i]
if strings.TrimSpace(asset.Type) != "image" {
continue
}
if strings.TrimSpace(asset.Path) == "" {
continue
}
return asset
}
return nil
}
func firstNonEmpty(values ...string) string {
for _, value := range values {
if trimmed := strings.TrimSpace(value); trimmed != "" {
return trimmed
}
}
return ""
}
func escapeText(value string) string {
return html.EscapeString(value)
}
func escapeAttr(value string) string {
return html.EscapeString(value)
}
func maxInt(a int, b int) int {
if a > b {
return a
}
return b
}

View File

@@ -0,0 +1,458 @@
package svglide
import (
"encoding/json"
"errors"
"os"
"path/filepath"
"strings"
"testing"
)
func TestAuthorSlidesWritesVisibleSVGForEachDeckSlide(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", `{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"},{"id":"s2","title":"Second claim","summary":"Second summary","role":"content","key_message":"Second key message","path":"slides/02.svg"}]}`)
writeAuthorInputsWithAnyGenContracts(t, `{"assets":[]}`)
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
report, err := AuthorSlides("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != StatusDone {
t.Fatalf("Status = %q, want %q", report.Status, StatusDone)
}
if len(report.Slides) != 2 {
t.Fatalf("Slides len = %d, want 2: %+v", len(report.Slides), report.Slides)
}
receipt := readAuthorReceiptForTest(t)
if receipt["stage"] != StageSVGAuthor {
t.Fatalf("receipt stage = %v, want %q", receipt["stage"], StageSVGAuthor)
}
if receipt["status"] != StatusDone {
t.Fatalf("receipt status = %v, want %q", receipt["status"], StatusDone)
}
if _, ok := receipt["artifacts"].([]any); !ok {
t.Fatalf("receipt artifacts = %T, want array", receipt["artifacts"])
}
if _, ok := receipt["generated_at"]; ok {
t.Fatalf("receipt contains generated_at, want StageReceipt-compatible schema: %+v", receipt)
}
for _, rel := range []string{"slides/01.svg", "slides/02.svg"} {
raw, err := os.ReadFile(filepath.Join("demo", rel))
if err != nil {
t.Fatalf("missing %s: %v", rel, err)
}
svg := string(raw)
for _, want := range []string{
`slide:role="slide"`,
`viewBox="0 0 960 540"`,
`foreignObject`,
`slide:role="shape"`,
`slide:shape-type="text"`,
} {
if !strings.Contains(svg, want) {
t.Fatalf("%s missing %q:\n%s", rel, want, svg)
}
}
}
validation, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !validation.OK {
t.Fatalf("ValidateRun OK = false, issues: %+v", validation.Issues)
}
}
func TestAuthorSlidesFallsBackForUnsafeColorTokens(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"url(https://example.com/bg.svg)","ink":"red;background:url(https://example.com/x)","muted":"not-a-color","accent":"#abc"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
svg := string(raw)
for _, banned := range []string{"url(", "https://example.com", "red;background", "not-a-color"} {
if strings.Contains(svg, banned) {
t.Fatalf("SVG contains unsafe color token %q:\n%s", banned, svg)
}
}
for _, want := range []string{`fill="#FFFFFF"`, `color:#111827`, `color:#6B7280`, `fill="#abc"`, `color:#abc`} {
if !strings.Contains(svg, want) {
t.Fatalf("SVG missing normalized/default color %q:\n%s", want, svg)
}
}
}
func TestAuthorSlidesPreflightsSlidePathsBeforeWriting(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"},{"id":"s2","title":"Second claim","summary":"Second summary","role":"content","key_message":"Second key message","path":"slides/../02.svg"}]}`,
)
if _, err := AuthorSlides("demo"); err == nil {
t.Fatal("expected invalid second slide path to fail")
}
if _, err := os.Stat(filepath.Join("demo", "slides", "01.svg")); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("first slide output exists after preflight failure, stat err = %v", err)
}
}
func TestAuthorSlidesRejectsMissingContentBeforeWriting(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"},{"id":"s2","title":"Second claim","summary":"Second summary","role":"content","key_message":"Second key message","path":"slides/02.svg"}]}`,
)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line"}]}`)
if _, err := AuthorSlides("demo"); err == nil {
t.Fatal("expected missing slide content to fail")
}
for _, rel := range []string{"slides/01.svg", "receipts/svg_author.json"} {
if _, err := os.Stat(filepath.Join("demo", rel)); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("%s exists after content preflight failure, stat err = %v", rel, err)
}
}
}
func TestAuthorSlidesRejectsDuplicateContentID(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":[],"visuals":[{"id":"none-s1","type":"none","instruction":"Text-only"}]},{"id":"s1","content":"Duplicate body line","source_refs":[],"visuals":[{"id":"none-s1b","type":"none","instruction":"Text-only"}]}]}`)
if _, err := AuthorSlides("demo"); err == nil {
t.Fatal("expected duplicate slide content id to fail")
}
if _, err := os.Stat(filepath.Join("demo", "receipts", "svg_author.json")); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("svg_author receipt exists after duplicate content id failure, stat err = %v", err)
}
}
func TestAuthorSlidesDoesNotRenderImageForNoneVisualDespiteReadyAsset(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":["web1"],"visuals":[{"id":"none-s1","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(raw), `<image slide:role="image"`) {
t.Fatalf("visual type none should not render image:\n%s", string(raw))
}
}
func TestAuthorSlidesDoesNotRenderImageForMismatchedVisualID(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the prepared hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"other","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(raw), `<image slide:role="image"`) {
t.Fatalf("mismatched visual id should not render image:\n%s", string(raw))
}
}
func TestAuthorSlidesRendersExperimentRemoteImageAsset(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", `{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"Hero slide","summary":"Hero summary","role":"cover","key_message":"Hero key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/demo","title":"Demo source","excerpt":"Demo excerpt","usage":"support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the remote hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"mode":"experiment_unrestricted_assets","assets":[{"id":"hero","slide_id":"s1","type":"image","path":"https://example.com/hero.png","usage":"Hero image","status":"ready"}]}`)
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
svg := string(raw)
for _, want := range []string{
`<image slide:role="image"`,
`href="https://example.com/hero.png"`,
} {
if !strings.Contains(svg, want) {
t.Fatalf("experiment remote image missing %q:\n%s", want, svg)
}
}
}
func TestAuthorSlidesSkipsUnsupportedReadyImageAssets(t *testing.T) {
tests := []struct {
name string
asset string
}{
{
name: "diagram",
asset: `{"assets":[{"id":"hero","slide_id":"s1","type":"diagram","path":"assets/images/hero.png","usage":"Hero diagram","status":"ready"}]}`,
},
{
name: "missing",
asset: `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"missing"}]}`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the prepared hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", tt.asset)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(raw), `<image slide:role="image"`) {
t.Fatalf("unsupported asset should not render image:\n%s", string(raw))
}
})
}
}
func TestAuthorSlidesRendersExistingAbsoluteImageAssetInExperiment(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
outside := filepath.Join(t.TempDir(), "hero.png")
if err := os.WriteFile(outside, []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the prepared hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"`+outside+`","usage":"Hero image","status":"ready"}]}`)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(raw), outside) || !strings.Contains(string(raw), `<image slide:role="image"`) {
t.Fatalf("absolute asset should render image in experiment mode:\n%s", string(raw))
}
}
func initAuthorDemoRun(t *testing.T, visualSystem string, deck string) {
t.Helper()
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", visualSystem)
mustWriteTestFile(t, "demo/outline/deck.json", deck)
writeAuthorInputsWithAnyGenContracts(t, `{"assets":[]}`)
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
}
func TestAuthorSlidesRendersSourceFootnotes(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", `{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/demo","title":"Demo source","excerpt":"Demo excerpt","usage":"support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line","notes":"Speaker note","source_refs":["web1"],"visuals":[{"id":"none-s1","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
svg := string(raw)
for _, want := range []string{
`来源`,
`web1`,
`slide:role="shape"`,
} {
if !strings.Contains(svg, want) {
t.Fatalf("source footnote missing %q:\n%s", want, svg)
}
}
}
func TestAuthorSlidesRendersPreparedImageAsset(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", `{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"Hero slide","summary":"Hero summary","role":"cover","key_message":"Hero key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/demo","title":"Demo source","excerpt":"Demo excerpt","usage":"support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line\nSecond body line\nThird body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the prepared hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
svg := string(raw)
for _, want := range []string{
`<image slide:role="image"`,
`slide:shape-type="image"`,
`href="assets/images/hero.png"`,
} {
if !strings.Contains(svg, want) {
t.Fatalf("prepared image asset missing %q:\n%s", want, svg)
}
}
validation, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !validation.OK {
t.Fatalf("ValidateRun OK = false, issues: %+v", validation.Issues)
}
}
func TestAuthorSlidesRendersImageFootnoteAndMultilineBodyWithValidation(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/brief/design_brief.json", `{"narrative_spine":"A to B","depth":"medium","tone":"clear"}`)
mustWriteTestFile(t, "demo/brief/visual_system.json", `{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"Hero slide","summary":"Hero summary","role":"cover","key_message":"Hero key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/demo","title":"Demo source","excerpt":"Demo excerpt","usage":"support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line\nSecond body line\nThird body line","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use the prepared hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
writeStatusTestRunFile(t, run)
if _, err := AuthorSlides("demo"); err != nil {
t.Fatal(err)
}
validation, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !validation.OK {
t.Fatalf("ValidateRun OK = false, issues: %+v", validation.Issues)
}
}
func writeAuthorInputsWithAnyGenContracts(t *testing.T, assets string) {
t.Helper()
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/demo","title":"Demo source","excerpt":"Demo excerpt","usage":"support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line\nSecond body line","notes":"Speaker note","source_refs":["web1"],"visuals":[{"id":"none-s1","type":"none","instruction":"Text-only"}]},{"id":"s2","content":"Point A\nPoint B\nPoint C","source_refs":["web1"],"visuals":[{"id":"none-s2","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", assets)
}
func readAuthorReceiptForTest(t *testing.T) map[string]any {
t.Helper()
raw, err := os.ReadFile(filepath.Join("demo", "receipts", "svg_author.json"))
if err != nil {
t.Fatal(err)
}
var receipt map[string]any
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatal(err)
}
return receipt
}
func mustWriteTestFile(t *testing.T, path string, content string) {
t.Helper()
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
t.Fatal(err)
}
}

194
internal/svglide/init.go Normal file
View File

@@ -0,0 +1,194 @@
package svglide
import (
"bytes"
"fmt"
"path/filepath"
"strings"
"time"
"github.com/larksuite/cli/internal/validate"
"github.com/larksuite/cli/internal/vfs"
)
type InitOptions struct {
Title string
Input string
Audience string
DeliveryMode string
Pages int
Now time.Time
Overwrite bool
}
func InitRun(root string, opts InitOptions) error {
root = strings.TrimSpace(root)
opts.Title = strings.TrimSpace(opts.Title)
opts.Input = strings.TrimSpace(opts.Input)
if root == "" {
return fmt.Errorf("out path is required")
}
if opts.Title == "" {
return fmt.Errorf("title is required")
}
if opts.Input == "" {
return fmt.Errorf("input is required")
}
safeRoot, err := validate.SafeOutputPath(root)
if err != nil {
return err
}
if err := validateRunRoot(root, safeRoot); err != nil {
return err
}
safeInput, err := validate.SafeInputPath(opts.Input)
if err != nil {
return err
}
if err := validateInputOutsideRunRoot(safeRoot, safeInput); err != nil {
return err
}
opts.Input = safeInput
if opts.Overwrite {
return initOverwrite(safeRoot, opts)
}
return initNoReplace(safeRoot, opts)
}
func validateRunRoot(root string, safeRoot string) error {
if filepath.Clean(root) == "." {
return fmt.Errorf("out path must be a child directory, got %q", root)
}
cwd, err := vfs.Getwd()
if err != nil {
return fmt.Errorf("cannot determine working directory: %w", err)
}
canonicalCwd, err := vfs.EvalSymlinks(cwd)
if err != nil {
return fmt.Errorf("cannot resolve working directory: %w", err)
}
if filepath.Clean(safeRoot) == filepath.Clean(canonicalCwd) {
return fmt.Errorf("out path must be a child directory, got %q", root)
}
return nil
}
func validateInputOutsideRunRoot(safeRoot string, safeInput string) error {
root := filepath.Clean(safeRoot)
input := filepath.Clean(safeInput)
rel, err := filepath.Rel(root, input)
if err != nil {
return fmt.Errorf("cannot compare input and output paths: %w", err)
}
if rel == "." || (rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))) {
return fmt.Errorf("input path %q must be outside output run directory %q", safeInput, safeRoot)
}
return nil
}
func initNoReplace(safeRoot string, opts InitOptions) error {
if err := vfs.MkdirAll(filepath.Dir(safeRoot), 0o755); err != nil {
return err
}
if err := vfs.Mkdir(safeRoot, 0o755); err != nil {
return fmt.Errorf("%s already exists or cannot be created; refusing to overwrite: %w", safeRoot, err)
}
return writeClaimedRunDirectory(safeRoot, opts)
}
func initOverwrite(safeRoot string, opts InitOptions) error {
if err := vfs.RemoveAll(safeRoot); err != nil {
return err
}
if err := vfs.MkdirAll(filepath.Dir(safeRoot), 0o755); err != nil {
return err
}
if err := vfs.Mkdir(safeRoot, 0o755); err != nil {
return err
}
return writeClaimedRunDirectory(safeRoot, opts)
}
func writeClaimedRunDirectory(safeRoot string, opts InitOptions) error {
cleanup := true
defer func() {
if cleanup {
_ = vfs.RemoveAll(safeRoot)
}
}()
if err := writeRunDirectory(safeRoot, safeRoot, opts); err != nil {
return err
}
cleanup = false
return nil
}
func writeRunDirectory(writeRoot string, runRoot string, opts InitOptions) error {
for _, dir := range []string{
"request",
"research",
"brief",
"outline",
"content",
"assets/images",
"slides",
"schemas",
"receipts",
} {
if err := vfs.MkdirAll(filepath.Join(writeRoot, dir), 0o755); err != nil {
return err
}
}
run := NewRun(NewRunConfig{
Title: opts.Title,
Input: opts.Input,
Audience: opts.Audience,
DeliveryMode: opts.DeliveryMode,
Pages: opts.Pages,
Out: runRoot,
Now: opts.Now,
})
run.Policy.Overwrite = opts.Overwrite
if err := writeJSON(filepath.Join(writeRoot, "run.json"), run); err != nil {
return err
}
if err := writeJSON(filepath.Join(writeRoot, "request", "request.json"), map[string]any{
"title": opts.Title,
"input": opts.Input,
"audience": opts.Audience,
"delivery_mode": opts.DeliveryMode,
"pages": opts.Pages,
}); err != nil {
return err
}
if err := writeJSON(filepath.Join(writeRoot, "request", "source_manifest.json"), map[string]any{
"sources": []map[string]string{{"path": opts.Input, "type": "local"}},
}); err != nil {
return err
}
return writeStaticFiles(writeRoot)
}
func writeStaticFiles(root string) error {
if err := writeText(filepath.Join(root, "README.md"), renderRunREADME()); err != nil {
return err
}
if err := writePromptManifest(root); err != nil {
return err
}
for name, schema := range DefaultSchemas() {
if err := writeText(filepath.Join(root, "schemas", name), schema); err != nil {
return err
}
}
return nil
}
func renderRunREADME() string {
var b bytes.Buffer
b.WriteString("# SVGlide Local Run\n\n")
b.WriteString("This directory is a local Codex-mediated SVG slides runtime. It does not publish to Feishu Slides.\n")
return b.String()
}

View File

@@ -0,0 +1,380 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"time"
)
func TestInitRunWritesDirectoryContract(t *testing.T) {
cwd := t.TempDir()
t.Chdir(cwd)
canonicalCwd, err := filepath.EvalSymlinks(cwd)
if err != nil {
t.Fatal(err)
}
root := "demo"
wantInput := filepath.Join(canonicalCwd, "source.md")
err = InitRun(root, InitOptions{
Title: "Demo",
Input: "source.md",
Audience: "产品负责人",
DeliveryMode: "self_read",
Pages: 8,
Now: time.Date(2026, 7, 2, 20, 0, 0, 0, time.FixedZone("CST", 8*3600)),
})
if err != nil {
t.Fatal(err)
}
for _, name := range []string{
"run.json",
"README.md",
"prompt_manifest.json",
"request/request.json",
"request/source_manifest.json",
"research",
"brief",
"outline",
"content",
"schemas/request.schema.json",
"schemas/deck.schema.json",
"receipts",
"slides",
"assets/images",
} {
if _, err := os.Stat(filepath.Join(root, name)); err != nil {
t.Fatalf("missing %s: %v", name, err)
}
}
raw, err := os.ReadFile(filepath.Join(root, "run.json"))
if err != nil {
t.Fatal(err)
}
var run Run
if err := json.Unmarshal(raw, &run); err != nil {
t.Fatal(err)
}
if run.Title != "Demo" || run.CurrentStage != StageRequest {
t.Fatalf("unexpected run: %+v", run)
}
if run.Input != wantInput {
t.Fatalf("run.Input = %q, want %q", run.Input, wantInput)
}
requestRaw, err := os.ReadFile(filepath.Join(root, "request", "request.json"))
if err != nil {
t.Fatal(err)
}
var request map[string]any
if err := json.Unmarshal(requestRaw, &request); err != nil {
t.Fatal(err)
}
if request["title"] != "Demo" || request["input"] != wantInput || request["audience"] != "产品负责人" || request["delivery_mode"] != "self_read" || request["pages"] != float64(8) {
t.Fatalf("unexpected request.json: %+v", request)
}
manifestRaw, err := os.ReadFile(filepath.Join(root, "request", "source_manifest.json"))
if err != nil {
t.Fatal(err)
}
var manifest struct {
Sources []struct {
Path string `json:"path"`
Type string `json:"type"`
} `json:"sources"`
}
if err := json.Unmarshal(manifestRaw, &manifest); err != nil {
t.Fatal(err)
}
if len(manifest.Sources) != 1 || manifest.Sources[0].Path != wantInput || manifest.Sources[0].Type != "local" {
t.Fatalf("unexpected source_manifest.json: %+v", manifest)
}
if _, err := os.Stat(filepath.Join(root, "prompts")); !os.IsNotExist(err) {
t.Fatalf("prompts directory should not be generated per run, stat err = %v", err)
}
promptRaw, err := os.ReadFile(filepath.Join(root, "prompt_manifest.json"))
if err != nil {
t.Fatal(err)
}
prompt := string(promptRaw)
for _, want := range []string{"mode_system_prompt_svg", "svg_reference", "tools/slides_edit.md", "tools/generate_svg_chart.md"} {
if !strings.Contains(prompt, want) {
t.Fatalf("prompt manifest missing %q:\n%s", want, prompt)
}
}
schemaRaw, err := os.ReadFile(filepath.Join(root, "schemas", "deck.schema.json"))
if err != nil {
t.Fatal(err)
}
var deckSchema map[string]any
if err := json.Unmarshal(schemaRaw, &deckSchema); err != nil {
t.Fatal(err)
}
if _, ok := deckSchema["properties"]; !ok || !strings.Contains(string(schemaRaw), "key_message") {
t.Fatalf("deck schema missing properties/key_message: %s", string(schemaRaw))
}
if !strings.Contains(string(schemaRaw), `"minItems": 1`) || !strings.Contains(string(schemaRaw), `^slides/[^/]+\\.svg$`) {
t.Fatalf("deck schema missing minItems/path pattern: %s", string(schemaRaw))
}
for _, name := range []string{
"source_manifest.schema.json",
"sources.schema.json",
"slide_content.schema.json",
"assets_plan.schema.json",
"quality.schema.json",
"receipt.schema.json",
"lint.schema.json",
"preview.schema.json",
} {
raw, err := os.ReadFile(filepath.Join(root, "schemas", name))
if err != nil {
t.Fatalf("missing schema %s: %v", name, err)
}
var schema map[string]any
if err := json.Unmarshal(raw, &schema); err != nil {
t.Fatalf("schema %s is not valid JSON: %v", name, err)
}
if schema["type"] == nil {
t.Fatalf("schema %s missing type: %s", name, string(raw))
}
}
for _, tc := range []struct {
name string
want []string
}{
{name: "request.schema.json", want: []string{`"purpose"`, `"language"`, `"visual_style_query"`}},
{name: "design_brief.schema.json", want: []string{`"visual_system"`, `"narrative_spine"`, `"depth"`, `"tone"`}},
{name: "deck.schema.json", want: []string{`"main_title"`, `"style_instruction"`, `"aesthetic_direction"`}},
{name: "sources.schema.json", want: []string{`"retrieval"`}},
{name: "slide_content.schema.json", want: []string{`"source_refs"`, `"visuals"`, `"chart"`, `"table"`, `"crop"`}},
{name: "assets_plan.schema.json", want: []string{`"experiment_unrestricted_assets"`, `"slide_id"`, `"status"`, `"deferred"`, `"chart"`, `"table"`, `"crop"`}},
{name: "quality.schema.json", want: []string{`"metrics"`}},
} {
raw, err := os.ReadFile(filepath.Join(root, "schemas", tc.name))
if err != nil {
t.Fatalf("missing schema %s: %v", tc.name, err)
}
text := string(raw)
for _, want := range tc.want {
if !strings.Contains(text, want) {
t.Fatalf("schema %s missing %s: %s", tc.name, want, text)
}
}
}
}
func TestInitRunRefusesExistingRunJSON(t *testing.T) {
t.Chdir(t.TempDir())
root := "demo"
if err := os.MkdirAll(root, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(root, "run.json"), []byte("{}"), 0o644); err != nil {
t.Fatal(err)
}
err := InitRun(root, InitOptions{Title: "Demo", Input: "source.md"})
if err == nil {
t.Fatal("expected overwrite refusal")
}
}
func TestInitRunRefusesExistingRootWithoutRunJSON(t *testing.T) {
t.Chdir(t.TempDir())
root := "demo"
if err := os.MkdirAll(root, 0o755); err != nil {
t.Fatal(err)
}
wantREADME := "keep this readme\n"
if err := os.WriteFile(filepath.Join(root, "README.md"), []byte(wantREADME), 0o644); err != nil {
t.Fatal(err)
}
err := InitRun(root, InitOptions{Title: "Demo", Input: "source.md"})
gotREADME, readErr := os.ReadFile(filepath.Join(root, "README.md"))
if readErr != nil {
t.Fatal(readErr)
}
if string(gotREADME) != wantREADME {
t.Fatalf("README overwritten: got %q, want %q", string(gotREADME), wantREADME)
}
if err == nil {
t.Fatal("expected existing root refusal")
}
}
func TestInitRunOverwriteReplacesOldRunDirectory(t *testing.T) {
t.Chdir(t.TempDir())
root := "demo"
if err := os.MkdirAll(filepath.Join(root, "slides"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(root, "slides", "old.svg"), []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
err := InitRun(root, InitOptions{Title: "Demo", Input: "source.md", Overwrite: true})
if err != nil {
t.Fatal(err)
}
if _, err := os.Stat(filepath.Join(root, "slides", "old.svg")); !os.IsNotExist(err) {
t.Fatalf("old slide should be removed, stat err = %v", err)
}
raw, err := os.ReadFile(filepath.Join(root, "run.json"))
if err != nil {
t.Fatal(err)
}
var run Run
if err := json.Unmarshal(raw, &run); err != nil {
t.Fatal(err)
}
if !run.Policy.Overwrite {
t.Fatalf("Policy.Overwrite = false, want true: %+v", run.Policy)
}
}
func TestInitRunRejectsOverlappingInputAndOutput(t *testing.T) {
tests := []struct {
name string
root string
input string
overwrite bool
}{
{name: "same path overwrite", root: "source.md", input: "source.md", overwrite: true},
{name: "input under output overwrite", root: "demo", input: "demo/source.md", overwrite: true},
{name: "input under output no overwrite", root: "demo", input: "demo/source.md", overwrite: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Chdir(t.TempDir())
if err := os.MkdirAll(filepath.Dir(tt.input), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(tt.input, []byte("source"), 0o644); err != nil {
t.Fatal(err)
}
err := InitRun(tt.root, InitOptions{Title: "Demo", Input: tt.input, Overwrite: tt.overwrite})
if err == nil {
t.Fatal("expected overlapping input/output refusal")
}
got, readErr := os.ReadFile(tt.input)
if readErr != nil {
t.Fatalf("source should remain readable: %v", readErr)
}
if string(got) != "source" {
t.Fatalf("source content changed: got %q", string(got))
}
})
}
}
func TestInitRunRejectsUnsafePaths(t *testing.T) {
cwd := t.TempDir()
t.Chdir(cwd)
tests := []struct {
name string
root string
opts InitOptions
}{
{name: "absolute root", root: filepath.Join(cwd, "demo"), opts: InitOptions{Title: "Demo", Input: "source.md"}},
{name: "escaping root", root: "../escape", opts: InitOptions{Title: "Demo", Input: "source.md"}},
{name: "escaping input", root: "demo", opts: InitOptions{Title: "Demo", Input: "../source.md"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := InitRun(tt.root, tt.opts); err == nil {
t.Fatal("expected unsafe path refusal")
}
})
}
}
func TestInitRunRejectsRootResolvingToCWDWhenOverwrite(t *testing.T) {
for _, root := range []string{".", "./", "subdir/.."} {
t.Run(root, func(t *testing.T) {
cwd := t.TempDir()
t.Chdir(cwd)
markerPath := filepath.Join(cwd, "keep.txt")
if err := os.WriteFile(markerPath, []byte("keep"), 0o644); err != nil {
t.Fatal(err)
}
err := InitRun(root, InitOptions{Title: "Demo", Input: "source.md", Overwrite: true})
if err == nil {
t.Fatal("expected root resolving to CWD to be rejected")
}
got, readErr := os.ReadFile(markerPath)
if readErr != nil {
t.Fatalf("marker should remain readable: %v", readErr)
}
if string(got) != "keep" {
t.Fatalf("marker content changed: got %q", string(got))
}
})
}
}
func TestDefaultPromptManifestContracts(t *testing.T) {
manifest := DefaultPromptManifest()
if manifest.Source != anyGenPromptRoot {
t.Fatalf("Source = %q, want %q", manifest.Source, anyGenPromptRoot)
}
if manifest.Runtime != "codex" {
t.Fatalf("Runtime = %q, want codex", manifest.Runtime)
}
entries := map[string]PromptManifestEntry{}
for _, entry := range manifest.Entries {
entries[entry.Name] = entry
}
for _, want := range []string{"anygen_svg_readme", "mode_system_prompt_svg", "svg_reference", "resolve_design_brief", "slide_outline", "activate_slides_edit", "slides_edit", "finish_slides_edit", "generate_svg_chart", "slides_convert", "slides_parse_template"} {
if entries[want].Path == "" {
t.Fatalf("manifest missing %q: %+v", want, manifest.Entries)
}
}
if entries["anygen_svg_readme"].Path != "skills/lark-slides/references/anygen-svg/README.md" || !entries["anygen_svg_readme"].Always {
t.Fatalf("anygen_svg_readme entry = %+v, want always README path", entries["anygen_svg_readme"])
}
if !entries["mode_system_prompt_svg"].Always || !entries["svg_reference"].Always {
t.Fatalf("core prompt entries must be always available: %+v", manifest.Entries)
}
if entries["activate_slides_edit"].Stage != StageSVGAuthor {
t.Fatalf("activate_slides_edit stage = %q, want %q", entries["activate_slides_edit"].Stage, StageSVGAuthor)
}
if entries["slides_edit"].Stage != StageSVGAuthor {
t.Fatalf("slides_edit stage = %q, want %q", entries["slides_edit"].Stage, StageSVGAuthor)
}
if entries["generate_svg_chart"].Stage != StageAssets {
t.Fatalf("generate_svg_chart stage = %q, want %q", entries["generate_svg_chart"].Stage, StageAssets)
}
paths := strings.Join(PromptPathsForStage(StageSVGAuthor), "\n")
for _, want := range []string{"README.md", "mode_system_prompt_svg.md", "svg_reference.md", "tools/activate_slides_edit.md", "tools/slides_edit.md", "tools/compute_custom_shape_bbox.md"} {
if !strings.Contains(paths, want) {
t.Fatalf("SVG author prompt paths missing %q:\n%s", want, paths)
}
}
}
func TestInitRunRejectsBlankRequiredFields(t *testing.T) {
blankRoot := " "
t.Chdir(t.TempDir())
tests := []struct {
name string
root string
opts InitOptions
}{
{name: "root", root: blankRoot, opts: InitOptions{Title: "Demo", Input: "source.md"}},
{name: "title", root: "title", opts: InitOptions{Title: " \t", Input: "source.md"}},
{name: "input", root: "input", opts: InitOptions{Title: "Demo", Input: " \t"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := InitRun(tt.root, tt.opts); err == nil {
t.Fatal("expected blank field refusal")
}
})
}
}

20
internal/svglide/io.go Normal file
View File

@@ -0,0 +1,20 @@
package svglide
import (
"encoding/json"
"github.com/larksuite/cli/internal/validate"
)
func writeJSON(path string, value any) error {
raw, err := json.MarshalIndent(value, "", " ")
if err != nil {
return err
}
raw = append(raw, '\n')
return validate.AtomicWrite(path, raw, 0o644)
}
func writeText(path string, content string) error {
return validate.AtomicWrite(path, []byte(content), 0o644)
}

431
internal/svglide/preview.go Normal file
View File

@@ -0,0 +1,431 @@
package svglide
import (
"bytes"
"encoding/json"
"fmt"
"html/template"
"path/filepath"
"strings"
"github.com/larksuite/cli/internal/validate"
)
const defaultPreviewPath = "preview.html"
const previewReceiptPath = "receipts/preview.json"
type PreviewReport struct {
Status string `json:"status"`
Slides []PreviewSlideReport `json:"slides"`
}
type PreviewSlideReport struct {
Path string `json:"path"`
Rendered bool `json:"rendered"`
Message string `json:"message,omitempty"`
}
type previewDeck struct {
Title string `json:"title"`
Slides []previewDeckSlide `json:"slides"`
}
type previewDeckSlide struct {
ID string `json:"id"`
Title string `json:"title"`
Summary string `json:"summary"`
Role string `json:"role"`
KeyMessage string `json:"key_message"`
Path string `json:"path"`
}
type previewPageData struct {
Title string
Status string
SlideCount int
RenderedCount int
Slides []previewPageSlide
}
type previewPageSlide struct {
Number int
ID string
Title string
Summary string
Role string
KeyMessage string
Path string
Rendered bool
Message string
}
func WritePreview(root string) (PreviewReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return PreviewReport{}, err
}
deckPath := strings.TrimSpace(run.Artifacts.Deck)
if deckPath == "" {
return writeFailedPreview(safeRoot, run, "", "deck artifact path is empty")
}
deckRaw, err := readRunRegularArtifact(safeRoot, deckPath)
if err != nil {
return writeFailedPreview(safeRoot, run, deckPath, fmt.Sprintf("deck %q: %v", deckPath, err))
}
var deck previewDeck
if err := json.Unmarshal(deckRaw, &deck); err != nil {
return writeFailedPreview(safeRoot, run, deckPath, fmt.Sprintf("deck %q contains invalid JSON: %v", deckPath, err))
}
if len(deck.Slides) == 0 {
return writeFailedPreview(safeRoot, run, deckPath, fmt.Sprintf("deck %q contains no slides", deckPath))
}
report := PreviewReport{Slides: make([]PreviewSlideReport, 0, len(deck.Slides))}
pageSlides := make([]previewPageSlide, 0, len(deck.Slides))
for i, slide := range deck.Slides {
slidePath, pathErr := previewSlideObjectPath(slide.Path)
pageSlide := previewPageSlide{
Number: i + 1,
ID: strings.TrimSpace(slide.ID),
Title: strings.TrimSpace(slide.Title),
Summary: strings.TrimSpace(slide.Summary),
Role: strings.TrimSpace(slide.Role),
KeyMessage: strings.TrimSpace(slide.KeyMessage),
Path: slidePath,
}
item := PreviewSlideReport{Path: slidePath}
if pathErr != nil {
item.Message = pathErr.Error()
} else if slidePath == "" {
item.Path = "(slide)"
pageSlide.Path = item.Path
item.Message = "slide path must not be empty"
} else if _, err := readRunRegularArtifact(safeRoot, slidePath); err != nil {
item.Message = err.Error()
} else {
item.Rendered = true
pageSlide.Rendered = true
}
pageSlide.Message = item.Message
report.Slides = append(report.Slides, item)
pageSlides = append(pageSlides, pageSlide)
}
report = normalizePreviewReport(report)
if err := writePreviewArtifacts(safeRoot, run, deck.Title, report, pageSlides); err != nil {
return report, err
}
return report, nil
}
func writeFailedPreview(safeRoot string, run Run, path string, message string) (PreviewReport, error) {
path = strings.TrimSpace(path)
if path == "" {
path = "(deck)"
}
report := normalizePreviewReport(PreviewReport{
Slides: []PreviewSlideReport{{
Path: path,
Rendered: false,
Message: message,
}},
})
pageSlides := []previewPageSlide{{
Number: 1,
Title: "Preview failed",
Path: path,
Rendered: false,
Message: message,
}}
if err := writePreviewArtifacts(safeRoot, run, run.Title, report, pageSlides); err != nil {
return report, err
}
return report, nil
}
func normalizePreviewReport(report PreviewReport) PreviewReport {
if report.Slides == nil {
report.Slides = []PreviewSlideReport{}
}
report.Status = "passed"
for i := range report.Slides {
report.Slides[i].Path = strings.TrimSpace(report.Slides[i].Path)
if report.Slides[i].Path == "" {
report.Slides[i].Path = "(slide)"
}
if !report.Slides[i].Rendered {
report.Status = "failed"
}
}
return report
}
func previewSlideObjectPath(path string) (string, error) {
raw := strings.TrimSpace(path)
if raw == "" {
return "", fmt.Errorf("slide path must not be empty")
}
if strings.Contains(raw, `\`) {
return "", fmt.Errorf("slide path %q must use forward slashes", raw)
}
if strings.Contains(raw, "%") {
return "", fmt.Errorf("slide path %q must not contain percent encoding", raw)
}
if strings.Contains(raw, ":") || strings.Contains(raw, "//") {
return "", fmt.Errorf("slide path %q must be a local slides/*.svg path", raw)
}
parts := strings.Split(raw, "/")
if len(parts) != 2 || parts[0] != "slides" {
return "", fmt.Errorf("slide path %q must match slides/<file>.svg", raw)
}
fileName := parts[1]
if fileName == "" || fileName == "." || fileName == ".." {
return "", fmt.Errorf("slide path %q must include a slide file name", raw)
}
if strings.Contains(fileName, "/") || strings.Contains(fileName, `\`) {
return "", fmt.Errorf("slide path %q must not contain nested directories", raw)
}
if strings.HasPrefix(fileName, ".") || strings.Contains(fileName, "..") {
return "", fmt.Errorf("slide path %q must not contain dot segments", raw)
}
if strings.ToLower(filepath.Ext(fileName)) != ".svg" {
return "", fmt.Errorf("slide path %q must end with .svg", raw)
}
cleaned := filepath.ToSlash(filepath.Clean(raw))
if cleaned != raw {
return "", fmt.Errorf("slide path %q must already be normalized", raw)
}
return raw, nil
}
func writePreviewArtifacts(safeRoot string, run Run, title string, report PreviewReport, slides []previewPageSlide) error {
report = normalizePreviewReport(report)
previewPath := strings.TrimSpace(run.Artifacts.Preview)
if previewPath == "" {
previewPath = defaultPreviewPath
}
target, err := ensureRunFileTargetForWrite(safeRoot, previewPath)
if err != nil {
return err
}
htmlRaw, err := renderPreviewHTML(title, report, slides)
if err != nil {
return err
}
if err := validate.AtomicWrite(target, htmlRaw, 0o644); err != nil {
return err
}
receiptTarget, err := ensureRunFileTargetForWrite(safeRoot, previewReceiptPath)
if err != nil {
return err
}
raw, err := json.MarshalIndent(report, "", " ")
if err != nil {
return err
}
raw = append(raw, '\n')
return validate.AtomicWrite(receiptTarget, raw, 0o644)
}
func renderPreviewHTML(title string, report PreviewReport, slides []previewPageSlide) ([]byte, error) {
title = strings.TrimSpace(title)
if title == "" {
title = "SVGlide Preview"
}
var rendered int
for _, slide := range slides {
if slide.Rendered {
rendered++
}
}
data := previewPageData{
Title: title,
Status: report.Status,
SlideCount: len(slides),
RenderedCount: rendered,
Slides: slides,
}
var b bytes.Buffer
if err := previewTemplate.Execute(&b, data); err != nil {
return nil, err
}
return b.Bytes(), nil
}
var previewTemplate = template.Must(template.New("preview").Parse(`<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{.Title}} - SVGlide Preview</title>
<style>
:root {
color-scheme: light;
--bg: #f6f7f9;
--panel: #ffffff;
--ink: #1f2933;
--muted: #657286;
--line: #d8dee8;
--accent: #1d7a62;
--warn: #b42318;
}
* { box-sizing: border-box; }
body {
margin: 0;
background: var(--bg);
color: var(--ink);
font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
line-height: 1.45;
}
header {
position: sticky;
top: 0;
z-index: 2;
border-bottom: 1px solid var(--line);
background: rgba(255,255,255,.94);
backdrop-filter: blur(10px);
}
.bar {
display: flex;
align-items: center;
justify-content: space-between;
gap: 24px;
max-width: 1180px;
margin: 0 auto;
padding: 18px 24px;
}
h1 {
margin: 0;
font-size: 20px;
font-weight: 650;
letter-spacing: 0;
}
.meta {
display: flex;
align-items: center;
gap: 10px;
color: var(--muted);
font-size: 13px;
white-space: nowrap;
}
.status {
color: #fff;
background: var(--accent);
border-radius: 999px;
padding: 3px 9px;
font-weight: 650;
}
.status.failed { background: var(--warn); }
main {
max-width: 1180px;
margin: 0 auto;
padding: 22px 24px 48px;
}
.deck {
display: grid;
gap: 18px;
}
.slide {
display: grid;
grid-template-columns: minmax(0, 1fr) 260px;
gap: 16px;
align-items: start;
border: 1px solid var(--line);
border-radius: 8px;
background: var(--panel);
padding: 16px;
box-shadow: 0 12px 24px rgba(31,41,51,.06);
}
.frame {
width: 100%;
aspect-ratio: 16 / 9;
overflow: hidden;
border: 1px solid var(--line);
border-radius: 6px;
background: #fff;
}
object {
display: block;
width: 100%;
height: 100%;
border: 0;
}
.missing {
display: grid;
place-items: center;
width: 100%;
height: 100%;
padding: 24px;
color: var(--warn);
text-align: center;
font-size: 14px;
}
.details {
min-width: 0;
display: grid;
gap: 10px;
color: var(--muted);
font-size: 13px;
}
.details h2 {
margin: 0;
color: var(--ink);
font-size: 16px;
font-weight: 650;
letter-spacing: 0;
overflow-wrap: anywhere;
}
.label {
color: var(--ink);
font-weight: 650;
}
.path {
overflow-wrap: anywhere;
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
font-size: 12px;
}
.message { color: var(--warn); overflow-wrap: anywhere; }
@media (max-width: 860px) {
.bar { align-items: flex-start; flex-direction: column; gap: 8px; }
.meta { flex-wrap: wrap; white-space: normal; }
.slide { grid-template-columns: 1fr; }
}
</style>
</head>
<body>
<header>
<div class="bar">
<h1>{{.Title}}</h1>
<div class="meta">
<span class="status {{.Status}}">{{.Status}}</span>
<span>{{.RenderedCount}} / {{.SlideCount}} rendered</span>
</div>
</div>
</header>
<main>
<section class="deck">
{{range .Slides}}
<article class="slide">
<div class="frame">
{{if .Rendered}}
<object data="{{.Path}}" type="image/svg+xml" aria-label="{{.Title}}"></object>
{{else}}
<div class="missing">{{.Message}}</div>
{{end}}
</div>
<div class="details">
<h2>{{printf "%02d" .Number}}. {{.Title}}</h2>
{{if .Summary}}<div><span class="label">Summary</span><br>{{.Summary}}</div>{{end}}
{{if .KeyMessage}}<div><span class="label">Key Message</span><br>{{.KeyMessage}}</div>{{end}}
{{if .Role}}<div><span class="label">Role</span><br>{{.Role}}</div>{{end}}
<div><span class="label">Path</span><br><span class="path">{{.Path}}</span></div>
{{if .Message}}<div class="message">{{.Message}}</div>{{end}}
</div>
</article>
{{end}}
</section>
</main>
</body>
</html>
`))

View File

@@ -0,0 +1,299 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
)
func TestWritePreviewWritesHTMLAndReceipt(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
report, err := WritePreview("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("Status = %q, want passed: %+v", report.Status, report)
}
if len(report.Slides) != 1 || !report.Slides[0].Rendered || report.Slides[0].Path != "slides/01.svg" {
t.Fatalf("Slides = %+v, want rendered slides/01.svg", report.Slides)
}
htmlRaw, err := os.ReadFile(filepath.Join("demo", "preview.html"))
if err != nil {
t.Fatal(err)
}
html := string(htmlRaw)
for _, want := range []string{"Demo - SVGlide Preview", `data="slides/01.svg"`, "01. Slide", "Key Message"} {
if !strings.Contains(html, want) {
t.Fatalf("preview.html missing %q:\n%s", want, html)
}
}
receipt := readPreviewReceipt(t)
if receipt.Status != "passed" || len(receipt.Slides) != 1 || !receipt.Slides[0].Rendered {
t.Fatalf("preview receipt = %+v, want passed rendered slide", receipt)
}
}
func TestWritePreviewEscapesDeckText(t *testing.T) {
initValidateTestRun(t)
writeDeckAt(t, filepath.Join("demo", "outline", "deck.json"), previewDeck{
Title: `<Deck & Demo>`,
Slides: []previewDeckSlide{{
ID: "cover",
Title: `<Cover & One>`,
Summary: `Summary <script>bad()</script>`,
Role: "cover",
KeyMessage: `Message & context`,
Path: "slides/01.svg",
}},
})
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
if _, err := WritePreview("demo"); err != nil {
t.Fatal(err)
}
htmlRaw, err := os.ReadFile(filepath.Join("demo", "preview.html"))
if err != nil {
t.Fatal(err)
}
html := string(htmlRaw)
if strings.Contains(html, "<script>bad()</script>") {
t.Fatalf("preview.html contains unescaped script:\n%s", html)
}
if !strings.Contains(html, "&lt;script&gt;bad()&lt;/script&gt;") || !strings.Contains(html, "&lt;Deck &amp; Demo&gt;") {
t.Fatalf("preview.html missing escaped deck text:\n%s", html)
}
}
func TestWritePreviewUsesRunArtifactDeckAndPreviewPath(t *testing.T) {
initValidateTestRun(t)
run := readValidateTestRunFile(t)
run.Artifacts.Deck = "custom/deck.json"
run.Artifacts.Preview = "public/deck.html"
writeValidateTestRunFile(t, run)
writeMinimalDeck(t, "demo", "slides/missing.svg")
writeMinimalDeckAt(t, filepath.Join("demo", "custom", "deck.json"), "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
report, err := WritePreview("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("Status = %q, want passed: %+v", report.Status, report)
}
if _, err := os.Stat(filepath.Join("demo", "public", "deck.html")); err != nil {
t.Fatalf("missing custom preview path: %v", err)
}
if _, err := os.Stat(filepath.Join("demo", "preview.html")); !os.IsNotExist(err) {
t.Fatalf("default preview should not be written when artifact path is custom, stat err=%v", err)
}
}
func TestWritePreviewReportsUnsafeSlidePath(t *testing.T) {
tests := []struct {
name string
slidePath string
filePath string
wantMessage string
}{
{
name: "escape",
slidePath: "../outside.svg",
filePath: "outside.svg",
wantMessage: "slides/<file>.svg",
},
{
name: "remote scheme",
slidePath: "https:/evil.example/a.svg",
filePath: filepath.Join("demo", "https:", "evil.example", "a.svg"),
wantMessage: "local slides/*.svg",
},
{
name: "encoded dot segment",
slidePath: "slides/%2e%2e.svg",
filePath: filepath.Join("demo", "slides", "%2e%2e.svg"),
wantMessage: "percent encoding",
},
{
name: "nested directory",
slidePath: "slides/nested/01.svg",
filePath: filepath.Join("demo", "slides", "nested", "01.svg"),
wantMessage: "slides/<file>.svg",
},
{
name: "backslash",
slidePath: `slides\01.svg`,
filePath: filepath.Join("demo", `slides\01.svg`),
wantMessage: "forward slashes",
},
{
name: "wrong extension",
slidePath: "slides/01.png",
filePath: filepath.Join("demo", "slides", "01.png"),
wantMessage: ".svg",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", tt.slidePath)
writeValidateTestFile(t, tt.filePath, visibleTextSVG())
report, err := WritePreview("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("Status = %q, want failed: %+v", report.Status, report)
}
if len(report.Slides) != 1 || report.Slides[0].Rendered {
t.Fatalf("Slides = %+v, want unrendered slide", report.Slides)
}
if !strings.Contains(report.Slides[0].Message, tt.wantMessage) {
t.Fatalf("Message = %q, want %q", report.Slides[0].Message, tt.wantMessage)
}
receipt := readPreviewReceipt(t)
if receipt.Status != "failed" || len(receipt.Slides) != 1 || receipt.Slides[0].Rendered {
t.Fatalf("preview receipt = %+v, want failed unrendered slide", receipt)
}
htmlRaw, err := os.ReadFile(filepath.Join("demo", "preview.html"))
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(htmlRaw), `data="`) {
t.Fatalf("preview should not embed unsafe slide path:\n%s", string(htmlRaw))
}
})
}
}
func TestWritePreviewWritesFailureArtifactsForDeckReadFailures(t *testing.T) {
initValidateTestRun(t)
if err := os.Remove(filepath.Join("demo", "outline", "deck.json")); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
report, err := WritePreview("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("Status = %q, want failed: %+v", report.Status, report)
}
if _, err := os.Stat(filepath.Join("demo", "preview.html")); err != nil {
t.Fatalf("missing preview.html for failed deck read: %v", err)
}
receipt := readPreviewReceipt(t)
if receipt.Status != "failed" || len(receipt.Slides) != 1 || receipt.Slides[0].Path != "outline/deck.json" {
t.Fatalf("preview receipt = %+v, want failed deck report", receipt)
}
}
func TestWritePreviewRejectsPreviewSymlink(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
outside := filepath.Join(filepath.Dir(cwd), "outside-preview.html")
if err := os.WriteFile(outside, []byte("outside"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Remove(filepath.Join("demo", "preview.html")); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "preview.html")); err != nil {
t.Fatal(err)
}
if _, err := WritePreview("demo"); err == nil {
t.Fatal("expected preview symlink write refusal")
}
raw, err := os.ReadFile(outside)
if err != nil {
t.Fatal(err)
}
if string(raw) != "outside" {
t.Fatalf("outside preview overwritten: %q", string(raw))
}
}
func TestWritePreviewRejectsPreviewReceiptSymlink(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
outside := filepath.Join(filepath.Dir(cwd), "outside-preview.json")
if err := os.WriteFile(outside, []byte("outside"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Remove(filepath.Join("demo", "receipts", "preview.json")); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "receipts", "preview.json")); err != nil {
t.Fatal(err)
}
if _, err := WritePreview("demo"); err == nil {
t.Fatal("expected preview receipt symlink write refusal")
}
raw, err := os.ReadFile(outside)
if err != nil {
t.Fatal(err)
}
if string(raw) != "outside" {
t.Fatalf("outside preview receipt overwritten: %q", string(raw))
}
}
func TestWritePreviewRejectsPreviewReceiptsDirectorySymlink(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
if err := os.RemoveAll(filepath.Join("demo", "receipts")); err != nil {
t.Fatal(err)
}
outside := filepath.Join(filepath.Dir(cwd), "outside-preview-receipts")
if err := os.MkdirAll(outside, 0o755); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "receipts")); err != nil {
t.Fatal(err)
}
if _, err := WritePreview("demo"); err == nil {
t.Fatal("expected preview receipts directory symlink write refusal")
}
if _, err := os.Stat(filepath.Join(outside, "preview.json")); !os.IsNotExist(err) {
t.Fatalf("preview receipt should not be written outside run root, stat err=%v", err)
}
}
func readPreviewReceipt(t *testing.T) PreviewReport {
t.Helper()
raw, err := os.ReadFile(filepath.Join("demo", "receipts", "preview.json"))
if err != nil {
t.Fatal(err)
}
var receipt PreviewReport
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatal(err)
}
return receipt
}
func writeDeckAt(t *testing.T, path string, deck previewDeck) {
t.Helper()
raw, err := json.MarshalIndent(deck, "", " ")
if err != nil {
t.Fatal(err)
}
raw = append(raw, '\n')
writeValidateTestFile(t, path, string(raw))
}

299
internal/svglide/prompt.go Normal file
View File

@@ -0,0 +1,299 @@
package svglide
func DefaultSchemas() map[string]string {
return map[string]string{
"request.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["title", "input"],
"properties": {
"title": {"type": "string"},
"input": {"type": "string"},
"purpose": {"type": "string"},
"audience": {"type": "string"},
"delivery_mode": {"type": "string"},
"language": {"type": "string"},
"pages": {"type": "integer"},
"visual_style_query": {"type": "array", "items": {"type": "string"}}
}
}
`,
"source_manifest.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["sources"],
"properties": {
"sources": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["path", "type"],
"properties": {
"path": {"type": "string"},
"type": {"type": "string", "enum": ["local"]}
}
}
}
}
}
`,
"sources.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["sources"],
"properties": {
"sources": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "path", "title", "excerpt", "usage", "retrieval"],
"properties": {
"id": {"type": "string"},
"path": {"type": "string"},
"title": {"type": "string"},
"excerpt": {"type": "string"},
"usage": {"type": "string"},
"retrieval": {"type": "string", "enum": ["full_page", "local_file", "user_provided"]}
}
}
}
}
}
`,
"design_brief.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["narrative_spine", "depth", "tone", "visual_system"],
"properties": {
"design_rationale": {"type": "string"},
"narrative_spine": {"type": "object"},
"depth": {"type": "object"},
"tone": {"type": "string"},
"visual_system": {
"type": "object",
"required": ["color_system", "typography", "layout_language"],
"properties": {
"color_system": {"type": "object"},
"typography": {"type": "object"},
"layout_language": {"type": "object"},
"imagery_treatment": {"type": "object"},
"material_texture": {"type": "object"},
"decoration_language": {"type": "object"},
"mood_coordinates": {"type": "object"}
}
}
}
}
`,
"visual_system.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["color_system", "typography", "layout_language"],
"properties": {
"color_system": {"type": "object"},
"typography": {"type": "object"},
"layout_language": {"type": "object"},
"imagery_treatment": {"type": "object"},
"material_texture": {"type": "object"},
"decoration_language": {"type": "object"},
"mood_coordinates": {"type": "object"}
}
}
`,
"deck.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["main_title", "style_instruction", "slides"],
"properties": {
"main_title": {"type": "string"},
"title": {"type": "string"},
"style_instruction": {
"type": "object",
"required": ["aesthetic_direction", "color_palette", "typography"],
"properties": {
"aesthetic_direction": {"type": "string"},
"color_palette": {"type": "object"},
"typography": {"type": "object"}
}
},
"slides": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "title", "summary", "role", "key_message", "path"],
"properties": {
"id": {"type": "string"},
"title": {"type": "string"},
"page_title": {"type": "string"},
"summary": {"type": "string"},
"role": {"type": "string"},
"key_message": {"type": "string"},
"path": {"type": "string", "pattern": "^slides/[^/]+\\.svg$"}
}
}
}
}
}
`,
"slide_content.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["slides"],
"properties": {
"slides": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "content", "source_refs", "visuals"],
"properties": {
"id": {"type": "string"},
"content": {"type": "string"},
"notes": {"type": "string"},
"source_refs": {"type": "array", "items": {"type": "string"}},
"visuals": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "type", "instruction"],
"properties": {
"id": {"type": "string"},
"type": {"type": "string", "enum": ["image", "diagram", "icon", "chart", "table", "crop", "none"]},
"instruction": {"type": "string"}
}
}
}
}
}
}
}
}
`,
"assets_plan.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["mode", "assets"],
"properties": {
"mode": {"type": "string", "enum": ["experiment_unrestricted_assets"]},
"assets": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "slide_id", "type", "path", "usage", "status"],
"properties": {
"id": {"type": "string"},
"slide_id": {"type": "string"},
"type": {"type": "string", "enum": ["image", "diagram", "icon", "chart", "table", "crop"]},
"path": {"type": "string"},
"usage": {"type": "string"},
"status": {"type": "string", "enum": ["ready", "missing", "deferred"]}
}
}
}
}
}
`,
"quality.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["status", "issues", "metrics"],
"properties": {
"status": {"type": "string", "enum": ["passed", "failed"]},
"issues": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["path", "code", "message", "severity"],
"properties": {
"path": {"type": "string"},
"code": {"type": "string"},
"message": {"type": "string"},
"severity": {"type": "string"}
}
}
},
"metrics": {
"type": "object",
"additionalProperties": false,
"required": ["slides", "sources", "web_sources", "assets", "slides_with_source_refs", "slides_with_visuals"],
"properties": {
"slides": {"type": "integer"},
"sources": {"type": "integer"},
"web_sources": {"type": "integer"},
"assets": {"type": "integer"},
"slides_with_source_refs": {"type": "integer"},
"slides_with_visuals": {"type": "integer"}
}
}
}
}
`,
"receipt.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["stage", "status"],
"properties": {
"stage": {"type": "string"},
"status": {"type": "string"},
"message": {"type": "string"},
"artifacts": {"type": "array", "items": {"type": "string"}}
}
}
`,
"lint.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["status", "issues"],
"properties": {
"status": {"type": "string"},
"issues": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["path", "code", "message"],
"properties": {
"path": {"type": "string"},
"code": {"type": "string"},
"message": {"type": "string"},
"severity": {"type": "string"}
}
}
}
}
}
`,
"preview.schema.json": `{
"type": "object",
"additionalProperties": false,
"required": ["status", "slides"],
"properties": {
"status": {"type": "string"},
"slides": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["path", "rendered"],
"properties": {
"path": {"type": "string"},
"rendered": {"type": "boolean"},
"message": {"type": "string"}
}
}
}
}
}
`,
}
}

View File

@@ -0,0 +1,55 @@
package svglide
import "path/filepath"
const anyGenPromptRoot = "skills/lark-slides/references/anygen-svg"
type PromptManifest struct {
Source string `json:"source"`
Runtime string `json:"runtime"`
Entries []PromptManifestEntry `json:"entries"`
}
type PromptManifestEntry struct {
Name string `json:"name"`
Path string `json:"path"`
Stage string `json:"stage,omitempty"`
Always bool `json:"always,omitempty"`
}
func DefaultPromptManifest() PromptManifest {
return PromptManifest{
Source: anyGenPromptRoot,
Runtime: "codex",
Entries: []PromptManifestEntry{
{Name: "anygen_svg_readme", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "README.md")), Always: true},
{Name: "mode_system_prompt_svg", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "mode_system_prompt_svg.md")), Always: true},
{Name: "svg_reference", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "svg_reference.md")), Always: true},
{Name: "resolve_design_brief", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "resolve_design_brief.md")), Stage: StageDesignBrief},
{Name: "slide_outline", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "slide_outline.md")), Stage: StageOutline},
{Name: "activate_slides_edit", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "activate_slides_edit.md")), Stage: StageSVGAuthor},
{Name: "slides_edit", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "slides_edit.md")), Stage: StageSVGAuthor},
{Name: "finish_slides_edit", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "finish_slides_edit.md")), Stage: StageValidatePreviewRepair},
{Name: "slide_organize", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "slide_organize.md")), Stage: StageOutline},
{Name: "compute_custom_shape_bbox", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "compute_custom_shape_bbox.md")), Stage: StageSVGAuthor},
{Name: "generate_svg_chart", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "generate_svg_chart.md")), Stage: StageAssets},
{Name: "slides_convert", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "slides_convert.md"))},
{Name: "slides_parse_template", Path: filepath.ToSlash(filepath.Join(anyGenPromptRoot, "tools", "slides_parse_template.md"))},
},
}
}
func PromptPathsForStage(stage string) []string {
manifest := DefaultPromptManifest()
paths := make([]string, 0, len(manifest.Entries))
for _, entry := range manifest.Entries {
if entry.Always || entry.Stage == stage {
paths = append(paths, entry.Path)
}
}
return paths
}
func writePromptManifest(root string) error {
return writeJSON(filepath.Join(root, "prompt_manifest.json"), DefaultPromptManifest())
}

293
internal/svglide/quality.go Normal file
View File

@@ -0,0 +1,293 @@
package svglide
import (
"encoding/json"
"fmt"
"path/filepath"
"strings"
)
type QualityReport struct {
Status string `json:"status"`
Issues []QualityIssue `json:"issues"`
Metrics QualityMetrics `json:"metrics"`
}
type QualityIssue struct {
Path string `json:"path"`
Code string `json:"code"`
Message string `json:"message"`
Severity string `json:"severity"`
}
type QualityMetrics struct {
Slides int `json:"slides"`
Sources int `json:"sources"`
WebSources int `json:"web_sources"`
Assets int `json:"assets"`
SlidesWithSourceRef int `json:"slides_with_source_refs"`
SlidesWithVisuals int `json:"slides_with_visuals"`
}
type qualitySourcesFile struct {
Sources []qualitySource `json:"sources"`
}
type qualitySource struct {
ID string `json:"id"`
Path string `json:"path"`
Title string `json:"title"`
Excerpt string `json:"excerpt"`
Usage string `json:"usage"`
Retrieval string `json:"retrieval"`
}
type qualityContentFile struct {
Slides []qualityContentSlide `json:"slides"`
}
type qualityContentSlide struct {
ID string `json:"id"`
Content string `json:"content"`
SourceRefs []string `json:"source_refs"`
Visuals []qualityVisual `json:"visuals"`
}
type qualityVisual struct {
ID string `json:"id"`
Type string `json:"type"`
Instruction string `json:"instruction"`
}
type qualityAssetsFile struct {
Assets []qualityAsset `json:"assets"`
}
type qualityAsset struct {
ID string `json:"id"`
SlideID string `json:"slide_id"`
Type string `json:"type"`
Path string `json:"path"`
Usage string `json:"usage"`
Status string `json:"status"`
}
func CheckQuality(root string) (QualityReport, error) {
safeRoot, _, err := readRun(root)
if err != nil {
return QualityReport{}, err
}
deck, err := readAuthorDeck(safeRoot, "outline/deck.json")
if err != nil {
return QualityReport{}, err
}
sources, err := readQualitySources(safeRoot)
if err != nil {
return QualityReport{}, err
}
content, err := readQualityContent(safeRoot)
if err != nil {
return QualityReport{}, err
}
assets, err := readQualityAssets(safeRoot)
if err != nil {
return QualityReport{}, err
}
report := QualityReport{
Status: "passed",
Issues: []QualityIssue{},
Metrics: QualityMetrics{},
}
report.Metrics.Slides = len(deck.Slides)
report.Metrics.Sources = len(sources.Sources)
report.Metrics.Assets = len(assets.Assets)
sourceIDs := make(map[string]bool, len(sources.Sources))
hasLocalOrUserProvidedSource := false
for _, source := range sources.Sources {
id := strings.TrimSpace(source.ID)
if id != "" {
sourceIDs[id] = true
}
retrieval := strings.TrimSpace(source.Retrieval)
path := strings.TrimSpace(source.Path)
if retrieval == "full_page" && (strings.HasPrefix(path, "http://") || strings.HasPrefix(path, "https://")) {
report.Metrics.WebSources++
}
if retrieval == "local_file" || retrieval == "user_provided" {
hasLocalOrUserProvidedSource = true
}
}
if report.Metrics.WebSources == 0 && !hasLocalOrUserProvidedSource {
report.Issues = append(report.Issues, qualityIssue(
"research/sources.json",
"svglide.quality.research",
"topic decks need at least one full_page web source or explicit local/user-provided source",
))
}
assetsBySlideAndID := make(map[string]qualityAsset, len(assets.Assets))
deferredBySlideAndID := make(map[string]qualityAsset, len(assets.Assets))
for _, asset := range assets.Assets {
status := strings.TrimSpace(asset.Status)
key := strings.TrimSpace(asset.SlideID) + "/" + strings.TrimSpace(asset.ID)
if status == "deferred" {
deferredBySlideAndID[key] = asset
continue
}
if status != "ready" {
continue
}
assetsBySlideAndID[key] = asset
}
contentByID := make(map[string]qualityContentSlide, len(content.Slides))
for _, slide := range content.Slides {
id := strings.TrimSpace(slide.ID)
if id == "" {
continue
}
contentByID[id] = slide
}
for _, slide := range deck.Slides {
id := strings.TrimSpace(slide.ID)
item, ok := contentByID[id]
if !ok {
report.Issues = append(report.Issues, qualityIssue(
"content/slide_content.json",
"svglide.quality.content",
fmt.Sprintf("deck slide %q is missing content", id),
))
continue
}
if len(item.SourceRefs) > 0 {
report.Metrics.SlidesWithSourceRef++
} else {
report.Issues = append(report.Issues, qualityIssue(
"content/slide_content.json",
"svglide.quality.source_refs",
fmt.Sprintf("slide %q has no source_refs", id),
))
}
for _, ref := range item.SourceRefs {
ref = strings.TrimSpace(ref)
if ref == "" || !sourceIDs[ref] {
report.Issues = append(report.Issues, qualityIssue(
"content/slide_content.json",
"svglide.quality.source_refs",
fmt.Sprintf("slide %q references unknown source %q", id, ref),
))
}
}
if len(item.Visuals) == 0 {
report.Issues = append(report.Issues, qualityIssue(
"content/slide_content.json",
"svglide.quality.visuals",
fmt.Sprintf("slide %q has no visuals; use a type=none sentinel when no visual asset is needed", id),
))
}
hasVisual := false
for _, visual := range item.Visuals {
visualType := strings.TrimSpace(visual.Type)
if visualType == "none" {
continue
}
hasVisual = true
key := id + "/" + strings.TrimSpace(visual.ID)
asset, ok := assetsBySlideAndID[key]
if !ok && visualTypeIsDeferredOnly(visualType) {
if deferredAsset, deferred := deferredBySlideAndID[key]; deferred {
asset = deferredAsset
ok = true
}
}
if !ok {
report.Issues = append(report.Issues, qualityIssue(
"assets/assets_plan.json",
"svglide.quality.asset",
fmt.Sprintf("slide %q visual %q has no ready asset", id, visual.ID),
))
continue
}
assetType := strings.TrimSpace(asset.Type)
if assetType != visualType {
report.Issues = append(report.Issues, qualityIssue(
"assets/assets_plan.json",
"svglide.quality.asset",
fmt.Sprintf("slide %q visual %q type %q has ready asset type %q", id, visual.ID, visualType, assetType),
))
}
}
if hasVisual {
report.Metrics.SlidesWithVisuals++
}
}
if len(report.Issues) > 0 {
report.Status = "failed"
}
if err := writeJSON(filepath.Join(safeRoot, "quality_report.json"), report); err != nil {
return report, err
}
return report, nil
}
func visualTypeIsDeferredOnly(value string) bool {
switch strings.TrimSpace(value) {
case "chart", "table", "crop":
return true
default:
return false
}
}
func readQualitySources(safeRoot string) (qualitySourcesFile, error) {
raw, err := readRunRegularArtifact(safeRoot, "research/sources.json")
if err != nil {
return qualitySourcesFile{}, err
}
var file qualitySourcesFile
if err := json.Unmarshal(raw, &file); err != nil {
return qualitySourcesFile{}, fmt.Errorf("read sources %q: %w", "research/sources.json", err)
}
return file, nil
}
func readQualityContent(safeRoot string) (qualityContentFile, error) {
raw, err := readRunRegularArtifact(safeRoot, "content/slide_content.json")
if err != nil {
return qualityContentFile{}, err
}
var file qualityContentFile
if err := json.Unmarshal(raw, &file); err != nil {
return qualityContentFile{}, fmt.Errorf("read slide content %q: %w", "content/slide_content.json", err)
}
return file, nil
}
func readQualityAssets(safeRoot string) (qualityAssetsFile, error) {
raw, err := readRunRegularArtifact(safeRoot, "assets/assets_plan.json")
if err != nil {
return qualityAssetsFile{}, err
}
var file qualityAssetsFile
if err := json.Unmarshal(raw, &file); err != nil {
return qualityAssetsFile{}, fmt.Errorf("read assets plan %q: %w", "assets/assets_plan.json", err)
}
return file, nil
}
func qualityIssue(path, code, message string) QualityIssue {
return QualityIssue{
Path: path,
Code: code,
Message: message,
Severity: "error",
}
}

View File

@@ -0,0 +1,289 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"testing"
)
func TestCheckQualityAllowsExplicitLocalSourceWithoutFullPageWebSource(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"local1","path":"source.md","title":"Local Source","excerpt":"Input","usage":"Support","retrieval":"local_file"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["local1"],"visuals":[{"id":"v1","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed; issues = %+v", report.Status, report.Issues)
}
}
func TestCheckQualityRejectsTopicDeckWithoutFullPageWebOrExplicitLocalSource(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"source1","path":"source.md","title":"Weak Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["source1"],"visuals":[{"id":"v1","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("status = %q, want failed", report.Status)
}
if !qualityIssueCodesContain(report.Issues, "svglide.quality.research") {
t.Fatalf("issues = %+v, want svglide.quality.research", report.Issues)
}
}
func TestCheckQualityRejectsSlideContentWithoutSourceRefs(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":[],"visuals":[{"id":"v1","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("status = %q, want failed", report.Status)
}
if !qualityIssueCodesContain(report.Issues, "svglide.quality.source_refs") {
t.Fatalf("issues = %+v, want svglide.quality.source_refs", report.Issues)
}
}
func TestCheckQualityRejectsMissingVisualAsset(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("status = %q, want failed", report.Status)
}
if !qualityIssueCodesContain(report.Issues, "svglide.quality.asset") {
t.Fatalf("issues = %+v, want svglide.quality.asset", report.Issues)
}
}
func TestCheckQualityPassesAnyGenReadyRun(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed", report.Status)
}
if len(report.Issues) != 0 {
t.Fatalf("issues = %+v, want empty", report.Issues)
}
if report.Metrics.Slides != 1 || report.Metrics.Sources != 1 || report.Metrics.WebSources != 1 || report.Metrics.Assets != 1 || report.Metrics.SlidesWithSourceRef != 1 || report.Metrics.SlidesWithVisuals != 1 {
t.Fatalf("metrics = %+v, want all ones", report.Metrics)
}
raw, err := os.ReadFile(filepath.Join("demo", "quality_report.json"))
if err != nil {
t.Fatalf("missing quality_report.json: %v", err)
}
var written QualityReport
if err := json.Unmarshal(raw, &written); err != nil {
t.Fatal(err)
}
if written.Status != "passed" {
t.Fatalf("written status = %q, want passed", written.Status)
}
}
func TestCheckQualityAllowsExperimentAssetsAndDeferredUnsupportedVisuals(t *testing.T) {
t.Chdir(t.TempDir())
initStatusTestRun(t)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/report","title":"Report","excerpt":"Full page excerpt","usage":"evidence","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/outline/deck.json", `{"main_title":"Demo Deck","style_instruction":{"aesthetic_direction":"Editorial report","color_palette":{},"typography":{}},"slides":[{"id":"s1","title":"Chart claim","summary":"Needs chart later","role":"content","key_message":"Chart is deferred","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Chart-backed point","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Use a remote hero image"},{"id":"chart1","type":"chart","instruction":"Use a real chart when chart generation is enabled"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"mode":"experiment_unrestricted_assets","assets":[{"id":"hero","slide_id":"s1","type":"image","path":"https://example.com/hero.png","usage":"Hero image","status":"ready"},{"id":"chart1","slide_id":"s1","type":"chart","path":"","usage":"Deferred chart generation","status":"deferred"}]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("Status = %q, want passed: %+v", report.Status, report.Issues)
}
}
func TestCheckQualityAllowsAbsoluteReadyAssetPathInExperiment(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"}]}]}`)
outside := filepath.Join(t.TempDir(), "hero.png")
if err := os.WriteFile(outside, []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"`+outside+`","usage":"Hero image","status":"ready"}]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed; issues = %+v", report.Status, report.Issues)
}
}
func TestCheckQualityRejectsEmptyVisuals(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("status = %q, want failed", report.Status)
}
if !qualityIssueCodesContain(report.Issues, "svglide.quality.visuals") {
t.Fatalf("issues = %+v, want svglide.quality.visuals", report.Issues)
}
}
func TestCheckQualityRejectsVisualAssetTypeMismatch(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"diagram","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("status = %q, want failed", report.Status)
}
if !qualityIssueCodesContain(report.Issues, "svglide.quality.asset") {
t.Fatalf("issues = %+v, want svglide.quality.asset", report.Issues)
}
}
func TestCheckQualityCountsSlidesWithVisualsPerPage(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"},{"id":"logo","type":"diagram","instruction":"Support diagram"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"},{"id":"logo","slide_id":"s1","type":"diagram","path":"assets/images/logo.svg","usage":"Support diagram","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "assets", "images", "logo.svg"), []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed", report.Status)
}
if report.Metrics.SlidesWithVisuals != 1 {
t.Fatalf("metrics.slides_with_visuals = %d, want 1", report.Metrics.SlidesWithVisuals)
}
}
func TestCheckQualityAllowsSymlinkReadyAssetPathInExperiment(t *testing.T) {
initStatusTestRun(t)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"hero","type":"image","instruction":"Hero image"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[{"id":"hero","slide_id":"s1","type":"image","path":"assets/images/hero.png","usage":"Hero image","status":"ready"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "assets", "images"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("outside-hero.png"), []byte("png"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(filepath.Join("..", "..", "outside-hero.png"), filepath.Join("demo", "assets", "images", "hero.png")); err != nil {
t.Fatal(err)
}
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed; issues = %+v", report.Status, report.Issues)
}
}
func TestCheckQualityUsesOutlineDeckNotRunArtifactDeck(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
run.Artifacts.Deck = "custom/deck.json"
writeStatusTestRunFile(t, run)
mustWriteTestFile(t, "demo/outline/deck.json", `{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`)
if err := os.MkdirAll(filepath.Join("demo", "custom"), 0o755); err != nil {
t.Fatal(err)
}
mustWriteTestFile(t, "demo/custom/deck.json", `{"title":"Custom Deck","slides":[{"id":"c1","title":"Custom 1","summary":"Custom summary 1","role":"cover","key_message":"Custom key 1","path":"slides/01.svg"},{"id":"c2","title":"Custom 2","summary":"Custom summary 2","role":"content","key_message":"Custom key 2","path":"slides/02.svg"}]}`)
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"web1","path":"https://example.com/page","title":"Web Source","excerpt":"Input","usage":"Support","retrieval":"full_page"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"Claim","source_refs":["web1"],"visuals":[{"id":"v1","type":"none","instruction":"Text-only"}]},{"id":"c1","content":"Custom claim 1","source_refs":["web1"],"visuals":[{"id":"v2","type":"none","instruction":"Text-only"}]},{"id":"c2","content":"Custom claim 2","source_refs":["web1"],"visuals":[{"id":"v3","type":"none","instruction":"Text-only"}]}]}`)
mustWriteTestFile(t, "demo/assets/assets_plan.json", `{"assets":[]}`)
report, err := CheckQuality("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("status = %q, want passed", report.Status)
}
if report.Metrics.Slides != 1 {
t.Fatalf("metrics.slides = %d, want 1 from outline/deck.json", report.Metrics.Slides)
}
}
func qualityIssueCodesContain(issues []QualityIssue, want string) bool {
for _, issue := range issues {
if issue.Code == want {
return true
}
}
return false
}

153
internal/svglide/receipt.go Normal file
View File

@@ -0,0 +1,153 @@
package svglide
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io/fs"
"path/filepath"
"strings"
"github.com/larksuite/cli/internal/validate"
"github.com/larksuite/cli/internal/vfs"
)
type validationLintReceipt struct {
Status string `json:"status"`
Issues []ValidationIssue `json:"issues"`
}
func writeValidationArtifacts(safeRoot string, report ValidationReport) error {
report = normalizeValidationReport(report)
lintPath, err := ensureRunFileTargetForWrite(safeRoot, "receipts/lint.json")
if err != nil {
return err
}
raw, err := json.MarshalIndent(validationLintReceipt{
Status: validationReceiptStatus(report),
Issues: report.Issues,
}, "", " ")
if err != nil {
return err
}
raw = append(raw, '\n')
if err := validate.AtomicWrite(lintPath, raw, 0o644); err != nil {
return err
}
queuePath, err := ensureRunFileTargetForWrite(safeRoot, "repair_queue.md")
if err != nil {
return err
}
return validate.AtomicWrite(queuePath, []byte(renderRepairQueue(report)), 0o644)
}
func normalizeValidationReport(report ValidationReport) ValidationReport {
if report.Issues == nil {
report.Issues = []ValidationIssue{}
}
report.OK = len(report.Issues) == 0
for i := range report.Issues {
report.Issues[i].Path = strings.TrimSpace(report.Issues[i].Path)
if report.Issues[i].Path == "" {
report.Issues[i].Path = "(deck)"
}
report.Issues[i].Code = strings.TrimSpace(report.Issues[i].Code)
if report.Issues[i].Code == "" {
report.Issues[i].Code = "svglide.validation"
}
report.Issues[i].Severity = strings.TrimSpace(report.Issues[i].Severity)
if report.Issues[i].Severity == "" {
report.Issues[i].Severity = "error"
}
}
return report
}
func validationReceiptStatus(report ValidationReport) string {
if report.OK {
return "passed"
}
return "failed"
}
func renderRepairQueue(report ValidationReport) string {
if report.OK {
return "No repair needed.\n"
}
var b bytes.Buffer
b.WriteString("# SVGlide Repair Queue\n\n")
for _, issue := range report.Issues {
fmt.Fprintf(&b, "- `%s` [%s]: %s\n", issue.Path, issue.Code, issue.Message)
}
return b.String()
}
func ensureRunFileTargetForWrite(safeRoot string, rel string) (string, error) {
cleanRel := filepath.Clean(rel)
if cleanRel == "." {
return "", fmt.Errorf("run file path must not be root")
}
dirRel := filepath.Dir(cleanRel)
if _, err := ensureRunDirectoryForWrite(safeRoot, dirRel); err != nil {
return "", err
}
path, err := safeRunPath(safeRoot, cleanRel)
if err != nil {
return "", err
}
info, err := vfs.Lstat(path)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
return path, nil
}
return "", err
}
if info.Mode()&fs.ModeSymlink != 0 {
return "", fmt.Errorf("run file path %q must not be a symlink", rel)
}
if !info.Mode().IsRegular() {
return "", fmt.Errorf("run file path %q must be a regular file", rel)
}
return path, nil
}
func ensureRunDirectoryForWrite(safeRoot string, rel string) (string, error) {
path, err := safeRunPath(safeRoot, rel)
if err != nil {
return "", err
}
cleanRel := filepath.Clean(rel)
if cleanRel == "." {
return path, nil
}
parts := strings.Split(cleanRel, string(filepath.Separator))
cur := safeRoot
for i, part := range parts {
if part == "" || part == "." {
continue
}
cur = filepath.Join(cur, part)
info, err := vfs.Lstat(cur)
if err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return "", err
}
if err := vfs.Mkdir(cur, 0o755); err != nil {
info, err = vfs.Lstat(cur)
if err != nil {
return "", err
}
} else {
continue
}
}
if info.Mode()&fs.ModeSymlink != 0 {
return "", fmt.Errorf("run directory path %q must not contain symlink component %q", rel, filepath.Join(parts[:i+1]...))
}
if !info.IsDir() {
return "", fmt.Errorf("run directory path %q component %q is not a directory", rel, filepath.Join(parts[:i+1]...))
}
}
return path, nil
}

142
internal/svglide/repair.go Normal file
View File

@@ -0,0 +1,142 @@
package svglide
import (
"strings"
)
type RepairReport struct {
Status string `json:"status"`
LintOK bool `json:"lint_ok"`
Preview string `json:"preview"`
Quality string `json:"quality"`
Reauthored bool `json:"reauthored"`
}
func RepairRun(root string) (RepairReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return RepairReport{}, err
}
lint, validateErr := ValidateRun(root)
if validateErr != nil {
return RepairReport{}, validateErr
}
reauthored := false
if !lint.OK {
repairPaths, ok := authorRepairPaths(lint)
if ok {
if _, err := authorSlides(root, repairPaths); err != nil {
return RepairReport{}, err
}
reauthored = true
lint, validateErr = ValidateRun(root)
}
if validateErr != nil {
return RepairReport{}, validateErr
}
}
preview, err := WritePreview(root)
if err != nil {
return RepairReport{}, err
}
quality, err := CheckQuality(root)
if err != nil {
return RepairReport{}, err
}
report := RepairReport{
Status: "failed",
LintOK: lint.OK,
Preview: preview.Status,
Quality: quality.Status,
Reauthored: reauthored,
}
if report.LintOK && report.Preview == "passed" && report.Quality == "passed" {
report.Status = "passed"
}
previewPath := strings.TrimSpace(run.Artifacts.Preview)
if previewPath == "" {
previewPath = defaultPreviewPath
}
if err := writeStageReceipt(safeRoot, StageReceipt{
Stage: StageValidatePreviewRepair,
Status: report.Status,
Message: repairReceiptMessage(report),
Artifacts: []string{
"receipts/lint.json",
"receipts/preview.json",
"quality_report.json",
"repair_queue.md",
previewPath,
},
}); err != nil {
return report, err
}
return report, nil
}
func canRepairByAuthoring(report ValidationReport) bool {
_, ok := authorRepairPaths(report)
return ok
}
func authorRepairPaths(report ValidationReport) (map[string]bool, bool) {
if report.OK || len(report.Issues) == 0 {
return nil, false
}
paths := make(map[string]bool)
for _, issue := range report.Issues {
path, ok := repairIssueAuthorPath(issue)
if !ok {
return nil, false
}
paths[path] = true
}
if len(paths) == 0 {
return nil, false
}
return paths, true
}
func canRepairIssueByAuthoring(issue ValidationIssue) bool {
_, ok := repairIssueAuthorPath(issue)
return ok
}
func repairIssueAuthorPath(issue ValidationIssue) (string, bool) {
path := strings.TrimSpace(issue.Path)
slidePath, err := previewSlideObjectPath(path)
if err != nil {
return "", false
}
switch strings.TrimSpace(issue.Code) {
case "svglide.path":
return slidePath, strings.Contains(issue.Message, "missing or not a regular file")
case "svglide.xml", "svglide.root", "svglide.slide_role", "svglide.viewbox", "svglide.visible_content":
return slidePath, true
default:
return "", false
}
}
func repairReceiptMessage(report RepairReport) string {
if report.Status == "passed" {
if report.Reauthored {
return "lint, preview, and quality passed after reauthoring"
}
return "lint, preview, and quality passed"
}
if report.LintOK && report.Preview == "passed" && report.Quality != "passed" {
return "quality gate failed"
}
if report.Reauthored {
return "repair reauthored slides but lint or preview still failed"
}
return "lint or preview failed"
}

View File

@@ -0,0 +1,241 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"testing"
)
func TestRepairRunAuthorsMissingSlidesAndWritesFinalReceipt(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
report, err := RepairRun("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" {
t.Fatalf("Status = %q, want passed: %+v", report.Status, report)
}
if !report.LintOK {
t.Fatalf("LintOK = false, want true: %+v", report)
}
if report.Preview != "passed" {
t.Fatalf("Preview = %q, want passed: %+v", report.Preview, report)
}
if report.Quality != "passed" {
t.Fatalf("Quality = %q, want passed: %+v", report.Quality, report)
}
if !report.Reauthored {
t.Fatalf("Reauthored = false, want true: %+v", report)
}
for _, rel := range []string{
"slides/01.svg",
"preview.html",
"receipts/lint.json",
"receipts/preview.json",
"quality_report.json",
"receipts/validate_preview_repair.json",
} {
if _, err := os.Stat(filepath.Join("demo", rel)); err != nil {
t.Fatalf("missing %s: %v", rel, err)
}
}
receipt := readRepairReceiptForTest(t)
if receipt["stage"] != StageValidatePreviewRepair {
t.Fatalf("receipt stage = %v, want %q", receipt["stage"], StageValidatePreviewRepair)
}
if receipt["status"] != "passed" {
t.Fatalf("receipt status = %v, want passed", receipt["status"])
}
if receipt["message"] != "lint, preview, and quality passed after reauthoring" {
t.Fatalf("receipt message = %v, want quality-aware pass message", receipt["message"])
}
if _, ok := receipt["artifacts"].([]any); !ok {
t.Fatalf("receipt artifacts = %T, want array", receipt["artifacts"])
}
if _, ok := receipt["updated_at"]; ok {
t.Fatalf("receipt contains updated_at, want StageReceipt-compatible schema: %+v", receipt)
}
if _, ok := receipt["generated_at"]; ok {
t.Fatalf("receipt contains generated_at, want StageReceipt-compatible schema: %+v", receipt)
}
}
func TestRepairRunFailsWhenQualityFails(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/slides/01.svg", visibleTextSVG())
mustWriteTestFile(t, "demo/research/sources.json", `{"sources":[{"id":"local1","path":"research/local.md","title":"Local source","excerpt":"Local excerpt","usage":"support","retrieval":"local_file"}]}`)
mustWriteTestFile(t, "demo/content/slide_content.json", `{"slides":[{"id":"s1","content":"First body line\nSecond body line","source_refs":[],"visuals":[{"id":"none-s1","type":"none","instruction":"Text-only"}]}]}`)
report, err := RepairRun("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("Status = %q, want failed: %+v", report.Status, report)
}
if report.LintOK != true {
t.Fatalf("LintOK = %v, want true: %+v", report.LintOK, report)
}
if report.Preview != "passed" {
t.Fatalf("Preview = %q, want passed: %+v", report.Preview, report)
}
if report.Quality != "failed" {
t.Fatalf("Quality = %q, want failed: %+v", report.Quality, report)
}
qualityRaw, err := os.ReadFile(filepath.Join("demo", "quality_report.json"))
if err != nil {
t.Fatal(err)
}
var quality map[string]any
if err := json.Unmarshal(qualityRaw, &quality); err != nil {
t.Fatal(err)
}
if quality["status"] != "failed" {
t.Fatalf("quality status = %v, want failed: %+v", quality["status"], quality)
}
receipt := readRepairReceiptForTest(t)
if receipt["status"] != "failed" {
t.Fatalf("receipt status = %v, want failed", receipt["status"])
}
if receipt["message"] != "quality gate failed" {
t.Fatalf("receipt message = %v, want quality gate failed", receipt["message"])
}
}
func TestRepairReceiptMessagePrioritizesLintPreviewFailuresOverQuality(t *testing.T) {
if got := repairReceiptMessage(RepairReport{Status: "failed", LintOK: false, Preview: "failed", Quality: "failed"}); got != "lint or preview failed" {
t.Fatalf("message = %q, want lint or preview failed", got)
}
if got := repairReceiptMessage(RepairReport{Status: "failed", LintOK: false, Preview: "failed", Quality: "failed", Reauthored: true}); got != "repair reauthored slides but lint or preview still failed" {
t.Fatalf("reauthored message = %q, want reauthored lint/preview failure", got)
}
if got := repairReceiptMessage(RepairReport{Status: "failed", LintOK: true, Preview: "passed", Quality: "failed"}); got != "quality gate failed" {
t.Fatalf("quality-only message = %q, want quality gate failed", got)
}
}
func TestRepairRunOnlyReauthorsFailedSlidePaths(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"},{"id":"s2","title":"Second claim","summary":"Second summary","role":"content","key_message":"Second key message","path":"slides/02.svg"}]}`,
)
custom := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540"><rect width="960" height="540" fill="#fff"/><text x="48" y="80">KEEP-CUSTOM-01</text></svg>`
mustWriteTestFile(t, "demo/slides/01.svg", custom)
report, err := RepairRun("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" || !report.Reauthored || !report.LintOK || report.Preview != "passed" {
t.Fatalf("report = %+v, want passed reauthored repair", report)
}
raw, err := os.ReadFile(filepath.Join("demo", "slides", "01.svg"))
if err != nil {
t.Fatal(err)
}
if string(raw) != custom {
t.Fatalf("slides/01.svg was overwritten:\n%s", string(raw))
}
if _, err := os.Stat(filepath.Join("demo", "slides", "02.svg")); err != nil {
t.Fatalf("missing reauthored slides/02.svg: %v", err)
}
validation, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !validation.OK {
t.Fatalf("ValidateRun OK = false after repair: %+v", validation.Issues)
}
}
func TestRepairRunReauthorsBackgroundOnlySVG(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
mustWriteTestFile(t, "demo/slides/01.svg", backgroundOnlySVG())
report, err := RepairRun("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "passed" || !report.Reauthored || !report.LintOK || report.Preview != "passed" {
t.Fatalf("report = %+v, want passed reauthored repair", report)
}
validation, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !validation.OK {
t.Fatalf("ValidateRun OK = false after repair: %+v", validation.Issues)
}
}
func TestRepairRunDoesNotAuthorInvalidSlidePath(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/../01.svg"}]}`,
)
report, err := RepairRun("demo")
if err != nil {
t.Fatal(err)
}
if report.Status != "failed" {
t.Fatalf("Status = %q, want failed: %+v", report.Status, report)
}
if report.Reauthored {
t.Fatalf("Reauthored = true, want false for invalid path: %+v", report)
}
if _, err := os.Stat(filepath.Join("demo", "receipts", "svg_author.json")); !os.IsNotExist(err) {
t.Fatalf("svg_author receipt exists or stat failed, want no authoring: %v", err)
}
}
func TestRepairRunTreatsValidationArtifactWriteErrorAsFatal(t *testing.T) {
initAuthorDemoRun(t,
`{"color_system":{"background":"#FFFFFF","ink":"#111827","muted":"#6B7280","accent":"#2563EB"},"typography":{"title":32,"body":16},"layout_language":"analyst deck"}`,
`{"title":"Demo Deck","slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"slides/01.svg"}]}`,
)
if err := os.Remove(filepath.Join("demo", "repair_queue.md")); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
if err := os.Mkdir(filepath.Join("demo", "repair_queue.md"), 0o755); err != nil {
t.Fatal(err)
}
if _, err := RepairRun("demo"); err == nil {
t.Fatal("expected repair to return validation artifact write error")
}
if _, err := os.Stat(filepath.Join("demo", "receipts", "validate_preview_repair.json")); !os.IsNotExist(err) {
t.Fatalf("final repair receipt exists or stat failed, want no misleading final receipt: %v", err)
}
}
func readRepairReceiptForTest(t *testing.T) map[string]any {
t.Helper()
raw, err := os.ReadFile(filepath.Join("demo", "receipts", "validate_preview_repair.json"))
if err != nil {
t.Fatal(err)
}
var receipt map[string]any
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatal(err)
}
return receipt
}

120
internal/svglide/run.go Normal file
View File

@@ -0,0 +1,120 @@
package svglide
import "time"
const (
StageRequest = "request"
StageResearch = "research"
StageDesignBrief = "design_brief"
StageOutline = "outline"
StageSlideContent = "slide_content"
StageAssets = "assets"
StageSVGAuthor = "svg_author"
StageValidatePreviewRepair = "validate_preview_repair"
StatusPending = "pending"
StatusReady = "ready"
StatusInProgress = "in_progress"
StatusDone = "done"
StatusFailed = "failed"
StatusBlocked = "blocked"
StatusNeedsRepair = "needs_repair"
)
type Run struct {
Version int `json:"version"`
Runtime string `json:"runtime"`
Command string `json:"command"`
Title string `json:"title"`
Input string `json:"input"`
Audience string `json:"audience,omitempty"`
DeliveryMode string `json:"delivery_mode,omitempty"`
Pages int `json:"pages,omitempty"`
Out string `json:"out"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
CurrentStage string `json:"current_stage"`
Stages []Stage `json:"stages"`
Artifacts ArtifactPaths `json:"artifacts"`
Policy Policy `json:"policy"`
}
type Stage struct {
Name string `json:"name"`
Status string `json:"status"`
Inputs []string `json:"inputs"`
Outputs []string `json:"outputs"`
Receipt string `json:"receipt"`
}
type ArtifactPaths struct {
Deck string `json:"deck"`
SlidesDir string `json:"slides_dir"`
Preview string `json:"preview"`
RepairQueue string `json:"repair_queue"`
}
type Policy struct {
PublishEnabled bool `json:"publish_enabled"`
NetworkByCodex bool `json:"network_by_codex"`
ImageGenerationByCodex bool `json:"image_generation_by_codex"`
Overwrite bool `json:"overwrite"`
}
type NewRunConfig struct {
Title string
Input string
Audience string
DeliveryMode string
Pages int
Out string
Now time.Time
}
func NewRun(cfg NewRunConfig) Run {
now := cfg.Now
if now.IsZero() {
now = time.Now()
}
ts := now.Format(time.RFC3339)
return Run{
Version: 1,
Runtime: "codex",
Command: "slides +create-svglide",
Title: cfg.Title,
Input: cfg.Input,
Audience: cfg.Audience,
DeliveryMode: cfg.DeliveryMode,
Pages: cfg.Pages,
Out: cfg.Out,
CreatedAt: ts,
UpdatedAt: ts,
CurrentStage: StageRequest,
Stages: DefaultStages(),
Artifacts: ArtifactPaths{
Deck: "outline/deck.json",
SlidesDir: "slides",
Preview: "preview.html",
RepairQueue: "repair_queue.md",
},
Policy: Policy{
PublishEnabled: false,
NetworkByCodex: true,
ImageGenerationByCodex: true,
Overwrite: false,
},
}
}
func DefaultStages() []Stage {
return []Stage{
{Name: StageRequest, Status: StatusPending, Inputs: []string{}, Outputs: []string{"request/request.json", "request/source_manifest.json"}, Receipt: "receipts/request.json"},
{Name: StageResearch, Status: StatusPending, Inputs: []string{"request/request.json", "request/source_manifest.json"}, Outputs: []string{"research/research_notes.md", "research/sources.json"}, Receipt: "receipts/research.json"},
{Name: StageDesignBrief, Status: StatusPending, Inputs: []string{"request/request.json", "research/research_notes.md"}, Outputs: []string{"brief/design_brief.json", "brief/visual_system.json"}, Receipt: "receipts/design_brief.json"},
{Name: StageOutline, Status: StatusPending, Inputs: []string{"brief/design_brief.json", "brief/visual_system.json"}, Outputs: []string{"outline/deck.json"}, Receipt: "receipts/outline.json"},
{Name: StageSlideContent, Status: StatusPending, Inputs: []string{"outline/deck.json", "research/research_notes.md"}, Outputs: []string{"content/slide_content.md", "content/slide_content.json"}, Receipt: "receipts/slide_content.json"},
{Name: StageAssets, Status: StatusPending, Inputs: []string{"content/slide_content.json", "brief/visual_system.json"}, Outputs: []string{"assets/assets_plan.json"}, Receipt: "receipts/assets.json"},
{Name: StageSVGAuthor, Status: StatusPending, Inputs: []string{"outline/deck.json", "content/slide_content.json", "brief/visual_system.json", "assets/assets_plan.json"}, Outputs: []string{"slides/*.svg"}, Receipt: "receipts/svg_author.json"},
{Name: StageValidatePreviewRepair, Status: StatusPending, Inputs: []string{"slides/*.svg"}, Outputs: []string{"receipts/lint.json", "receipts/preview.json", "quality_report.json", "repair_queue.md", "preview.html"}, Receipt: "receipts/validate_preview_repair.json"},
}
}

View File

@@ -0,0 +1,174 @@
package svglide
import (
"reflect"
"testing"
"time"
)
func TestDefaultStagesAreOrdered(t *testing.T) {
stages := DefaultStages()
want := []string{
StageRequest,
StageResearch,
StageDesignBrief,
StageOutline,
StageSlideContent,
StageAssets,
StageSVGAuthor,
StageValidatePreviewRepair,
}
if len(stages) != len(want) {
t.Fatalf("stage count = %d, want %d", len(stages), len(want))
}
for i, stage := range stages {
if stage.Name != want[i] {
t.Fatalf("stage[%d] = %q, want %q", i, stage.Name, want[i])
}
if stage.Status != StatusPending {
t.Fatalf("stage[%d].Status = %q, want %q", i, stage.Status, StatusPending)
}
if stage.Inputs == nil {
t.Fatalf("stage[%d].Inputs = nil, want stable empty array", i)
}
if stage.Outputs == nil {
t.Fatalf("stage[%d].Outputs = nil, want stable empty array", i)
}
if stage.Receipt == "" {
t.Fatalf("stage[%d] missing receipt path", i)
}
}
}
func TestDefaultStagesRequireGeneratedSlideSVGs(t *testing.T) {
stages := DefaultStages()
svgAuthor := mustStage(t, stages, StageSVGAuthor)
if !reflect.DeepEqual(svgAuthor.Outputs, []string{"slides/*.svg"}) {
t.Fatalf("svg_author Outputs = %v, want slides/*.svg", svgAuthor.Outputs)
}
repair := mustStage(t, stages, StageValidatePreviewRepair)
if !reflect.DeepEqual(repair.Inputs, []string{"slides/*.svg"}) {
t.Fatalf("validate_preview_repair Inputs = %v, want slides/*.svg", repair.Inputs)
}
}
func TestDefaultStagesFinalStageRequiresQualityReport(t *testing.T) {
stages := DefaultStages()
final := stages[len(stages)-1]
if final.Name != StageValidatePreviewRepair {
t.Fatalf("final stage = %q, want %q", final.Name, StageValidatePreviewRepair)
}
if !stringSliceContains(final.Outputs, "quality_report.json") {
t.Fatalf("final outputs = %+v, want quality_report.json", final.Outputs)
}
}
func TestDefaultStagesResearchInputsMatchPromptContract(t *testing.T) {
stages := DefaultStages()
research := mustStage(t, stages, StageResearch)
want := []string{"request/request.json", "request/source_manifest.json"}
if !reflect.DeepEqual(research.Inputs, want) {
t.Fatalf("research Inputs = %v, want %v", research.Inputs, want)
}
}
func TestDefaultStagesOutlineInputsMatchPromptContract(t *testing.T) {
stages := DefaultStages()
outline := mustStage(t, stages, StageOutline)
want := []string{"brief/design_brief.json", "brief/visual_system.json"}
if !reflect.DeepEqual(outline.Inputs, want) {
t.Fatalf("outline Inputs = %v, want %v", outline.Inputs, want)
}
}
func TestNewRunDefaultsToCodexRuntime(t *testing.T) {
now := time.Date(2026, 7, 2, 15, 4, 5, 0, time.UTC)
run := NewRun(NewRunConfig{
Title: "Demo",
Input: "source.md",
Audience: "产品和工程负责人",
DeliveryMode: "self_read",
Pages: 8,
Out: ".lark-slides/svglide-runs/demo",
Now: now,
})
if run.Version != 1 {
t.Fatalf("Version = %d, want 1", run.Version)
}
if run.Runtime != "codex" {
t.Fatalf("Runtime = %q, want codex", run.Runtime)
}
if run.Command != "slides +create-svglide" {
t.Fatalf("Command = %q, want slides +create-svglide", run.Command)
}
if run.Title != "Demo" {
t.Fatalf("Title = %q, want Demo", run.Title)
}
if run.Input != "source.md" {
t.Fatalf("Input = %q, want source.md", run.Input)
}
if run.Audience != "产品和工程负责人" {
t.Fatalf("Audience = %q, want 产品和工程负责人", run.Audience)
}
if run.DeliveryMode != "self_read" {
t.Fatalf("DeliveryMode = %q, want self_read", run.DeliveryMode)
}
if run.Pages != 8 {
t.Fatalf("Pages = %d, want 8", run.Pages)
}
if run.Out != ".lark-slides/svglide-runs/demo" {
t.Fatalf("Out = %q, want .lark-slides/svglide-runs/demo", run.Out)
}
wantTS := now.Format(time.RFC3339)
if run.CreatedAt != wantTS {
t.Fatalf("CreatedAt = %q, want %q", run.CreatedAt, wantTS)
}
if run.UpdatedAt != wantTS {
t.Fatalf("UpdatedAt = %q, want %q", run.UpdatedAt, wantTS)
}
if run.CurrentStage != StageRequest {
t.Fatalf("CurrentStage = %q, want %q", run.CurrentStage, StageRequest)
}
wantArtifacts := ArtifactPaths{
Deck: "outline/deck.json",
SlidesDir: "slides",
Preview: "preview.html",
RepairQueue: "repair_queue.md",
}
if run.Artifacts != wantArtifacts {
t.Fatalf("Artifacts = %+v, want %+v", run.Artifacts, wantArtifacts)
}
wantStages := DefaultStages()
if !reflect.DeepEqual(run.Stages, wantStages) {
t.Fatalf("Stages = %+v, want %+v", run.Stages, wantStages)
}
wantPolicy := Policy{
PublishEnabled: false,
NetworkByCodex: true,
ImageGenerationByCodex: true,
Overwrite: false,
}
if run.Policy != wantPolicy {
t.Fatalf("Policy = %+v, want %+v", run.Policy, wantPolicy)
}
}
func mustStage(t *testing.T, stages []Stage, name string) Stage {
t.Helper()
for _, stage := range stages {
if stage.Name == name {
return stage
}
}
t.Fatalf("missing stage %q", name)
return Stage{}
}
func stringSliceContains(values []string, want string) bool {
for _, value := range values {
if value == want {
return true
}
}
return false
}

304
internal/svglide/schema.go Normal file
View File

@@ -0,0 +1,304 @@
package svglide
import (
"bytes"
"encoding/json"
"fmt"
"io"
"math/big"
"path/filepath"
"regexp"
"strings"
)
type liteJSONSchema struct {
Type string `json:"type"`
Required []string `json:"required"`
AdditionalProperties *bool `json:"additionalProperties"`
Properties map[string]liteJSONSchema `json:"properties"`
Items *liteJSONSchema `json:"items"`
MinItems *int `json:"minItems"`
Enum []string `json:"enum"`
Pattern string `json:"pattern"`
}
var stageOutputSchemaPaths = map[string]string{
"request/request.json": "schemas/request.schema.json",
"request/source_manifest.json": "schemas/source_manifest.schema.json",
"research/sources.json": "schemas/sources.schema.json",
"brief/design_brief.json": "schemas/design_brief.schema.json",
"brief/visual_system.json": "schemas/visual_system.schema.json",
"outline/deck.json": "schemas/deck.schema.json",
"content/slide_content.json": "schemas/slide_content.schema.json",
"assets/assets_plan.json": "schemas/assets_plan.schema.json",
"quality_report.json": "schemas/quality.schema.json",
"receipts/lint.json": "schemas/lint.schema.json",
"receipts/preview.json": "schemas/preview.schema.json",
}
func ValidateStageOutputs(root string) error {
safeRoot, run, err := readRun(root)
if err != nil {
return err
}
stage, err := currentStage(run)
if err != nil {
return err
}
for _, output := range stage.Outputs {
if hasGlobMeta(output) || strings.ToLower(filepath.Ext(output)) != ".json" {
continue
}
schemaPath, ok := stageOutputSchemaPaths[output]
if !ok {
continue
}
if err := validateStageOutputSchema(safeRoot, output, schemaPath); err != nil {
return err
}
if output == "outline/deck.json" {
if err := validateDeckSlideOutputPaths(safeRoot, output); err != nil {
return err
}
}
}
return nil
}
func validateDeckSlideOutputPaths(safeRoot string, artifactPath string) error {
raw, err := readRunRegularArtifact(safeRoot, artifactPath)
if err != nil {
return fmt.Errorf("%s: read artifact: %w", artifactPath, err)
}
var deck struct {
Slides []struct {
Path string `json:"path"`
} `json:"slides"`
}
if err := json.Unmarshal(raw, &deck); err != nil {
return fmt.Errorf("%s: invalid JSON: %w", artifactPath, err)
}
for i, slide := range deck.Slides {
if _, err := previewSlideObjectPath(slide.Path); err != nil {
return fmt.Errorf("%s: field slides[%d].path: %w", artifactPath, i, err)
}
}
return nil
}
func validateStageOutputSchema(safeRoot, artifactPath, schemaPath string) error {
artifactRaw, err := readRunRegularArtifact(safeRoot, artifactPath)
if err != nil {
return fmt.Errorf("%s: read artifact: %w", artifactPath, err)
}
schemaRaw, err := readRunRegularArtifact(safeRoot, schemaPath)
if err != nil {
return fmt.Errorf("%s: read schema %s: %w", artifactPath, schemaPath, err)
}
schema, err := decodeLiteJSONSchema(schemaRaw)
if err != nil {
return fmt.Errorf("%s: schema %s: %w", artifactPath, schemaPath, err)
}
value, err := decodeJSONValue(artifactRaw)
if err != nil {
return fmt.Errorf("%s: invalid JSON: %w", artifactPath, err)
}
if err := validateJSONValue(schema, value, ""); err != nil {
return fmt.Errorf("%s: %w", artifactPath, err)
}
return nil
}
func decodeLiteJSONSchema(raw []byte) (liteJSONSchema, error) {
var schema liteJSONSchema
decoder := json.NewDecoder(bytes.NewReader(raw))
if err := decoder.Decode(&schema); err != nil {
return liteJSONSchema{}, fmt.Errorf("invalid JSON: %w", err)
}
if err := rejectTrailingJSON(decoder); err != nil {
return liteJSONSchema{}, err
}
return schema, nil
}
func decodeJSONValue(raw []byte) (any, error) {
decoder := json.NewDecoder(bytes.NewReader(raw))
decoder.UseNumber()
var value any
if err := decoder.Decode(&value); err != nil {
return nil, err
}
if err := rejectTrailingJSON(decoder); err != nil {
return nil, err
}
return value, nil
}
func rejectTrailingJSON(decoder *json.Decoder) error {
var extra any
if err := decoder.Decode(&extra); err != io.EOF {
if err == nil {
return fmt.Errorf("contains trailing JSON value")
}
return err
}
return nil
}
func validateJSONValue(schema liteJSONSchema, value any, fieldPath string) error {
switch schema.Type {
case "":
return nil
case "object":
return validateJSONObject(schema, value, fieldPath)
case "array":
return validateJSONArray(schema, value, fieldPath)
case "string":
return validateJSONString(schema, value, fieldPath)
case "integer":
if !isJSONInteger(value) {
return fmt.Errorf("field %s expected integer, got %s", displayFieldPath(fieldPath), jsonValueType(value))
}
return nil
case "boolean":
if _, ok := value.(bool); !ok {
return fmt.Errorf("field %s expected boolean, got %s", displayFieldPath(fieldPath), jsonValueType(value))
}
return nil
default:
return fmt.Errorf("field %s uses unsupported schema type %q", displayFieldPath(fieldPath), schema.Type)
}
}
func validateJSONObject(schema liteJSONSchema, value any, fieldPath string) error {
object, ok := value.(map[string]any)
if !ok {
return fmt.Errorf("field %s expected object, got %s", displayFieldPath(fieldPath), jsonValueType(value))
}
for _, required := range schema.Required {
if _, ok := object[required]; !ok {
return fmt.Errorf("field %s is required", joinFieldPath(fieldPath, required))
}
}
if schema.AdditionalProperties != nil && !*schema.AdditionalProperties {
for name := range object {
if _, ok := schema.Properties[name]; !ok {
return fmt.Errorf("field %s is not allowed by additionalProperties:false", joinFieldPath(fieldPath, name))
}
}
}
for name, propertySchema := range schema.Properties {
child, ok := object[name]
if !ok {
continue
}
if err := validateJSONValue(propertySchema, child, joinFieldPath(fieldPath, name)); err != nil {
return err
}
}
return nil
}
func validateJSONArray(schema liteJSONSchema, value any, fieldPath string) error {
array, ok := value.([]any)
if !ok {
return fmt.Errorf("field %s expected array, got %s", displayFieldPath(fieldPath), jsonValueType(value))
}
if schema.MinItems != nil && len(array) < *schema.MinItems {
return fmt.Errorf("field %s has %d items, want minItems %d", displayFieldPath(fieldPath), len(array), *schema.MinItems)
}
if schema.Items == nil {
return nil
}
for i, item := range array {
if err := validateJSONValue(*schema.Items, item, joinArrayFieldPath(fieldPath, i)); err != nil {
return err
}
}
return nil
}
func validateJSONString(schema liteJSONSchema, value any, fieldPath string) error {
text, ok := value.(string)
if !ok {
return fmt.Errorf("field %s expected string, got %s", displayFieldPath(fieldPath), jsonValueType(value))
}
if len(schema.Enum) > 0 {
for _, allowed := range schema.Enum {
if text == allowed {
return nil
}
}
return fmt.Errorf("field %s value %q is not in enum %v", displayFieldPath(fieldPath), text, schema.Enum)
}
if schema.Pattern != "" {
matched, err := regexp.MatchString(schema.Pattern, text)
if err != nil {
return fmt.Errorf("field %s has invalid pattern %q: %w", displayFieldPath(fieldPath), schema.Pattern, err)
}
if !matched {
return fmt.Errorf("field %s value %q does not match pattern %q", displayFieldPath(fieldPath), text, schema.Pattern)
}
}
return nil
}
func isJSONInteger(value any) bool {
switch typed := value.(type) {
case json.Number:
return isCanonicalJSONInteger(typed.String())
case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
return true
default:
return false
}
}
func isCanonicalJSONInteger(value string) bool {
if value == "" || strings.ContainsAny(value, ".eE") {
return false
}
var parsed big.Int
_, ok := parsed.SetString(value, 10)
return ok
}
func jsonValueType(value any) string {
switch value.(type) {
case nil:
return "null"
case map[string]any:
return "object"
case []any:
return "array"
case string:
return "string"
case json.Number, float64:
return "number"
case bool:
return "boolean"
default:
return fmt.Sprintf("%T", value)
}
}
func joinFieldPath(parent, name string) string {
if parent == "" {
return name
}
return parent + "." + name
}
func joinArrayFieldPath(parent string, index int) string {
if parent == "" {
return fmt.Sprintf("[%d]", index)
}
return fmt.Sprintf("%s[%d]", parent, index)
}
func displayFieldPath(path string) string {
if path == "" {
return "$"
}
return path
}

View File

@@ -0,0 +1,326 @@
package svglide
import (
"os"
"path/filepath"
"strings"
"testing"
)
func TestValidateStageOutputsRejectsMissingRequiredField(t *testing.T) {
initStatusTestRun(t)
if err := os.WriteFile(filepath.Join("demo", "request", "request.json"), []byte(`{"title":"Demo"}`), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected schema validation error")
}
if !strings.Contains(err.Error(), "request/request.json") || !strings.Contains(err.Error(), "input") {
t.Fatalf("error = %v, want path and missing field", err)
}
}
func TestValidateStageOutputsAcceptsCurrentRequestArtifacts(t *testing.T) {
initStatusTestRun(t)
if err := ValidateStageOutputs("demo"); err != nil {
t.Fatal(err)
}
}
func TestValidateStageOutputsRejectsDeckSlidePathsThatPreviewRejects(t *testing.T) {
for _, path := range []string{"slides/a%20.svg", "slides/.hidden.svg", "slides/a..b.svg", "slides/a:b.svg"} {
t.Run(path, func(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageOutline)
mustWriteTestFile(t, "demo/outline/deck.json", validSchemaDeckJSON(path))
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected deck slide path validation error")
}
if !strings.Contains(err.Error(), "outline/deck.json") || !strings.Contains(err.Error(), "slides[0].path") {
t.Fatalf("error = %v, want deck path context", err)
}
})
}
}
func TestCompleteCurrentStageRejectsInvalidDeckSlidePath(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageOutline)
mustWriteTestFile(t, "demo/outline/deck.json", validSchemaDeckJSON("slides/a%20.svg"))
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected deck slide path validation error")
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageOutline {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageOutline)
}
if got := stageStatus(t, run, StageOutline); got == StatusDone {
t.Fatalf("outline stage status = %q, want not %q", got, StatusDone)
}
if _, statErr := os.Stat(filepath.Join("demo", "receipts", "outline.json")); !os.IsNotExist(statErr) {
t.Fatalf("outline receipt should not be written, stat err = %v", statErr)
}
}
func TestValidateStageOutputsRejectsInvalidValidatePreviewRepairReceipts(t *testing.T) {
tests := []struct {
name string
setup func(t *testing.T)
path string
}{
{
name: "lint",
setup: func(t *testing.T) {
t.Helper()
if err := os.WriteFile(filepath.Join("demo", "receipts", "lint.json"), []byte(`{"status":"failed"}`), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "quality_report.json"), []byte(validQualityReportJSON()), 0o644); err != nil {
t.Fatal(err)
}
},
path: "receipts/lint.json",
},
{
name: "preview",
setup: func(t *testing.T) {
t.Helper()
if err := os.WriteFile(filepath.Join("demo", "receipts", "lint.json"), []byte(`{"status":"passed","issues":[]}`), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "receipts", "preview.json"), []byte(`{"status":"passed","slides":[{"path":"slides/01.svg","rendered":"yes"}]}`), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "quality_report.json"), []byte(validQualityReportJSON()), 0o644); err != nil {
t.Fatal(err)
}
},
path: "receipts/preview.json",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageValidatePreviewRepair)
tt.setup(t)
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected schema validation error")
}
if !strings.Contains(err.Error(), tt.path) {
t.Fatalf("error = %v, want path %s", err, tt.path)
}
})
}
}
func TestValidateStageOutputsRejectsInvalidQualityReportSchema(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageValidatePreviewRepair)
if err := os.WriteFile(filepath.Join("demo", "receipts", "lint.json"), []byte(`{"status":"passed","issues":[]}`), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "receipts", "preview.json"), []byte(`{"status":"passed","slides":[{"path":"slides/01.svg","rendered":true}]}`), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "quality_report.json"), []byte(`{"status":"passed","issues":[],"metrics":{"slides":1,"sources":1,"web_sources":0,"assets":0,"slides_with_source_refs":1}}`), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected quality report schema validation error")
}
if !strings.Contains(err.Error(), "quality_report.json") {
t.Fatalf("error = %v, want path quality_report.json", err)
}
}
func TestValidateStageOutputsRejectsSourcesMissingRetrieval(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageResearch)
if err := os.WriteFile(filepath.Join("demo", "research", "sources.json"), []byte(`{"sources":[{"id":"s1","path":"https://example.com","title":"Example","excerpt":"Ex","usage":"supporting evidence"}]}`), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected retrieval schema validation error")
}
if !strings.Contains(err.Error(), "research/sources.json") || !strings.Contains(err.Error(), "retrieval") {
t.Fatalf("error = %v, want research/sources.json and retrieval", err)
}
}
func TestValidateStageOutputsRejectsSlideContentMissingSourceRefsOrVisualIds(t *testing.T) {
tests := []struct {
name string
raw string
want string
}{
{
name: "missing source_refs",
raw: `{"slides":[{"id":"s1","content":"Plan","visuals":[{"id":"v1","type":"none","instruction":"No visual needed"}]}]}`,
want: "source_refs",
},
{
name: "missing visual id",
raw: `{"slides":[{"id":"s1","content":"Plan","source_refs":["s1"],"visuals":[{"type":"none","instruction":"No visual needed"}]}]}`,
want: "visuals[0].id",
},
{
name: "empty visuals",
raw: `{"slides":[{"id":"s1","content":"Plan","source_refs":["s1"],"visuals":[]}]}`,
want: "visuals",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageSlideContent)
if err := os.WriteFile(filepath.Join("demo", "content", "slide_content.json"), []byte(tt.raw), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected slide content schema validation error")
}
if !strings.Contains(err.Error(), "content/slide_content.json") || !strings.Contains(err.Error(), tt.want) {
t.Fatalf("error = %v, want content/slide_content.json and %s", err, tt.want)
}
})
}
}
func TestValidateStageOutputsRejectsAssetsMissingStatus(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageAssets)
if err := os.WriteFile(filepath.Join("demo", "assets", "assets_plan.json"), []byte(`{"mode":"experiment_unrestricted_assets","assets":[{"id":"a1","slide_id":"s1","type":"image","path":"https://example.com/a.png","usage":"hero image"}]}`), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected asset schema validation error")
}
if !strings.Contains(err.Error(), "assets/assets_plan.json") || !strings.Contains(err.Error(), "status") {
t.Fatalf("error = %v, want assets/assets_plan.json and status", err)
}
}
func TestValidateStageOutputsAcceptsExperimentAssetPaths(t *testing.T) {
tests := []struct {
name string
path string
}{
{name: "outside images", path: "../a.png"},
{name: "dot dot filename", path: "assets/images/hero..png"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageAssets)
if err := os.WriteFile(filepath.Join("demo", "assets", "assets_plan.json"), []byte(`{"mode":"experiment_unrestricted_assets","assets":[{"id":"a1","slide_id":"s1","type":"image","path":"`+tt.path+`","usage":"hero image","status":"ready"}]}`), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err != nil {
t.Fatalf("expected experiment asset path to pass schema validation, got %v", err)
}
})
}
}
func TestDefaultSchemasIncludeAnyGenQualityContracts(t *testing.T) {
schemas := DefaultSchemas()
for _, name := range []string{
"sources.schema.json",
"slide_content.schema.json",
"assets_plan.schema.json",
"quality.schema.json",
} {
if strings.TrimSpace(schemas[name]) == "" {
t.Fatalf("schema %s is missing", name)
}
}
if !strings.Contains(schemas["sources.schema.json"], `"retrieval"`) {
t.Fatalf("sources schema missing retrieval contract: %s", schemas["sources.schema.json"])
}
if !strings.Contains(schemas["slide_content.schema.json"], `"source_refs"`) {
t.Fatalf("slide content schema missing source_refs: %s", schemas["slide_content.schema.json"])
}
if !strings.Contains(schemas["slide_content.schema.json"], `"visuals"`) {
t.Fatalf("slide content schema missing visuals: %s", schemas["slide_content.schema.json"])
}
if !strings.Contains(schemas["assets_plan.schema.json"], `"slide_id"`) {
t.Fatalf("assets schema missing slide_id: %s", schemas["assets_plan.schema.json"])
}
for _, want := range []string{`"experiment_unrestricted_assets"`, `"chart"`, `"table"`, `"crop"`, `"deferred"`} {
if !strings.Contains(schemas["assets_plan.schema.json"], want) {
t.Fatalf("assets schema missing %s: %s", want, schemas["assets_plan.schema.json"])
}
}
if !strings.Contains(schemas["quality.schema.json"], `"metrics"`) {
t.Fatalf("quality schema missing metrics: %s", schemas["quality.schema.json"])
}
}
func validSchemaDeckJSON(path string) string {
return `{"main_title":"Demo Deck","style_instruction":{"aesthetic_direction":"Editorial report","color_palette":{},"typography":{}},"slides":[{"id":"s1","title":"First claim","summary":"First summary","role":"cover","key_message":"First key message","path":"` + path + `"}]}`
}
func validQualityReportJSON() string {
return `{"status":"passed","issues":[],"metrics":{"slides":1,"sources":1,"web_sources":0,"assets":0,"slides_with_source_refs":1,"slides_with_visuals":1}}`
}
func TestValidateStageOutputsRejectsNonCanonicalIntegers(t *testing.T) {
for _, pages := range []string{"8.0", "8e0", "0.99999999999999999"} {
t.Run(pages, func(t *testing.T) {
initStatusTestRun(t)
raw := `{"title":"Demo","input":"source.md","pages":` + pages + `}`
if err := os.WriteFile(filepath.Join("demo", "request", "request.json"), []byte(raw), 0o644); err != nil {
t.Fatal(err)
}
err := ValidateStageOutputs("demo")
if err == nil {
t.Fatal("expected schema validation error")
}
if !strings.Contains(err.Error(), "request/request.json") || !strings.Contains(err.Error(), "pages") {
t.Fatalf("error = %v, want path and pages field", err)
}
})
}
}
func TestCompleteCurrentStageRejectsInvalidCurrentStageOutputSchema(t *testing.T) {
initStatusTestRun(t)
if err := os.WriteFile(filepath.Join("demo", "request", "source_manifest.json"), []byte(`{"sources":[{"path":"source.md","type":"remote"}]}`), 0o644); err != nil {
t.Fatal(err)
}
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected schema validation error")
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageRequest {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageRequest)
}
if got := stageStatus(t, run, StageRequest); got == StatusDone {
t.Fatalf("request stage status = %q, want not %q", got, StatusDone)
}
if _, statErr := os.Stat(filepath.Join("demo", "receipts", "request.json")); !os.IsNotExist(statErr) {
t.Fatalf("receipt should not be written, stat err = %v", statErr)
}
}

120
internal/svglide/stage.go Normal file
View File

@@ -0,0 +1,120 @@
package svglide
import (
"encoding/json"
"fmt"
"path/filepath"
"strings"
"time"
)
type StageReceipt struct {
Stage string `json:"stage"`
Status string `json:"status"`
Message string `json:"message,omitempty"`
Artifacts []string `json:"artifacts,omitempty"`
}
func CompleteCurrentStage(root string) (StatusReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return StatusReport{}, err
}
index, stage, err := currentStageWithIndex(run)
if err != nil {
return StatusReport{}, err
}
missingOutputs, err := missingRunPaths(safeRoot, stage.Outputs)
if err != nil {
return StatusReport{}, err
}
if len(missingOutputs) > 0 {
return StatusReport{}, fmt.Errorf("current stage %q missing outputs: %s", stage.Name, strings.Join(missingOutputs, ", "))
}
if err := ValidateStageOutputs(root); err != nil {
return StatusReport{}, err
}
if stage.Name == StageValidatePreviewRepair {
if err := validateFinalStageReceiptsPassed(safeRoot); err != nil {
return StatusReport{}, err
}
}
if err := writeStageReceipt(safeRoot, StageReceipt{
Stage: stage.Name,
Status: StatusDone,
Artifacts: stage.Outputs,
}); err != nil {
return StatusReport{}, err
}
run.Stages[index].Status = StatusDone
if index < len(run.Stages)-1 {
nextStage := &run.Stages[index+1]
run.CurrentStage = nextStage.Name
if nextStage.Status == "" {
nextStage.Status = StatusPending
}
} else {
run.CurrentStage = stage.Name
}
run.UpdatedAt = time.Now().Format(time.RFC3339)
if err := writeRunFile(safeRoot, run); err != nil {
return StatusReport{}, err
}
return InspectStatus(root)
}
type stageStatusReceipt struct {
Status string `json:"status"`
}
func validateFinalStageReceiptsPassed(safeRoot string) error {
for _, path := range []string{"receipts/lint.json", "receipts/preview.json", "quality_report.json"} {
raw, err := readRunRegularArtifact(safeRoot, path)
if err != nil {
return fmt.Errorf("%s: read receipt: %w", path, err)
}
var receipt stageStatusReceipt
if err := json.Unmarshal(raw, &receipt); err != nil {
return fmt.Errorf("%s: invalid JSON: %w", path, err)
}
if receipt.Status != "passed" {
return fmt.Errorf("%s: status is %q, want passed", path, receipt.Status)
}
}
return nil
}
func currentStageWithIndex(run Run) (int, Stage, error) {
for i, stage := range run.Stages {
if stage.Name == run.CurrentStage {
return i, stage, nil
}
}
return -1, Stage{}, fmt.Errorf("current stage %q not found in run", run.CurrentStage)
}
func writeRunFile(safeRoot string, run Run) error {
target, err := ensureRunFileTargetForWrite(safeRoot, "run.json")
if err != nil {
return err
}
return writeJSON(target, run)
}
func writeStageReceipt(safeRoot string, receipt StageReceipt) error {
if strings.TrimSpace(receipt.Stage) == "" {
return fmt.Errorf("stage receipt stage must not be empty")
}
if strings.ContainsAny(receipt.Stage, `/\`) || receipt.Stage == "." || receipt.Stage == ".." {
return fmt.Errorf("stage receipt stage %q must be a file name", receipt.Stage)
}
target, err := ensureRunFileTargetForWrite(safeRoot, filepath.Join("receipts", receipt.Stage+".json"))
if err != nil {
return err
}
return writeJSON(target, receipt)
}

View File

@@ -0,0 +1,148 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
)
func TestCompleteCurrentStageAdvancesToNextStage(t *testing.T) {
initStatusTestRun(t)
status, err := CompleteCurrentStage("demo")
if err != nil {
t.Fatal(err)
}
if status.CurrentStage != StageResearch {
t.Fatalf("CurrentStage = %q, want %q", status.CurrentStage, StageResearch)
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageResearch {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageResearch)
}
if got := stageStatus(t, run, StageRequest); got != StatusDone {
t.Fatalf("request stage status = %q, want %q", got, StatusDone)
}
if got := stageStatus(t, run, StageResearch); got != StatusPending {
t.Fatalf("research stage status = %q, want %q", got, StatusPending)
}
raw, err := os.ReadFile(filepath.Join("demo", "receipts", "request.json"))
if err != nil {
t.Fatalf("missing request receipt: %v", err)
}
var receipt StageReceipt
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatalf("invalid request receipt: %v", err)
}
if receipt.Stage != StageRequest || receipt.Status != StatusDone {
t.Fatalf("receipt = %+v, want request done", receipt)
}
}
func TestCompleteCurrentStageRejectsMissingOutput(t *testing.T) {
initStatusTestRun(t)
if err := os.Remove(filepath.Join("demo", "request", "source_manifest.json")); err != nil {
t.Fatal(err)
}
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected missing output error")
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageRequest {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageRequest)
}
}
func TestCompleteCurrentStageDoesNotAdvanceRunWhenReceiptWriteFails(t *testing.T) {
initStatusTestRun(t)
if err := os.Mkdir(filepath.Join("demo", "receipts", "request.json"), 0o755); err != nil {
t.Fatal(err)
}
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected receipt write error")
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageRequest {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageRequest)
}
if got := stageStatus(t, run, StageRequest); got == StatusDone {
t.Fatalf("request stage status = %q, want not %q", got, StatusDone)
}
}
func TestCompleteCurrentStageRejectsFailedValidatePreviewRepairReceipts(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageValidatePreviewRepair)
mustWriteTestFile(t, "demo/slides/01.svg", visibleTextSVG())
mustWriteTestFile(t, "demo/receipts/lint.json", `{"status":"failed","issues":[]}`)
mustWriteTestFile(t, "demo/receipts/preview.json", `{"status":"failed","slides":[{"path":"slides/01.svg","rendered":false}]}`)
mustWriteTestFile(t, "demo/quality_report.json", `{"status":"passed","issues":[],"metrics":{"slides":1,"sources":1,"web_sources":1,"assets":0,"slides_with_source_refs":1,"slides_with_visuals":0}}`)
mustWriteTestFile(t, "demo/repair_queue.md", "# repair\n")
mustWriteTestFile(t, "demo/preview.html", "<!doctype html><title>preview</title>")
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected failed lint/preview receipts to block completion")
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageValidatePreviewRepair {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageValidatePreviewRepair)
}
if got := stageStatus(t, run, StageValidatePreviewRepair); got == StatusDone {
t.Fatalf("validate stage status = %q, want not %q", got, StatusDone)
}
if _, statErr := os.Stat(filepath.Join("demo", "receipts", "validate_preview_repair.json")); !os.IsNotExist(statErr) {
t.Fatalf("final receipt should not be written, stat err = %v", statErr)
}
}
func TestCompleteCurrentStageRejectsFailedQualityReport(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageValidatePreviewRepair)
mustWriteTestFile(t, "demo/slides/01.svg", visibleTextSVG())
mustWriteTestFile(t, "demo/receipts/lint.json", `{"status":"passed","issues":[]}`)
mustWriteTestFile(t, "demo/receipts/preview.json", `{"status":"passed","slides":[{"path":"slides/01.svg","rendered":true}]}`)
mustWriteTestFile(t, "demo/quality_report.json", `{"status":"failed","issues":[],"metrics":{"slides":1,"sources":1,"web_sources":0,"assets":0,"slides_with_source_refs":1,"slides_with_visuals":0}}`)
mustWriteTestFile(t, "demo/repair_queue.md", "# repair\n")
mustWriteTestFile(t, "demo/preview.html", "<!doctype html><title>preview</title>")
_, err := CompleteCurrentStage("demo")
if err == nil {
t.Fatal("expected failed quality report to block completion")
}
if !strings.Contains(err.Error(), "quality_report.json") && !strings.Contains(err.Error(), "status is \"failed\"") {
t.Fatalf("error = %v, want quality report failure", err)
}
run := readStatusTestRunFile(t)
if run.CurrentStage != StageValidatePreviewRepair {
t.Fatalf("run.CurrentStage = %q, want %q", run.CurrentStage, StageValidatePreviewRepair)
}
if got := stageStatus(t, run, StageValidatePreviewRepair); got == StatusDone {
t.Fatalf("validate stage status = %q, want not %q", got, StatusDone)
}
if _, statErr := os.Stat(filepath.Join("demo", "receipts", "validate_preview_repair.json")); !os.IsNotExist(statErr) {
t.Fatalf("final receipt should not be written, stat err = %v", statErr)
}
}
func stageStatus(t *testing.T, run Run, name string) string {
t.Helper()
for _, stage := range run.Stages {
if stage.Name == name {
return stage.Status
}
}
t.Fatalf("missing stage %q", name)
return ""
}

382
internal/svglide/status.go Normal file
View File

@@ -0,0 +1,382 @@
package svglide
import (
"encoding/json"
"errors"
"fmt"
"io/fs"
"path/filepath"
"strings"
"github.com/larksuite/cli/internal/validate"
"github.com/larksuite/cli/internal/vfs"
)
type StatusReport struct {
CurrentStage string `json:"current_stage"`
MissingInputs []string `json:"missing_inputs"`
MissingOutputs []string `json:"missing_outputs"`
NextCommand string `json:"next_command"`
}
type NextTaskReport struct {
Stage string `json:"stage"`
Mode string `json:"mode"`
ApprovalRequired bool `json:"approval_required"`
BlockingOwner string `json:"blocking_owner"`
BlockingReason string `json:"blocking_reason,omitempty"`
PromptPath string `json:"prompt_path,omitempty"`
PromptPaths []string `json:"prompt_paths"`
AdapterPaths []string `json:"adapter_paths"`
PromptManifest string `json:"prompt_manifest"`
Inputs []string `json:"inputs"`
Outputs []string `json:"outputs"`
}
const (
createSVGlideAdapterPath = "skills/lark-slides/references/lark-slides-create-svglide.md"
svglideExecutionMode = "execution"
svglideBlockingOwner = "svglide-runtime"
)
func ReadRun(root string) (Run, error) {
safeRoot, err := validate.SafeInputPath(root)
if err != nil {
return Run{}, err
}
return readRunFile(safeRoot)
}
func InspectStatus(root string) (StatusReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return StatusReport{}, err
}
stage, err := currentStage(run)
if err != nil {
return StatusReport{}, err
}
missingInputs, err := missingRunPaths(safeRoot, stage.Inputs)
if err != nil {
return StatusReport{}, err
}
missingOutputs, err := missingRunPaths(safeRoot, stage.Outputs)
if err != nil {
return StatusReport{}, err
}
return StatusReport{
CurrentStage: stage.Name,
MissingInputs: missingInputs,
MissingOutputs: missingOutputs,
NextCommand: fmt.Sprintf("lark-cli slides +create-svglide --action next --run %s", shellQuote(root)),
}, nil
}
func NextTask(root string) (NextTaskReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return NextTaskReport{}, err
}
stage, err := currentStage(run)
if err != nil {
return NextTaskReport{}, err
}
missingInputs, err := missingRunPaths(safeRoot, stage.Inputs)
if err != nil {
return NextTaskReport{}, err
}
if len(missingInputs) > 0 {
return NextTaskReport{}, fmt.Errorf("current stage %q missing inputs: %s", stage.Name, strings.Join(missingInputs, ", "))
}
inputs, err := validateRunPaths(safeRoot, stage.Inputs)
if err != nil {
return NextTaskReport{}, err
}
outputs, err := validateRunPaths(safeRoot, stage.Outputs)
if err != nil {
return NextTaskReport{}, err
}
return NextTaskReport{
Stage: stage.Name,
Mode: svglideExecutionMode,
ApprovalRequired: false,
BlockingOwner: svglideBlockingOwner,
PromptPaths: PromptPathsForStage(stage.Name),
AdapterPaths: []string{createSVGlideAdapterPath},
PromptManifest: "prompt_manifest.json",
Inputs: inputs,
Outputs: outputs,
}, nil
}
func readRun(root string) (string, Run, error) {
safeRoot, err := validate.SafeInputPath(root)
if err != nil {
return "", Run{}, err
}
run, err := readRunFile(safeRoot)
if err != nil {
return "", Run{}, err
}
return safeRoot, run, nil
}
func readRunFile(safeRoot string) (Run, error) {
raw, err := vfs.ReadFile(filepath.Join(safeRoot, "run.json"))
if err != nil {
return Run{}, err
}
var run Run
if err := json.Unmarshal(raw, &run); err != nil {
return Run{}, fmt.Errorf("read run.json: %w", err)
}
return run, nil
}
func currentStage(run Run) (Stage, error) {
for _, stage := range run.Stages {
if stage.Name == run.CurrentStage {
return stage, nil
}
}
return Stage{}, fmt.Errorf("current stage %q not found in run", run.CurrentStage)
}
func missingRunPaths(safeRoot string, rels []string) ([]string, error) {
var missing []string
for _, rel := range rels {
if hasGlobMeta(rel) {
exists, err := runGlobExists(safeRoot, rel)
if err != nil {
return nil, err
}
if !exists {
missing = append(missing, rel)
}
continue
}
exists, err := runRegularFileExists(safeRoot, rel)
if err != nil {
return nil, fmt.Errorf("lstat run path %q: %w", rel, err)
}
if !exists {
missing = append(missing, rel)
}
}
return missing, nil
}
func validateRunPaths(safeRoot string, rels []string) ([]string, error) {
paths := make([]string, 0, len(rels))
for _, rel := range rels {
if hasGlobMeta(rel) {
if _, _, _, err := validateRunGlobPattern(safeRoot, rel); err != nil {
return nil, err
}
} else {
if _, err := safeRunPath(safeRoot, rel); err != nil {
return nil, err
}
}
paths = append(paths, rel)
}
return paths, nil
}
func runGlobExists(safeRoot, rel string) (bool, error) {
dirRel, pattern, dirPath, err := validateRunGlobPattern(safeRoot, rel)
if err != nil {
return false, err
}
dirPath, exists, err := runDirectoryExists(safeRoot, dirRel)
if err != nil {
return false, fmt.Errorf("lstat glob directory for %q: %w", rel, err)
}
if !exists {
return false, nil
}
entries, err := vfs.ReadDir(dirPath)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
return false, nil
}
return false, fmt.Errorf("read glob directory for %q: %w", rel, err)
}
for _, entry := range entries {
matched, err := filepath.Match(pattern, entry.Name())
if err != nil {
return false, fmt.Errorf("invalid glob pattern %q: %w", rel, err)
}
if !matched {
continue
}
matchRel := filepath.Join(dirRel, entry.Name())
exists, err := runRegularFileExists(safeRoot, matchRel)
if err != nil {
return false, fmt.Errorf("lstat glob match %q: %w", matchRel, err)
}
if exists {
return true, nil
}
}
return false, nil
}
func validateRunGlobPattern(safeRoot, rel string) (string, string, string, error) {
if strings.TrimSpace(rel) == "" {
return "", "", "", fmt.Errorf("run path must not be empty")
}
if isAbsoluteRunPath(rel) {
return "", "", "", fmt.Errorf("run path %q must be relative to run root", rel)
}
cleanRel := filepath.Clean(rel)
dirRel, pattern := filepath.Split(cleanRel)
dirRel = strings.TrimSuffix(dirRel, string(filepath.Separator))
if pattern == "" {
return "", "", "", fmt.Errorf("glob path %q is missing a file pattern", rel)
}
if _, err := filepath.Match(pattern, ""); err != nil {
return "", "", "", fmt.Errorf("invalid glob pattern %q: %w", rel, err)
}
if dirRel == "" {
dirRel = "."
}
if hasGlobMeta(dirRel) {
return "", "", "", fmt.Errorf("glob path %q is only supported in the file name", rel)
}
dirPath, err := safeRunPath(safeRoot, dirRel)
if err != nil {
return "", "", "", err
}
return dirRel, pattern, dirPath, nil
}
func runDirectoryExists(safeRoot, rel string) (string, bool, error) {
info, path, exists, err := lstatRunPath(safeRoot, rel)
if err != nil {
return path, false, err
}
if !exists {
return path, false, nil
}
if !info.IsDir() {
return path, false, fmt.Errorf("run path %q is not a directory", rel)
}
return path, true, nil
}
func runRegularFileExists(safeRoot, rel string) (bool, error) {
info, _, exists, err := lstatRunPath(safeRoot, rel)
if err != nil {
return false, err
}
if !exists {
return false, nil
}
return info.Mode().IsRegular(), nil
}
func lstatRunPath(safeRoot, rel string) (fs.FileInfo, string, bool, error) {
path, err := safeRunPath(safeRoot, rel)
if err != nil {
return nil, "", false, err
}
cleanRel := filepath.Clean(rel)
if cleanRel == "." {
info, err := vfs.Lstat(path)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
return nil, path, false, nil
}
return nil, path, false, err
}
if info.Mode()&fs.ModeSymlink != 0 {
return nil, path, false, nil
}
return info, path, true, nil
}
parts := strings.Split(cleanRel, string(filepath.Separator))
cur := safeRoot
var info fs.FileInfo
for i, part := range parts {
if part == "" || part == "." {
continue
}
cur = filepath.Join(cur, part)
info, err = vfs.Lstat(cur)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
return nil, path, false, nil
}
return nil, path, false, err
}
if info.Mode()&fs.ModeSymlink != 0 {
return nil, path, false, nil
}
if i < len(parts)-1 && !info.IsDir() {
return nil, path, false, fmt.Errorf("run path component %q is not a directory", filepath.Join(parts[:i+1]...))
}
}
if info == nil {
return nil, path, false, nil
}
return info, path, true, nil
}
func hasGlobMeta(path string) bool {
return strings.ContainsAny(path, "*?[")
}
func safeRunPath(safeRoot, rel string) (string, error) {
if strings.TrimSpace(rel) == "" {
return "", fmt.Errorf("run path must not be empty")
}
if isAbsoluteRunPath(rel) {
return "", fmt.Errorf("run path %q must be relative to run root", rel)
}
cleanRel := filepath.Clean(rel)
path := filepath.Clean(filepath.Join(safeRoot, cleanRel))
rootRel, err := filepath.Rel(safeRoot, path)
if err != nil {
return "", fmt.Errorf("cannot compare run path %q with run root: %w", rel, err)
}
if rootRel == ".." || strings.HasPrefix(rootRel, ".."+string(filepath.Separator)) || filepath.IsAbs(rootRel) {
return "", fmt.Errorf("run path %q escapes run root", rel)
}
return path, nil
}
func isAbsoluteRunPath(path string) bool {
path = strings.TrimSpace(path)
if filepath.IsAbs(path) || strings.HasPrefix(path, "/") || strings.HasPrefix(path, `\`) {
return true
}
if len(path) >= 3 && path[1] == ':' && (path[2] == '/' || path[2] == '\\') {
drive := path[0]
return ('A' <= drive && drive <= 'Z') || ('a' <= drive && drive <= 'z')
}
return false
}
func shellQuote(value string) string {
if value == "" {
return "''"
}
if isShellBareword(value) {
return value
}
return "'" + strings.ReplaceAll(value, "'", "'\\''") + "'"
}
func isShellBareword(value string) bool {
for _, r := range value {
if ('a' <= r && r <= 'z') || ('A' <= r && r <= 'Z') || ('0' <= r && r <= '9') {
continue
}
if strings.ContainsRune("_@%+=:,./-", r) {
continue
}
return false
}
return true
}

View File

@@ -0,0 +1,497 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"slices"
"strings"
"testing"
)
func TestStatusReportsMissingOutputs(t *testing.T) {
initStatusTestRun(t)
if err := os.Remove(filepath.Join("demo", "request", "source_manifest.json")); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if status.CurrentStage != StageRequest {
t.Fatalf("CurrentStage = %q, want %q", status.CurrentStage, StageRequest)
}
if !slices.Contains(status.MissingOutputs, "request/source_manifest.json") {
t.Fatalf("MissingOutputs = %v, want request/source_manifest.json", status.MissingOutputs)
}
if len(status.MissingInputs) != 0 {
t.Fatalf("MissingInputs = %v, want empty", status.MissingInputs)
}
if status.NextCommand != "lark-cli slides +create-svglide --action next --run demo" {
t.Fatalf("NextCommand = %q, want --action next shortcut with caller root", status.NextCommand)
}
}
func TestStatusQuotesNextCommandRunPath(t *testing.T) {
tests := []struct {
root string
want string
}{
{
root: "demo dir",
want: "lark-cli slides +create-svglide --action next --run 'demo dir'",
},
{
root: "demo' dir",
want: "lark-cli slides +create-svglide --action next --run 'demo'\\'' dir'",
},
{
root: "demo trail ",
want: "lark-cli slides +create-svglide --action next --run 'demo trail '",
},
}
for _, tt := range tests {
t.Run(tt.root, func(t *testing.T) {
cwd := initStatusTestRunAt(t, tt.root)
status, err := InspectStatus(tt.root)
if err != nil {
t.Fatal(err)
}
if status.NextCommand != tt.want {
t.Fatalf("NextCommand = %q, want %q", status.NextCommand, tt.want)
}
if strings.Contains(status.NextCommand, cwd) {
t.Fatalf("NextCommand = %q, should not contain absolute safe root %q", status.NextCommand, cwd)
}
})
}
}
func TestNextTaskReturnsAnyGenPromptAssets(t *testing.T) {
initStatusTestRun(t)
next, err := NextTask("demo")
if err != nil {
t.Fatal(err)
}
if next.Stage != StageRequest {
t.Fatalf("Stage = %q, want %q", next.Stage, StageRequest)
}
if next.PromptManifest != "prompt_manifest.json" {
t.Fatalf("PromptManifest = %q, want prompt_manifest.json", next.PromptManifest)
}
if next.PromptPath != "" {
t.Fatalf("PromptPath = %q, want empty deprecated field", next.PromptPath)
}
got := strings.Join(next.PromptPaths, "\n")
for _, want := range []string{
"skills/lark-slides/references/anygen-svg/mode_system_prompt_svg.md",
"skills/lark-slides/references/anygen-svg/svg_reference.md",
} {
if !strings.Contains(got, want) {
t.Fatalf("PromptPaths missing %q:\n%s", want, got)
}
}
if len(next.Inputs) != 0 {
t.Fatalf("Inputs = %v, want empty", next.Inputs)
}
if !slices.Equal(next.Outputs, []string{"request/request.json", "request/source_manifest.json"}) {
t.Fatalf("Outputs = %v, want request outputs", next.Outputs)
}
}
func TestNextTaskSeparatesAnyGenPromptsFromRuntimeAdapter(t *testing.T) {
initStatusTestRun(t)
next, err := NextTask("demo")
if err != nil {
t.Fatalf("NextTask: %v", err)
}
gotPrompts := strings.Join(next.PromptPaths, "\n")
if strings.Contains(gotPrompts, "lark-slides-create-svglide.md") {
t.Fatalf("PromptPaths should contain AnyGen assets only, got:\n%s", gotPrompts)
}
if !strings.Contains(gotPrompts, "skills/lark-slides/references/anygen-svg/README.md") {
t.Fatalf("PromptPaths missing AnyGen README:\n%s", gotPrompts)
}
if len(next.AdapterPaths) != 1 || next.AdapterPaths[0] != "skills/lark-slides/references/lark-slides-create-svglide.md" {
t.Fatalf("AdapterPaths = %#v, want create-svglide adapter", next.AdapterPaths)
}
}
func TestNextTaskDeclaresExecutionModeWithoutApprovalGate(t *testing.T) {
initStatusTestRun(t)
next, err := NextTask("demo")
if err != nil {
t.Fatalf("NextTask: %v", err)
}
if next.Mode != "execution" {
t.Fatalf("Mode = %q, want execution", next.Mode)
}
if next.ApprovalRequired {
t.Fatalf("ApprovalRequired = true, want false")
}
if next.BlockingOwner != "svglide-runtime" {
t.Fatalf("BlockingOwner = %q, want svglide-runtime", next.BlockingOwner)
}
if next.BlockingReason != "" {
t.Fatalf("BlockingReason = %q, want empty", next.BlockingReason)
}
}
func TestInspectStatusRejectsUnsafeRunPath(t *testing.T) {
t.Chdir(t.TempDir())
if _, err := InspectStatus("../escape"); err == nil {
t.Fatal("expected unsafe run path refusal")
}
}
func TestReadRunReadsRunJSONAndRejectsAbsoluteRunPath(t *testing.T) {
cwd := initStatusTestRun(t)
run, err := ReadRun("demo")
if err != nil {
t.Fatal(err)
}
if run.Title != "Demo" || run.CurrentStage != StageRequest {
t.Fatalf("unexpected run: %+v", run)
}
if _, err := ReadRun(filepath.Join(cwd, "demo")); err == nil {
t.Fatal("expected absolute run path refusal")
}
}
func TestInspectStatusRejectsEscapingStagePath(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageRequest, []string{"../outside.json"})
writeStatusTestRunFile(t, run)
if _, err := InspectStatus("demo"); err == nil {
t.Fatal("expected escaping stage output path refusal")
}
}
func TestInspectStatusReturnsStatErrorsThatAreNotMissing(t *testing.T) {
initStatusTestRun(t)
if err := os.RemoveAll(filepath.Join("demo", "request")); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join("demo", "request"), []byte("not a directory"), 0o644); err != nil {
t.Fatal(err)
}
if _, err := InspectStatus("demo"); err == nil {
t.Fatal("expected stat error when output parent is a file")
}
}
func TestInspectStatusReportsDirectoryArtifactAsMissing(t *testing.T) {
initStatusTestRun(t)
path := filepath.Join("demo", "request", "source_manifest.json")
if err := os.Remove(path); err != nil {
t.Fatal(err)
}
if err := os.Mkdir(path, 0o755); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "request/source_manifest.json") {
t.Fatalf("MissingOutputs = %v, want directory artifact to be missing", status.MissingOutputs)
}
}
func TestNextTaskRejectsEscapingStagePath(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageRequest, []string{"../outside.json"})
writeStatusTestRunFile(t, run)
if _, err := NextTask("demo"); err == nil {
t.Fatal("expected escaping stage output path refusal")
}
}
func TestNextTaskRejectsMissingCurrentStageInputs(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
run.CurrentStage = StageDesignBrief
writeStatusTestRunFile(t, run)
if _, err := NextTask("demo"); err == nil {
t.Fatal("expected missing current stage inputs to reject next task")
}
}
func TestNextTaskRejectsResearchMissingSourceManifest(t *testing.T) {
initStatusTestRun(t)
if err := os.Remove(filepath.Join("demo", "request", "source_manifest.json")); err != nil {
t.Fatal(err)
}
run := readStatusTestRunFile(t)
run.CurrentStage = StageResearch
writeStatusTestRunFile(t, run)
if _, err := NextTask("demo"); err == nil {
t.Fatal("expected missing research source manifest to reject next task")
}
}
func TestNextTaskRejectsOutlineMissingVisualSystem(t *testing.T) {
initStatusTestRun(t)
if err := os.WriteFile(filepath.Join("demo", "brief", "design_brief.json"), []byte("{}"), 0o644); err != nil {
t.Fatal(err)
}
run := readStatusTestRunFile(t)
run.CurrentStage = StageOutline
writeStatusTestRunFile(t, run)
if _, err := NextTask("demo"); err == nil {
t.Fatal("expected missing outline visual system to reject next task")
}
}
func TestInspectStatusReportsMissingGlobUntilMatched(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
run.CurrentStage = StageSVGAuthor
setStatusTestStageOutputs(t, &run, StageSVGAuthor, []string{"slides/*.svg"})
writeStatusTestRunFile(t, run)
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "slides/*.svg") {
t.Fatalf("MissingOutputs = %v, want slides/*.svg", status.MissingOutputs)
}
if err := os.WriteFile(filepath.Join("demo", "slides", "01.svg"), []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
status, err = InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if slices.Contains(status.MissingOutputs, "slides/*.svg") {
t.Fatalf("MissingOutputs = %v, want glob satisfied by slides/01.svg", status.MissingOutputs)
}
}
func TestInspectStatusDoesNotSatisfyGlobThroughIntermediateSymlink(t *testing.T) {
cwd := initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageSVGAuthor)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageSVGAuthor, []string{"link/bar/*.svg"})
writeStatusTestRunFile(t, run)
outside := filepath.Join(filepath.Dir(cwd), "outside")
if err := os.MkdirAll(filepath.Join(outside, "bar"), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(outside, "bar", "01.svg"), []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "link")); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "link/bar/*.svg") {
t.Fatalf("MissingOutputs = %v, want intermediate symlink glob to leave link/bar/*.svg missing", status.MissingOutputs)
}
}
func TestInspectStatusDoesNotSatisfyArtifactThroughIntermediateSymlink(t *testing.T) {
cwd := initStatusTestRun(t)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageRequest, []string{"link/request.json"})
writeStatusTestRunFile(t, run)
outside := filepath.Join(filepath.Dir(cwd), "outside")
if err := os.MkdirAll(outside, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(outside, "request.json"), []byte("{}"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "link")); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "link/request.json") {
t.Fatalf("MissingOutputs = %v, want intermediate symlink artifact to leave link/request.json missing", status.MissingOutputs)
}
}
func TestInspectStatusDoesNotSatisfyGlobWithEscapingSymlinkDirectory(t *testing.T) {
cwd := initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageSVGAuthor)
if err := os.RemoveAll(filepath.Join("demo", "slides")); err != nil {
t.Fatal(err)
}
outsideSlides := filepath.Join(filepath.Dir(cwd), "outside-slides")
if err := os.MkdirAll(outsideSlides, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(outsideSlides, "01.svg"), []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outsideSlides, filepath.Join("demo", "slides")); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "slides/*.svg") {
t.Fatalf("MissingOutputs = %v, want symlink directory glob to leave slides/*.svg missing", status.MissingOutputs)
}
}
func TestInspectStatusDoesNotSatisfyGlobWithDirectory(t *testing.T) {
initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageSVGAuthor)
if err := os.Mkdir(filepath.Join("demo", "slides", "01.svg"), 0o755); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "slides/*.svg") {
t.Fatalf("MissingOutputs = %v, want directory match to leave slides/*.svg missing", status.MissingOutputs)
}
}
func TestInspectStatusDoesNotSatisfyGlobWithEscapingSymlink(t *testing.T) {
cwd := initStatusTestRun(t)
setCurrentStageForStatusTest(t, StageSVGAuthor)
outside := filepath.Join(filepath.Dir(cwd), "outside.svg")
if err := os.WriteFile(outside, []byte("<svg/>"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "slides", "01.svg")); err != nil {
t.Fatal(err)
}
status, err := InspectStatus("demo")
if err != nil {
t.Fatal(err)
}
if !slices.Contains(status.MissingOutputs, "slides/*.svg") {
t.Fatalf("MissingOutputs = %v, want symlink match to leave slides/*.svg missing", status.MissingOutputs)
}
}
func TestInspectStatusRejectsInvalidGlobPattern(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageRequest, []string{"slides/[.svg"})
writeStatusTestRunFile(t, run)
if _, err := InspectStatus("demo"); err == nil {
t.Fatal("expected invalid glob pattern error")
}
}
func TestNextTaskRejectsInvalidGlobPattern(t *testing.T) {
initStatusTestRun(t)
run := readStatusTestRunFile(t)
setStatusTestStageOutputs(t, &run, StageRequest, []string{"slides/[.svg"})
writeStatusTestRunFile(t, run)
if _, err := NextTask("demo"); err == nil {
t.Fatal("expected invalid glob pattern error")
}
}
func initStatusTestRun(t *testing.T) string {
return initStatusTestRunAt(t, "demo")
}
func initStatusTestRunAt(t *testing.T, root string) string {
t.Helper()
cwd := t.TempDir()
t.Chdir(cwd)
if err := os.WriteFile("source.md", []byte("# Demo"), 0o644); err != nil {
t.Fatal(err)
}
initRoot := root
if trimmed := strings.TrimSpace(root); trimmed != root {
initRoot = trimmed
}
if err := InitRun(initRoot, InitOptions{Title: "Demo", Input: "source.md"}); err != nil {
t.Fatal(err)
}
if initRoot != root {
if err := os.Rename(initRoot, root); err != nil {
t.Fatal(err)
}
}
return cwd
}
func readStatusTestRunFile(t *testing.T) Run {
t.Helper()
raw, err := os.ReadFile(filepath.Join("demo", "run.json"))
if err != nil {
t.Fatal(err)
}
var run Run
if err := json.Unmarshal(raw, &run); err != nil {
t.Fatal(err)
}
return run
}
func writeStatusTestRunFile(t *testing.T, run Run) {
t.Helper()
raw, err := json.MarshalIndent(run, "", " ")
if err != nil {
t.Fatal(err)
}
raw = append(raw, '\n')
if err := os.WriteFile(filepath.Join("demo", "run.json"), raw, 0o644); err != nil {
t.Fatal(err)
}
}
func setStatusTestStageOutputs(t *testing.T, run *Run, stageName string, outputs []string) {
t.Helper()
for i := range run.Stages {
if run.Stages[i].Name == stageName {
run.Stages[i].Outputs = outputs
return
}
}
t.Fatalf("missing stage %q", stageName)
}
func setCurrentStageForStatusTest(t *testing.T, stageName string) {
t.Helper()
run := readStatusTestRunFile(t)
run.CurrentStage = stageName
writeStatusTestRunFile(t, run)
}

View File

@@ -0,0 +1,524 @@
package svglide
import (
"bytes"
"encoding/json"
"encoding/xml"
"fmt"
"io"
"math"
"strconv"
"strings"
"github.com/larksuite/cli/internal/vfs"
)
const slideNamespace = "https://slides.bytedance.com/ns"
const svgNamespace = "http://www.w3.org/2000/svg"
const xlinkNamespace = "http://www.w3.org/1999/xlink"
type ValidationReport struct {
OK bool `json:"ok"`
Issues []ValidationIssue `json:"issues"`
}
type ValidationIssue struct {
Path string `json:"path"`
Code string `json:"code,omitempty"`
Message string `json:"message"`
Severity string `json:"severity,omitempty"`
}
type validationDeck struct {
Slides []validationDeckSlide `json:"slides"`
}
type validationDeckSlide struct {
Path string `json:"path"`
}
type svgViewBox struct {
Width float64
Height float64
Valid bool
}
type svgLintElement struct {
Excluded bool
TextCandidate bool
}
func ValidateRun(root string) (ValidationReport, error) {
safeRoot, run, err := readRun(root)
if err != nil {
return ValidationReport{}, err
}
deckPath := strings.TrimSpace(run.Artifacts.Deck)
if deckPath == "" {
return failValidation(safeRoot, ValidationIssue{Code: "svglide.deck", Message: "deck artifact path is empty"}, fmt.Errorf("deck artifact path is empty"))
}
deckRaw, err := readRunRegularArtifact(safeRoot, deckPath)
if err != nil {
issue := ValidationIssue{Path: deckPath, Code: "svglide.deck", Message: fmt.Sprintf("deck %q: %v", deckPath, err)}
return failValidation(safeRoot, issue, fmt.Errorf("read deck %q: %w", deckPath, err))
}
var deck validationDeck
if err := json.Unmarshal(deckRaw, &deck); err != nil {
issue := ValidationIssue{Path: deckPath, Code: "svglide.deck", Message: fmt.Sprintf("deck %q contains invalid JSON: %v", deckPath, err)}
return failValidation(safeRoot, issue, fmt.Errorf("read deck %q: %w", deckPath, err))
}
if len(deck.Slides) == 0 {
issue := ValidationIssue{Path: deckPath, Code: "svglide.deck", Message: fmt.Sprintf("deck %q contains no slides", deckPath)}
return failValidation(safeRoot, issue, fmt.Errorf("deck %q contains no slides", deckPath))
}
report := ValidationReport{Issues: []ValidationIssue{}}
for _, slide := range deck.Slides {
slidePath := strings.TrimSpace(slide.Path)
if slidePath == "" {
report.Issues = append(report.Issues, ValidationIssue{Code: "svglide.path", Message: "slide path must not be empty"})
continue
}
raw, err := readRunRegularArtifact(safeRoot, slidePath)
if err != nil {
report.Issues = append(report.Issues, ValidationIssue{Path: slidePath, Code: "svglide.path", Message: err.Error()})
continue
}
report.Issues = append(report.Issues, lintSVG(slidePath, raw)...)
}
report = normalizeValidationReport(report)
if err := writeValidationArtifacts(safeRoot, report); err != nil {
return report, err
}
return report, nil
}
func failValidation(safeRoot string, issue ValidationIssue, err error) (ValidationReport, error) {
report := ValidationReport{Issues: []ValidationIssue{issue}}
report = normalizeValidationReport(report)
if writeErr := writeValidationArtifacts(safeRoot, report); writeErr != nil {
if err != nil {
return report, fmt.Errorf("%w; write validation artifacts: %v", err, writeErr)
}
return report, writeErr
}
return report, nil
}
func readRunRegularArtifact(safeRoot string, rel string) ([]byte, error) {
info, path, exists, err := lstatRunPath(safeRoot, rel)
if err != nil {
return nil, err
}
if !exists || !info.Mode().IsRegular() {
return nil, fmt.Errorf("run path %q is missing or not a regular file inside run root", rel)
}
raw, err := vfs.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("read run path %q: %w", rel, err)
}
return raw, nil
}
func lintSVG(path string, raw []byte) []ValidationIssue {
decoder := xml.NewDecoder(bytes.NewReader(raw))
var issues []ValidationIssue
var rootSeen bool
var rootIsSVG bool
var hasSlideRole bool
var hasViewBox bool
var hasVisibleContent bool
var viewBox svgViewBox
var stack []svgLintElement
for {
token, err := decoder.Token()
if err == io.EOF {
break
}
if err != nil {
return []ValidationIssue{{Path: path, Code: "svglide.xml", Message: fmt.Sprintf("invalid XML: %v", err)}}
}
switch typed := token.(type) {
case xml.StartElement:
parentExcluded := len(stack) > 0 && stack[len(stack)-1].Excluded
excluded := parentExcluded || elementIsHidden(typed) || elementIsNonRendering(typed)
ctx := svgLintElement{
Excluded: excluded,
TextCandidate: elementIsTextCandidate(typed),
}
if !rootSeen {
rootSeen = true
rootIsSVG = typed.Name.Local == "svg" && typed.Name.Space == svgNamespace
hasSlideRole = hasRootSlideRole(typed)
viewBox, hasViewBox = rootViewBox(typed)
issues = append(issues, lintSVGElementProtocol(path, typed, excluded)...)
stack = append(stack, ctx)
continue
}
issues = append(issues, lintSVGElementProtocol(path, typed, excluded)...)
if elementCountsAsVisibleContent(typed, viewBox, excluded) {
hasVisibleContent = true
}
stack = append(stack, ctx)
case xml.CharData:
if strings.TrimSpace(string(typed)) != "" && activeVisibleTextCandidate(stack) {
hasVisibleContent = true
}
case xml.EndElement:
if len(stack) > 0 {
stack = stack[:len(stack)-1]
}
default:
continue
}
}
if !rootSeen {
return []ValidationIssue{{Path: path, Code: "svglide.xml", Message: "invalid XML: missing root element"}}
}
if !rootIsSVG {
issues = append(issues, ValidationIssue{Path: path, Code: "svglide.root", Message: "root element must be <svg>"})
}
if !hasSlideRole {
issues = append(issues, ValidationIssue{Path: path, Code: "svglide.slide_role", Message: `root element must include slide:role="slide"`})
}
if !hasViewBox {
issues = append(issues, ValidationIssue{Path: path, Code: "svglide.viewbox", Message: "root element must include viewBox"})
} else if !viewBox.Valid {
issues = append(issues, ValidationIssue{Path: path, Code: "svglide.viewbox", Message: "root element must include valid viewBox"})
}
if rootIsSVG && !hasVisibleContent {
issues = append(issues, ValidationIssue{Path: path, Code: "svglide.visible_content", Message: "slide contains only background/placeholder content"})
}
return issues
}
func hasRootSlideRole(start xml.StartElement) bool {
for _, attr := range start.Attr {
if strings.TrimSpace(attr.Value) != "slide" {
continue
}
if attr.Name.Local == "role" && attr.Name.Space == slideNamespace {
return true
}
}
return false
}
func rootViewBox(start xml.StartElement) (svgViewBox, bool) {
for _, attr := range start.Attr {
if attr.Name.Space != "" || attr.Name.Local != "viewBox" || strings.TrimSpace(attr.Value) == "" {
continue
}
return parseViewBox(attr.Value), true
}
return svgViewBox{}, false
}
func parseViewBox(value string) svgViewBox {
fields := strings.Fields(strings.ReplaceAll(value, ",", " "))
if len(fields) != 4 {
return svgViewBox{}
}
values := make([]float64, 4)
for i, field := range fields {
parsed, err := strconv.ParseFloat(field, 64)
if err != nil || math.IsNaN(parsed) || math.IsInf(parsed, 0) {
return svgViewBox{}
}
values[i] = parsed
}
width := values[2]
height := values[3]
if width <= 0 || height <= 0 {
return svgViewBox{}
}
return svgViewBox{Width: width, Height: height, Valid: true}
}
func lintSVGElementProtocol(path string, start xml.StartElement, excluded bool) []ValidationIssue {
if start.Name.Space != svgNamespace {
return nil
}
var issues []ValidationIssue
if excluded {
return issues
}
if elementHasNonPositiveDimension(start) {
issues = append(issues, ValidationIssue{
Path: path,
Code: "svglide.geometry",
Message: fmt.Sprintf("<%s> has non-positive width or height", start.Name.Local),
})
}
if start.Name.Local == "image" {
if !hasSlideAttr(start, "role", "image") {
issues = append(issues, ValidationIssue{
Path: path,
Code: "svglide.image_role",
Message: `image must include slide:role="image"`,
})
}
}
return issues
}
func elementHasNonPositiveDimension(start xml.StartElement) bool {
for _, name := range []string{"width", "height"} {
value, ok := plainAttr(start, name)
if !ok {
continue
}
parsed, ok := parseSVGDimension(value)
if ok && parsed <= 0 {
return true
}
}
return false
}
func hasSlideAttr(start xml.StartElement, local string, value string) bool {
for _, attr := range start.Attr {
if attr.Name.Space == slideNamespace && attr.Name.Local == local && strings.TrimSpace(attr.Value) == value {
return true
}
}
return false
}
func plainAttr(start xml.StartElement, local string) (string, bool) {
for _, attr := range start.Attr {
if attr.Name.Space == "" && attr.Name.Local == local {
return attr.Value, true
}
}
return "", false
}
func parseSVGDimension(value string) (float64, bool) {
s := strings.TrimSpace(value)
if s == "" {
return 0, false
}
lower := strings.ToLower(s)
for _, suffix := range []string{"vmax", "vmin", "rem", "px", "%", "em", "pt", "pc", "in", "cm", "mm", "qh", "q", "ex", "ch", "vw", "vh"} {
if strings.HasSuffix(lower, suffix) {
s = strings.TrimSpace(s[:len(s)-len(suffix)])
if s == "" {
return 0, false
}
break
}
}
parsed, err := strconv.ParseFloat(s, 64)
if err != nil || math.IsNaN(parsed) || math.IsInf(parsed, 0) {
return 0, false
}
return parsed, true
}
func elementCountsAsVisibleContent(start xml.StartElement, viewBox svgViewBox, excluded bool) bool {
if excluded {
return false
}
if start.Name.Space != svgNamespace {
return false
}
if hasSemanticMarker(start, "background", "placeholder") {
return false
}
switch start.Name.Local {
case "text", "tspan":
return false
case "foreignObject", "chart":
return true
case "image", "use":
return elementHasHref(start)
case "g":
return hasSemanticMarker(start, "chart", "shape")
case "path", "circle", "ellipse", "line", "polyline", "polygon":
return true
case "rect":
return !isBackgroundRect(start, viewBox)
default:
return hasSemanticMarker(start, "chart", "shape")
}
}
func activeVisibleTextCandidate(stack []svgLintElement) bool {
for i := len(stack) - 1; i >= 0; i-- {
if stack[i].Excluded {
return false
}
if stack[i].TextCandidate {
return true
}
}
return false
}
func elementIsTextCandidate(start xml.StartElement) bool {
return start.Name.Space == svgNamespace && (start.Name.Local == "text" || start.Name.Local == "tspan")
}
func elementIsHidden(start xml.StartElement) bool {
for _, attr := range start.Attr {
if attr.Name.Space != "" {
continue
}
switch attr.Name.Local {
case "display":
if strings.EqualFold(strings.TrimSpace(attr.Value), "none") {
return true
}
case "visibility":
if strings.EqualFold(strings.TrimSpace(attr.Value), "hidden") {
return true
}
case "opacity":
if opacityIsZero(attr.Value) {
return true
}
case "style":
if styleHidesElement(attr.Value) {
return true
}
}
}
return false
}
func styleHidesElement(style string) bool {
for _, declaration := range strings.Split(style, ";") {
name, value, ok := strings.Cut(declaration, ":")
if !ok {
continue
}
switch strings.ToLower(strings.TrimSpace(name)) {
case "display":
if strings.EqualFold(strings.TrimSpace(value), "none") {
return true
}
case "visibility":
if strings.EqualFold(strings.TrimSpace(value), "hidden") {
return true
}
case "opacity":
if opacityIsZero(value) {
return true
}
}
}
return false
}
func opacityIsZero(value string) bool {
parsed, err := strconv.ParseFloat(strings.TrimSpace(value), 64)
if err != nil || math.IsNaN(parsed) || math.IsInf(parsed, 0) {
return false
}
return floatEqual(parsed, 0)
}
func elementIsNonRendering(start xml.StartElement) bool {
if start.Name.Space != svgNamespace {
return false
}
switch start.Name.Local {
case "defs", "symbol", "clipPath", "mask", "pattern", "linearGradient", "radialGradient", "marker", "metadata", "title", "desc", "style", "script":
return true
default:
return false
}
}
func elementHasHref(start xml.StartElement) bool {
for _, attr := range start.Attr {
if attr.Name.Local != "href" || strings.TrimSpace(attr.Value) == "" {
continue
}
if attr.Name.Space == "" || attr.Name.Space == xlinkNamespace {
return true
}
}
return false
}
func hasSemanticMarker(start xml.StartElement, terms ...string) bool {
for _, attr := range start.Attr {
if attr.Name.Space != "" {
continue
}
name := strings.ToLower(attr.Name.Local)
if name != "role" && name != "class" && name != "id" && !strings.HasPrefix(name, "data-") {
continue
}
value := strings.ToLower(attr.Value)
for _, term := range terms {
if strings.Contains(value, term) {
return true
}
}
}
return false
}
func isBackgroundRect(start xml.StartElement, viewBox svgViewBox) bool {
if hasSemanticMarker(start, "background", "placeholder") {
return true
}
width := attrValue(start, "width")
height := attrValue(start, "height")
if width == "100%" && height == "100%" {
return true
}
if !viewBox.Valid {
return false
}
x := attrFloatDefault(start, "x", 0)
y := attrFloatDefault(start, "y", 0)
w, okW := parseAttrFloat(width)
h, okH := parseAttrFloat(height)
if !okW || !okH {
return false
}
return floatEqual(x, 0) && floatEqual(y, 0) && floatEqual(w, viewBox.Width) && floatEqual(h, viewBox.Height)
}
func attrValue(start xml.StartElement, name string) string {
for _, attr := range start.Attr {
if attr.Name.Space == "" && attr.Name.Local == name {
return strings.TrimSpace(attr.Value)
}
}
return ""
}
func attrFloatDefault(start xml.StartElement, name string, fallback float64) float64 {
value := attrValue(start, name)
if value == "" {
return fallback
}
parsed, ok := parseAttrFloat(value)
if !ok {
return fallback
}
return parsed
}
func parseAttrFloat(value string) (float64, bool) {
parsed, err := strconv.ParseFloat(strings.TrimSpace(value), 64)
if err != nil {
return 0, false
}
return parsed, true
}
func floatEqual(a float64, b float64) bool {
return math.Abs(a-b) < 0.001
}

View File

@@ -0,0 +1,993 @@
package svglide
import (
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
)
func TestValidateRunRejectsBackgroundOnlySVGAndWritesRepairArtifacts(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), backgroundOnlySVG())
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if len(report.Issues) == 0 {
t.Fatal("expected background-only SVG issue")
}
if !validationIssuesContain(report.Issues, "background") {
t.Fatalf("Issues = %+v, want background/placeholder issue", report.Issues)
}
raw, err := os.ReadFile(filepath.Join("demo", "receipts", "lint.json"))
if err != nil {
t.Fatalf("missing lint receipt: %v", err)
}
var receipt ValidationReport
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatalf("lint receipt is not ValidationReport JSON: %v", err)
}
if receipt.OK || len(receipt.Issues) == 0 {
t.Fatalf("lint receipt = %+v, want failing issues", receipt)
}
var lintReceipt validationLintReceipt
if err := json.Unmarshal(raw, &lintReceipt); err != nil {
t.Fatalf("lint receipt is not schema-compatible JSON: %v", err)
}
if lintReceipt.Status != "failed" {
t.Fatalf("lint receipt status = %q, want failed", lintReceipt.Status)
}
if lintReceipt.Issues[0].Code == "" || lintReceipt.Issues[0].Severity == "" {
t.Fatalf("lint receipt issue = %+v, want code and severity", lintReceipt.Issues[0])
}
queue, err := os.ReadFile(filepath.Join("demo", "repair_queue.md"))
if err != nil {
t.Fatalf("missing repair queue: %v", err)
}
if !strings.Contains(string(queue), "slides/01.svg") {
t.Fatalf("repair queue = %q, want slide path", string(queue))
}
}
func TestValidateRunPassesVisibleTextSVG(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
if len(report.Issues) != 0 {
t.Fatalf("Issues = %+v, want empty", report.Issues)
}
queue, err := os.ReadFile(filepath.Join("demo", "repair_queue.md"))
if err != nil {
t.Fatalf("missing repair queue: %v", err)
}
if strings.TrimSpace(string(queue)) != "No repair needed." {
t.Fatalf("repair queue = %q, want no repair text", string(queue))
}
}
func TestValidateRunRejectsEscapingSlidePath(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "../outside.svg")
writeValidateTestFile(t, "outside.svg", visibleTextSVG())
report, err := ValidateRun("demo")
if err == nil && report.OK {
t.Fatalf("ValidateRun OK with escaping slide path: %+v", report)
}
}
func TestValidateRunRejectsSlideSymlinks(t *testing.T) {
tests := []struct {
name string
deckPath string
setupLink func(t *testing.T, outside string)
}{
{
name: "file symlink",
deckPath: "slides/01.svg",
setupLink: func(t *testing.T, outside string) {
if err := os.Symlink(filepath.Join(outside, "01.svg"), filepath.Join("demo", "slides", "01.svg")); err != nil {
t.Fatal(err)
}
},
},
{
name: "intermediate symlink",
deckPath: "slides/link/01.svg",
setupLink: func(t *testing.T, outside string) {
if err := os.Symlink(outside, filepath.Join("demo", "slides", "link")); err != nil {
t.Fatal(err)
}
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", tt.deckPath)
outside := filepath.Join(filepath.Dir(cwd), "outside")
if err := os.MkdirAll(outside, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(outside, "01.svg"), []byte(visibleTextSVG()), 0o644); err != nil {
t.Fatal(err)
}
tt.setupLink(t, outside)
report, err := ValidateRun("demo")
if err == nil && report.OK {
t.Fatalf("ValidateRun OK with symlinked slide path: %+v", report)
}
})
}
}
func TestValidateRunRejectsDeckSymlinks(t *testing.T) {
tests := []struct {
name string
deckPath string
setupLink func(t *testing.T, outside string)
}{
{
name: "file symlink",
deckPath: filepath.Join("demo", "outline", "deck.json"),
setupLink: func(t *testing.T, outside string) {
if err := os.Remove(filepath.Join("demo", "outline", "deck.json")); err != nil {
t.Fatal(err)
}
if err := os.Symlink(filepath.Join(outside, "deck.json"), filepath.Join("demo", "outline", "deck.json")); err != nil {
t.Fatal(err)
}
},
},
{
name: "intermediate symlink",
deckPath: filepath.Join("demo", "outline_link", "deck.json"),
setupLink: func(t *testing.T, outside string) {
run := readValidateTestRunFile(t)
run.Artifacts.Deck = "outline_link/deck.json"
writeValidateTestRunFile(t, run)
if err := os.Symlink(outside, filepath.Join("demo", "outline_link")); err != nil {
t.Fatal(err)
}
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
outside := filepath.Join(filepath.Dir(cwd), "outside")
if err := os.MkdirAll(outside, 0o755); err != nil {
t.Fatal(err)
}
writeMinimalDeckAt(t, filepath.Join(outside, "deck.json"), "slides/01.svg")
tt.setupLink(t, outside)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("ValidateRun OK with symlinked deck path %q: %+v", tt.deckPath, report)
}
})
}
}
func TestValidateRunRejectsEmptyDeck(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo")
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
assertValidationFailureArtifacts(t, "demo", report, "no slides")
}
func TestValidateRunWritesRepairArtifactsForDeckReadFailures(t *testing.T) {
tests := []struct {
name string
setup func(t *testing.T)
wantErr string
}{
{
name: "missing deck",
setup: func(t *testing.T) {
if err := os.Remove(filepath.Join("demo", "outline", "deck.json")); err != nil {
t.Fatal(err)
}
},
wantErr: "deck",
},
{
name: "invalid deck json",
setup: func(t *testing.T) {
writeValidateTestFile(t, filepath.Join("demo", "outline", "deck.json"), `{`)
},
wantErr: "deck",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
tt.setup(t)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
assertValidationFailureArtifacts(t, "demo", report, tt.wantErr)
})
}
}
func TestValidateRunReadsDeckFromRunArtifacts(t *testing.T) {
initValidateTestRun(t)
run := readValidateTestRunFile(t)
run.Artifacts.Deck = "custom/deck.json"
writeValidateTestRunFile(t, run)
writeMinimalDeck(t, "demo", "slides/bad.svg")
writeMinimalDeckAt(t, filepath.Join("demo", "custom", "deck.json"), "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
}
func TestValidateRunReportsInvalidXML(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg><text>broken`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContain(report.Issues, "XML") && !validationIssuesContain(report.Issues, "xml") {
t.Fatalf("Issues = %+v, want XML parse issue", report.Issues)
}
}
func TestValidateRunRequiresSVGRootSlideRoleAndViewBox(t *testing.T) {
tests := []struct {
name string
svg string
want string
}{
{
name: "non svg root",
svg: `<html><body>not svg</body></html>`,
want: "<svg>",
},
{
name: "wrong svg namespace",
svg: `<svg xmlns="https://wrong.example/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540"><text>hello</text></svg>`,
want: "<svg>",
},
{
name: "missing slide role",
svg: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 960 540"><text>hello</text></svg>`,
want: `slide:role`,
},
{
name: "missing viewBox",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide"><text>hello</text></svg>`,
want: `viewBox`,
},
{
name: "wrong namespaced slide role",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:foo="https://wrong.example" foo:role="slide" viewBox="0 0 960 540"><text>hello</text></svg>`,
want: `slide:role`,
},
{
name: "unbound slide prefix role",
svg: `<svg xmlns="http://www.w3.org/2000/svg" slide:role="slide" viewBox="0 0 960 540"><text>hello</text></svg>`,
want: `slide:role`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), tt.svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContain(report.Issues, tt.want) {
t.Fatalf("Issues = %+v, want %q", report.Issues, tt.want)
}
})
}
}
func TestValidateRunRejectsInvalidViewBox(t *testing.T) {
tests := []struct {
name string
svg string
}{
{
name: "bad viewBox with text",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="bad"><text>hello</text></svg>`,
},
{
name: "bad viewBox origin fields",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="bad bad 960 540"><text>hello</text></svg>`,
},
{
name: "nan viewBox width",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 NaN 540"><text>hello</text></svg>`,
},
{
name: "zero viewBox with text",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 0 540"><text>hello</text></svg>`,
},
{
name: "bad viewBox with full page rect",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="bad"><rect width="960" height="540" fill="#fff"/></svg>`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), tt.svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContain(report.Issues, "viewBox") {
t.Fatalf("Issues = %+v, want viewBox issue", report.Issues)
}
})
}
}
func TestValidateRunIgnoresNonVisibleContent(t *testing.T) {
tests := []struct {
name string
body string
}{
{
name: "text in defs",
body: `<defs><text>hidden template</text></defs>`,
},
{
name: "display none text",
body: `<text display="none">hidden</text>`,
},
{
name: "visibility hidden text",
body: `<text visibility="hidden">hidden</text>`,
},
{
name: "style display none text",
body: `<text style="display:none">hidden</text>`,
},
{
name: "style visibility hidden text",
body: `<text style="visibility:hidden">hidden</text>`,
},
{
name: "opacity zero text",
body: `<text opacity="0">hidden</text>`,
},
{
name: "style opacity zero text",
body: `<text style="opacity:0">hidden</text>`,
},
{
name: "empty text",
body: `<text> </text>`,
},
{
name: "image without href",
body: `<image slide:role="image" width="120" height="80"/>`,
},
{
name: "use without href",
body: `<use x="10" y="10"/>`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
svg := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540">` + tt.body + `</svg>`
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContain(report.Issues, "background") && !validationIssuesContain(report.Issues, "placeholder") {
t.Fatalf("Issues = %+v, want placeholder issue", report.Issues)
}
})
}
}
func TestValidateRunRejectsWrongNamespaceVisibleContent(t *testing.T) {
tests := []struct {
name string
body string
}{
{
name: "wrong namespace path",
body: `<bad:path xmlns:bad="https://wrong.example/svg" d="M10 10h20v20z"/>`,
},
{
name: "wrong namespace text",
body: `<bad:text xmlns:bad="https://wrong.example/svg">hidden by namespace</bad:text>`,
},
{
name: "wrong namespace image href",
body: `<image xmlns:bad="https://wrong.example/svg" bad:href="asset.png" width="120" height="80"/>`,
},
{
name: "wrong namespace viewBox",
body: `<text>hello</text>`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
viewBox := `viewBox="0 0 960 540"`
if tt.name == "wrong namespace viewBox" {
viewBox = `bad:viewBox="0 0 960 540" xmlns:bad="https://wrong.example/svg"`
}
svg := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" ` + viewBox + `>` + tt.body + `</svg>`
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if tt.name == "wrong namespace viewBox" {
if !validationIssuesContain(report.Issues, "viewBox") {
t.Fatalf("Issues = %+v, want viewBox issue", report.Issues)
}
return
}
if !validationIssuesContain(report.Issues, "background") && !validationIssuesContain(report.Issues, "placeholder") {
t.Fatalf("Issues = %+v, want placeholder issue", report.Issues)
}
})
}
}
func TestValidateRunAcceptsNamespacedXLinkHref(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
svg := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" xmlns:xlink="http://www.w3.org/1999/xlink" slide:role="slide" viewBox="0 0 960 540"><image slide:role="image" xlink:href="assets/images/asset.png" width="120" height="80"/></svg>`
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
}
func TestValidateRunRejectsNegativeElementDimensions(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<foreignObject x="10" y="10" width="100" height="-4" slide:role="shape" slide:shape-type="text">
<div xmlns="http://www.w3.org/1999/xhtml">Bad size</div>
</foreignObject>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContainCode(report.Issues, "svglide.geometry") {
t.Fatalf("issues = %+v, want geometry issue", report.Issues)
}
}
func TestValidateRunAllowsExperimentImageHref(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<image slide:role="image" slide:shape-type="image" href="https://example.com/hero.png" x="10" y="10" width="200" height="120"/>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, want true: %+v", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, did not expect remote asset issue", report.Issues)
}
}
func TestValidateRunAllowsExperimentImageHrefCaseInsensitive(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<image slide:role="image" slide:shape-type="image" href="HTTPS://example.com/hero.png" x="10" y="10" width="200" height="120"/>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, want true: %+v", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, did not expect remote asset issue", report.Issues)
}
}
func TestValidateRunRejectsImageWithoutImageRole(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<image href="assets/images/hero.png" x="10" y="10" width="200" height="120"/>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if report.OK {
t.Fatalf("OK = true, want false")
}
if !validationIssuesContainCode(report.Issues, "svglide.image_role") {
t.Fatalf("issues = %+v, want image role issue", report.Issues)
}
}
func TestValidateRunIgnoresGeometryAndImageRoleInsideExcludedContent(t *testing.T) {
tests := []struct {
name string
body string
}{
{
name: "defs image",
body: `<defs><image href="assets/images/defs.png" width="-4px" height="120"/></defs><text x="48" y="80">Hello</text>`,
},
{
name: "pattern image",
body: `<pattern id="p"><image href="assets/images/pattern.png" width="120" height="0%"/></pattern><text x="48" y="80">Hello</text>`,
},
{
name: "mask image",
body: `<mask id="m"><image href="assets/images/mask.png" width="auto" height="-4px"/></mask><text x="48" y="80">Hello</text>`,
},
{
name: "display none image",
body: `<g display="none"><image href="assets/images/hidden.png" width="-4px" height="120"/></g><text x="48" y="80">Hello</text>`,
},
{
name: "visibility hidden image",
body: `<g visibility="hidden"><image href="assets/images/hidden.png" width="120" height="-4px"/></g><text x="48" y="80">Hello</text>`,
},
{
name: "marker image role",
body: `<marker id="mk"><image href="assets/images/marker.png" width="120" height="80"/></marker><text x="48" y="80">Hello</text>`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
svg := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">` + tt.body + `</svg>`
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.geometry") {
t.Fatalf("issues = %+v, want no geometry issue", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, want no remote asset issue", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.image_role") {
t.Fatalf("issues = %+v, want no image role issue", report.Issues)
}
})
}
}
func TestValidateRunAllowsExperimentImageHrefWithXLink(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 960 540" slide:role="slide">
<image slide:role="image" xlink:href="https://example.com/hero.png" x="10" y="10" width="200" height="120"/>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, want true: %+v", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, did not expect remote asset issue", report.Issues)
}
}
func TestValidateRunAllowsExperimentImageHrefVariants(t *testing.T) {
tests := []struct {
name string
href string
}{
{name: "parent directory", href: "../outside.png"},
{name: "absolute path", href: "/Users/example/secret.png"},
{name: "file url", href: "file:///tmp/secret.png"},
{name: "protocol relative", href: "//example.com/hero.png"},
{name: "data url", href: "data:image/png;base64,AAAA"},
{name: "percent encoding", href: "assets/images/hero%2epng"},
{name: "nested asset path", href: "assets/images/nested/hero.png"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<image slide:role="image" slide:shape-type="image" href="`+tt.href+`" x="10" y="10" width="200" height="120"/>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, want true for %s: %+v", tt.href, report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, did not expect remote asset issue", report.Issues)
}
})
}
}
func TestValidateRunAllowsExperimentImageHrefInsideExcludedContent(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<defs><image href="file:///tmp/secret.png" width="-4px" height="120"/></defs>
<text x="48" y="80">Hello</text>
</svg>`)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, want true: %+v", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.remote_asset") {
t.Fatalf("issues = %+v, did not expect remote asset issue", report.Issues)
}
if validationIssuesContainCode(report.Issues, "svglide.geometry") {
t.Fatalf("issues = %+v, want no geometry issue inside excluded content", report.Issues)
}
}
func TestValidateRunRejectsDimensionUnits(t *testing.T) {
tests := []struct {
name string
svg string
want bool
}{
{
name: "negative px",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<foreignObject x="10" y="10" width="100" height="-4px" slide:role="shape" slide:shape-type="text">
<div xmlns="http://www.w3.org/1999/xhtml">Bad size</div>
</foreignObject>
</svg>`,
want: true,
},
{
name: "zero percent",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<foreignObject x="10" y="10" width="0%" height="20" slide:role="shape" slide:shape-type="text">
<div xmlns="http://www.w3.org/1999/xhtml">Bad size</div>
</foreignObject>
</svg>`,
want: true,
},
{
name: "auto width",
svg: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" viewBox="0 0 960 540" slide:role="slide">
<foreignObject x="10" y="10" width="auto" height="20" slide:role="shape" slide:shape-type="text">
<div xmlns="http://www.w3.org/1999/xhtml">Fine</div>
</foreignObject>
<text x="48" y="80">Hello</text>
</svg>`,
want: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), tt.svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if tt.want {
if !validationIssuesContainCode(report.Issues, "svglide.geometry") {
t.Fatalf("issues = %+v, want geometry issue", report.Issues)
}
return
}
if validationIssuesContainCode(report.Issues, "svglide.geometry") {
t.Fatalf("issues = %+v, want no geometry issue", report.Issues)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
})
}
}
func TestValidateRunAcceptsPlainHref(t *testing.T) {
initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
svg := `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540"><image slide:role="image" href="assets/images/asset.png" width="120" height="80"/></svg>`
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), svg)
report, err := ValidateRun("demo")
if err != nil {
t.Fatal(err)
}
if !report.OK {
t.Fatalf("OK = false, issues = %+v", report.Issues)
}
}
func TestValidateRunRejectsReceiptSymlink(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
if err := os.RemoveAll(filepath.Join("demo", "receipts")); err != nil {
t.Fatal(err)
}
outside := filepath.Join(filepath.Dir(cwd), "outside-receipts")
if err := os.MkdirAll(outside, 0o755); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "receipts")); err != nil {
t.Fatal(err)
}
if _, err := ValidateRun("demo"); err == nil {
t.Fatal("expected receipt symlink write refusal")
}
if _, err := os.Stat(filepath.Join(outside, "lint.json")); !os.IsNotExist(err) {
t.Fatalf("lint receipt should not be written outside run root, stat err=%v", err)
}
}
func TestValidateRunRejectsLintReceiptFileSymlink(t *testing.T) {
cwd := initValidateTestRun(t)
writeMinimalDeck(t, "demo", "slides/01.svg")
writeValidateTestFile(t, filepath.Join("demo", "slides", "01.svg"), visibleTextSVG())
if err := os.Remove(filepath.Join("demo", "receipts", "lint.json")); err != nil && !os.IsNotExist(err) {
t.Fatal(err)
}
outside := filepath.Join(filepath.Dir(cwd), "outside-lint.json")
if err := os.WriteFile(outside, []byte("outside"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.Symlink(outside, filepath.Join("demo", "receipts", "lint.json")); err != nil {
t.Fatal(err)
}
if _, err := ValidateRun("demo"); err == nil {
t.Fatal("expected lint receipt file symlink write refusal")
}
raw, err := os.ReadFile(outside)
if err != nil {
t.Fatal(err)
}
if string(raw) != "outside" {
t.Fatalf("outside file was overwritten: %q", string(raw))
}
}
func initValidateTestRun(t *testing.T) string {
t.Helper()
cwd := t.TempDir()
t.Chdir(cwd)
if err := os.WriteFile("source.md", []byte("# Demo"), 0o644); err != nil {
t.Fatal(err)
}
if err := InitRun("demo", InitOptions{Title: "Demo", Input: "source.md"}); err != nil {
t.Fatal(err)
}
return cwd
}
func writeMinimalDeck(t *testing.T, root string, slidePaths ...string) {
t.Helper()
writeMinimalDeckAt(t, filepath.Join(root, "outline", "deck.json"), slidePaths...)
}
func writeMinimalDeckAt(t *testing.T, path string, slidePaths ...string) {
t.Helper()
slides := make([]map[string]string, 0, len(slidePaths))
for i, path := range slidePaths {
slides = append(slides, map[string]string{
"id": "slide-" + string(rune('1'+i)),
"title": "Slide",
"summary": "Summary",
"role": "content",
"key_message": "Message",
"path": path,
})
}
raw, err := json.MarshalIndent(map[string]any{
"title": "Demo",
"slides": slides,
}, "", " ")
if err != nil {
t.Fatal(err)
}
raw = append(raw, '\n')
writeValidateTestFile(t, path, string(raw))
}
func readValidateTestRunFile(t *testing.T) Run {
t.Helper()
raw, err := os.ReadFile(filepath.Join("demo", "run.json"))
if err != nil {
t.Fatal(err)
}
var run Run
if err := json.Unmarshal(raw, &run); err != nil {
t.Fatal(err)
}
return run
}
func writeValidateTestRunFile(t *testing.T, run Run) {
t.Helper()
raw, err := json.MarshalIndent(run, "", " ")
if err != nil {
t.Fatal(err)
}
raw = append(raw, '\n')
if err := os.WriteFile(filepath.Join("demo", "run.json"), raw, 0o644); err != nil {
t.Fatal(err)
}
}
func writeValidateTestFile(t *testing.T, path string, content string) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
t.Fatal(err)
}
}
func backgroundOnlySVG() string {
return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540"><rect width="960" height="540" fill="#fff"/></svg>`
}
func visibleTextSVG() string {
return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:slide="https://slides.bytedance.com/ns" slide:role="slide" viewBox="0 0 960 540"><rect width="960" height="540" fill="#fff"/><text x="48" y="80">Hello</text></svg>`
}
func validationIssuesContain(issues []ValidationIssue, needle string) bool {
for _, issue := range issues {
if strings.Contains(issue.Path, needle) || strings.Contains(issue.Message, needle) {
return true
}
}
return false
}
func validationIssuesContainCode(issues []ValidationIssue, code string) bool {
for _, issue := range issues {
if issue.Code == code {
return true
}
}
return false
}
func assertValidationFailureArtifacts(t *testing.T, root string, report ValidationReport, needle string) {
t.Helper()
if report.OK {
t.Fatalf("OK = true, want false")
}
if len(report.Issues) == 0 {
t.Fatal("expected validation issue")
}
if !validationIssuesContain(report.Issues, needle) {
t.Fatalf("Issues = %+v, want %q", report.Issues, needle)
}
raw, err := os.ReadFile(filepath.Join(root, "receipts", "lint.json"))
if err != nil {
t.Fatalf("missing lint receipt: %v", err)
}
var receipt ValidationReport
if err := json.Unmarshal(raw, &receipt); err != nil {
t.Fatalf("lint receipt is not ValidationReport JSON: %v", err)
}
if receipt.OK || !validationIssuesContain(receipt.Issues, needle) {
t.Fatalf("lint receipt = %+v, want failing issue containing %q", receipt, needle)
}
queue, err := os.ReadFile(filepath.Join(root, "repair_queue.md"))
if err != nil {
t.Fatalf("missing repair queue: %v", err)
}
if !strings.Contains(string(queue), needle) {
t.Fatalf("repair queue = %q, want %q", string(queue), needle)
}
}

View File

@@ -16,6 +16,14 @@ import (
const (
// EnvNoProxy disables automatic proxy support when set to any non-empty value.
EnvNoProxy = "LARK_CLI_NO_PROXY"
// EnvNoProxyWarn suppresses the proxy-detected warning when set to any
// non-empty value, while leaving proxy behavior unchanged. Unlike
// EnvNoProxy (which both silences the warning AND disables the proxy), this
// keeps proxy egress active. It exists so agents consuming --format json can
// keep using the proxy without the human-oriented warning line landing in
// the output stream and breaking JSON parsing.
EnvNoProxyWarn = "LARK_CLI_NO_PROXY_WARN"
)
// proxyEnvKeys lists environment variables that Go's ProxyFromEnvironment reads.
@@ -73,6 +81,11 @@ func redactProxyURL(raw string) string {
// are redacted. Safe to call multiple times; only the first call prints.
func WarnIfProxied(w io.Writer) {
proxyWarningOnce.Do(func() {
// Explicit opt-out: silence the warning without touching proxy behavior.
// Checked before the plugin and env-proxy branches so it suppresses both.
if os.Getenv(EnvNoProxyWarn) != "" {
return
}
// Proxy plugin mode overrides env proxies and LARK_CLI_NO_PROXY (see
// Shared), so its warning and disable instructions take precedence.
// Emitting the env-proxy warning here would be misleading: it tells the
@@ -88,7 +101,7 @@ func WarnIfProxied(w io.Writer) {
if key == "" {
return
}
fmt.Fprintf(w, "[lark-cli] [WARN] proxy detected: %s=%s — requests (including credentials) will transit through this proxy. Set %s=1 to disable proxy.\n",
key, redactProxyURL(val), EnvNoProxy)
fmt.Fprintf(w, "[lark-cli] [WARN] proxy detected: %s=%s — requests (including credentials) will transit through this proxy. Set %s=1 to disable proxy, or %s=1 to keep the proxy and silence this warning.\n",
key, redactProxyURL(val), EnvNoProxy, EnvNoProxyWarn)
})
}

View File

@@ -93,6 +93,47 @@ func TestWarnIfProxied_SilentWhenDisabled(t *testing.T) {
}
}
// TestWarnIfProxied_SilentWhenWarnOptOut verifies that LARK_CLI_NO_PROXY_WARN
// suppresses the warning while the proxy stays configured (unlike
// LARK_CLI_NO_PROXY, which also disables the proxy).
func TestWarnIfProxied_SilentWhenWarnOptOut(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
unsetProxyPluginEnv(t)
resetProxyPluginState()
proxyWarningOnce = sync.Once{}
t.Setenv("HTTPS_PROXY", "http://proxy:8080")
t.Setenv(EnvNoProxyWarn, "1")
var buf bytes.Buffer
WarnIfProxied(&buf)
if buf.Len() != 0 {
t.Errorf("expected no warning when %s is set, got: %s", EnvNoProxyWarn, buf.String())
}
}
// TestWarnIfProxied_WarnOptOutSuppressesPluginWarning verifies that
// LARK_CLI_NO_PROXY_WARN also suppresses the proxy-plugin warning.
func TestWarnIfProxied_WarnOptOutSuppressesPluginWarning(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())
unsetProxyPluginEnv(t)
proxyWarningOnce = sync.Once{}
old := proxyPluginStatus
proxyPluginStatus = func() (string, string, bool) { return "http://127.0.0.1:3128", "", true }
t.Cleanup(func() { proxyPluginStatus = old })
t.Setenv(EnvNoProxyWarn, "1")
var buf bytes.Buffer
WarnIfProxied(&buf)
if buf.Len() != 0 {
t.Errorf("expected no plugin warning when %s is set, got: %s", EnvNoProxyWarn, buf.String())
}
}
// TestWarnIfProxied_OnlyOnce verifies that proxy warnings are emitted only once.
func TestWarnIfProxied_OnlyOnce(t *testing.T) {
t.Setenv("LARKSUITE_CLI_CONFIG_DIR", t.TempDir())

View File

@@ -27,6 +27,7 @@ func OpenFile(name string, flag int, perm fs.FileMode) (*os.File, error) {
return DefaultFS.OpenFile(name, flag, perm)
}
func CreateTemp(dir, pattern string) (*os.File, error) { return DefaultFS.CreateTemp(dir, pattern) }
func Mkdir(path string, perm fs.FileMode) error { return DefaultFS.Mkdir(path, perm) }
func MkdirAll(path string, perm fs.FileMode) error { return DefaultFS.MkdirAll(path, perm) }
func MkdirTemp(dir, pattern string) (string, error) { return DefaultFS.MkdirTemp(dir, pattern) }
func ReadDir(name string) ([]os.DirEntry, error) { return DefaultFS.ReadDir(name) }

View File

@@ -25,6 +25,7 @@ type FS interface {
CreateTemp(dir, pattern string) (*os.File, error)
// Directory/File management
Mkdir(path string, perm fs.FileMode) error
MkdirAll(path string, perm fs.FileMode) error
MkdirTemp(dir, pattern string) (string, error)
ReadDir(name string) ([]os.DirEntry, error)

View File

@@ -30,6 +30,7 @@ func (OsFs) OpenFile(name string, flag int, perm fs.FileMode) (*os.File, error)
func (OsFs) CreateTemp(dir, pattern string) (*os.File, error) { return os.CreateTemp(dir, pattern) }
// Directory/File management
func (OsFs) Mkdir(path string, perm fs.FileMode) error { return os.Mkdir(path, perm) }
func (OsFs) MkdirAll(path string, perm fs.FileMode) error { return os.MkdirAll(path, perm) }
func (OsFs) MkdirTemp(dir, pattern string) (string, error) { return os.MkdirTemp(dir, pattern) }
func (OsFs) ReadDir(name string) ([]os.DirEntry, error) { return os.ReadDir(name) }

View File

@@ -23,6 +23,15 @@ func TestOsFsBasicOperations(t *testing.T) {
fs := OsFs{}
dir := t.TempDir()
// Mkdir
one := filepath.Join(dir, "one")
if err := fs.Mkdir(one, 0o755); err != nil {
t.Fatalf("Mkdir: %v", err)
}
if err := Mkdir(filepath.Join(dir, "two"), 0o755); err != nil {
t.Fatalf("package Mkdir: %v", err)
}
// MkdirAll
sub := filepath.Join(dir, "a", "b")
if err := fs.MkdirAll(sub, 0o755); err != nil {

View File

@@ -1,6 +1,6 @@
{
"name": "@larksuite/cli",
"version": "1.0.58",
"version": "1.0.63",
"description": "The official CLI for Lark/Feishu open platform",
"bin": {
"lark-cli": "scripts/run.js"

View File

@@ -5,7 +5,12 @@
const fs = require("fs");
const path = require("path");
const { execFileSync, execFile } = require("child_process");
const p = require("@clack/prompts");
// @clack/prompts is ESM-only since v1; load it via dynamic import() so this
// CommonJS script works on all supported Node versions (require() of an ESM
// package throws ERR_REQUIRE_ESM before Node 22.12). Assigned in the entry
// point below before main() runs.
let p;
const PKG = "@larksuite/cli";
const SKILLS_REPO = "https://open.feishu.cn";
@@ -374,7 +379,12 @@ async function main() {
}
}
main().catch((err) => {
p.cancel("Unexpected error: " + (err.message || err));
(async () => {
p = await import("@clack/prompts");
await main();
})().catch((err) => {
const msg = "Unexpected error: " + (err.message || err);
if (p) p.cancel(msg);
else console.error(msg);
process.exit(1);
});

View File

@@ -0,0 +1,207 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"io"
"strings"
"github.com/larksuite/cli/shortcuts/common"
)
const (
defaultAppsAnalyticsEnv = "online"
defaultAppsAnalyticsGranular = "day"
analyticsListEndpoint = "query_analytics_data"
)
// AppsAnalyticsList lists online app product analytics.
var AppsAnalyticsList = common.Shortcut{
Service: appsService,
Command: "+analytics-list",
Description: "List online app user and page-view analytics",
Risk: "read",
Tips: []string{
"Example: lark-cli apps +analytics-list --app-id <app_id> --analytics users --granularity week",
"Tip: analytics timestamps use nanoseconds; use +metric-list for request/runtime metrics.",
},
Scopes: []string{"spark:app:read"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: []common.Flag{
{Name: "app-id", Desc: "app ID whose online analytics should be listed", Required: true},
{Name: appsEnvironmentFlag, Default: defaultAppsAnalyticsEnv, Desc: "observability environment; only online is supported"},
{Name: "analytics", Desc: "analytics family to list", Required: true, Enum: []string{"users", "page-view"}},
{Name: "series", Desc: "analytics series within the family, such as active-users or desktop-view"},
{Name: "since", Desc: "start time, relative duration (30s, 5m, 0.5h, 2h, 3d, 1w), local date/time, or RFC3339; defaults to 30 days before --until"},
{Name: "until", Desc: "end time, relative duration (30s, 5m, 0.5h, 2h, 3d, 1w), local date/time, or RFC3339; defaults to now"},
{Name: "page", Desc: "frontend page or route filter"},
{Name: "device-type", Desc: "device type filter", Enum: []string{"desktop", "mobile"}},
{Name: "granularity", Default: defaultAppsAnalyticsGranular, Desc: "analytics aggregation granularity", Enum: []string{"day", "week", "month"}},
},
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
_, _, _, err := buildAnalyticsListBody(rctx)
return err
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
body, _, _, _ := buildAnalyticsListBody(rctx)
return common.NewDryRunAPI().
POST(analyticsListPath(rctx.Str("app-id"))).
Desc("List online app analytics").
Body(body)
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, _ := requireAppID(rctx.Str("app-id"))
body, types, labels, err := buildAnalyticsListBody(rctx)
if err != nil {
return err
}
data, err := rctx.CallAPITyped("POST", analyticsListPath(appID), nil, body)
if err != nil {
return withAppsHint(err, appIDListHint)
}
out := observabilitySeriesOutput{
Items: normalizeAnalyticsSeries(data, types, labels),
HasMore: false,
}
rctx.OutFormat(out, nil, func(w io.Writer) {
rows := observabilitySeriesRows(out.Items)
sortObservabilityRowsDesc(rows, "timestamp_ns")
rows = filterObservabilityRowsWithTime(rows, "timestamp_ns")
appsPrintSchemaTable(w, rows, analyticsSeriesSchema(labels))
})
return nil
},
}
func analyticsListPath(appID string) string {
return appScopedPath(appID, analyticsListEndpoint)
}
func buildAnalyticsListBody(rctx *common.RuntimeContext) (map[string]interface{}, []string, []string, error) {
env := strings.TrimSpace(rctx.Str(appsEnvironmentFlag))
if env == "" {
env = defaultAppsAnalyticsEnv
}
if err := validateObservabilityEnv(env); err != nil {
return nil, nil, nil, err
}
types, labels, filter, err := analyticsTypesForCLI(rctx.Str("analytics"), rctx.Str("series"), rctx.Str("device-type"))
if err != nil {
return nil, nil, nil, err
}
since, until, err := defaultedObservabilityTimeRange(rctx.Str("since"), rctx.Str("until"))
if err != nil {
return nil, nil, nil, err
}
aggregation, err := analyticsGranularityForCLI(rctx.Str("granularity"))
if err != nil {
return nil, nil, nil, err
}
if page := strings.TrimSpace(rctx.Str("page")); page != "" {
filter["page"] = page
}
body := map[string]interface{}{
"metric_types": types,
"start_timestamp_ns": nsNumber(since),
"end_timestamp_ns": nsNumber(until),
"time_aggregation_unit": aggregation,
"need_pack_lack_point": false,
}
if len(filter) > 0 {
body["filter"] = filter
}
return body, types, labels, nil
}
func analyticsTypesForCLI(name, series, deviceType string) ([]string, []string, map[string]interface{}, error) {
name = strings.TrimSpace(strings.ToLower(name))
series = strings.TrimSpace(strings.ToLower(series))
deviceType = strings.TrimSpace(strings.ToLower(deviceType))
filter := make(map[string]interface{})
if deviceType != "" {
switch deviceType {
case "desktop", "mobile":
filter["device_types"] = []string{deviceType}
default:
return nil, nil, nil, appsValidationParamError("--device-type", "--device-type must be desktop or mobile")
}
}
switch name {
case "users":
switch series {
case "":
return []string{"ACTIVE_USER", "NEW_USER", "TOTAL_USER"}, []string{"active-users", "new-users", "total-users"}, filter, nil
case "active", "active-users":
return []string{"ACTIVE_USER"}, []string{"active-users"}, filter, nil
case "new", "new-users":
return []string{"NEW_USER"}, []string{"new-users"}, filter, nil
case "total", "total-users":
return []string{"TOTAL_USER"}, []string{"total-users"}, filter, nil
default:
return nil, nil, nil, appsValidationParamError("--series", "--series for --analytics users must be active, new, or total")
}
case "page-view":
switch series {
case "", "all":
return []string{"PAGE_VIEW"}, []string{"all"}, filter, nil
case "desktop", "desktop-view":
if err := mergeAnalyticsDeviceFilter(filter, "desktop"); err != nil {
return nil, nil, nil, err
}
return []string{"PAGE_VIEW"}, []string{"desktop"}, filter, nil
case "mobile", "mobile-view":
if err := mergeAnalyticsDeviceFilter(filter, "mobile"); err != nil {
return nil, nil, nil, err
}
return []string{"PAGE_VIEW"}, []string{"mobile"}, filter, nil
default:
return nil, nil, nil, appsValidationParamError("--series", "--series for --analytics page-view must be all, desktop, or mobile")
}
default:
return nil, nil, nil, appsValidationParamError("--analytics", "--analytics must be users or page-view")
}
}
func mergeAnalyticsDeviceFilter(filter map[string]interface{}, deviceType string) error {
if existing, ok := filter["device_types"].([]string); ok && len(existing) > 0 && existing[0] != deviceType {
return appsValidationParamError("--device-type", "--device-type conflicts with --series")
}
filter["device_types"] = []string{deviceType}
return nil
}
func analyticsGranularityForCLI(granularity string) (string, error) {
switch strings.TrimSpace(strings.ToLower(granularity)) {
case "", "day":
return "DAY", nil
case "week":
return "WEEK", nil
case "month":
return "MONTH", nil
default:
return "", appsValidationParamError("--granularity", "--granularity must be day, week, or month")
}
}
func normalizeAnalyticsSeries(data map[string]interface{}, names, labels []string) []map[string]interface{} {
items := normalizeObservabilitySeries(data, labels, observabilityNameLabels(names, labels), false, "timestamp_ns")
fillObservabilityZeroesWhenPartiallyPresent(items, labels)
return items
}
func analyticsSeriesSchema(labels []string) appsOutputSchema {
columns := []appsOutputColumn{
{Key: "timestamp_ns", Label: "time", Format: appsFormatNS("2006-01-02 15:04:05")},
}
for _, label := range labels {
columns = append(columns, appsOutputColumn{Key: label})
}
return appsOutputSchema{Columns: columns, Strict: true}
}

View File

@@ -0,0 +1,459 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"encoding/json"
"strings"
"testing"
"time"
"github.com/larksuite/cli/internal/httpmock"
)
func TestAppsAnalyticsList_DryRunUsesNanoseconds(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users",
"--since", "2026-06-23T10:00:00Z", "--until", "2026-06-23T10:01:00Z",
"--granularity", "week", "--dry-run", "--as", "user",
}, factory, stdout)
if err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Method string `json:"method"`
URL string `json:"url"`
Body map[string]interface{} `json:"body"`
} `json:"api"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode dry-run: %v\n%s", err, stdout.String())
}
if env.API[0].Method != "POST" || env.API[0].URL != "/open-apis/spark/v1/apps/app_x/query_analytics_data" {
t.Fatalf("method/url = %s %s", env.API[0].Method, env.API[0].URL)
}
body := env.API[0].Body
if _, ok := body["start_timestamp_ns"]; !ok {
t.Fatalf("analytics dry-run missing start_timestamp_ns: %#v", body)
}
if _, ok := body["start_timestamp"]; ok {
t.Fatalf("analytics should not use start_timestamp: %#v", body)
}
if body["time_aggregation_unit"] != "WEEK" {
t.Fatalf("time_aggregation_unit = %v", body["time_aggregation_unit"])
}
if _, ok := body["app_env"]; ok {
t.Fatalf("analytics OpenAPI body should not include app_env: %#v", body)
}
if _, ok := body["analytics_types"]; ok {
t.Fatalf("analytics OpenAPI body should use metric_types, not analytics_types: %#v", body)
}
if body["need_pack_lack_point"] != false {
t.Fatalf("need_pack_lack_point = %#v, want false", body["need_pack_lack_point"])
}
if _, ok := body["group_by"]; ok {
t.Fatalf("group_by is intentionally unsupported for now: %#v", body)
}
if metricTypes, ok := body["metric_types"].([]interface{}); !ok || len(metricTypes) != 3 {
t.Fatalf("metric_types = %#v", body["metric_types"])
}
if body["start_timestamp_ns"] != "1782208800000000000" ||
body["end_timestamp_ns"] != "1782208860000000000" {
t.Fatalf("analytics timestamps = %#v %#v", body["start_timestamp_ns"], body["end_timestamp_ns"])
}
}
func TestAppsAnalyticsList_PageViewDesktopSeriesSetsDeviceFilter(t *testing.T) {
for _, tc := range []struct {
name string
args []string
}{
{
name: "series",
args: []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "page-view",
"--series", "desktop", "--page", "/home", "--dry-run", "--as", "user",
},
},
{
name: "device-type",
args: []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "page-view",
"--device-type", "desktop", "--dry-run", "--as", "user",
},
},
} {
t.Run(tc.name, func(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsAnalyticsList, tc.args, factory, stdout); err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Body map[string]interface{} `json:"body"`
} `json:"api"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode dry-run: %v\n%s", err, stdout.String())
}
filter := env.API[0].Body["filter"].(map[string]interface{})
deviceTypes := filter["device_types"].([]interface{})
if len(deviceTypes) != 1 || deviceTypes[0] != "desktop" {
t.Fatalf("device_types = %#v", deviceTypes)
}
if tc.name == "series" && filter["page"] != "/home" {
t.Fatalf("filter.page = %#v, want /home", filter["page"])
}
})
}
}
func TestAppsAnalyticsList_DesktopSeriesUsesDesktopValueLabel(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"series": []interface{}{
map[string]interface{}{
"metric_type": "PAGE_VIEW",
"points": []interface{}{
map[string]interface{}{
"timestamp_ns": float64(1782208800000000000),
"value": float64(21),
},
},
},
},
},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "page-view",
"--series", "desktop", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
var env struct {
Data struct {
Items []struct {
Values map[string]interface{} `json:"values"`
} `json:"items"`
} `json:"data"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode output: %v\n%s", err, stdout.String())
}
if len(env.Data.Items) != 1 {
t.Fatalf("items len = %d", len(env.Data.Items))
}
if env.Data.Items[0].Values["desktop"] != float64(21) {
t.Fatalf("values = %#v, want desktop=21", env.Data.Items[0].Values)
}
if _, ok := env.Data.Items[0].Values["page-view"]; ok {
t.Fatalf("values should not use page-view label: %#v", env.Data.Items[0].Values)
}
}
func TestAppsAnalyticsList_PrettyFormatsTimeFirst(t *testing.T) {
const rawNS = int64(1782208800000000000)
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"series": []interface{}{
map[string]interface{}{
"metric_type": "ACTIVE_USER",
"points": []interface{}{
map[string]interface{}{"timestamp_ns": float64(rawNS), "value": float64(7)},
},
},
},
},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users", "--series", "active", "--format", "pretty", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
got := stdout.String()
wantTime := time.Unix(0, rawNS).Local().Format("2006-01-02 15:04:05")
if !strings.HasPrefix(got, "time") {
t.Fatalf("pretty output should start with time column, got:\n%s", got)
}
if !strings.Contains(got, wantTime) {
t.Fatalf("pretty output missing formatted time %q:\n%s", wantTime, got)
}
if strings.Contains(got, "timestamp_ns") || strings.Contains(got, "1782208800000000000") {
t.Fatalf("pretty output should hide raw timestamp_ns, got:\n%s", got)
}
}
func TestAppsAnalyticsList_PrettySkipsRowsWithoutTime(t *testing.T) {
const rawNS = int64(1782208800000000000)
rows := []map[string]interface{}{
{"timestamp_ns": rawNS, "active-users": float64(7)},
{"active-users": float64(0)},
}
sortObservabilityRowsDesc(rows, "timestamp_ns")
rows = filterObservabilityRowsWithTime(rows, "timestamp_ns")
if len(rows) != 1 {
t.Fatalf("rows len = %d, want 1: %#v", len(rows), rows)
}
if rows[0]["timestamp_ns"] != rawNS {
t.Fatalf("remaining row = %#v", rows[0])
}
}
func TestAppsAnalyticsList_NamedSeriesDoesNotDependOnBackendOrder(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"series": []interface{}{
map[string]interface{}{
"metric_type": "TOTAL_USER",
"points": []interface{}{
map[string]interface{}{"timestamp_ns": float64(1782208800000000000), "value": float64(20)},
},
},
map[string]interface{}{
"metric_type": "ACTIVE_USER",
"points": []interface{}{
map[string]interface{}{"timestamp_ns": float64(1782208800000000000), "value": float64(7)},
},
},
map[string]interface{}{
"metric_type": "NEW_USER",
"points": []interface{}{
map[string]interface{}{"timestamp_ns": float64(1782208800000000000), "value": float64(3)},
},
},
},
},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
var env struct {
Data struct {
Items []struct {
Values map[string]interface{} `json:"values"`
} `json:"items"`
} `json:"data"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode output: %v\n%s", err, stdout.String())
}
if len(env.Data.Items) != 1 {
t.Fatalf("items len = %d", len(env.Data.Items))
}
values := env.Data.Items[0].Values
if values["active-users"] != float64(7) || values["new-users"] != float64(3) || values["total-users"] != float64(20) {
t.Fatalf("values = %#v, want active-users=7 new-users=3 total-users=20", values)
}
}
func TestAppsAnalyticsList_FillsMissingAndNullValuesWhenAnyValuePresent(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"items": []interface{}{
map[string]interface{}{
"timestamp_ns": "1782208800000000000",
"values": map[string]interface{}{
"total-users": float64(4),
"active-users": nil,
},
},
},
},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
var env struct {
Data struct {
Items []struct {
Values map[string]interface{} `json:"values"`
} `json:"items"`
} `json:"data"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode output: %v\n%s", err, stdout.String())
}
values := env.Data.Items[0].Values
if values["total-users"] != float64(4) || values["active-users"] != float64(0) || values["new-users"] != float64(0) {
t.Fatalf("values = %#v, want total-users=4 active-users=0 new-users=0", values)
}
}
func TestAppsAnalyticsList_DoesNotFillAllNullValues(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"items": []interface{}{
map[string]interface{}{
"timestamp_ns": "1782208800000000000",
"values": map[string]interface{}{
"total-users": nil,
"active-users": nil,
},
},
},
},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
var env struct {
Data struct {
Items []struct {
Values map[string]interface{} `json:"values"`
} `json:"items"`
} `json:"data"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode output: %v\n%s", err, stdout.String())
}
values := env.Data.Items[0].Values
if values["total-users"] != nil || values["active-users"] != nil {
t.Fatalf("values = %#v, want existing nulls preserved", values)
}
if _, ok := values["new-users"]; ok {
t.Fatalf("values should not fill missing labels when all present values are null: %#v", values)
}
}
func TestAppsAnalyticsList_EmptyResponseOutputsEmptyItemsArray(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/open-apis/spark/v1/apps/app_x/query_analytics_data",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{},
},
})
if err := runAppsShortcut(t, AppsAnalyticsList, []string{
"+analytics-list", "--app-id", "app_x", "--analytics", "users", "--as", "user",
}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
var env struct {
Data struct {
Items []map[string]interface{} `json:"items"`
HasMore bool `json:"has_more"`
} `json:"data"`
}
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
t.Fatalf("decode output: %v\n%s", err, stdout.String())
}
if env.Data.Items == nil {
t.Fatalf("items decoded as nil; stdout=%s", stdout.String())
}
if len(env.Data.Items) != 0 || env.Data.HasMore {
t.Fatalf("empty output = items %#v has_more %v", env.Data.Items, env.Data.HasMore)
}
}
func TestAnalyticsTypesMapping(t *testing.T) {
types, labels, filter, err := analyticsTypesForCLI("users", "", "")
if err != nil {
t.Fatal(err)
}
if strings.Join(types, ",") != "ACTIVE_USER,NEW_USER,TOTAL_USER" {
t.Fatalf("types = %#v", types)
}
if strings.Join(labels, ",") != "active-users,new-users,total-users" {
t.Fatalf("labels = %#v", labels)
}
if len(filter) != 0 {
t.Fatalf("filter = %#v, want empty", filter)
}
types, labels, filter, err = analyticsTypesForCLI("page-view", "", "")
if err != nil {
t.Fatal(err)
}
if strings.Join(types, ",") != "PAGE_VIEW" || strings.Join(labels, ",") != "all" {
t.Fatalf("page-view all mapping = %#v %#v", types, labels)
}
if len(filter) != 0 {
t.Fatalf("filter = %#v, want empty", filter)
}
types, labels, filter, err = analyticsTypesForCLI("page-view", "desktop", "")
if err != nil {
t.Fatal(err)
}
if strings.Join(types, ",") != "PAGE_VIEW" || strings.Join(labels, ",") != "desktop" {
t.Fatalf("page-view mapping = %#v %#v", types, labels)
}
deviceTypes := filter["device_types"].([]string)
if len(deviceTypes) != 1 || deviceTypes[0] != "desktop" {
t.Fatalf("device_types = %#v", deviceTypes)
}
types, labels, filter, err = analyticsTypesForCLI("page-view", "mobile-view", "")
if err != nil {
t.Fatal(err)
}
if strings.Join(types, ",") != "PAGE_VIEW" || strings.Join(labels, ",") != "mobile" {
t.Fatalf("page-view mobile mapping = %#v %#v", types, labels)
}
deviceTypes = filter["device_types"].([]string)
if len(deviceTypes) != 1 || deviceTypes[0] != "mobile" {
t.Fatalf("device_types = %#v", deviceTypes)
}
if _, _, _, err := analyticsTypesForCLI("users", "desktop", ""); err == nil {
t.Fatalf("users desktop series should fail")
}
if _, _, _, err := analyticsTypesForCLI("page-view", "tablet", ""); err == nil {
t.Fatalf("page-view tablet series should fail")
}
if _, _, _, err := analyticsTypesForCLI("page-view", "", "tablet"); err == nil {
t.Fatalf("tablet device type should fail")
}
}

View File

@@ -0,0 +1,302 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"fmt"
"io"
"strings"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/shortcuts/common"
)
// AppsDBAuditList 列出数据表的行级审计事件INSERT/UPDATE/DELETE 的变更追溯)。
//
// GET /apps/{app_id}/db/audit_listcursor 分页)。--table 可重复传多张表;--since/--until 多格式时间。
// operator 透传 {id,name}json 还原对象、pretty 取 namebefore/after 是条件出现的 JSON
// INSERT 无 before、DELETE 无 afterjson 还原成对象。
//
// 多表查询时CLI 先用 schema表是否存在+ status审计是否开启在本地过滤把不存在 /
// 未开启审计的表剔除后再查 audit_list被剔除的表及原因放进 skipped服务端不再返该字段
var AppsDBAuditList = common.Shortcut{
Service: appsService,
Command: "+db-audit-list",
Description: "List row-change audit events for one or more tables (cursor pagination)",
Risk: "read",
Tips: []string{
"Example: lark-cli apps +db-audit-list --app-id <app_id> --table orders",
"Multiple tables: repeat --table; filter time with --since 7d / --until 2026-04-15.",
},
Scopes: []string{"spark:app:read"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: append([]common.Flag{
{Name: "app-id", Desc: "Miaoda app id", Required: true},
{Name: "table", Type: "string_slice", Desc: "table(s) to list audit events for (repeatable)", Required: true},
{Name: "since", Desc: "filter: event at or after; relative (7d/2h) | date | datetime | ISO 8601 w/ TZ (bare date/datetime read in local timezone)"},
{Name: "until", Desc: "filter: event at or before; same formats as --since"},
{Name: "page-size", Type: "int", Default: "20", Desc: "page size"},
{Name: "page-token", Desc: "pagination cursor from previous response"},
}, dbEnvFlags("dev", []string{"dev", "online"}, "target db environment (default dev; use online for the online environment, or for an app whose DB is not multi-env)")...),
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
if err := rejectLegacyEnvFlag(rctx); err != nil {
return err
}
if len(auditListTables(rctx)) == 0 {
return errs.NewValidationError(errs.SubtypeInvalidArgument, "--table is required (at least one table)").WithParam("--table")
}
return normalizeTimeFlags(rctx, "since", "until")
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
appID, _ := requireAppID(rctx.Str("app-id"))
return common.NewDryRunAPI().
GET(appAuditListPath(appID)).
Desc("List Miaoda app table audit events").
Params(buildAuditListParams(rctx, auditListTables(rctx)))
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, err := requireAppID(rctx.Str("app-id"))
if err != nil {
return err
}
requested := auditListTables(rctx)
env := dbEnv(rctx)
// 多表查询CLI 侧先用 schema表是否存在+ status审计是否开启过滤
// 不存在 / 未开启审计的表不进 audit_list 查询,单独在 skipped 里给出原因。
// 单表查询直接打 audit_list由后端就 table-not-found / audit-not-enabled 报错。
queryTables := requested
var skipped []auditSkippedEntry
if len(requested) > 1 {
queryTables, skipped, err = filterAuditTables(rctx, appID, env, requested)
if err != nil {
return withAppsHint(err, dbChangelogHint)
}
// 所有请求表都被过滤掉 → 无可查询表,直接返回空 + skipped 提示,不调 audit_list。
if len(queryTables) == 0 {
out := map[string]interface{}{"items": []auditLogItem{}, "has_more": false, "skipped": skipped}
rctx.OutFormat(out, nil, func(w io.Writer) {
io.WriteString(w, "No audit events found.\n")
writeAuditSkipped(w, skipped, len(requested))
})
return nil
}
}
data, err := rctx.CallAPITyped("GET", appAuditListPath(appID), buildAuditListParams(rctx, queryTables), nil)
if err != nil {
return withAppsHint(err, dbChangelogHint)
}
items := projectAuditLogItems(data["items"])
data["items"] = items
// 服务端不再返 skipped改由 CLI 算出的 skipped 写回输出。
if len(skipped) > 0 {
data["skipped"] = skipped
} else {
delete(data, "skipped")
}
multi := len(requested) > 1
rctx.OutFormat(data, nil, func(w io.Writer) {
renderAuditListPretty(w, items, skipped, len(requested), multi)
})
return nil
},
}
// auditSkippedEntry 是被 CLI 预过滤掉的表及原因(替代已删除的服务端 skipped 字段)。
type auditSkippedEntry struct {
Table string `json:"table"`
Reason string `json:"reason"`
}
// filterAuditTables 用 schema存在性+ status审计开关把请求表分成「可查询」与「跳过」两组。
func filterAuditTables(rctx *common.RuntimeContext, appID, env string, requested []string) ([]string, []auditSkippedEntry, error) {
existing, err := fetchExistingTables(rctx, appID, env)
if err != nil {
return nil, nil, err
}
enabled, err := fetchAuditEnabledTables(rctx, appID, env)
if err != nil {
return nil, nil, err
}
valid := make([]string, 0, len(requested))
var skipped []auditSkippedEntry
for _, t := range requested {
switch {
case !existing[t]:
skipped = append(skipped, auditSkippedEntry{Table: t, Reason: "table not found"})
case !enabled[t]:
skipped = append(skipped, auditSkippedEntry{Table: t, Reason: "audit not enabled"})
default:
valid = append(valid, t)
}
}
return valid, skipped, nil
}
// fetchExistingTables 翻页拉全量表清单返回存在表名集合schema 命令同源接口)。
func fetchExistingTables(rctx *common.RuntimeContext, appID, env string) (map[string]bool, error) {
existing := map[string]bool{}
token := ""
for {
params := map[string]interface{}{"env": env, "page_size": 100}
if token != "" {
params["page_token"] = token
}
data, err := rctx.CallAPITyped("GET", appTablesPath(appID), params, nil)
if err != nil {
return nil, err
}
for _, it := range asMapSlice(data["items"]) {
if name := common.GetString(it, "name"); name != "" {
existing[name] = true
}
}
token = common.GetString(data, "page_token")
if data["has_more"] != true || token == "" {
break
}
}
return existing, nil
}
// fetchAuditEnabledTables 拉审计状态返回当前已开启审计的表名集合status 命令同源接口)。
func fetchAuditEnabledTables(rctx *common.RuntimeContext, appID, env string) (map[string]bool, error) {
data, err := rctx.CallAPITyped("GET", appAuditStatusPath(appID), map[string]interface{}{"env": env}, nil)
if err != nil {
return nil, err
}
enabled := map[string]bool{}
for _, it := range asMapSlice(data["items"]) {
if it["enabled"] == true {
if name := common.GetString(it, "table"); name != "" {
enabled[name] = true
}
}
}
return enabled, nil
}
// asMapSlice 把 interface{}[]interface{})里的每个 map 元素取出,非 map 丢弃。
func asMapSlice(raw interface{}) []map[string]interface{} {
arr, _ := raw.([]interface{})
out := make([]map[string]interface{}, 0, len(arr))
for _, it := range arr {
if m, ok := it.(map[string]interface{}); ok {
out = append(out, m)
}
}
return out
}
// auditListTables 取 --table 切片trim 去空。
func auditListTables(rctx *common.RuntimeContext) []string {
out := make([]string, 0)
for _, t := range rctx.StrSlice("table") {
if v := strings.TrimSpace(t); v != "" {
out = append(out, v)
}
}
return out
}
// buildAuditListParams 组装 audit_list 查询参数env / tables(逗号拼接) / page_size 及可选 since/until/page_token。
func buildAuditListParams(rctx *common.RuntimeContext, tables []string) map[string]interface{} {
params := map[string]interface{}{
"env": dbEnv(rctx),
"tables": strings.Join(tables, ","),
"page_size": rctx.Int("page-size"),
}
addStr := func(flag, key string) {
if v := strings.TrimSpace(rctx.Str(flag)); v != "" {
params[key] = v
}
}
addStr("since", "since")
addStr("until", "until")
addStr("page-token", "page_token")
return params
}
type auditLogItem struct {
EventID string `json:"event_id"`
EventTime string `json:"event_time"`
TargetTable string `json:"target_table"`
Type string `json:"type"`
Operator *operatorRef `json:"operator,omitempty"`
Summary string `json:"summary"`
Before interface{} `json:"before,omitempty"`
After interface{} `json:"after,omitempty"`
}
// projectAuditLogItems 把服务端原始审计事件投影为白名单 auditLogItemoperator 解析、before/after 还原成对象)。
func projectAuditLogItems(raw interface{}) []auditLogItem {
arr, _ := raw.([]interface{})
out := make([]auditLogItem, 0, len(arr))
for _, it := range arr {
m, ok := it.(map[string]interface{})
if !ok {
continue
}
row := auditLogItem{
EventID: common.GetString(m, "event_id"),
EventTime: common.GetString(m, "event_time"),
TargetTable: common.GetString(m, "target_table"),
Type: common.GetString(m, "type"),
Operator: parseOperator(common.GetString(m, "operator")),
Summary: common.GetString(m, "summary"),
}
// before/after 条件出现INSERT 无 before、DELETE 无 after。JSON 字符串 → 还原对象。
if b := common.GetString(m, "before"); b != "" {
row.Before = safeParseJSON(b)
}
if a := common.GetString(m, "after"); a != "" {
row.After = safeParseJSON(a)
}
out = append(out, row)
}
return out
}
// renderAuditListPretty 单表 5 列 / 多表 6 列(首列 target_table末尾列出 skipped 表。
func renderAuditListPretty(w io.Writer, items []auditLogItem, skipped []auditSkippedEntry, totalRequested int, multi bool) {
if len(items) == 0 {
io.WriteString(w, "No audit events found.\n")
writeAuditSkipped(w, skipped, totalRequested)
return
}
var headers []string
if multi {
headers = []string{"target_table", "event_time", "type", "event_id", "operator", "summary"}
} else {
headers = []string{"event_time", "type", "event_id", "operator", "summary"}
}
rows := make([][]string, 0, len(items))
for _, it := range items {
cells := []string{dashIfEmpty(it.EventTime), it.Type, it.EventID, operatorName(it.Operator), dashIfEmpty(it.Summary)}
if multi {
cells = append([]string{dashIfEmpty(it.TargetTable)}, cells...)
}
rows = append(rows, cells)
}
renderAlignedTable(w, headers, rows)
writeAuditSkipped(w, skipped, totalRequested)
}
// writeAuditSkipped 打 "— Skipped N of M tables: orders (audit not enabled), foo (table not found)"。
func writeAuditSkipped(w io.Writer, skipped []auditSkippedEntry, totalRequested int) {
if len(skipped) == 0 {
return
}
parts := make([]string, 0, len(skipped))
for _, s := range skipped {
parts = append(parts, fmt.Sprintf("%s (%s)", s.Table, s.Reason))
}
fmt.Fprintf(w, "— Skipped %d of %d tables: %s\n", len(skipped), totalRequested, strings.Join(parts, ", "))
}

View File

@@ -0,0 +1,144 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"fmt"
"io"
"strings"
"github.com/larksuite/cli/shortcuts/common"
)
// 审计保留期合法取值。
var auditRetentions = []string{"7d", "30d", "180d", "360d", "forever"}
const dbAuditSetHint = "verify --app-id and --table; check current config with `lark-cli apps +db-audit-status --app-id <app_id>`"
// AppsDBAuditEnable 为某张表开启行级审计(变更追溯)。
//
// POST /apps/{app_id}/db/audit_setbody {table, enabled:true, retention}。--retention 默认 7d。
var AppsDBAuditEnable = common.Shortcut{
Service: appsService,
Command: "+db-audit-enable",
Description: "Enable row-change audit logging for a table",
Risk: "write",
Tips: []string{
"Example: lark-cli apps +db-audit-enable --app-id <app_id> --table orders --retention 30d",
},
Scopes: []string{"spark:app:write"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: append([]common.Flag{
{Name: "app-id", Desc: "Miaoda app id", Required: true},
{Name: "table", Desc: "table to enable audit for", Required: true},
{Name: "retention", Default: "7d", Enum: auditRetentions, Desc: "how long to keep audit logs"},
}, dbEnvFlags("dev", []string{"dev", "online"}, "target db environment (default dev; use online for the online environment, or for an app whose DB is not multi-env)")...),
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
return rejectLegacyEnvFlag(rctx)
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
appID, _ := requireAppID(rctx.Str("app-id"))
return common.NewDryRunAPI().
POST(appAuditSetPath(appID)).
Desc("Enable table audit").
Params(map[string]interface{}{"env": dbEnv(rctx)}).
Body(map[string]interface{}{"table": strings.TrimSpace(rctx.Str("table")), "enabled": true, "retention": rctx.Str("retention")})
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, err := requireAppID(rctx.Str("app-id"))
if err != nil {
return err
}
table := strings.TrimSpace(rctx.Str("table"))
retention := rctx.Str("retention")
stop := rctx.StartSpinner("Enabling audit logging for " + table)
defer stop()
data, err := rctx.CallAPITyped("POST", appAuditSetPath(appID),
map[string]interface{}{"env": dbEnv(rctx)},
map[string]interface{}{"table": table, "enabled": true, "retention": retention})
stop()
if err != nil {
return withAppsHint(err, dbAuditSetHint)
}
st := auditSetStatus(data, table)
ret := common.GetString(st, "retention")
if ret == "" {
ret = retention
}
out := map[string]interface{}{"table": common.GetString(st, "table"), "enabled": true, "retention": ret}
rctx.OutFormat(out, nil, func(w io.Writer) {
fmt.Fprintf(w, "✓ Audit enabled for table '%s' (retention: %s)\n", common.GetString(out, "table"), ret)
})
return nil
},
}
// AppsDBAuditDisable 关闭某张表的行级审计。
//
// POST /apps/{app_id}/db/audit_setbody {table, enabled:false}。
var AppsDBAuditDisable = common.Shortcut{
Service: appsService,
Command: "+db-audit-disable",
Description: "Disable row-change audit logging for a table",
Risk: "write",
Tips: []string{
"Example: lark-cli apps +db-audit-disable --app-id <app_id> --table orders",
},
Scopes: []string{"spark:app:write"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: append([]common.Flag{
{Name: "app-id", Desc: "Miaoda app id", Required: true},
{Name: "table", Desc: "table to disable audit for", Required: true},
}, dbEnvFlags("dev", []string{"dev", "online"}, "target db environment (default dev; use online for the online environment, or for an app whose DB is not multi-env)")...),
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
return rejectLegacyEnvFlag(rctx)
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
appID, _ := requireAppID(rctx.Str("app-id"))
return common.NewDryRunAPI().
POST(appAuditSetPath(appID)).
Desc("Disable table audit").
Params(map[string]interface{}{"env": dbEnv(rctx)}).
Body(map[string]interface{}{"table": strings.TrimSpace(rctx.Str("table")), "enabled": false})
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, err := requireAppID(rctx.Str("app-id"))
if err != nil {
return err
}
table := strings.TrimSpace(rctx.Str("table"))
data, err := rctx.CallAPITyped("POST", appAuditSetPath(appID),
map[string]interface{}{"env": dbEnv(rctx)},
map[string]interface{}{"table": table, "enabled": false})
if err != nil {
return withAppsHint(err, dbAuditSetHint)
}
st := auditSetStatus(data, table)
out := map[string]interface{}{"table": common.GetString(st, "table"), "enabled": false}
rctx.OutFormat(out, nil, func(w io.Writer) {
fmt.Fprintf(w, "✓ Audit disabled for table '%s'\n", common.GetString(out, "table"))
})
return nil
},
}
// auditSetStatus 取响应里的 status 对象(缺失时用入参 table 兜底)。
func auditSetStatus(data map[string]interface{}, table string) map[string]interface{} {
if st, ok := data["status"].(map[string]interface{}); ok {
if common.GetString(st, "table") == "" {
st["table"] = table
}
return st
}
return map[string]interface{}{"table": table}
}

View File

@@ -0,0 +1,140 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"io"
"strings"
"github.com/larksuite/cli/shortcuts/common"
)
// AppsDBAuditStatus 查看数据表的审计开关状态(哪些表开了行级审计、保留期)。
//
// GET /apps/{app_id}/db/audit_status。--table 指定单表(无记录时占位 enabled=false
// 不指定返回所有已配置表。json 单表返对象、多表返数组pretty 单表 key/value、多表表格。
var AppsDBAuditStatus = common.Shortcut{
Service: appsService,
Command: "+db-audit-status",
Description: "Show table audit (row-change tracking) status",
Risk: "read",
Tips: []string{
"Example: lark-cli apps +db-audit-status --app-id <app_id>",
"Check one table: --table orders",
},
Scopes: []string{"spark:app:read"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: append([]common.Flag{
{Name: "app-id", Desc: "Miaoda app id", Required: true},
{Name: "table", Desc: "show status for a single table (default: all configured tables)"},
}, dbEnvFlags("dev", []string{"dev", "online"}, "target db environment (default dev; use online for the online environment, or for an app whose DB is not multi-env)")...),
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
return rejectLegacyEnvFlag(rctx)
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
appID, _ := requireAppID(rctx.Str("app-id"))
return common.NewDryRunAPI().
GET(appAuditStatusPath(appID)).
Desc("Get table audit status").
Params(buildAuditStatusParams(rctx))
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, err := requireAppID(rctx.Str("app-id"))
if err != nil {
return err
}
data, err := rctx.CallAPITyped("GET", appAuditStatusPath(appID), buildAuditStatusParams(rctx), nil)
if err != nil {
return withAppsHint(err, dbChangelogHint)
}
table := strings.TrimSpace(rctx.Str("table"))
items := projectAuditStatusItems(data["items"])
// 单表查询但后端无记录 → 占位 enabled=false与 miaoda 一致)。
if table != "" && len(items) == 0 {
items = []map[string]interface{}{{"table": table, "enabled": false}}
}
// json单表返对象、多表返数组。
var out interface{}
if table != "" && len(items) == 1 {
out = items[0]
} else {
out = map[string]interface{}{"items": items}
}
rctx.OutFormat(out, nil, func(w io.Writer) {
renderAuditStatusPretty(w, items, table)
})
return nil
},
}
// buildAuditStatusParams 组装 audit_status 查询参数env 及可选 table单表查询
func buildAuditStatusParams(rctx *common.RuntimeContext) map[string]interface{} {
params := map[string]interface{}{"env": dbEnv(rctx)}
if t := strings.TrimSpace(rctx.Str("table")); t != "" {
params["table"] = t
}
return params
}
// projectAuditStatusItems 透出 {table, enabled, enabled_at?, retention?}。
func projectAuditStatusItems(raw interface{}) []map[string]interface{} {
arr, _ := raw.([]interface{})
out := make([]map[string]interface{}, 0, len(arr))
for _, it := range arr {
m, ok := it.(map[string]interface{})
if !ok {
continue
}
row := map[string]interface{}{
"table": common.GetString(m, "table"),
"enabled": m["enabled"] == true,
}
if v := common.GetString(m, "enabled_at"); v != "" {
row["enabled_at"] = v
}
if v := common.GetString(m, "retention"); v != "" {
row["retention"] = v
}
out = append(out, row)
}
return out
}
// renderAuditStatusPretty 单表渲染 key/value、多表渲染对齐表格table/enabled/enabled_at/retention
func renderAuditStatusPretty(w io.Writer, items []map[string]interface{}, table string) {
if len(items) == 0 {
io.WriteString(w, "No audit configuration found.\n")
return
}
yesNo := func(m map[string]interface{}) string {
if m["enabled"] == true {
return "yes"
}
return "no"
}
get := func(m map[string]interface{}, k string) string { return dashIfEmpty(common.GetString(m, k)) }
// 单表 → key/value
if table != "" && len(items) == 1 {
it := items[0]
renderKeyValuePairs(w, [][2]string{
{"table", common.GetString(it, "table")},
{"enabled", yesNo(it)},
{"enabled_at", get(it, "enabled_at")},
{"retention", get(it, "retention")},
})
return
}
// 多表 → 表格
headers := []string{"table", "enabled", "enabled_at", "retention"}
rows := make([][]string, 0, len(items))
for _, it := range items {
rows = append(rows, []string{common.GetString(it, "table"), yesNo(it), get(it, "enabled_at"), get(it, "retention")})
}
renderAlignedTable(w, headers, rows)
}

View File

@@ -0,0 +1,316 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"encoding/json"
"errors"
"net/http"
"strings"
"testing"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/internal/httpmock"
)
const (
dbAuditStatusURL = "/open-apis/spark/v1/apps/app_x/db/audit_status"
dbAuditSetURL = "/open-apis/spark/v1/apps/app_x/db/audit_set"
dbAuditListURL = "/open-apis/spark/v1/apps/app_x/db/audit_list"
dbTablesListURL = "/open-apis/spark/v1/apps/app_x/tables"
)
// ── audit-status ──
// TestAppsDBAuditStatus_SingleTableObjectWithPlaceholder 验证单表查询无记录时返回 enabled:false 的占位对象(非数组)。
func TestAppsDBAuditStatus_SingleTableObjectWithPlaceholder(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditStatusURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{}}},
})
if err := runAppsShortcut(t, AppsDBAuditStatus,
[]string{"+db-audit-status", "--app-id", "app_x", "--table", "orders", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
// 单表无记录 → 占位对象 enabled:false不是数组
var env struct {
Data struct {
Table string `json:"table"`
Enabled bool `json:"enabled"`
} `json:"data"`
}
if err := json.Unmarshal([]byte(stdout.String()), &env); err != nil {
t.Fatalf("decode: %v\n%s", err, stdout.String())
}
if env.Data.Table != "orders" || env.Data.Enabled {
t.Fatalf("expected placeholder {orders,false}, got %+v", env.Data)
}
}
// TestAppsDBAuditStatus_MultiTablePrettyTable 验证多表 pretty 输出含 enabled/yes/no 列与 retention 值。
func TestAppsDBAuditStatus_MultiTablePrettyTable(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditStatusURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{
map[string]interface{}{"table": "orders", "enabled": true, "enabled_at": "2026-04-15T10:30:00Z", "retention": "30d"},
map[string]interface{}{"table": "users", "enabled": false},
}}},
})
if err := runAppsShortcut(t, AppsDBAuditStatus,
[]string{"+db-audit-status", "--app-id", "app_x", "--format", "pretty", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
got := stdout.String()
if !strings.Contains(got, "enabled") || !strings.Contains(got, "yes") || !strings.Contains(got, "no") || !strings.Contains(got, "30d") {
t.Fatalf("pretty table malformed:\n%s", got)
}
}
// ── audit-enable / disable ──
// TestAppsDBAuditEnable_RequiresTableAndValidRetention 验证缺 --table 报必填错、非法 --retention 报 ValidationError。
func TestAppsDBAuditEnable_RequiresTableAndValidRetention(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
// 缺 --table → cobra required, exit 1
if err := runAppsShortcut(t, AppsDBAuditEnable,
[]string{"+db-audit-enable", "--app-id", "app_x", "--as", "user"}, factory, stdout); err == nil {
t.Fatalf("expected required --table error")
}
// 非法 retention → enum 校验 (validation)
factory2, stdout2, _ := newAppsExecuteFactory(t)
err := runAppsShortcut(t, AppsDBAuditEnable,
[]string{"+db-audit-enable", "--app-id", "app_x", "--table", "orders", "--retention", "99d", "--as", "user"}, factory2, stdout2)
var ve *errs.ValidationError
if !errors.As(err, &ve) {
t.Fatalf("err = %T %v, want *errs.ValidationError", err, err)
}
if ve.Param != "--retention" {
t.Fatalf("Param = %q, want --retention", ve.Param)
}
}
// TestAppsDBAuditEnable_DryRunAndSuccess 验证 dry-run 发出 enabled:true+retention 的 POST成功时打印 pretty 确认行。
func TestAppsDBAuditEnable_DryRunAndSuccess(t *testing.T) {
// dry-run body {table, enabled:true, retention}
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsDBAuditEnable,
[]string{"+db-audit-enable", "--app-id", "app_x", "--table", "orders", "--retention", "30d", "--dry-run", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Method string `json:"method"`
URL string `json:"url"`
Body map[string]interface{} `json:"body"`
} `json:"api"`
}
_ = json.Unmarshal([]byte(stdout.String()), &env)
a := env.API[0]
if a.Method != "POST" || a.URL != dbAuditSetURL || a.Body["enabled"] != true || a.Body["retention"] != "30d" || a.Body["table"] != "orders" {
t.Fatalf("dry-run = %s %s body=%v", a.Method, a.URL, a.Body)
}
// success
factory2, stdout2, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST", URL: dbAuditSetURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"status": map[string]interface{}{"table": "orders", "enabled": true, "retention": "30d"}}},
})
if err := runAppsShortcut(t, AppsDBAuditEnable,
[]string{"+db-audit-enable", "--app-id", "app_x", "--table", "orders", "--retention", "30d", "--format", "pretty", "--as", "user"}, factory2, stdout2); err != nil {
t.Fatalf("execute err=%v", err)
}
if !strings.Contains(stdout2.String(), "✓ Audit enabled for table 'orders' (retention: 30d)") {
t.Fatalf("pretty: %s", stdout2.String())
}
}
// TestAppsDBAuditDisable_DryRunAndSuccess 验证 dry-run 发出 enabled:false 的 POST成功时打印 pretty 确认行。
func TestAppsDBAuditDisable_DryRunAndSuccess(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsDBAuditDisable,
[]string{"+db-audit-disable", "--app-id", "app_x", "--table", "orders", "--dry-run", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Body map[string]interface{} `json:"body"`
} `json:"api"`
}
_ = json.Unmarshal([]byte(stdout.String()), &env)
if env.API[0].Body["enabled"] != false || env.API[0].Body["table"] != "orders" {
t.Fatalf("dry-run body=%v (want enabled:false)", env.API[0].Body)
}
factory2, stdout2, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "POST", URL: dbAuditSetURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"status": map[string]interface{}{"table": "orders", "enabled": false}}},
})
if err := runAppsShortcut(t, AppsDBAuditDisable,
[]string{"+db-audit-disable", "--app-id", "app_x", "--table", "orders", "--format", "pretty", "--as", "user"}, factory2, stdout2); err != nil {
t.Fatalf("execute err=%v", err)
}
if !strings.Contains(stdout2.String(), "✓ Audit disabled for table 'orders'") {
t.Fatalf("pretty: %s", stdout2.String())
}
}
// ── audit-list ──
// TestAppsDBAuditList_RequiresTable 验证缺 --table 时报必填错误。
func TestAppsDBAuditList_RequiresTable(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--as", "user"}, factory, stdout); err == nil {
t.Fatalf("expected required --table error")
}
}
// TestAppsDBAuditList_DryRunJoinsTables 验证 dry-run 将多个 --table 合并为 tables=orders,users 且归一化 since。
func TestAppsDBAuditList_DryRunJoinsTables(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--table", "orders", "--table", "users", "--since", "7d", "--dry-run", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Method string `json:"method"`
URL string `json:"url"`
Params map[string]interface{} `json:"params"`
} `json:"api"`
}
_ = json.Unmarshal([]byte(stdout.String()), &env)
a := env.API[0]
if a.Method != "GET" || a.URL != dbAuditListURL || a.Params["tables"] != "orders,users" {
t.Fatalf("dry-run = %s %s tables=%v", a.Method, a.URL, a.Params["tables"])
}
if s, _ := a.Params["since"].(string); !strings.HasSuffix(s, "Z") {
t.Fatalf("since not normalized: %v", a.Params["since"])
}
}
// 单表查询:不预过滤、直接打 audit_list后端就 not-found/not-enabled 报错),无 skipped。
// TestAppsDBAuditList_SingleTableNoPreflight 验证单表查询不预过滤、operator/before/after 还原为对象、无 skipped。
func TestAppsDBAuditList_SingleTableNoPreflight(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditListURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{
"has_more": false, "page_token": "",
"items": []interface{}{map[string]interface{}{
"event_id": "01525", "event_time": "2026-04-16T10:30:00Z", "target_table": "users",
"type": "UPDATE", "operator": `{"id":"7311","name":"alice"}`, "summary": "UPDATE 1 field",
"before": `{"amount":100}`, "after": `{"amount":999}`,
}},
}},
})
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--table", "users", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
got := stdout.String()
// operator → 对象before/after → 还原成对象(非字符串)。
for _, want := range []string{`"name": "alice"`, `"before"`, `"amount": 100`, `"after"`, `"amount": 999`} {
if !strings.Contains(got, want) {
t.Errorf("missing %q:\n%s", want, got)
}
}
if strings.Contains(got, `"skipped"`) {
t.Errorf("single-table query must not emit skipped:\n%s", got)
}
if strings.Contains(got, `"before": "{`) {
t.Errorf("before should be an object, not a JSON string:\n%s", got)
}
}
// TestAppsDBAuditList_SingleTableEmptyPretty 验证单表无事件时不报错、pretty 打印 "No audit events found." 且无 Skipped。
func TestAppsDBAuditList_SingleTableEmptyPretty(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditListURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{}}},
})
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--table", "orders", "--format", "pretty", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("empty audit list should NOT error (ok read), got %v", err)
}
got := stdout.String()
if !strings.Contains(got, "No audit events found.") || strings.Contains(got, "Skipped") {
t.Fatalf("expected empty, no skipped for single table:\n%s", got)
}
}
// 多表查询CLI 用 schema存在性+ status审计开关预过滤只把有效表传给 audit_list
// 不存在 / 未开启审计的表进 skipped。
// TestAppsDBAuditList_MultiTablePreflightFilters 验证多表查询用 schema+status 预过滤,仅传有效表,不存在/未开审计的表进 skipped。
func TestAppsDBAuditList_MultiTablePreflightFilters(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
// schemaorders/users/carts 存在ghost 不存在。
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbTablesListURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"has_more": false, "items": []interface{}{
map[string]interface{}{"name": "orders"}, map[string]interface{}{"name": "users"}, map[string]interface{}{"name": "carts"},
}}},
})
// statusorders/users 开启审计carts 未开启。
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditStatusURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{
map[string]interface{}{"table": "orders", "enabled": true}, map[string]interface{}{"table": "users", "enabled": true},
map[string]interface{}{"table": "carts", "enabled": false},
}}},
})
// audit_list 只应被传入有效表 orders,users。
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditListURL,
OnMatch: func(req *http.Request) {
if got := req.URL.Query().Get("tables"); got != "orders,users" {
t.Errorf("audit_list tables = %q, want orders,users (filtered)", got)
}
},
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"has_more": false, "items": []interface{}{
map[string]interface{}{"event_id": "e1", "event_time": "2026-04-16T10:30:00Z", "target_table": "orders", "type": "INSERT", "summary": "INSERT"},
}}},
})
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--table", "orders", "--table", "users", "--table", "carts", "--table", "ghost", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
got := stdout.String()
// skippedcarts(audit not enabled) + ghost(table not found),结构化 {table,reason}。
for _, want := range []string{`"skipped"`, `"table": "carts"`, `"reason": "audit not enabled"`, `"table": "ghost"`, `"reason": "table not found"`} {
if !strings.Contains(got, want) {
t.Errorf("missing %q:\n%s", want, got)
}
}
}
// 多表查询且全部被过滤掉 → 不调 audit_list直接空 + skipped 提示。
// TestAppsDBAuditList_MultiTableAllFilteredSkipsQuery 验证多表全部被过滤时跳过 audit_list 调用,直接输出空结果加 Skipped 提示。
func TestAppsDBAuditList_MultiTableAllFilteredSkipsQuery(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbTablesListURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"has_more": false, "items": []interface{}{
map[string]interface{}{"name": "orders"},
}}},
})
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbAuditStatusURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{}}},
})
// 不注册 audit_list若被调用会命中未注册请求而报错。
if err := runAppsShortcut(t, AppsDBAuditList,
[]string{"+db-audit-list", "--app-id", "app_x", "--table", "ghost1", "--table", "ghost2", "--format", "pretty", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("all-filtered should still succeed (empty), got %v", err)
}
got := stdout.String()
if !strings.Contains(got, "No audit events found.") || !strings.Contains(got, "Skipped 2 of 2 tables") {
t.Fatalf("expected empty + 'Skipped 2 of 2 tables':\n%s", got)
}
}

View File

@@ -0,0 +1,152 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"fmt"
"io"
"strings"
"github.com/larksuite/cli/shortcuts/common"
)
const dbChangelogHint = "verify --app-id is correct; if targeting --environment dev, create it first with `lark-cli apps +db-env-create --app-id <app_id> --environment dev`"
// AppsDBChangelogList 列出应用数据库的 DDL 变更记录(建表/改表/索引等结构变更追溯)。
//
// GET /apps/{app_id}/db/changelog_listcursor 分页)。过滤:--table、--since/--until多格式时间
// --change-id 精确查单条命中返单条、否则空。operator 后端以 JSON 字符串透传 {id,name}
// json 还原成对象、pretty 只展示 name。
var AppsDBChangelogList = common.Shortcut{
Service: appsService,
Command: "+db-changelog-list",
Description: "List a Miaoda app database's DDL change history (cursor pagination)",
Risk: "read",
Tips: []string{
"Example: lark-cli apps +db-changelog-list --app-id <app_id>",
"Pin a single change with --change-id; filter time with --since 7d / --until 2026-04-15.",
},
Scopes: []string{"spark:app:read"},
AuthTypes: []string{"user"},
HasFormat: true,
Flags: append([]common.Flag{
{Name: "app-id", Desc: "Miaoda app id", Required: true},
{Name: "table", Desc: "filter by target table"},
{Name: "change-id", Desc: "look up a single change by id (returns that one record only)"},
{Name: "since", Desc: "filter: changed at or after; relative (7d/2h) | date | datetime | ISO 8601 w/ TZ (bare date/datetime read in local timezone)"},
{Name: "until", Desc: "filter: changed at or before; same formats as --since"},
{Name: "page-size", Type: "int", Default: "20", Desc: "page size"},
{Name: "page-token", Desc: "pagination cursor from previous response"},
}, dbEnvFlags("dev", []string{"dev", "online"}, "target db environment (default dev; use online for the online environment, or for an app whose DB is not multi-env)")...),
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
if _, err := requireAppID(rctx.Str("app-id")); err != nil {
return err
}
if err := rejectLegacyEnvFlag(rctx); err != nil {
return err
}
return normalizeTimeFlags(rctx, "since", "until")
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
appID, _ := requireAppID(rctx.Str("app-id"))
return common.NewDryRunAPI().
GET(appChangelogListPath(appID)).
Desc("List Miaoda app DDL changelog").
Params(buildChangelogParams(rctx))
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
appID, err := requireAppID(rctx.Str("app-id"))
if err != nil {
return err
}
data, err := rctx.CallAPITyped("GET", appChangelogListPath(appID), buildChangelogParams(rctx), nil)
if err != nil {
return withAppsHint(err, dbChangelogHint)
}
items := projectChangelogItems(data["items"])
data["items"] = items
changeID := strings.TrimSpace(rctx.Str("change-id"))
rctx.OutFormat(data, nil, func(w io.Writer) {
renderChangelogPretty(w, items, changeID)
})
return nil
},
}
// buildChangelogParams 组装 changelog_list 查询参数env / page_size 及可选 table/change_id/since/until/page_token。
func buildChangelogParams(rctx *common.RuntimeContext) map[string]interface{} {
params := map[string]interface{}{
"env": dbEnv(rctx),
"page_size": rctx.Int("page-size"),
}
addStr := func(flag, key string) {
if v := strings.TrimSpace(rctx.Str(flag)); v != "" {
params[key] = v
}
}
addStr("table", "table")
addStr("change-id", "change_id")
addStr("since", "since")
addStr("until", "until")
addStr("page-token", "page_token")
return params
}
type changelogItem struct {
ChangeID string `json:"change_id"`
ChangedAt string `json:"changed_at"`
Operator *operatorRef `json:"operator,omitempty"`
TargetTable string `json:"target_table"`
ChangeType string `json:"change_type"`
Summary string `json:"summary"`
Statement string `json:"statement,omitempty"`
}
// projectChangelogItems 把服务端原始 DDL 变更记录投影为白名单 changelogItemoperator 解析成对象)。
func projectChangelogItems(raw interface{}) []changelogItem {
arr, _ := raw.([]interface{})
out := make([]changelogItem, 0, len(arr))
for _, it := range arr {
m, ok := it.(map[string]interface{})
if !ok {
continue
}
out = append(out, changelogItem{
ChangeID: common.GetString(m, "change_id"),
ChangedAt: common.GetString(m, "changed_at"),
Operator: parseOperator(common.GetString(m, "operator")),
TargetTable: common.GetString(m, "target_table"),
ChangeType: common.GetString(m, "change_type"),
Summary: common.GetString(m, "summary"),
Statement: common.GetString(m, "statement"),
})
}
return out
}
// renderChangelogPretty 6 列change_id / changed_at / operator(name) / target_table / change_type / summary。
func renderChangelogPretty(w io.Writer, items []changelogItem, changeID string) {
if len(items) == 0 {
if changeID != "" {
fmt.Fprintf(w, "No DDL change with id=%s found.\n", changeID)
} else {
io.WriteString(w, "No DDL changes found.\n")
}
return
}
headers := []string{"change_id", "changed_at", "operator", "target_table", "change_type", "summary"}
rows := make([][]string, 0, len(items))
for _, it := range items {
rows = append(rows, []string{
it.ChangeID,
dashIfEmpty(it.ChangedAt),
operatorName(it.Operator),
dashIfEmpty(it.TargetTable),
it.ChangeType,
dashIfEmpty(it.Summary),
})
}
renderAlignedTable(w, headers, rows)
}

View File

@@ -0,0 +1,143 @@
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"encoding/json"
"errors"
"strings"
"testing"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/internal/httpmock"
)
const dbChangelogURL = "/open-apis/spark/v1/apps/app_x/db/changelog_list"
// TestAppsDBChangelogList_RequiresAppID 验证空白 --app-id 报 --app-id 的 ValidationError。
func TestAppsDBChangelogList_RequiresAppID(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
err := runAppsShortcut(t, AppsDBChangelogList,
[]string{"+db-changelog-list", "--app-id", " ", "--as", "user"}, factory, stdout)
var ve *errs.ValidationError
if !errors.As(err, &ve) {
t.Fatalf("err = %T %v, want *errs.ValidationError", err, err)
}
if ve.Param != "--app-id" {
t.Fatalf("Param = %q, want --app-id", ve.Param)
}
}
// TestAppsDBChangelogList_DryRunFiltersAndTimeNormalize 验证 dry-run 透传 env/table/change_id 过滤参数并将 since 归一化为 RFC3339 UTC。
func TestAppsDBChangelogList_DryRunFiltersAndTimeNormalize(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
if err := runAppsShortcut(t, AppsDBChangelogList,
[]string{"+db-changelog-list", "--app-id", "app_x", "--environment", "dev", "--table", "orders",
"--change-id", "01J", "--since", "2026-01-01", "--page-size", "5", "--dry-run", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("dry-run err=%v", err)
}
var env struct {
API []struct {
Method string `json:"method"`
URL string `json:"url"`
Params map[string]interface{} `json:"params"`
} `json:"api"`
}
_ = json.Unmarshal([]byte(stdout.String()), &env)
a := env.API[0]
if a.Method != "GET" || a.URL != dbChangelogURL {
t.Fatalf("dry-run = %s %s", a.Method, a.URL)
}
if a.Params["env"] != "dev" || a.Params["table"] != "orders" || a.Params["change_id"] != "01J" {
t.Fatalf("params = %v", a.Params)
}
if s, _ := a.Params["since"].(string); !strings.HasSuffix(s, "Z") {
t.Fatalf("since not normalized to RFC3339 UTC: %v", a.Params["since"])
}
}
// TestAppsDBChangelogList_RejectsBadSince 验证不可解析的 --since 报 --since 的 ValidationError。
func TestAppsDBChangelogList_RejectsBadSince(t *testing.T) {
factory, stdout, _ := newAppsExecuteFactory(t)
err := runAppsShortcut(t, AppsDBChangelogList,
[]string{"+db-changelog-list", "--app-id", "app_x", "--since", "notatime", "--as", "user"}, factory, stdout)
var ve *errs.ValidationError
if !errors.As(err, &ve) {
t.Fatalf("err = %T %v, want *errs.ValidationError", err, err)
}
if ve.Param != "--since" {
t.Fatalf("Param = %q, want --since", ve.Param)
}
}
// TestAppsDBChangelogList_SuccessParsesOperator 验证成功响应中 operator JSON 串被解析为对象并输出变更字段。
func TestAppsDBChangelogList_SuccessParsesOperator(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbChangelogURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{
"has_more": false, "page_token": "",
"items": []interface{}{map[string]interface{}{
"change_id": "01J", "changed_at": "2026-04-15T10:30:00Z",
"operator": `{"id":"7311","name":"alice"}`, "target_table": "orders",
"change_type": "ALTER_TABLE", "summary": "add column", "statement": "ALTER TABLE orders ...",
}},
}},
})
if err := runAppsShortcut(t, AppsDBChangelogList,
[]string{"+db-changelog-list", "--app-id", "app_x", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
got := stdout.String()
for _, want := range []string{`"operator"`, `"name": "alice"`, `"id": "7311"`, `"change_type": "ALTER_TABLE"`, `"statement"`} {
if !strings.Contains(got, want) {
t.Errorf("missing %q:\n%s", want, got)
}
}
}
// TestAppsDBChangelogList_ChangeIDNotFoundPretty 验证按 --change-id 查询无结果时 pretty 打印 not-found 提示。
func TestAppsDBChangelogList_ChangeIDNotFoundPretty(t *testing.T) {
factory, stdout, reg := newAppsExecuteFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET", URL: dbChangelogURL,
Body: map[string]interface{}{"code": 0, "data": map[string]interface{}{"items": []interface{}{}}},
})
if err := runAppsShortcut(t, AppsDBChangelogList,
[]string{"+db-changelog-list", "--app-id", "app_x", "--change-id", "nope", "--format", "pretty", "--as", "user"}, factory, stdout); err != nil {
t.Fatalf("execute err=%v", err)
}
if !strings.Contains(stdout.String(), "No DDL change with id=nope found.") {
t.Fatalf("expected not-found message, got: %s", stdout.String())
}
}
// TestParseOperator_Cases 验证 parseOperator 处理合法 JSON、空 name 回退 id、非 JSON 原样、空串返回 nil以及 operatorName(nil) 为占位符。
func TestParseOperator_Cases(t *testing.T) {
if op := parseOperator(`{"id":"1","name":"a"}`); op == nil || op.ID != "1" || op.Name != "a" {
t.Fatalf("valid: %#v", op)
}
if op := parseOperator(`{"id":"1","name":""}`); op == nil || op.Name != "1" {
t.Fatalf("name fallback to id: %#v", op)
}
if op := parseOperator("plain-user"); op == nil || op.ID != "plain-user" || op.Name != "plain-user" {
t.Fatalf("non-json raw: %#v", op)
}
if op := parseOperator(""); op != nil {
t.Fatalf("empty → nil, got %#v", op)
}
if operatorName(nil) != "—" {
t.Fatalf("nil operatorName should be —")
}
}
// TestSafeParseJSON_Cases 验证 safeParseJSON 合法 JSON 解析为对象、非法 JSON 原样返回字符串。
func TestSafeParseJSON_Cases(t *testing.T) {
if v := safeParseJSON(`{"a":1}`); v == nil {
t.Fatalf("valid json → object")
}
if v, ok := safeParseJSON("not json").(string); !ok || v != "not json" {
t.Fatalf("invalid json → raw string, got %v", v)
}
}

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