GH-2280: Add ContainerProperties.pauseImmediate

Resolves #2280

Author: garyrussell

spring-kafka-docs/src/main/asciidoc/kafka.adoc

@@ -2580,6 +2580,10 @@ See `monitorInterval`.
 Deprecated.
 Replaced by `KafkaUtils.setConsumerRecordFormatter`.
 
+|[[pauseImmediate]]<<pauseImmediate,`pauseImmediate`>>
+|`false`
+|When the container is paused, stop processing after the current record instead of after processing all the records from the previous poll; the remaining records are retained in memory and will be passed to the listener when the container is resumed.
+
 |[[pollTimeout]]<<pollTimeout,`pollTimeout`>>
 |5000
 |The timeout passed into `Consumer.poll()`.
@@ -3789,6 +3793,10 @@ However, the consumers might not have actually paused yet.
 
 In addition (also since 2.1.5), `ConsumerPausedEvent` and `ConsumerResumedEvent` instances are published with the container as the `source` property and the `TopicPartition` instances involved in the `partitions` property.
 
+Starting with version 2.9, a new container property `pauseImmediate`, when set to true, causes the pause to take effect after the current record is processed.
+By default, the pause takes effect when all of the records from the previous poll have been processed.
+See <<pauseImmediate>>.
+
 The following simple Spring Boot application demonstrates by using the container registry to get a reference to a `@KafkaListener` method's container and pausing or resuming its consumers as well as receiving the corresponding events:
 
 ====

spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerProperties.java

@@ -326,6 +326,8 @@ public EOSMode getMode() {
 
 	private boolean asyncAcks;
 
+	private boolean pauseImmediate;
+
 	/**
 	 * Create properties for a container that will subscribe to the specified topics.
 	 * @param topics the topics.
@@ -934,6 +936,27 @@ public void setAsyncAcks(boolean asyncAcks) {
 		this.asyncAcks = asyncAcks;
 	}
 
+	/**
+	 * When pausing the container with a record listener, whether the pause takes effect
+	 * immediately, when the current record has been processed, or after all records from
+	 * the previous poll have been processed. Default false.
+	 * @return whether to pause immediately.
+	 * @since 2.9
+	 */
+	public boolean isPauseImmediate() {
+		return this.pauseImmediate;
+	}
+
+	/**
+	 * Set to true to pause the container after the current record has been processed, rather
+	 * than after all the records from the previous poll have been processed.
+	 * @param pauseImmediate true to pause immediately.
+	 * @since 2.9
+	 */
+	public void setPauseImmediate(boolean pauseImmediate) {
+		this.pauseImmediate = pauseImmediate;
+	}
+
 	private void adviseListenerIfNeeded() {
 		if (!CollectionUtils.isEmpty(this.adviceChain)) {
 			if (AopUtils.isAopProxy(this.messageListener)) {

spring-kafka/src/main/java/org/springframework/kafka/listener/KafkaMessageListenerContainer.java

@@ -723,6 +723,8 @@ private final class ListenerConsumer implements SchedulingAwareRunnable, Consume
 
 		private final Set<TopicPartition> pausedForNack = new HashSet<>();
 
+		private final boolean pauseImmediate = this.containerProperties.isPauseImmediate();
+
 		private Map<TopicPartition, OffsetMetadata> definedPartitions;
 
 		private int count;
@@ -761,7 +763,7 @@ private final class ListenerConsumer implements SchedulingAwareRunnable, Consume
 
 		private boolean receivedSome;
 
-		private ConsumerRecords<K, V> pendingRecordsAfterError;
+		private ConsumerRecords<K, V> remainingRecords;
 
 		private boolean pauseForPending;
 
@@ -1362,7 +1364,7 @@ protected void pollAndInvoke() {
 			debugRecords(records);
 
 			invokeIfHaveRecords(records);
-			if (this.pendingRecordsAfterError == null) {
+			if (this.remainingRecords == null) {
 				resumeConsumerIfNeccessary();
 				if (!this.consumerPaused) {
 					resumePartitionsIfNecessary();
@@ -1376,9 +1378,9 @@ private void doProcessCommits() {
 					processCommits();
 				}
 				catch (CommitFailedException cfe) {
-					if (this.pendingRecordsAfterError != null && !this.isBatchListener) {
-						ConsumerRecords<K, V> pending = this.pendingRecordsAfterError;
-						this.pendingRecordsAfterError = null;
+					if (this.remainingRecords != null && !this.isBatchListener) {
+						ConsumerRecords<K, V> pending = this.remainingRecords;
+						this.remainingRecords = null;
 						List<ConsumerRecord<?, ?>> records = new ArrayList<>();
 						Iterator<ConsumerRecord<K, V>> iterator = pending.iterator();
 						while (iterator.hasNext()) {
@@ -1544,19 +1546,19 @@ private ConsumerRecords<K, V> doPoll() {
 			}
 			else {
 				records = pollConsumer();
-				if (this.pendingRecordsAfterError != null) {
+				if (this.remainingRecords != null) {
 					int howManyRecords = records.count();
 					if (howManyRecords > 0) {
 						this.logger.error(() -> String.format("Poll returned %d record(s) while consumer was paused "
 								+ "after an error; emergency stop invoked to avoid message loss", howManyRecords));
 						KafkaMessageListenerContainer.this.emergencyStop.run();
 					}
-					TopicPartition firstPart = this.pendingRecordsAfterError.partitions().iterator().next();
+					TopicPartition firstPart = this.remainingRecords.partitions().iterator().next();
 					boolean isPaused = isPaused() || isPartitionPauseRequested(firstPart);
 					this.logger.debug(() -> "First pending after error: " + firstPart + "; paused: " + isPaused);
 					if (!isPaused) {
-						records = this.pendingRecordsAfterError;
-						this.pendingRecordsAfterError = null;
+						records = this.remainingRecords;
+						this.remainingRecords = null;
 					}
 				}
 				captureOffsets(records);
@@ -2221,8 +2223,8 @@ private RuntimeException doInvokeBatchListener(final ConsumerRecords<K, V> recor
 		private void commitOffsetsIfNeeded(final ConsumerRecords<K, V> records) {
 			if ((!this.autoCommit && this.commonErrorHandler.isAckAfterHandle())
 					|| this.producer != null) {
-				if (this.pendingRecordsAfterError != null) {
-					ConsumerRecord<K, V> firstUncommitted = this.pendingRecordsAfterError.iterator().next();
+				if (this.remainingRecords != null) {
+					ConsumerRecord<K, V> firstUncommitted = this.remainingRecords.iterator().next();
 					Iterator<ConsumerRecord<K, V>> it = records.iterator();
 					while (it.hasNext()) {
 						ConsumerRecord<K, V> next = it.next();
@@ -2388,7 +2390,7 @@ private void invokeBatchErrorHandler(final ConsumerRecords<K, V> records,
 						records, this.consumer, KafkaMessageListenerContainer.this.thisOrParentContainer,
 						() -> invokeBatchOnMessageWithRecordsOrList(records, list));
 				if (!afterHandling.isEmpty()) {
-					this.pendingRecordsAfterError = afterHandling;
+					this.remainingRecords = afterHandling;
 					this.pauseForPending = true;
 				}
 			}
@@ -2445,7 +2447,9 @@ private void invokeRecordListenerInTx(final ConsumerRecords<K, V> records) {
 					handleNack(records, record);
 					break;
 				}
-
+				if (checkImmediatePause(iterator)) {
+					break;
+				}
 			}
 		}
 
@@ -2529,7 +2533,26 @@ private void doInvokeWithRecords(final ConsumerRecords<K, V> records) {
 					handleNack(records, record);
 					break;
 				}
+				if (checkImmediatePause(iterator)) {
+					break;
+				}
+			}
+		}
+
+		private boolean checkImmediatePause(Iterator<ConsumerRecord<K, V>> iterator) {
+			if (isPaused() && this.pauseImmediate) {
+				Map<TopicPartition, List<ConsumerRecord<K, V>>> remaining = new HashMap<>();
+				while (iterator.hasNext()) {
+					ConsumerRecord<K, V> next = iterator.next();
+					remaining.computeIfAbsent(new TopicPartition(next.topic(), next.partition()),
+							tp -> new ArrayList<ConsumerRecord<K, V>>()).add(next);
+				}
+				if (remaining.size() > 0) {
+					this.remainingRecords = new ConsumerRecords<>(remaining);
+					return true;
+				}
 			}
+			return false;
 		}
 
 		@Nullable
@@ -2676,8 +2699,8 @@ private void commitOffsetsIfNeeded(final ConsumerRecord<K, V> record) {
 				if (this.isManualAck) {
 					this.commitRecovered = true;
 				}
-				if (this.pendingRecordsAfterError == null
-						|| !record.equals(this.pendingRecordsAfterError.iterator().next())) {
+				if (this.remainingRecords == null
+						|| !record.equals(this.remainingRecords.iterator().next())) {
 					ackCurrent(record);
 				}
 				if (this.isManualAck) {
@@ -2795,7 +2818,7 @@ private void invokeErrorHandler(final ConsumerRecord<K, V> record,
 							tp -> new ArrayList<ConsumerRecord<K, V>>()).add(next);
 				}
 				if (records.size() > 0) {
-					this.pendingRecordsAfterError = new ConsumerRecords<>(records);
+					this.remainingRecords = new ConsumerRecords<>(records);
 					this.pauseForPending = true;
 				}
 			}