Skip to content

Fix TraceStateBuilder.remove corrupting the builder when the same key is removed twice #8613

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

Merged
jack-berg merged 1 commit into from
Jul 21, 2026
+37 −2
Merged

Fix TraceStateBuilder.remove corrupting the builder when the same key is removed twice #8613

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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

## Unreleased

### API

* Fix `TraceStateBuilder.remove` corrupting the builder when the same key is removed twice
([#8613](https://github.com/open-telemetry/opentelemetry-java/pull/8613))

### SDK

#### Exporters
Expand Down
6 changes: 4 additions & 2 deletions api/all/src/main/java/io/opentelemetry/api/trace/ArrayBasedTraceStateBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,10 @@ public TraceStateBuilder remove(String key) {
}
for (int i = 0; i < reversedEntries.size(); i += 2) {
if (reversedEntries.get(i).equals(key)) {
reversedEntries.set(i + 1, null);
numEntries--;
if (reversedEntries.get(i + 1) != null) {
reversedEntries.set(i + 1, null);
numEntries--;
}
return this;
}
}
Expand Down
28 changes: 28 additions & 0 deletions api/all/src/test/java/io/opentelemetry/api/trace/TraceStateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
class TraceStateTest {
private static final String FIRST_KEY = "key_1";
private static final String SECOND_KEY = "key_2";
private static final String THIRD_KEY = "key_3";
private static final String FIRST_VALUE = "value.1";
private static final String SECOND_VALUE = "value.2";
private static final String THIRD_VALUE = "value.3";

private final TraceState firstTraceState =
TraceState.builder().put(FIRST_KEY, FIRST_VALUE).build();
Expand Down Expand Up @@ -303,6 +305,32 @@ void removeNotPresent() {
.isEqualTo(multiValueTraceState);
}

@Test
void removeTwice() {

@psx95 psx95 Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: rename to removeSameKeyTwice() - this could apply to all the added tests since all the added tests are removing the same key.

assertThat(firstTraceState.toBuilder().remove(FIRST_KEY).remove(FIRST_KEY).build())
.isEqualTo(TraceState.getDefault());
}

@Test
void removeTwice_KeepsRemainingEntry() {
assertThat(multiValueTraceState.toBuilder().remove(FIRST_KEY).remove(FIRST_KEY).build().asMap())
.containsExactly(entry(SECOND_KEY, SECOND_VALUE));
}

@Test
void removeTwice_KeepsRemainingEntries() {
assertThat(
TraceState.builder()
.put(FIRST_KEY, FIRST_VALUE)
.put(SECOND_KEY, SECOND_VALUE)
.put(THIRD_KEY, THIRD_VALUE)
.remove(FIRST_KEY)

@psx95 psx95 Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: just to add variety, remove the SECOND_KEY twice here.

.remove(FIRST_KEY)
.build()
.asMap())
.containsExactly(entry(THIRD_KEY, THIRD_VALUE), entry(SECOND_KEY, SECOND_VALUE));
}

@Test
void addAndRemoveEntry() {
assertThat(
Expand Down
Loading