]> git.giacomolli.uk - onechat/blobdiff - whatsapp_test.go
Show stored images to the user
[onechat] / whatsapp_test.go
index 5c38d59123714b757bea6d4d330d1672fed0ab60..c1471e98e8f3c3aa2ad97daa69cd13795be3bd59 100644 (file)
@@ -6,6 +6,7 @@ import (
        "path/filepath"
        "strings"
        "testing"
+       "testing/synctest"
        "time"
 
        "github.com/stretchr/testify/require"
@@ -17,6 +18,7 @@ import (
 func TestWhatsAppStatusFollowsTheConnection(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
+
        clock := newTestClock()
        whatsapp, fake, _ := whatsappStartTest(t, dir, clock)
        daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
@@ -28,44 +30,290 @@ func TestWhatsAppStatusFollowsTheConnection(t *testing.T) {
        require.Equal(t, "WhatsApp is linked and connected since 2026-01-01 12:00.", whatsapp.Status())
 
        clock.now = clock.now.Add(20 * 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:20. The last connection started at 2026-01-01 12:00.", whatsapp.Status())
 }
 
 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, "<4>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, "<4>first connect failed, retrying: network unavailable\n<6>connected 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, "<4>first connect failed, retrying: network unavailable\n<6>connected 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(whatsappOutageNoticeDelay)
+               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(whatsappOutageNoticeDelay)
+               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, logs := whatsappStartTest(t, dir, newTestClock())
-       daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
 
-       <-fake.connects
-       require.True(t, fake.Emit(&events.Disconnected{}))
-       require.Equal(t, "WhatsApp is linked and disconnected since 2026-01-01 12:00.", whatsapp.Status())
-       require.Equal(t, "new WhatsApp messages wait, because the first connection failed (the next try is automatic)\n", logs.String())
+       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{}))
+
        clock.now = clock.now.Add(25 * time.Second)
+
        require.True(t, fake.Emit(&events.Connected{}))
 
        require.Equal(t, []string{
-               "WhatsApp is connected, and new messages come in",
-               "new WhatsApp messages wait, because the connection is lost (the next try is automatic)",
-               "WhatsApp is connected again, after 1m25s",
+               "<6>connected",
+               "<4>disconnected, retrying",
+               "<6>connected again after=1m25s",
        }, strings.Split(strings.TrimSuffix(logs.String(), "\n"), "\n"))
        require.NotContains(t, logs.String(), whatsappTestNumber)
        require.NotContains(t, logs.String(), whatsappTestLID)
@@ -78,7 +326,7 @@ func TestWhatsAppIsNotLinkedWithoutALinkedDevice(t *testing.T) {
        }{
                {
                        name: "no session file",
-                       session: func(t *testing.T, dir string) {
+                       session: func(_ *testing.T, _ string) {
                        },
                },
                {
@@ -93,6 +341,7 @@ func TestWhatsAppIsNotLinkedWithoutALinkedDevice(t *testing.T) {
                t.Run(tc.name, func(t *testing.T) {
                        dir := t.TempDir()
                        tc.session(t, dir)
+
                        whatsapp, _, _ := whatsappStartTest(t, dir, newTestClock())
                        require.Equal(t, "WhatsApp is not linked. Run /whatsapp pair PHONE to link it.", whatsapp.Status())
                })
@@ -138,7 +387,7 @@ func TestWhatsAppCommandsAnswerOnlyTheClientThatAsked(t *testing.T) {
 
 func TestWhatsAppPairsWithACode(t *testing.T) {
        dir := t.TempDir()
-       whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
+       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
        server := newModelFake(t)
        socket, memory := daemonStartTestWithWhatsApp(t, server, nil, whatsapp)
        asking := terminalStartTestClient(t, socket)
@@ -147,6 +396,7 @@ func TestWhatsAppPairsWithACode(t *testing.T) {
        other.WaitFor(t, "[connected to OneChat]")
 
        asking.Type("/whatsapp pair +1 555-000-1111")
+
        items := <-fake.pairings
        items <- whatsmeow.QRChannelItem{
                Event: whatsmeow.QRChannelEventCode,
@@ -157,7 +407,9 @@ func TestWhatsAppPairsWithACode(t *testing.T) {
                ID:  types.NewADJID(whatsappTestNumber, 0, 1),
                LID: types.NewADJID(whatsappTestLID, 0, 1),
        }))
+
        items <- whatsmeow.QRChannelSuccess
+
        asking.WaitFor(t, "WhatsApp is linked to +15550001111.")
 
        // The library connects again after the link with the context of the
@@ -173,6 +425,7 @@ func TestWhatsAppPairsWithACode(t *testing.T) {
        require.Equal(t, "[connected to OneChat]\n", other.Output())
        require.Zero(t, server.Calls())
        require.Equal(t, []string{"WhatsApp is linked."}, whatsappTestLogTexts(t, memory))
+       require.Equal(t, "<6>linked\n", logs.String())
 
        info, err := os.Stat(filepath.Join(dir, whatsappDirName))
        require.NoError(t, err)
@@ -262,6 +515,7 @@ func TestWhatsAppNewPairingEndsTheOneBefore(t *testing.T) {
        client.Type("/whatsapp pair 15550001111")
        <-fake.pairings
        client.Type("/whatsapp pair 15550002222")
+
        items := <-fake.pairings
        items <- whatsmeow.QRChannelItem{
                Event: whatsmeow.QRChannelEventCode,
@@ -275,6 +529,7 @@ func TestWhatsAppNewPairingEndsTheOneBefore(t *testing.T) {
 func TestWhatsAppPairWhenLinked(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
+
        whatsapp, _, _ := whatsappStartTest(t, dir, newTestClock())
        socket, _ := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
        client := terminalStartTestClient(t, socket)
@@ -304,15 +559,18 @@ func TestWhatsAppUnlink(t *testing.T) {
                t.Run(tc.name, func(t *testing.T) {
                        dir := t.TempDir()
                        whatsappTestSession(t, dir, true)
-                       whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
+
+                       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
                        fake.logoutErr = tc.logoutErr
                        socket, memory := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
                        client := terminalStartTestClient(t, socket)
+
                        <-fake.connects
 
                        client.Type("/whatsapp unlink")
                        client.WaitFor(t, tc.answer)
                        require.Equal(t, 1, fake.Logouts())
+                       require.Equal(t, "<6>unlinked\n", logs.String())
                        require.NoFileExists(t, filepath.Join(dir, whatsappDirName, whatsappSessionFileName))
                        require.Equal(t, "WhatsApp is not linked. Run /whatsapp pair PHONE to link it.", whatsapp.Status())
                        require.Equal(t, []string{"WhatsApp is unlinked."}, whatsappTestLogTexts(t, memory))
@@ -326,7 +584,8 @@ func TestWhatsAppUnlink(t *testing.T) {
 func TestWhatsAppLogoutFromThePhone(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
-       whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
+
+       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
        telegram := newTelegramFake(t)
        bot, _ := telegramStartTestBot(t, telegram)
        socket, memory := daemonStartTestWithWhatsApp(t, newModelFake(t), bot, whatsapp)
@@ -335,47 +594,51 @@ func TestWhatsAppLogoutFromThePhone(t *testing.T) {
        <-fake.connects
 
        require.True(t, fake.Emit(&events.LoggedOut{}))
+
        notice := "WhatsApp was unlinked from the phone. Run /whatsapp pair PHONE to link it again."
        client.WaitFor(t, notice)
        telegramWaitForSent(t, telegram, notice)
+       require.Equal(t, "<3>logged out by the phone, run /whatsapp pair PHONE\n", logs.String())
        require.NoFileExists(t, filepath.Join(dir, whatsappDirName, whatsappSessionFileName))
        require.Equal(t, "WhatsApp is not linked. Run /whatsapp pair PHONE to link it.", whatsapp.Status())
        require.Equal(t, []string{"WhatsApp was unlinked from the phone."}, whatsappTestLogTexts(t, memory))
 }
 
 func TestWhatsAppLongDisconnectionGivesOneNotice(t *testing.T) {
-       dir := t.TempDir()
-       whatsappTestSession(t, dir, true)
-       clock := newTestClock()
-       whatsapp, fake, _ := whatsappStartTest(t, dir, clock)
-       whatsapp.noticeDelay = 300 * time.Millisecond
-       socket, _ := 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(&events.Disconnected{}))
-       require.True(t, fake.Emit(&events.Connected{}))
-       time.Sleep(400 * time.Millisecond)
-       require.Equal(t, "[connected to OneChat]\n", client.Output())
-
-       clock.now = clock.now.Add(time.Hour)
-       require.True(t, fake.Emit(&events.Disconnected{}))
-       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(400 * time.Millisecond)
-
-       require.True(t, fake.Emit(&events.Connected{}))
-       client.WaitFor(t, "WhatsApp is connected again.\n")
-       require.Equal(t, 1, strings.Count(client.Output(), "WhatsApp is disconnected since"))
+       synctest.Test(t, func(t *testing.T) {
+               test := whatsappRetryTest(t)
+               test.start(t)
+               synctest.Wait()
+
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               time.Sleep(whatsappOutageNoticeDelay + time.Second)
+               synctest.Wait()
+               require.Zero(t, test.events.Count("notice"))
+
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+               time.Sleep(whatsappOutageNoticeDelay)
+               synctest.Wait()
+               require.Equal(t, 1, test.events.Count("notice"))
+               require.Contains(t, test.events.Last("notice"), "OneChat tries again.")
+               require.True(t, test.fake.Emit(&events.Disconnected{}))
+               time.Sleep(whatsappOutageNoticeDelay)
+               synctest.Wait()
+               require.Equal(t, 1, test.events.Count("notice"))
+
+               require.True(t, test.fake.Emit(&events.Connected{}))
+               require.Equal(t, 2, test.events.Count("notice"))
+               require.Equal(t, "WhatsApp is connected again.", test.events.Last("notice"))
+       })
 }
 
 func TestWhatsAppDisconnectionWithNoRetryGivesANoticeAtOnce(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
-       whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
+
+       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
        socket, _ := daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
        client := terminalStartTestClient(t, socket)
        client.WaitFor(t, "[connected to OneChat]")
@@ -383,20 +646,23 @@ func TestWhatsAppDisconnectionWithNoRetryGivesANoticeAtOnce(t *testing.T) {
 
        require.True(t, fake.Emit(&events.StreamReplaced{}))
        client.WaitFor(t, "WhatsApp is disconnected and does not connect again by itself: stream replaced. Restart the daemon to try again.")
+       require.Equal(t, "<3>disconnected for good, restart to retry: stream replaced\n", logs.String())
 }
 
 func TestWhatsAppLogsNoOwnNumber(t *testing.T) {
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
+
        whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
        fake.connectErr = errors.New("no route for " + whatsappTestNumber + "@s.whatsapp.net and " + whatsappTestLID + "@lid")
+
        daemonStartTestWithWhatsApp(t, newModelFake(t), nil, whatsapp)
        <-fake.connects
 
        require.Eventually(t, func() bool {
                return logs.String() != ""
        }, 10*time.Second, time.Millisecond)
-       require.Equal(t, "WhatsApp messages do not come, because the connection failed, and it is tried again only at a restart of the daemon: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
+       require.Equal(t, "<4>first connect failed, retrying: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
 }
 
 func TestWhatsAppPhone(t *testing.T) {