docs: clarify mail message shortcut guidance #1306
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| // Copyright (c) 2026 Lark Technologies Pte. Ltd. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package mail | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/larksuite/cli/shortcuts/common" | ||
| ) | ||
|
|
||
| func TestMailMessageHelpMentionsSingleMessageOnly(t *testing.T) { | ||
| help := strings.ToLower(mountedShortcutHelp(t, MailMessage)) | ||
| for _, want := range []string{ | ||
| "single email", | ||
| "mail +messages", | ||
| "do not loop mail +message", | ||
| "single email message id", | ||
| } { | ||
| if !strings.Contains(help, want) { | ||
| t.Errorf("mail +message help should mention %q; got:\n%s", want, help) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestMailMessagesHelpMentionsBatchLimitAndAutoChunk(t *testing.T) { | ||
| help := strings.ToLower(mountedShortcutHelp(t, MailMessages)) | ||
| for _, want := range []string{ | ||
| "multiple emails", | ||
| "at most 20 ids per batch_get request", | ||
| "merges output", | ||
| "current backend raw request validation rejects more than 50 ids", | ||
| } { | ||
| if !strings.Contains(help, want) { | ||
| t.Errorf("mail +messages help should mention %q; got:\n%s", want, help) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestMailMessageDryRunMentionsSingleMessageOnly(t *testing.T) { | ||
| runtime := runtimeForShortcutDryRun(t, MailMessage, map[string]string{ | ||
| "message-id": "msg_1", | ||
| }) | ||
| got := strings.ToLower(marshalDryRun(t, MailMessage.DryRun(context.Background(), runtime))) | ||
| for _, want := range []string{ | ||
| "one email only", | ||
| "for multiple ids use mail +messages", | ||
| } { | ||
| if !strings.Contains(got, want) { | ||
| t.Errorf("mail +message dry-run should mention %q; got:\n%s", want, got) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestMailMessagesDryRunMentionsChunkAndBackendLimit(t *testing.T) { | ||
| runtime := runtimeForShortcutDryRun(t, MailMessages, map[string]string{ | ||
| "message-ids": "msg_1,msg_2", | ||
| }) | ||
| got := strings.ToLower(marshalDryRun(t, MailMessages.DryRun(context.Background(), runtime))) | ||
| for _, want := range []string{ | ||
| "auto-chunks at most 20 ids per request", | ||
| "merges output", | ||
| "backend raw request validation rejects more than 50 ids", | ||
| } { | ||
| if !strings.Contains(got, want) { | ||
| t.Errorf("mail +messages dry-run should mention %q; got:\n%s", want, got) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func mountedShortcutHelp(t *testing.T, shortcut common.Shortcut) string { | ||
| t.Helper() | ||
| f, _, _, _ := mailShortcutTestFactory(t) | ||
| parent := &cobra.Command{Use: "mail"} | ||
| shortcut.Mount(parent, f) | ||
| cmd, _, err := parent.Find([]string{shortcut.Command}) | ||
| if err != nil { | ||
| t.Fatalf("find mounted shortcut %s: %v", shortcut.Command, err) | ||
| } | ||
| if cmd == parent { | ||
| t.Fatalf("shortcut %s was not mounted", shortcut.Command) | ||
| } | ||
| var out bytes.Buffer | ||
| cmd.SetOut(&out) | ||
| cmd.SetErr(&out) | ||
| if err := cmd.Help(); err != nil { | ||
| t.Fatalf("help for %s: %v", shortcut.Command, err) | ||
| } | ||
| return cmd.Short + "\n" + out.String() | ||
| } | ||
|
|
||
| func runtimeForShortcutDryRun(t *testing.T, shortcut common.Shortcut, values map[string]string) *common.RuntimeContext { | ||
| t.Helper() | ||
| cmd := &cobra.Command{Use: shortcut.Command} | ||
| for _, fl := range shortcut.Flags { | ||
| switch fl.Type { | ||
| case "bool": | ||
| cmd.Flags().Bool(fl.Name, fl.Default == "true", "") | ||
| default: | ||
| cmd.Flags().String(fl.Name, fl.Default, "") | ||
| } | ||
| } | ||
| if err := cmd.ParseFlags(nil); err != nil { | ||
| t.Fatalf("parse flags failed: %v", err) | ||
| } | ||
| for k, v := range values { | ||
| if err := cmd.Flags().Set(k, v); err != nil { | ||
| t.Fatalf("set flag --%s failed: %v", k, err) | ||
| } | ||
| } | ||
| return &common.RuntimeContext{Cmd: cmd} | ||
| } | ||
|
|
||
| func marshalDryRun(t *testing.T, dry *common.DryRunAPI) string { | ||
| t.Helper() | ||
| raw, err := json.Marshal(dry) | ||
| if err != nil { | ||
| t.Fatalf("marshal dry-run: %v", err) | ||
| } | ||
| return string(raw) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 AI Review | [P3 可维护性] IM feed group 错误契约迁移缺少回归覆盖
这里把 feed group 调用从
DoAPIJSON切到DoAPIJSONTyped，成功数据结构不变，但错误分类/输出契约会从 legacy API error 路径变为 typed error 路径；同类改动还出现在im_feed_group_list_item.go和im_feed_group_query_item.go。如果脚本或 AI 依赖旧的错误 envelope/message，非零 API code 场景会发生可见行为变化，但当前新增测试主要覆盖 mail 文案和成功分批，没有锁住 feed group 的错误输出。修复建议: 补一组 feed group 非零 API code / HTTP error 的单测，断言返回的 code、message、log_id/subtype 等关键字段；或者在 PR 描述中明确这是有意的 IM 错误契约迁移。
如有疑问或认为判断不准确，欢迎直接回复讨论。