]> git.giacomolli.uk - onechat/blobdiff - whatsapp_fake_helper_test.go
Separate multiline Go statements
[onechat] / whatsapp_fake_helper_test.go
index d8bb9bb310a4d15ce31fa45e07026408f6ff0d6a..24789a72c22ecbd6de799842a6a9df4bb835bbe3 100644 (file)
@@ -3,12 +3,12 @@ package main
 import (
        "context"
        "fmt"
-       "log/slog"
        "os"
        "path/filepath"
        "slices"
        "sync"
        "testing"
+       "testing/synctest"
        "time"
 
        "github.com/stretchr/testify/require"
@@ -83,12 +83,39 @@ type WhatsAppFake struct {
        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
 }
 
+// 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()
@@ -168,6 +195,76 @@ func (f *WhatsAppFake) GetJoinedGroups(_ context.Context) ([]*types.GroupInfo, e
        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()
@@ -181,6 +278,10 @@ func (f *WhatsAppFake) SendMessage(_ context.Context, to types.JID, message *waE
        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(),
@@ -240,12 +341,20 @@ func (f *WhatsAppFake) newClient(_ *store.Device, handle func(event any) bool) W
        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
+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
@@ -304,11 +413,6 @@ func whatsappTestSession(t *testing.T, dir string, linked bool) {
        require.NoError(t, container.Close())
 }
 
-// whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read.
-func whatsappDiscardLog() *slog.Logger {
-       return slog.New(slog.DiscardHandler)
-}
-
 // whatsappTestMessage returns the event of the text message id of sender in
 // chat at the time at. A sender with whatsappTestNumber is the user.
 func whatsappTestMessage(chat, sender types.JID, id, text string, at time.Time) *events.Message {
@@ -351,7 +455,7 @@ func whatsappTestLogTexts(t *testing.T, memory *Memory) []string {
 }
 
 // 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()
 
@@ -359,7 +463,6 @@ func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) {
        whatsappTestSession(t, dir, true)
 
        whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock())
-       whatsapp.state.quiet = 50 * time.Millisecond
 
        return whatsapp, fake
 }
@@ -387,3 +490,22 @@ func whatsappTestContacts(t *testing.T, whatsapp *WhatsApp) {
        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,
+       }
+}