forked from sourcegraph/zoekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1062 lines (855 loc) · 29.2 KB
/
api.go
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package zoekt // import "github.com/sourcegraph/zoekt"
import (
"context"
"encoding/json"
"errors"
"fmt"
"reflect"
"strconv"
"strings"
"time"
"github.com/sourcegraph/zoekt/query"
)
const (
mapHeaderBytes uint64 = 48
sliceHeaderBytes uint64 = 24
stringHeaderBytes uint64 = 16
pointerSize uint64 = 8
interfaceBytes uint64 = 16
)
// FileMatch contains all the matches within a file.
type FileMatch struct {
FileName string
// Repository is the globally unique name of the repo of the
// match
Repository string
// SubRepositoryName is the globally unique name of the repo,
// if it came from a subrepository
SubRepositoryName string `json:",omitempty"`
// SubRepositoryPath holds the prefix where the subrepository
// was mounted.
SubRepositoryPath string `json:",omitempty"`
// Commit SHA1 (hex) of the (sub)repo holding the file.
Version string `json:",omitempty"`
// Detected language of the result.
Language string
// For debugging. Needs DebugScore set, but public so tests in
// other packages can print some diagnostics.
Debug string `json:",omitempty"`
Branches []string `json:",omitempty"`
// One of LineMatches or ChunkMatches will be returned depending on whether
// the SearchOptions.ChunkMatches is set.
LineMatches []LineMatch `json:",omitempty"`
ChunkMatches []ChunkMatch `json:",omitempty"`
// Only set if requested
Content []byte `json:",omitempty"`
// Checksum of the content.
Checksum []byte
// Ranking; the higher, the better.
Score float64 `json:",omitempty"`
// RepositoryPriority is a Sourcegraph extension. It is used by Sourcegraph to
// order results from different repositories relative to each other.
RepositoryPriority float64 `json:",omitempty"`
// RepositoryID is a Sourcegraph extension. This is the ID of Repository in
// Sourcegraph.
RepositoryID uint32 `json:",omitempty"`
}
func (m *FileMatch) sizeBytes() (sz uint64) {
// Score
sz += 8
for _, s := range []string{
m.Debug,
m.FileName,
m.Repository,
m.Language,
m.SubRepositoryName,
m.SubRepositoryPath,
m.Version,
} {
sz += stringHeaderBytes + uint64(len(s))
}
// Branches
sz += sliceHeaderBytes
for _, s := range m.Branches {
sz += stringHeaderBytes + uint64(len(s))
}
// LineMatches
sz += sliceHeaderBytes
for _, lm := range m.LineMatches {
sz += lm.sizeBytes()
}
// ChunkMatches
sz += sliceHeaderBytes
for _, cm := range m.ChunkMatches {
sz += cm.sizeBytes()
}
// RepositoryID
sz += 4
// RepositoryPriority
sz += 8
// Content
sz += sliceHeaderBytes + uint64(len(m.Content))
// Checksum
sz += sliceHeaderBytes + uint64(len(m.Checksum))
return
}
// ChunkMatch is a set of non-overlapping matches within a contiguous range of
// lines in the file.
type ChunkMatch struct {
DebugScore string
// Content is a contiguous range of complete lines that fully contains Ranges.
// Lines will always include their terminating newline (if it exists).
Content []byte
// Ranges is a set of matching ranges within this chunk. Each range is relative
// to the beginning of the file (not the beginning of Content).
Ranges []Range
// SymbolInfo is the symbol information associated with Ranges. If it is non-nil,
// its length will equal that of Ranges. Any of its elements may be nil.
SymbolInfo []*Symbol
// FileName indicates whether this match is a match on the file name, in
// which case Content will contain the file name.
FileName bool
// ContentStart is the location (inclusive) of the beginning of content
// relative to the beginning of the file. It will always be at the
// beginning of a line (Column will always be 1).
ContentStart Location
Score float64
}
func (cm *ChunkMatch) sizeBytes() (sz uint64) {
// Content
sz += sliceHeaderBytes + uint64(len(cm.Content))
// ContentStart
sz += cm.ContentStart.sizeBytes()
// FileName
sz += 1
// Ranges
sz += sliceHeaderBytes
if len(cm.Ranges) > 0 {
sz += uint64(len(cm.Ranges)) * cm.Ranges[0].sizeBytes()
}
// SymbolInfo
sz += sliceHeaderBytes
for _, si := range cm.SymbolInfo {
sz += pointerSize
if si != nil {
sz += si.sizeBytes()
}
}
// Score
sz += 8
// DebugScore
sz += stringHeaderBytes + uint64(len(cm.DebugScore))
return
}
type Range struct {
// The inclusive beginning of the range.
Start Location
// The exclusive end of the range.
End Location
}
func (r *Range) sizeBytes() uint64 {
return r.Start.sizeBytes() + r.End.sizeBytes()
}
type Location struct {
// 0-based byte offset from the beginning of the file
ByteOffset uint32
// 1-based line number from the beginning of the file
LineNumber uint32
// 1-based column number (in runes) from the beginning of line
Column uint32
}
func (l *Location) sizeBytes() uint64 {
return 3 * 4
}
// LineMatch holds the matches within a single line in a file.
type LineMatch struct {
// The line in which a match was found.
Line []byte
// The byte offset of the first byte of the line.
LineStart int
// The byte offset of the first byte past the end of the line.
// This is usually the byte after the terminating newline, but can also be
// the end of the file if there is no terminating newline
LineEnd int
LineNumber int
// Before and After are only set when SearchOptions.NumContextLines is > 0
Before []byte
After []byte
// If set, this was a match on the filename.
FileName bool
// The higher the better. Only ranks the quality of the match
// within the file, does not take rank of file into account
Score float64
DebugScore string
LineFragments []LineFragmentMatch
}
func (lm *LineMatch) sizeBytes() (sz uint64) {
// Line
sz += sliceHeaderBytes + uint64(len(lm.Line))
// LineStart, LineEnd, LineNumber
sz += 3 * 8
// Before
sz += sliceHeaderBytes + uint64(len(lm.Before))
// After
sz += sliceHeaderBytes + uint64(len(lm.After))
// FileName
sz += 1
// Score
sz += 8
// DebugScore
sz += stringHeaderBytes + uint64(len(lm.DebugScore))
// LineFragments
sz += sliceHeaderBytes
for _, lf := range lm.LineFragments {
sz += lf.sizeBytes()
}
return
}
type Symbol struct {
Sym string
Kind string
Parent string
ParentKind string
}
func (s *Symbol) sizeBytes() uint64 {
return 4*stringHeaderBytes + uint64(len(s.Sym)+len(s.Kind)+len(s.Parent)+len(s.ParentKind))
}
// LineFragmentMatch a segment of matching text within a line.
type LineFragmentMatch struct {
// Offset within the line, in bytes.
LineOffset int
// Offset from file start, in bytes.
Offset uint32
// Number bytes that match.
MatchLength int
SymbolInfo *Symbol
}
func (lfm *LineFragmentMatch) sizeBytes() (sz uint64) {
// LineOffset
sz += 8
// Offset
sz += 4
// MatchLength
sz += 8
// SymbolInfo
sz += pointerSize
if lfm.SymbolInfo != nil {
sz += lfm.SymbolInfo.sizeBytes()
}
return
}
type FlushReason uint8
const (
FlushReasonTimerExpired FlushReason = 1 << iota
FlushReasonFinalFlush
FlushReasonMaxSize
)
var FlushReasonStrings = map[FlushReason]string{
FlushReasonTimerExpired: "timer_expired",
FlushReasonFinalFlush: "final_flush",
FlushReasonMaxSize: "max_size_reached",
}
func (fr FlushReason) String() string {
if v, ok := FlushReasonStrings[fr]; ok {
return v
}
return "none"
}
// Stats contains interesting numbers on the search
type Stats struct {
// Amount of I/O for reading contents.
ContentBytesLoaded int64
// Amount of I/O for reading from index.
IndexBytesLoaded int64
// Number of search shards that had a crash.
Crashes int
// Wall clock time for this search
Duration time.Duration
// Number of files containing a match.
FileCount int
// Number of files in shards that we considered.
ShardFilesConsidered int
// Files that we evaluated. Equivalent to files for which all
// atom matches (including negations) evaluated to true.
FilesConsidered int
// Files for which we loaded file content to verify substring matches
FilesLoaded int
// Candidate files whose contents weren't examined because we
// gathered enough matches.
FilesSkipped int
// Shards that we scanned to find matches.
ShardsScanned int
// Shards that we did not process because a query was canceled.
ShardsSkipped int
// Shards that we did not process because the query was rejected by the
// ngram filter indicating it had no matches.
ShardsSkippedFilter int
// Number of non-overlapping matches
MatchCount int
// Number of candidate matches as a result of searching ngrams.
NgramMatches int
// NgramLookups is the number of times we accessed an ngram in the index.
NgramLookups int
// Wall clock time for queued search.
Wait time.Duration
// Aggregate wall clock time spent constructing and pruning the match tree.
// This accounts for time such as lookups in the trigram index.
MatchTreeConstruction time.Duration
// Aggregate wall clock time spent searching the match tree. This accounts
// for the bulk of search work done looking for matches.
MatchTreeSearch time.Duration
// Number of times regexp was called on files that we evaluated.
RegexpsConsidered int
// FlushReason explains why results were flushed.
FlushReason FlushReason
}
func (s *Stats) sizeBytes() (sz uint64) {
sz = 16 * 8 // This assumes we are running on a 64-bit architecture
sz += 1 // FlushReason
return
}
func (s *Stats) Add(o Stats) {
s.ContentBytesLoaded += o.ContentBytesLoaded
s.IndexBytesLoaded += o.IndexBytesLoaded
s.Crashes += o.Crashes
s.FileCount += o.FileCount
s.FilesConsidered += o.FilesConsidered
s.FilesLoaded += o.FilesLoaded
s.FilesSkipped += o.FilesSkipped
s.MatchCount += o.MatchCount
s.NgramMatches += o.NgramMatches
s.NgramLookups += o.NgramLookups
s.ShardFilesConsidered += o.ShardFilesConsidered
s.ShardsScanned += o.ShardsScanned
s.ShardsSkipped += o.ShardsSkipped
s.ShardsSkippedFilter += o.ShardsSkippedFilter
s.Wait += o.Wait
s.MatchTreeConstruction += o.MatchTreeConstruction
s.MatchTreeSearch += o.MatchTreeSearch
s.RegexpsConsidered += o.RegexpsConsidered
// We want the first non-zero FlushReason to be sticky. This is a useful
// property when aggregating stats from several Zoekts.
if s.FlushReason == 0 {
s.FlushReason = o.FlushReason
}
}
// Zero returns true if stats is empty.
func (s *Stats) Zero() bool {
if s == nil {
return true
}
return !(s.ContentBytesLoaded > 0 ||
s.IndexBytesLoaded > 0 ||
s.Crashes > 0 ||
s.FileCount > 0 ||
s.FilesConsidered > 0 ||
s.FilesLoaded > 0 ||
s.FilesSkipped > 0 ||
s.MatchCount > 0 ||
s.NgramMatches > 0 ||
s.NgramLookups > 0 ||
s.ShardFilesConsidered > 0 ||
s.ShardsScanned > 0 ||
s.ShardsSkipped > 0 ||
s.ShardsSkippedFilter > 0 ||
s.Wait > 0 ||
s.MatchTreeConstruction > 0 ||
s.MatchTreeSearch > 0 ||
s.RegexpsConsidered > 0)
}
// Progress contains information about the global progress of the running search query.
// This is used by the frontend to reorder results and emit them when stable.
// Sourcegraph specific: this is used when querying multiple zoekt-webserver instances.
type Progress struct {
// Priority of the shard that was searched.
Priority float64
// MaxPendingPriority is the maximum priority of pending result that is being searched in parallel.
// This is used to reorder results when the result set is known to be stable-- that is, when a result's
// Priority is greater than the max(MaxPendingPriority) from the latest results of each backend, it can be returned to the user.
//
// MaxPendingPriority decreases monotonically in each SearchResult.
MaxPendingPriority float64
}
func (p *Progress) sizeBytes() uint64 {
return 2 * 8
}
// SearchResult contains search matches and extra data
type SearchResult struct {
Stats
// Do not encode this as we cannot encode -Inf in JSON
Progress `json:"-"`
Files []FileMatch
// RepoURLs holds a repo => template string map.
RepoURLs map[string]string
// FragmentNames holds a repo => template string map, for
// the line number fragment.
LineFragments map[string]string
}
// SizeBytes is a best-effort estimate of the size of SearchResult in memory.
// The estimate does not take alignment into account. The result is a lower
// bound on the actual size in memory.
func (sr *SearchResult) SizeBytes() (sz uint64) {
sz += sr.Stats.sizeBytes()
sz += sr.Progress.sizeBytes()
// Files
sz += sliceHeaderBytes
for _, f := range sr.Files {
sz += f.sizeBytes()
}
// RepoURLs
sz += mapHeaderBytes
for k, v := range sr.RepoURLs {
sz += stringHeaderBytes + uint64(len(k))
sz += stringHeaderBytes + uint64(len(v))
}
// LineFragments
sz += mapHeaderBytes
for k, v := range sr.LineFragments {
sz += stringHeaderBytes + uint64(len(k))
sz += stringHeaderBytes + uint64(len(v))
}
return
}
// RepositoryBranch describes an indexed branch, which is a name
// combined with a version.
type RepositoryBranch struct {
Name string
Version string
}
func (r RepositoryBranch) String() string {
return fmt.Sprintf("%s@%s", r.Name, r.Version)
}
// Repository holds repository metadata.
type Repository struct {
// Sourcegraph's repository ID
ID uint32
// The repository name
Name string
// The repository URL.
URL string
// The physical source where this repo came from, eg. full
// path to the zip filename or git repository directory. This
// will not be exposed in the UI, but can be used to detect
// orphaned index shards.
Source string
// The branches indexed in this repo.
Branches []RepositoryBranch
// Nil if this is not the super project.
SubRepoMap map[string]*Repository
// URL template to link to the commit of a branch
CommitURLTemplate string
// The repository URL for getting to a file. Has access to
// {{.Version}}, {{.Path}}
FileURLTemplate string
// The URL fragment to add to a file URL for line numbers. has
// access to {{.LineNumber}}. The fragment should include the
// separator, generally '#' or ';'.
LineFragmentTemplate string
// Perf optimization: priority is set when we load the shard. It corresponds to
// the value of "priority" stored in RawConfig.
priority float64
// All zoekt.* configuration settings.
RawConfig map[string]string
// Importance of the repository, bigger is more important
Rank uint16
// IndexOptions is a hash of the options used to create the index for the
// repo.
IndexOptions string
// HasSymbols is true if this repository has indexed ctags
// output. Sourcegraph specific: This field is more appropriate for
// IndexMetadata. However, we store it here since the Sourcegraph frontend
// can read this structure but not IndexMetadata.
HasSymbols bool
// Tombstone is true if we are not allowed to search this repo.
Tombstone bool
// LatestCommitDate is the date of the latest commit among all indexed Branches.
// The date might be time.Time's 0-value if the repository was last indexed
// before this field was added.
LatestCommitDate time.Time
// FileTombstones is a set of file paths that should be ignored across all branches
// in this shard.
FileTombstones map[string]struct{} `json:",omitempty"`
}
func (r *Repository) UnmarshalJSON(data []byte) error {
// We define a new type so that we can use json.Unmarshal
// without recursing into this same method.
type repository *Repository
repo := repository(r)
err := json.Unmarshal(data, repo)
if err != nil {
return err
}
if v, ok := repo.RawConfig["repoid"]; ok {
id, _ := strconv.ParseUint(v, 10, 32)
r.ID = uint32(id)
}
if v, ok := repo.RawConfig["priority"]; ok {
r.priority, err = strconv.ParseFloat(v, 64)
if err != nil {
r.priority = 0
}
// Sourcegraph indexserver doesn't set repo.Rank, so we set it here
// based on priority. Setting it on read instead of during indexing
// allows us to avoid a complete reindex.
if r.Rank == 0 && r.priority > 0 {
// Normalize the repo score within [0, 1), with the midpoint at 5,000. This means popular
// repos (roughly ones with over 5,000 stars) see diminishing returns from more stars.
r.Rank = uint16(r.priority / (5000.0 + r.priority) * maxUInt16)
}
}
return nil
}
// MergeMutable will merge x into r. mutated will be true if it made any
// changes. err is non-nil if we needed to mutate an immutable field.
//
// Note: SubRepoMap, IndexOptions and HasSymbol fields are ignored. They are
// computed while indexing so can't be synthesized from x.
//
// Note: We ignore RawConfig fields which are duplicated into Repository:
// name and id.
func (r *Repository) MergeMutable(x *Repository) (mutated bool, err error) {
if r.ID != x.ID {
// Sourcegraph: strange behaviour may occur if ID changes but names don't.
return mutated, errors.New("ID is immutable")
}
if r.Name != x.Name {
// Name is encoded into the shard name on disk. We need to re-index if it
// changes.
return mutated, errors.New("Name is immutable")
}
if !reflect.DeepEqual(r.Branches, x.Branches) {
// Need a reindex if content changing.
return mutated, errors.New("Branches is immutable")
}
for k, v := range x.RawConfig {
// We ignore name and id since they are encoded into the repository.
if k == "name" || k == "id" {
continue
}
if r.RawConfig == nil {
mutated = true
r.RawConfig = make(map[string]string)
}
if r.RawConfig[k] != v {
mutated = true
r.RawConfig[k] = v
}
}
if r.URL != x.URL {
mutated = true
r.URL = x.URL
}
if r.CommitURLTemplate != x.CommitURLTemplate {
mutated = true
r.CommitURLTemplate = x.CommitURLTemplate
}
if r.FileURLTemplate != x.FileURLTemplate {
mutated = true
r.FileURLTemplate = x.FileURLTemplate
}
if r.LineFragmentTemplate != x.LineFragmentTemplate {
mutated = true
r.LineFragmentTemplate = x.LineFragmentTemplate
}
return mutated, nil
}
// IndexMetadata holds metadata stored in the index file. It contains
// data generated by the core indexing library.
type IndexMetadata struct {
IndexFormatVersion int
IndexFeatureVersion int
IndexMinReaderVersion int
IndexTime time.Time
PlainASCII bool
LanguageMap map[string]uint16
ZoektVersion string
ID string
}
// Statistics of a (collection of) repositories.
type RepoStats struct {
// Repos is used for aggregrating the number of repositories.
//
// Note: This field is not populated on RepoListEntry.Stats (individual) but
// only for RepoList.Stats (aggregate).
Repos int
// Shards is the total number of search shards.
Shards int
// Documents holds the number of documents or files.
Documents int
// IndexBytes is the amount of RAM used for index overhead.
IndexBytes int64
// ContentBytes is the amount of RAM used for raw content.
ContentBytes int64
// Sourcegraph specific stats below. These are not as efficient to calculate
// as the above statistics. We experimentally measured about a 10% slower
// shard load time. However, we find these values very useful to track and
// computing them outside of load time introduces a lot of complexity.
// NewLinesCount is the number of newlines "\n" that appear in the zoekt
// indexed documents. This is not exactly the same as line count, since it
// will not include lines not terminated by "\n" (eg a file with no "\n", or
// a final line without "\n"). Note: Zoekt deduplicates documents across
// branches, so if a path has the same contents on multiple branches, there
// is only one document for it. As such that document's newlines is only
// counted once. See DefaultBranchNewLinesCount and AllBranchesNewLinesCount
// for counts which do not deduplicate.
NewLinesCount uint64
// DefaultBranchNewLinesCount is the number of newlines "\n" in the default
// branch.
DefaultBranchNewLinesCount uint64
// OtherBranchesNewLinesCount is the number of newlines "\n" in all branches
// except the default branch.
OtherBranchesNewLinesCount uint64
}
func (s *RepoStats) Add(o *RepoStats) {
// can't update Repos, since one repo may have multiple
// shards.
s.Shards += o.Shards
s.IndexBytes += o.IndexBytes
s.Documents += o.Documents
s.ContentBytes += o.ContentBytes
// Sourcegraph specific
s.NewLinesCount += o.NewLinesCount
s.DefaultBranchNewLinesCount += o.DefaultBranchNewLinesCount
s.OtherBranchesNewLinesCount += o.OtherBranchesNewLinesCount
}
type RepoListEntry struct {
Repository Repository
IndexMetadata IndexMetadata
Stats RepoStats
}
// MinimalRepoListEntry is a subset of RepoListEntry. It was added after
// performance profiling of sourcegraph.com revealed that querying this
// information from Zoekt was causing lots of CPU and memory usage. Note: we
// can revisit this, how we store and query this information has changed a lot
// since this was introduced.
type MinimalRepoListEntry struct {
// HasSymbols is exported since Sourcegraph uses this information at search
// planning time to decide between Zoekt and an unindexed symbol search.
//
// Note: it pretty much is always true in practice.
HasSymbols bool
// Branches is used by Sourcegraphs query planner to decided if it can use
// zoekt or go via an unindexed code path.
Branches []RepositoryBranch
// IndexTimeUnix is the IndexTime converted to unix time (number of seconds
// since the epoch). This is to make it clear we are not transporting the
// full fidelty timestamp (ie with milliseconds and location). Additionally
// it saves 16 bytes in this struct.
//
// IndexTime is used as a heuristic in Sourcegraph to decide in aggregate
// how many repositories need updating after a ranking change/etc.
//
// TODO(keegancsmith) audit updates to IndexTime and document how and when
// it changes. Concerned about things like metadata updates or compound
// shards leading to untrustworthy data here.
IndexTimeUnix int64
}
type ReposMap map[uint32]MinimalRepoListEntry
// MarshalBinary implements a specialized encoder for ReposMap.
func (q *ReposMap) MarshalBinary() ([]byte, error) {
return reposMapEncode(*q)
}
// UnmarshalBinary implements a specialized decoder for ReposMap.
func (q *ReposMap) UnmarshalBinary(b []byte) error {
var err error
(*q), err = reposMapDecode(b)
return err
}
// RepoList holds a set of Repository metadata.
type RepoList struct {
// Returned when ListOptions.Field is RepoListFieldRepos.
Repos []*RepoListEntry
// ReposMap is set when ListOptions.Field is RepoListFieldReposMap.
ReposMap ReposMap
Crashes int
// Stats response to a List request.
// This is the aggregate RepoStats of all repos matching the input query.
Stats RepoStats
}
type Searcher interface {
Search(ctx context.Context, q query.Q, opts *SearchOptions) (*SearchResult, error)
// List lists repositories. The query `q` can only contain
// query.Repo atoms.
List(ctx context.Context, q query.Q, opts *ListOptions) (*RepoList, error)
Close()
// Describe the searcher for debug messages.
String() string
}
type RepoListField int
const (
RepoListFieldRepos RepoListField = 0
RepoListFieldReposMap = 2
)
type ListOptions struct {
// Field decides which field to populate in RepoList response.
Field RepoListField
// Username of the user running the query in the neogrok frontend.
// used for restricting the user to the repoACL
UserName string
}
func (o *ListOptions) GetField() (RepoListField, error) {
if o == nil {
return RepoListFieldRepos, nil
}
switch o.Field {
case RepoListFieldRepos, RepoListFieldReposMap:
return o.Field, nil
case 1:
return 0, fmt.Errorf("RepoListFieldMinimal (%d) is no longer supported", o.Field)
default:
return 0, fmt.Errorf("unknown RepoListField %d", o.Field)
}
}
func (o *ListOptions) String() string {
return fmt.Sprintf("%#v", o)
}
type SearchOptions struct {
// Return an upper-bound estimate of eligible documents in
// stats.ShardFilesConsidered.
EstimateDocCount bool
// Return the whole file.
Whole bool
// Maximum number of matches: skip all processing an index
// shard after we found this many non-overlapping matches.
ShardMaxMatchCount int
// Maximum number of matches: stop looking for more matches
// once we have this many matches across shards.
TotalMaxMatchCount int
// Maximum number of matches: skip processing documents for a repository in
// a shard once we have found ShardRepoMaxMatchCount.
//
// A compound shard may contain multiple repositories. This will most often
// be set to 1 to find all repositories containing a result.
ShardRepoMaxMatchCount int
// Abort the search after this much time has passed.
MaxWallTime time.Duration
// FlushWallTime if non-zero will stop streaming behaviour at first and
// instead will collate and sort results. At FlushWallTime the results will
// be sent and then the behaviour will revert to the normal streaming.
FlushWallTime time.Duration
// Truncates the number of documents (i.e. files) after collating and
// sorting the results.
MaxDocDisplayCount int
// Truncates the number of matchs after collating and sorting the results.
MaxMatchDisplayCount int
// If set to a number greater than zero then up to this many number
// of context lines will be added before and after each matched line.
// Note that the included context lines might contain matches and
// it's up to the consumer of the result to remove those lines.
NumContextLines int
// If true, ChunkMatches will be returned in each FileMatch rather than LineMatches
// EXPERIMENTAL: the behavior of this flag may be changed in future versions.
ChunkMatches bool
// EXPERIMENTAL. If true, document ranks are used as additional input for
// sorting matches.
UseDocumentRanks bool
// EXPERIMENTAL. When UseDocumentRanks is enabled, this can be optionally set to adjust
// their weight in the file match score. If the value is <= 0.0, the default weight value
// will be used. This option is temporary and is only exposed for testing/ tuning purposes.
DocumentRanksWeight float64
// EXPERIMENTAL. If true, use text-search style scoring instead of the default
// scoring formula. The scoring algorithm treats each match in a file as a term
// and computes an approximation to BM25.
//
// The calculation of IDF assumes that Zoekt visits all documents containing any
// of the query terms during evaluation. This is true, for example, if all query
// terms are ORed together.
//
// When enabled, all other scoring signals are ignored, including document ranks.
UseBM25Scoring bool
// Trace turns on opentracing for this request if true and if the Jaeger address was provided as
// a command-line flag
Trace bool
// If set, the search results will contain debug information for scoring.
DebugScore bool
// SpanContext is the opentracing span context, if it exists, from the zoekt client
SpanContext map[string]string
// Username of the user running the query in the neogrok frontend.
// used for restricting the user to the repoACL
UserName string
}
// String returns a succinct representation of the options. This is meant for
// human consumption in logs and traces.
//
// Note: some tracing systems have limits on length of values, so we take care
// to try and make this small, and include the important information near the
// front incase of truncation.
func (s *SearchOptions) String() string {
var b strings.Builder
add := func(name, value string) {
b.WriteString(name)
b.WriteByte('=')
b.WriteString(value)
b.WriteByte(' ')
}
addInt := func(name string, value int) {
if value != 0 {
add(name, strconv.Itoa(value))
}
}
addDuration := func(name string, value time.Duration) {
if value != 0 {