Skip to content

Minor: Preserve user-provided acks config without mutation #21400

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

Open
anupamalok wants to merge 1 commit into
base: trunk
Choose a base branch
from
+47 −9
Open

Minor: Preserve user-provided acks config without mutation #21400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 26 additions & 9 deletions clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,12 +590,13 @@ private void maybeOverrideClientId(final Map<String, Object> configs) {

private void postProcessAndValidateIdempotenceConfigs(final Map<String, Object> configs) {
final Map<String, Object> originalConfigs = this.originals();
final String acksStr = parseAcks(this.getString(ACKS_CONFIG));
configs.put(ACKS_CONFIG, acksStr);
String acksConfig = this.getString(ACKS_CONFIG);
final Short acks = parseAcks(acksConfig);
configs.put(ACKS_CONFIG, Short.toString(acks));
final boolean userConfiguredIdempotence = this.originals().containsKey(ENABLE_IDEMPOTENCE_CONFIG);
boolean idempotenceEnabled = this.getBoolean(ENABLE_IDEMPOTENCE_CONFIG);
boolean shouldDisableIdempotence = false;

// For idempotence producers, values for `retries` and `acks` and `max.in.flight.requests.per.connection` need validation
if (idempotenceEnabled) {
final int retries = this.getInt(RETRIES_CONFIG);
Expand All @@ -607,7 +608,7 @@ private void postProcessAndValidateIdempotenceConfigs(final Map<String, Object>
shouldDisableIdempotence = true;
}

final short acks = Short.parseShort(acksStr);

if (acks != (short) -1) {
if (userConfiguredIdempotence) {
throw new ConfigException("Must set " + ACKS_CONFIG + " to all in order to use the idempotent " +
Expand Down Expand Up @@ -648,16 +649,32 @@ private void postProcessAndValidateIdempotenceConfigs(final Map<String, Object>
" is set to true. Transactions will not expire with two-phase commit enabled."
);
}
log.info("Producer configs after post-processing: {}", configs);

}

private static String parseAcks(String acksString) {
try {
return acksString.trim().equalsIgnoreCase("all") ? "-1" : Short.parseShort(acksString.trim()) + "";
} catch (NumberFormatException e) {
throw new ConfigException("Invalid configuration value for 'acks': " + acksString);
private static short parseAcks(String acksString) {
if (acksString == null) {
throw new ConfigException("acks must be set");
}

String value = acksString.trim();

if (value.equalsIgnoreCase("all") || value.equals("-1")) {
return (short) -1;
}

if (value.equals("0") || value.equals("1")) {
return Short.parseShort(value);
}

throw new ConfigException(
"Invalid value for 'acks': " + acksString +
". Valid values are '0', '1', '-1', or 'all'."
);
}


static Map<String, Object> appendSerializerToConfig(Map<String, Object> configs,
Serializer<?> keySerializer,
Serializer<?> valueSerializer) {
Expand Down
21 changes: 21 additions & 0 deletions clients/src/test/java/org/apache/kafka/clients/producer/ProducerConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,4 +202,25 @@ public void testValidateConfigPropertiesFile() {
}
}
}
/**
* Verifies that KafkaProducer does not mutate the user-provided configurationwhen normalizing the acks setting
*/
@Test
public void shouldNotMutateUserProvidedAcksConfig() {
Properties props = new Properties();
props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "localhost:9092");
props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
props.put(ProducerConfig.ACKS_CONFIG, "all");

assertEquals("all", props.get(ProducerConfig.ACKS_CONFIG));

assertDoesNotThrow(() -> new KafkaProducer<>(props));

assertEquals(
"all",
props.get(ProducerConfig.ACKS_CONFIG),
"KafkaProducer must not rewrite user-provided acks config"
);
}
}