Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix XAddOptions maxlen handling and XPendingOptions validation #2985

Closed
wants to merge 1 commit into from
Closed

Fix XAddOptions maxlen handling and XPendingOptions validation #2985

wants to merge 1 commit into from

Conversation

jinkshower
Copy link
Contributor

Closes #2982

  • You have read the Spring Data contribution guidelines.
  • You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
  • You submit test cases (unit or integration tests) that back your changes.
  • You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

jinkshower
jinkshower commented Sep 8, 2024
View reviewed changes
src/main/java/org/springframework/data/redis/connection/stream/StreamReadOptions.java
@@ -96,7 +96,7 @@ public StreamReadOptions block(Duration timeout) {
*/
public StreamReadOptions count(long count) {

Assert.isTrue(count > 0, "Count must be greater or equal to zero");
Assert.isTrue(count > 0, "Count must be greater than zero");
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix description to represent assertion

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Sep 8, 2024
jinkshower
jinkshower commented Sep 8, 2024
View reviewed changes
src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java
@@ -337,7 +337,7 @@ public Long getMaxlen() {
* @since 2.3
*/
public boolean hasMaxlen() {
return maxlen != null && maxlen > 0;
return maxlen != null;
Copy link
Contributor Author

@jinkshower jinkshower Sep 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For context, Lettuce and Jedis treat maxlen edge case differently. XAddArgs in Lettuce asserts maxlen > 0 whereas Jedis doesn't check on maxlen so it follows default redis behaviour which asserts maxlen >=0.

My best choice was just let the user know. So I didn't put any assertion on maxlen. If we validate against negative values (maxlen < 0), it could be confusing since maxlen is validated differently across multiple layers.

java.lang.IllegalArgumentException: Maxlen must be greater 0

	at io.lettuce.core.internal.LettuceAssert.isTrue(LettuceAssert.java:193)
	at io.lettuce.core.XAddArgs.maxlen(XAddArgs.java:121)
	at org.springframework.data.redis.connection.lettuce.LettuceStreamCommands.xAdd(LettuceStreamCommands.java:84)
	at org.springframework.data.redis.connection.DefaultedRedisConnection.xAdd(DefaultedRedisConnection.java:489)
	at org.springframework.data.redis.connection.DefaultStringRedisConnection.xAdd(DefaultStringRedisConnection.java:2918)
	at org.springframework.data.redis.core.DefaultStreamOperations.lambda$add$2(DefaultStreamOperations.java:153)

127.0.0.1:6379> xadd mystream maxlen -1 * test "value"
(error) ERR The MAXLEN argument must be >= 0.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is fine to resort to driver defaults.

@mp911de mp911de self-assigned this Sep 10, 2024
mp911de
mp911de approved these changes Sep 10, 2024
View reviewed changes
src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java
@@ -337,7 +337,7 @@ public Long getMaxlen() {
* @since 2.3
*/
public boolean hasMaxlen() {
return maxlen != null && maxlen > 0;
return maxlen != null;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is fine to resort to driver defaults.

src/test/java/org/springframework/data/redis/core/DefaultStreamOperationsIntegrationTests.java

XAddOptions options = XAddOptions.maxlen(-1).approximateTrimming(false);

assertThatThrownBy(() -> streamOps.add(StreamRecords.objectBacked(value).withStreamKey(key), options));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing Redis/Driver behavior exceeds the scope of what we want to test. We will remove these tests during the merge.

mp911de pushed a commit that referenced this pull request Sep 10, 2024
@jinkshower @mp911de
Fix XAddOptions maxlen handling and XPendingOptions validation.
f5ad90a 
Closes #2982
Original pull request: #2985
mp911de added a commit that referenced this pull request Sep 10, 2024
@mp911de
Polishing.
fcbe0fd 
Refine assertions usage.

Original pull request: #2985
Closes #2982
mp911de pushed a commit that referenced this pull request Sep 10, 2024
@jinkshower @mp911de
Fix XAddOptions maxlen handling and XPendingOptions validation.
b7f26fa 
Closes #2982
Original pull request: #2985
mp911de added a commit that referenced this pull request Sep 10, 2024
@mp911de
Polishing.
6eac1d1 
Refine assertions usage.

Original pull request: #2985
Closes #2982
mp911de pushed a commit that referenced this pull request Sep 10, 2024
@jinkshower @mp911de
Fix XAddOptions maxlen handling and XPendingOptions validation.
c16c840 
Closes #2982
Original pull request: #2985
mp911de added a commit that referenced this pull request Sep 10, 2024
@mp911de
Polishing.
66c74bc 
Refine assertions usage.

Original pull request: #2985
Closes #2982
@mp911de mp911de added type: bug A general bug and removed status: waiting-for-triage An issue we've not yet triaged labels Sep 10, 2024
@mp911de mp911de added this to the 3.2.10 (2023.1.10) milestone Sep 10, 2024
@mp911de
Copy link
Member

mp911de commented Sep 10, 2024

Thank you for your contribution. That's merged, polished, and backported now.

@mp911de mp911de closed this Sep 10, 2024
@jinkshower
Copy link
Contributor Author

jinkshower commented Sep 10, 2024 •
edited
Loading

Thank you for the quick review! I’ve learned so much from this and the previous PR by understanding and reading the source code!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mp911de mp911de mp911de approved these changes

Assignees

@mp911de mp911de

Labels
type: bug A general bug
Projects
None yet
Milestone
3.2.10 (2023.1.10)
Development

Successfully merging this pull request may close these issues.

Negative maxlen for XAddOptions is ignored
3 participants
@jinkshower @mp911de @spring-projects-issues