forked from helm/chartmuseum
/
cache.go
593 lines (507 loc) · 15.9 KB
/
cache.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
/*
Copyright The Helm Authors.
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 multitenant
/*
__../)
-._ \ /:
_.-' \ ( \___
,' \ .'`\.) :"-._______
,' .'/|| / / _ `""` ``` `, _ _ ~ - _
.' / || / | ( `.~v~v~v~v~v' _ -- * * _ -
' / || | .\ `. `. __- ~ - ~ -- -
/ || | : `----`. `. -~ _ _ ~ * * -
/ || \:_ / `. `. - *__ - - __
/ .'/ `.`----\ `._; -- _ * - _
|| `,_ ` - -__ -
|| / `---':
HERE BE DRAGONS!!!
*/
import (
"encoding/json"
"errors"
pathutil "path"
"sync"
"time"
"go.uber.org/zap"
cm_logger "helm.sh/chartmuseum/pkg/chartmuseum/logger"
cm_repo "helm.sh/chartmuseum/pkg/repo"
cm_storage "github.com/chartmuseum/storage"
"github.com/ghodss/yaml"
"github.com/gin-gonic/gin"
helm_repo "helm.sh/helm/v3/pkg/repo"
)
type (
cacheEntry struct {
// cryptic JSON field names to minimize size saved in cache
RepoName string `json:"a"`
RepoIndex *cm_repo.Index `json:"b"`
}
event struct {
Context *gin.Context `json:"-"`
RepoName string `json:"repo_name"`
OpType operationType `json:"operation_type"`
ChartVersion *helm_repo.ChartVersion `json:"chart_version"`
}
operationType int
)
const (
updateChart operationType = 0
addChart operationType = 1
deleteChart operationType = 2
)
var (
EntrySavedMessage = "Entry saved in cache store"
CouldNotSaveEntryErrorMessage = "Could not save entry in cache store"
)
func (server *MultiTenantServer) primeCache() error {
// only prime the cache if this is a single tenant setup
if server.Router.Depth == 0 {
log := server.Logger.ContextLoggingFn(&gin.Context{})
_, err := server.getIndexFile(log, "")
if err != nil {
return errors.New(err.Message)
}
}
return nil
}
// getChartList fetches from the server and accumulates concurrent requests to be fulfilled all at once.
func (server *MultiTenantServer) getChartList(log cm_logger.LoggingFn, repo string) <-chan fetchedObjects {
ch := make(chan fetchedObjects, 1)
tenant := server.Tenants[repo]
tenant.FetchedObjectsLock.Lock()
tenant.FetchedObjectsChans = append(tenant.FetchedObjectsChans, ch)
if len(tenant.FetchedObjectsChans) == 1 {
// this unlock is wanted, while fetching the list, allow other channeled requests to be added
tenant.FetchedObjectsLock.Unlock()
objects, err := server.fetchChartsInStorage(log, repo)
tenant.FetchedObjectsLock.Lock()
// flush every other consumer that also wanted the index
for _, foCh := range tenant.FetchedObjectsChans {
foCh <- fetchedObjects{objects, err}
}
tenant.FetchedObjectsChans = nil
}
tenant.FetchedObjectsLock.Unlock()
return ch
}
func (server *MultiTenantServer) regenerateRepositoryIndex(log cm_logger.LoggingFn, entry *cacheEntry, diff cm_storage.ObjectSliceDiff) <-chan indexRegeneration {
ch := make(chan indexRegeneration, 1)
tenant := server.Tenants[entry.RepoName]
tenant.RegenerationLock.Lock()
tenant.RegeneratedIndexesChans = append(tenant.RegeneratedIndexesChans, ch)
if len(tenant.RegeneratedIndexesChans) == 1 {
tenant.RegenerationLock.Unlock()
index, err := server.regenerateRepositoryIndexWorker(log, entry, diff)
tenant.RegenerationLock.Lock()
for _, riCh := range tenant.RegeneratedIndexesChans {
riCh <- indexRegeneration{index, err}
}
tenant.RegeneratedIndexesChans = nil
}
tenant.RegenerationLock.Unlock()
return ch
}
func (server *MultiTenantServer) regenerateRepositoryIndexWorker(log cm_logger.LoggingFn, entry *cacheEntry, diff cm_storage.ObjectSliceDiff) (*cm_repo.Index, error) {
repo := entry.RepoName
log(cm_logger.DebugLevel, "Regenerating index.yaml",
"repo", repo,
)
index := &cm_repo.Index{
IndexFile: entry.RepoIndex.IndexFile,
RepoName: repo,
Raw: entry.RepoIndex.Raw,
ChartURL: entry.RepoIndex.ChartURL,
}
for _, object := range diff.Removed {
err := server.removeIndexObject(log, repo, index, object)
if err != nil {
return nil, err
}
}
for _, object := range diff.Updated {
err := server.updateIndexObject(log, repo, index, object)
if err != nil {
return nil, err
}
}
// Parallelize retrieval of added objects to improve speed
err := server.addIndexObjectsAsync(log, repo, index, diff.Added)
if err != nil {
return nil, err
}
err = index.Regenerate()
if err != nil {
return nil, err
}
log(cm_logger.DebugLevel, "index.yaml regenerated",
"repo", repo,
)
entry.RepoIndex = index
err = server.saveCacheEntry(log, entry)
return index, err
}
func (server *MultiTenantServer) fetchChartsInStorage(log cm_logger.LoggingFn, repo string) ([]cm_storage.Object, error) {
log(cm_logger.DebugLevel, "Fetching chart list from storage",
"repo", repo,
)
allObjects, err := server.StorageBackend.ListObjects(repo)
if err != nil {
return []cm_storage.Object{}, err
}
// filter out storage objects that dont have extension used for chart packages (.tgz)
//filteredObjects := []cm_storage.Object{}
//for _, object := range allObjects {
// if object.HasExtension(cm_repo.ChartPackageFileExtension) {
// log(cm_logger.DebugLevel, "GetObject From Storage Backend", "repo", repo, "path", object.Path)
// Since ListObject cannot fetch the content from file list
//objectDetail, err := server.StorageBackend.GetObject(pathutil.Join(repo, object.Path))
//if err != nil {
// return nil, fmt.Errorf("backend storage: chart not found: %q", err)
//}
//do not change other object field except content
//object.Content = objectDetail.Content
//filteredObjects = append(filteredObjects, object)
//}
//}
return allObjects, nil
}
func (server *MultiTenantServer) removeIndexObject(log cm_logger.LoggingFn, repo string, index *cm_repo.Index, object cm_storage.Object) error {
chartVersion, err := server.getObjectChartVersion(repo, object, false)
if err != nil {
return server.checkInvalidChartPackageError(log, repo, object, err, "removed")
}
log(cm_logger.DebugLevel, "Removing chart from index",
"repo", repo,
"name", chartVersion.Name,
"version", chartVersion.Version,
)
index.RemoveEntry(chartVersion)
return nil
}
func (server *MultiTenantServer) updateIndexObject(log cm_logger.LoggingFn, repo string, index *cm_repo.Index, object cm_storage.Object) error {
chartVersion, err := server.getObjectChartVersion(repo, object, true)
if err != nil {
return server.checkInvalidChartPackageError(log, repo, object, err, "updated")
}
log(cm_logger.DebugLevel, "Updating chart in index",
"repo", repo,
"name", chartVersion.Name,
"version", chartVersion.Version,
)
index.UpdateEntry(chartVersion)
return nil
}
func (server *MultiTenantServer) addIndexObjectsAsync(log cm_logger.LoggingFn, repo string, index *cm_repo.Index, objects []cm_storage.Object) error {
numObjects := len(objects)
if numObjects == 0 {
return nil
}
log(cm_logger.DebugLevel, "Loading charts packages from storage (this could take awhile)",
"repo", repo,
"total", numObjects,
)
for _, object := range objects {
o, err := cm_repo.ChartVersionFromStorageObject(object)
if err != nil {
return err
}
index.AddEntry(o)
}
return nil
}
func (server *MultiTenantServer) getObjectChartVersion(repo string, object cm_storage.Object, load bool) (*helm_repo.ChartVersion, error) {
op := object.Path
if load {
var err error
objectPath := pathutil.Join(repo, op)
object, err = server.StorageBackend.GetObject(objectPath)
if err != nil {
return nil, err
}
if len(object.Content) == 0 {
return nil, cm_repo.ErrorInvalidChartPackage
}
}
return cm_repo.ChartVersionFromStorageObject(object)
}
func (server *MultiTenantServer) checkInvalidChartPackageError(log cm_logger.LoggingFn, repo string, object cm_storage.Object, err error, action string) error {
if err == cm_repo.ErrorInvalidChartPackage {
log(cm_logger.WarnLevel, "Invalid package in storage",
"repo", repo,
"action", action,
"package", object.Path,
)
return nil
}
return err
}
func (server *MultiTenantServer) initCacheEntry(log cm_logger.LoggingFn, repo string) (*cacheEntry, error) {
var entry *cacheEntry
var content []byte
var err error
server.TenantCacheKeyLock.Lock()
defer server.TenantCacheKeyLock.Unlock()
if _, ok := server.Tenants[repo]; !ok {
server.Tenants[repo] = &tenantInternals{
FetchedObjectsLock: &sync.Mutex{},
RegenerationLock: &sync.Mutex{},
}
}
if server.ExternalCacheStore == nil {
var ok bool
entry, ok = server.InternalCacheStore[repo]
if !ok {
repoIndex := server.newRepositoryIndex(log, repo)
entry = &cacheEntry{
RepoName: repo,
RepoIndex: repoIndex,
}
server.InternalCacheStore[repo] = entry
} else {
log(cm_logger.DebugLevel, "Entry found in cache store",
"repo", repo,
)
}
} else {
content, err = server.ExternalCacheStore.Get(repo)
if err != nil {
repoIndex := server.newRepositoryIndex(log, repo)
entry = &cacheEntry{
RepoName: repo,
RepoIndex: repoIndex,
}
content, err = json.Marshal(entry)
if err != nil {
return nil, err
}
err := server.ExternalCacheStore.Set(repo, content)
if err != nil {
log(cm_logger.ErrorLevel, CouldNotSaveEntryErrorMessage,
"error", err.Error(),
"repo", repo,
)
}
return entry, nil
}
log(cm_logger.DebugLevel, "Entry found in cache store",
"repo", repo,
)
err = json.Unmarshal(content, &entry)
if err != nil {
return nil, err
}
}
return entry, nil
}
func (server *MultiTenantServer) saveCacheEntry(log cm_logger.LoggingFn, entry *cacheEntry) error {
repo := entry.RepoName
if server.ExternalCacheStore == nil {
server.InternalCacheStore[repo] = entry
log(cm_logger.DebugLevel, EntrySavedMessage,
"repo", repo,
)
} else {
content, err := json.Marshal(entry)
if err != nil {
return err
}
err = server.ExternalCacheStore.Set(repo, content)
if err != nil {
log(cm_logger.ErrorLevel, CouldNotSaveEntryErrorMessage,
"error", err.Error(),
"repo", repo,
)
} else {
log(cm_logger.DebugLevel, EntrySavedMessage,
"repo", repo,
)
}
}
return nil
}
func (server *MultiTenantServer) newRepositoryIndex(log cm_logger.LoggingFn, repo string) *cm_repo.Index {
var chartURL string
if server.ChartURL != "" {
chartURL = server.ChartURL
if repo != "" {
chartURL = chartURL + "/" + repo
}
}
serverInfo := &cm_repo.ServerInfo{
ContextPath: server.Router.ContextPath,
}
if !server.UseStatefiles {
return cm_repo.NewIndex(chartURL, repo, serverInfo)
}
objectPath := pathutil.Join(repo, cm_repo.StatefileFilename)
object, err := server.StorageBackend.GetObject(objectPath)
if err != nil {
return cm_repo.NewIndex(chartURL, repo, serverInfo)
}
indexFile := &cm_repo.IndexFile{}
err = yaml.Unmarshal(object.Content, indexFile)
if err != nil {
log(cm_logger.WarnLevel, "index-cache.yaml found but could not be parsed",
"repo", repo,
"error", err.Error(),
)
return cm_repo.NewIndex(chartURL, repo, serverInfo)
}
log(cm_logger.DebugLevel, "index-cache.yaml loaded",
"repo", repo,
)
return &cm_repo.Index{
IndexFile: indexFile,
RepoName: repo,
Raw: object.Content,
ChartURL: chartURL,
}
}
func (server *MultiTenantServer) initCacheTimer() {
if server.CacheInterval > 0 {
// delta update the cache every X duration
// (in case the files on the disk are manually manipulated)
go func() {
t := time.NewTicker(server.CacheInterval)
for _ = range t.C {
server.rebuildIndex()
}
}()
}
}
func (server *MultiTenantServer) emitEvent(c *gin.Context, repo string, operationType operationType, chart *helm_repo.ChartVersion) {
server.EventChan <- event{
Context: c,
RepoName: repo,
OpType: operationType,
ChartVersion: chart,
}
}
func (server *MultiTenantServer) startEventListener() {
server.Router.Logger.Debug("Starting internal event listener")
for {
e := <-server.EventChan
log := server.Logger.ContextLoggingFn(e.Context)
repo := e.RepoName
log(cm_logger.DebugLevel, "Event received", zap.Any("event", e))
entry, err := server.initCacheEntry(log, repo)
if err != nil {
log(cm_logger.ErrorLevel, "Error initializing cache entry", zap.Error(err), zap.String("repo", repo))
continue
}
index := entry.RepoIndex
tenant, ok := server.Tenants[e.RepoName]
if !ok {
log(cm_logger.ErrorLevel, "Error find tenants repo name", zap.Error(err), zap.String("repo", repo))
continue
}
tenant.RegenerationLock.Lock()
if e.ChartVersion == nil {
log(cm_logger.WarnLevel, "Event does not contain chart version", zap.String("repo", repo),
"operation_type", e.OpType)
tenant.RegenerationLock.Unlock()
continue
}
switch e.OpType {
case updateChart:
index.UpdateEntry(e.ChartVersion)
case addChart:
index.AddEntry(e.ChartVersion)
case deleteChart:
index.RemoveEntry(e.ChartVersion)
default:
log(cm_logger.ErrorLevel, "Invalid operation type", zap.String("repo", repo),
"operation_type", e.OpType)
tenant.RegenerationLock.Unlock()
continue
}
err = index.Regenerate()
if err != nil {
log(cm_logger.ErrorLevel, "Error regenerating index", zap.Error(err), zap.String("repo", repo))
tenant.RegenerationLock.Unlock()
continue
}
entry.RepoIndex = index
err = server.saveCacheEntry(log, entry)
if err != nil {
log(cm_logger.ErrorLevel, "Error saving cache entry", zap.Error(err), zap.String("repo", repo))
tenant.RegenerationLock.Unlock()
continue
}
if server.UseStatefiles {
// Dont wait, save index-cache.yaml to storage in the background.
// It is not crucial if this does not succeed, we will just log any errors
go server.saveStatefile(log, e.RepoName, entry.RepoIndex.Raw)
}
tenant.RegenerationLock.Unlock()
log(cm_logger.DebugLevel, "Event handled successfully", zap.Any("event", e))
}
}
func (server *MultiTenantServer) rebuildIndex() {
if len(server.Tenants) == 0 {
return
}
server.Logger.Info("Rebuilding index for all tenants in cache")
for repo, _ := range server.Tenants {
go server.rebuildIndexForTenant(repo)
}
}
func (server *MultiTenantServer) rebuildIndexForTenant(repo string) {
log := server.Logger.ContextLoggingFn(&gin.Context{})
log(cm_logger.InfoLevel, "Rebuilding index for tenant", zap.String("repo", repo))
entry, err := server.initCacheEntry(log, repo)
if err != nil {
errStr := err.Error()
log(cm_logger.ErrorLevel, errStr,
"repo", repo,
)
return
}
server.refreshCacheEntry(log, repo, entry)
}
func (server *MultiTenantServer) refreshCacheEntry(log cm_logger.LoggingFn, repo string, entry *cacheEntry) {
fo := <-server.getChartList(log, repo)
if fo.err != nil {
errStr := fo.err.Error()
log(cm_logger.ErrorLevel, errStr,
"repo", repo,
)
return
}
objects := server.getRepoObjectSlice(entry)
diff := cm_storage.GetObjectSliceDiff(objects, fo.objects, server.TimestampTolerance)
// return fast if no changes
if !diff.Change {
log(cm_logger.DebugLevel, "No change detected between cache and storage",
"repo", repo,
)
return
}
log(cm_logger.DebugLevel, "Change detected between cache and storage",
"repo", repo,
)
ir := <-server.regenerateRepositoryIndex(log, entry, diff)
if ir.err != nil {
errStr := ir.err.Error()
log(cm_logger.ErrorLevel, errStr,
"repo", repo,
)
return
}
entry.RepoIndex = ir.index
if server.UseStatefiles {
// Dont wait, save index-cache.yaml to storage in the background.
// It is not crucial if this does not succeed, we will just log any errors
go server.saveStatefile(log, repo, ir.index.Raw)
}
}