jolshan commented on code in PR #15685: URL: https://github.com/apache/kafka/pull/15685#discussion_r1603376757
########## server-common/src/main/java/org/apache/kafka/server/common/FeatureVersion.java: ########## @@ -0,0 +1,137 @@ +/* + * 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.common; + +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; + +/** + * This is enum for the various features implemented for Kafka clusters. + * KIP-584: Versioning Scheme for Features introduced the idea of various features, but only added one feature -- MetadataVersion. + * KIP-1022: Formatting and Updating Features allowed for more features to be added. In order to set and update features, + * they need to be specified via the StorageTool or FeatureCommand tools. + * <br> + * Having a unified enum for the features that will use a shared type in the API used to set and update them + * makes it easier to process these features. + */ +public enum FeatureVersion { + + /** + * Features defined. If a feature is included in this list, and marked to be used in production they will also be specified when + * formatting a cluster via the StorageTool. MetadataVersion is handled separately, so it is not included here. + * + * See {@link TestFeatureVersion} as an example. See {@link FeatureVersionUtils.FeatureVersionImpl} when implementing a new feature. + */ + TEST_VERSION("test.feature.version", TestFeatureVersion.values(), TestFeatureVersion::fromFeatureLevel, false); + + public static final FeatureVersion[] FEATURES; + public static final List<FeatureVersion> PRODUCTION_FEATURES; + private final String name; + private final FeatureVersionUtils.FeatureVersionImpl[] features; + private final FeatureVersionUtils.CreateMethod createFeatureVersionMethod; + private final boolean usedInProduction; + + FeatureVersion(String name, + FeatureVersionUtils.FeatureVersionImpl[] features, + FeatureVersionUtils.CreateMethod createMethod, + boolean usedInProduction) { + this.name = name; + this.features = features; + this.createFeatureVersionMethod = createMethod; + this.usedInProduction = usedInProduction; + } + + static { + FeatureVersion[] enumValues = FeatureVersion.values(); + FEATURES = Arrays.copyOf(enumValues, enumValues.length); + + PRODUCTION_FEATURES = Arrays.stream(FEATURES).filter(feature -> + feature.usedInProduction).collect(Collectors.toList()); + } + + public String featureName() { + return name; + } + + /** + * Creates a FeatureVersion from a given name and level with the correct feature object underneath. + * + * @param level the level of the feature + * @returns the FeatureVersionUtils.FeatureVersionImpl for the feature the enum is based on. + * @throws IllegalArgumentException if the feature name is not valid (not implemented for this method) + */ + public FeatureVersionUtils.FeatureVersionImpl fromFeatureLevel(short level) { + return createFeatureVersionMethod.fromFeatureLevel(level); + } + + /** + * A method to validate the feature can be set. If a given feature relies on another feature, the dependencies should be + * captured in {@link FeatureVersionUtils.FeatureVersionImpl#dependencies()} + * <p> + * For example, say feature X level x relies on feature Y level y: + * if feature X >= x then throw an error if feature Y < y. + * + * All feature levels above 0 require metadata.version=4 (IBP_3_3_IV0) in order to write the feature records to the cluster. + * + * @param feature the feature we are validating + * @param metadataVersion the metadata version we have (or want to set) + * @param features the feature versions (besides MetadataVersion) we have (or want to set) + * @throws IllegalArgumentException if the feature is not valid + */ + public static void validateVersion(FeatureVersionUtils.FeatureVersionImpl feature, MetadataVersion metadataVersion, Map<String, Short> features) { Review Comment: Hmmm -- I believe I added tests in the StorageToolTest? I can double check. -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
