Renames writer.path.type config name as it has a type conflict with w…

…riter.path (#3852)
apache · Jan 3, 2024 · 39ffa2f · 39ffa2f
1 parent 3302569
commit 39ffa2f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/gobblin-api/src/main/java/org/apache/gobblin/configuration/ConfigurationKeys.java b/gobblin-api/src/main/java/org/apache/gobblin/configuration/ConfigurationKeys.java
@@ -432,7 +432,11 @@ public class ConfigurationKeys {
   public static final String DEFAULT_WRITER_BUILDER_CLASS = "org.apache.gobblin.writer.AvroDataWriterBuilder";
   public static final String WRITER_FILE_NAME = WRITER_PREFIX + ".file.name";
   public static final String WRITER_FILE_PATH = WRITER_PREFIX + ".file.path";
-  public static final String WRITER_FILE_PATH_TYPE = WRITER_PREFIX + ".file.path.type";
+
+  @Deprecated // Use WRITER_FILE_PATH instead as configuration is not type safe with WRITER_FILE_PATH when stored in config
+  public static final String WRITER_FILE_PATH_TYPE_DEPRECATED = WRITER_PREFIX + ".file.path.type";
+
+  public static final String WRITER_FILE_PATH_TYPE = WRITER_PREFIX + ".file.pathType";
   public static final String WRITER_FILE_OWNER = WRITER_PREFIX + ".file.owner";
   public static final String WRITER_FILE_GROUP = WRITER_PREFIX + ".file.group";
   public static final String WRITER_FILE_REPLICATION_FACTOR = WRITER_PREFIX + ".file.replication.factor";

diff --git a/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java b/gobblin-utility/src/main/java/org/apache/gobblin/util/WriterUtils.java
@@ -19,6 +19,7 @@
 
 import java.io.IOException;
 import java.net.URI;
+import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -28,6 +29,7 @@
 import lombok.SneakyThrows;
 import org.apache.avro.file.CodecFactory;
 import org.apache.avro.file.DataFileConstants;
+import org.apache.gobblin.util.deprecation.DeprecationUtils;
 import org.apache.hadoop.conf.Configuration;
 import org.apache.hadoop.fs.FileSystem;
 import org.apache.hadoop.fs.Path;
@@ -175,6 +177,8 @@ public static Path getWriterFilePath(State state, int numBranches, int branchId)
   }
 
   private static WriterFilePathType getWriterFilePathType(State state) {
+    DeprecationUtils.renameDeprecatedKeys(state, ConfigurationKeys.WRITER_FILE_PATH_TYPE,
+        Arrays.asList(ConfigurationKeys.WRITER_FILE_PATH_TYPE_DEPRECATED));
     String pathTypeStr =
         state.getProp(ConfigurationKeys.WRITER_FILE_PATH_TYPE, ConfigurationKeys.DEFAULT_WRITER_FILE_PATH_TYPE);
     return WriterFilePathType.valueOf(pathTypeStr.toUpperCase());