Skip to content
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

Jump to bottom

Add support for commas in values for exporter.otlp.headers #6052

Closed
wants to merge 2 commits into from
Closed

Add support for commas in values for exporter.otlp.headers #6052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
719ff40
Add support for commas in values for exporter.otlp.headers
lesterhaynes Dec 6, 2023
6390294
re-work logic to allow mixed quoted/unquoted list elements
lesterhaynes Dec 8, 2023
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
42 changes: 34 additions & 8 deletions ...rc/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/DefaultConfigProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
import java.time.Duration;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
Expand Down Expand Up @@ -181,7 +182,35 @@ public List<String> getList(String name) {
if (value == null) {
return Collections.emptyList();
}
return filterBlanksAndNulls(value.split(","));

// Support list members containing commas per RFC9110 5.5 suggestion
List<String> listMembers = new ArrayList<>();
StringBuilder curValue = new StringBuilder();
boolean openedQuote = false;
for (int i = 0; i < value.length(); i++) {
char c = value.charAt(i);
if (c == '"') {
if (openedQuote) {
openedQuote = false;
listMembers.add(curValue.toString());
curValue = new StringBuilder();
} else {
openedQuote = true;
}
} else if (c == ',') {
if (openedQuote) {
curValue.append(c);
} else {
listMembers.add(curValue.toString());
curValue = new StringBuilder();
}
} else {
curValue.append(c);
}
}
listMembers.add(curValue.toString());

return filterBlanksAndNulls(listMembers);
}

/**
Expand Down Expand Up @@ -212,8 +241,8 @@ public Map<String, String> getMap(String name) {
return getList(ConfigUtil.normalizePropertyKey(name)).stream()
.map(
entry -> {
String[] split = entry.split("=", 2);
if (split.length != 2 || StringUtils.isNullOrEmpty(split[0])) {
List<String> split = Arrays.asList(entry.split("=", 2));
if (split.size() != 2 || StringUtils.isNullOrEmpty(split.get(0))) {
throw new ConfigurationException(
"Invalid map property: " + name + "=" + config.get(name));
}
Expand Down Expand Up @@ -246,11 +275,8 @@ private static ConfigurationException newInvalidPropertyException(
"Invalid value for property " + name + "=" + value + ". Must be a " + type + ".");
}

private static List<String> filterBlanksAndNulls(String[] values) {
return Arrays.stream(values)
.map(String::trim)
.filter(s -> !s.isEmpty())
.collect(Collectors.toList());
private static List<String> filterBlanksAndNulls(List<String> values) {
return values.stream().map(String::trim).filter(s -> !s.isEmpty()).collect(Collectors.toList());
}

/** Returns the TimeUnit associated with a unit string. Defaults to milliseconds. */
Expand Down
10 changes: 10 additions & 0 deletions ...i/src/test/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ConfigPropertiesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ void allValid() {
assertThat(config.getList("test.list")).containsExactly("cat", "dog", "bear");
assertThat(config.getMap("test.map"))
.containsExactly(entry("cat", "meow"), entry("dog", "bark"), entry("bear", "growl"));
assertThat(config.getMap("test.map.commas"))
.containsExactly(
entry("cat", "meow,hiss"), entry("dog", "bark,growl"), entry("bear", "roar"));
assertThat(config.getDuration("test.duration")).isEqualTo(Duration.ofSeconds(1));
}

Expand All @@ -49,6 +52,9 @@ void allValidUsingHyphens() {
assertThat(config.getList("test-list")).containsExactly("cat", "dog", "bear");
assertThat(config.getMap("test-map"))
.containsExactly(entry("cat", "meow"), entry("dog", "bark"), entry("bear", "growl"));
assertThat(config.getMap("test-map-commas"))
.containsExactly(
entry("cat", "meow,hiss"), entry("dog", "bark,growl"), entry("bear", "roar"));
assertThat(config.getDuration("test-duration")).isEqualTo(Duration.ofSeconds(1));
}

Expand All @@ -61,6 +67,7 @@ void allMissing() {
assertThat(config.getDouble("test.double")).isNull();
assertThat(config.getList("test.list")).isEmpty();
assertThat(config.getMap("test.map")).isEmpty();
assertThat(config.getMap("test.map.commas")).isEmpty();
assertThat(config.getDuration("test.duration")).isNull();
}

Expand All @@ -73,6 +80,7 @@ void allEmpty() {
properties.put("test.double", "");
properties.put("test.list", "");
properties.put("test.map", "");
properties.put("test.map.commas", "");
properties.put("test.duration", "");

ConfigProperties config = DefaultConfigProperties.createFromMap(properties);
Expand All @@ -82,6 +90,7 @@ void allEmpty() {
assertThat(config.getDouble("test.double")).isNull();
assertThat(config.getList("test.list")).isEmpty();
assertThat(config.getMap("test.map")).isEmpty();
assertThat(config.getMap("test.map.commas")).isEmpty();
assertThat(config.getDuration("test.duration")).isNull();
}

Expand Down Expand Up @@ -277,6 +286,7 @@ private static Map<String, String> makeTestProps() {
properties.put("test.list", "cat,dog,bear");
properties.put("test.map", "cat=meow,dog=bark,bear=growl,bird=");
properties.put("test.duration", "1s");
properties.put("test.map.commas", "cat=\"meow,hiss\",dog=\"bark,growl\", bear=roar");
return properties;
}
}