abhioncbr commented on code in PR #12440: URL: https://github.com/apache/pinot/pull/12440#discussion_r1512015424
########## pinot-spi/src/main/java/org/apache/pinot/spi/env/SegmentMetadataPropertyWriter.java: ########## @@ -0,0 +1,67 @@ +/** + * 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.env; + +import java.io.IOException; +import java.io.Writer; +import org.apache.commons.configuration2.PropertiesConfiguration.PropertiesWriter; +import org.apache.commons.configuration2.convert.ListDelimiterHandler; + + +/** + * SegmentMetadataPropertyWriter extends the PropertiesWriter + * <p> + * Purpose: custom property writer for writing the segment metadata faster by skipping the escaping of key. + */ +public class SegmentMetadataPropertyWriter extends PropertiesWriter { + private boolean _skipEscapePropertyName; + private final String _segmentMetadataVersionHeader; + + public SegmentMetadataPropertyWriter(final Writer writer, ListDelimiterHandler handler, + String segmentMetadataVersionHeader) { + super(writer, handler); + _segmentMetadataVersionHeader = segmentMetadataVersionHeader; + } + + @Override + protected String escapeKey(final String key) { + // skip the escapeKey functionality, if segment metadata has a newer version + // if not newer version, follow the escape for backward compatibility. + if (_skipEscapePropertyName) { + return key; + } + return super.escapeKey(key); + } + + @Override + public void writeln(final String s) throws IOException { Review Comment: Good question. In the first attempt, I was setting `_skipEscapePropertyName` in the constructor itself. However, in our current implementation, We set the IOFactory along with properties configuration object creation([code reference](https://github.com/apache/pinot/blob/master/pinot-spi/src/main/java/org/apache/pinot/spi/env/CommonsConfigurationUtils.java#L279)). So this flag value based on Header content was always getting set to `false`. That's why, I decided to populate the flag value when we started writing the data into the file. After debugging, I discovered that header content is always the first line written to the file, and it's being treated as the comment line in commons-configuration2[[code reference](https://github.com/apache/commons-configuration/blob/master/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java#L489)], so, in my opinion, we don't need any escaping, and no property getting written before this. My only worry is that in the case of segment metadata without any header, this block executes every time we try to write the line. I need input to make this check run more conditional. -- 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
