Skip to content

Commit c0fbe54

Browse files
feat(lark-im): support UAT for forward and add threads.forward (#689)
- Update messages.forward identity to support `user` and `bot` - Add threads.forward entry under threads API resources - Add forward APIs -> `im:message`, `im:message.send_as_user` scope mapping Change-Id: I2e33b0d78d72fd067ba3916095479f9b336e7eb9
1 parent 4ba39ef commit c0fbe54

3 files changed

Lines changed: 196 additions & 5 deletions

File tree

skills/lark-im/SKILL.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ lark-cli im <resource> <method> [flags] # 调用 API
109109
### messages
110110

111111
- `delete` — 撤回消息。Identity: supports `user` and `bot`; for `bot` calls, the bot must be in the chat to revoke group messages; to revoke another user's group message, the bot must be the owner, an admin, or the creator; for user P2P recalls, the target user must be within the bot's availability.
112-
- `forward` — 转发消息。Identity: `bot` only (`tenant_access_token`).
112+
- `forward` — 转发消息。Identity: supports `user` and `bot`.
113113
- `merge_forward` — 合并转发消息。Identity: `bot` only (`tenant_access_token`).
114114
- `read_users` — 查询消息已读信息。Identity: `bot` only (`tenant_access_token`); the bot must be in the chat, and can only query read status for messages it sent within the last 7 days.
115115

@@ -120,6 +120,10 @@ lark-cli im <resource> <method> [flags] # 调用 API
120120
- `delete` — 删除消息表情回复。Identity: supports `user` and `bot`; the caller must be in the conversation that contains the message, and can only delete reactions added by itself.[Must-read](references/lark-im-reactions.md)
121121
- `list` — 获取消息表情回复。Identity: supports `user` and `bot`; the caller must be in the conversation that contains the message.[Must-read](references/lark-im-reactions.md)
122122

123+
### threads
124+
125+
- `forward` — 转发话题。Identity: supports `user` and `bot`.
126+
123127
### images
124128

125129
- `create` — 上传图片。Identity: `bot` only (`tenant_access_token`).
@@ -147,6 +151,7 @@ lark-cli im <resource> <method> [flags] # 调用 API
147151
| `messages.forward` | `im:message` |
148152
| `messages.merge_forward` | `im:message` |
149153
| `messages.read_users` | `im:message:readonly` |
154+
| `threads.forward` | `im:message` |
150155
| `reactions.batch_query` | `im:message.reactions:read` |
151156
| `reactions.create` | `im:message.reactions:write_only` |
152157
| `reactions.delete` | `im:message.reactions:write_only` |

tests/cli_e2e/im/coverage.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# IM CLI E2E Coverage
22

33
## Metrics
4-
- Denominator: 29 leaf commands
5-
- Covered: 9
6-
- Coverage: 31.0%
4+
- Denominator: 30 leaf commands
5+
- Covered: 11
6+
- Coverage: 36.7%
77

88
## Summary
99
- TestIM_ChatUpdateWorkflow: proves `im +chat-create`, `im +chat-update`, and `im chats get`; key `t.Run(...)` proof points are `update chat name as bot`, `update chat description as bot`, and `get updated chat as bot`.
@@ -12,6 +12,7 @@
1212
- TestIM_ChatMessageWorkflowAsUser: proves the user chat message flow through `create chat as user`, `send message as user`, and `list chat messages as user` with the created message ID and content asserted from read-after-write output.
1313
- TestIM_MessageGetWorkflowAsUser: proves user message readback through `batch get message as user` after creating a fresh chat and sending a unique message.
1414
- TestIM_MessageReplyWorkflowAsBot: proves threaded reply flow through `reply to message in thread as bot` and `list thread replies as bot`, reading back the reply from `im +threads-messages-list`.
15+
- TestIM_MessageForwardWorkflowAsUser: proves UAT-backed API forwarding through `im messages forward` and `im threads forward` using a fresh message/thread fixture; skips the forward assertions when the current test app/UAT lacks IM forward permission.
1516
- Blocked area: `im +chat-search` did not reliably return freshly created private chats in UAT, and `im +messages-search` did not reliably index freshly sent messages in time for a deterministic read-after-write assertion, so both remain uncovered.
1617

1718
## Command Table
@@ -37,9 +38,10 @@
3738
|| im chats update | api | | none | only covered indirectly through `+chat-update` |
3839
|| im images create | api | | none | no image upload workflow yet |
3940
|| im messages delete | api | | none | no recall workflow yet |
40-
| | im messages forward | api | | none | no forward workflow yet |
41+
| | im messages forward | api | im/message_forward_workflow_test.go::TestIM_MessageForwardWorkflowAsUser/forward message with api command as user | `message_id`; `receive_id_type`; `uuid`; `receive_id` | forwards a fresh message back into the test chat using UAT |
4142
|| im messages merge_forward | api | | none | no merge-forward workflow yet |
4243
|| im messages read_users | api | | none | no read-user workflow yet |
44+
|| im threads forward | api | im/message_forward_workflow_test.go::TestIM_MessageForwardWorkflowAsUser/forward thread with api command as user | `thread_id`; `receive_id_type`; `uuid`; `receive_id` | forwards a fresh thread back into the test chat using UAT |
4345
|| im pins create | api | | none | pin workflows not covered |
4446
|| im pins delete | api | | none | pin workflows not covered |
4547
|| im pins list | api | | none | pin workflows not covered |
Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
2+
// SPDX-License-Identifier: MIT
3+
4+
package im
5+
6+
import (
7+
"context"
8+
"strings"
9+
"testing"
10+
"time"
11+
12+
clie2e "github.com/larksuite/cli/tests/cli_e2e"
13+
"github.com/stretchr/testify/require"
14+
"github.com/tidwall/gjson"
15+
)
16+
17+
func TestIM_MessageForwardWorkflowAsUser(t *testing.T) {
18+
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Minute)
19+
t.Cleanup(cancel)
20+
21+
clie2e.SkipWithoutUserToken(t)
22+
23+
suffix := clie2e.GenerateSuffix()
24+
messageText := "im-forward-msg-" + suffix
25+
replyText := "im-forward-reply-" + suffix
26+
27+
selfOpenID := getSelfOpenID(t, ctx)
28+
chatID, messageID := sendDirectMessageToUser(t, ctx, selfOpenID, messageText, "bot")
29+
30+
t.Run("forward message with api command as user", func(t *testing.T) {
31+
result, err := clie2e.RunCmd(ctx, clie2e.Request{
32+
Args: []string{"im", "messages", "forward"},
33+
DefaultAs: "user",
34+
Params: map[string]any{
35+
"message_id": messageID,
36+
"receive_id_type": "chat_id",
37+
"uuid": "msg-forward-" + suffix,
38+
},
39+
Data: map[string]any{
40+
"receive_id": chatID,
41+
},
42+
})
43+
require.NoError(t, err)
44+
skipIfMissingIMForwardPermission(t, result)
45+
result.AssertExitCode(t, 0)
46+
result.AssertStdoutStatus(t, 0)
47+
48+
forwardedID := gjson.Get(result.Stdout, "data.message_id").String()
49+
require.NotEmpty(t, forwardedID, "stdout:\n%s", result.Stdout)
50+
require.NotEqual(t, messageID, forwardedID, "stdout:\n%s", result.Stdout)
51+
require.Equal(t, chatID, gjson.Get(result.Stdout, "data.chat_id").String(), "stdout:\n%s", result.Stdout)
52+
})
53+
54+
var threadID string
55+
t.Run("create thread fixture as bot", func(t *testing.T) {
56+
result, err := clie2e.RunCmd(ctx, clie2e.Request{
57+
Args: []string{"im", "+messages-reply",
58+
"--message-id", messageID,
59+
"--text", replyText,
60+
"--reply-in-thread",
61+
},
62+
DefaultAs: "bot",
63+
})
64+
require.NoError(t, err)
65+
result.AssertExitCode(t, 0)
66+
result.AssertStdoutStatus(t, true)
67+
68+
threadID = findThreadIDForMessage(t, ctx, chatID, messageID, "bot")
69+
})
70+
71+
t.Run("forward thread with api command as user", func(t *testing.T) {
72+
result, err := clie2e.RunCmd(ctx, clie2e.Request{
73+
Args: []string{"im", "threads", "forward"},
74+
DefaultAs: "user",
75+
Params: map[string]any{
76+
"thread_id": threadID,
77+
"receive_id_type": "chat_id",
78+
"uuid": "thread-forward-" + suffix,
79+
},
80+
Data: map[string]any{
81+
"receive_id": chatID,
82+
},
83+
})
84+
require.NoError(t, err)
85+
skipIfMissingIMForwardPermission(t, result)
86+
result.AssertExitCode(t, 0)
87+
result.AssertStdoutStatus(t, 0)
88+
89+
forwardedID := gjson.Get(result.Stdout, "data.message_id").String()
90+
require.NotEmpty(t, forwardedID, "stdout:\n%s", result.Stdout)
91+
require.Equal(t, chatID, gjson.Get(result.Stdout, "data.chat_id").String(), "stdout:\n%s", result.Stdout)
92+
require.Equal(t, "merge_forward", gjson.Get(result.Stdout, "data.msg_type").String(), "stdout:\n%s", result.Stdout)
93+
})
94+
}
95+
96+
func findThreadIDForMessage(t *testing.T, ctx context.Context, chatID string, messageID string, defaultAs string) string {
97+
t.Helper()
98+
99+
listResult, err := clie2e.RunCmdWithRetry(ctx, clie2e.Request{
100+
Args: []string{
101+
"im", "+chat-messages-list",
102+
"--chat-id", chatID,
103+
"--start", time.Now().UTC().Add(-10 * time.Minute).Format(time.RFC3339),
104+
"--end", time.Now().UTC().Add(10 * time.Minute).Format(time.RFC3339),
105+
},
106+
DefaultAs: defaultAs,
107+
}, clie2e.RetryOptions{
108+
ShouldRetry: func(result *clie2e.Result) bool {
109+
if result == nil || result.ExitCode != 0 {
110+
return true
111+
}
112+
for _, item := range gjson.Get(result.Stdout, "data.messages").Array() {
113+
if item.Get("message_id").String() == messageID && item.Get("thread_id").String() != "" {
114+
return false
115+
}
116+
}
117+
return true
118+
},
119+
})
120+
require.NoError(t, err)
121+
listResult.AssertExitCode(t, 0)
122+
listResult.AssertStdoutStatus(t, true)
123+
124+
for _, item := range gjson.Get(listResult.Stdout, "data.messages").Array() {
125+
if item.Get("message_id").String() == messageID {
126+
threadID := item.Get("thread_id").String()
127+
require.NotEmpty(t, threadID, "expected thread_id for message %s in stdout:\n%s", messageID, listResult.Stdout)
128+
return threadID
129+
}
130+
}
131+
132+
t.Fatalf("expected message %s in stdout:\n%s", messageID, listResult.Stdout)
133+
return ""
134+
}
135+
136+
func getSelfOpenID(t *testing.T, ctx context.Context) string {
137+
t.Helper()
138+
139+
result, err := clie2e.RunCmd(ctx, clie2e.Request{
140+
Args: []string{"contact", "+get-user"},
141+
DefaultAs: "user",
142+
})
143+
require.NoError(t, err)
144+
result.AssertExitCode(t, 0)
145+
result.AssertStdoutStatus(t, true)
146+
147+
openID := gjson.Get(result.Stdout, "data.user.open_id").String()
148+
require.NotEmpty(t, openID, "stdout:\n%s", result.Stdout)
149+
return openID
150+
}
151+
152+
func sendDirectMessageToUser(t *testing.T, ctx context.Context, userOpenID string, text string, defaultAs string) (string, string) {
153+
t.Helper()
154+
155+
result, err := clie2e.RunCmd(ctx, clie2e.Request{
156+
Args: []string{"im", "+messages-send",
157+
"--user-id", userOpenID,
158+
"--text", text,
159+
},
160+
DefaultAs: defaultAs,
161+
})
162+
require.NoError(t, err)
163+
result.AssertExitCode(t, 0)
164+
result.AssertStdoutStatus(t, true)
165+
166+
chatID := gjson.Get(result.Stdout, "data.chat_id").String()
167+
messageID := gjson.Get(result.Stdout, "data.message_id").String()
168+
require.NotEmpty(t, chatID, "stdout:\n%s", result.Stdout)
169+
require.NotEmpty(t, messageID, "stdout:\n%s", result.Stdout)
170+
return chatID, messageID
171+
}
172+
173+
func skipIfMissingIMForwardPermission(t *testing.T, result *clie2e.Result) {
174+
t.Helper()
175+
if result == nil || result.ExitCode == 0 {
176+
return
177+
}
178+
stderrLower := strings.ToLower(result.Stderr)
179+
if strings.Contains(stderrLower, "permission denied") ||
180+
strings.Contains(stderrLower, "230027") ||
181+
strings.Contains(stderrLower, "missing_scope") {
182+
t.Skipf("skip UAT forward workflow due to missing IM forward permissions: %s", result.Stderr)
183+
}
184+
}

0 commit comments

Comments
 (0)