fix(base): align workflow validation and agent guidance

[huarenmin13]

Summary

Fix Base workflow cases 014 and 026 without adding a general workflow schema validator.

• 014: Document DeleteRecordTrigger as known unsupported. When a requested capability is unavailable, agents must preserve the original intent, stop writes, and execute alternatives only after explicit user selection.
• 026: Validate LarkMessageAction.data before workflow create/update: data must be an object, receiver and content must be non-empty arrays, and optional send_to_everyone/btn_list fields are type-checked when present.

Changes

• Share one create/update validator for the LarkMessageAction contract and return typed --json field errors before transport.
• Preserve valid request bodies and leave non-target or unknown step shapes to server validation.
• Align workflow get/update guidance and the delivered Skill schema.
• Keep the effective diff within existing files.

Validation

• make build
• go test ./shortcuts/base -count=1
• Current-binary delivered-Skill E2E tests
• go vet ./shortcuts/base ./tests/cli_e2e/base
• gofmt and git diff --check

The opt-in live workflow round-trip was not run.

Related

Base workflow evaluation cases 014 and 026.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Workflow create and update now perform structured workflow-definition validation, including message-action fields and unsupported steps. Guidance and schema references describe the updated contracts, while unit and CLI tests cover validation errors, dry-run output, and request-body preservation.

Changes

Workflow contracts and validation

Layer / File(s)	Summary
Workflow validation and command wiring shortcuts/base/workflow_message_validation.go, shortcuts/base/workflow_create.go, shortcuts/base/workflow_update.go	Create and update validate workflow titles, steps, supported types, and LarkMessageAction fields with structured validation errors.
Execution and request preservation coverage shortcuts/base/workflow_execute_test.go	Tests cover validation subtypes and hints, preserved create/update JSON bodies, message-action payloads, and empty steps.
Workflow guidance and delivered schema contracts shortcuts/base/workflow_get.go, shortcuts/base/workflow_update.go, skills/lark-base/references/*, shortcuts/base/base_shortcuts_test.go, tests/cli_e2e/base/*	Tips and references document full replacement, status handling, omitted optional fields, and unsupported triggers; CLI tests verify delivered guidance and dry-run behavior.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant BaseWorkflowCreate
  participant validateWorkflowDefinition
  participant WorkflowAPI
  CLI->>BaseWorkflowCreate: submit --json workflow body
  BaseWorkflowCreate->>validateWorkflowDefinition: validate workflow definition
  validateWorkflowDefinition-->>BaseWorkflowCreate: validation result
  BaseWorkflowCreate->>WorkflowAPI: send validated JSON request

Loading

Possibly related PRs

• larksuite/cli#2092: Adds closely related workflow message-action validation and command wiring.

Suggested labels: domain/base, size/M

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title is concise and accurately summarizes the main change: workflow validation and guidance alignment.
Description check	✅ Passed	The description covers the required summary, changes, validation, and related issues, with only the Test Plan heading folded into Validation.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[huarenmin13]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@shortcuts/base/workflow_execute_test.go`:
- Around line 169-212: The TestBaseWorkflowExecuteUpdatePreservesValidRequests
cases need stronger request-body assertions. In the “valid message action”
subtest, inspect the captured JSON from decodeCapturedJSONBody and verify the
preserved receiver and content values, not just the steps length; in the “empty
steps” subtest, assert that the captured body contains steps as an empty array
while retaining the existing dispatch verification.

In `@tests/cli_e2e/base/workflow_skill_contract_test.go`:
- Around line 32-45: The workflow skill contract test’s contracts table only
covers DeleteRecordTrigger text and must also validate the changed
LarkMessageAction schema. Extend the contracts in the test to assert non-empty
receiver and content fields, while covering optional send_to_everyone and
btn_list fields, using the existing contract assertion flow.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e21b0491-5417-4af6-ac57-8c3831d258f8

📥 Commits

Reviewing files that changed from the base of the PR and between 1b173e1 and efedfe1.

📒 Files selected for processing (11)

• shortcuts/base/base_shortcuts_test.go
• shortcuts/base/workflow_create.go
• shortcuts/base/workflow_execute_test.go
• shortcuts/base/workflow_get.go
• shortcuts/base/workflow_message_validation.go
• shortcuts/base/workflow_update.go
• skills/lark-base/SKILL.md
• skills/lark-base/references/lark-base-workflow-schema.md
• tests/cli_e2e/base/url_resolution_skill_contract_test.go
• tests/cli_e2e/base/workflow_skill_contract_test.go
• tests/cli_e2e/base/workflow_update_dryrun_test.go

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@shortcuts/base/base_resolve_test.go`:
- Line 234: Update the unrelated Base URL case in the relevant resolve test to
assert the complete typed error contract: verify Category, Subtype, and the
preserved cause using errs.ProblemOf with errors.Is or errors.As, and extract
Param directly from the *errs.ValidationError instead of errs.ProblemOf. Retain
the existing message and Hint assertions.
- Around line 283-285: Add a success-path test for the form-share resolver
alongside the existing BaseURLResolve assertions, exercising a
/share/base/form/<token> request and verifying the returned input_type,
resource_type, and share_token. Keep the description assertion, but ensure the
execution test confirms routing selects the form-share behavior rather than the
generic Base branch.

In `@shortcuts/base/base_resolve.go`:
- Line 18: Update classifyBaseURL so the specific /share/base/form/ pattern is
checked before the generic /base/ pattern, ensuring form-share URLs reach
resolveFormShareURL instead of the generic base resolution. Add a regression
test covering successful classification and resolution of a form-share URL.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 654d0113-d33f-4048-bd8b-d6bbba9569be

📥 Commits

Reviewing files that changed from the base of the PR and between efedfe1 and ffc792b.

📒 Files selected for processing (4)

• shortcuts/base/base_resolve.go
• shortcuts/base/base_resolve_test.go
• shortcuts/base/workflow_execute_test.go
• tests/cli_e2e/base/workflow_skill_contract_test.go

🚧 Files skipped from review as they are similar to previous changes (1)

• shortcuts/base/workflow_execute_test.go

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@shortcuts/base/base_resolve_test.go`:
- Around line 260-265: Strengthen error assertions in
shortcuts/base/base_resolve_test.go at lines 260-265, 415-418, and 429-432: in
the malformed-URL case, verify the unwrapped cause is specifically *url.Error
rather than only non-nil; in both semantic validation cases, assert
CategoryValidation, SubtypeInvalidArgument, and a nil cause using the existing
typed-error assertion patterns.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 01b9a56d-56d5-4371-8208-234c09a60325

📥 Commits

Reviewing files that changed from the base of the PR and between ffc792b and cf82941.

📒 Files selected for processing (3)

• shortcuts/base/base_resolve.go
• shortcuts/base/base_resolve_test.go
• shortcuts/base/workflow_execute_test.go

🚧 Files skipped from review as they are similar to previous changes (1)

• shortcuts/base/workflow_execute_test.go

[github-actions]

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@b6e49aeff132b9e729323ba0cd1b9c616cb716f7

🧩 Skill update

npx skills add huarenmin13/cli#codex/base-workflow-contracts -y -g

[huarenmin13]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.