Skip to content

grpc custom metadata passthrough implementation #1097

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
jfallows merged 14 commits into from
Jul 16, 2024
Merged

grpc custom metadata passthrough implementation #1097

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1830d79
grpc custom metadata passthrough implementation
ankitk-me Jun 13, 2024
cf715fc
script update & extract and pass response metadata implementation update
ankitk-me Jun 25, 2024
94959b2
race condition fix
ankitk-me Jun 26, 2024
ca5030a
Make the scripts deterministic
akrambek Jun 26, 2024
eae0881
Produce IT fix
ankitk-me Jun 26, 2024
609b18f
kafka-grpc metadata pass through
ankitk-me Jun 28, 2024
50a36d8
addressing review comment
ankitk-me Jun 29, 2024
fbad7fa
GrpcFunctions matcher bug fix & binary metadata IT
ankitk-me Jul 4, 2024
2cbff6c
addressing review comments
ankitk-me Jul 9, 2024
0d7af5b
`grpc-kafka` fetch changes
ankitk-me Jul 10, 2024
44e97f4
Prevent overwrite of write buffer when encoding progress
jfallows Jul 16, 2024
6ff7bc0
addressing review comments
ankitk-me Jul 16, 2024
9b85d7f
adding EMPTY_HEADERS constant
ankitk-me Jul 16, 2024
7f42557
build fix
ankitk-me Jul 16, 2024
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
Prev Previous commit
Next Next commit
addressing review comments
  • Loading branch information
@ankitk-me
ankitk-me committed Jul 9, 2024
commit 2cbff6c06ea56c3d48c88ec3dc6e1029b251d97a
31 changes: 16 additions & 15 deletions ...aklivity/zilla/runtime/binding/grpc/kafka/internal/config/GrpcKafkaWithProduceResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,15 @@
import io.aklivity.zilla.runtime.binding.grpc.kafka.internal.types.OctetsFW;
import io.aklivity.zilla.runtime.binding.grpc.kafka.internal.types.String16FW;
import io.aklivity.zilla.runtime.binding.grpc.kafka.internal.types.stream.GrpcMetadataFW;
import io.aklivity.zilla.runtime.binding.grpc.kafka.internal.types.stream.GrpcType;

public class GrpcKafkaWithProduceResult
{
public static final String META_PREFIX = "meta:";
public static final String BIN_SUFFIX = "-bin";
private static final int META_PREFIX_LENGTH = 5;
private static final int BIN_SUFFIX_LENGTH = 4;

private static final int META_PREFIX_LENGTH = META_PREFIX.length();
private static final int BIN_SUFFIX_LENGTH = BIN_SUFFIX.length();

private static final KafkaOffsetFW KAFKA_OFFSET_HISTORICAL =
new KafkaOffsetFW.Builder()
Expand All @@ -60,7 +62,7 @@ public class GrpcKafkaWithProduceResult
private final String16FW service;
private final String16FW method;
private final Array32FW<GrpcMetadataFW> metadata;
private final ExpandableDirectByteBuffer buffer;
private final ExpandableDirectByteBuffer nameBuffer;

GrpcKafkaWithProduceResult(
String16FW service,
Expand All @@ -84,8 +86,8 @@ public class GrpcKafkaWithProduceResult
this.acks = acks;
this.keyRef = keyRef;
this.hash = hash;
this.buffer = new ExpandableDirectByteBuffer();
this.buffer.putStringWithoutLengthAscii(0, META_PREFIX);
this.nameBuffer = new ExpandableDirectByteBuffer();
this.nameBuffer.putStringWithoutLengthAscii(0, META_PREFIX);

hash.updateHash(correlation.service.value());
hash.updateHash(service.value());
Expand Down Expand Up @@ -162,19 +164,18 @@ private void metadata(
KafkaHeaderFW.Builder builder,
GrpcMetadataFW metadata)
{
int nameLen = metadata.nameLen();
int nameLenWithPrefix = nameLen + META_PREFIX_LENGTH;
buffer.putBytes(META_PREFIX_LENGTH, metadata.name().value(), 0, nameLen);

if (metadata.type().get() == BASE64)
GrpcType type = metadata.type().get();
DirectBuffer name = metadata.name().value();
int nameLen = META_PREFIX_LENGTH + metadata.nameLen();
nameBuffer.putBytes(META_PREFIX_LENGTH, name, 0, name.capacity());
if (type == BASE64)
{
buffer.putStringWithoutLengthAscii(nameLenWithPrefix, BIN_SUFFIX);
nameLenWithPrefix += BIN_SUFFIX_LENGTH;
nameBuffer.putStringWithoutLengthAscii(nameLen, BIN_SUFFIX);
nameLen += BIN_SUFFIX_LENGTH;
}

builder
.nameLen(nameLenWithPrefix)
.name(buffer, 0, nameLenWithPrefix)
.nameLen(nameLen)
.name(nameBuffer, 0, nameLen)
.valueLen(metadata.valueLen())
.value(metadata.value().value(), 0, metadata.valueLen());
}
Expand Down
27 changes: 14 additions & 13 deletions ...a/io/aklivity/zilla/runtime/binding/grpc/kafka/internal/stream/GrpcKafkaProxyFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,10 @@ public final class GrpcKafkaProxyFactory implements GrpcKafkaStreamFactory
{
private static final String GRPC_TYPE_NAME = "grpc";
private static final String KAFKA_TYPE_NAME = "kafka";
private static final int META_PREFIX_LENGTH = 5;
private static final byte[] META_PREFIX = "meta:".getBytes();
private static final byte[] BIN_SUFFIX = "-bin".getBytes();
private static final int META_PREFIX_LENGTH = META_PREFIX.length;
private static final int BIN_SUFFIX_LENGTH = BIN_SUFFIX.length;

private static final int DATA_FLAG_INIT = 0x02;
private static final int DATA_FLAG_FIN = 0x01;
Expand All @@ -82,8 +83,8 @@ public final class GrpcKafkaProxyFactory implements GrpcKafkaStreamFactory
private static final String16FW HEADER_VALUE_GRPC_ABORTED = new String16FW("10");
private static final String16FW HEADER_VALUE_GRPC_INTERNAL_ERROR = new String16FW("13");

private final byte[] headerPrefix = new byte[5];
private final byte[] headerSuffix = new byte[4];
private final byte[] headerPrefix = new byte[META_PREFIX_LENGTH];
private final byte[] headerSuffix = new byte[BIN_SUFFIX_LENGTH];

private final Varuint32FW.Builder lenRW =
new Varuint32FW.Builder().wrap(new UnsafeBuffer(new byte[1024 * 8]), 0, 1024 * 8);;
Expand Down Expand Up @@ -1430,21 +1431,21 @@ private void doGrpcBegin(
headers.forEach(h ->
{
final OctetsFW name = h.name();
final DirectBuffer buffer = name.buffer();
final int offset = name.offset();
final int limit = name.limit();

name.buffer().getBytes(offset, headerPrefix);
name.buffer().getBytes(limit - BIN_SUFFIX.length, headerSuffix);

buffer.getBytes(offset, headerPrefix);
buffer.getBytes(limit - BIN_SUFFIX.length, headerSuffix);
if (Arrays.equals(META_PREFIX, headerPrefix))
{
final GrpcType type = Arrays.equals(BIN_SUFFIX, headerSuffix) ? BASE64 : TEXT;
int length = h.nameLen() - META_PREFIX_LENGTH;
final int metadataNameLength = type == BASE64 ? length - BIN_SUFFIX.length : length;

builder.item(m -> m.type(t -> t.set(type))
.nameLen(metadataNameLength)
.name(h.name().value(), META_PREFIX_LENGTH, metadataNameLength)
final int nameLen = type == BASE64
? h.nameLen() - META_PREFIX_LENGTH - BIN_SUFFIX_LENGTH
: h.nameLen() - META_PREFIX_LENGTH;
builder.item(m -> m
.type(t -> t.set(type))
.nameLen(nameLen)
.name(name.value(), META_PREFIX_LENGTH, nameLen)
.valueLen(h.valueLen())
.value(h.value()));
}
Expand Down
32 changes: 19 additions & 13 deletions ...aklivity/zilla/runtime/binding/kafka/grpc/internal/stream/KafkaGrpcFetchHeaderHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.util.Map;
import java.util.function.Consumer;

import org.agrona.DirectBuffer;
import org.agrona.MutableDirectBuffer;

import io.aklivity.zilla.runtime.binding.kafka.grpc.config.KafkaGrpcCorrelationConfig;
Expand All @@ -36,9 +37,10 @@

public final class KafkaGrpcFetchHeaderHelper
{
private static final int META_PREFIX_LENGTH = 5;
private static final byte[] META_PREFIX = "meta:".getBytes();
private static final byte[] BIN_SUFFIX = "-bin".getBytes();
private static final int META_PREFIX_LENGTH = META_PREFIX.length;
private static final int BIN_SUFFIX_LENGTH = BIN_SUFFIX.length;

private final Map<OctetsFW, Consumer<OctetsFW>> visitors;
private final OctetsFW serviceRO = new OctetsFW();
Expand All @@ -48,8 +50,8 @@ public final class KafkaGrpcFetchHeaderHelper
private final Array32FW.Builder<GrpcMetadataFW.Builder, GrpcMetadataFW> grpcMetadataRW =
new Array32FW.Builder<>(new GrpcMetadataFW.Builder(), new GrpcMetadataFW());
private final MutableDirectBuffer metaBuffer;
private final byte[] headerPrefix = new byte[5];
private final byte[] headerSuffix = new byte[4];
private final byte[] headerPrefix = new byte[META_PREFIX_LENGTH];
private final byte[] headerSuffix = new byte[BIN_SUFFIX_LENGTH];

public int partitionId;
public long partitionOffset;
Expand All @@ -60,6 +62,8 @@ public final class KafkaGrpcFetchHeaderHelper
public OctetsFW correlationId;
public Array32FW<GrpcMetadataFW> metadata;

private Array32FW.Builder<GrpcMetadataFW.Builder, GrpcMetadataFW> builder;

public KafkaGrpcFetchHeaderHelper(
KafkaGrpcCorrelationConfig correlation,
MutableDirectBuffer metaBuffer)
Expand All @@ -85,7 +89,7 @@ public void visit(
replyTo = null;
correlationId = null;

grpcMetadataRW.wrap(metaBuffer, 0, metaBuffer.capacity());
builder = grpcMetadataRW.wrap(metaBuffer, 0, metaBuffer.capacity());

if (dataEx != null)
{
Expand Down Expand Up @@ -114,11 +118,11 @@ private boolean dispatch(
{
final OctetsFW name = header.name();
final OctetsFW value = header.value();
final DirectBuffer buffer = name.buffer();
final int offset = name.offset();
final int limit = name.limit();

name.buffer().getBytes(offset, headerPrefix);
name.buffer().getBytes(limit - BIN_SUFFIX.length, headerSuffix);
buffer.getBytes(offset, headerPrefix);
buffer.getBytes(limit - BIN_SUFFIX_LENGTH, headerSuffix);

Comment thread
ankitk-me marked this conversation as resolved.
final Consumer<OctetsFW> visitor = visitors.get(name);
if (visitor != null)
Expand All @@ -128,13 +132,15 @@ private boolean dispatch(
else if (Arrays.equals(META_PREFIX, headerPrefix))
{
final GrpcType type = Arrays.equals(BIN_SUFFIX, headerSuffix) ? BASE64 : TEXT;
int length = header.nameLen() - META_PREFIX_LENGTH;
final int metadataNameLength = type == BASE64 ? length - BIN_SUFFIX.length : length;
grpcMetadataRW.item(m -> m.type(t -> t.set(type))
.nameLen(metadataNameLength)
.name(name.value(), META_PREFIX_LENGTH, metadataNameLength)
final int nameLen = type == BASE64
? header.nameLen() - META_PREFIX_LENGTH - BIN_SUFFIX_LENGTH
: header.nameLen() - META_PREFIX_LENGTH;
builder.item(m -> m
.type(t -> t.set(type))
.nameLen(nameLen)
.name(name.value(), META_PREFIX_LENGTH, nameLen)
.valueLen(header.valueLen())
.value(value));
.value(header.value()));
}
Comment thread
ankitk-me marked this conversation as resolved.

return service != null &&
Expand Down
30 changes: 15 additions & 15 deletions ...livity/zilla/runtime/binding/kafka/grpc/internal/stream/KafkaGrpcRemoteServerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.GrpcDataExFW;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.GrpcMetadataFW;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.GrpcResetExFW;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.GrpcType;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.KafkaBeginExFW;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.KafkaDataExFW;
import io.aklivity.zilla.runtime.binding.kafka.grpc.internal.types.stream.KafkaFlushExFW;
Expand All @@ -79,8 +80,8 @@ public final class KafkaGrpcRemoteServerFactory implements KafkaGrpcStreamFactor
private static final String KAFKA_TYPE_NAME = "kafka";
private static final String META_PREFIX = "meta:";
private static final String BIN_SUFFIX = "-bin";
private static final int META_PREFIX_LENGTH = 5;
private static final int BIN_SUFFIX_LENGTH = 4;
private static final int META_PREFIX_LENGTH = META_PREFIX.length();
private static final int BIN_SUFFIX_LENGTH = BIN_SUFFIX.length();

private static final int SIGNAL_INITIATE_KAFKA_STREAM = 1;
private static final int GRPC_QUEUE_MESSAGE_PADDING = 3 * 256 + 33;
Expand Down Expand Up @@ -138,6 +139,7 @@ public final class KafkaGrpcRemoteServerFactory implements KafkaGrpcStreamFactor
private final MutableDirectBuffer writeBuffer;
private final MutableDirectBuffer extBuffer;
private final MutableDirectBuffer metaBuffer;
private final ExpandableDirectByteBuffer nameBuffer;
private final BindingHandler streamFactory;
private final LongUnaryOperator supplyInitialId;
private final LongUnaryOperator supplyReplyId;
Expand Down Expand Up @@ -177,6 +179,8 @@ public KafkaGrpcRemoteServerFactory(
this.grpcTypeId = context.supplyTypeId(GRPC_TYPE_NAME);
this.kafkaTypeId = context.supplyTypeId(KAFKA_TYPE_NAME);
this.groupIdFormat = config.groupIdFormat();
this.nameBuffer = new ExpandableDirectByteBuffer();
this.nameBuffer.putStringWithoutLengthAscii(0, META_PREFIX);
}

@Override
Expand Down Expand Up @@ -1335,7 +1339,6 @@ private final class GrpcClient
private final KafkaRemoteServer server;
private final KafkaCorrelateProxy correlater;
private final OctetsFW correlationId;
private final ExpandableDirectByteBuffer buffer;
private final long originId;
private final long routedId;
private final long initialId;
Expand Down Expand Up @@ -1373,8 +1376,6 @@ private GrpcClient(
this.initialId = supplyInitialId.applyAsLong(routedId);
this.replyId = supplyReplyId.applyAsLong(initialId);
this.correlater = new KafkaCorrelateProxy(originId, resolveId, replyTo, server.condition, this);
this.buffer = new ExpandableDirectByteBuffer();
this.buffer.putStringWithoutLengthAscii(0, META_PREFIX);
}

private int initialPendingAck()
Expand Down Expand Up @@ -1717,19 +1718,18 @@ private void metadata(
KafkaHeaderFW.Builder builder,
GrpcMetadataFW metadata)
{
int nameLen = metadata.nameLen();
int nameLenWithPrefix = nameLen + META_PREFIX_LENGTH;
buffer.putBytes(META_PREFIX_LENGTH, metadata.name().value(), 0, nameLen);

if (metadata.type().get() == BASE64)
GrpcType type = metadata.type().get();
DirectBuffer name = metadata.name().value();
int nameLen = META_PREFIX_LENGTH + metadata.nameLen();
nameBuffer.putBytes(META_PREFIX_LENGTH, name, 0, name.capacity());
if (type == BASE64)
{
buffer.putStringWithoutLengthAscii(nameLenWithPrefix, BIN_SUFFIX);
nameLenWithPrefix += BIN_SUFFIX_LENGTH;
nameBuffer.putStringWithoutLengthAscii(nameLen, BIN_SUFFIX);
nameLen += BIN_SUFFIX_LENGTH;
}

builder
.nameLen(nameLenWithPrefix)
.name(buffer, 0, nameLenWithPrefix)
.nameLen(nameLen)
.name(nameBuffer, 0, nameLen)
.valueLen(metadata.valueLen())
.value(metadata.value().value(), 0, metadata.valueLen());
}
Expand Down
2 changes: 1 addition & 1 deletion ...o/aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/bidi.stream.rpc/client.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ write zilla:begin.ext ${grpc:beginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoBidiStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...o/aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/bidi.stream.rpc/server.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ read zilla:begin.ext ${grpc:matchBeginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoBidiStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/client.stream.rpc/client.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ write zilla:begin.ext ${grpc:beginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoClientStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/client.stream.rpc/server.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ read zilla:begin.ext ${grpc:matchBeginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoClientStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/server.stream.rpc/client.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ write zilla:begin.ext ${grpc:beginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoServerStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}

Expand Down
2 changes: 1 addition & 1 deletion ...aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/server.stream.rpc/server.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ read zilla:begin.ext ${grpc:matchBeginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoServerStream")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...ipts/io/aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/unary.rpc/client.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ write zilla:begin.ext ${grpc:beginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoUnary")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
2 changes: 1 addition & 1 deletion ...ipts/io/aklivity/zilla/specs/binding/grpc/kafka/streams/grpc/produce/unary.rpc/server.rpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ read zilla:begin.ext ${grpc:matchBeginEx()
.authority("localhost:8080")
.service("example.EchoService")
.method("EchoUnary")
.metadata("BASE64", "custom", "dGVzdA==")
.metadataBase64("custom", "dGVzdA==")
.metadata("idempotency-key", "59410e57-3e0f-4b61-9328-f645a7968ac8")
.build()}
connected
Expand Down
Loading