Skip to content

Make flattened synthetic source concatenate object keys on scalar/object mismatch #129600

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.

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

Conversation

parkertimmins
Copy link
Contributor

@parkertimmins parkertimmins commented Jun 18, 2025

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source.

This fixes the issue by replacing the problematic object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by .. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.

For example if the following flattened field values is indexed:

{
   "a": {
       "b": 5
       "b": {
          "c": 10,
          "d": { "e": 15 }
       }
   }
}

The following synthetic source will be produced:

{
   "a": {
      "b": 5
      "b.c": 10,
      "b.d.e": 15
   }
}

Fixes #122936

next = nextValue == null ? KeyValue.EMPTY : new KeyValue(nextValue);

var startPrefix = curr.prefix.diff(openObjects);
if (startPrefix.prefix.isEmpty() == false && startPrefix.prefix.getFirst().equals(lastScalarSingleLeaf)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

What if the conflict doesn't happen on the first part of the prefix, e.g.

field {
  path {
    to: 10
    to {
      foo: bar
    }
  }
}

Would this be caught here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, so this will become:

field {
  path {
    to: 10
    to.foo: bar
 }
}

When it get to the first key/value field.path.to|10 it will take the else block and traverse down into the object, adding field and path to the openObject context. When it reaches the key value field.path.to.foo|bar that object will still be open, and seeing that lastScalarSingleLeaf has a value of to, and that to is the first token in the startPrexix (to.foo), it will make a concatenated path.

(Updated a test to this situation to verify it)

@@ -103,7 +103,7 @@ public void testSingleObject() throws IOException {

// THEN
assertEquals(
"{\"a\":\"value_a\",\"a\":{\"b\":\"value_b\",\"b\":{\"c\":\"value_c\"},\"d\":\"value_d\"}}",
"{\"a\":\"value_a\",\"a.b\":\"value_b\",\"a.b.c\":\"value_c\",\"a.d\":\"value_d\"}",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Interestingly, there was a test which had a scalar/object mismatch. But it produced duplicate keys. When the xcontent was converted to jsont these duplicate keys originally threw an error, but now just drop the duplicates. (Something must have changed in xcontent stuff since the issue was opened to cause this change from an error to deduplication)

@parkertimmins parkertimmins marked this pull request as ready for review June 18, 2025 19:32
@parkertimmins parkertimmins requested review from kkrik-es and lkts June 18, 2025 19:33
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Jun 18, 2025
@parkertimmins parkertimmins added auto-backport Automatically create backport pull requests when merged :StorageEngine/Mapping The storage related side of mappings labels Jun 18, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-storage-engine (Team:StorageEngine)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jun 18, 2025
@parkertimmins parkertimmins added needs:triage Requires assignment of a team area label v8.19.0 v9.0.4 v8.18.4 and removed Team:StorageEngine needs:triage Requires assignment of a team area label labels Jun 18, 2025
Copy link
Contributor

github-actions bot commented Jun 19, 2025

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

var syntheticSource = syntheticSource(mapper, b -> {
b.startObject("field");
{
b.field("key1.key2", "foo");
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add also: `b.field("key1", "baz");

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wasn't able to add a key1 field because there is a key1 object. I went ahead and added a few more keys with scalar values at the root level and in nested objects.

final FlattenedFieldSyntheticWriterHelper writer = new FlattenedFieldSyntheticWriterHelper(new SortedSetSortedKeyedValues(dv));
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final XContentBuilder builder = new XContentBuilder(XContentType.JSON.xContent(), baos);
final List<byte[]> bytes = List.of("a.b.c" + '\0' + "10", "a.b.c.d" + '\0' + "20")
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also add something for a and a.b.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's worth leaving this one as is so that the concatenated keys occur in a nested object. But testSingleObject has keys a, a.b, and a.b.c, so it covers the scenario where keys in the root object are concatenated.

Copy link
Contributor

@kkrik-es kkrik-es left a comment

Choose a reason for hiding this comment

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

Nice, some minor comments to address but otherwise it looks good.

@parkertimmins parkertimmins requested review from kkrik-es and lkts June 20, 2025 03:31
@parkertimmins parkertimmins merged commit 245dc07 into elastic:main Jun 20, 2025
29 checks passed
@parkertimmins parkertimmins deleted the parker/flattened-scalar-object-mismatch branch June 20, 2025 19:20
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
8.19 Commit could not be cherrypicked due to conflicts
9.0
8.18 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 129600

parkertimmins added a commit to parkertimmins/elasticsearch that referenced this pull request Jun 20, 2025
…ect mismatch (elastic#129600)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.
parkertimmins added a commit to parkertimmins/elasticsearch that referenced this pull request Jun 20, 2025
…ect mismatch (elastic#129600)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.

(cherry picked from commit 245dc07)

# Conflicts:
#	docs/reference/elasticsearch/mapping-reference/flattened.md
@parkertimmins
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.19
8.18

Questions ?

Please refer to the Backport tool documentation

parkertimmins added a commit to parkertimmins/elasticsearch that referenced this pull request Jun 20, 2025
…ect mismatch (elastic#129600)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.

(cherry picked from commit 245dc07)
elasticsearchmachine pushed a commit that referenced this pull request Jun 20, 2025
…ect mismatch (#129600) (#129792)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.
elasticsearchmachine pushed a commit that referenced this pull request Jun 20, 2025
…lar/object mismatch (#129600) (#129794)

* Make flattened synthetic source concatenate object keys on scalar/object mismatch (#129600)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.

(cherry picked from commit 245dc07)

* remove methods not avaiable in java version

* skip testing console-result in docs
elasticsearchmachine pushed a commit that referenced this pull request Jun 20, 2025
…lar/object mismatch (#129600) (#129793)

* Make flattened synthetic source concatenate object keys on scalar/object mismatch (#129600)

There is an issue where for Flattened fields with synthetic source, if there is a key with a scalar value, and a duplicate key with an object value, one of the values will be left out of the produced synthetic source. This fixes the issue by replacing the object with paths to each of its keys. These paths consist of the concatenation of all keys going down to a given scalar, joined by a period. For example, they are of the form foo.bar.baz. This applies recursively, so that every value within the object, no matter how nested, will be accessible through a full specified path.

(cherry picked from commit 245dc07)

# Conflicts:
#	docs/reference/elasticsearch/mapping-reference/flattened.md

* remove methods not avaiable in java version

* skip testing console-result in docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged backport pending >bug :StorageEngine/Mapping The storage related side of mappings Team:StorageEngine v8.18.4 v8.19.0 v9.0.4 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Synthetic _source can't be retrieved with overlapping keys in flattened field
4 participants