all repos — searchix @ v0.4.4

Search engine for NixOS, nix-darwin, home-manager and NUR users

internal/index/search.go (view raw)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
package index

import (
	"bytes"
	"context"
	"encoding/gob"
	"iter"
	"net/url"
	"strings"
	"time"

	"alin.ovh/x/log"

	"alin.ovh/searchix/internal/config"
	"alin.ovh/searchix/internal/index/meta"
	"alin.ovh/searchix/internal/nix"

	"github.com/Southclaws/fault"
	"github.com/Southclaws/fault/fctx"
	"github.com/Southclaws/fault/fmsg"
	"github.com/blevesearch/bleve/v2"
	"github.com/blevesearch/bleve/v2/search"
	"github.com/blevesearch/bleve/v2/search/query"
)

const DefaultPageSize = 100

type DocumentMatch struct {
	*search.DocumentMatch
	Data Indexable
}

type Result struct {
	*bleve.SearchResult
	Hits iter.Seq[DocumentMatch]
}

type ReadIndex struct {
	index  bleve.Index
	config *config.Config
	log    *log.Logger
	meta   *meta.Meta
}

type SearchRequest struct {
	Source   config.Source
	From     int
	PageSize int
	Facets   url.Values
	Keyword  string
}

func (index *ReadIndex) Exists() bool {
	return index.meta.Exists()
}

func (index *ReadIndex) LastUpdated() time.Time {
	return index.meta.LastUpdated()
}

func (index *ReadIndex) GetEnabledSources() ([]string, error) {
	facet := bleve.NewFacetRequest("Source", len(index.config.Importer.Sources))
	query := bleve.NewMatchAllQuery()
	search := bleve.NewSearchRequest(query)
	search.AddFacet("Source", facet)

	results, err := index.index.Search(search)
	if err != nil {
		return nil, fault.Wrap(err, fmsg.With("could not get list of enabled sources from index"))
	}

	enabledSources := make([]string, results.Facets["Source"].Terms.Len())
	for i, term := range results.Facets["Source"].Terms.Terms() {
		enabledSources[i] = term.Term
	}

	return enabledSources, nil
}

func setField[T query.FieldableQuery](
	q T,
	field string,
) T {
	q.SetField(field)

	return q
}

func setBoost[T query.BoostableQuery](q T, boost float64) T {
	q.SetBoost(boost)

	return q
}

func (index *ReadIndex) search(
	ctx context.Context,
	request *bleve.SearchRequest,
) (*Result, error) {
	request.Fields = []string{"_data", "Source"}

	bleveResult, err := index.index.SearchInContext(ctx, request)
	select {
	case <-ctx.Done():
		return nil, fault.Wrap(ctx.Err(), fctx.With(ctx))
	default:
		if err != nil {
			return nil, fault.Wrap(err,
				fctx.With(ctx),
				fmsg.Withf("failed to execute search query"),
			)
		}

		hits := func(yield func(DocumentMatch) bool) {
			var buf bytes.Buffer
			for _, match := range bleveResult.Hits {
				hit := DocumentMatch{
					DocumentMatch: match,
					Data:          nil,
				}
				_, err := buf.WriteString(match.Fields["_data"].(string))
				if err != nil {
					index.log.Warn("error fetching result data", "error", err)
				}
				err = gob.NewDecoder(&buf).Decode(&hit.Data)
				if err != nil {
					index.log.Warn("error decoding gob data", "error", err, "data", buf.String())
				}
				buf.Reset()
				if !yield(hit) {
					return
				}
			}
		}

		return &Result{
			SearchResult: bleveResult,
			Hits:         hits,
		}, nil
	}
}

func (index *ReadIndex) Search(
	ctx context.Context,
	opts SearchRequest,
) (*Result, error) {
	query := bleve.NewBooleanQuery()

	if opts.Source.Importer != config.All {
		query.AddMust(
			setField(bleve.NewTermQuery(opts.Source.Key), "Source"),
		)
	} else {
		q := bleve.NewDisjunctionQuery(
			setBoost(setField(bleve.NewTermQuery("nixpkgs"), "Source"), -1000),
			setBoost(setField(bleve.NewTermQuery("nur"), "Source"), -5000),
		)

		query.AddShould(q)
	}

	if opts.Keyword != "" {
		if strings.ContainsAny(opts.Keyword, "+-=&|<>!(){}[]^\"~*?:\\/") {
			query.AddMust(bleve.NewQueryStringQuery(opts.Keyword))
		} else {
			// match the user's query in any field ...
			query.AddMust(bleve.NewDisjunctionQuery(
				setBoost(bleve.NewTermQuery(opts.Keyword), 50),
				setBoost(bleve.NewPrefixQuery(opts.Keyword), 25),
				setBoost(bleve.NewMatchPhraseQuery(opts.Keyword), 25),
				bleve.NewMatchQuery(opts.Keyword),
			))
		}

		idQuery := bleve.NewMatchQuery(opts.Keyword)
		idQuery.SetField("_id")
		idQuery.SetBoost(8)
		query.AddShould(idQuery)

		mainProgramQuery := bleve.NewMatchQuery(opts.Keyword)
		mainProgramQuery.SetField("MainProgram")
		mainProgramQuery.SetBoost(10)
		query.AddShould(mainProgramQuery)

		mainProgramLiteralQuery := bleve.NewTermQuery(opts.Keyword)
		mainProgramLiteralQuery.SetField("MainProgram")
		mainProgramLiteralQuery.SetBoost(50)
		query.AddShould(mainProgramLiteralQuery)

		programsQuery := bleve.NewMatchQuery(opts.Keyword)
		programsQuery.SetField("Programs")
		programsQuery.SetBoost(2)
		query.AddShould(programsQuery)

		programsLiteralQuery := bleve.NewTermQuery(opts.Keyword)
		programsLiteralQuery.SetField("Programs")
		programsLiteralQuery.SetBoost(100)
		query.AddShould(programsLiteralQuery)

		attrQuery := bleve.NewMatchQuery(opts.Keyword)
		attrQuery.SetField("Attribute")
		attrQuery.SetBoost(2)
		query.AddShould(attrQuery)

		attrPrefixQuery := bleve.NewPrefixQuery(opts.Keyword)
		attrPrefixQuery.SetField("Attribute")
		attrPrefixQuery.SetBoost(10)
		query.AddShould(attrPrefixQuery)

		attrTermQuery := bleve.NewTermQuery(opts.Keyword)
		attrTermQuery.SetField("Attribute")
		attrTermQuery.SetBoost(600)
		query.AddShould(attrTermQuery)

		nameQuery := bleve.NewMatchQuery(opts.Keyword)
		nameQuery.SetField("Name")
		nameQuery.SetBoost(2)
		query.AddShould(nameQuery)

		nameNGramQuery := bleve.NewMatchQuery(opts.Keyword)
		nameNGramQuery.SetField("NameNGram")
		nameNGramQuery.SetBoost(2)
		query.AddShould(nameNGramQuery)

		namePrefixQuery := bleve.NewPrefixQuery(opts.Keyword)
		namePrefixQuery.SetField("Name")
		namePrefixQuery.SetBoost(10)
		query.AddShould(namePrefixQuery)

		nameTermQuery := bleve.NewTermQuery(opts.Keyword)
		nameTermQuery.SetField("Name")
		nameTermQuery.SetBoost(100)
		query.AddShould(nameTermQuery)
	}

	search := bleve.NewSearchRequest(query)
	search.Explain = config.DevMode
	search.Size = opts.PageSize

	if len(opts.Facets) > 0 {
		for name, values := range opts.Facets {
			or := bleve.NewDisjunctionQuery()
			for _, value := range values {
				q := bleve.NewTermQuery(value)
				q.SetField(name)

				or.AddQuery(q)
			}
			query.AddMust(or)
		}

		if opts.Keyword == "" {
			search.SortBy([]string{"_id"})
		}
	}

	if opts.Source.Importer.Includes(config.Packages) {
		search.AddFacet("Package set", bleve.NewFacetRequest("PackageSet", 10))
		search.AddFacet("Platform", bleve.NewFacetRequest("Platforms", 10))
	}
	if opts.Source.Importer.Includes(config.Options) {
		search.AddFacet("Option set", bleve.NewFacetRequest("Parents", 10))
	}

	if opts.From != 0 {
		search.From = opts.From
	}

	return index.search(ctx, search)
}

func (index *ReadIndex) ImportedBefore(
	cutoff time.Time,
	source config.Source,
) (*bleve.SearchResult, error) {
	cutoffQuery := bleve.NewDateRangeQuery(time.UnixMilli(0), cutoff)
	cutoffQuery.SetField("ImportedAt")

	all := bleve.NewConjunctionQuery(cutoffQuery)

	if source.Importer != config.All {
		sourceQuery := bleve.NewTermQuery(source.Key)
		sourceQuery.SetField("Source")

		all.AddQuery(sourceQuery)
	}

	req := bleve.NewSearchRequest(all)
	req.Size = 10_000
	req.SortBy([]string{"_id"})

	res, err := index.index.Search(req)
	if err != nil {
		return nil, fault.Wrap(err, fmsg.With("could not query old documents"))
	}

	return res, nil
}

func (index *ReadIndex) Count(source config.Source) (uint64, error) {
	if source.Importer == config.All {
		count, err := index.index.DocCount()
		if err != nil {
			return 0, fault.Wrap(err)
		}

		return count, nil
	}

	query := setField(bleve.NewTermQuery(source.Key), "Source")
	req := bleve.NewSearchRequest(query)
	res, err := index.index.Search(req)
	if err != nil {
		return 0, fault.Wrap(err)
	}

	return res.Total, nil
}

func (index *ReadIndex) Close() error {
	err := index.index.Close()
	if err != nil {
		return fault.Wrap(err)
	}

	return nil
}

func (index *ReadIndex) GetDocument(
	ctx context.Context,
	source config.Source,
	id string,
) (Indexable, error) {
	key := nix.MakeKey(source, id)
	query := bleve.NewDocIDQuery([]string{key})
	search := bleve.NewSearchRequest(query)
	search.Size = 1

	result, err := index.search(ctx, search)
	if err != nil {
		return nil, err
	}

	if result.Total == 0 {
		return nil, nil
	}

	for hit := range result.Hits {
		if hit.ID == key {
			return hit.Data, err
		}
	}

	return nil, err
}