Add popFirst and popLast methods to RedisZSet.

See #2007

Author: mp911de

src/main/java/org/springframework/data/redis/support/collections/DefaultRedisZSet.java

@@ -19,6 +19,7 @@
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.redis.connection.DataType;
 import org.springframework.data.redis.connection.RedisZSetCommands.Limit;
@@ -380,6 +381,38 @@ public E first() {
 		throw new NoSuchElementException();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#popFirst()
+	 */
+	@Override
+	public E popFirst() {
+
+		TypedTuple<E> tuple = boundZSetOps.popMin();
+
+		if (tuple != null) {
+			return tuple.getValue();
+		}
+
+		throw new NoSuchElementException();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#popFirst(long, java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public E popFirst(long timeout, TimeUnit unit) {
+
+		TypedTuple<E> tuple = boundZSetOps.popMin(timeout, unit);
+
+		if (tuple != null) {
+			return tuple.getValue();
+		}
+
+		throw new NoSuchElementException();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.support.collections.RedisZSet#last()
@@ -397,6 +430,38 @@ public E last() {
 		throw new NoSuchElementException();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#popLast()
+	 */
+	@Override
+	public E popLast() {
+
+		TypedTuple<E> tuple = boundZSetOps.popMax();
+
+		if (tuple != null) {
+			return tuple.getValue();
+		}
+
+		throw new NoSuchElementException();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.support.collections.RedisZSet#popLast(long, java.util.concurrent.TimeUnit)
+	 */
+	@Override
+	public E popLast(long timeout, TimeUnit unit) {
+
+		TypedTuple<E> tuple = boundZSetOps.popMax(timeout, unit);
+
+		if (tuple != null) {
+			return tuple.getValue();
+		}
+
+		throw new NoSuchElementException();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.support.collections.RedisZSet#rank(java.lang.Object)

src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java

@@ -21,6 +21,7 @@
 import java.util.NoSuchElementException;
 import java.util.Set;
 import java.util.SortedSet;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.redis.connection.RedisZSetCommands.Limit;
 import org.springframework.data.redis.connection.RedisZSetCommands.Range;
@@ -217,6 +218,28 @@ default boolean addIfAbsent(E e) {
 	 */
 	E first();
 
+	/**
+	 * Removes the first (lowest) object at the top of this sorted set and returns that object as the value of this
+	 * function.
+	 *
+	 * @return the first (lowest) element currently in this sorted set.
+	 * @throws NoSuchElementException sorted set is empty.
+	 * @since 2.6
+	 */
+	E popFirst();
+
+	/**
+	 * Removes the first (lowest) object at the top of this sorted set and returns that object as the value of this
+	 * function. <b>Blocks connection</b> until element available or {@code timeout} reached.
+	 *
+	 * @param timeout
+	 * @param unit must not be {@literal null}.
+	 * @return the first (lowest) element currently in this sorted set.
+	 * @throws NoSuchElementException sorted set is empty.
+	 * @since 2.6
+	 */
+	E popFirst(long timeout, TimeUnit unit);
+
 	/**
 	 * Returns the last (highest) element currently in this sorted set.
 	 *
@@ -225,6 +248,28 @@ default boolean addIfAbsent(E e) {
 	 */
 	E last();
 
+	/**
+	 * Removes the last (highest) object at the top of this sorted set and returns that object as the value of this
+	 * function.
+	 *
+	 * @return the last (highest) element currently in this sorted set.
+	 * @throws NoSuchElementException sorted set is empty.
+	 * @since 2.6
+	 */
+	E popLast();
+
+	/**
+	 * Removes the last (highest) object at the top of this sorted set and returns that object as the value of this
+	 * function. <b>Blocks connection</b> until element available or {@code timeout} reached.
+	 *
+	 * @param timeout
+	 * @param unit must not be {@literal null}.
+	 * @return the last (highest) element currently in this sorted set.
+	 * @throws NoSuchElementException sorted set is empty.
+	 * @since 2.6
+	 */
+	E popLast(long timeout, TimeUnit unit);
+
 	/**
 	 * @since 1.4
 	 * @return

src/test/java/org/springframework/data/redis/support/collections/AbstractRedisZSetTestIntegration.java

@@ -23,6 +23,7 @@
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import org.assertj.core.data.Offset;
 import org.junit.jupiter.api.BeforeEach;
@@ -37,6 +38,7 @@
 import org.springframework.data.redis.core.Cursor;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.data.redis.core.ZSetOperations.TypedTuple;
+import org.springframework.data.redis.test.condition.EnabledOnCommand;
 import org.springframework.data.redis.test.extension.parametrized.ParameterizedRedisTest;
 
 /**
@@ -119,13 +121,46 @@ void testFirst() {
 		assertThat(zSet.first()).isEqualTo(t1);
 	}
 
+	@ParameterizedRedisTest
+	@EnabledOnCommand("ZPOPMIN")
+	void testPopFirst() {
+
+		T t1 = getT();
+		T t2 = getT();
+		T t3 = getT();
+
+		zSet.add(t1, 3);
+		zSet.add(t2, 4);
+		zSet.add(t3, 5);
+
+		assertThat(zSet.popFirst()).isEqualTo(t1);
+		assertThat(zSet).hasSize(2);
+	}
+
+	@ParameterizedRedisTest
+	@EnabledOnCommand("ZPOPMIN")
+	void testPopFirstWithTimeout() {
+
+		T t1 = getT();
+		T t2 = getT();
+		T t3 = getT();
+
+		zSet.add(t1, 3);
+		zSet.add(t2, 4);
+		zSet.add(t3, 5);
+
+		assertThat(zSet.popFirst(1, TimeUnit.SECONDS)).isEqualTo(t1);
+		assertThat(zSet).hasSize(2);
+	}
+
 	@ParameterizedRedisTest
 	void testFirstException() {
 		assertThatExceptionOfType(NoSuchElementException.class).isThrownBy(() -> zSet.first());
 	}
 
 	@ParameterizedRedisTest
 	void testLast() {
+
 		T t1 = getT();
 		T t2 = getT();
 		T t3 = getT();
@@ -138,6 +173,38 @@ void testLast() {
 		assertThat(zSet.last()).isEqualTo(t3);
 	}
 
+	@ParameterizedRedisTest
+	@EnabledOnCommand("ZPOPMAX")
+	void testPopLast() {
+
+		T t1 = getT();
+		T t2 = getT();
+		T t3 = getT();
+
+		zSet.add(t1, 3);
+		zSet.add(t2, 4);
+		zSet.add(t3, 5);
+
+		assertThat(zSet.popLast()).isEqualTo(t3);
+		assertThat(zSet).hasSize(2);
+	}
+
+	@ParameterizedRedisTest
+	@EnabledOnCommand("ZPOPMAX")
+	void testPopLastWithTimeout() {
+
+		T t1 = getT();
+		T t2 = getT();
+		T t3 = getT();
+
+		zSet.add(t1, 3);
+		zSet.add(t2, 4);
+		zSet.add(t3, 5);
+
+		assertThat(zSet.popLast(1, TimeUnit.SECONDS)).isEqualTo(t3);
+		assertThat(zSet).hasSize(2);
+	}
+
 	@ParameterizedRedisTest
 	void testLastException() {
 		assertThatExceptionOfType(NoSuchElementException.class).isThrownBy(() -> zSet.last());