// 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
own []string
notify func(Event)
connected bool
+ retrying bool
connectedAt time.Time
disconnectedAt time.Time
disconnections int
// 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, pair command, 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
+ w.retrying = linked
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
w.close()
}()
+ if linked {
+ connect()
+ }
+
for {
err := w.inbox.deliver(ctx, l, w.link(), false)
if err != nil {
return err
case <-w.inbox.wake:
case <-w.inbox.due():
+ case <-retry:
+ connect()
case <-w.logouts:
+ stopRetry()
err = w.loggedOut(ctx, l)
if err != nil {
return err
}
case request := <-w.requests:
+ stopRetry()
cancel()
pairing.Wait()
cancel = func() {}
}
}
-// 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.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)
- if err != nil {
- w.logger.Printf("connect failed, restart to retry: %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.
client := w.client
w.client = nil
w.linked = false
+ w.retrying = false
w.own = nil
w.connected = false
w.disconnectedAt = time.Time{}
// 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
-// between them log nothing.
+// 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:
}
w.connected = true
+ w.retrying = false
w.connectedAt = w.clock()
if w.timer != nil {
w.timer.Stop()
notice = "WhatsApp is connected again."
}
case *events.Disconnected:
- if w.linked && (w.connected || w.disconnectedAt.IsZero()) {
+ connected := w.connected
+ if w.startOutage() {
line = "disconnected, retrying"
- if !w.connected {
+ if !connected {
line = "first connect failed, retrying"
}
-
- w.disconnectedAt = w.clock()
- w.disconnections++
- disconnections := w.disconnections
- w.timer = time.AfterFunc(w.noticeDelay, func() {
- w.disconnectedLong(disconnections)
- })
}
-
- w.connected = false
case *events.LoggedOut:
+ w.retrying = false
select {
case w.logouts <- struct{}{}:
default:
}
case events.PermanentDisconnect:
+ w.retrying = false
if w.linked {
w.connected = false
w.noticed = true
}
// 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.
+// 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 {
client := whatsmeow.NewClient(device, waLog.Noop)
- client.InitialAutoReconnect = true
+ client.InitialAutoReconnect = device.ID == nil
client.SynchronousAck = true
client.ManualHistorySyncDownload = true
client.AddEventHandlerWithSuccessStatus(handle)
projects / onechat / blobdiff