Check the complete message before committing

[onechat] / whatsapp_fake_helper_test.go

diff --git a/whatsapp_fake_helper_test.go b/whatsapp_fake_helper_test.go
index 8e1da1378ed81fe97f9dcab917f13843bb29dba9..1fca3b00c22875f909b15823cfa3a7388ecf4448 100644 (file)
--- a/whatsapp_fake_helper_test.go
+++ b/whatsapp_fake_helper_test.go
@@ -3,13 +3,12 @@ package main
 import (
        "context"
        "fmt"
 import (
        "context"
        "fmt"

-       "io"
-       "log"

        "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"


@@ -84,15 +83,43 @@ type WhatsAppFake struct {
        logoutErr     error
        groups        []*types.GroupInfo
        sendErr       error
        logoutErr     error
        groups        []*types.GroupInfo
        sendErr       error

+       uploadErr     error
+       uploads       [][]byte
+       imageSends    []*waE2E.ImageMessage
+       downloadData  []byte
+       downloadErr   error
+       downloadWait  time.Duration
+       downloads     []whatsmeow.DownloadableMessage

        phones        []string
        logouts       int
        sent          []WhatsAppFakeSend
        connections   []context.Context
 }
 
        phones        []string
        logouts       int
        sent          []WhatsAppFakeSend
        connections   []context.Context
 }
 

+// WhatsAppFakeSend is one send of the fake: the chat, the text, and the message
+// ID.
+type WhatsAppFakeSend struct {
+       to   string
+       text 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
+}
+

 // 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.connectTimes = append(f.connectTimes, time.Now())
        f.mutex.Unlock()
        f.connections = append(f.connections, ctx)
        f.connectTimes = append(f.connectTimes, time.Now())
        f.mutex.Unlock()


@@ -105,6 +132,7 @@ func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        if len(f.connectErrors) > 0 {
                err := f.connectErrors[0]
                f.connectErrors = f.connectErrors[1:]
        if len(f.connectErrors) > 0 {
                err := f.connectErrors[0]
                f.connectErrors = f.connectErrors[1:]

+

                return err
        }
 
                return err
        }
 


@@ -167,6 +195,76 @@ func (f *WhatsAppFake) GetJoinedGroups(_ context.Context) ([]*types.GroupInfo, e
        return f.groups, nil
 }
 
        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)
+}
+
+// Upload records the pixels and returns made-up media metadata.
+func (f *WhatsAppFake) Upload(_ context.Context, data []byte, mediaType whatsmeow.MediaType) (whatsmeow.UploadResponse, error) {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       if mediaType != whatsmeow.MediaImage {
+               return whatsmeow.UploadResponse{}, fmt.Errorf("unexpected media type %q", mediaType)
+       }
+
+       f.uploads = append(f.uploads, slices.Clone(data))
+       if f.uploadErr != nil {
+               return whatsmeow.UploadResponse{}, f.uploadErr
+       }
+
+       return whatsmeow.UploadResponse{
+               URL:           "https://example.com/image",
+               DirectPath:    "/image",
+               MediaKey:      []byte("made-up key"),
+               FileSHA256:    []byte("made-up hash"),
+               FileEncSHA256: []byte("made-up encrypted hash"),
+               FileLength:    uint64(len(data)),
+       }, nil
+}
+
+// Uploads returns the pixels passed to Upload.
+func (f *WhatsAppFake) Uploads() [][]byte {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.uploads)
+}
+
+// ImageSends returns the outgoing image messages.
+func (f *WhatsAppFake) ImageSends() []*waE2E.ImageMessage {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.imageSends)
+}
+

 // 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()


@@ -180,6 +278,10 @@ func (f *WhatsAppFake) SendMessage(_ context.Context, to types.JID, message *waE
        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 

+       if message.GetImageMessage() != nil {
+               f.imageSends = append(f.imageSends, message.GetImageMessage())
+       }
+

        f.sent = append(f.sent, WhatsAppFakeSend{
                to:   to.String(),
                text: message.GetConversation(),
        f.sent = append(f.sent, WhatsAppFakeSend{
                to:   to.String(),
                text: message.GetConversation(),


@@ -222,6 +324,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()
 


@@ -238,73 +341,20 @@ func (f *WhatsAppFake) newClient(_ *store.Device, handle func(event any) bool) W
        return f
 }
 
        return f
 }
 

-// WhatsAppFakeSend is one send of the fake: the chat, the text, and the message
-// ID.
-type WhatsAppFakeSend struct {
-       to   string
-       text string
-       id   string
-}
-
-// 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.
-func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, *WhatsAppFake, *SyncBuffer) {
+func (r *WhatsAppRetryTest) start(t *testing.T) {

        t.Helper()
 
        t.Helper()
 

-       fake := &WhatsAppFake{
-               connects: make(chan struct{}, 16),
-               pairings: make(chan chan whatsmeow.QRChannelItem, 16),
-       }
-
-       logs := &SyncBuffer{}
-       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, log.New(logs, "", 0), fake.newClient)
-       require.NoError(t, err)
+       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() {
 
        t.Cleanup(func() {

-               require.NoError(t, whatsapp.Close())
+               cancel()
+               synctest.Wait()

        })
        })

-
-       return whatsapp, fake, logs
-}
-
-// whatsappTestSession writes a session database with mode 0600 to the data
-// directory dir. When linked is true, it holds a device linked to
-// whatsappTestNumber and whatsappTestLID, and else no device.
-func whatsappTestSession(t *testing.T, dir string, linked bool) {
-       t.Helper()
-
-       path := filepath.Join(dir, whatsappDirName, whatsappSessionFileName)
-       require.NoError(t, os.MkdirAll(filepath.Dir(path), 0o700))
-       require.NoError(t, os.WriteFile(path, nil, 0o600))
-
-       address, err := whatsappSessionAddress(path)
-       require.NoError(t, err)
-
-       container, err := sqlstore.New(t.Context(), "sqlite", address, waLog.Noop)
-       require.NoError(t, err)
-
-       if linked {
-               device := container.NewDevice()
-               jid := types.NewADJID(whatsappTestNumber, 0, 1)
-               device.ID = &jid
-               device.LID = types.NewADJID(whatsappTestLID, 0, 1)
-               device.LID.Server = types.HiddenUserServer
-               device.Account = &waAdv.ADVSignedDeviceIdentity{
-                       Details:             []byte{},
-                       AccountSignature:    make([]byte, 64),
-                       AccountSignatureKey: make([]byte, 32),
-                       DeviceSignature:     make([]byte, 64),
-               }
-               require.NoError(t, device.Save(t.Context()))
-       }
-
-       require.NoError(t, container.Close())
-}
-
-// whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read.
-func whatsappDiscardLog() *log.Logger {
-       return log.New(io.Discard, "", 0)

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


@@ -337,6 +387,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)


@@ -348,18 +399,74 @@ 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
 }
 

+// whatsappTestSession writes a session database with mode 0600 to the data
+// directory dir. When linked is true, it holds a device linked to
+// whatsappTestNumber and whatsappTestLID, and else no device.
+func whatsappTestSession(t *testing.T, dir string, linked bool) {
+       t.Helper()
+
+       path := filepath.Join(dir, whatsappDirName, whatsappSessionFileName)
+       require.NoError(t, os.MkdirAll(filepath.Dir(path), 0o700))
+       require.NoError(t, os.WriteFile(path, nil, 0o600))
+
+       address, err := whatsappSessionAddress(path)
+       require.NoError(t, err)
+
+       container, err := sqlstore.New(t.Context(), "sqlite", address, waLog.Noop)
+       require.NoError(t, err)
+
+       if linked {
+               device := container.NewDevice()
+               jid := types.NewADJID(whatsappTestNumber, 0, 1)
+               device.ID = &jid
+               device.LID = types.NewADJID(whatsappTestLID, 0, 1)
+               device.LID.Server = types.HiddenUserServer
+               device.Account = &waAdv.ADVSignedDeviceIdentity{
+                       Details:             []byte{},
+                       AccountSignature:    make([]byte, 64),
+                       AccountSignatureKey: make([]byte, 32),
+                       DeviceSignature:     make([]byte, 64),
+               }
+               require.NoError(t, device.Save(t.Context()))
+       }
+
+       require.NoError(t, container.Close())
+}
+
+// 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.
+func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, *WhatsAppFake, *SyncBuffer) {
+       t.Helper()
+
+       fake := &WhatsAppFake{
+               connects: make(chan struct{}, 16),
+               pairings: make(chan chan whatsmeow.QRChannelItem, 16),
+       }
+
+       logs := &SyncBuffer{}
+       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, daemonTestLogger(logs), fake.newClient)
+       require.NoError(t, err)
+
+       t.Cleanup(func() {
+               require.NoError(t, whatsapp.Close())
+       })
+
+       return whatsapp, fake, logs
+}
+

 // 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) {
 // 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) {


@@ -378,7 +485,27 @@ func whatsappTestContacts(t *testing.T, whatsapp *WhatsApp) {
        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"))
        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"))
 }
        _, _, 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,
+       }
+}