1package cache
2
3import (
4 "bytes"
5 "encoding/gob"
6 "errors"
7 "fmt"
8 "sort"
9 "strings"
10 "time"
11
12 "github.com/MichaelMure/git-bug/bug"
13 "github.com/MichaelMure/git-bug/entity"
14 "github.com/MichaelMure/git-bug/query"
15 "github.com/MichaelMure/git-bug/repository"
16 "github.com/blevesearch/bleve"
17)
18
19const (
20 bugCacheFile = "bug-cache"
21 searchCacheDir = "search-cache"
22)
23
24var errBugNotInCache = errors.New("bug missing from cache")
25
26// bugUpdated is a callback to trigger when the excerpt of a bug changed,
27// that is each time a bug is updated
28func (c *RepoCache) bugUpdated(id entity.Id) error {
29 c.muBug.Lock()
30 b, ok := c.bugs[id]
31 if !ok {
32 c.muBug.Unlock()
33
34 // if the bug is not loaded at this point, it means it was loaded before
35 // but got evicted. Which means we potentially have multiple copies in
36 // memory and thus concurrent write.
37 // Failing immediately here is the simple and safe solution to avoid
38 // complicated data loss.
39 return errBugNotInCache
40 }
41 c.loadedBugs.Get(id)
42 c.bugExcerpts[id] = NewBugExcerpt(b.bug, b.Snapshot())
43 c.muBug.Unlock()
44
45 if err := c.addBugToSearchIndex(b.Snapshot()); err != nil {
46 return err
47 }
48
49 // we only need to write the bug cache
50 return c.writeBugCache()
51}
52
53// load will try to read from the disk the bug cache file
54func (c *RepoCache) loadBugCache() error {
55 c.muBug.Lock()
56 defer c.muBug.Unlock()
57
58 f, err := c.repo.LocalStorage().Open(bugCacheFile)
59 if err != nil {
60 return err
61 }
62
63 decoder := gob.NewDecoder(f)
64
65 aux := struct {
66 Version uint
67 Excerpts map[entity.Id]*BugExcerpt
68 }{}
69
70 err = decoder.Decode(&aux)
71 if err != nil {
72 return err
73 }
74
75 if aux.Version != formatVersion {
76 return fmt.Errorf("unknown cache format version %v", aux.Version)
77 }
78
79 c.bugExcerpts = aux.Excerpts
80
81 index, err := c.repo.GetBleveIndex("bug")
82 if err != nil {
83 return err
84 }
85
86 // simple heuristic to detect a mismatch between the index and the bugs
87 count, err := index.DocCount()
88 if err != nil {
89 return err
90 }
91 if count != uint64(len(c.bugExcerpts)) {
92 return fmt.Errorf("count mismatch between bleve and bug excerpts")
93 }
94
95 return nil
96}
97
98// write will serialize on disk the bug cache file
99func (c *RepoCache) writeBugCache() error {
100 c.muBug.RLock()
101 defer c.muBug.RUnlock()
102
103 var data bytes.Buffer
104
105 aux := struct {
106 Version uint
107 Excerpts map[entity.Id]*BugExcerpt
108 }{
109 Version: formatVersion,
110 Excerpts: c.bugExcerpts,
111 }
112
113 encoder := gob.NewEncoder(&data)
114
115 err := encoder.Encode(aux)
116 if err != nil {
117 return err
118 }
119
120 f, err := c.repo.LocalStorage().Create(bugCacheFile)
121 if err != nil {
122 return err
123 }
124
125 _, err = f.Write(data.Bytes())
126 if err != nil {
127 return err
128 }
129
130 return f.Close()
131}
132
133// ResolveBugExcerpt retrieve a BugExcerpt matching the exact given id
134func (c *RepoCache) ResolveBugExcerpt(id entity.Id) (*BugExcerpt, error) {
135 c.muBug.RLock()
136 defer c.muBug.RUnlock()
137
138 excerpt, ok := c.bugExcerpts[id]
139 if !ok {
140 return nil, bug.ErrBugNotExist
141 }
142
143 return excerpt, nil
144}
145
146// ResolveBug retrieve a bug matching the exact given id
147func (c *RepoCache) ResolveBug(id entity.Id) (*BugCache, error) {
148 c.muBug.RLock()
149 cached, ok := c.bugs[id]
150 if ok {
151 c.loadedBugs.Get(id)
152 c.muBug.RUnlock()
153 return cached, nil
154 }
155 c.muBug.RUnlock()
156
157 b, err := bug.ReadLocalWithResolver(c.repo, newIdentityCacheResolver(c), id)
158 if err != nil {
159 return nil, err
160 }
161
162 cached = NewBugCache(c, b)
163
164 c.muBug.Lock()
165 c.bugs[id] = cached
166 c.loadedBugs.Add(id)
167 c.muBug.Unlock()
168
169 c.evictIfNeeded()
170
171 return cached, nil
172}
173
174// evictIfNeeded will evict a bug from the cache if needed
175// it also removes references of the bug from the bugs
176func (c *RepoCache) evictIfNeeded() {
177 c.muBug.Lock()
178 defer c.muBug.Unlock()
179 if c.loadedBugs.Len() <= c.maxLoadedBugs {
180 return
181 }
182
183 for _, id := range c.loadedBugs.GetOldestToNewest() {
184 b := c.bugs[id]
185 if b.NeedCommit() {
186 continue
187 }
188
189 b.mu.Lock()
190 c.loadedBugs.Remove(id)
191 delete(c.bugs, id)
192
193 if c.loadedBugs.Len() <= c.maxLoadedBugs {
194 return
195 }
196 }
197}
198
199// ResolveBugExcerptPrefix retrieve a BugExcerpt matching an id prefix. It fails if multiple
200// bugs match.
201func (c *RepoCache) ResolveBugExcerptPrefix(prefix string) (*BugExcerpt, error) {
202 return c.ResolveBugExcerptMatcher(func(excerpt *BugExcerpt) bool {
203 return excerpt.Id.HasPrefix(prefix)
204 })
205}
206
207// ResolveBugPrefix retrieve a bug matching an id prefix. It fails if multiple
208// bugs match.
209func (c *RepoCache) ResolveBugPrefix(prefix string) (*BugCache, error) {
210 return c.ResolveBugMatcher(func(excerpt *BugExcerpt) bool {
211 return excerpt.Id.HasPrefix(prefix)
212 })
213}
214
215// ResolveBugCreateMetadata retrieve a bug that has the exact given metadata on
216// its Create operation, that is, the first operation. It fails if multiple bugs
217// match.
218func (c *RepoCache) ResolveBugCreateMetadata(key string, value string) (*BugCache, error) {
219 return c.ResolveBugMatcher(func(excerpt *BugExcerpt) bool {
220 return excerpt.CreateMetadata[key] == value
221 })
222}
223
224func (c *RepoCache) ResolveBugExcerptMatcher(f func(*BugExcerpt) bool) (*BugExcerpt, error) {
225 id, err := c.resolveBugMatcher(f)
226 if err != nil {
227 return nil, err
228 }
229 return c.ResolveBugExcerpt(id)
230}
231
232func (c *RepoCache) ResolveBugMatcher(f func(*BugExcerpt) bool) (*BugCache, error) {
233 id, err := c.resolveBugMatcher(f)
234 if err != nil {
235 return nil, err
236 }
237 return c.ResolveBug(id)
238}
239
240func (c *RepoCache) resolveBugMatcher(f func(*BugExcerpt) bool) (entity.Id, error) {
241 c.muBug.RLock()
242 defer c.muBug.RUnlock()
243
244 // preallocate but empty
245 matching := make([]entity.Id, 0, 5)
246
247 for _, excerpt := range c.bugExcerpts {
248 if f(excerpt) {
249 matching = append(matching, excerpt.Id)
250 }
251 }
252
253 if len(matching) > 1 {
254 return entity.UnsetId, bug.NewErrMultipleMatchBug(matching)
255 }
256
257 if len(matching) == 0 {
258 return entity.UnsetId, bug.ErrBugNotExist
259 }
260
261 return matching[0], nil
262}
263
264// QueryBugs return the id of all Bug matching the given Query
265func (c *RepoCache) QueryBugs(q *query.Query) ([]entity.Id, error) {
266 c.muBug.RLock()
267 defer c.muBug.RUnlock()
268
269 if q == nil {
270 return c.AllBugsIds(), nil
271 }
272
273 matcher := compileMatcher(q.Filters)
274
275 var filtered []*BugExcerpt
276 var foundBySearch map[entity.Id]*BugExcerpt
277
278 if q.Search != nil {
279 foundBySearch = map[entity.Id]*BugExcerpt{}
280
281 terms := make([]string, len(q.Search))
282 copy(terms, q.Search)
283 for i, search := range q.Search {
284 if strings.Contains(search, " ") {
285 terms[i] = fmt.Sprintf("\"%s\"", search)
286 }
287 }
288
289 bleveQuery := bleve.NewQueryStringQuery(strings.Join(terms, " "))
290 bleveSearch := bleve.NewSearchRequest(bleveQuery)
291
292 index, err := c.repo.GetBleveIndex("bug")
293 if err != nil {
294 return nil, err
295 }
296
297 searchResults, err := index.Search(bleveSearch)
298 if err != nil {
299 return nil, err
300 }
301
302 for _, hit := range searchResults.Hits {
303 foundBySearch[entity.Id(hit.ID)] = c.bugExcerpts[entity.Id(hit.ID)]
304 }
305 } else {
306 foundBySearch = c.bugExcerpts
307 }
308
309 for _, excerpt := range foundBySearch {
310 if matcher.Match(excerpt, c) {
311 filtered = append(filtered, excerpt)
312 }
313 }
314
315 var sorter sort.Interface
316
317 switch q.OrderBy {
318 case query.OrderById:
319 sorter = BugsById(filtered)
320 case query.OrderByCreation:
321 sorter = BugsByCreationTime(filtered)
322 case query.OrderByEdit:
323 sorter = BugsByEditTime(filtered)
324 default:
325 return nil, errors.New("missing sort type")
326 }
327
328 switch q.OrderDirection {
329 case query.OrderAscending:
330 // Nothing to do
331 case query.OrderDescending:
332 sorter = sort.Reverse(sorter)
333 default:
334 return nil, errors.New("missing sort direction")
335 }
336
337 sort.Sort(sorter)
338
339 result := make([]entity.Id, len(filtered))
340
341 for i, val := range filtered {
342 result[i] = val.Id
343 }
344
345 return result, nil
346}
347
348// AllBugsIds return all known bug ids
349func (c *RepoCache) AllBugsIds() []entity.Id {
350 c.muBug.RLock()
351 defer c.muBug.RUnlock()
352
353 result := make([]entity.Id, len(c.bugExcerpts))
354
355 i := 0
356 for _, excerpt := range c.bugExcerpts {
357 result[i] = excerpt.Id
358 i++
359 }
360
361 return result
362}
363
364// ValidLabels list valid labels
365//
366// Note: in the future, a proper label policy could be implemented where valid
367// labels are defined in a configuration file. Until that, the default behavior
368// is to return the list of labels already used.
369func (c *RepoCache) ValidLabels() []bug.Label {
370 c.muBug.RLock()
371 defer c.muBug.RUnlock()
372
373 set := map[bug.Label]interface{}{}
374
375 for _, excerpt := range c.bugExcerpts {
376 for _, l := range excerpt.Labels {
377 set[l] = nil
378 }
379 }
380
381 result := make([]bug.Label, len(set))
382
383 i := 0
384 for l := range set {
385 result[i] = l
386 i++
387 }
388
389 // Sort
390 sort.Slice(result, func(i, j int) bool {
391 return string(result[i]) < string(result[j])
392 })
393
394 return result
395}
396
397// NewBug create a new bug
398// The new bug is written in the repository (commit)
399func (c *RepoCache) NewBug(title string, message string) (*BugCache, *bug.CreateOperation, error) {
400 return c.NewBugWithFiles(title, message, nil)
401}
402
403// NewBugWithFiles create a new bug with attached files for the message
404// The new bug is written in the repository (commit)
405func (c *RepoCache) NewBugWithFiles(title string, message string, files []repository.Hash) (*BugCache, *bug.CreateOperation, error) {
406 author, err := c.GetUserIdentity()
407 if err != nil {
408 return nil, nil, err
409 }
410
411 return c.NewBugRaw(author, time.Now().Unix(), title, message, files, nil)
412}
413
414// NewBugWithFilesMeta create a new bug with attached files for the message, as
415// well as metadata for the Create operation.
416// The new bug is written in the repository (commit)
417func (c *RepoCache) NewBugRaw(author *IdentityCache, unixTime int64, title string, message string, files []repository.Hash, metadata map[string]string) (*BugCache, *bug.CreateOperation, error) {
418 b, op, err := bug.CreateWithFiles(author.Identity, unixTime, title, message, files)
419 if err != nil {
420 return nil, nil, err
421 }
422
423 for key, value := range metadata {
424 op.SetMetadata(key, value)
425 }
426
427 err = b.Commit(c.repo)
428 if err != nil {
429 return nil, nil, err
430 }
431
432 c.muBug.Lock()
433 if _, has := c.bugs[b.Id()]; has {
434 c.muBug.Unlock()
435 return nil, nil, fmt.Errorf("bug %s already exist in the cache", b.Id())
436 }
437
438 cached := NewBugCache(c, b)
439 c.bugs[b.Id()] = cached
440 c.loadedBugs.Add(b.Id())
441 c.muBug.Unlock()
442
443 c.evictIfNeeded()
444
445 // force the write of the excerpt
446 err = c.bugUpdated(b.Id())
447 if err != nil {
448 return nil, nil, err
449 }
450
451 return cached, op, nil
452}
453
454// RemoveBug removes a bug from the cache and repo given a bug id prefix
455func (c *RepoCache) RemoveBug(prefix string) error {
456 c.muBug.RLock()
457
458 b, err := c.ResolveBugPrefix(prefix)
459 if err != nil {
460 c.muBug.RUnlock()
461 return err
462 }
463 c.muBug.RUnlock()
464
465 c.muBug.Lock()
466 err = bug.RemoveBug(c.repo, b.Id())
467
468 delete(c.bugs, b.Id())
469 delete(c.bugExcerpts, b.Id())
470 c.loadedBugs.Remove(b.Id())
471
472 c.muBug.Unlock()
473
474 return c.writeBugCache()
475}
476
477func (c *RepoCache) addBugToSearchIndex(snap *bug.Snapshot) error {
478 searchableBug := struct {
479 Text []string
480 }{}
481
482 for _, comment := range snap.Comments {
483 searchableBug.Text = append(searchableBug.Text, comment.Message)
484 }
485
486 searchableBug.Text = append(searchableBug.Text, snap.Title)
487
488 index, err := c.repo.GetBleveIndex("bug")
489 if err != nil {
490 return err
491 }
492
493 err = index.Index(snap.Id().String(), searchableBug)
494 if err != nil {
495 return err
496 }
497
498 return nil
499}