forked from golang/dep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
source_cache_bolt.go
531 lines (484 loc) · 13.9 KB
/
source_cache_bolt.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
// Copyright 2017 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package gps
import (
"fmt"
"log"
"os"
"path"
"path/filepath"
"strings"
"time"
"github.com/boltdb/bolt"
"github.com/golang/dep/gps/internal/pb"
"github.com/golang/dep/gps/pkgtree"
"github.com/golang/protobuf/proto"
"github.com/jmank88/nuts"
"github.com/pkg/errors"
)
// boltCacheFilename is a versioned filename for the bolt cache. The version
// must be incremented whenever incompatible changes are made.
const boltCacheFilename = "bolt-v1.db"
// boltCache manages a bolt.DB cache and provides singleSourceCaches.
type boltCache struct {
db *bolt.DB
epoch int64 // getters will not return values older than this unix timestamp
logger *log.Logger // info logging
}
// newBoltCache returns a new boltCache backed by a BoltDB file under the cache directory.
func newBoltCache(cd string, epoch int64, logger *log.Logger) (*boltCache, error) {
path := filepath.Join(cd, boltCacheFilename)
dir := filepath.Dir(path)
if fi, err := os.Stat(dir); os.IsNotExist(err) {
if err := os.MkdirAll(dir, os.ModeDir|os.ModePerm); err != nil {
return nil, errors.Wrapf(err, "failed to create source cache directory: %s", dir)
}
} else if err != nil {
return nil, errors.Wrapf(err, "failed to check source cache directory: %s", dir)
} else if !fi.IsDir() {
return nil, errors.Wrapf(err, "source cache path is not directory: %s", dir)
}
db, err := bolt.Open(path, 0600, &bolt.Options{Timeout: 1 * time.Second})
if err != nil {
return nil, errors.Wrapf(err, "failed to open BoltDB cache file %q", path)
}
return &boltCache{
db: db,
epoch: epoch,
logger: logger,
}, nil
}
// newSingleSourceCache returns a new singleSourceCache for pi.
func (c *boltCache) newSingleSourceCache(pi ProjectIdentifier) singleSourceCache {
return &singleSourceCacheBolt{
boltCache: c,
sourceName: []byte(pi.normalizedSource()),
}
}
// close releases all cache resources.
func (c *boltCache) close() error {
return errors.Wrapf(c.db.Close(), "error closing Bolt database %q", c.db.String())
}
// singleSourceCacheBolt implements a singleSourceCache backed by a persistent BoltDB file.
// Version mappings are timestamped, and the `epoch` field limits the age of returned values.
// Database access methods are safe for concurrent use.
//
// Implementation:
//
// Each source has a top-level bucket containing sub-buckets for (1) versions and (2) revisions.
//
// 1) Versions buckets hold version keys with revision values:
//
// Bucket: "v<timestamp>"
// Keys: Unpaired Versions serialized via ConstraintMsg
// Values: "<revision>"
//
// 2) Revision buckets hold (a) manifest and lock data for various ProjectAnalyzers,
// (b) package trees, and (c) version lists.
//
// Bucket: "r<revision>"
//
// a) Manifest and Lock info are stored in buckets derived from ProjectAnalyzer.Info:
//
// Sub-Bucket: "<name>.<version>m", "<name>.<version>l"
// Keys/Values: Manifest or Lock fields
//
// b) Package tree buckets contain package import path keys and package-or-error buckets:
//
// Sub-Bucket: "p"
// Sub-Bucket: "<import_path>"
// Key/Values: PackageOrErr fields
//
// c) Revision-versions buckets contain lists of version values:
//
// Sub-Bucket: "v<timestamp>"
// Keys: "<sequence_number>"
// Values: Unpaired Versions serialized via ConstraintMsg
type singleSourceCacheBolt struct {
*boltCache
sourceName []byte
}
func (s *singleSourceCacheBolt) setManifestAndLock(rev Revision, ai ProjectAnalyzerInfo, m Manifest, l Lock) {
err := s.updateRevBucket(rev, func(b *bolt.Bucket) error {
info := ai.String()
name := make([]byte, len(info)+1)
copy(name, info)
name[len(info)] = 'm'
if b.Bucket(name) != nil {
if err := b.DeleteBucket(name); err != nil {
return err
}
}
// Manifest
mb, err := b.CreateBucket(name)
if err != nil {
return err
}
if err := cachePutManifest(mb, m); err != nil {
return errors.Wrap(err, "failed to put manifest")
}
if l == nil {
return nil
}
// Lock
name[len(info)] = 'l'
if b.Bucket(name) != nil {
if err := b.DeleteBucket(name); err != nil {
return err
}
}
lb, err := b.CreateBucket(name)
if err != nil {
return err
}
return errors.Wrap(cachePutLock(lb, l), "failed to put lock")
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to cache manifest/lock for revision %q, analyzer: %v", rev, ai))
}
}
func (s *singleSourceCacheBolt) getManifestAndLock(rev Revision, ai ProjectAnalyzerInfo) (m Manifest, l Lock, ok bool) {
err := s.viewRevBucket(rev, func(b *bolt.Bucket) error {
info := ai.String()
name := make([]byte, len(info)+1)
copy(name, info)
name[len(info)] = 'm'
// Manifest
mb := b.Bucket(name)
if mb == nil {
return nil
}
var err error
m, err = cacheGetManifest(mb)
if err != nil {
return errors.Wrap(err, "failed to get manifest")
}
// Lock
name[len(info)] = 'l'
lb := b.Bucket(name)
if lb == nil {
ok = true
return nil
}
l, err = cacheGetLock(lb)
if err != nil {
return errors.Wrap(err, "failed to get lock")
}
ok = true
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to get cached manifest/lock for revision %q, analyzer: %v", rev, ai))
}
return
}
func (s *singleSourceCacheBolt) setPackageTree(rev Revision, ptree pkgtree.PackageTree) {
err := s.updateRevBucket(rev, func(b *bolt.Bucket) error {
if b.Bucket(cacheKeyPTree) != nil {
if err := b.DeleteBucket(cacheKeyPTree); err != nil {
return err
}
}
ptrees, err := b.CreateBucket(cacheKeyPTree)
if err != nil {
return err
}
root := string(ptree.ImportRoot)
for ip, poe := range ptree.Packages {
// Stored by relative import path.
rip := strings.TrimPrefix(ip, root)
if rip == "" {
rip = "/"
}
pb, err := ptrees.CreateBucket([]byte(rip))
if err != nil {
return err
}
if err := cachePutPackageOrErr(pb, poe); err != nil {
return err
}
}
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to cache package tree for revision %q", rev))
}
}
func (s *singleSourceCacheBolt) getPackageTree(rev Revision, pr ProjectRoot) (ptree pkgtree.PackageTree, ok bool) {
err := s.viewRevBucket(rev, func(b *bolt.Bucket) error {
ptrees := b.Bucket(cacheKeyPTree)
if ptrees == nil {
return nil
}
pkgs := make(map[string]pkgtree.PackageOrErr)
err := ptrees.ForEach(func(rip, _ []byte) error {
poe, err := cacheGetPackageOrErr(ptrees.Bucket(rip))
if err != nil {
return err
}
srip := string(rip)
if srip == "/" {
srip = ""
}
// Return full import paths.
ip := path.Join(string(pr), srip)
if poe.Err == nil {
poe.P.ImportPath = ip
}
pkgs[ip] = poe
return nil
})
if err != nil {
return err
}
ptree.ImportRoot = string(pr)
ptree.Packages = pkgs
ok = true
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to get cached package tree for revision %q", rev))
}
return
}
func (s *singleSourceCacheBolt) markRevisionExists(rev Revision) {
err := s.updateRevBucket(rev, func(versions *bolt.Bucket) error {
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to mark revision %q in cache", rev))
}
}
func (s *singleSourceCacheBolt) setVersionMap(pvs []PairedVersion) {
err := s.updateSourceBucket(func(src *bolt.Bucket) error {
if err := cachePrefixDelete(src, cacheVersion); err != nil {
return err
}
vk := cacheTimestampedKey(cacheVersion, time.Now())
versions, err := src.CreateBucket(vk)
if err != nil {
return err
}
c := src.Cursor()
for k, _ := c.Seek(cacheKeyRevision); len(k) > 0 && k[0] == cacheRevision; k, _ = c.Next() {
rb := src.Bucket(k)
if err := cachePrefixDelete(rb, cacheVersion); err != nil {
return err
}
}
revVersions := make(map[Revision]*bolt.Bucket)
key := make(nuts.Key, nuts.KeyLen(uint64(len(pvs)-1)))
var msg pb.Constraint
for i, pv := range pvs {
uv, rev := pv.Unpair(), pv.Revision()
uv.copyTo(&msg)
uvB, err := proto.Marshal(&msg)
if err != nil {
return errors.Wrapf(err, "failed to serialize UnpairedVersion: %#v", uv)
}
if err := versions.Put(uvB, []byte(rev)); err != nil {
return errors.Wrap(err, "failed to put version->revision")
}
b, err := src.CreateBucketIfNotExists(cacheRevisionName(rev))
if err != nil {
return errors.Wrapf(err, "failed to create bucket for revision: %s", rev)
}
var versions *bolt.Bucket
if versions = revVersions[rev]; versions == nil {
err := cachePrefixDelete(b, cacheVersion)
if err != nil {
return err
}
versions, err = b.CreateBucket(vk)
if err != nil {
return errors.Wrapf(err, "failed to create bucket for revision versions: %s", rev)
}
revVersions[rev] = versions
}
key.Put(uint64(i))
if err := versions.Put(key, uvB); err != nil {
return errors.Wrap(err, "failed to put revision->version")
}
}
return nil
})
if err != nil {
s.logger.Println(errors.Wrap(err, "failed to cache version map"))
}
}
func (s *singleSourceCacheBolt) getVersionsFor(rev Revision) (uvs []UnpairedVersion, ok bool) {
err := s.viewRevBucket(rev, func(b *bolt.Bucket) error {
versions := cacheFindLatestValid(b, cacheVersion, s.epoch)
if versions == nil {
return nil
}
ok = true
var msg pb.Constraint
return versions.ForEach(func(_, v []byte) error {
if err := proto.Unmarshal(v, &msg); err != nil {
return err
}
uv, err := unpairedVersionFromCache(&msg)
if err != nil {
return err
}
uvs = append(uvs, uv)
return nil
})
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to get cached versions for revision %q", rev))
return nil, false
}
return
}
func (s *singleSourceCacheBolt) getAllVersions() (pvs []PairedVersion, ok bool) {
err := s.viewSourceBucket(func(src *bolt.Bucket) error {
versions := cacheFindLatestValid(src, cacheVersion, s.epoch)
if versions == nil {
return nil
}
var msg pb.Constraint
return versions.ForEach(func(k, v []byte) error {
if err := proto.Unmarshal(k, &msg); err != nil {
return err
}
uv, err := unpairedVersionFromCache(&msg)
if err != nil {
return err
}
pvs = append(pvs, uv.Pair(Revision(v)))
ok = true
return nil
})
})
if err != nil {
s.logger.Println(errors.Wrap(err, "failed to get all cached versions"))
return nil, false
}
return
}
func (s *singleSourceCacheBolt) getRevisionFor(uv UnpairedVersion) (rev Revision, ok bool) {
err := s.viewSourceBucket(func(src *bolt.Bucket) error {
versions := cacheFindLatestValid(src, cacheVersion, s.epoch)
if versions == nil {
return nil
}
var msg pb.Constraint
uv.copyTo(&msg)
b, err := proto.Marshal(&msg)
if err != nil {
return errors.Wrapf(err, "failed to serialize UnpairedVersion: %#v", uv)
}
v := versions.Get(b)
if len(v) > 0 {
rev = Revision(v)
ok = true
}
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, "failed to get cached revision for unpaired version: %v", uv))
}
return
}
func (s *singleSourceCacheBolt) toRevision(v Version) (rev Revision, ok bool) {
switch t := v.(type) {
case Revision:
return t, true
case PairedVersion:
return t.Revision(), true
case UnpairedVersion:
return s.getRevisionFor(t)
default:
s.logger.Println(fmt.Sprintf("failed to get cached revision for version %v: unknown type %T", v, v))
return "", false
}
}
func (s *singleSourceCacheBolt) toUnpaired(v Version) (uv UnpairedVersion, ok bool) {
const errMsg = "failed to get cached unpaired version for version: %v"
switch t := v.(type) {
case UnpairedVersion:
return t, true
case PairedVersion:
return t.Unpair(), true
case Revision:
err := s.viewRevBucket(t, func(b *bolt.Bucket) error {
versions := cacheFindLatestValid(b, cacheVersion, s.epoch)
if versions == nil {
return nil
}
_, v := versions.Cursor().First()
if len(v) == 0 {
return nil
}
var msg pb.Constraint
if err := proto.Unmarshal(v, &msg); err != nil {
return err
}
var err error
uv, err = unpairedVersionFromCache(&msg)
if err != nil {
return err
}
ok = true
return nil
})
if err != nil {
s.logger.Println(errors.Wrapf(err, errMsg, v))
}
return
default:
s.logger.Println(fmt.Sprintf(errMsg, v))
return
}
}
// cacheRevisionName returns the bucket name for rev.
func cacheRevisionName(rev Revision) []byte {
name := make([]byte, 1+len(rev))
name[0] = 'r'
copy(name[1:], string(rev))
return name
}
// viewSourceBucket executes view with the source bucket, if it exists.
func (s *singleSourceCacheBolt) viewSourceBucket(view func(b *bolt.Bucket) error) error {
return s.db.View(func(tx *bolt.Tx) error {
b := tx.Bucket(s.sourceName)
if b == nil {
return nil
}
return view(b)
})
}
// updateSourceBucket executes update (in batch) with the source bucket, creating it first if necessary.
func (s *singleSourceCacheBolt) updateSourceBucket(update func(b *bolt.Bucket) error) error {
return s.db.Batch(func(tx *bolt.Tx) error {
b, err := tx.CreateBucketIfNotExists(s.sourceName)
if err != nil {
return errors.Wrapf(err, "failed to create bucket: %s", s.sourceName)
}
return update(b)
})
}
// viewRevBucket executes view with rev's bucket for this source, if it exists.
func (s *singleSourceCacheBolt) viewRevBucket(rev Revision, view func(b *bolt.Bucket) error) error {
return s.viewSourceBucket(func(src *bolt.Bucket) error {
b := src.Bucket(cacheRevisionName(rev))
if b == nil {
return nil
}
return view(b)
})
}
// updateRevBucket executes update with rev's bucket for this source, creating it first if necessary.
func (s *singleSourceCacheBolt) updateRevBucket(rev Revision, update func(b *bolt.Bucket) error) error {
return s.updateSourceBucket(func(src *bolt.Bucket) error {
name := cacheRevisionName(rev)
b, err := src.CreateBucketIfNotExists(name)
if err != nil {
return errors.Wrapf(err, "failed to create bucket: %s", name)
}
return update(b)
})
}