Fix messages not being removed from cache

This additionally implements the same fix for components. Although it did not affect components, it's better for all items that used `Timer` to swap to the new method

Author: Defxult

Sources/Discord/Discord.swift

@@ -91,6 +91,7 @@ public class Bot {
     var gw: Gateway!
     private var onceExecute: (() async -> Void)? = nil
 
+    let loop: EventLoop
     private let msgCacheLock = NSLock()
     private let sema = DispatchSemaphore(value: 0)
     private let app = Vapor.Application()
@@ -106,6 +107,7 @@ public class Bot {
         self.intents = intents
         self.sharding = sharding
         self.cacheManager = cacheManager
+        loop = app.eventLoopGroup.any()
         gw = Gateway(bot: self, elg: app.eventLoopGroup)
         http = .init(bot: self, token: token, version: version, app: app)
     }
@@ -139,7 +141,7 @@ public class Bot {
 
     func removeCachedMessage(_ messageId: Snowflake) {
         if let message = cachedMessages.first(where: { $0.id == messageId }) {
-            message.cacheExpireTimer?.invalidate()
+            message.cacheExpireScheduler?.cancel()
             cachedMessages.remove(message)
         }
     }
@@ -521,7 +523,7 @@ public class Bot {
     /// - Returns: The message matching the provided ID, or `nil` if not found.
     public func getMessage(_ id: Snowflake) -> Message? {
         if let msg = cachedMessages.first(where: { $0.id == id }) {
-            msg.setExpires()
+            msg.setScheduler()
             return msg
         }
         return nil

Sources/Discord/Gateway.swift

@@ -467,9 +467,9 @@ class Gateway {
             }
         case .messageComponent:
             if let cachedMsg = interaction.bot!.getMessage(interaction.message!.id) {
-                // Reset the onTimeout timer. With each interaction this is reset because I don't want the
+                // Reset the onTimeout scheduler. With each interaction this is reset because I don't want the
                 // components to be disabled (by default) when components are in active use
-                cachedMsg.ui?.startOnTimeoutTimer()
+                cachedMsg.ui?.startOnTimeoutScheduler()
 
                 await cachedMsg.ui?.onInteraction(interaction)
             }
@@ -984,8 +984,8 @@ class Gateway {
             let guildId = Conversions.snowflakeToOptionalUInt(data["guild_id"])
 
             if let message = bot.getMessage(messageId) {
-                // Before the message is removed from the cache, invalidate the UI onTimeout timer
-                message.ui?.timer?.invalidate()
+                // Before the message is removed from the cache, cancel the UI onTimeout scheduler
+                message.ui?.scheduler?.cancel()
 
                 bot.removeCachedMessage(message.id)
                 dispatch({ await $0.onMessageDelete(message: message) })

Sources/Discord/Models/Components.swift

@@ -23,6 +23,8 @@ DEALINGS IN THE SOFTWARE.
  */
 
 import Foundation
+import NIOCore
+import NIOPosix
 
 /// Represents a components type.
 public enum ComponentType : Int {
@@ -69,12 +71,17 @@ public class UI {
     /// The message the UI is attached to.
     public private(set) var attachedMessage: Message? = nil
 
-    var timer: Timer? = nil
+    let elg = MultiThreadedEventLoopGroup(numberOfThreads: 1)
+    var scheduler: Scheduled<()>? = nil
 
     /// Initializes a UI.
     /// - Parameter timeout: The amount of time in seconds for when the UI times out and the `onTimeout` closure is called.
     public init(timeout: TimeInterval = 120) {
-        self.timeout = timeout < 0 ? 120 : timeout
+        self.timeout = timeout < 0 ? 0 : timeout
+    }
+    
+    deinit {
+        try? elg.syncShutdownGracefully()
     }
 
     /// Add an item to the UI.
@@ -151,15 +158,11 @@ public class UI {
         return self
     }
 
-    func startOnTimeoutTimer() {
-        timer?.invalidate()
-        DispatchQueue.main.async {
-            self.timer = .scheduledTimer(withTimeInterval: self.timeout, repeats: false, block: { _ in
-                Task {
-                    await self.onTimeout(self.attachedMessage)
-                }
-            })
-        }
+    func startOnTimeoutScheduler() {
+        scheduler?.cancel()
+        scheduler = elg.any().scheduleTask(in: .seconds(Int64(timeout)), {
+            Task { await self.onTimeout(self.attachedMessage) }
+        })
     }
 
     func convert() throws -> [JSON] {
@@ -195,7 +198,7 @@ public class UI {
         if let ui, let cachedMessage = message.bot!.getMessage(message.id) {
             cachedMessage.ui = ui
             ui.attachedMessage = cachedMessage
-            ui.startOnTimeoutTimer()
+            ui.startOnTimeoutScheduler()
         }
     }
 

Sources/Discord/Models/Message.swift

@@ -23,6 +23,7 @@ DEALINGS IN THE SOFTWARE.
 */
 
 import Foundation
+import NIOCore
 
 /// Represents a Discord message.
 public class Message : Object, Hashable, Updateable {
@@ -209,13 +210,15 @@ public class Message : Object, Hashable, Updateable {
     /// Your bot instance.
     public weak private(set) var bot: Bot?
 
-    static var cacheExpire: Date { Calendar.current.date(byAdding: .hour, value: 3, to: .now)! }
-    var cacheExpireTimer: Timer? = nil
+    var guildId: Snowflake?
+    
+    var cacheExpireScheduler: Scheduled<()>? = nil
+    var expires: Date! // initialized in setScheduler()
+    static let expireAfter = 5
+    static var cacheExpire: Date { Calendar.current.date(byAdding: .hour, value: Message.expireAfter, to: .now)! }
 
     let channelId: Snowflake
-    var guildId: Snowflake?
     let mentionRoleStrings: [String]
-    var expires: Date
     let temp: JSON
 
     init(bot: Bot, messageData: JSON) {
@@ -295,8 +298,7 @@ public class Message : Object, Hashable, Updateable {
             }
         }
 
-        expires = Message.cacheExpire
-        setExpires()
+        setScheduler()
 
         // This was moved to the end because `self` cannot be used before all stored proprties have been initalized.
         if let reactionObjs = messageData["reactions"] as? [JSON] {
@@ -479,13 +481,14 @@ public class Message : Object, Hashable, Updateable {
         try await bot!.http.crosspostMessage(channelId: channel.id, messageId: id)
     }
 
-    func setExpires() {
+    func setScheduler() {
+        // Set/reset the expiration date. This method is called during this init() or
+        // when a message is retrieved via Bot.getMessage()
         expires = Message.cacheExpire
-        cacheExpireTimer?.invalidate()
-        DispatchQueue.main.async {
-            self.cacheExpireTimer = .scheduledTimer(withTimeInterval: self.expires.timeIntervalSince(.now), repeats: false, block: { [self] _ in
-                bot!.removeCachedMessage(id)
-            })
+        
+        cacheExpireScheduler?.cancel()
+        cacheExpireScheduler = bot!.loop.scheduleTask(in: .hours(Int64(Message.expireAfter))) {
+            self.bot!.removeCachedMessage(self.id)
         }
     }