MB-64766: Adding decoded sort values to new array (#2198)

- Added a new field to document match to store the decoded sort values
- Added implementations for decoding numeric, datetime and geo sort
values
 - Added appropriate test cases for the same

Also, upgrade zapx/v16 for fix:
* 4e38ae4 Likith B | MB-59633: Support list of geo shapes for a single
field

---------

Co-authored-by: Abhinav Dangeti <[email protected]>

Author: Likith101

go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/blevesearch/zapx/v13 v13.4.2
 	github.com/blevesearch/zapx/v14 v14.4.2
 	github.com/blevesearch/zapx/v15 v15.4.2
-	github.com/blevesearch/zapx/v16 v16.2.3
+	github.com/blevesearch/zapx/v16 v16.2.4
 	github.com/couchbase/moss v0.2.0
 	github.com/golang/protobuf v1.3.2
 	github.com/spf13/cobra v1.8.1

go.sum

@@ -44,8 +44,8 @@ github.com/blevesearch/zapx/v14 v14.4.2 h1:2SGHakVKd+TrtEqpfeq8X+So5PShQ5nW6GNxT
 github.com/blevesearch/zapx/v14 v14.4.2/go.mod h1:rz0XNb/OZSMjNorufDGSpFpjoFKhXmppH9Hi7a877D8=
 github.com/blevesearch/zapx/v15 v15.4.2 h1:sWxpDE0QQOTjyxYbAVjt3+0ieu8NCE0fDRaFxEsp31k=
 github.com/blevesearch/zapx/v15 v15.4.2/go.mod h1:1pssev/59FsuWcgSnTa0OeEpOzmhtmr/0/11H0Z8+Nw=
-github.com/blevesearch/zapx/v16 v16.2.3 h1:7Y0r+a3diEvlazsncexq1qoFOcBd64xwMS7aDm4lo1s=
-github.com/blevesearch/zapx/v16 v16.2.3/go.mod h1:wVJ+GtURAaRG9KQAMNYyklq0egV+XJlGcXNCE0OFjjA=
+github.com/blevesearch/zapx/v16 v16.2.4 h1:tGgfvleXTAkwsD5mEzgM3zCS/7pgocTCnO1oyAUjlww=
+github.com/blevesearch/zapx/v16 v16.2.4/go.mod h1:Rti/REtuuMmzwsI8/C/qIzRaEoSK/wiFYw5e5ctUKKs=
 github.com/couchbase/ghistogram v0.1.0 h1:b95QcQTCzjTUocDXp/uMgSNQi8oj1tGwnJ4bODWZnps=
 github.com/couchbase/ghistogram v0.1.0/go.mod h1:s1Jhy76zqfEecpNWJfWUiKZookAFaiGOEoyzgHt9i7k=
 github.com/couchbase/moss v0.2.0 h1:VCYrMzFwEryyhRSeI+/b3tRBSeTpi/8gn5Kf6dxqn+o=

search/collector/topn.go

@@ -20,7 +20,6 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/blevesearch/bleve/v2/numeric"
 	"github.com/blevesearch/bleve/v2/search"
 	"github.com/blevesearch/bleve/v2/size"
 	index "github.com/blevesearch/bleve_index_api"
@@ -501,23 +500,7 @@ func (hc *TopNCollector) finalizeResults(r index.IndexReader) error {
 		doc.Complete(nil)
 		return nil
 	})
-	if err != nil {
-		return err
-	}
 
-	// Decode geo sort keys back to its distance values
-	for i, so := range hc.sort {
-		if _, ok := so.(*search.SortGeoDistance); ok {
-			for _, dm := range hc.results {
-				// The string is a int64 bit representation of a float64 distance
-				distInt, err := numeric.PrefixCoded(dm.Sort[i]).Int64()
-				if err != nil {
-					return err
-				}
-				dm.Sort[i] = strconv.FormatFloat(numeric.Int64ToFloat64(distInt), 'f', -1, 64)
-			}
-		}
-	}
 	return err
 }
 

search/search.go

@@ -154,6 +154,7 @@ type DocumentMatch struct {
 	Locations       FieldTermLocationMap  `json:"locations,omitempty"`
 	Fragments       FieldFragmentMap      `json:"fragments,omitempty"`
 	Sort            []string              `json:"sort,omitempty"`
+	DecodedSort     []string              `json:"decoded_sort,omitempty"`
 
 	// Fields contains the values for document fields listed in
 	// SearchRequest.Fields. Text fields are returned as strings, numeric
@@ -224,6 +225,7 @@ func (dm *DocumentMatch) Reset() *DocumentMatch {
 	dm.IndexInternalID = indexInternalID[:0]
 	// reuse the []interface{} already allocated (and reset len to 0)
 	dm.Sort = sort[:0]
+	dm.DecodedSort = dm.DecodedSort[:0]
 	// reuse the FieldTermLocations already allocated (and reset len to 0)
 	dm.FieldTermLocations = ftls[:0]
 	return dm
@@ -263,6 +265,10 @@ func (dm *DocumentMatch) Size() int {
 		sizeInBytes += size.SizeOfString + len(entry)
 	}
 
+	for _, entry := range dm.DecodedSort {
+		sizeInBytes += size.SizeOfString + len(entry)
+	}
+
 	for k := range dm.Fields {
 		sizeInBytes += size.SizeOfString + len(k) +
 			size.SizeOfPtr

search/sort.go

@@ -20,7 +20,9 @@ import (
 	"fmt"
 	"math"
 	"sort"
+	"strconv"
 	"strings"
+	"time"
 	"unicode/utf8"
 
 	"github.com/blevesearch/bleve/v2/geo"
@@ -36,6 +38,7 @@ var (
 type SearchSort interface {
 	UpdateVisitor(field string, term []byte)
 	Value(a *DocumentMatch) string
+	DecodeValue(value string) string
 	Descending() bool
 
 	RequiresDocID() bool
@@ -212,7 +215,9 @@ type SortOrder []SearchSort
 
 func (so SortOrder) Value(doc *DocumentMatch) {
 	for _, soi := range so {
-		doc.Sort = append(doc.Sort, soi.Value(doc))
+		value := soi.Value(doc)
+		doc.Sort = append(doc.Sort, value)
+		doc.DecodedSort = append(doc.DecodedSort, soi.DecodeValue(value))
 	}
 }
 
@@ -390,6 +395,25 @@ func (s *SortField) Value(i *DocumentMatch) string {
 	return iTerm
 }
 
+func (s *SortField) DecodeValue(value string) string {
+	switch s.Type {
+	case SortFieldAsNumber:
+		i64, err := numeric.PrefixCoded(value).Int64()
+		if err != nil {
+			return value
+		}
+		return strconv.FormatFloat(numeric.Int64ToFloat64(i64), 'f', -1, 64)
+	case SortFieldAsDate:
+		i64, err := numeric.PrefixCoded(value).Int64()
+		if err != nil {
+			return value
+		}
+		return time.Unix(0, i64).UTC().String()
+	default:
+		return value
+	}
+}
+
 // Descending determines the order of the sort
 func (s *SortField) Descending() bool {
 	return s.Desc
@@ -545,6 +569,10 @@ func (s *SortDocID) Value(i *DocumentMatch) string {
 	return i.ID
 }
 
+func (s *SortDocID) DecodeValue(value string) string {
+	return value
+}
+
 // Descending determines the order of the sort
 func (s *SortDocID) Descending() bool {
 	return s.Desc
@@ -590,6 +618,10 @@ func (s *SortScore) Value(i *DocumentMatch) string {
 	return "_score"
 }
 
+func (s *SortScore) DecodeValue(value string) string {
+	return value
+}
+
 // Descending determines the order of the sort
 func (s *SortScore) Descending() bool {
 	return s.Desc
@@ -694,6 +726,14 @@ func (s *SortGeoDistance) Value(i *DocumentMatch) string {
 	return string(numeric.MustNewPrefixCodedInt64(distInt64, 0))
 }
 
+func (s *SortGeoDistance) DecodeValue(value string) string {
+	distInt, err := numeric.PrefixCoded(value).Int64()
+	if err != nil {
+		return ""
+	}
+	return strconv.FormatFloat(numeric.Int64ToFloat64(distInt), 'f', -1, 64)
+}
+
 // Descending determines the order of the sort
 func (s *SortGeoDistance) Descending() bool {
 	return s.Desc