(gobblin) branch master updated: Renames writer.path.type config name as it has a type conflict with writer.path (#3852)

[wl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wlo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/gobblin.git


The following commit(s) were added to refs/heads/master by this push:
     new 39ffa2f2d Renames writer.path.type config name as it has a type conflict with writer.path (#3852)
39ffa2f2d is described below

commit 39ffa2f2d166a8d4bc7768a40ba21b67325ab08a
Author: William Lo <lo...@gmail.com>
AuthorDate: Wed Jan 3 16:05:43 2024 -0500

    Renames writer.path.type config name as it has a type conflict with writer.path (#3852)
---
 .../java/org/apache/gobblin/configuration/ConfigurationKeys.java    | 6 +++++-
 .../src/main/java/org/apache/gobblin/util/WriterUtils.java          | 4 ++++
 2 files changed, 9 insertions(+), 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
index 21f8bc532..e64dcbb93 100644
--- 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
index c1fa45d8d..7cb33541c 100644
--- 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 @@ package org.apache.gobblin.util;
 
 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 java.util.function.BiConsumer;
 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 class WriterUtils {
   }
 
   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());