Add tidy frequency to MemoryPersistDriver (#707)

* Add tidy frequency to MemoryPersistDriver

- Fix bug where expired test was the wrong way around
- Add test for tidy

* Fix breaking change

Author: adam-fowler

Sources/Hummingbird/Storage/MemoryPersistDriver.swift

@@ -18,9 +18,35 @@ import NIOCore
 
 /// In memory driver for persist system for storing persistent cross request key/value pairs
 public actor MemoryPersistDriver<C: Clock>: PersistDriver where C.Duration == Duration {
+    public struct Configuration: Sendable {
+        /// amount of time between each call to tidy
+        public var tidyFrequency: Duration
+
+        ///  Initialize MemoryPersistDriver configuration
+        /// - Parameter tidyFrequency:
+        public init(tidyFrequency: Duration = .seconds(600)) {
+            self.tidyFrequency = tidyFrequency
+        }
+    }
+
+    /// Initialize MemoryPersistDriver
+    /// - Parameters:
+    ///   - clock: Clock to use when calculating expiration dates
+    @_disfavoredOverload
     public init(_ clock: C = .continuous) {
         self.values = [:]
         self.clock = clock
+        self.configuration = .init()
+    }
+
+    /// Initialize MemoryPersistDriver
+    /// - Parameters:
+    ///   - clock: Clock to use when calculating expiration dates
+    ///   - configuration: Configuration of driver
+    public init(_ clock: C = .continuous, configuration: Configuration = .init()) {
+        self.values = [:]
+        self.clock = clock
+        self.configuration = configuration
     }
 
     public func create(key: String, value: some Codable & Sendable, expires: Duration?) async throws {
@@ -51,7 +77,7 @@ public actor MemoryPersistDriver<C: Clock>: PersistDriver where C.Duration == Du
         let now = self.clock.now
         self.values = self.values.compactMapValues {
             if let expires = $0.expires {
-                if expires > now {
+                if expires < now {
                     return nil
                 }
             }
@@ -72,7 +98,7 @@ public actor MemoryPersistDriver<C: Clock>: PersistDriver where C.Duration == Du
     }
 
     public func run() async throws {
-        let timerSequence = AsyncTimerSequence(interval: .seconds(600), clock: .suspending)
+        let timerSequence = AsyncTimerSequence(interval: self.configuration.tidyFrequency, clock: self.clock)
             .cancelOnGracefulShutdown()
         for try await _ in timerSequence {
             self.tidy()
@@ -81,4 +107,5 @@ public actor MemoryPersistDriver<C: Clock>: PersistDriver where C.Duration == Du
 
     var values: [String: Item]
     let clock: C
+    let configuration: Configuration
 }

Tests/HummingbirdTests/PersistTests.swift

@@ -19,9 +19,11 @@ import XCTest
 final class PersistTests: XCTestCase {
     static let redisHostname = Environment().get("REDIS_HOSTNAME") ?? "localhost"
 
-    func createRouter() throws -> (Router<BasicRequestContext>, PersistDriver) {
+    func createRouter(
+        configuration: MemoryPersistDriver<ContinuousClock>.Configuration = .init()
+    ) throws -> (Router<BasicRequestContext>, PersistDriver) {
         let router = Router()
-        let persist = MemoryPersistDriver()
+        let persist = MemoryPersistDriver(configuration: configuration)
 
         router.put("/persist/:tag") { request, context -> HTTPResponse.Status in
             let buffer = try await request.body.collect(upTo: .max)
@@ -225,4 +227,17 @@ final class PersistTests: XCTestCase {
             }
         }
     }
+
+    func testTidy() async throws {
+        let (router, persist) = try createRouter(configuration: .init(tidyFrequency: .milliseconds(1)))
+        let app = Application(responder: router.buildResponder(), services: [persist])
+        try await app.test(.router) { client in
+            let tag = UUID().uuidString
+            try await client.execute(uri: "/persist/\(tag)/10", method: .put, body: ByteBufferAllocator().buffer(string: "NotExpired")) { _ in }
+            try await Task.sleep(for: .milliseconds(20))
+            try await client.execute(uri: "/persist/\(tag)", method: .get) { response in
+                XCTAssertEqual(String(buffer: response.body), "NotExpired")
+            }
+        }
+    }
 }