feat(im,datasource): support Lark, Feishu's international edition
Lark and Feishu are the same product deployed on two isolated clouds (open.larksuite.com and open.feishu.cn). WeKnora touches both from two places — the IM bot and the Wiki data-source connector — and this brings Lark to parity across both. Neither API surface differs, so rather than duplicate either implementation, each is parametrized by a Region and registered twice. IM (internal/im/feishu): Every API call routes through a.api(), which prefixes the region's host, and the WebSocket client passes larkws.WithDomain — the SDK defaults to open.feishu.cn, so Lark long connections would otherwise fail to authenticate. Data source (internal/datasource/connector/feishu): Lark was half-supported: the client honoured a base_url override and a LarkBaseURL constant existed, but the connector registered only as "feishu" and the UI never exposed base_url, so Lark wikis could not be configured at all. Lark is now its own connector type. base_url is kept as an explicit override so data sources that pointed a "feishu" connector at open.larksuite.com keep working. Bugs found and fixed along the way: - Wiki resource links were hardcoded to https://feishu.cn/wiki/{token} in four places, so a Lark wiki linked into the wrong cloud entirely. - Bot identity is now platform-prefixed (feishu:cli_x vs lark:cli_x). BotIdentity carries a unique index, so without this a Lark channel would be rejected as a duplicate of an unrelated Feishu bot sharing an app_id. - The card image cache is now keyed by app_id. image_keys are issued per app on one cloud; a Feishu key handed to a Lark app fails the card update with code=200570. - The datasource doc claimed Lark "adapts automatically" — it could not, since the UI had no way to reach base_url. Permissions are where the clouds genuinely diverge. Identical APIs do not mean identical permission catalogues: aily:file:read, aily:file:write and corehr:file:download exist on Feishu but not on Lark, so pasting Feishu's scope JSON into Lark fails to import. That JSON is also over-broad (it covers products WeKnora never calls) and simultaneously incomplete (it omits the drive:*/docx:* scopes the connector needs). Lark therefore gets its own list, derived from the 17 endpoints the code actually calls and checked identifier-by-identifier against Lark's own API reference, plus a full Feishu→Lark mapping table marking each scope verified, unverified, or absent. Both features use tenant_access_token only — no user_access_ token exists anywhere in the repo — so the user dimension stays empty. Known limitation: Region.ThinkingText makes Lark's initial card placeholder English, but once streaming starts the think-block headers come from the shared MarkdownThinkStyle and are Chinese on every platform (Lark, Slack, Telegram, Mattermost alike). Fixing that means threading a locale through FormatIMDisplayContent, which has no platform context — a cross-platform change, not a Lark one. Documented as such. The channel-creation 400 message is now derived from validIMPlatforms so the list cannot drift as platforms are added. Tests: region invariants and per-region URL construction on both sides, the Feishu/Lark bot-identity split, platform-to-channel mapping, base_url override precedence, an end-to-end SendReply against a fake Open Platform (token fetch, reply, thread-unsupported fallback, hard-error surfacing), and a ListResources drive asserting wiki links never leak the other cloud's host. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
+16
-3
@@ -3,6 +3,7 @@ package handler
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/Tencent/WeKnora/internal/im"
|
||||
@@ -13,10 +14,22 @@ import (
|
||||
|
||||
// validIMPlatforms is the set of supported IM platforms.
|
||||
var validIMPlatforms = map[string]bool{
|
||||
"wecom": true, "feishu": true, "slack": true, "telegram": true, "dingtalk": true, "mattermost": true,
|
||||
"wechat": true, "qqbot": true,
|
||||
"wecom": true, "feishu": true, "lark": true, "slack": true, "telegram": true, "dingtalk": true,
|
||||
"mattermost": true, "wechat": true, "qqbot": true,
|
||||
}
|
||||
|
||||
// invalidIMPlatformError is the 400 message listing the accepted platforms. It
|
||||
// is derived from validIMPlatforms so the two cannot drift apart as platforms
|
||||
// are added.
|
||||
var invalidIMPlatformError = func() string {
|
||||
names := make([]string, 0, len(validIMPlatforms))
|
||||
for p := range validIMPlatforms {
|
||||
names = append(names, "'"+p+"'")
|
||||
}
|
||||
sort.Strings(names)
|
||||
return "platform must be one of: " + strings.Join(names, ", ")
|
||||
}()
|
||||
|
||||
// IMHandler handles IM platform callback requests and channel CRUD.
|
||||
type IMHandler struct {
|
||||
imService *im.Service
|
||||
@@ -60,7 +73,7 @@ func (h *IMHandler) CreateIMChannel(c *gin.Context) {
|
||||
}
|
||||
|
||||
if !validIMPlatforms[req.Platform] {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "platform must be 'wecom', 'feishu', 'slack', 'telegram', 'dingtalk', 'mattermost', 'wechat' or 'qqbot'"})
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": invalidIMPlatformError})
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// The channel-creation endpoint rejects any platform without a registered
|
||||
// adapter factory, so this set must track the factories wired in the container.
|
||||
func TestValidIMPlatforms_CoversLark(t *testing.T) {
|
||||
want := []string{
|
||||
"wecom", "feishu", "lark", "slack", "telegram",
|
||||
"dingtalk", "mattermost", "wechat", "qqbot",
|
||||
}
|
||||
for _, platform := range want {
|
||||
if !validIMPlatforms[platform] {
|
||||
t.Errorf("platform %q is not accepted", platform)
|
||||
}
|
||||
}
|
||||
if validIMPlatforms["nonsense"] {
|
||||
t.Error("unknown platform is accepted")
|
||||
}
|
||||
}
|
||||
|
||||
// The 400 message is derived from validIMPlatforms; it must not drift as
|
||||
// platforms are added.
|
||||
func TestInvalidIMPlatformError_ListsEveryPlatform(t *testing.T) {
|
||||
for platform := range validIMPlatforms {
|
||||
if !strings.Contains(invalidIMPlatformError, "'"+platform+"'") {
|
||||
t.Errorf("error message omits %q: %s", platform, invalidIMPlatformError)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user