Skip to content

[refactor][java] Improve docs and code quality about KeyValueSchema usages #17256

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
codelipenghui merged 2 commits into from
Nov 16, 2022
Merged

[refactor][java] Improve docs and code quality about KeyValueSchema usages #17256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03e26e2
[refactor][java] Improve docs and code quality about KeyValueSchema u…
BewareMyPower Aug 24, 2022
9058334
Fix TypedMessageBuilderImplTest
BewareMyPower Aug 24, 2022
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
6 changes: 4 additions & 2 deletions pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Schema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,10 +384,12 @@ static <K, V> Schema<KeyValue<K, V>> KeyValue(Class<K> key, Class<V> value) {
}

/**
* Key Value Schema using passed in key and value schemas.
* Key Value Schema using passed in key and value schemas with {@link KeyValueEncodingType#INLINE} encoding type.
*
* @see Schema#KeyValue(Schema, Schema, KeyValueEncodingType)
*/
static <K, V> Schema<KeyValue<K, V>> KeyValue(Schema<K> key, Schema<V> value) {
return DefaultImplementation.getDefaultImplementation().newKeyValueSchema(key, value);
return KeyValue(key, value, KeyValueEncodingType.INLINE);
}

/**
Expand Down
2 changes: 0 additions & 2 deletions ...pi/src/main/java/org/apache/pulsar/client/internal/PulsarClientImplementationBinding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,6 @@ <T extends com.google.protobuf.GeneratedMessageV3> Schema<T> newProtobufNativeSc

Schema<KeyValue<byte[], byte[]>> newKeyValueBytesSchema();

<K, V> Schema<KeyValue<K, V>> newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema);

<K, V> Schema<KeyValue<K, V>> newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema,
KeyValueEncodingType keyValueEncodingType);

Expand Down
4 changes: 0 additions & 4 deletions ...nt/src/main/java/org/apache/pulsar/client/impl/PulsarClientImplementationBindingImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,10 +242,6 @@ public Schema<KeyValue<byte[], byte[]>> newKeyValueBytesSchema() {
return KeyValueSchemaImpl.kvBytes();
}

public <K, V> Schema<KeyValue<K, V>> newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema) {
return KeyValueSchemaImpl.of(keySchema, valueSchema);
}

public <K, V> Schema<KeyValue<K, V>> newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema,
KeyValueEncodingType keyValueEncodingType) {
return KeyValueSchemaImpl.of(keySchema, valueSchema, keyValueEncodingType);
Expand Down
98 changes: 58 additions & 40 deletions pulsar-client/src/main/java/org/apache/pulsar/client/impl/TypedMessageBuilderImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,15 @@
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.apache.pulsar.client.api.Message;
import org.apache.pulsar.client.api.MessageId;
import org.apache.pulsar.client.api.PulsarClientException;
import org.apache.pulsar.client.api.Schema;
import org.apache.pulsar.client.api.TypedMessageBuilder;
import org.apache.pulsar.client.impl.schema.KeyValueSchemaImpl;
import org.apache.pulsar.client.api.schema.KeyValueSchema;
import org.apache.pulsar.client.impl.transaction.TransactionImpl;
import org.apache.pulsar.common.api.proto.MessageMetadata;
import org.apache.pulsar.common.schema.KeyValueEncodingType;
Expand Down Expand Up @@ -105,14 +106,12 @@ public CompletableFuture<MessageId> sendAsync() {

@Override
public TypedMessageBuilder<T> key(String key) {
if (schema.getSchemaInfo().getType() == SchemaType.KEY_VALUE) {
KeyValueSchemaImpl kvSchema = (KeyValueSchemaImpl) schema;
checkArgument(kvSchema.getKeyValueEncodingType() != KeyValueEncodingType.SEPARATED,
"This method is not allowed to set keys when in encoding type is SEPARATED");
if (key == null) {
msgMetadata.setNullPartitionKey(true);
return this;
}
getKeyValueSchema().ifPresent(keyValueSchema -> checkArgument(

@asafm asafm Oct 3, 2022

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.

While you're here, can you explain why when the schema is KeyValue, and the encoding is SEPARATED, it is forbidden to use this method to se the key of the message?

@BewareMyPower BewareMyPower Oct 4, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because when the encoding is SEPARATED, the partition key should be set by a KeyValue object.

Producer<KeyValue<String, String>> producer = client.newProducer(
                Schema.KeyValue(Schema.STRING, Schema.STRING, KeyValueEncodingType.SEPARATED))
        .topic("my-topic")
        .create();
producer.newMessage().value(new KeyValue<>("key", "value")).send()

With the SEPARATED key value encoding type, the code above will send a message whose partition key is "key" and value is "value". If it's allowed to set the partition key here, conflicts will happen.

There is no design of the key value schema, I just guessed the reason why key and keyBytes methods are forbidden and followed the previous behavior in this PR

@asafm asafm Oct 6, 2022

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.

I don't understand why.
Why can't we do

.newMessage() // this creates a builder
.key(theKey)
.value(theValue)
.send()

@BewareMyPower BewareMyPower Oct 6, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because the schema type is Schema<KeyValue<K, V>>, the value's type must be KeyValue<K, V>, then the code will look like:

.key("key")
.value(new KeyValue<>("key-1", "value"))

The root cause is that Pulsar only stores the schema of the value. So it can only support key schema by passing a pair of "key" and "value" as the whole value.

keyValueSchema.getKeyValueEncodingType() != KeyValueEncodingType.SEPARATED,
"This method is not allowed to set keys when in encoding type is SEPARATED"));
if (key == null) {
msgMetadata.setNullPartitionKey(true);
return this;
}
msgMetadata.setPartitionKey(key);
msgMetadata.setPartitionKeyB64Encoded(false);
Expand All @@ -121,14 +120,12 @@ public TypedMessageBuilder<T> key(String key) {

@Override
public TypedMessageBuilder<T> keyBytes(byte[] key) {
if (schema instanceof KeyValueSchemaImpl && schema.getSchemaInfo().getType() == SchemaType.KEY_VALUE) {
KeyValueSchemaImpl kvSchema = (KeyValueSchemaImpl) schema;
checkArgument(!(kvSchema.getKeyValueEncodingType() == KeyValueEncodingType.SEPARATED),
"This method is not allowed to set keys when in encoding type is SEPARATED");
if (key == null) {
msgMetadata.setNullPartitionKey(true);
return this;
}
getKeyValueSchema().ifPresent(keyValueSchema -> checkArgument(
keyValueSchema.getKeyValueEncodingType() != KeyValueEncodingType.SEPARATED,
"This method is not allowed to set keys when in encoding type is SEPARATED"));
if (key == null) {
msgMetadata.setNullPartitionKey(true);
return this;
}
msgMetadata.setPartitionKey(Base64.getEncoder().encodeToString(key));
msgMetadata.setPartitionKeyB64Encoded(true);
Expand All @@ -147,31 +144,18 @@ public TypedMessageBuilder<T> value(T value) {
msgMetadata.setNullValue(true);
return this;
}
if (value instanceof org.apache.pulsar.common.schema.KeyValue
&& schema.getSchemaInfo() != null && schema.getSchemaInfo().getType() == SchemaType.KEY_VALUE) {
KeyValueSchemaImpl kvSchema = (KeyValueSchemaImpl) schema;
org.apache.pulsar.common.schema.KeyValue kv = (org.apache.pulsar.common.schema.KeyValue) value;
if (kvSchema.getKeyValueEncodingType() == KeyValueEncodingType.SEPARATED) {
// set key as the message key
if (kv.getKey() != null) {
msgMetadata.setPartitionKey(
Base64.getEncoder().encodeToString(kvSchema.getKeySchema().encode(kv.getKey())));
msgMetadata.setPartitionKeyB64Encoded(true);
} else {
this.msgMetadata.setNullPartitionKey(true);
}

// set value as the payload
if (kv.getValue() != null) {
this.content = ByteBuffer.wrap(kvSchema.getValueSchema().encode(kv.getValue()));
} else {
this.msgMetadata.setNullValue(true);
}

return getKeyValueSchema().map(keyValueSchema -> {
if (keyValueSchema.getKeyValueEncodingType() == KeyValueEncodingType.SEPARATED) {
setSeparateKeyValue(value, keyValueSchema);
return this;
} else {
return null;
}
}
this.content = ByteBuffer.wrap(schema.encode(value));
return this;
}).orElseGet(() -> {
content = ByteBuffer.wrap(schema.encode(value));
return this;
});
}

@Override
Expand Down Expand Up @@ -300,4 +284,38 @@ public String getKey() {
public ByteBuffer getContent() {
return content;
}

private Optional<KeyValueSchema<?, ?>> getKeyValueSchema() {
if (schema.getSchemaInfo() != null
&& schema.getSchemaInfo().getType() == SchemaType.KEY_VALUE
// The schema's class could also be AutoProduceBytesSchema when its type is KEY_VALUE
&& schema instanceof KeyValueSchema) {
return Optional.of((KeyValueSchema<?, ?>) schema);
} else {
return Optional.empty();
}
}

@SuppressWarnings("unchecked")
private <K, V> void setSeparateKeyValue(T value, KeyValueSchema<K, V> keyValueSchema) {
checkArgument(value instanceof org.apache.pulsar.common.schema.KeyValue);
org.apache.pulsar.common.schema.KeyValue<K, V> keyValue =
(org.apache.pulsar.common.schema.KeyValue<K, V>) value;

// set key as the message key
if (keyValue.getKey() != null) {
msgMetadata.setPartitionKey(Base64.getEncoder().encodeToString(
keyValueSchema.getKeySchema().encode(keyValue.getKey())));
msgMetadata.setPartitionKeyB64Encoded(true);
} else {
msgMetadata.setNullPartitionKey(true);
}

// set value as the payload
if (keyValue.getValue() != null) {
content = ByteBuffer.wrap(keyValueSchema.getValueSchema().encode(keyValue.getValue()));
} else {
msgMetadata.setNullValue(true);
}
}
}