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

fix: implement processMap function to MAP structured data #99

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix: implement processMap function to MAP structured data #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
517ba74
fix: implement processMap function to MAP structured data
peacecwz May 10, 2023
b788921
fix: add header by field name
peacecwz May 10, 2023
df4cbd0
feat: add tests to HeaderToField for processMap function implementation
peacecwz May 10, 2023
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
27 changes: 27 additions & 0 deletions src/main/java/com/github/jcustenborder/kafka/connect/transform/common/HeaderToField.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.apache.kafka.connect.data.SchemaAndValue;
import org.apache.kafka.connect.data.SchemaBuilder;
import org.apache.kafka.connect.data.Struct;
import org.apache.kafka.connect.header.Header;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -100,6 +101,32 @@ Conversion conversion(Schema schema) {
});
}

@Override
protected SchemaAndValue processMap(R record, Map<String, Object> input) {
if (record.headers().isEmpty()) {
return new SchemaAndValue(null, input);
}

Map<String, Object> headers = new HashMap<>();
if (this.config.mappings.isEmpty()) {
for (Header header: record.headers()) {
headers.put(header.key(), header.value());
break;
}
} else {
this.config.mappings.forEach(mapping -> {
for (Header header: record.headers()) {
if (header.key().equals(mapping.header)) {
headers.put(mapping.field, header.value());
break;
}
}
});
}

input.put("_headers", headers);
Copy link

@harpaj harpaj Sep 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I just tested this code because we are running into a similar problem.
It appears to add the extracted values to the new struct field _headers which you are setting here, creating a nested structure.
So

".header.mappings": "time:INT64:d,time:INT64:h,time:INT64:m"

becomes

"value": {
    "_headers" : {
        "d" : 1669852804800000000,
        "h" : 1669852804800000000,
        "m" : 1669852804800000000
    }
}

I would have expected a flat structure here (and interestingly also the test you added shows a flat structure).

Copy link

Choose a reason for hiding this comment

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

The test actually doesn't test this correctly.
To have the same behaviour as for Structs (i,e, adding the new fields to the root), this should be:

Suggested change
input.put("_headers", headers);
input.putAll(headers);

return new SchemaAndValue(null, input);
}

@Override
protected SchemaAndValue processStruct(R record, Schema inputSchema, Struct input) {
Expand Down
49 changes: 43 additions & 6 deletions src/test/java/com/github/jcustenborder/kafka/connect/transform/common/HeaderToFieldTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,16 @@
import java.io.IOException;

import static com.github.jcustenborder.kafka.connect.utils.AssertStruct.assertStruct;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

public class HeaderToFieldTest {
Transformation<SinkRecord> transformation;

@BeforeEach
public void before() {
this.transformation = new HeaderToField.Value<>();
}


@Test
public void apply() throws IOException {
this.transformation = new HeaderToField.Value<>();

this.transformation.configure(
ImmutableMap.of(HeaderToFieldConfig.HEADER_MAPPINGS_CONF, "applicationId:STRING")
);
Expand Down Expand Up @@ -71,4 +68,44 @@ public void apply() throws IOException {
assertStruct(expectedStruct, (Struct) actualRecord.value());
}

@Test
public void applyWithMap() throws IOException {
this.transformation = new HeaderToField.Key<>();
Copy link

Choose a reason for hiding this comment

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

Suggested change
this.transformation = new HeaderToField.Key<>();
this.transformation = new HeaderToField.Value<>();


this.transformation.configure(
ImmutableMap.of(HeaderToFieldConfig.HEADER_MAPPINGS_CONF, "applicationId:STRING")
);

ConnectHeaders inputHeaders = new ConnectHeaders();
inputHeaders.addString("applicationId", "testing");

Schema inputSchema = SchemaBuilder.map(SchemaBuilder.STRING_SCHEMA, SchemaBuilder.OPTIONAL_STRING_SCHEMA)
Copy link

Choose a reason for hiding this comment

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

Suggested change
Schema inputSchema = SchemaBuilder.map(SchemaBuilder.STRING_SCHEMA, SchemaBuilder.OPTIONAL_STRING_SCHEMA)
Map<String, Object> inputSchema = new HashMap<>();
value.put("firstName", "example");
value.put("lastName", "user");

.parameter("firstName", "example")
.parameter("lastName", "user")
.build();

Schema expectedSchema = SchemaBuilder.map(SchemaBuilder.STRING_SCHEMA, SchemaBuilder.OPTIONAL_STRING_SCHEMA)
.parameter("firstName", "example")
.parameter("lastName", "user")
.parameter("applicationId", "testing")
.build();

SinkRecord inputRecord = new SinkRecord(
"testing",
1,
null,
null,
expectedSchema.schema(),
inputSchema,
12345L,
123412351L,
TimestampType.NO_TIMESTAMP_TYPE,
inputHeaders
);

SinkRecord actualRecord = this.transformation.apply(inputRecord);
assertNotNull(actualRecord, "record should not be null.");
assertEquals(expectedSchema.parameters().size(), 3);
Copy link

Choose a reason for hiding this comment

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

Suggested change
assertEquals(expectedSchema.parameters().size(), 3);
assertEquals("testing", ((Map<String, String>)actualRecord.value()).get("applicationId"));

}

}