Skip to content

Self-hosted workflows for coding-agent delivery. Orchestrate CodeBuddy, Codex and Claude Code with scripts and human approval gates. Includes Local workflows for coding assistants.

refactor(botinteraction): extract frame key logging from dial (#428)

fx-kurumi5c1efe0636d1
diff --git a/internal/botinteraction/socket.go b/internal/botinteraction/socket.go
index b74146ae..221c515c 100644
--- a/internal/botinteraction/socket.go
+++ b/internal/botinteraction/socket.go
@@ -68,6 +68,29 @@ type socket struct {
cancel context.CancelFunc
}
+// logFrameKeys logs the sorted JSON keys of a frame body, its event and its
+// template card event to help diagnose unexpected WeCom frames.
+func logFrameKeys(f Frame) {
+ keys, body := sortedJSONKeys(f.Body)
+ eventKeys, event := sortedJSONKeys(body["event"])
+ cardKeys, _ := sortedJSONKeys(event["template_card_event"])
+ log.Printf("wecom frame cmd=%s body_keys=%v event_keys=%v card_keys=%v", f.Cmd, keys, eventKeys, cardKeys)
+}
+
+// sortedJSONKeys decodes raw as a JSON object and returns its keys in sorted
+// order together with the decoded fields. Invalid or empty input yields an
+// empty (non-nil) key slice and a nil map.
+func sortedJSONKeys(raw json.RawMessage) ([]string, map[string]json.RawMessage) {
+ var fields map[string]json.RawMessage
+ _ = json.Unmarshal(raw, &fields)
+ keys := []string{}
+ for key := range fields {
+ keys = append(keys, key)
+ }
+ sort.Strings(keys)
+ return keys, fields
+}
+
func dial(ctx context.Context, url, botID, secret string, onFrame func(*socket, Frame)) (*socket, error) {
conn, _, err := websocket.DefaultDialer.DialContext(ctx, url, nil)
if err != nil {
@@ -89,28 +112,7 @@ func dial(ctx context.Context, url, botID, secret string, onFrame func(*socket,
ack := s.pending[f.Headers.RequestID]
s.mu.Unlock()
if f.Cmd != "" && f.Cmd != "aibot_msg_callback" {
- var body map[string]json.RawMessage
- _ = json.Unmarshal(f.Body, &body)
- keys := []string{}
- for key := range body {
- keys = append(keys, key)
- }
- sort.Strings(keys)
- var event map[string]json.RawMessage
- _ = json.Unmarshal(body["event"], &event)
- eventKeys := []string{}
- for key := range event {
- eventKeys = append(eventKeys, key)
- }
- sort.Strings(eventKeys)
- var cardEvent map[string]json.RawMessage
- _ = json.Unmarshal(event["template_card_event"], &cardEvent)
- cardKeys := []string{}
- for key := range cardEvent {
- cardKeys = append(cardKeys, key)
- }
- sort.Strings(cardKeys)
- log.Printf("wecom frame cmd=%s body_keys=%v event_keys=%v card_keys=%v", f.Cmd, keys, eventKeys, cardKeys)
+ logFrameKeys(f)
}
if f.Cmd == "aibot_msg_callback" || f.Cmd == "aibot_event_callback" {
onFrame(s, f)
diff --git a/internal/botinteraction/socket_frame_keys_test.go b/internal/botinteraction/socket_frame_keys_test.go
new file mode 100644
index 00000000..93f4ac53
--- /dev/null
+++ b/internal/botinteraction/socket_frame_keys_test.go
@@ -0,0 +1,53 @@
+package botinteraction
+
+import (
+ "bytes"
+ "encoding/json"
+ "log"
+ "reflect"
+ "strings"
+ "testing"
+)
+
+func TestSortedJSONKeys(t *testing.T) {
+ cases := []struct {
+ name string
+ raw string
+ want []string
+ }{
+ {"object", `{"b":1,"a":2,"c":{}}`, []string{"a", "b", "c"}},
+ {"empty input", ``, []string{}},
+ {"invalid json", `not-json`, []string{}},
+ {"non object", `[1,2]`, []string{}},
+ }
+ for _, tc := range cases {
+ t.Run(tc.name, func(t *testing.T) {
+ keys, _ := sortedJSONKeys(json.RawMessage(tc.raw))
+ if keys == nil || !reflect.DeepEqual(keys, tc.want) {
+ t.Fatalf("keys = %#v, want %#v", keys, tc.want)
+ }
+ })
+ }
+}
+
+func TestLogFrameKeys(t *testing.T) {
+ var buf bytes.Buffer
+ prevOut, prevFlags := log.Writer(), log.Flags()
+ log.SetOutput(&buf)
+ log.SetFlags(0)
+ defer func() { log.SetOutput(prevOut); log.SetFlags(prevFlags) }()
+
+ nested := Frame{Cmd: "aibot_event_callback", Body: json.RawMessage(`{"msgid":"m","event":{"eventtype":"x","template_card_event":{"task_id":"t","event_key":"k"}}}`)}
+ logFrameKeys(nested)
+ want := "wecom frame cmd=aibot_event_callback body_keys=[event msgid] event_keys=[eventtype template_card_event] card_keys=[event_key task_id]"
+ if got := strings.TrimSpace(buf.String()); got != want {
+ t.Fatalf("log = %q, want %q", got, want)
+ }
+
+ buf.Reset()
+ logFrameKeys(Frame{Cmd: "ping"})
+ want = "wecom frame cmd=ping body_keys=[] event_keys=[] card_keys=[]"
+ if got := strings.TrimSpace(buf.String()); got != want {
+ t.Fatalf("log = %q, want %q", got, want)
+ }
+}