]> git.giacomolli.uk - onechat/blobdiff - whatsapp_test.go
Separate returns from longer statement blocks
[onechat] / whatsapp_test.go
index e0018e5ba2a744d99f6130ed03b269dd366ebfc1..dca137b8a55bf6d2dd2d87ea2f8cd206087e3170 100644 (file)
@@ -1,11 +1,13 @@
 package main
 
 import (
+       "context"
        "errors"
        "os"
        "path/filepath"
        "strings"
        "testing"
+       "testing/synctest"
        "time"
 
        "github.com/stretchr/testify/require"
@@ -35,14 +37,261 @@ func TestWhatsAppStatusFollowsTheConnection(t *testing.T) {
 }
 
 func TestWhatsAppStatusOfAFirstConnectionThatFailed(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+
+               require.Equal(t, "WhatsApp is linked and disconnected since "+time.Now().Format(whatsappTimeLayout)+".", test.whatsapp.Status())
+               require.Equal(t, "first connect failed, retrying: network unavailable\n", test.logs.String())
+       })
+}
+
+func TestWhatsAppRetriesTheFirstConnectionWithCappedBackoff(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               for range 10 {
+                       test.fake.connectErrors = append(test.fake.connectErrors, errors.New("network unavailable"))
+               }
+
+               test.start(t)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 1)
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+
+               delays := []time.Duration{2 * time.Second, 4 * time.Second, 8 * time.Second, 16 * time.Second, 32 * time.Second, 64 * time.Second, 128 * time.Second, 256 * time.Second, 5 * time.Minute, 5 * time.Minute}
+               var outage time.Duration
+               for index, delay := range delays {
+                       time.Sleep(delay - time.Nanosecond)
+                       synctest.Wait()
+                       require.Len(t, test.fake.Connections(), index+1)
+                       time.Sleep(time.Nanosecond)
+                       synctest.Wait()
+                       require.Len(t, test.fake.Connections(), index+2)
+                       outage += delay
+               }
+
+               times := test.fake.ConnectionTimes()
+               for index, delay := range delays {
+                       require.Equal(t, delay, times[index+1].Sub(times[index]))
+               }
+
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               require.True(t, test.fake.Emit(&events.OfflineSyncCompleted{}))
+               synctest.Wait()
+               time.Sleep(10 * time.Minute)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 11)
+               require.Equal(t, "first connect failed, retrying: network unavailable\nconnected again after "+durationText(outage)+"\n", test.logs.String())
+       })
+}
+
+func TestWhatsAppFirstConnectionRetriesStopWhenContextEnds(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+               time.Sleep(2 * time.Second)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 2)
+
+               test.cancel()
+               require.NoError(t, <-test.done)
+               time.Sleep(10 * time.Minute)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 2)
+       })
+}
+
+func TestWhatsAppLinkedPairRequestKeepsFirstConnectionRetries(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+
+               answers := make(chan string, 1)
+               test.whatsapp.Command("pair 15550001111", func(text string) {
+                       answers <- text
+               })
+               require.Equal(t, "WhatsApp is linked already. Run /whatsapp unlink first.", <-answers)
+               synctest.Wait()
+               test.fake.mutex.Lock()
+               test.fake.connectErr = nil
+               test.fake.mutex.Unlock()
+               time.Sleep(whatsappRetryDelay)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 2)
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               require.True(t, test.fake.Emit(&events.OfflineSyncCompleted{}))
+               require.Contains(t, test.whatsapp.Status(), "linked and connected since")
+               time.Sleep(whatsappRetryLimit)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 2)
+               require.Equal(t, "first connect failed, retrying: network unavailable\nconnected again after 2s\n", test.logs.String())
+       })
+}
+
+func TestWhatsAppFirstConnectionRetriesStopForLinkChanges(t *testing.T) {
+       testCases := []struct {
+               name string
+               stop func(test *WhatsAppRetryTest)
+       }{
+               {
+                       name: "unlink",
+                       stop: func(test *WhatsAppRetryTest) {
+                               test.whatsapp.Command("unlink", func(_ string) {
+                               })
+                       },
+               },
+               {
+                       name: "logout",
+                       stop: func(test *WhatsAppRetryTest) {
+                               test.fake.Emit(&events.LoggedOut{})
+                       },
+               },
+               {
+                       name: "permanent disconnect",
+                       stop: func(test *WhatsAppRetryTest) {
+                               test.fake.Emit(&events.StreamReplaced{})
+                       },
+               },
+       }
+
+       for _, tc := range testCases {
+               t.Run(tc.name, func(t *testing.T) {
+                       synctest.Test(t, func(t *testing.T) {
+                               test := whatsappRetryTest(t)
+                               test.fake.connectErr = errors.New("network unavailable")
+                               test.start(t)
+                               synctest.Wait()
+                               tc.stop(test)
+                               synctest.Wait()
+                               time.Sleep(10 * time.Minute)
+                               synctest.Wait()
+                               require.Len(t, test.fake.Connections(), 1)
+                       })
+               })
+       }
+}
+
+func TestWhatsAppPairsAfterFirstConnectionRetriesStop(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+               test.whatsapp.Command("unlink", func(_ string) {
+               })
+               synctest.Wait()
+               require.False(t, test.whatsapp.isLinked())
+
+               test.fake.mutex.Lock()
+               test.fake.connectErr = nil
+               test.fake.mutex.Unlock()
+               test.whatsapp.Command("pair 15550001111", func(_ string) {
+               })
+               items := <-test.fake.pairings
+               items <- whatsmeow.QRChannelItem{Event: whatsmeow.QRChannelEventCode}
+               synctest.Wait()
+               require.True(t, test.fake.Emit(&events.PairSuccess{
+                       ID:  types.NewADJID(whatsappTestNumber, 0, 1),
+                       LID: types.NewADJID(whatsappTestLID, 0, 1),
+               }))
+               items <- whatsmeow.QRChannelSuccess
+               synctest.Wait()
+               require.True(t, test.whatsapp.isLinked())
+               time.Sleep(10 * time.Minute)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 2)
+               require.Equal(t, []string{whatsappTestNumber}, test.fake.Phones())
+       })
+}
+
+func TestWhatsAppInboxFailureStopsFirstConnectionRetries(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+               failure := errors.New("state write failed")
+               test.whatsapp.inbox.failures <- failure
+               require.ErrorIs(t, <-test.done, failure)
+               time.Sleep(10 * time.Minute)
+               synctest.Wait()
+               require.Len(t, test.fake.Connections(), 1)
+       })
+}
+
+func TestWhatsAppLongFirstConnectionOutageGivesOneNotice(t *testing.T) {
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.fake.connectErr = errors.New("network unavailable")
+               test.start(t)
+               synctest.Wait()
+               since := time.Now().Format(whatsappTimeLayout)
+               time.Sleep(whatsappNoticeDelay)
+               synctest.Wait()
+               require.Equal(t, 1, test.events.Count("notice"))
+               require.Equal(t, "WhatsApp is disconnected since "+since+". OneChat tries again.", test.events.Last("notice"))
+
+               time.Sleep(whatsappNoticeDelay)
+               synctest.Wait()
+               require.Equal(t, 1, test.events.Count("notice"))
+               test.fake.mutex.Lock()
+               test.fake.connectErr = nil
+               test.fake.mutex.Unlock()
+               time.Sleep(whatsappRetryLimit)
+               synctest.Wait()
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               require.True(t, test.fake.Emit(&events.OfflineSyncCompleted{}))
+               synctest.Wait()
+               require.Equal(t, 2, test.events.Count("notice"))
+               require.Equal(t, "WhatsApp is connected again.", test.events.Last("notice"))
+       })
+}
+
+func TestWhatsAppStartingRetriesDoNotDuplicateLibraryRetries(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
-       whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
+       whatsapp, _, _ := whatsappStartTest(t, dir, newTestClock())
+       client, ok := whatsappNewClient(whatsapp.device, whatsapp.handle).(*whatsmeow.Client)
+       require.True(t, ok)
+       require.False(t, client.InitialAutoReconnect)
+       require.True(t, client.EnableAutoReconnect)
+
+       device := whatsapp.container.NewDevice()
+       client, ok = whatsappNewClient(device, whatsapp.handle).(*whatsmeow.Client)
+       require.True(t, ok)
+       require.True(t, client.InitialAutoReconnect)
+}
+
+func TestWhatsAppLogsEachChangeOfTheConnectionOnce(t *testing.T) {
+       dir := t.TempDir()
+       whatsappTestSession(t, dir, true)
+       clock := newTestClock()
+       whatsapp, fake, logs := whatsappStartTest(t, dir, clock)
        daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
 
        <-fake.connects
+       require.True(t, fake.Emit(&events.Connected{}))
+       clock.now = clock.now.Add(time.Minute)
+       require.True(t, fake.Emit(&events.Disconnected{}))
+       clock.now = clock.now.Add(time.Minute)
        require.True(t, fake.Emit(&events.Disconnected{}))
-       require.Equal(t, "WhatsApp is linked and disconnected since 2026-01-01 12:00.", whatsapp.Status())
+       clock.now = clock.now.Add(25 * time.Second)
+       require.True(t, fake.Emit(&events.Connected{}))
+
+       require.Equal(t, []string{
+               "connected",
+               "disconnected, retrying",
+               "connected again after 1m25s",
+       }, strings.Split(strings.TrimSuffix(logs.String(), "\n"), "\n"))
+       require.NotContains(t, logs.String(), whatsappTestNumber)
+       require.NotContains(t, logs.String(), whatsappTestLID)
 }
 
 func TestWhatsAppIsNotLinkedWithoutALinkedDevice(t *testing.T) {
@@ -52,7 +301,7 @@ func TestWhatsAppIsNotLinkedWithoutALinkedDevice(t *testing.T) {
        }{
                {
                        name: "no session file",
-                       session: func(t *testing.T, dir string) {
+                       session: func(_ *testing.T, _ string) {
                        },
                },
                {
@@ -134,6 +383,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())
@@ -314,7 +571,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]")
@@ -323,7 +580,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)
@@ -331,7 +588,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")
@@ -362,7 +619,7 @@ func TestWhatsAppLogsNoOwnNumber(t *testing.T) {
        require.Eventually(t, func() bool {
                return logs.String() != ""
        }, 10*time.Second, time.Millisecond)
-       require.Equal(t, "connect: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
+       require.Equal(t, "first connect failed, retrying: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
 }
 
 func TestWhatsAppPhone(t *testing.T) {
@@ -448,22 +705,65 @@ func TestWhatsAppCommandArgs(t *testing.T) {
        }
 }
 
-// whatsappTestLogTexts returns the texts of the messages in the log of memory,
-// after the log holds at least one message.
-func whatsappTestLogTexts(t *testing.T, memory *Memory) []string {
+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"}`))
+}
+
+// WhatsAppRetryTest runs WhatsApp without a model or network client call. All
+// timers and channels belong to its synctest bubble, so backoff uses fake time.
+type WhatsAppRetryTest struct {
+       whatsapp *WhatsApp
+       fake     *WhatsAppFake
+       logs     *SyncBuffer
+       loop     *TurnLoop
+       events   *TurnEventRecorder
+       cancel   context.CancelFunc
+       done     chan error
+}
+
+func (r *WhatsAppRetryTest) start(t *testing.T) {
        t.Helper()
 
-       require.Eventually(t, func() bool {
-               return memory.Len() > 0
-       }, 10*time.Second, time.Millisecond)
+       ctx, cancel := context.WithCancel(t.Context())
+       r.cancel = cancel
+       r.done = make(chan error, 1)
+       go func() {
+               r.done <- r.whatsapp.Run(ctx, r.loop, r.events.Add)
+       }()
 
-       var texts []string
-       for id := range memory.Len() {
-               message, err := memory.Message(id)
-               require.NoError(t, err)
+       t.Cleanup(func() {
+               cancel()
+               synctest.Wait()
+       })
+}
 
-               texts = append(texts, message.Text)
-       }
+func whatsappRetryTest(t *testing.T) *WhatsAppRetryTest {
+       t.Helper()
 
-       return texts
+       dir := t.TempDir()
+       whatsappTestSession(t, dir, true)
+       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
+       whatsapp.clock = time.Now
+       agent, err := openAgent(t.TempDir())
+       require.NoError(t, err)
+       memory, err := openMemory(t.Context(), agent.dir, time.Now, newFakeSummarizer(), discardLog())
+       require.NoError(t, err)
+       t.Cleanup(func() {
+               require.NoError(t, memory.Close())
+       })
+
+       events := &TurnEventRecorder{}
+       client := newModelClient("https://example.com", ModelAPIKey(modelTestKey), agent.CacheKey(), filepath.Join(agent.dir, "usage.jsonl"))
+       loop, err := newTurnLoop(agent, memory, newTestSubagents(t), whatsapp, newTestSchedules(t, time.Now), client, time.Now, discardLog(), events.Add)
+       require.NoError(t, err)
+
+       return &WhatsAppRetryTest{
+               whatsapp: whatsapp,
+               fake:     fake,
+               logs:     logs,
+               loop:     loop,
+               events:   events,
+       }
 }