junrao commented on a change in pull request #10271: URL: https://github.com/apache/kafka/pull/10271#discussion_r619545527
########## File path: storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataContext.java ########## @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.server.log.remote.metadata.storage; + +import java.util.Objects; + +/** + * The context associated with the record in remote log metadata topic. This contains api-key, and the payload object. + * <br> + * <p> + * For example: + * Remote log segment metadata record will have + * <pre> + * <ul> + * <li>api key as: {@link org.apache.kafka.server.log.remote.metadata.storage.generated.RemoteLogSegmentMetadataRecord#apiKey()} </li> + * <li>payload as: {@link org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata} </li> + * </ul> + * </pre> + * <p> + * + * You can read more details in <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-405%3A+Kafka+Tiered+Storage#KIP405:KafkaTieredStorage-MessageFormat";>KIP-405</a> + */ +public class RemoteLogMetadataContext { + private final short apiKey; Review comment: This class is now only used for holding the apiKey. We could just derive the apiKey from the specific class like RemoteLogSegmentMetadata? ########## File path: raft/src/main/java/org/apache/kafka/raft/metadata/AbstractMetadataRecordSerde.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.raft.metadata; + +import org.apache.kafka.common.errors.SerializationException; +import org.apache.kafka.common.metadata.MetadataRecordType; +import org.apache.kafka.common.protocol.ApiMessage; +import org.apache.kafka.common.protocol.ObjectSerializationCache; +import org.apache.kafka.common.protocol.Readable; +import org.apache.kafka.common.protocol.Writable; +import org.apache.kafka.common.utils.ByteUtils; +import org.apache.kafka.metadata.ApiMessageAndVersion; +import org.apache.kafka.raft.RecordSerde; + +/** + * This is an implementation of {@code RecordSerde} with {@code ApiMessageAndVersion} but implementors need to implement + * {@link #apiMessageFor(short)} to return a {@code ApiMessage} instance for the given {@code apiKey}. + * + * This can be used as the underlying serialization mechanism for any metadata kind of log storage. + */ +public abstract class AbstractMetadataRecordSerde implements RecordSerde<ApiMessageAndVersion> { Review comment: (1) AbstractMetadataRecordSerde => WritableApiMessageSerde ? (2) Also, could we remove the reference to raft in RecordSerde since it's no longer just for raft? ########## File path: storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataContext.java ########## @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.server.log.remote.metadata.storage; + +import java.util.Objects; + +/** + * The context associated with the record in remote log metadata topic. This contains api-key, and the payload object. + * <br> + * <p> + * For example: + * Remote log segment metadata record will have + * <pre> + * <ul> + * <li>api key as: {@link org.apache.kafka.server.log.remote.metadata.storage.generated.RemoteLogSegmentMetadataRecord#apiKey()} </li> + * <li>payload as: {@link org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata} </li> + * </ul> + * </pre> + * <p> + * + * You can read more details in <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-405%3A+Kafka+Tiered+Storage#KIP405:KafkaTieredStorage-MessageFormat";>KIP-405</a> + */ +public class RemoteLogMetadataContext { + private final short apiKey; + private final Object payload; Review comment: Instead of accepting arbitrary object, would it be better to have a base class like RemoteStorageMetadata for all remote log metadata? We could also use the base class to store common fields such as BrokerId and EventTimestampMs. Then, may be Serializer could just be of Serializer<RemoteStorageMetadata> instead of RemoteLogMetadataContext. ########## File path: raft/src/main/java/org/apache/kafka/raft/metadata/AbstractMetadataRecordSerde.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.raft.metadata; + +import org.apache.kafka.common.errors.SerializationException; +import org.apache.kafka.common.metadata.MetadataRecordType; +import org.apache.kafka.common.protocol.ApiMessage; +import org.apache.kafka.common.protocol.ObjectSerializationCache; +import org.apache.kafka.common.protocol.Readable; +import org.apache.kafka.common.protocol.Writable; +import org.apache.kafka.common.utils.ByteUtils; +import org.apache.kafka.metadata.ApiMessageAndVersion; +import org.apache.kafka.raft.RecordSerde; + +/** + * This is an implementation of {@code RecordSerde} with {@code ApiMessageAndVersion} but implementors need to implement + * {@link #apiMessageFor(short)} to return a {@code ApiMessage} instance for the given {@code apiKey}. + * + * This can be used as the underlying serialization mechanism for any metadata kind of log storage. + */ +public abstract class AbstractMetadataRecordSerde implements RecordSerde<ApiMessageAndVersion> { + private static final short DEFAULT_FRAME_VERSION = 0; + private static final int DEFAULT_FRAME_VERSION_SIZE = ByteUtils.sizeOfUnsignedVarint(DEFAULT_FRAME_VERSION); + + @Override + public int recordSize(ApiMessageAndVersion data, + ObjectSerializationCache serializationCache) { + int size = DEFAULT_FRAME_VERSION_SIZE; + size += ByteUtils.sizeOfUnsignedVarint(data.message().apiKey()); + size += ByteUtils.sizeOfUnsignedVarint(data.version()); + size += data.message().size(serializationCache, data.version()); + return size; + } + + @Override + public void write(ApiMessageAndVersion data, + ObjectSerializationCache serializationCache, + Writable out) { + out.writeUnsignedVarint(DEFAULT_FRAME_VERSION); + out.writeUnsignedVarint(data.message().apiKey()); + out.writeUnsignedVarint(data.version()); + data.message().write(out, serializationCache, data.version()); + } + + @Override + public ApiMessageAndVersion read(Readable input, + int size) { + short frameVersion = (short) input.readUnsignedVarint(); + if (frameVersion != DEFAULT_FRAME_VERSION) { + throw new SerializationException("Could not deserialize metadata record due to unknown frame version " + + frameVersion + "(only frame version " + DEFAULT_FRAME_VERSION + " is supported)"); + } + + short apiKey = (short) input.readUnsignedVarint(); + short version = (short) input.readUnsignedVarint(); + ApiMessage record = apiMessageFor(apiKey); + record.read(input, version); + return new ApiMessageAndVersion(record, version); + } + + /** + * Return {@code ApiMessage} instance for the given {@code apiKey}. This is used while deserializing the bytes + * payload into the respective {@code ApiMessage} in {@link #read(Readable, int)} method. + * + * @param apiKey apiKey for which a {@code ApiMessage} to be created. + */ + public abstract ApiMessage apiMessageFor(short apiKey); Review comment: Another option is for all ApiMessageAndVersion that need to be stored in a log to share the same ID space. Then, we don't need to have this method. ########## File path: raft/src/main/java/org/apache/kafka/raft/metadata/AbstractMetadataRecordSerde.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.raft.metadata; + +import org.apache.kafka.common.errors.SerializationException; +import org.apache.kafka.common.metadata.MetadataRecordType; +import org.apache.kafka.common.protocol.ApiMessage; +import org.apache.kafka.common.protocol.ObjectSerializationCache; +import org.apache.kafka.common.protocol.Readable; +import org.apache.kafka.common.protocol.Writable; +import org.apache.kafka.common.utils.ByteUtils; +import org.apache.kafka.metadata.ApiMessageAndVersion; +import org.apache.kafka.raft.RecordSerde; + +/** + * This is an implementation of {@code RecordSerde} with {@code ApiMessageAndVersion} but implementors need to implement + * {@link #apiMessageFor(short)} to return a {@code ApiMessage} instance for the given {@code apiKey}. + * + * This can be used as the underlying serialization mechanism for any metadata kind of log storage. Review comment: Could we document the serialization format in the comment? ########## File path: storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/serialization/AbstractMetadataMessageSerde.java ########## @@ -19,52 +19,41 @@ import org.apache.kafka.common.protocol.ApiMessage; import org.apache.kafka.common.protocol.ByteBufferAccessor; import org.apache.kafka.common.protocol.ObjectSerializationCache; -import org.apache.kafka.common.utils.ByteUtils; +import org.apache.kafka.common.protocol.Readable; import org.apache.kafka.metadata.ApiMessageAndVersion; - +import org.apache.kafka.raft.metadata.AbstractMetadataRecordSerde; import java.nio.ByteBuffer; /** - * This class provides serialization/deserialization of {@code ApiMessageAndVersion}. + * This class provides serialization/deserialization of {@code ApiMessageAndVersion}. This can be used as + * serialization/deserialization protocol for any metadata records derived of {@code ApiMessage}s. * <p></p> * Implementors need to extend this class and implement {@link #apiMessageFor(short)} method to return a respective * {@code ApiMessage} for the given {@code apiKey}. This is required to deserialize the bytes to build the respective * {@code ApiMessage} instance. */ -public abstract class AbstractApiMessageAndVersionSerde { +public abstract class AbstractMetadataMessageSerde { Review comment: Perhaps we can use WritableApiMessageSerde and BytesApiMessageSerde for the two classes? It would be useful to write in the comment the difference between the two. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
