Name timeouts for the operations they limit

[onechat] / whatsapp_fake_helper_test.go

diff --git a/whatsapp_fake_helper_test.go b/whatsapp_fake_helper_test.go
index 3d7d117c0337967156eb096767ee15b06a27166f..9f80b382dfb096d91fe4cb18638e7faef45684f8 100644 (file)
--- a/whatsapp_fake_helper_test.go
+++ b/whatsapp_fake_helper_test.go
@@ -3,13 +3,13 @@ package main
 import (
        "context"
        "fmt"
 import (
        "context"
        "fmt"

-       "io"
-       "log"
+       "log/slog"

        "os"
        "path/filepath"
        "slices"
        "sync"
        "testing"
        "os"
        "path/filepath"
        "slices"
        "sync"
        "testing"

+       "testing/synctest"

        "time"
 
        "github.com/stretchr/testify/require"
        "time"
 
        "github.com/stretchr/testify/require"


@@ -69,29 +69,37 @@ var (
 // daemon gives it, and Emit gives events to the handler, as the library does.
 // Each connection keeps its context and sends to connects, and each pairing
 // sends its channel to pairings, so that the test gives the items of the
 // daemon gives it, and Emit gives events to the handler, as the library does.
 // Each connection keeps its context and sends to connects, and each pairing
 // sends its channel to pairings, so that the test gives the items of the

-// pairing. A connection fails with connectErr, a logout with logoutErr, and a
-// send with sendErr. groups are the groups of the account. A send that does not
-// fail gets the time whatsappTestSendTime.
+// pairing. A connection takes its error from connectErrors, then connectErr. A
+// logout fails with logoutErr, and a send with sendErr. groups are the groups
+// of the account. A send that does not fail gets the time whatsappTestSendTime.

 type WhatsAppFake struct {
        connects chan struct{}
        pairings chan chan whatsmeow.QRChannelItem
 
 type WhatsAppFake struct {
        connects chan struct{}
        pairings chan chan whatsmeow.QRChannelItem
 

-       mutex       sync.Mutex
-       handle      func(event any) bool
-       connectErr  error
-       logoutErr   error
-       groups      []*types.GroupInfo
-       sendErr     error
-       phones      []string
-       logouts     int
-       sent        []WhatsAppFakeSend
-       connections []context.Context
+       mutex         sync.Mutex
+       handle        func(event any) bool
+       connectErr    error
+       connectErrors []error
+       connectTimes  []time.Time
+       logoutErr     error
+       groups        []*types.GroupInfo
+       sendErr       error
+       downloadData  []byte
+       downloadErr   error
+       downloadWait  time.Duration
+       downloads     []whatsmeow.DownloadableMessage
+       phones        []string
+       logouts       int
+       sent          []WhatsAppFakeSend
+       connections   []context.Context

 }
 
 // ConnectContext keeps ctx and tells the test that the daemon connected.
 func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        f.mutex.Lock()
 }
 
 // ConnectContext keeps ctx and tells the test that the daemon connected.
 func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        f.mutex.Lock()

+

        f.connections = append(f.connections, ctx)
        f.connections = append(f.connections, ctx)

+       f.connectTimes = append(f.connectTimes, time.Now())

        f.mutex.Unlock()
 
        f.connects <- struct{}{}
        f.mutex.Unlock()
 
        f.connects <- struct{}{}


@@ -99,6 +107,13 @@ func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 

+       if len(f.connectErrors) > 0 {
+               err := f.connectErrors[0]
+               f.connectErrors = f.connectErrors[1:]
+
+               return err
+       }
+

        return f.connectErr
 }
 
        return f.connectErr
 }
 


@@ -110,12 +125,20 @@ func (f *WhatsAppFake) Connections() []context.Context {
        return slices.Clone(f.connections)
 }
 
        return slices.Clone(f.connections)
 }
 

+// ConnectionTimes returns the time of each connection call, in order.
+func (f *WhatsAppFake) ConnectionTimes() []time.Time {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.connectTimes)
+}
+

 // Disconnect does nothing.
 func (f *WhatsAppFake) Disconnect() {
 }
 
 // GetQRChannel gives a new channel of pairing items to the test.
 // Disconnect does nothing.
 func (f *WhatsAppFake) Disconnect() {
 }
 
 // GetQRChannel gives a new channel of pairing items to the test.

-func (f *WhatsAppFake) GetQRChannel(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) {
+func (f *WhatsAppFake) GetQRChannel(_ context.Context) (<-chan whatsmeow.QRChannelItem, error) {

        items := make(chan whatsmeow.QRChannelItem, 8)
        f.pairings <- items
 
        items := make(chan whatsmeow.QRChannelItem, 8)
        f.pairings <- items
 


@@ -123,7 +146,7 @@ func (f *WhatsAppFake) GetQRChannel(ctx context.Context) (<-chan whatsmeow.QRCha
 }
 
 // PairPhone keeps phone and returns whatsappTestCode.
 }
 
 // PairPhone keeps phone and returns whatsappTestCode.

-func (f *WhatsAppFake) PairPhone(ctx context.Context, phone string, showPushNotification bool, clientType whatsmeow.PairClientType, clientDisplayName string) (string, error) {
+func (f *WhatsAppFake) PairPhone(_ context.Context, phone string, _ bool, _ whatsmeow.PairClientType, _ string) (string, error) {

        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 


@@ -133,7 +156,7 @@ func (f *WhatsAppFake) PairPhone(ctx context.Context, phone string, showPushNoti
 }
 
 // Logout counts the logouts and returns logoutErr.
 }
 
 // Logout counts the logouts and returns logoutErr.

-func (f *WhatsAppFake) Logout(ctx context.Context) error {
+func (f *WhatsAppFake) Logout(_ context.Context) error {

        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 


@@ -143,13 +166,43 @@ func (f *WhatsAppFake) Logout(ctx context.Context) error {
 }
 
 // GetJoinedGroups returns groups.
 }
 
 // GetJoinedGroups returns groups.

-func (f *WhatsAppFake) GetJoinedGroups(ctx context.Context) ([]*types.GroupInfo, error) {
+func (f *WhatsAppFake) GetJoinedGroups(_ context.Context) ([]*types.GroupInfo, error) {

        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        return f.groups, nil
 }
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        return f.groups, nil
 }
 

+// Download waits for downloadWait, records the request, and returns the made-up
+// image or downloadErr. A canceled context ends the wait.
+func (f *WhatsAppFake) Download(ctx context.Context, message whatsmeow.DownloadableMessage) ([]byte, error) {
+       if f.downloadWait > 0 {
+               timer := time.NewTimer(f.downloadWait)
+               defer timer.Stop()
+
+               select {
+               case <-ctx.Done():
+                       return nil, ctx.Err()
+               case <-timer.C:
+               }
+       }
+
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       f.downloads = append(f.downloads, message)
+
+       return slices.Clone(f.downloadData), f.downloadErr
+}
+
+// Downloads returns the media requested from the fake.
+func (f *WhatsAppFake) Downloads() []whatsmeow.DownloadableMessage {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.downloads)
+}
+

 // GenerateMessageID returns a new message ID.
 func (f *WhatsAppFake) GenerateMessageID() types.MessageID {
        f.mutex.Lock()
 // GenerateMessageID returns a new message ID.
 func (f *WhatsAppFake) GenerateMessageID() types.MessageID {
        f.mutex.Lock()


@@ -159,7 +212,7 @@ func (f *WhatsAppFake) GenerateMessageID() types.MessageID {
 }
 
 // SendMessage keeps the send and returns sendErr.
 }
 
 // SendMessage keeps the send and returns sendErr.

-func (f *WhatsAppFake) SendMessage(ctx context.Context, to types.JID, message *waE2E.Message, extra ...whatsmeow.SendRequestExtra) (whatsmeow.SendResponse, error) {
+func (f *WhatsAppFake) SendMessage(_ context.Context, to types.JID, message *waE2E.Message, extra ...whatsmeow.SendRequestExtra) (whatsmeow.SendResponse, error) {

        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 


@@ -205,6 +258,7 @@ func (f *WhatsAppFake) Logouts() int {
 // Emit gives event to the handler of the daemon and returns its answer.
 func (f *WhatsAppFake) Emit(event any) bool {
        f.mutex.Lock()
 // Emit gives event to the handler of the daemon and returns its answer.
 func (f *WhatsAppFake) Emit(event any) bool {
        f.mutex.Lock()

+

        handle := f.handle
        f.mutex.Unlock()
 
        handle := f.handle
        f.mutex.Unlock()
 


@@ -212,7 +266,7 @@ func (f *WhatsAppFake) Emit(event any) bool {
 }
 
 // newClient keeps handle and returns the fake as the client of device.
 }
 
 // newClient keeps handle and returns the fake as the client of device.

-func (f *WhatsAppFake) newClient(device *store.Device, handle func(event any) bool) WhatsAppClient {
+func (f *WhatsAppFake) newClient(_ *store.Device, handle func(event any) bool) WhatsAppClient {

        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 


@@ -229,6 +283,34 @@ type WhatsAppFakeSend struct {
        id   string
 }
 
        id   string
 }
 

+// 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()
+
+       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)
+       }()
+
+       t.Cleanup(func() {
+               cancel()
+               synctest.Wait()
+       })
+}
+

 // whatsappStartTest opens the WhatsApp of the data directory dir with a fake
 // client and the test clock, and closes it at the end of the test. The daemon
 // log goes to the returned buffer.
 // whatsappStartTest opens the WhatsApp of the data directory dir with a fake
 // client and the test clock, and closes it at the end of the test. The daemon
 // log goes to the returned buffer.


@@ -241,7 +323,7 @@ func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, *
        }
 
        logs := &SyncBuffer{}
        }
 
        logs := &SyncBuffer{}

-       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, log.New(logs, "", 0), fake.newClient)
+       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, daemonTestLogger(logs), fake.newClient)

        require.NoError(t, err)
 
        t.Cleanup(func() {
        require.NoError(t, err)
 
        t.Cleanup(func() {


@@ -286,8 +368,8 @@ func whatsappTestSession(t *testing.T, dir string, linked bool) {
 }
 
 // whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read.
 }
 
 // whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read.

-func whatsappDiscardLog() *log.Logger {
-       return log.New(io.Discard, "", 0)
+func whatsappDiscardLog() *slog.Logger {
+       return slog.New(slog.DiscardHandler)

 }
 
 // whatsappTestMessage returns the event of the text message id of sender in
 }
 
 // whatsappTestMessage returns the event of the text message id of sender in


@@ -320,6 +402,7 @@ func whatsappTestLogTexts(t *testing.T, memory *Memory) []string {
        }, 10*time.Second, time.Millisecond)
 
        var texts []string
        }, 10*time.Second, time.Millisecond)
 
        var texts []string

+

        for id := range memory.Len() {
                message, err := memory.Message(id)
                require.NoError(t, err)
        for id := range memory.Len() {
                message, err := memory.Message(id)
                require.NoError(t, err)


@@ -331,14 +414,14 @@ func whatsappTestLogTexts(t *testing.T, memory *Memory) []string {
 }
 
 // whatsappStartTestLinked opens a WhatsApp with a linked device in a temporary
 }
 
 // whatsappStartTestLinked opens a WhatsApp with a linked device in a temporary

-// directory, with a quiet time of 50 ms for its batches.
+// directory.

 func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) {
        t.Helper()
 
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)
 func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) {
        t.Helper()
 
        dir := t.TempDir()
        whatsappTestSession(t, dir, true)

+

        whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
        whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())

-       whatsapp.state.quiet = 50 * time.Millisecond

 
        return whatsapp, fake
 }
 
        return whatsapp, fake
 }


@@ -352,3 +435,36 @@ func whatsappTestConnect(t *testing.T, fake *WhatsAppFake) {
        require.True(t, fake.Emit(&events.Connected{}))
        require.True(t, fake.Emit(&events.OfflineSyncCompleted{}))
 }
        require.True(t, fake.Emit(&events.Connected{}))
        require.True(t, fake.Emit(&events.OfflineSyncCompleted{}))
 }

+
+// 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 whatsappRetryTest(t *testing.T) *WhatsAppRetryTest {
+       t.Helper()
+
+       dir := t.TempDir()
+       whatsappTestSession(t, dir, true)
+
+       whatsapp, fake, logs := whatsappStartTest(t, dir, newTestClock())
+       whatsapp.clock = time.Now
+       loop, events := newTestIdleTurnLoop(t, whatsapp)
+
+       return &WhatsAppRetryTest{
+               whatsapp: whatsapp,
+               fake:     fake,
+               logs:     logs,
+               loop:     loop,
+               events:   events,
+       }
+}