Add SETEX and PSETEX commands

Motivation:

The SETEX and PSETEX commands are missing.

Modifications:

- Add SETEX command
- Add PSETEX command
- Add integration tests

Result:

Users can atomically set a key with an expire

Author: glbrntt

Sources/RediStack/Commands/StringCommands.swift

@@ -293,6 +293,60 @@ extension RedisClient {
             .map { $0 == 1 }
     }
 
+    /// Sets a key to the provided value and an expiration timeout in seconds.
+    ///
+    /// See [https://redis.io/commands/setex](https://redis.io/commands/setex)
+    /// - Important: Regardless of the type of data stored at the key, it will be overwritten to a "string" data type.
+    ///
+    /// ie. If the key is a reference to a Sorted Set, its value will be overwritten to be a "string" data type.
+    /// - Important: The actual expiration used will be the specified value or `1`, whichever is larger.
+    /// - Parameters:
+    ///     - key: The key to use to uniquely identify this value.
+    ///     - value: The value to set the key to.
+    ///     - expiration: The number of seconds after which to expire the key.
+    /// - Returns: A `NIO.EventLoopFuture` that resolves if the operation was successful.
+    @inlinable
+    public func setex<Value: RESPValueConvertible>(
+        _ key: RedisKey,
+        to value: Value,
+        expirationInSeconds expiration: Int
+    ) -> EventLoopFuture<Void> {
+        let args: [RESPValue] = [
+            .init(from: key),
+            .init(from: max(1, expiration)),
+            value.convertedToRESPValue()
+        ]
+        return self.send(command: "SETEX", with: args)
+            .map { _ in () }
+    }
+
+    /// Sets a key to the provided value and an expiration timeout in milliseconds.
+    ///
+    /// See [https://redis.io/commands/psetex](https://redis.io/commands/psetex)
+    /// - Important: Regardless of the type of data stored at the key, it will be overwritten to a "string" data type.
+    ///
+    /// ie. If the key is a reference to a Sorted Set, its value will be overwritten to be a "string" data type.
+    /// - Important: The actual expiration used will be the specified value or `1`, whichever is larger.
+    /// - Parameters:
+    ///     - key: The key to use to uniquely identify this value.
+    ///     - value: The value to set the key to.
+    ///     - expiration: The number of milliseconds after which to expire the key.
+    /// - Returns: A `NIO.EventLoopFuture` that resolves if the operation was successful.
+    @inlinable
+    public func psetex<Value: RESPValueConvertible>(
+        _ key: RedisKey,
+        to value: Value,
+        expirationInMilliseconds expiration: Int
+    ) -> EventLoopFuture<Void> {
+        let args: [RESPValue] = [
+            .init(from: key),
+            .init(from: max(1, expiration)),
+            value.convertedToRESPValue()
+        ]
+        return self.send(command: "PSETEX", with: args)
+            .map { _ in () }
+    }
+
     /// Sets each key to their respective new value, overwriting existing values.
     /// - Note: Use `msetnx(_:)` if you don't want to overwrite values.
     ///

Tests/RediStackIntegrationTests/Commands/StringCommandsTests.swift

@@ -121,6 +121,30 @@ final class StringCommandsTests: RediStackIntegrationTestCase {
         XCTAssertFalse(try connection.setnx(#function, to: "value").wait())
     }
 
+    func test_setex() throws {
+        XCTAssertNoThrow(try connection.setex(#function, to: "value", expirationInSeconds: 42).wait())
+        let ttl = try connection.ttl(#function).wait()
+        switch ttl {
+        case .keyDoesNotExist, .unlimited:
+            XCTFail("Unexpected TTL for \(#function)")
+        case .limited(let lifetime):
+            XCTAssertGreaterThan(lifetime.timeAmount, .nanoseconds(0))
+            XCTAssertLessThanOrEqual(lifetime.timeAmount, .seconds(42))
+        }
+    }
+
+    func test_psetex() throws {
+        XCTAssertNoThrow(try connection.psetex(#function, to: "value", expirationInMilliseconds: 42_000).wait())
+        let ttl = try connection.pttl(#function).wait()
+        switch ttl {
+        case .keyDoesNotExist, .unlimited:
+            XCTFail("Unexpected TTL for \(#function)")
+        case .limited(let lifetime):
+            XCTAssertGreaterThan(lifetime.timeAmount, .nanoseconds(0))
+            XCTAssertLessThanOrEqual(lifetime.timeAmount, .milliseconds(42_000))
+        }
+    }
+
     func test_append() throws {
         let result = "value appended"
         XCTAssertNoThrow(try connection.append("value", to: #function).wait())

Tests/RediStackIntegrationTests/XCTestManifests.swift

@@ -157,10 +157,12 @@ extension StringCommandsTests {
         ("test_mget", test_mget),
         ("test_mset", test_mset),
         ("test_msetnx", test_msetnx),
+        ("test_psetex", test_psetex),
         ("test_set_condition_and_expiration", test_set_condition_and_expiration),
         ("test_set_condition", test_set_condition),
         ("test_set_expiration", test_set_expiration),
         ("test_set", test_set),
+        ("test_setex", test_setex),
         ("test_setnx", test_setnx),
     ]
 }