Skip to content

Commit

Permalink
Issue #18: searching keyword to highlight from the backend side
Browse files Browse the repository at this point in the history
  • Loading branch information
idrissneumann committed Nov 30, 2023
1 parent abd7860 commit b71b27a
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 17 deletions.
41 changes: 24 additions & 17 deletions pkg/quickwit/response_parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,30 @@ func parseResponse(responses []*es.SearchResponse, targets []*Query, configuredF
return &result, nil
}

func parseLuceneQuery(query string) []string {
var keywords []string

termRegex := regexp.MustCompile(`("[^"]+"|\S+)`)
matches := termRegex.FindAllString(query, -1)

for _, match := range matches {
if match[0] == '"' && match[len(match)-1] == '"' {
match = match[1 : len(match)-1]
}

keywords = append(keywords, strings.ReplaceAll(match, "*", ""))
}

return keywords
}

func processLogsResponse(res *es.SearchResponse, target *Query, configuredFields es.ConfiguredFields, queryRes *backend.DataResponse) error {
propNames := make(map[string]bool)
docs := make([]map[string]interface{}, len(res.Hits.Hits))
searchWords := make(map[string]bool)

highlights := parseLuceneQuery(target.RawQuery)

for hitIdx, hit := range res.Hits.Hits {
var flattened map[string]interface{}
if hit["_source"] != nil {
Expand Down Expand Up @@ -132,23 +151,6 @@ func processLogsResponse(res *es.SearchResponse, target *Query, configuredFields
propNames[key] = true
}

// FIXME: Quickwit does not support highlight. Should we replace this by a custom highlighter?
// Process highlight to searchWords
if highlights, ok := doc["highlight"].(map[string]interface{}); ok {
for _, highlight := range highlights {
if highlightList, ok := highlight.([]interface{}); ok {
for _, highlightValue := range highlightList {
str := fmt.Sprintf("%v", highlightValue)
matches := searchWordsRegex.FindAllStringSubmatch(str, -1)

for _, v := range matches {
searchWords[v[1]] = true
}
}
}
}
}

docs[hitIdx] = doc
}

Expand All @@ -158,6 +160,11 @@ func processLogsResponse(res *es.SearchResponse, target *Query, configuredFields
frames := data.Frames{}
frame := data.NewFrame("", fields...)
setPreferredVisType(frame, data.VisTypeLogs)

for _, keyword := range highlights {
searchWords[keyword] = true
}

setLogsCustomMeta(frame, searchWords, stringToIntWithDefaultValue(target.Metrics[0].Settings.Get("limit").MustString(), defaultSize))
frames = append(frames, frame)

Expand Down
30 changes: 30 additions & 0 deletions pkg/quickwit/response_parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3178,6 +3178,36 @@ func TestLabelOrderInFieldName(t *testing.T) {
requireTimeSeriesName(t, "val1 error", frames[5])
}

func TestParseLuceneQuery(t *testing.T) {
t.Run("Empty term query", func(t *testing.T) {
query := ""
highlights := parseLuceneQuery(query)
require.Len(t, highlights, 0)
})

t.Run("Simple term query", func(t *testing.T) {
query := "foo"
highlights := parseLuceneQuery(query)
require.Len(t, highlights, 1)
require.Equal(t, "foo", highlights[0])
})

t.Run("Multi term query", func(t *testing.T) {
query := "foo bar"
highlights := parseLuceneQuery(query)
require.Len(t, highlights, 2)
require.Equal(t, "foo", highlights[0])
require.Equal(t, "bar", highlights[1])
})

t.Run("Wildcard query", func(t *testing.T) {
query := "foo*"
highlights := parseLuceneQuery(query)
require.Len(t, highlights, 1)
require.Equal(t, "foo", highlights[0])
})
}

func TestFlatten(t *testing.T) {
t.Run("Flattens simple object", func(t *testing.T) {
obj := map[string]interface{}{
Expand Down

0 comments on commit b71b27a

Please sign in to comment.