Skip to content

[HUDI-2880] Fixing loading of props from default dir #4167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danny0405 merged 2 commits into from
Dec 1, 2021
Merged

[HUDI-2880] Fixing loading of props from default dir #4167

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf0309f
Fixing loading of props from default dir
nsivabalan Nov 30, 2021
8c00866
addressing comments
nsivabalan Dec 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions hudi-common/src/main/java/org/apache/hudi/common/config/DFSPropertiesConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,21 @@

package org.apache.hudi.common.config;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hudi.common.fs.FSUtils;
import org.apache.hudi.common.util.Option;
import org.apache.hudi.common.util.StringUtils;
import org.apache.hudi.common.util.ValidationUtils;
import org.apache.hudi.exception.HoodieIOException;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
Expand Down Expand Up @@ -77,7 +80,7 @@ public DFSPropertiesConfiguration(@Nonnull Configuration hadoopConf, @Nonnull Pa
this.currentFilePath = filePath;
this.hoodieConfig = new HoodieConfig();
this.visitedFilePaths = new HashSet<>();
addPropsFromFile(filePath);
addPropsFromFile(filePath, false);
}

public DFSPropertiesConfiguration() {
Expand All @@ -95,13 +98,9 @@ public static TypedProperties loadGlobalProps() {
DFSPropertiesConfiguration conf = new DFSPropertiesConfiguration();
Option<Path> defaultConfPath = getConfPathFromEnv();
if (defaultConfPath.isPresent()) {
conf.addPropsFromFile(defaultConfPath.get());
conf.addPropsFromFile(defaultConfPath.get(), false);
} else {
try {
conf.addPropsFromFile(new Path(DEFAULT_CONF_FILE_DIR));
} catch (Exception ignored) {
Copy link
Member

@vinothchandar vinothchandar Mar 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is actually preferrable to leaking the check for a default path inside addPropsFromFile

Copy link
Contributor

@yihua yihua Apr 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments addressed in #5311 .

LOG.warn("Didn't find config file under default conf file dir: " + DEFAULT_CONF_FILE_DIR);
}
conf.addPropsFromFile(new Path(DEFAULT_CONF_FILE_DIR + "/" + DEFAULT_PROPERTIES_FILE), true);
}
return conf.getProps();
}
Expand All @@ -119,7 +118,7 @@ public static void clearGlobalProps() {
*
* @param filePath File path for configuration file
*/
public void addPropsFromFile(Path filePath) {
public void addPropsFromFile(Path filePath, boolean isDefaultDirectory) {
if (visitedFilePaths.contains(filePath.toString())) {
throw new IllegalStateException("Loop detected; file " + filePath + " already referenced");
}
Expand All @@ -128,14 +127,19 @@ public void addPropsFromFile(Path filePath) {
filePath.toString(),
Option.ofNullable(hadoopConfig).orElseGet(Configuration::new)
);
try {
if (isDefaultDirectory && !fs.exists(filePath)) {
LOG.warn("Properties file " + filePath + " not found. Ignoring to load props file");
return;
}

try (BufferedReader reader = new BufferedReader(new InputStreamReader(fs.open(filePath)))) {
BufferedReader reader = new BufferedReader(new InputStreamReader(fs.open(filePath)));
Copy link
Member

@vinothchandar vinothchandar Mar 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove the try here? it closes the reader correctly right ?

visitedFilePaths.add(filePath.toString());
currentFilePath = filePath;
addPropsFromStream(reader);
} catch (IOException ioe) {
LOG.error("Error reading in properties from dfs");
throw new IllegalArgumentException("Cannot read properties from dfs", ioe);
LOG.error("Error reading in properties from dfs from file " + filePath);
throw new HoodieIOException("Cannot read properties from dfs from file " + filePath, ioe);
}
}

Expand All @@ -154,7 +158,7 @@ public void addPropsFromStream(BufferedReader reader) throws IOException {
String[] split = splitProperty(line);
if (line.startsWith("include=") || line.startsWith("include =")) {
Path includeFilePath = new Path(currentFilePath.getParent(), split[1]);
addPropsFromFile(includeFilePath);
addPropsFromFile(includeFilePath, false);
} else {
hoodieConfig.setValue(split[0], split[1]);
}
Expand Down Expand Up @@ -192,7 +196,7 @@ private static Option<Path> getConfPathFromEnv() {
}

private String[] splitProperty(String line) {
line = line.replaceAll("\\s+"," ");
line = line.replaceAll("\\s+", " ");
String delimiter = line.contains("=") ? "=" : " ";
int ind = line.indexOf(delimiter);
String k = line.substring(0, ind).trim();
Expand Down
7 changes: 3 additions & 4 deletions hudi-common/src/test/java/org/apache/hudi/common/util/TestDFSPropertiesConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,12 @@ public void testIncludes() {
assertEquals("t3.value", props.getString("string.prop"));
assertEquals(1354354354, props.getLong("long.prop"));
assertThrows(IllegalStateException.class, () -> {
cfg.addPropsFromFile(new Path(dfsBasePath + "/t4.props"));
cfg.addPropsFromFile(new Path(dfsBasePath + "/t4.props"), false);
}, "Should error out on a self-included file.");
}

@Test
public void testLocalFileSystemLoading() {
public void testLocalFileSystemLoading() throws IOException {
DFSPropertiesConfiguration cfg = new DFSPropertiesConfiguration(dfs.getConf(), new Path(dfsBasePath + "/t1.props"));

cfg.addPropsFromFile(
Expand All @@ -156,8 +156,7 @@ public void testLocalFileSystemLoading() {
.getResource("props/test.properties")
.getPath()
)
)
);
), false);

TypedProperties props = cfg.getProps();

Expand Down