Add Highlight field to SearchHit struct (#654)

* Add Highlight field to SearchHit struct Signed-off-by: Tim Holdaway <[email protected]> * Update changelog Signed-off-by: Tim Holdaway <[email protected]> * Update SearchTemplate struct with Status field This field is returned since OpenSearch 2.18 Signed-off-by: Tim Holdaway <[email protected]> * Update NodeStatsstruct with RemoteStore field This field is returned since OpenSearch 2.18. (see opensearch-project/OpenSearch#15611) Signed-off-by: Tim Holdaway <[email protected]> * Always attempt to pull the docker base image for integration tests. Otherwise we can end up with a cached version of opensearch:latest that is not the current latest, and would use that instead, resulting in tests running against a different version than in the CI build. Signed-off-by: Tim Holdaway <[email protected]> --------- Signed-off-by: Tim Holdaway <[email protected]>
opensearch-project · Jan 18, 2025 · 040f709 · 040f709
1 parent f81866a
commit 040f709
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- Adds `Highlight` field to `SearchHit` ([#654](https://github.com/opensearch-project/opensearch-go/pull/654))
 
 ### Changed
 

diff --git a/Makefile b/Makefile
@@ -207,7 +207,7 @@ godoc: ## Display documentation for the package
 	godoc --http=localhost:6060 --play
 
 cluster.build:
-	docker compose --project-directory .ci/opensearch build;
+	docker compose --project-directory .ci/opensearch build --pull;
 
 cluster.start:
 	docker compose --project-directory .ci/opensearch up -d;

diff --git a/opensearchapi/api_nodes-stats.go b/opensearchapi/api_nodes-stats.go
@@ -112,6 +112,7 @@ type NodesStats struct {
 	Repositories                   []json.RawMessage                        `json:"repositories"`
 	AdmissionControl               NodesStatsAdmissionControl               `json:"admission_control"`
 	Caches                         NodesStatsCaches                         `json:"caches"`
+	RemoteStore                    NodeStatsRemoteStore                     `json:"remote_store"`
 }
 
 // NodesStatsIndices is a sub type of NodesStats representing Indices information of the node
@@ -729,3 +730,8 @@ type NodesStatsCaches struct {
 		StoreName   string `json:"store_name"`
 	} `json:"request_cache"`
 }
+
+// NodeStatsRemoteStore is a sub type of NodesStats
+type NodeStatsRemoteStore struct {
+	LastSuccessfulFetchOfPinnedTimestamps int `json:"last_successful_fetch_of_pinned_timestamps"`
+}
diff --git a/opensearchapi/api_search-template.go b/opensearchapi/api_search-template.go
@@ -62,6 +62,7 @@ type SearchTemplateResp struct {
 	Took    int            `json:"took"`
 	Timeout bool           `json:"timed_out"`
 	Shards  ResponseShards `json:"_shards"`
+	Status  int            `json:"status"`
 	Hits    struct {
 		Total struct {
 			Value    int    `json:"value"`

diff --git a/opensearchapi/api_search.go b/opensearchapi/api_search.go
@@ -99,6 +99,7 @@ type SearchHit struct {
 	Explanation *DocumentExplainDetails `json:"_explanation"`
 	SeqNo       *int                    `json:"_seq_no"`
 	PrimaryTerm *int                    `json:"_primary_term"`
+	Highlight   map[string][]string     `json:"highlight"`
 }
 
 // Suggest is a sub type of SearchResp containing information of the suggest field

diff --git a/opensearchapi/api_search_test.go b/opensearchapi/api_search_test.go
@@ -181,4 +181,28 @@ func TestSearch(t *testing.T) {
 		require.Nil(t, err)
 		assert.NotEmpty(t, resp.Suggest)
 	})
+
+	t.Run("request with highlight", func(t *testing.T) {
+		resp, err := client.Search(
+			nil,
+			&opensearchapi.SearchReq{
+				Indices: []string{index},
+				Body: strings.NewReader(`{
+					"query": {
+						"match": {
+							"foo": "bar"
+						}
+					},
+					"highlight": {
+						"fields": {
+							"foo": {}
+						}
+					}
+				}`),
+			},
+		)
+		require.Nil(t, err)
+		assert.NotEmpty(t, resp.Hits.Hits)
+		assert.Equal(t, map[string][]string{"foo": []string{"<em>bar</em>"}}, resp.Hits.Hits[0].Highlight)
+	})
 }