Skip to content

Add a custom toString to DynamicMap #126562

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
merged 8 commits into from
Apr 11, 2025
Merged

Add a custom toString to DynamicMap #126562

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2118bce
fix toString for DynamicMap
jdconrad Apr 9, 2025
4cdfc6e
Update docs/changelog/126562.yaml
jdconrad Apr 9, 2025
44fd72e
[CI] Auto commit changes from spotless
Apr 9, 2025
24d06ef
match standard map tostring
jdconrad Apr 9, 2025
fa58565
Merge branch 'main' into p70262
jdconrad Apr 9, 2025
3e0fe17
update test
jdconrad Apr 9, 2025
e136208
Merge branch 'main' into p70262
jdconrad Apr 9, 2025
02f995a
[CI] Auto commit changes from spotless
Apr 9, 2025
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
6 changes: 6 additions & 0 deletions docs/changelog/126562.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pr: 126562
summary: Add a custom `toString` to `DynamicMap`
area: Infra/Scripting
type: bug
issues:
- 70262
13 changes: 12 additions & 1 deletion server/src/main/java/org/elasticsearch/script/DynamicMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,17 @@ public Set<Entry<String, Object>> entrySet() {

@Override
public String toString() {
return delegate.toString();
StringBuilder sb = new StringBuilder("DynamicMap [");
int count = 0;
for (Map.Entry<String, Object> entry : entrySet()) {
sb.append(entry.getKey());
sb.append(": ");
Copy link
Member

@rjernst rjernst Apr 9, 2025

Choose a reason for hiding this comment

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

We should the same format as other Map's (eg HashMap, Map.of, etc) in Java use, which I believe is with curly braces and = between key/values. Also I wonder if we need the DynamicMap prefix?

Copy link
Contributor Author

@jdconrad jdconrad Apr 9, 2025

Choose a reason for hiding this comment

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

Fixed to match AbstractMap

sb.append(entry.getValue());
if (++count < size()) {
sb.append(", ");
}
}
sb.append("]");
return sb.toString();
}
}
5 changes: 3 additions & 2 deletions server/src/test/java/org/elasticsearch/script/ScriptTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import java.util.HashMap;
import java.util.Map;

import static org.hamcrest.Matchers.both;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;

public class ScriptTests extends ESTestCase {
Expand Down Expand Up @@ -192,7 +194,6 @@ public void testDynamicMapToString() {
map.put("long", 1L);
map.put("string", "value");
DynamicMap dm = new DynamicMap(map, Collections.emptyMap());
assertTrue(dm.toString().contains("string=value"));
assertTrue(dm.toString().contains("long=1"));
assertThat(dm.toString(), both(containsString("long: 1")).and(containsString("string: value")));
}
}
Loading