Changeset 428 in code for trunk/upstream.go

Timestamp:

Nov 24, 2020, 1:13:24 PM (5 years ago)

Author:

contact

Message:

Implement delivery receipts via PING messages

This patch implements basic message delivery receipts via PING and PONG.

When a PRIVMSG or NOTICE message is sent, a PING message with a token is
also sent. The history cursor isn't immediately advanced, instead the
bouncer will wait for a PONG message before doing so.

Self-messages trigger a PING for simplicity's sake. We can't immediately
advance the history cursor in this case, because a prior message might
still have an outstanding PING.

Future work may include optimizations such as removing the need to send
a PING after a self-message, or groupping multiple PING messages
together.

Closes: ​https://todo.sr.ht/~emersion/soju/11

File:

• trunk/upstream.go (modified) (5 diffs)

trunk/upstream.go

@@ -1608 +1608 @@
 }
 
-func (uc *upstreamConn) appendLog(entity string, msg *irc.Message) {
+// appendLog appends a message to the log file.
+//
+// The internal message ID is returned. If the message isn't recorded in the
+// log file, an empty string is returned.
+func (uc *upstreamConn) appendLog(entity string, msg *irc.Message) (msgID string) {
         if uc.user.msgStore == nil {
-                return
+                return ""
         }
 
@@ -1623 +1627 @@
                 if err != nil {
                         uc.logger.Printf("failed to log message: failed to get last message ID: %v", err)
-                        return
+                        return ""
                 }
 
@@ -1647 +1651 @@
         if err != nil {
                 uc.logger.Printf("failed to log message: %v", err)
-                return
-        }
-
-        if !detached && msgID != "" {
-                uc.forEachDownstream(func(dc *downstreamConn) {
-                        history.clients[dc.clientName] = msgID
-                })
-        }
+                return ""
+        }
+
+        return msgID
 }
 
@@ -1663 +1663 @@
 // forwarded to all connections except origin.
 func (uc *upstreamConn) produce(target string, msg *irc.Message, origin *downstreamConn) {
+        var msgID string
         if target != "" {
-                uc.appendLog(target, msg)
+                msgID = uc.appendLog(target, msg)
         }
 
@@ -1674 +1675 @@
         uc.forEachDownstream(func(dc *downstreamConn) {
                 if dc != origin || dc.caps["echo-message"] {
-                        dc.SendMessage(dc.marshalMessage(msg, uc.network))
+                        dc.sendMessageWithID(dc.marshalMessage(msg, uc.network), msgID)
+                } else {
+                        dc.advanceMessageWithID(msg, msgID)
                 }
         })