Fixes #321: fix highlight max_analyzer_offset field name to match OS 2.2.0

[gjunge]

Fix field max_analyzed_offset to max_analyzer_offset

Description

The current field max_analyzed_offset used in ElasticSearch doesn't match the field added to OpenSearch version 2.2.0, max_analyzer_offset.
This means the current client implementation have two problems:

It doesn't work for versions before version 2.2.0, because no equivalent field exist on OpenSearch.
It doesn't work for version after 2.2.0, because the field is misspelled.

Even though the Property changes, which is normally a breaking change, since the current field is unusable, this change is not "breaking" anything.

For further information see:

• Fixes #553: fix max_analyzer_offset field to match OS 2.2.0 opensearch-java#555
• [Backport 2.x] Adds a new parameter, max_analyzer_offset, for the highlighter OpenSearch#4031
• Adds a new parameter, max_analyzer_offset, for the highlighter OpenSearch#3893

Issues Resolved:

• [BUG] "Misspelling" on setting MaxAnalyzedOffset on IHighlight #321

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[Yury-Fridlyand]

Can you add a unit and/or integration test please?

[gjunge]

Can you add a unit and/or integration test please?

I have extended the existing Highlighting unit test. Have to say, was working a little blindly, since I was not able to get these tests running.

[Yury-Fridlyand]

You have to add a switch or keep both options, because this .Net client should work with all OpenSearch versions.
As you can see from CI, all IT failed on pre 2.2 versions:

[xUnit.net 00:01:16.42]     Tests.Search.Request.HighlightingUsageTests.ReturnsExpectedIsValid [FAIL]
  Failed Tests.Search.Request.HighlightingUsageTests.ReturnsExpectedIsValid [798 ms]
  Error Message:
   Tests.Framework.EndpointTests.ResponseAssertionException : Expected response.IsValid to be True because Invalid OpenSearch.Client response built from a unsuccessful (400) low level call on POST: /project/_search?pretty=true&error_trace=true&typed_keys=true
# Audit trail of this API call:
 - [1] BadResponse: Node: https://localhost:9200/ Took: 00:00:00.1518266
# OriginalException: OpenSearch.Net.OpenSearchClientException: Request failed to execute. Call: Status code 400 from: POST /project/_search?pretty=true&error_trace=true&typed_keys=true. ServerError: Type: x_content_parse_exception Reason: "[1:675] [highlight] unknown field [max_analyzer_offset]"
# Request:
{"highlight":{"encoder":"html","fields":{"name.standard":{"force_source":true,"fragmenter":"span","fragment_size":150,"no_match_size":150,"number_of_fragments":3,"type":"plain"},"leadDeveloper.firstName":{"boundary_max_scan":50,"highlight_query":{"match":{"leadDeveloper.firstName":{"query":"Kurt Edgardo Naomi Dariana Justice Felton"}}},"phrase_limit":10,"post_tags":["</name>"],"pre_tags":["<name>"],"type":"fvh"},"leadDeveloper.lastName":{"highlight_query":{"match":{"leadDeveloper.lastName":{"query":"Mante"}}},"post_tags":["</name>"],"pre_tags":["<name>"],"type":"unified"}},"highlight_query":{"match":{"name.standard":{"query":"Upton Sons Shield Rice Rowe Roberts"}}},"max_analyzer_offset":1000000,"post_tags":["</tag1>"],"pre_tags":["<tag1>"]},"query":{"match":{"name.standard":{"query":"Upton Sons Shield Rice Rowe Roberts"}}}}
[xUnit.net 00:01:16.48]     Tests.Search.Request.HighlightingUsageTests.ReturnsExpectedResponse [FAIL]
# Response:
{
  "error" : {
    "root_cause" : [
      {
        "type" : "x_content_parse_exception",
        "reason" : "[1:675] [highlight] unknown field [max_analyzer_offset]",

[gjunge]

Understood. Do you have a pointer where this already happens in the project so I can implement it consistently?

[Yury-Fridlyand]

Understood. Do you have a pointer where this already happens in the project so I can implement it consistently?

I think you need to keep both in the client code, like we have with master/cluster_manager:

opensearch-net/src/OpenSearch.Client/Nodes/NodesInfo/NodeRole.cs

Lines 37 to 43 in 74bcaab

	///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManager"/> instead</remarks>
	[EnumMember(Value = "master")]
	Master,
	///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="Master"/></remarks>
	[EnumMember(Value = "cluster_manager")]
	ClusterManager,

For integration tests you can duplicate tests and use SkipVersion attribute:

opensearch-net/tests/Tests/Cat/CatClusterManager/CatClusterManagerApiTests.cs

Lines 40 to 42 in 74bcaab

	[SkipVersion("<2.0.0", "CatClusterManager API was introdused in 2.0.0 release instead of CatMaster")]
	public class CatClusterManagerApiTests
	: ApiIntegrationTestBase<ReadOnlyCluster, CatResponse<CatClusterManagerRecord>, ICatClusterManagerRequest, CatClusterManagerDescriptor, CatClusterManagerRequest>

opensearch-net/tests/Tests/Cat/CatMaster/CatMasterApiTests.cs

Lines 40 to 42 in 74bcaab

	[SkipVersion(">=2.0.0", "CatMaster API was renamed to CatClusterManager in 2.0.0 release")]
	public class CatMasterApiTests
	: ApiIntegrationTestBase<ReadOnlyCluster, CatResponse<CatMasterRecord>, ICatMasterRequest, CatMasterDescriptor, CatMasterRequest>

So client will be compatible with all OpenSearch version and test framework will skip test of incompatible feature for given version range.

[gjunge]

Added also field level max_analyzer_offset. Gives the new unit test some more "reason to exist".

[Xtansia]

Thanks for contributing this fix @gjunge, looks good!

[opensearch-trigger-bot]

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-322-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 8ad8057696044485d53858b794f2d6d0dc74aa8d
# Push it to GitHub
git push --set-upstream origin backport/backport-322-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-322-to-1.x.