Skip to content

Relax field-level meta validation constraints #20578

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
msfroh merged 1 commit into from
Apr 14, 2026
Merged

Relax field-level meta validation constraints #20578

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
38 changes: 25 additions & 13 deletions server/src/main/java/org/opensearch/index/mapper/TypeParsers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public class TypeParsers {
public static final String INDEX_OPTIONS_FREQS = "freqs";
public static final String INDEX_OPTIONS_POSITIONS = "positions";
public static final String INDEX_OPTIONS_OFFSETS = "offsets";
public static final int META_MAX_ENTRIES = 100;
public static final int META_MAX_KEY_LENGTH = 255;
public static final int META_MAX_VALUE_LENGTH = 10_000;

public static void checkNull(String propName, Object propNode) {
if (false == propName.equals("null_value") && propNode == null) {
Expand All @@ -86,26 +89,35 @@ public static Map<String, String> parseMeta(String name, Object metaObject) {
}
@SuppressWarnings("unchecked")
Map<String, ?> meta = (Map<String, ?>) metaObject;
if (meta.size() > 5) {
throw new MapperParsingException("[meta] can't have more than 5 entries, but got " + meta.size() + " on field [" + name + "]");
if (meta.size() > META_MAX_ENTRIES) {
throw new MapperParsingException(
"[meta] can't have more than " + META_MAX_ENTRIES + " entries, but got " + meta.size() + " on field [" + name + "]"
);
}
for (String key : meta.keySet()) {
if (key.codePointCount(0, key.length()) > 20) {
for (Map.Entry<String, ?> entry : meta.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
if (key.codePointCount(0, key.length()) > META_MAX_KEY_LENGTH) {
throw new MapperParsingException(
"[meta] keys can't be longer than 20 chars, but got [" + key + "] for field [" + name + "]"
"[meta] keys can't be longer than " + META_MAX_KEY_LENGTH + " chars, but got [" + key + "] for field [" + name + "]"
);
}
}
for (Object value : meta.values()) {
if (value instanceof String) {
String sValue = (String) value;
if (sValue.codePointCount(0, sValue.length()) > 50) {

if (value == null) {
throw new MapperParsingException("[meta] values can't be null (field [" + name + "])");
}
if (value instanceof String sValue) {
if (sValue.codePointCount(0, sValue.length()) > META_MAX_VALUE_LENGTH) {
throw new MapperParsingException(
"[meta] values can't be longer than 50 chars, but got [" + value + "] for field [" + name + "]"
"[meta] values can't be longer than "
+ META_MAX_VALUE_LENGTH
+ " chars, but got ["
+ value
+ "] for field ["
+ name
+ "]"
);
}
} else if (value == null) {
throw new MapperParsingException("[meta] values can't be null (field [" + name + "])");
} else {
throw new MapperParsingException(
"[meta] values can only be strings, but got "
Expand Down
39 changes: 28 additions & 11 deletions server/src/test/java/org/opensearch/index/mapper/TypeParsersTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,23 +117,35 @@ public void testParseMeta() {
}

{
String longKeyString = IntStream.range(0, TypeParsers.META_MAX_KEY_LENGTH + 1)
.mapToObj(Integer::toString)
.collect(Collectors.joining());
MapperParsingException e = expectThrows(
MapperParsingException.class,
() -> TypeParsers.parseMeta("foo", Collections.singletonMap("veryloooooooooooongkey", 3L))
() -> TypeParsers.parseMeta("foo", Collections.singletonMap(longKeyString, 3L))
);
assertEquals(
"[meta] keys can't be longer than "
+ TypeParsers.META_MAX_KEY_LENGTH
+ " chars, but got ["
+ longKeyString
+ "] for field [foo]",
e.getMessage()
);
assertEquals("[meta] keys can't be longer than 20 chars, but got [veryloooooooooooongkey] for field [foo]", e.getMessage());
}

{
Map<String, String> meta = new HashMap<>();
meta.put("foo1", "3");
meta.put("foo2", "3");
meta.put("foo3", "3");
meta.put("foo4", "3");
meta.put("foo5", "3");
meta.put("foo6", "3");
for (int i = 0; i < TypeParsers.META_MAX_ENTRIES; i++) {
meta.put("foo" + i, "someValue");
}
meta.put("extraKey", "someValue");
assertTrue(TypeParsers.META_MAX_ENTRIES < meta.size());
MapperParsingException e = expectThrows(MapperParsingException.class, () -> TypeParsers.parseMeta("foo", meta));
assertEquals("[meta] can't have more than 5 entries, but got 6 on field [foo]", e.getMessage());
assertEquals(
"[meta] can't have more than " + TypeParsers.META_MAX_ENTRIES + " entries, but got " + meta.size() + " on field [foo]",
e.getMessage()
);
}

{
Expand All @@ -158,12 +170,17 @@ public void testParseMeta() {
}

{
String longString = IntStream.range(0, 51).mapToObj(Integer::toString).collect(Collectors.joining());
String longString = IntStream.range(0, TypeParsers.META_MAX_VALUE_LENGTH + 1)
.mapToObj(Integer::toString)
.collect(Collectors.joining());
MapperParsingException e = expectThrows(
MapperParsingException.class,
() -> TypeParsers.parseMeta("foo", Collections.singletonMap("foo", longString))
);
assertThat(e.getMessage(), Matchers.startsWith("[meta] values can't be longer than 50 chars"));
assertThat(
e.getMessage(),
Matchers.startsWith("[meta] values can't be longer than " + TypeParsers.META_MAX_VALUE_LENGTH + " chars")
);
}
}
}
Loading