Skip to content

BE: Closes #71 Messages: Show headers duplicates #640

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions api/src/main/java/io/kafbat/ui/emitter/MessageFilters.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import dev.cel.common.CelValidationResult;
import dev.cel.common.types.CelType;
import dev.cel.common.types.CelTypeProvider;
import dev.cel.common.types.ListType;
import dev.cel.common.types.MapType;
import dev.cel.common.types.SimpleType;
import dev.cel.common.types.StructType;
Expand Down Expand Up @@ -67,9 +68,14 @@ private static boolean headersContains(TopicMessageDTO msg, String searchString)
}

for (final var entry : headers.entrySet()) {
if (StringUtils.contains(entry.getKey(), searchString) || StringUtils.contains(entry.getValue(), searchString)) {
if (StringUtils.contains(entry.getKey(), searchString)) {
return true;
}
for (final var value : entry.getValue()) {
if (StringUtils.contains(value, searchString)) {
return true;
}
}
}

return false;
Expand Down Expand Up @@ -143,7 +149,7 @@ private static CelCompiler createCompiler() {
"timestampMs", SimpleType.INT,
"keyAsText", SimpleType.STRING,
"valueAsText", SimpleType.STRING,
"headers", MapType.create(SimpleType.STRING, SimpleType.STRING),
"headers", MapType.create(SimpleType.STRING, ListType.create(SimpleType.STRING)),
"key", SimpleType.DYN,
"value", SimpleType.DYN
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
import java.time.Instant;
import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.UnaryOperator;
import lombok.RequiredArgsConstructor;
Expand Down Expand Up @@ -63,13 +65,13 @@ private static TimestampTypeEnum mapToTimestampType(TimestampType timestampType)
}

private void fillHeaders(TopicMessageDTO message, ConsumerRecord<Bytes, Bytes> rec) {
Map<String, String> headers = new HashMap<>();
Map<String, List<String>> headers = new HashMap<>();
rec.headers().iterator()
.forEachRemaining(header ->
headers.put(
header.key(),
header.value() != null ? new String(header.value()) : null
));
.forEachRemaining(header -> {
String key = header.key();
String value = header.value() != null ? new String(header.value()) : null;
headers.computeIfAbsent(key, k -> new ArrayList<>()).add(value);
});
message.setHeaders(headers);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.kafbat.ui.serdes;

import io.kafbat.ui.serde.api.Serde;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
import lombok.RequiredArgsConstructor;
Expand All @@ -19,7 +20,7 @@ public ProducerRecord<byte[], byte[]> create(String topic,
@Nullable Integer partition,
@Nullable String key,
@Nullable String value,
@Nullable Map<String, String> headers) {
@Nullable Map<String, List<String>> headers) {
return new ProducerRecord<>(
topic,
partition,
Expand All @@ -29,10 +30,14 @@ public ProducerRecord<byte[], byte[]> create(String topic,
);
}

private Iterable<Header> createHeaders(Map<String, String> clientHeaders) {
private Iterable<Header> createHeaders(Map<String, List<String>> clientHeaders) {
RecordHeaders headers = new RecordHeaders();
clientHeaders.forEach((k, v) -> headers.add(new RecordHeader(k, v == null ? null : v.getBytes())));
clientHeaders.forEach((k, values) -> values.forEach(v -> headers.add(createRecord(k, v))));
return headers;
}

private RecordHeader createRecord(String key, String value) {
return new RecordHeader(key, value == null ? null : value.getBytes());
}

}
22 changes: 14 additions & 8 deletions api/src/test/java/io/kafbat/ui/emitter/MessageFiltersTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,17 @@ void returnsTrueWhenStringContainedInKeyOrContentOrHeadersOrInAllThree() {
);

assertTrue(
filter.test(msg().key("dfg").content("does-not-contain").headers(Map.of("abC", "value")))
filter.test(msg().key("dfg").content("does-not-contain").headers(Map.of("abC", List.of("value"))))
);

assertTrue(
filter.test(msg().key("dfg").content("does-not-contain").headers(Map.of("x1", "some abC")))
filter.test(msg().key("dfg").content("does-not-contain").headers(Map.of("x1", List.of("some abC"))))
);

assertTrue(
filter.test(msg().key("dfg")
.content("does-not-contain")
.headers(Map.of("x1", List.of("does-not-contain", "some abC"))))
);
}

Expand All @@ -65,7 +71,7 @@ void returnsFalseOtherwise() {
);

assertFalse(
filter.test(msg().key("aBc").content("AbC").headers(Map.of("abc", "value")))
filter.test(msg().key("aBc").content("AbC").headers(Map.of("abc", List.of("value"))))
);

}
Expand Down Expand Up @@ -97,12 +103,12 @@ void canCheckOffset() {

@Test
void canCheckHeaders() {
var f = celScriptFilter("record.headers.size() == 2 && record.headers['k1'] == 'v1'");
assertTrue(f.test(msg().headers(Map.of("k1", "v1", "k2", "v2"))));
assertFalse(f.test(msg().headers(Map.of("k1", "unexpected", "k2", "v2"))));
var f = celScriptFilter("record.headers.size() == 2 && record.headers['k1'] == ['v1']");
assertTrue(f.test(msg().headers(Map.of("k1", List.of("v1"), "k2", List.of("v2")))));
assertFalse(f.test(msg().headers(Map.of("k1", List.of("unexpected"), "k2", List.of("v2")))));

f = celScriptFilter("record.headers.size() == 1 && !has(record.headers.k1) && record.headers['k2'] == 'v2'");
assertTrue(f.test(msg().headers(Map.of("k2", "v2"))));
f = celScriptFilter("record.headers.size() == 1 && !has(record.headers.k1) && record.headers['k2'] == ['v2']");
assertTrue(f.test(msg().headers(Map.of("k2", List.of("v2")))));

f = celScriptFilter("!has(record.headers) || record.headers.size() == 0");
assertTrue(f.test(msg().headers(Map.of())));
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
package io.kafbat.ui.serdes;

import static io.kafbat.ui.serde.api.DeserializeResult.Type.STRING;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import io.kafbat.ui.model.TopicMessageDTO;
import io.kafbat.ui.serde.api.DeserializeResult;
import io.kafbat.ui.serde.api.Serde;
import java.util.List;
import java.util.Map;
import java.util.function.UnaryOperator;
import org.apache.kafka.clients.consumer.ConsumerRecord;
Expand All @@ -22,9 +25,50 @@ void dataMaskingAppliedOnDeserializedMessage() {
Serde.Deserializer deser = (headers, data) -> new DeserializeResult("test", STRING, Map.of());

var recordDeser = new ConsumerRecordDeserializer("test", deser, "test", deser, "test", deser, deser, maskerMock);
recordDeser.deserialize(new ConsumerRecord<>("t", 1, 1L, Bytes.wrap("t".getBytes()), Bytes.wrap("t".getBytes())));
recordDeser.deserialize(record());

verify(maskerMock).apply(any(TopicMessageDTO.class));
}

@Test
void deserializeWithMultipleHeaderValues() {
UnaryOperator<TopicMessageDTO> maskerMock = mock();
when(maskerMock.apply(any(TopicMessageDTO.class))).thenAnswer(invocation -> invocation.getArgument(0));
Serde.Deserializer deser = (headers, data) -> new DeserializeResult("test", STRING, Map.of());

var recordDeser = new ConsumerRecordDeserializer("test", deser, "test", deser, "test", deser, deser, maskerMock);
ConsumerRecord<Bytes, Bytes> record = record();
record.headers().add("headerKey", "headerValue1".getBytes());
record.headers().add("headerKey", "headerValue2".getBytes());
TopicMessageDTO message = recordDeser.deserialize(record);

Map<String, List<String>> headers = message.getHeaders();
assertEquals(1, headers.size());
assertEquals(List.of("headerValue1", "headerValue2"), headers.get("headerKey"));
}

@Test
void deserializeWithMixedSingleAndMultipleHeaderValues() {
UnaryOperator<TopicMessageDTO> maskerMock = mock();
when(maskerMock.apply(any(TopicMessageDTO.class))).thenAnswer(invocation -> invocation.getArgument(0));
Serde.Deserializer deser = (headers, data) -> new DeserializeResult("test", STRING, Map.of());

var recordDeser = new ConsumerRecordDeserializer("test", deser, "test", deser, "test", deser, deser, maskerMock);
ConsumerRecord<Bytes, Bytes> record = record();
record.headers().add("headerKey1", "singleValue".getBytes());
record.headers().add("headerKey2", "multiValue1".getBytes());
record.headers().add("headerKey2", "multiValue2".getBytes());
TopicMessageDTO message = recordDeser.deserialize(record);

Map<String, List<String>> headers = message.getHeaders();
assertEquals(1, headers.get("headerKey1").size());
assertEquals(List.of("singleValue"), headers.get("headerKey1"));
assertEquals(2, headers.get("headerKey2").size());
assertEquals(List.of("multiValue1", "multiValue2"), headers.get("headerKey2"));
}

private ConsumerRecord<Bytes, Bytes> record() {
return new ConsumerRecord<>("t", 1, 1L, Bytes.wrap("t".getBytes()), Bytes.wrap("t".getBytes()));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package io.kafbat.ui.serdes;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.mockito.Mockito.mock;

import io.kafbat.ui.serde.api.Serde;
import java.util.List;
import java.util.Map;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.header.internals.RecordHeader;
import org.junit.jupiter.api.Test;

class ProducerRecordCreatorTest {

@Test
void createWithHeaders() {
Serde.Serializer keySerializer = mock(Serde.Serializer.class);
Serde.Serializer valueSerializer = mock(Serde.Serializer.class);

ProducerRecordCreator recordCreator = new ProducerRecordCreator(keySerializer, valueSerializer);
Map<String, List<String>> headers = Map.of(
"headerKey1", List.of("headerValue1"),
"headerKey2", List.of("headerValue2", "headerValue3")
);
ProducerRecord<byte[], byte[]> record = recordCreator.create("topic", 1, "key", "value", headers);

assertNotNull(record.headers());
assertEquals(3, record.headers().toArray().length);
assertThat(record.headers()).containsExactlyInAnyOrder(
new RecordHeader("headerKey1", "headerValue1".getBytes()),
new RecordHeader("headerKey2", "headerValue2".getBytes()),
new RecordHeader("headerKey2", "headerValue3".getBytes())
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ void execSmartFilterTestReturnsExecutionResult() {
+ "&& has(record.timestampMs) && has(record.offset)")
.key("1234")
.value("{ \"some\" : \"value\" } ")
.headers(Map.of("h1", "hv1"))
.headers(Map.of("h1", List.of("hv1")))
.offset(12345L)
.timestampMs(System.currentTimeMillis())
.partition(1);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ void topicMessageMetadataJson() {
.keySerde(SchemaRegistrySerde.name())
.content(JSON_SCHEMA_RECORD)
.valueSerde(SchemaRegistrySerde.name())
.headers(Map.of("header1", "value1"))
.headers(Map.of("header1", List.of("value1")))
)
.doAssert(polled -> {
assertJsonEqual(polled.getKey(), JSON_SCHEMA_RECORD);
Expand All @@ -438,9 +438,9 @@ void headerValueNullPresentTest() {
.keySerde(SchemaRegistrySerde.name())
.content(JSON_SCHEMA_RECORD)
.valueSerde(SchemaRegistrySerde.name())
.headers(Collections.singletonMap("header123", null))
.headers(Collections.singletonMap("header123", Collections.singletonList(null)))
)
.doAssert(polled -> assertThat(polled.getHeaders().get("header123")).isNull());
.doAssert(polled -> assertThat(polled.getHeaders().get("header123")).containsExactly((String) null));
}


Expand Down
12 changes: 9 additions & 3 deletions contract/src/main/resources/swagger/kafbat-ui-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3004,7 +3004,9 @@ components:
headers:
type: object
additionalProperties:
type: string
type: array
items:
type: string
partition:
type: integer
offset:
Expand Down Expand Up @@ -3033,7 +3035,9 @@ components:
headers:
type: object
additionalProperties:
type: string
type: array
items:
type: string
content:
type: string
nullable: true
Expand Down Expand Up @@ -3123,7 +3127,9 @@ components:
headers:
type: object
additionalProperties:
type: string
type: array
items:
type: string
content:
type: string
keyFormat:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const InfoModal: React.FC<InfoModalProps> = ({ toggleIsOpen }) => {
<S.ListItem>value (json if possible)</S.ListItem>
<S.ListItem>keyAsText</S.ListItem>
<S.ListItem>valueAsText</S.ListItem>
<S.ListItem>header</S.ListItem>
<S.ListItem>headers</S.ListItem>
<S.ListItem>partition</S.ListItem>
<S.ListItem>timestampMs</S.ListItem>
</ol>
Expand Down Expand Up @@ -51,7 +51,7 @@ const InfoModal: React.FC<InfoModalProps> = ({ toggleIsOpen }) => {
<S.ListItem>
<code>
record.headers.size() == 1 && !has(record.headers.k1) &&
record.headers[&apos;k2&apos;] == &apos;v2&apos;
&apos;v2&apos; in record.headers[&apos;k2&apos;]
</code>
</S.ListItem>
</ol>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type Tab = 'key' | 'content' | 'headers';
export interface MessageContentProps {
messageKey?: string;
messageContent?: string;
headers?: { [key: string]: string | undefined };
headers?: { [key: string]: string[] | undefined };
timestamp?: Date;
timestampType?: TopicMessageTimestampTypeEnum;
keySize?: number;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const setupWrapper = (props?: Partial<MessageContentProps>) => {
<MessageContent
messageKey='"test-key"'
messageContent='{"data": "test"}'
headers={{ header: 'test' }}
headers={{ header1: ['test'], header2: ['value1', 'value2'] }}
timestamp={new Date(0)}
timestampType={TopicMessageTimestampTypeEnum.CREATE_TIME}
keySerde="SchemaRegistry"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ describe('Message component', () => {
key: 'test-key',
partition: 6,
content: '{"data": "test"}',
headers: { header: 'test' },
headers: { header: ['test'] },
};
const mockKeyFilters: PreviewFilter = {
field: 'sub',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,13 @@ export const FlexItem = styled.div`
width: 100%;
}
`;
export const Headers = styled.div`
display: flex;
align-items: center;

svg {
margin-left: 8px;
vertical-align: middle;
cursor: pointer;
}
`;
Loading
Loading