Name timeouts for the operations they limit

[onechat] / whatsapp_state.go

diff --git a/whatsapp_state.go b/whatsapp_state.go
index b8929f008983bea3d71ade8b3fc30b59bce02a92..b1b5935c7536833728bea6a06230998b1ae605af 100644 (file)
--- a/whatsapp_state.go
+++ b/whatsapp_state.go
@@ -16,12 +16,12 @@ const (
        // the batches that are not in the log yet and the records of the sends.
        whatsappStateFileName = "state.json"
 
-       // whatsappBatchQuiet is how long a chat is quiet before its batch
+       // whatsappBatchIdleTimeout is how long a chat is quiet before its batch
        // closes.
-       whatsappBatchQuiet = 20 * time.Second
+       whatsappBatchIdleTimeout = 20 * time.Second
 
-       // whatsappBatchWindow is the longest time of a batch.
-       whatsappBatchWindow = 2 * time.Minute
+       // whatsappBatchTimeout is the longest time of a batch.
+       whatsappBatchTimeout = 2 * time.Minute
 
        // whatsappBatchMessages is the most messages of a batch.
        whatsappBatchMessages = 50
@@ -32,13 +32,12 @@ const (
 )
 
 // openWhatsAppState reads the batches and the send records of the state file at
-// path. A missing file holds none. A batch closes after quiet with no message,
-// or after window at the latest.
-func openWhatsAppState(path string, quiet, window time.Duration) (*WhatsAppState, error) {
+// path. A missing file holds none. A batch closes after
+// whatsappBatchIdleTimeout with no message, or after whatsappBatchTimeout at
+// the latest.
+func openWhatsAppState(path string) (*WhatsAppState, error) {
        s := &WhatsAppState{
-               path:   path,
-               quiet:  quiet,
-               window: window,
+               path: path,
        }
 
        data, err := os.ReadFile(path)
@@ -61,11 +60,13 @@ func openWhatsAppState(path string, quiet, window time.Duration) (*WhatsAppState
 // WhatsAppState holds the state file: the send records, and the batches of the
 // WhatsApp messages that are not in the log yet, open and closed, in the order
 // of their first message. The messages of one chat form one batch while the
-// times of the messages are at most quiet apart, at most window after the
-// first, and the batch has fewer than whatsappBatchMessages messages. The times
-// are the WhatsApp times, so a catch-up after a stop gives the same batches as
-// live messages. A batch also closes when quiet passes after the arrival of its
-// last message, or window after the arrival of its first message, in real time.
+// times of the messages are at most whatsappBatchIdleTimeout apart, at most
+// whatsappBatchTimeout after the first, and the batch has fewer than
+// whatsappBatchMessages messages. The times are the WhatsApp times, so a
+// catch-up after a stop gives the same batches as live messages. A batch also
+// closes when whatsappBatchIdleTimeout passes after the arrival of its last
+// message, or whatsappBatchTimeout after the arrival of its first message, in
+// real time.
 //
 // A send record keeps the result of a send by its ID, so that a repeated call
 // of the send tool does not send again. The state file keeps the last
@@ -76,9 +77,7 @@ func openWhatsAppState(path string, quiet, window time.Duration) (*WhatsAppState
 // library adds messages while Run closes and removes batches, and the turns
 // send.
 type WhatsAppState struct {
-       path   string
-       quiet  time.Duration
-       window time.Duration
+       path string
 
        mutex sync.Mutex
        file  WhatsAppStateFile
@@ -102,7 +101,7 @@ func (s *WhatsAppState) Add(chat WhatsAppChat, message WhatsAppMessage, arrival
                        return false, nil
                }
 
-               if message.Time.Sub(batch.Messages[len(batch.Messages)-1].Time) > s.quiet || message.Time.Sub(batch.Messages[0].Time) > s.window {
+               if message.Time.Sub(batch.Messages[len(batch.Messages)-1].Time) > whatsappBatchIdleTimeout || message.Time.Sub(batch.Messages[0].Time) > whatsappBatchTimeout {
                        batch.Closed = true
                        closed = true
                        index = -1
@@ -170,6 +169,7 @@ func (s *WhatsAppState) Closed() []WhatsAppBatch {
        defer s.mutex.Unlock()
 
        var closed []WhatsAppBatch
+
        for _, batch := range s.file.Batches {
                if batch.Closed {
                        closed = append(closed, batch)
@@ -198,6 +198,7 @@ func (s *WhatsAppState) Wait(now time.Time) (time.Duration, bool) {
        defer s.mutex.Unlock()
 
        var first time.Time
+
        for _, batch := range s.file.Batches {
                deadline := s.deadline(batch)
                if !batch.Closed && (first.IsZero() || deadline.Before(first)) {
@@ -259,8 +260,8 @@ func (s *WhatsAppState) open(chat string) int {
 
 // deadline returns when batch closes in real time.
 func (s *WhatsAppState) deadline(batch WhatsAppBatch) time.Time {
-       quiet := batch.Last.Add(s.quiet)
-       window := batch.First.Add(s.window)
+       quiet := batch.Last.Add(whatsappBatchIdleTimeout)
+       window := batch.First.Add(whatsappBatchTimeout)
        if window.Before(quiet) {
                return window
        }