gortiz commented on code in PR #10191: URL: https://github.com/apache/pinot/pull/10191#discussion_r1122696136
########## pinot-spi/src/main/java/org/apache/pinot/spi/config/table/IndexConfig.java: ########## @@ -0,0 +1,46 @@ +/** + * 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.pinot.spi.config.table; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.apache.pinot.spi.config.BaseJsonConfig; + + +/** + * This is the base class used to configure indexes. + * + * The common logic between all indexes is that they can be enabled or disabled. + * + * Indexes that do not require extra configuration can directly use this class. + */ +public class IndexConfig extends BaseJsonConfig { + public static final IndexConfig ENABLED = new IndexConfig(true); + public static final IndexConfig DISABLED = new IndexConfig(false); + private final boolean _enabled; Review Comment: > My concern is that when deserializing from JSON and enabled is not explicitly set, the config will have it as false. That is the default behavior of Jackson, but that default behavior shall not modify our code. Another relevant case: IMO subclasses of `IndexConfig` should be immutable. The design of this class enforces it. That means that we need to create a factory method or an annotation annotated with `@JsonCreator`. That method/class have to have one parameter for each property know by Jackson. Therefore we need to introduce the `enabled` (or `disabled`) property there. For example, a `DictionaryIndexConfig` should have a constructor like: ```java @JsonCreator public DictionaryIndexConfig(@JsonProperty("enabled") boolean enabled, @JsonProperty("onHeap") boolean onHeap, @JsonProperty("useVarLengthDictionary") @Nullable Boolean useVarLengthDictionary) { super(enabled); _onHeap = onHeap; _useVarLengthDictionary = Boolean.TRUE.equals(useVarLengthDictionary); } ``` Given that we already need to do that. It cost nothing to do: ```java @JsonCreator public DictionaryIndexConfig(@JsonProperty("enabled") Boolean enabled, @JsonProperty("onHeap") boolean onHeap, @JsonProperty("useVarLengthDictionary") @Nullable Boolean useVarLengthDictionary) { super(enabled == null || enabled); _onHeap = onHeap; _useVarLengthDictionary = Boolean.TRUE.equals(useVarLengthDictionary); } ``` By doing that tell Jackson what to do without making Jackson defaults have an impact on our code. -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
