Core: Add explicit JSON parser for ConfigResponse #9952
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * 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.iceberg.rest.responses; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonGenerator; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import java.io.IOException; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.util.JsonUtil; | ||
|
|
||
| public class ConfigResponseParser { | ||
|
|
||
| private static final String DEFAULTS = "defaults"; | ||
| private static final String OVERRIDES = "overrides"; | ||
|
|
||
| private ConfigResponseParser() {} | ||
|
|
||
| public static String toJson(ConfigResponse response) { | ||
| return toJson(response, false); | ||
| } | ||
|
|
||
| public static String toJson(ConfigResponse response, boolean pretty) { | ||
| return JsonUtil.generate(gen -> toJson(response, gen), pretty); | ||
| } | ||
|
|
||
| public static void toJson(ConfigResponse response, JsonGenerator gen) throws IOException { | ||
| Preconditions.checkArgument(null != response, "Invalid config response: null"); | ||
|
|
||
| gen.writeStartObject(); | ||
|
|
||
| JsonUtil.writeStringMap(DEFAULTS, response.defaults(), gen); | ||
|
Contributor
Author
There was a problem hiding this comment. existing tests in
Contributor
There was a problem hiding this comment. Should we just change this to not send back the key in the response in the value is null (makes for a cleaner response? I don't really think that's a behavior change since in the end a client needs to check that the value is not null.
Contributor
There was a problem hiding this comment. NVM these two fields are spec'd out so it seems like servers should always send it even though it may be null |
||
| JsonUtil.writeStringMap(OVERRIDES, response.overrides(), gen); | ||
|
|
||
| gen.writeEndObject(); | ||
| } | ||
|
|
||
| public static ConfigResponse fromJson(String json) { | ||
| return JsonUtil.parse(json, ConfigResponseParser::fromJson); | ||
| } | ||
|
|
||
| public static ConfigResponse fromJson(JsonNode json) { | ||
| Preconditions.checkArgument(null != json, "Cannot parse config response from null object"); | ||
|
|
||
| ConfigResponse.Builder builder = ConfigResponse.builder(); | ||
|
|
||
| if (json.hasNonNull(DEFAULTS)) { | ||
| builder.withDefaults(JsonUtil.getStringMapNullableValues(DEFAULTS, json)); | ||
|
Contributor
Author
There was a problem hiding this comment. this seems to specifically require a Map where the value can be null (see also #4184 (comment)) and there are also tests in |
||
| } | ||
|
|
||
| if (json.hasNonNull(OVERRIDES)) { | ||
| builder.withOverrides(JsonUtil.getStringMapNullableValues(OVERRIDES, json)); | ||
| } | ||
|
|
||
| return builder.build(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| /* | ||
| * 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.iceberg.rest.responses; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import java.util.Map; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Maps; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class TestConfigResponseParser { | ||
|
|
||
| @Test | ||
| public void nullAndEmptyCheck() { | ||
| assertThatThrownBy(() -> ConfigResponseParser.toJson(null)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Invalid config response: null"); | ||
|
|
||
| assertThatThrownBy(() -> ConfigResponseParser.fromJson((JsonNode) null)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Cannot parse config response from null object"); | ||
|
|
||
| ConfigResponse actual = ConfigResponseParser.fromJson("{}"); | ||
| ConfigResponse expected = ConfigResponse.builder().build(); | ||
| // ConfigResponse doesn't implement hashCode/equals | ||
| assertThat(actual.defaults()).isEqualTo(expected.defaults()).isEmpty(); | ||
| assertThat(actual.overrides()).isEqualTo(expected.overrides()).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void unknownFields() { | ||
| ConfigResponse actual = ConfigResponseParser.fromJson("{\"x\": \"val\", \"y\": \"val2\"}"); | ||
| ConfigResponse expected = ConfigResponse.builder().build(); | ||
| // ConfigResponse doesn't implement hashCode/equals | ||
| assertThat(actual.defaults()).isEqualTo(expected.defaults()).isEmpty(); | ||
| assertThat(actual.overrides()).isEqualTo(expected.overrides()).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void defaultsOnly() { | ||
| Map<String, String> defaults = Maps.newHashMap(); | ||
| defaults.put("a", "1"); | ||
| defaults.put("b", null); | ||
| defaults.put("c", "2"); | ||
| defaults.put("d", null); | ||
|
|
||
| ConfigResponse response = ConfigResponse.builder().withDefaults(defaults).build(); | ||
| String expectedJson = | ||
| "{\n" | ||
| + " \"defaults\" : {\n" | ||
| + " \"a\" : \"1\",\n" | ||
| + " \"b\" : null,\n" | ||
| + " \"c\" : \"2\",\n" | ||
| + " \"d\" : null\n" | ||
| + " },\n" | ||
| + " \"overrides\" : { }\n" | ||
| + "}"; | ||
|
|
||
| String json = ConfigResponseParser.toJson(response, true); | ||
| assertThat(json).isEqualTo(expectedJson); | ||
| assertThat(ConfigResponseParser.toJson(ConfigResponseParser.fromJson(json), true)) | ||
| .isEqualTo(expectedJson); | ||
| } | ||
|
|
||
| @Test | ||
| public void overridesOnly() { | ||
| Map<String, String> overrides = Maps.newHashMap(); | ||
| overrides.put("a", "1"); | ||
| overrides.put("b", null); | ||
| overrides.put("c", "2"); | ||
| overrides.put("d", null); | ||
|
|
||
| ConfigResponse response = ConfigResponse.builder().withOverrides(overrides).build(); | ||
| String expectedJson = | ||
| "{\n" | ||
| + " \"defaults\" : { },\n" | ||
| + " \"overrides\" : {\n" | ||
| + " \"a\" : \"1\",\n" | ||
| + " \"b\" : null,\n" | ||
| + " \"c\" : \"2\",\n" | ||
| + " \"d\" : null\n" | ||
| + " }\n" | ||
| + "}"; | ||
|
|
||
| String json = ConfigResponseParser.toJson(response, true); | ||
| assertThat(json).isEqualTo(expectedJson); | ||
| assertThat(ConfigResponseParser.toJson(ConfigResponseParser.fromJson(json), true)) | ||
| .isEqualTo(expectedJson); | ||
| } | ||
|
|
||
| @Test | ||
| public void roundTripSerde() { | ||
| Map<String, String> defaults = Maps.newHashMap(); | ||
| defaults.put("key1", "1"); | ||
| defaults.put("key2", null); | ||
|
|
||
| Map<String, String> overrides = Maps.newHashMap(); | ||
| overrides.put("key3", "23"); | ||
| overrides.put("key4", null); | ||
|
|
||
| ConfigResponse response = | ||
| ConfigResponse.builder().withDefaults(defaults).withOverrides(overrides).build(); | ||
| String expectedJson = | ||
| "{\n" | ||
| + " \"defaults\" : {\n" | ||
| + " \"key1\" : \"1\",\n" | ||
| + " \"key2\" : null\n" | ||
| + " },\n" | ||
| + " \"overrides\" : {\n" | ||
| + " \"key3\" : \"23\",\n" | ||
| + " \"key4\" : null\n" | ||
| + " }\n" | ||
| + "}"; | ||
|
|
||
| String json = ConfigResponseParser.toJson(response, true); | ||
| assertThat(json).isEqualTo(expectedJson); | ||
| assertThat(ConfigResponseParser.toJson(ConfigResponseParser.fromJson(json), true)) | ||
| .isEqualTo(expectedJson); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.