Separate returns from longer statement blocks

[onechat] / whatsapp.go

diff --git a/whatsapp.go b/whatsapp.go
index b883496aea73266c0ce87889c9e1d9895b25335a..b0767084a6cb614af20f8dde1da27927f459aa50 100644 (file)
--- a/whatsapp.go
+++ b/whatsapp.go
@@ -14,6 +14,7 @@ import (
        "time"
 
        "go.mau.fi/whatsmeow"
        "time"
 
        "go.mau.fi/whatsmeow"

+       "go.mau.fi/whatsmeow/proto/waCompanionReg"

        "go.mau.fi/whatsmeow/proto/waE2E"
        "go.mau.fi/whatsmeow/store"
        "go.mau.fi/whatsmeow/store/sqlstore"
        "go.mau.fi/whatsmeow/proto/waE2E"
        "go.mau.fi/whatsmeow/store"
        "go.mau.fi/whatsmeow/store/sqlstore"


@@ -64,6 +65,13 @@ const (
        // gets a notice.
        whatsappNoticeDelay = 10 * time.Minute
 
        // gets a notice.
        whatsappNoticeDelay = 10 * time.Minute
 

+       // whatsappRetryDelay is the first wait after a failed starting
+       // connection.
+       whatsappRetryDelay = 2 * time.Second
+
+       // whatsappRetryLimit is the longest wait between starting connections.
+       whatsappRetryLimit = 5 * time.Minute
+

        // whatsappRequests is the number of pair and unlink commands that can
        // wait for Run.
        whatsappRequests = 8
        // whatsappRequests is the number of pair and unlink commands that can
        // wait for Run.
        whatsappRequests = 8


@@ -186,6 +194,7 @@ type WhatsApp struct {
        own            []string
        notify         func(Event)
        connected      bool
        own            []string
        notify         func(Event)
        connected      bool

+       retrying       bool

        connectedAt    time.Time
        disconnectedAt time.Time
        disconnections int
        connectedAt    time.Time
        disconnectedAt time.Time
        disconnections int


@@ -197,18 +206,41 @@ type WhatsApp struct {
 // Run connects a linked device, logs the closed batches in l, runs the pair and
 // unlink commands, and handles a logout from the phone, until ctx ends. Its
 // notes go to the log of l, and notify gets the notices for all clients. A
 // Run connects a linked device, logs the closed batches in l, runs the pair and
 // unlink commands, and handles a logout from the phone, until ctx ends. Its
 // notes go to the log of l, and notify gets the notices for all clients. A

-// failed first connection is logged, and the library tries again when the
-// failure is one of the network. Run returns the error of a write of the log or
-// of the state file, which stops the daemon, because then messages would be
-// lost.
+// failed first connection starts the same outage notice as a lost connection. A
+// timer in the select retries it with a doubled wait from 2 seconds to 5
+// minutes, without a retry goroutine or a wait that blocks commands or the
+// inbox. A connection, unlink, logout, or ctx end stops retries. The library
+// owns retries after a connection opens. Run returns the error of a write of
+// the log or of the state file, which stops the daemon, because then messages
+// would be lost.

 func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) error {
        w.mutex.Lock()
        w.notify = notify
        linked := w.linked
 func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) error {
        w.mutex.Lock()
        w.notify = notify
        linked := w.linked

+       w.retrying = linked

        w.mutex.Unlock()
 
        w.mutex.Unlock()
 

-       if linked {
-               w.connect(ctx)
+       timer := time.NewTimer(whatsappRetryDelay)
+       timer.Stop()
+       defer timer.Stop()
+
+       var retry <-chan time.Time
+       delay := whatsappRetryDelay
+       connect := func() {
+               retry = nil
+               if w.connect(ctx) {
+                       timer.Reset(delay)
+                       retry = timer.C
+                       delay = min(2*delay, whatsappRetryLimit)
+               }
+       }
+
+       stopRetry := func() {
+               timer.Stop()
+               retry = nil
+               w.mutex.Lock()
+               w.retrying = false
+               w.mutex.Unlock()

        }
 
        var pairing sync.WaitGroup
        }
 
        var pairing sync.WaitGroup


@@ -219,6 +251,10 @@ func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) err
                w.close()
        }()
 
                w.close()
        }()
 

+       if linked {
+               connect()
+       }
+

        for {
                err := w.inbox.deliver(ctx, l, w.link(), false)
                if err != nil {
        for {
                err := w.inbox.deliver(ctx, l, w.link(), false)
                if err != nil {


@@ -232,7 +268,10 @@ func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) err
                        return err
                case <-w.inbox.wake:
                case <-w.inbox.due():
                        return err
                case <-w.inbox.wake:
                case <-w.inbox.due():

+               case <-retry:
+                       connect()

                case <-w.logouts:
                case <-w.logouts:

+                       stopRetry()

                        err = w.loggedOut(ctx, l)
                        if err != nil {
                                return err
                        err = w.loggedOut(ctx, l)
                        if err != nil {
                                return err


@@ -244,6 +283,7 @@ func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) err
 
                        switch {
                        case request.unlink:
 
                        switch {
                        case request.unlink:

+                               stopRetry()

                                err = w.unlink(ctx, l, request.answer)
                                if err != nil {
                                        return err
                                err = w.unlink(ctx, l, request.answer)
                                if err != nil {
                                        return err


@@ -395,17 +435,60 @@ func (w *WhatsApp) link() WhatsAppLink {
        }
 }
 
        }
 }
 

-// connect makes the client of the linked device and connects it.
-func (w *WhatsApp) connect(ctx context.Context) {
+// connect tries the starting connection of the linked device with one client.
+// It returns whether Run must retry. A failed call starts the shared outage
+// state and logs its redacted cause once, because a returned ConnectContext
+// error does not emit Disconnected. Connected logs recovery after
+// authentication.
+func (w *WhatsApp) connect(ctx context.Context) bool {

        w.mutex.Lock()
        w.mutex.Lock()

-       w.client = w.newClient(w.device, w.handle)
+       if ctx.Err() != nil || !w.linked || !w.retrying || w.closed {
+               w.mutex.Unlock()
+               return false
+       }
+
+       if w.client == nil {
+               w.client = w.newClient(w.device, w.handle)
+       }
+

        client := w.client
        w.mutex.Unlock()
 
        err := client.ConnectContext(ctx)
        client := w.client
        w.mutex.Unlock()
 
        err := client.ConnectContext(ctx)

-       if err != nil {
-               w.logger.Printf("connect: %s", w.redact(err.Error()))
+       w.mutex.Lock()
+       if err == nil || ctx.Err() != nil || !w.retrying || !w.linked {
+               w.retrying = false
+               w.mutex.Unlock()
+
+               return false
+       }
+
+       first := w.startOutage()
+       cause := whatsappRedact(w.own, err.Error())
+       w.mutex.Unlock()
+       if first {
+               w.logger.Printf("first connect failed, retrying: %s", cause)
+       }
+
+       return true
+}
+
+// startOutage starts the shared outage time and notice timer once. The caller
+// holds the mutex. Its result tells whether this is the first failure.
+func (w *WhatsApp) startOutage() bool {
+       first := w.linked && (w.connected || w.disconnectedAt.IsZero())
+       if first {
+               w.disconnectedAt = w.clock()
+               w.disconnections++
+               disconnections := w.disconnections
+               w.timer = time.AfterFunc(w.noticeDelay, func() {
+                       w.disconnectedLong(disconnections)
+               })

        }
        }

+
+       w.connected = false
+
+       return first

 }
 
 // close ends the connection and the timer of the notice, and stops all notices.
 }
 
 // close ends the connection and the timer of the notice, and stops all notices.


@@ -434,6 +517,7 @@ func (w *WhatsApp) loggedOut(ctx context.Context, l *TurnLoop) error {
                return nil
        }
 
                return nil
        }
 

+       w.logger.Print("logged out by the phone, run /whatsapp pair PHONE")

        err := w.inbox.deliver(ctx, l, w.link(), true)
        if err != nil {
                return err
        err := w.inbox.deliver(ctx, l, w.link(), true)
        if err != nil {
                return err


@@ -441,12 +525,12 @@ func (w *WhatsApp) loggedOut(ctx context.Context, l *TurnLoop) error {
 
        err = w.removeSession()
        if err != nil {
 
        err = w.removeSession()
        if err != nil {

-               w.logger.Printf("delete the session after the logout: %v", err)
+               w.logger.Printf("session delete failed: %v", err)

        }
 
        err = l.note("WhatsApp was unlinked from the phone.")
        if err != nil {
        }
 
        err = l.note("WhatsApp was unlinked from the phone.")
        if err != nil {

-               w.logger.Printf("note the logout: %v", err)
+               w.logger.Printf("chat note failed: %v", err)

        }
 
        w.broadcast("WhatsApp was unlinked from the phone. Run /whatsapp pair PHONE to link it again.")
        }
 
        w.broadcast("WhatsApp was unlinked from the phone. Run /whatsapp pair PHONE to link it again.")


@@ -489,9 +573,10 @@ func (w *WhatsApp) unlink(ctx context.Context, l *TurnLoop, answer func(text str
                return nil
        }
 
                return nil
        }
 

+       w.logger.Print("unlinked")

        err = l.note("WhatsApp is unlinked.")
        if err != nil {
        err = l.note("WhatsApp is unlinked.")
        if err != nil {

-               w.logger.Printf("note the unlink: %v", err)
+               w.logger.Printf("chat note failed: %v", err)

        }
 
        if client == nil || logoutErr != nil {
        }
 
        if client == nil || logoutErr != nil {


@@ -511,8 +596,10 @@ func (w *WhatsApp) removeSession() error {
        client := w.client
        w.client = nil
        w.linked = false
        client := w.client
        w.client = nil
        w.linked = false

+       w.retrying = false

        w.own = nil
        w.connected = false
        w.own = nil
        w.connected = false

+       w.disconnectedAt = time.Time{}

        if w.timer != nil {
                w.timer.Stop()
        }
        if w.timer != nil {
                w.timer.Stop()
        }


@@ -594,6 +681,8 @@ func (w *WhatsApp) pair(ctx, runCtx context.Context, l *TurnLoop, phone string,
                return
        }
 
                return
        }
 

+       // The server accepts only a display name of the form "Browser (OS)"
+       // with a common browser and OS, and refuses the pairing otherwise.

        code, err := client.PairPhone(ctx, phone, true, whatsmeow.PairClientChrome, "Chrome (Linux)")
        if err != nil {
                answer("WhatsApp refused the pairing: " + err.Error() + ". Check the phone number and run /whatsapp pair PHONE again.")
        code, err := client.PairPhone(ctx, phone, true, whatsmeow.PairClientChrome, "Chrome (Linux)")
        if err != nil {
                answer("WhatsApp refused the pairing: " + err.Error() + ". Check the phone number and run /whatsapp pair PHONE again.")


@@ -625,10 +714,11 @@ func (w *WhatsApp) pair(ctx, runCtx context.Context, l *TurnLoop, phone string,
                case item.Event == whatsmeow.QRChannelSuccess.Event:
                        linked = true
                        w.linkedBy(client)
                case item.Event == whatsmeow.QRChannelSuccess.Event:
                        linked = true
                        w.linkedBy(client)

+                       w.logger.Print("linked")

 
                        err = l.note("WhatsApp is linked.")
                        if err != nil {
 
                        err = l.note("WhatsApp is linked.")
                        if err != nil {

-                               w.logger.Printf("note the link: %v", err)
+                               w.logger.Printf("chat note failed: %v", err)

                        }
 
                        answer("WhatsApp is linked to +" + phone + ".")
                        }
 
                        answer("WhatsApp is linked to +" + phone + ".")


@@ -688,9 +778,14 @@ func (w *WhatsApp) linkedBy(client WhatsAppClient) {
 // goes to the inbox. The names of the groups follow the events of the groups. A
 // connection starts a catch-up of the inbox, which ends at OfflineSyncCompleted
 // or after its catchupLimit. A disconnection keeps the time of its start while
 // goes to the inbox. The names of the groups follow the events of the groups. A
 // connection starts a catch-up of the inbox, which ends at OfflineSyncCompleted
 // or after its catchupLimit. A disconnection keeps the time of its start while

-// the library tries again. After noticeDelay of a disconnection, all clients
-// get one notice, and they get one more when the connection comes back. A
-// disconnection that the library does not try again gives a notice at once.
+// Run or the library tries again. After noticeDelay of a disconnection, all
+// clients get one notice, and they get one more when the connection comes back.
+// A disconnection that the library does not try again gives a notice at once.
+//
+// The log of the daemon gets one line for each change of the connection of the
+// linked device: connected, a failed first connection, a lost connection, and
+// connected again with the length of the outage. The retries of the library and
+// Run between them log nothing.

 func (w *WhatsApp) handle(event any) bool {
        switch event := event.(type) {
        case *events.Message:
 func (w *WhatsApp) handle(event any) bool {
        switch event := event.(type) {
        case *events.Message:


@@ -711,13 +806,22 @@ func (w *WhatsApp) handle(event any) bool {
                w.inbox.startCatchup()
        }
 
                w.inbox.startCatchup()
        }
 

-       var notice string
+       var notice, line string

        w.mutex.Lock()
        switch event := event.(type) {
        case *events.PairSuccess:
                w.own = whatsappOwnIDs(event.ID.User, event.LID.User)
        case *events.Connected:
        w.mutex.Lock()
        switch event := event.(type) {
        case *events.PairSuccess:
                w.own = whatsappOwnIDs(event.ID.User, event.LID.User)
        case *events.Connected:

+               switch {
+               case !w.linked || w.connected:
+               case w.disconnectedAt.IsZero():
+                       line = "connected"
+               default:
+                       line = "connected again after " + durationText(w.clock().Sub(w.disconnectedAt))
+               }
+

                w.connected = true
                w.connected = true

+               w.retrying = false

                w.connectedAt = w.clock()
                if w.timer != nil {
                        w.timer.Stop()
                w.connectedAt = w.clock()
                if w.timer != nil {
                        w.timer.Stop()


@@ -728,30 +832,39 @@ func (w *WhatsApp) handle(event any) bool {
                        notice = "WhatsApp is connected again."
                }
        case *events.Disconnected:
                        notice = "WhatsApp is connected again."
                }
        case *events.Disconnected:

-               if w.linked && (w.connected || w.disconnectedAt.IsZero()) {
-                       w.disconnectedAt = w.clock()
-                       w.disconnections++
-                       disconnections := w.disconnections
-                       w.timer = time.AfterFunc(w.noticeDelay, func() {
-                               w.disconnectedLong(disconnections)
-                       })
+               connected := w.connected
+               if w.startOutage() {
+                       line = "disconnected, retrying"
+                       if !connected {
+                               line = "first connect failed, retrying"
+                       }

                }
                }

-
-               w.connected = false

        case *events.LoggedOut:
        case *events.LoggedOut:

+               w.retrying = false

                select {
                case w.logouts <- struct{}{}:
                default:
                }
        case events.PermanentDisconnect:
                select {
                case w.logouts <- struct{}{}:
                default:
                }
        case events.PermanentDisconnect:

+               w.retrying = false

                if w.linked {
                        w.connected = false
                        w.noticed = true
                        notice = "WhatsApp is disconnected and does not connect again by itself: " + event.PermanentDisconnectDescription() + ". Restart the daemon to try again."
                if w.linked {
                        w.connected = false
                        w.noticed = true
                        notice = "WhatsApp is disconnected and does not connect again by itself: " + event.PermanentDisconnectDescription() + ". Restart the daemon to try again."

+                       line = "disconnected for good, restart to retry: " + whatsappRedact(w.own, event.PermanentDisconnectDescription())

                }
        }
                }
        }

+
+       if w.closed {
+               line = ""
+       }
+

        w.mutex.Unlock()
 
        w.mutex.Unlock()
 

+       if line != "" {
+               w.logger.Print(line)
+       }
+

        if notice != "" {
                w.broadcast(notice)
        }
        if notice != "" {
                w.broadcast(notice)
        }


@@ -817,14 +930,23 @@ type WhatsAppRequest struct {
        answer func(text string)
 }
 
        answer func(text string)
 }
 

+// whatsappSetDeviceProps sets the device properties that the library sends at
+// the pairing. They are global values of the library, so the daemon sets them
+// once before any client exists. The phone shows the linked device with the
+// name OneChat and a desktop icon only when the platform type is known.
+func whatsappSetDeviceProps() {
+       store.SetOSInfo("OneChat", [3]uint32{0, 1, 0})
+       store.DeviceProps.PlatformType = waCompanionReg.DeviceProps_DESKTOP.Enum()
+}
+

 // whatsappNewClient returns the client of the library for device, with handle
 // whatsappNewClient returns the client of the library for device, with handle

-// as its event handler. The client tries again after a failed first connection,
-// acknowledges a message only after handle returns true, and downloads no old
-// history. The phone shows the device with the name OneChat.
+// as its event handler. Run owns failed starting connections of linked devices,
+// so only an unlinked device enables the initial retry of the library for
+// pairing. The library still retries a lost connection. The client acknowledges
+// a message only after handle returns true, and downloads no old history.

 func whatsappNewClient(device *store.Device, handle func(event any) bool) WhatsAppClient {
 func whatsappNewClient(device *store.Device, handle func(event any) bool) WhatsAppClient {

-       store.SetOSInfo("OneChat", [3]uint32{0, 1, 0})

        client := whatsmeow.NewClient(device, waLog.Noop)
        client := whatsmeow.NewClient(device, waLog.Noop)

-       client.InitialAutoReconnect = true
+       client.InitialAutoReconnect = device.ID == nil

        client.SynchronousAck = true
        client.ManualHistorySyncDownload = true
        client.AddEventHandlerWithSuccessStatus(handle)
        client.SynchronousAck = true
        client.ManualHistorySyncDownload = true
        client.AddEventHandlerWithSuccessStatus(handle)