Adds support for XPENDING IDLE parameter #2822
Conversation
| /// <param name="flags">The flags to use for this operation.</param> | ||
| /// <returns>An instance of <see cref="StreamPendingMessageInfo"/> for each pending message.</returns> | ||
| /// <remarks>Equivalent of calling XPENDING key group start-id end-id count consumer-name.</remarks> | ||
| /// <remarks><seealso href="https://redis.io/commands/xpending"/></remarks> | ||
| StreamPendingMessageInfo[] StreamPendingMessages(RedisKey key, RedisValue groupName, int count, RedisValue consumerName, RedisValue? minId = null, RedisValue? maxId = null, CommandFlags flags = CommandFlags.None); | ||
| StreamPendingMessageInfo[] StreamPendingMessages(RedisKey key, RedisValue groupName, int count, RedisValue consumerName, RedisValue? minId = null, RedisValue? maxId = null, long? minIdleTimeInMs = null, CommandFlags flags = CommandFlags.None); |
There was a problem hiding this comment.
we need to add an overload here, i.e. a second method with different parameters; otherwise, this is a hard binary break - we try very hard not to do that. If the compiler complains about two methods with optional parameters, we can work around that
(yes: technically adding methods to the interface is also problematic, but: it is problematic in different ways, and in reality we don't expect custom implementations of the IDatabase etc APIs)
| var offset = 0; | ||
|
|
||
| values[offset++] = groupName; | ||
| if (minIdleTimeInMs is not null) |
| @@ -1154,8 +1154,8 @@ public void StreamPendingInfoGet() | |||
| [Fact] | |||
| public void StreamPendingMessageInfoGet() | |||
| { | |||
| prefixed.StreamPendingMessages("key", "group", 10, RedisValue.Null, "-", "+", CommandFlags.None); | |||
| mock.Received().StreamPendingMessages("prefix:key", "group", 10, RedisValue.Null, "-", "+", CommandFlags.None); | |||
| prefixed.StreamPendingMessages("key", "group", 10, RedisValue.Null, "-", "+", 1000, CommandFlags.None); | |||
There was a problem hiding this comment.
if this 1000 is the new arg, we probably need a version-check here, to not break test setups
There was a problem hiding this comment.
I'm not following the concern here and likely showing my lack of knowledge about your setup. 1000 is the new arg, but this seems to be mocked and I'm not following how that could break. What is the "test setup" you're referencing?
There was a problem hiding this comment.
oh, if it is mocked: fine - ignore me
- Add release notes - Add overload to StreamPendingMessages/StreamPendingMessagesAsync to preserve back compat
There was a problem hiding this comment.
technically this is a little weird if somebody was passing literal 0 as the flags parameter on the old API, which is legal but unusual; I'm OK with it, though - any thoughts from @NickCraver @philon-msft ?
Adds support for Idle time filter on XPENDING command.
This filter is only available on Redis 6.2+, but I didn't see an indication that version is checked when building command arguments/values.
CommandFlags appeared always to be the last method argument. Adding minIdleTimeInMs before the flags seems like a breaking change to the signature of StreamPendingMessages/StreamPendingMessagesAsync. I can amend if desired.
fixes #2432