chia7712 commented on code in PR #19568: URL: https://github.com/apache/kafka/pull/19568#discussion_r2073096926
########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), + /** + * Transaction has started and ongoing + * <p> + * transition: received EndTxnRequest with commit => PrepareCommit + * received EndTxnRequest with abort => PrepareAbort + * received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + */ + ONGOING((byte) 1, "Ongoing", false), + /** + * Group is preparing to commit + * transition: received acks from all partitions => CompleteCommit + */ + PREPARE_COMMIT((byte) 2, "PrepareCommit", false), + /** + * Group is preparing to abort + * <p> + * transition: received acks from all partitions => CompleteAbort + * <p> + * Note, In transaction v2, we allow Empty, CompleteCommit, CompleteAbort to transition to PrepareAbort. because the + * client may not know the txn state on the server side, it needs to send endTxn request when uncertain. + */ + PREPARE_ABORT((byte) 3, "PrepareAbort", false), + /** + * Group has completed commit + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_COMMIT((byte) 4, "CompleteCommit", true), + /** + * Group has completed abort + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_ABORT((byte) 5, "CompleteAbort", true), + /** + * TransactionalId has expired and is about to be removed from the transaction cache + */ + DEAD((byte) 6, "Dead", false), + /** + * We are in the middle of bumping the epoch and fencing out older producers. + */ + PREPARE_EPOCH_FENCE((byte) 7, "PrepareEpochFence", false); + + private static final Map<String, TransactionState> NAME_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::getName, Function.identity())); + + private static final Map<Byte, TransactionState> ID_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::id, Function.identity())); + + public static final Set<TransactionState> ALL_STATES = Collections.unmodifiableSet(EnumSet.allOf(TransactionState.class)); + + private final byte id; + private final String stateName; + // Defer initialization to static block + private Set<TransactionState> validPreviousStates; + private final boolean expirationAllowed; + + // Static block to initialize validPreviousStates after all constants are defined + static { + EMPTY.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + ONGOING.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING, EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + PREPARE_COMMIT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING)); + PREPARE_ABORT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING, PREPARE_EPOCH_FENCE, EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + COMPLETE_COMMIT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(PREPARE_COMMIT)); + COMPLETE_ABORT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(PREPARE_ABORT)); + DEAD.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(EMPTY, COMPLETE_ABORT, COMPLETE_COMMIT)); + PREPARE_EPOCH_FENCE.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING)); + } + + + TransactionState(byte id, String name, boolean expirationAllowed) { + this.id = id; + this.stateName = name; + this.expirationAllowed = expirationAllowed; + // validPreviousStates is initialized in the static block + } + + /** + * @return The state id byte. + */ + public byte id() { + return id; + } + + /** + * Get the name of this state. This is exposed through the `DescribeTransactions` API. + * @return The state name string. + */ + public String getName() { Review Comment: how about `stateName()`? ########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), Review Comment: the name is exposed by the RPC, so it would be good to ensure the naming between this and admin.TransactionState is consistent. Maybe we can use the following pattern to rewrite it? ```java EMPTY((byte) 0, org.apache.kafka.clients.admin.TransactionState.EMPTY.toString(), true), ``` ########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), + /** + * Transaction has started and ongoing + * <p> + * transition: received EndTxnRequest with commit => PrepareCommit + * received EndTxnRequest with abort => PrepareAbort + * received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + */ + ONGOING((byte) 1, "Ongoing", false), + /** + * Group is preparing to commit + * transition: received acks from all partitions => CompleteCommit + */ + PREPARE_COMMIT((byte) 2, "PrepareCommit", false), + /** + * Group is preparing to abort + * <p> + * transition: received acks from all partitions => CompleteAbort + * <p> + * Note, In transaction v2, we allow Empty, CompleteCommit, CompleteAbort to transition to PrepareAbort. because the + * client may not know the txn state on the server side, it needs to send endTxn request when uncertain. + */ + PREPARE_ABORT((byte) 3, "PrepareAbort", false), + /** + * Group has completed commit + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_COMMIT((byte) 4, "CompleteCommit", true), + /** + * Group has completed abort + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_ABORT((byte) 5, "CompleteAbort", true), + /** + * TransactionalId has expired and is about to be removed from the transaction cache + */ + DEAD((byte) 6, "Dead", false), + /** + * We are in the middle of bumping the epoch and fencing out older producers. + */ + PREPARE_EPOCH_FENCE((byte) 7, "PrepareEpochFence", false); + + private static final Map<String, TransactionState> NAME_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::getName, Function.identity())); + + private static final Map<Byte, TransactionState> ID_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::id, Function.identity())); + + public static final Set<TransactionState> ALL_STATES = Collections.unmodifiableSet(EnumSet.allOf(TransactionState.class)); + + private final byte id; + private final String stateName; + // Defer initialization to static block + private Set<TransactionState> validPreviousStates; + private final boolean expirationAllowed; + + // Static block to initialize validPreviousStates after all constants are defined + static { + EMPTY.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + ONGOING.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING, EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + PREPARE_COMMIT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING)); + PREPARE_ABORT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING, PREPARE_EPOCH_FENCE, EMPTY, COMPLETE_COMMIT, COMPLETE_ABORT)); + COMPLETE_COMMIT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(PREPARE_COMMIT)); + COMPLETE_ABORT.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(PREPARE_ABORT)); + DEAD.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(EMPTY, COMPLETE_ABORT, COMPLETE_COMMIT)); + PREPARE_EPOCH_FENCE.validPreviousStates = Collections.unmodifiableSet(EnumSet.of(ONGOING)); + } + + + TransactionState(byte id, String name, boolean expirationAllowed) { + this.id = id; + this.stateName = name; + this.expirationAllowed = expirationAllowed; + // validPreviousStates is initialized in the static block Review Comment: Could you please consider using `switch` to initialize it in the constructor? ########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), + /** + * Transaction has started and ongoing + * <p> + * transition: received EndTxnRequest with commit => PrepareCommit + * received EndTxnRequest with abort => PrepareAbort + * received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + */ + ONGOING((byte) 1, "Ongoing", false), + /** + * Group is preparing to commit + * transition: received acks from all partitions => CompleteCommit + */ + PREPARE_COMMIT((byte) 2, "PrepareCommit", false), + /** + * Group is preparing to abort + * <p> + * transition: received acks from all partitions => CompleteAbort + * <p> + * Note, In transaction v2, we allow Empty, CompleteCommit, CompleteAbort to transition to PrepareAbort. because the + * client may not know the txn state on the server side, it needs to send endTxn request when uncertain. + */ + PREPARE_ABORT((byte) 3, "PrepareAbort", false), + /** + * Group has completed commit + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_COMMIT((byte) 4, "CompleteCommit", true), + /** + * Group has completed abort + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_ABORT((byte) 5, "CompleteAbort", true), + /** + * TransactionalId has expired and is about to be removed from the transaction cache + */ + DEAD((byte) 6, "Dead", false), + /** + * We are in the middle of bumping the epoch and fencing out older producers. + */ + PREPARE_EPOCH_FENCE((byte) 7, "PrepareEpochFence", false); + + private static final Map<String, TransactionState> NAME_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::getName, Function.identity())); Review Comment: `toUnmodifiableMap` ########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), + /** + * Transaction has started and ongoing + * <p> + * transition: received EndTxnRequest with commit => PrepareCommit + * received EndTxnRequest with abort => PrepareAbort + * received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + */ + ONGOING((byte) 1, "Ongoing", false), + /** + * Group is preparing to commit + * transition: received acks from all partitions => CompleteCommit + */ + PREPARE_COMMIT((byte) 2, "PrepareCommit", false), + /** + * Group is preparing to abort + * <p> + * transition: received acks from all partitions => CompleteAbort + * <p> + * Note, In transaction v2, we allow Empty, CompleteCommit, CompleteAbort to transition to PrepareAbort. because the + * client may not know the txn state on the server side, it needs to send endTxn request when uncertain. + */ + PREPARE_ABORT((byte) 3, "PrepareAbort", false), + /** + * Group has completed commit + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_COMMIT((byte) 4, "CompleteCommit", true), + /** + * Group has completed abort + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_ABORT((byte) 5, "CompleteAbort", true), + /** + * TransactionalId has expired and is about to be removed from the transaction cache + */ + DEAD((byte) 6, "Dead", false), + /** + * We are in the middle of bumping the epoch and fencing out older producers. + */ + PREPARE_EPOCH_FENCE((byte) 7, "PrepareEpochFence", false); + + private static final Map<String, TransactionState> NAME_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::getName, Function.identity())); + + private static final Map<Byte, TransactionState> ID_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::id, Function.identity())); Review Comment: `toUnmodifiableMap` ########## transaction-coordinator/src/main/java/org/apache/kafka/coordinator/transaction/TransactionState.java: ########## @@ -0,0 +1,170 @@ +/* + * 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.coordinator.transaction; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * Represents the states of a transaction in the transaction coordinator. + * This enum corresponds to the Scala sealed trait TransactionState in kafka.coordinator.transaction. + */ +public enum TransactionState { + /** + * Transaction has not existed yet + * <p> + * transition: received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + * received EndTxnRequest with abort and TransactionV2 enabled => PrepareAbort + */ + EMPTY((byte) 0, "Empty", true), + /** + * Transaction has started and ongoing + * <p> + * transition: received EndTxnRequest with commit => PrepareCommit + * received EndTxnRequest with abort => PrepareAbort + * received AddPartitionsToTxnRequest => Ongoing + * received AddOffsetsToTxnRequest => Ongoing + */ + ONGOING((byte) 1, "Ongoing", false), + /** + * Group is preparing to commit + * transition: received acks from all partitions => CompleteCommit + */ + PREPARE_COMMIT((byte) 2, "PrepareCommit", false), + /** + * Group is preparing to abort + * <p> + * transition: received acks from all partitions => CompleteAbort + * <p> + * Note, In transaction v2, we allow Empty, CompleteCommit, CompleteAbort to transition to PrepareAbort. because the + * client may not know the txn state on the server side, it needs to send endTxn request when uncertain. + */ + PREPARE_ABORT((byte) 3, "PrepareAbort", false), + /** + * Group has completed commit + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_COMMIT((byte) 4, "CompleteCommit", true), + /** + * Group has completed abort + * <p> + * Will soon be removed from the ongoing transaction cache + */ + COMPLETE_ABORT((byte) 5, "CompleteAbort", true), + /** + * TransactionalId has expired and is about to be removed from the transaction cache + */ + DEAD((byte) 6, "Dead", false), + /** + * We are in the middle of bumping the epoch and fencing out older producers. + */ + PREPARE_EPOCH_FENCE((byte) 7, "PrepareEpochFence", false); + + private static final Map<String, TransactionState> NAME_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::getName, Function.identity())); + + private static final Map<Byte, TransactionState> ID_TO_ENUM = Arrays.stream(values()) + .collect(Collectors.toMap(TransactionState::id, Function.identity())); + + public static final Set<TransactionState> ALL_STATES = Collections.unmodifiableSet(EnumSet.allOf(TransactionState.class)); Review Comment: `Set.copy`? -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
