Skip to content

Avoid shared internal code in sdk-common and api-incubator (#6970) #8916

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

Open
rooks-ns wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −13
Open

Avoid shared internal code in sdk-common and api-incubator (#6970) #8916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions all/src/test/java/io/opentelemetry/all/NoSharedInternalCodeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,12 @@ class NoSharedInternalCodeTest {

private static final Set<String> exemptions =
Set.of(
"opentelemetry-api-incubator",
"opentelemetry-exporter-common",
"opentelemetry-exporter-logging",
"opentelemetry-exporter-logging-otlp",
"opentelemetry-exporter-prometheus",
"opentelemetry-extension-trace-propagators",
"opentelemetry-opencensus-shim",
"opentelemetry-sdk-common",
"opentelemetry-sdk-logs",
"opentelemetry-sdk-metrics",
"opentelemetry-sdk-profiles",
Expand Down
8 changes: 6 additions & 2 deletions sdk/common/src/main/java/io/opentelemetry/sdk/common/export/RetryPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@

package io.opentelemetry.sdk.common.export;

import static io.opentelemetry.api.internal.Utils.checkArgument;

import com.google.auto.value.AutoValue;
import java.io.IOException;
import java.time.Duration;
Expand Down Expand Up @@ -133,5 +131,11 @@ public RetryPolicy build() {

return retryPolicy;
}

private static void checkArgument(boolean isValid, String errorMessage) {
if (!isValid) {
throw new IllegalArgumentException(errorMessage);
}
}
}
}
3 changes: 1 addition & 2 deletions sdk/common/src/main/java/io/opentelemetry/sdk/resources/ResourceBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.internal.StringUtils;
import io.opentelemetry.sdk.resources.internal.Entity;
import io.opentelemetry.sdk.resources.internal.EntityUtil;
import java.util.ArrayList;
Expand Down Expand Up @@ -441,6 +440,6 @@ private static String deriveSchemaUrl(List<Entity> entities) {

@Nullable
static String normalizeSchemaUrl(@Nullable String schemaUrl) {
return StringUtils.isNullOrEmpty(schemaUrl) ? null : schemaUrl;
return schemaUrl == null || schemaUrl.isEmpty() ? null : schemaUrl;
}
}
19 changes: 14 additions & 5 deletions sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/AttributeCheckUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.internal.StringUtils;
import io.opentelemetry.api.internal.Utils;
import java.util.Objects;

/**
Expand All @@ -35,8 +33,9 @@ private AttributeCheckUtil() {}
public static void checkAttributes(Attributes attributes) {
attributes.forEach(
(key, value) -> {
Utils.checkArgument(
isValidAndNotEmpty(key), "Attribute key" + ERROR_MESSAGE_INVALID_CHARS);
if (!isValidAndNotEmpty(key)) {
throw new IllegalArgumentException("Attribute key" + ERROR_MESSAGE_INVALID_CHARS);
}
Objects.requireNonNull(value, "Attribute value" + ERROR_MESSAGE_INVALID_VALUE);
});
}
Expand All @@ -60,6 +59,16 @@ public static boolean isValidAndNotEmpty(AttributeKey<?> name) {
* @return whether the name is valid.
*/
public static boolean isValid(String name) {
return name.length() <= MAX_LENGTH && StringUtils.isPrintableString(name);
return name.length() <= MAX_LENGTH && isPrintableString(name);
}

private static boolean isPrintableString(String str) {
for (int i = 0; i < str.length(); i++) {
char ch = str.charAt(i);
if (ch < ' ' || ch > '~') {
return false;
}
}
return true;
}
}
8 changes: 6 additions & 2 deletions sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/SdkEntityBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@

package io.opentelemetry.sdk.resources.internal;

import static io.opentelemetry.api.internal.Utils.checkArgument;

import io.opentelemetry.api.common.Attributes;
import java.util.Objects;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -64,4 +62,10 @@ public EntityBuilder setDescription(Attributes description) {
public Entity build() {
return SdkEntity.create(entityType, id, description, schemaUrl);
}

private static void checkArgument(boolean isValid, String errorMessage) {
if (!isValid) {
throw new IllegalArgumentException(errorMessage);
}
}
}
18 changes: 18 additions & 0 deletions sdk/common/src/test/java/io/opentelemetry/sdk/resources/ResourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,24 @@ void create_NullEmptyValue() {
assertThat(resource.getAttributes().size()).isEqualTo(1);
}

@Test
void create_invalidAttributeKey() {
assertThatThrownBy(() -> Resource.create(Attributes.of(stringKey("\u0002ab"), "value")))
.isInstanceOf(IllegalArgumentException.class)
.hasMessageContaining("Attribute key should be a ASCII string");

assertThatThrownBy(() -> Resource.create(Attributes.of(stringKey("key\u007f"), "value")))
.isInstanceOf(IllegalArgumentException.class)
.hasMessageContaining("Attribute key should be a ASCII string");

char[] chars = new char[256];
Arrays.fill(chars, 'a');
String tooLongKey = new String(chars);
assertThatThrownBy(() -> Resource.create(Attributes.of(stringKey(tooLongKey), "value")))
.isInstanceOf(IllegalArgumentException.class)
.hasMessageContaining("Attribute key should be a ASCII string");
}

@Test
void testResourceEquals() {
Attributes attribute1 = Attributes.of(stringKey("a"), "1", stringKey("b"), "2");
Expand Down
Loading