X-Git-Url: http://git.giacomolli.uk/onechat/blobdiff_plain/56d959f2d573eef1be5c04d0bf1659fa30d36e7c..0b97bb2cc4bc0b8f8fe27cc7aa3f9d1d89ed28c8:/whatsapp_test.go?ds=sidebyside diff --git a/whatsapp_test.go b/whatsapp_test.go index 38a7b8d..791e3ca 100644 --- a/whatsapp_test.go +++ b/whatsapp_test.go @@ -1,7 +1,10 @@ package main import ( + "crypto/sha256" + "encoding/hex" "errors" + "fmt" "net/http" "os" "path/filepath" @@ -137,6 +140,14 @@ func TestWhatsAppPairsWithACode(t *testing.T) { items <- whatsmeow.QRChannelSuccess asking.WaitFor(t, "WhatsApp is linked to +15550001111.") + // The library connects again after the link with the context of the + // connection, so the end of the pairing must not end it. + connections := fake.Connections() + require.Len(t, connections, 1) + require.Never(t, func() bool { + return connections[0].Err() != nil + }, 200*time.Millisecond, time.Millisecond) + require.Equal(t, []string{whatsappTestNumber}, fake.Phones()) require.Equal(t, "WhatsApp is linked and not connected yet.", whatsapp.Status()) require.Equal(t, "[connected to OneChat]\n", other.Output()) @@ -317,7 +328,7 @@ func TestWhatsAppLongDisconnectionGivesOneNotice(t *testing.T) { whatsappTestSession(t, dir, true) clock := newTestClock() whatsapp, fake, _ := whatsappStartTest(t, dir, clock) - whatsapp.noticeDelay = 50 * time.Millisecond + whatsapp.noticeDelay = 300 * time.Millisecond socket, _ := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) client := terminalStartTestClient(t, socket) client.WaitFor(t, "[connected to OneChat]") @@ -326,7 +337,7 @@ func TestWhatsAppLongDisconnectionGivesOneNotice(t *testing.T) { require.True(t, fake.Emit(&events.Connected{})) require.True(t, fake.Emit(&events.Disconnected{})) require.True(t, fake.Emit(&events.Connected{})) - time.Sleep(100 * time.Millisecond) + time.Sleep(400 * time.Millisecond) require.Equal(t, "[connected to OneChat]\n", client.Output()) clock.now = clock.now.Add(time.Hour) @@ -334,7 +345,7 @@ func TestWhatsAppLongDisconnectionGivesOneNotice(t *testing.T) { require.True(t, fake.Emit(&events.Disconnected{})) client.WaitFor(t, "WhatsApp is disconnected since 2026-01-01 13:00. OneChat tries again.\n") require.True(t, fake.Emit(&events.Disconnected{})) - time.Sleep(100 * time.Millisecond) + time.Sleep(400 * time.Millisecond) require.True(t, fake.Emit(&events.Connected{})) client.WaitFor(t, "WhatsApp is connected again.\n") @@ -487,9 +498,13 @@ func TestWhatsAppPrivateBatchStartsATurnWithAnEmptyReply(t *testing.T) { client.WaitFor(t, "[connected to OneChat]") <-fake.connects + // The catch-up holds the batch open until its end, so the two messages + // form one batch also on a slow machine. + require.True(t, fake.Emit(&events.Connected{})) at := time.Date(2026, 1, 1, 12, 0, 0, 0, time.UTC) require.True(t, fake.Emit(whatsappTestMessage(whatsappTestAna, whatsappTestAna, "m1", "Are you at home?", at))) require.True(t, fake.Emit(whatsappTestMessage(whatsappTestAna, whatsappTestOwn, "m2", "Yes", at))) + require.True(t, fake.Emit(&events.OfflineSyncCompleted{})) text := "[WhatsApp] Ana Souza, private chat 15550002222@s.whatsapp.net, Thursday 2026-01-01\n12:00 Ana Souza: Are you at home?\n12:00 You: Yes\n" + whatsappBatchEmptyReply client.WaitFor(t, text+"\n[working]\n[done]\n") @@ -498,7 +513,7 @@ func TestWhatsAppPrivateBatchStartsATurnWithAnEmptyReply(t *testing.T) { require.Equal(t, []string{text}, whatsappTestLogTexts(t, memory)) require.Empty(t, telegram.Sent()) require.Eventually(t, func() bool { - return len(whatsapp.batches.Closed()) == 0 + return len(whatsapp.state.Closed()) == 0 }, 10*time.Second, time.Millisecond) } @@ -563,7 +578,7 @@ func TestWhatsAppGroupTurns(t *testing.T) { socket, memory := daemonStartTestWithWhatsApp(t, server, nil, whatsapp) client := terminalStartTestClient(t, socket) client.WaitFor(t, "[connected to OneChat]") - <-fake.connects + whatsappTestConnect(t, fake) event := whatsappTestMessage(whatsappTestFamily, whatsappTestBruno, "m1", "Who brings the cake?", time.Date(2026, 1, 1, 12, 0, 0, 0, time.UTC)) event.Info.PushName = "Bruno Lima" @@ -652,8 +667,8 @@ func TestWhatsAppTakesOnlyText(t *testing.T) { event := whatsappTestMessage(whatsappTestAna, whatsappTestAna, "m1", "hi", at) tc.change(event) require.True(t, whatsapp.handle(event)) - require.NoError(t, whatsapp.batches.CloseAll()) - require.Empty(t, whatsapp.batches.Closed()) + require.NoError(t, whatsapp.state.CloseAll()) + require.Empty(t, whatsapp.state.Closed()) }) } } @@ -666,7 +681,412 @@ func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) { dir := t.TempDir() whatsappTestSession(t, dir, true) whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock()) - whatsapp.batches.quiet = 50 * time.Millisecond + whatsapp.state.quiet = 50 * time.Millisecond return whatsapp, fake } + +func TestWhatsAppCatchupGivesOneTurn(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + server := newModelFake(t) + socket, memory := daemonStartTestWithWhatsApp(t, server, nil, whatsapp) + client := terminalStartTestClient(t, socket) + client.WaitFor(t, "[connected to OneChat]") + <-fake.connects + + require.True(t, fake.Emit(&events.Connected{})) + at := time.Date(2026, 1, 1, 8, 0, 0, 0, time.UTC) + for index, event := range []*events.Message{ + whatsappTestMessage(whatsappTestAna, whatsappTestAna, "m1", "Good morning", at), + whatsappTestMessage(whatsappTestBruno, whatsappTestBruno, "m2", "Call me", at.Add(time.Hour)), + whatsappTestMessage(whatsappTestAna, whatsappTestAna, "m3", "Are you there?", at.Add(2*time.Hour)), + } { + event.Info.PushName = []string{"Ana", "Bruno", "Ana"}[index] + require.True(t, fake.Emit(event)) + } + + time.Sleep(100 * time.Millisecond) + require.Zero(t, memory.Len()) + + require.True(t, fake.Emit(&events.OfflineSyncCompleted{})) + client.WaitFor(t, "[done]") + require.Equal(t, []string{ + "[WhatsApp] Ana, private chat 15550002222@s.whatsapp.net, Thursday 2026-01-01\n08:00 Ana: Good morning\n" + whatsappBatchEmptyReply, + "[WhatsApp] Bruno, private chat 15550003333@s.whatsapp.net, Thursday 2026-01-01\n09:00 Bruno: Call me\n" + whatsappBatchEmptyReply, + "[WhatsApp] Ana, private chat 15550002222@s.whatsapp.net, Thursday 2026-01-01\n10:00 Ana: Are you there?\n" + whatsappBatchEmptyReply, + }, whatsappTestLogTexts(t, memory)[:3]) + + time.Sleep(100 * time.Millisecond) + require.Equal(t, 1, server.Calls()) + for _, text := range []string{"Good morning", "Call me", "Are you there?"} { + require.Contains(t, string(server.Call(0).raw), text) + } +} + +func TestWhatsAppCatchupEndsAfterItsLimit(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + whatsapp.catchupLimit = 100 * time.Millisecond + socket, memory := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + client := terminalStartTestClient(t, socket) + client.WaitFor(t, "[connected to OneChat]") + <-fake.connects + + require.True(t, fake.Emit(&events.Connected{})) + require.True(t, fake.Emit(whatsappTestMessage(whatsappTestAna, whatsappTestOwn, "m1", "On my way.", time.Date(2026, 1, 1, 12, 0, 0, 0, time.UTC)))) + client.WaitFor(t, "12:00 You: On my way.") + require.Len(t, whatsappTestLogTexts(t, memory), 1) +} + +func TestWhatsAppStateOfTheStateFileWaitForTheCatchup(t *testing.T) { + dir := t.TempDir() + whatsappTestSession(t, dir, true) + before, _, _ := whatsappStartTest(t, dir, newTestClock()) + _, err := before.state.Add(whatsappTestChat, WhatsAppMessage{ + ID: "m1", + Sender: "Ana Souza", + Time: time.Date(2026, 1, 1, 12, 0, 0, 0, time.UTC), + Text: "Did you see my message?", + }, time.Now().Add(-time.Hour)) + require.NoError(t, err) + + whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock()) + socket, memory := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + client := terminalStartTestClient(t, socket) + client.WaitFor(t, "[connected to OneChat]") + <-fake.connects + + time.Sleep(100 * time.Millisecond) + require.Zero(t, memory.Len()) + + require.True(t, fake.Emit(&events.Connected{})) + require.True(t, fake.Emit(&events.OfflineSyncCompleted{})) + client.WaitFor(t, "12:00 Ana Souza: Did you see my message?") + client.WaitFor(t, "[done]") +} + +// whatsappTestConnect waits for the connection of the daemon and gives it the +// events of a connection with an empty catch-up. +func whatsappTestConnect(t *testing.T, fake *WhatsAppFake) { + t.Helper() + + <-fake.connects + require.True(t, fake.Emit(&events.Connected{})) + require.True(t, fake.Emit(&events.OfflineSyncCompleted{})) +} + +func TestWhatsAppFindMatchesNamesWithNoRegardToCaseAndAccents(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + fake.groups = []*types.GroupInfo{ + { + JID: whatsappTestFamily, + GroupName: types.GroupName{ + Name: "Família Souza", + }, + }, + } + + whatsappTestContacts(t, whatsapp) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + testCases := []struct { + name string + query string + answer string + }{ + { + name: "no accent finds an accent", + query: "joao", + answer: "15550004444@s.whatsapp.net | João Silva | contact", + }, + { + name: "a part of a name finds contacts and groups", + query: "SOUZA", + answer: "15550002222@s.whatsapp.net | Ana Souza | contact\n120363000000000001@g.us | Família Souza | group", + }, + { + name: "a business name", + query: "bakery", + answer: "15550005555@s.whatsapp.net | Corner Bakery | contact", + }, + { + name: "no match", + query: "Zed", + answer: "No contact or group has a name with \"Zed\".", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + answer, err := whatsapp.Find(t.Context(), tc.query) + require.NoError(t, err) + require.Equal(t, tc.answer, answer) + }) + } +} + +func TestWhatsAppFindGivesAtMostTwentyMatches(t *testing.T) { + whatsapp, _ := whatsappStartTestLinked(t) + for index := range 25 { + jid := types.NewJID(fmt.Sprintf("1555001%04d", index), types.DefaultUserServer) + require.NoError(t, whatsapp.device.Contacts.PutContactName(t.Context(), jid, "", fmt.Sprintf("Member %02d", index))) + } + + answer, err := whatsapp.Find(t.Context(), "member") + require.NoError(t, err) + + lines := strings.Split(answer, "\n") + require.Len(t, lines, 22) + require.Equal(t, "15550010000@s.whatsapp.net | Member 00 | contact", lines[0]) + require.Equal(t, "5 more: give a longer part of the name.", lines[20]) + require.Equal(t, "The groups are not in this answer, because WhatsApp is disconnected.", lines[21]) +} + +func TestWhatsAppFindBeforeTheNamesArrive(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + answer, err := whatsapp.Find(t.Context(), "ana") + require.NoError(t, err) + require.Equal(t, whatsappNamesNotReady, answer) +} + +func TestWhatsAppFindWithoutALink(t *testing.T) { + whatsapp, _, _ := whatsappStartTest(t, t.TempDir(), newTestClock()) + + answer, err := whatsapp.Find(t.Context(), "ana") + require.NoError(t, err) + require.Equal(t, whatsappNotLinked, answer) +} + +func TestAgentFindsAWhatsAppContact(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + whatsappTestContacts(t, whatsapp) + server := newModelFake(t) + server.reply = func(w http.ResponseWriter, call ModelFakeCall) { + if call.number == 0 { + modelWriteEvents(w, modelCompletedEvent([]any{modelFunctionCallItem("fc_1", "call_1", "whatsapp_find", `{"name":"ana"}`)}, 100, 0, 5)) + return + } + + modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("Found Ana.")}, 100, 0, 5)) + } + + socket, _ := daemonStartTestWithWhatsApp(t, server, nil, whatsapp) + client := terminalStartTestClient(t, socket) + whatsappTestConnect(t, fake) + + client.Type("Find Ana on WhatsApp.") + client.WaitFor(t, "[result] 15550002222@s.whatsapp.net | Ana Souza | contact\nFound Ana.\n[done]") +} + +func TestSubagentHasNoWhatsAppTools(t *testing.T) { + box := &Toolbox{} + require.Equal(t, `error: unknown tool "whatsapp_find"`, box.run(t.Context(), "whatsapp_find", `{"name":"ana"}`)) + require.Equal(t, `error: unknown tool "whatsapp_send"`, box.run(t.Context(), "whatsapp_send", `{"id":"a","chat":"15550002222@s.whatsapp.net","text":"hi"}`)) +} + +// whatsappTestContacts puts the contacts of the tests into the session of +// whatsapp: Ana Souza, Joao Silva with an accent, a business, and the user. +func whatsappTestContacts(t *testing.T, whatsapp *WhatsApp) { + t.Helper() + + contacts := whatsapp.device.Contacts + require.NoError(t, contacts.PutContactName(t.Context(), whatsappTestAna, "Ana", "Ana Souza")) + require.NoError(t, contacts.PutContactName(t.Context(), types.NewJID("15550004444", types.DefaultUserServer), "João", "João Silva")) + _, _, err := contacts.PutBusinessName(t.Context(), types.NewJID("15550005555", types.DefaultUserServer), "Corner Bakery") + require.NoError(t, err) + require.NoError(t, contacts.PutContactName(t.Context(), whatsappTestOwn, "Me", "Me Souza")) +} + +func TestWhatsAppSendSendsOnceForEachID(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + whatsappTestContacts(t, whatsapp) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + answer, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "The keys are under the mat.") + require.NoError(t, err) + require.Equal(t, "Sent to Ana Souza at 12:05.", answer) + + answer, err = whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "The keys are under the mat.") + require.NoError(t, err) + require.Equal(t, "Sent to Ana Souza at 12:05. This is the answer of the first call with this id: nothing was sent again.", answer) + + _, err = whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "Another text.") + require.EqualError(t, err, "the id keys belongs to another message: give a new id for each message") + + require.Equal(t, []WhatsAppFakeSend{ + { + to: whatsappTestAna.String(), + text: "The keys are under the mat.", + id: "MSG1", + }, + }, fake.Sent()) + + again, err := openWhatsAppState(filepath.Join(whatsapp.dir, whatsappStateFileName), whatsappBatchQuiet, whatsappBatchWindow) + require.NoError(t, err) + + record, found := again.Send("keys") + require.True(t, found) + require.Equal(t, whatsappSent, record.State) + require.Equal(t, "MSG1", record.MessageID) +} + +func TestWhatsAppSendToAGroup(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + fake.groups = []*types.GroupInfo{ + { + JID: whatsappTestFamily, + GroupName: types.GroupName{ + Name: "Family", + }, + }, + } + + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + answer, err := whatsapp.Send(t.Context(), "cake", whatsappTestFamily.String(), "I bring the cake.") + require.NoError(t, err) + require.Equal(t, "Sent to Family at 12:05.", answer) +} + +func TestWhatsAppSendThatFails(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + fake.sendErr = errors.New("server error for " + whatsappTestNumber) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + for range 2 { + answer, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "hi") + require.NoError(t, err) + require.True(t, strings.HasPrefix(answer, "The send failed: server error for OWN."), answer) + } + + require.Len(t, fake.Sent(), 1) +} + +func TestWhatsAppSendCutByAStop(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + digest := sha256.Sum256([]byte("hi")) + require.NoError(t, whatsapp.state.PutSend(WhatsAppSend{ + ID: "keys", + Chat: whatsappTestAna.String(), + Digest: hex.EncodeToString(digest[:]), + State: whatsappSending, + })) + + answer, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "hi") + require.NoError(t, err) + require.Contains(t, answer, "its result is unknown") + require.Empty(t, fake.Sent()) +} + +func TestWhatsAppSendRefuses(t *testing.T) { + testCases := []struct { + name string + id string + chat string + text string + err string + }{ + { + name: "no id", + id: " ", + chat: whatsappTestAna.String(), + text: "hi", + err: "the id must have 1 to 100 bytes", + }, + { + name: "no text", + id: "a", + chat: whatsappTestAna.String(), + text: "", + err: "the text must have 1 to 65536 bytes", + }, + { + name: "a name for a chat", + id: "a", + chat: "Ana Souza", + text: "hi", + err: `"Ana Souza" is not the ID of a WhatsApp chat: find the ID with whatsapp_find`, + }, + { + name: "a status broadcast", + id: "a", + chat: types.StatusBroadcastJID.String(), + text: "hi", + err: `"status@broadcast" is not a private chat or a group`, + }, + { + name: "the chat of the user", + id: "a", + chat: whatsappTestOwn.String(), + text: "hi", + err: "this is the chat of the user with itself: send to another chat", + }, + } + + whatsapp, fake := whatsappStartTestLinked(t) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + _, err := whatsapp.Send(t.Context(), tc.id, tc.chat, tc.text) + require.EqualError(t, err, tc.err) + }) + } + + require.Empty(t, fake.Sent()) +} + +func TestWhatsAppSendWhileDisconnected(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp) + whatsappTestConnect(t, fake) + require.True(t, fake.Emit(&events.Disconnected{})) + + _, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "hi") + require.EqualError(t, err, "WhatsApp is disconnected, so nothing was sent: try again later") + + require.True(t, fake.Emit(&events.Connected{})) + answer, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "hi") + require.NoError(t, err) + require.Equal(t, "Sent to +15550002222 at 12:05.", answer) +} + +func TestWhatsAppSendWithoutALink(t *testing.T) { + whatsapp, _, _ := whatsappStartTest(t, t.TempDir(), newTestClock()) + + answer, err := whatsapp.Send(t.Context(), "keys", whatsappTestAna.String(), "hi") + require.NoError(t, err) + require.Equal(t, whatsappNotLinked, answer) +} + +func TestAgentSendsAWhatsAppMessage(t *testing.T) { + whatsapp, fake := whatsappStartTestLinked(t) + whatsappTestContacts(t, whatsapp) + server := newModelFake(t) + server.reply = func(w http.ResponseWriter, call ModelFakeCall) { + if call.number == 0 { + modelWriteEvents(w, modelCompletedEvent([]any{modelFunctionCallItem("fc_1", "call_1", "whatsapp_send", `{"id":"keys","chat":"15550002222@s.whatsapp.net","text":"The keys are under the mat."}`)}, 100, 0, 5)) + return + } + + modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("Sent.")}, 100, 0, 5)) + } + + socket, _ := daemonStartTestWithWhatsApp(t, server, nil, whatsapp) + client := terminalStartTestClient(t, socket) + whatsappTestConnect(t, fake) + + client.Type("Tell Ana that the keys are under the mat.") + client.WaitFor(t, "[result] Sent to Ana Souza at 12:05.\nSent.\n[done]") + require.Len(t, fake.Sent(), 1) +}