Skip to content

Commit 3222567

Browse files
poojanilangekarpoojanilangekar
committed
deprecatedKey -> legacyKey
1 parent 7d8f87b commit 3222567

File tree

4 files changed

+47
-48
lines changed

4 files changed

+47
-48
lines changed

‎polaris-core/src/main/java/org/apache/polaris/core/config/BehaviorChangeConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ public class BehaviorChangeConfiguration<T> extends PolarisConfiguration<T> {
3434

3535
protected BehaviorChangeConfiguration(
3636
String key,
37-
Optional<String> deprecatedKey,
37+
Optional<String> legacyKey,
3838
String description,
3939
T defaultValue,
4040
Optional<String> catalogConfig,
4141
Optional<String> catalogConfigUnsafe) {
42-
super(key, deprecatedKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
42+
super(key, legacyKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
4343
}
4444

4545
public static final BehaviorChangeConfiguration<Boolean> VALIDATE_VIEW_LOCATION_OVERLAP =

‎polaris-core/src/main/java/org/apache/polaris/core/config/FeatureConfiguration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@
3636
public class FeatureConfiguration<T> extends PolarisConfiguration<T> {
3737
protected FeatureConfiguration(
3838
String key,
39-
Optional<String> deprecatedKey,
39+
Optional<String> legacyKey,
4040
String description,
4141
T defaultValue,
4242
Optional<String> catalogConfig,
4343
Optional<String> catalogConfigUnsafe) {
44-
super(key, deprecatedKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
44+
super(key, legacyKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
4545
}
4646

4747
/**
@@ -268,7 +268,7 @@ public static void enforceFeatureEnabledOrThrow(
268268
SUPPORTED_EXTERNAL_CATALOG_CONNECTION_TYPES =
269269
PolarisConfiguration.<List<String>>builder()
270270
.key("SUPPORTED_EXTERNAL_CATALOG_CONNECTION_TYPES")
271-
.deprecatedKey("SUPPORTED_CATALOG_CONNECTION_TYPES")
271+
.legacyKey("SUPPORTED_CATALOG_CONNECTION_TYPES")
272272
.description("The list of supported external catalog connection types for federation")
273273
.defaultValue(List.of(ConnectionType.ICEBERG_REST.name()))
274274
.buildFeatureConfiguration();

‎polaris-core/src/main/java/org/apache/polaris/core/config/PolarisConfiguration.java

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public abstract class PolarisConfiguration<T> {
4141

4242
public final String key;
4343
public final String description;
44-
public final Optional<String> deprecatedKey;
44+
public final Optional<String> legacyKey;
4545
public final T defaultValue;
4646
private final Optional<String> catalogConfigImpl;
4747
private final Optional<String> catalogConfigUnsafeImpl;
@@ -57,20 +57,19 @@ public abstract class PolarisConfiguration<T> {
5757
private static void registerConfiguration(PolarisConfiguration<?> configuration) {
5858
for (PolarisConfiguration<?> existingConfiguration : allConfigurations) {
5959
if (existingConfiguration.key.equals(configuration.key)
60-
|| (configuration.deprecatedKey.isPresent()
61-
&& existingConfiguration.key.equals(configuration.deprecatedKey.get()))) {
60+
|| (configuration.legacyKey.isPresent()
61+
&& existingConfiguration.key.equals(configuration.legacyKey.get()))) {
6262
throw new IllegalArgumentException(
6363
String.format("Config '%s' is already in use", existingConfiguration.key));
64-
} else if (existingConfiguration.deprecatedKey.isPresent()
65-
&& (configuration.key.equals(existingConfiguration.deprecatedKey.get())
66-
|| (configuration.deprecatedKey.isPresent()
64+
} else if (existingConfiguration.legacyKey.isPresent()
65+
&& (configuration.key.equals(existingConfiguration.legacyKey.get())
66+
|| (configuration.legacyKey.isPresent()
6767
&& configuration
68-
.deprecatedKey
68+
.legacyKey
6969
.get()
70-
.equals(existingConfiguration.deprecatedKey.get())))) {
70+
.equals(existingConfiguration.legacyKey.get())))) {
7171
throw new IllegalArgumentException(
72-
String.format(
73-
"Config '%s' is already in use", existingConfiguration.deprecatedKey.get()));
72+
String.format("Config '%s' is already in use", existingConfiguration.legacyKey.get()));
7473
} else {
7574
var configs =
7675
Stream.of(
@@ -99,26 +98,26 @@ public static List<PolarisConfiguration<?>> getAllConfigurations() {
9998
@SuppressWarnings("unchecked")
10099
protected PolarisConfiguration(
101100
String key,
102-
Optional<String> deprecatedKey,
101+
Optional<String> legacyKey,
103102
String description,
104103
T defaultValue,
105104
Optional<String> catalogConfig,
106105
Optional<String> catalogConfigUnsafe) {
107106
this.key = key;
108-
this.deprecatedKey = deprecatedKey;
107+
this.legacyKey = legacyKey;
109108
this.description = description;
110109
this.defaultValue = defaultValue;
111110
this.catalogConfigImpl = catalogConfig;
112111
this.catalogConfigUnsafeImpl = catalogConfigUnsafe;
113112
this.typ = (Class<T>) defaultValue.getClass();
114113
}
115114

116-
public boolean hasDeprecatedKey() {
117-
return deprecatedKey.isPresent();
115+
public boolean hasLegacyKey() {
116+
return legacyKey.isPresent();
118117
}
119118

120-
public String deprecatedKey() {
121-
return deprecatedKey.orElseThrow(
119+
public String legacyKey() {
120+
return legacyKey.orElseThrow(
122121
() ->
123122
new IllegalStateException(
124123
"Attempted to read a deprecated key from a configuration that doesn't have one."));
@@ -152,7 +151,7 @@ T cast(Object value) {
152151

153152
public static class Builder<T> {
154153
private String key;
155-
private Optional<String> deprecatedKey = Optional.empty();
154+
private Optional<String> legacyKey = Optional.empty();
156155
private String description;
157156
private T defaultValue;
158157
private Optional<String> catalogConfig = Optional.empty();
@@ -163,8 +162,8 @@ public Builder<T> key(String key) {
163162
return this;
164163
}
165164

166-
public Builder<T> deprecatedKey(String deprecatedKey) {
167-
this.deprecatedKey = Optional.of(deprecatedKey);
165+
public Builder<T> legacyKey(String legacyKey) {
166+
this.legacyKey = Optional.of(legacyKey);
168167
return this;
169168
}
170169

@@ -222,7 +221,7 @@ public FeatureConfiguration<T> buildFeatureConfiguration() {
222221
validateOrThrow();
223222
FeatureConfiguration<T> config =
224223
new FeatureConfiguration<>(
225-
key, deprecatedKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
224+
key, legacyKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
226225
PolarisConfiguration.registerConfiguration(config);
227226
return config;
228227
}
@@ -235,7 +234,7 @@ public BehaviorChangeConfiguration<T> buildBehaviorChangeConfiguration() {
235234
}
236235
BehaviorChangeConfiguration<T> config =
237236
new BehaviorChangeConfiguration<>(
238-
key, deprecatedKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
237+
key, legacyKey, description, defaultValue, catalogConfig, catalogConfigUnsafe);
239238
PolarisConfiguration.registerConfiguration(config);
240239
return config;
241240
}

‎polaris-core/src/test/java/org/apache/polaris/core/config/PolarisConfigurationTest.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,35 +26,35 @@
2626
public class PolarisConfigurationTest {
2727

2828
@Test
29-
void testFeatureConfigurationWithDeprecatedKey() {
29+
void testFeatureConfigurationWithLegacyKey() {
3030
FeatureConfiguration<Boolean> config =
3131
PolarisConfiguration.<Boolean>builder()
32-
.key("FEATURE_CONFIG_WITH_DEPRECATED_KEY")
33-
.deprecatedKey("OLD_FEATURE_CONFIG_WITH_DEPRECATED_KEY")
32+
.key("FEATURE_CONFIG_WITH_LEGACY_KEY")
33+
.legacyKey("OLD_FEATURE_CONFIG_WITH_LEGACY_KEY")
3434
.description("Test configuration with deprecated key")
3535
.defaultValue(true)
3636
.buildFeatureConfiguration();
3737

38-
assertThat(config.hasDeprecatedKey()).isTrue();
39-
assertThat(config.deprecatedKey()).isEqualTo("OLD_FEATURE_CONFIG_WITH_DEPRECATED_KEY");
40-
assertThat(config.key).isEqualTo("FEATURE_CONFIG_WITH_DEPRECATED_KEY");
38+
assertThat(config.hasLegacyKey()).isTrue();
39+
assertThat(config.legacyKey()).isEqualTo("OLD_FEATURE_CONFIG_WITH_LEGACY_KEY");
40+
assertThat(config.key).isEqualTo("FEATURE_CONFIG_WITH_LEGACY_KEY");
4141
assertThat(config.description).isEqualTo("Test configuration with deprecated key");
4242
assertThat(config.defaultValue).isTrue();
4343
}
4444

4545
@Test
46-
void testBehaviorChangeConfigurationWithDeprecatedKey() {
46+
void testBehaviorChangeConfigurationWithLegacyKey() {
4747
BehaviorChangeConfiguration<String> config =
4848
PolarisConfiguration.<String>builder()
49-
.key("BEHAVIOR_CONFIG_WITH_DEPRECATED_KEY")
50-
.deprecatedKey("OLD_BEHAVIOR_CONFIG_WITH_DEPRECATED_KEY")
49+
.key("BEHAVIOR_CONFIG_WITH_LEGACY_KEY")
50+
.legacyKey("OLD_BEHAVIOR_CONFIG_WITH_LEGACY_KEY")
5151
.description("Test behavior configuration with deprecated key")
5252
.defaultValue("test-value")
5353
.buildBehaviorChangeConfiguration();
5454

55-
assertThat(config.hasDeprecatedKey()).isTrue();
56-
assertThat(config.deprecatedKey()).isEqualTo("OLD_BEHAVIOR_CONFIG_WITH_DEPRECATED_KEY");
57-
assertThat(config.key).isEqualTo("BEHAVIOR_CONFIG_WITH_DEPRECATED_KEY");
55+
assertThat(config.hasLegacyKey()).isTrue();
56+
assertThat(config.legacyKey()).isEqualTo("OLD_BEHAVIOR_CONFIG_WITH_LEGACY_KEY");
57+
assertThat(config.key).isEqualTo("BEHAVIOR_CONFIG_WITH_LEGACY_KEY");
5858
assertThat(config.defaultValue).isEqualTo("test-value");
5959
}
6060

@@ -78,10 +78,10 @@ void testDuplicateKeyValidation() {
7878
}
7979

8080
@Test
81-
void testDuplicateDeprecatedKeyValidation() {
81+
void testDuplicateLegacyKeyValidation() {
8282
PolarisConfiguration.<Boolean>builder()
8383
.key("NEW_KEY_DEPRECATED_TEST_2")
84-
.deprecatedKey("DEPRECATED_KEY_TEST_2")
84+
.legacyKey("LEGACY_KEY_TEST_2")
8585
.description("First configuration with deprecated key")
8686
.defaultValue(true)
8787
.buildFeatureConfiguration();
@@ -90,36 +90,36 @@ void testDuplicateDeprecatedKeyValidation() {
9090
() ->
9191
PolarisConfiguration.<Boolean>builder()
9292
.key("ANOTHER_NEW_KEY_2")
93-
.deprecatedKey("DEPRECATED_KEY_TEST_2")
93+
.legacyKey("LEGACY_KEY_TEST_2")
9494
.description("Second configuration with same deprecated key")
9595
.defaultValue(false)
9696
.buildFeatureConfiguration())
9797
.isInstanceOf(IllegalArgumentException.class)
98-
.hasMessage("Config 'DEPRECATED_KEY_TEST_2' is already in use");
98+
.hasMessage("Config 'LEGACY_KEY_TEST_2' is already in use");
9999
}
100100

101101
@Test
102-
void testNewKeyMatchingExistingDeprecatedKeyValidation() {
102+
void testNewKeyMatchingExistingLegacyKeyValidation() {
103103
PolarisConfiguration.<Boolean>builder()
104104
.key("ORIGINAL_KEY_3")
105-
.deprecatedKey("OLD_DEPRECATED_KEY_3")
105+
.legacyKey("OLD_LEGACY_KEY_3")
106106
.description("First configuration with deprecated key")
107107
.defaultValue(true)
108108
.buildFeatureConfiguration();
109109

110110
assertThatThrownBy(
111111
() ->
112112
PolarisConfiguration.<Boolean>builder()
113-
.key("OLD_DEPRECATED_KEY_3")
113+
.key("OLD_LEGACY_KEY_3")
114114
.description("Configuration with key matching existing deprecated key")
115115
.defaultValue(false)
116116
.buildFeatureConfiguration())
117117
.isInstanceOf(IllegalArgumentException.class)
118-
.hasMessage("Config 'OLD_DEPRECATED_KEY_3' is already in use");
118+
.hasMessage("Config 'OLD_LEGACY_KEY_3' is already in use");
119119
}
120120

121121
@Test
122-
void testDeprecatedKeyMatchingExistingKeyValidation() {
122+
void testLegacyKeyMatchingExistingKeyValidation() {
123123
PolarisConfiguration.<Boolean>builder()
124124
.key("EXISTING_KEY_4")
125125
.description("First configuration")
@@ -130,7 +130,7 @@ void testDeprecatedKeyMatchingExistingKeyValidation() {
130130
() ->
131131
PolarisConfiguration.<Boolean>builder()
132132
.key("NEW_KEY_FOR_VALIDATION_4")
133-
.deprecatedKey("EXISTING_KEY_4")
133+
.legacyKey("EXISTING_KEY_4")
134134
.description("Configuration with deprecated key matching existing key")
135135
.defaultValue(false)
136136
.buildFeatureConfiguration())

0 commit comments

Comments
 (0)