Skip to content

KAFKA-9707: Fix InsertField.Key should apply to keys of tombstone records #8280

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

Merged
kkonstantine merged 6 commits into from
Mar 26, 2020
Merged

KAFKA-9707: Fix InsertField.Key should apply to keys of tombstone records #8280

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
25696b3
KAFKA-9707: Fix InsertField.Key not applying to tombstone events
gharris1727 Mar 11, 2020
af8eb92
Add null value assertion to tombstone test
gharris1727 Mar 11, 2020
54ff2b3
Remove mis-named function and add test for passing-through a null-key…
gharris1727 Mar 25, 2020
5d8105e
Simplify unchanged record assertion
gharris1727 Mar 25, 2020
a75bcc2
Replace assertEquals with assertSame
gharris1727 Mar 25, 2020
34eacf0
Fix checkstyleTest indent issue
gharris1727 Mar 26, 2020
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
2 changes: 1 addition & 1 deletion connect/transforms/src/main/java/org/apache/kafka/connect/transforms/InsertField.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ public R apply(R record) {
}

private boolean isTombstoneRecord(R record) {
return record.value() == null;
return operatingValue(record) == null;

@rhauch rhauch Mar 25, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we please clean up the logic? This method no longer returns true if it's just a tombstone record; it also returns true if the key is null for InsertField$Key.

I'd suggest removing this method altogether and just changing the point where this method is called to simply be:

          if (operatingValue(record) == null) {

@C0urante C0urante Mar 25, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Plus one for this; confusion around the term tombstone has already caused plenty of miscommunication around this issue and we should be careful to use it correctly.

}

private R applySchemaless(R record) {
Expand Down
50 changes: 37 additions & 13 deletions connect/transforms/src/test/java/org/apache/kafka/connect/transforms/InsertFieldTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,18 @@
import static org.junit.Assert.assertSame;

public class InsertFieldTest {
private InsertField<SourceRecord> xform = new InsertField.Value<>();
private InsertField<SourceRecord> xformKey = new InsertField.Key<>();
private InsertField<SourceRecord> xformValue = new InsertField.Value<>();

@After
public void teardown() {
xform.close();
xformValue.close();
}

@Test(expected = DataException.class)
public void topLevelStructRequired() {
xform.configure(Collections.singletonMap("topic.field", "topic_field"));
xform.apply(new SourceRecord(null, null, "", 0, Schema.INT32_SCHEMA, 42));
xformValue.configure(Collections.singletonMap("topic.field", "topic_field"));
xformValue.apply(new SourceRecord(null, null, "", 0, Schema.INT32_SCHEMA, 42));
}

@Test
Expand All @@ -55,13 +56,13 @@ public void copySchemaAndInsertConfiguredFields() {
props.put("static.field", "instance_id");
props.put("static.value", "my-instance-id");

xform.configure(props);
xformValue.configure(props);

final Schema simpleStructSchema = SchemaBuilder.struct().name("name").version(1).doc("doc").field("magic", Schema.OPTIONAL_INT64_SCHEMA).build();
final Struct simpleStruct = new Struct(simpleStructSchema).put("magic", 42L);

final SourceRecord record = new SourceRecord(null, null, "test", 0, simpleStructSchema, simpleStruct);
final SourceRecord transformedRecord = xform.apply(record);
final SourceRecord transformedRecord = xformValue.apply(record);

assertEquals(simpleStructSchema.name(), transformedRecord.valueSchema().name());
assertEquals(simpleStructSchema.version(), transformedRecord.valueSchema().version());
Expand All @@ -83,7 +84,7 @@ public void copySchemaAndInsertConfiguredFields() {
assertEquals("my-instance-id", ((Struct) transformedRecord.value()).getString("instance_id"));

// Exercise caching
final SourceRecord transformedRecord2 = xform.apply(
final SourceRecord transformedRecord2 = xformValue.apply(
new SourceRecord(null, null, "test", 1, simpleStructSchema, new Struct(simpleStructSchema)));
assertSame(transformedRecord.valueSchema(), transformedRecord2.valueSchema());
}
Expand All @@ -97,12 +98,12 @@ public void schemalessInsertConfiguredFields() {
props.put("static.field", "instance_id");
props.put("static.value", "my-instance-id");

xform.configure(props);
xformValue.configure(props);

final SourceRecord record = new SourceRecord(null, null, "test", 0,
null, Collections.singletonMap("magic", 42L));

final SourceRecord transformedRecord = xform.apply(record);
final SourceRecord transformedRecord = xformValue.apply(record);

assertEquals(42L, ((Map<?, ?>) transformedRecord.value()).get("magic"));
assertEquals("test", ((Map<?, ?>) transformedRecord.value()).get("topic_field"));
Expand All @@ -121,12 +122,12 @@ public void insertConfiguredFieldsIntoTombstoneEventWithoutSchemaLeavesValueUnch
props.put("static.field", "instance_id");
props.put("static.value", "my-instance-id");

xform.configure(props);
xformValue.configure(props);

final SourceRecord record = new SourceRecord(null, null, "test", 0,
null, null);

final SourceRecord transformedRecord = xform.apply(record);
final SourceRecord transformedRecord = xformValue.apply(record);

assertEquals(null, transformedRecord.value());
assertEquals(null, transformedRecord.valueSchema());
Expand All @@ -141,16 +142,39 @@ public void insertConfiguredFieldsIntoTombstoneEventWithSchemaLeavesValueUnchang
props.put("static.field", "instance_id");
props.put("static.value", "my-instance-id");

xform.configure(props);
xformValue.configure(props);

final Schema simpleStructSchema = SchemaBuilder.struct().name("name").version(1).doc("doc").field("magic", Schema.OPTIONAL_INT64_SCHEMA).build();

final SourceRecord record = new SourceRecord(null, null, "test", 0,
simpleStructSchema, null);

final SourceRecord transformedRecord = xform.apply(record);
final SourceRecord transformedRecord = xformValue.apply(record);

assertEquals(null, transformedRecord.value());
assertEquals(simpleStructSchema, transformedRecord.valueSchema());
}

@Test
public void insertkeyFieldsIntoTombstoneEvent() {
final Map<String, Object> props = new HashMap<>();
props.put("topic.field", "topic_field!");
props.put("partition.field", "partition_field");
props.put("timestamp.field", "timestamp_field?");
props.put("static.field", "instance_id");
props.put("static.value", "my-instance-id");

xformKey.configure(props);

final SourceRecord record = new SourceRecord(null, null, "test", 0,
null, Collections.singletonMap("magic", 42L), null, null);

final SourceRecord transformedRecord = xformKey.apply(record);

assertEquals(42L, ((Map<?, ?>) transformedRecord.key()).get("magic"));
assertEquals("test", ((Map<?, ?>) transformedRecord.key()).get("topic_field"));
assertEquals(0, ((Map<?, ?>) transformedRecord.key()).get("partition_field"));
assertEquals(null, ((Map<?, ?>) transformedRecord.key()).get("timestamp_field"));
assertEquals("my-instance-id", ((Map<?, ?>) transformedRecord.key()).get("instance_id"));
Comment thread
gharris1727 marked this conversation as resolved.
Comment thread
gharris1727 marked this conversation as resolved.
}
}