-
Notifications
You must be signed in to change notification settings - Fork 111
/
catalog_cache.go
505 lines (455 loc) · 14.4 KB
/
catalog_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
package runtime
import (
"context"
"errors"
"fmt"
"strings"
"time"
runtimev1 "github.com/rilldata/rill/proto/gen/rill/runtime/v1"
"github.com/rilldata/rill/runtime/drivers"
"github.com/rilldata/rill/runtime/pkg/dag2"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/timestamppb"
)
// catalogCache is a catalog proxy that caches and edits resources in-memory. It enables rapid reads and writes to the catalog.
// It writes changes to resources to the underlying store when flush() or close() is called.
// It only reads resources from the underlying store on initialization, making the overall workload against the store write-heavy.
//
// catalogCache additionally provides various indexes of the resources: a DAG, map of soft-deleted resources, map of renamed resources.
// It is not thread-safe, but it protects against split-brain scenarios by erroring if the underlying store is mutated by another catalog cache.
type catalogCache struct {
ctrl *Controller
store drivers.CatalogStore
release func()
version int64
resources map[string]map[string]*runtimev1.Resource
dirty map[string]*runtimev1.ResourceName
stored map[string]bool
dag dag2.DAG[string, *runtimev1.ResourceName]
cyclic map[string]*runtimev1.ResourceName
renamed map[string]*runtimev1.ResourceName
deleted map[string]*runtimev1.ResourceName
events map[string]catalogEvent
hasEvents bool
hasEventsCh chan struct{}
}
// newCatalogCache initializes and warms a new catalog cache.
// It resets ephemeral fields to the following defaults: reconcile_status=idle, renamed_from=nil, reconcile_on=nil.
func newCatalogCache(ctx context.Context, ctrl *Controller, instanceID string) (*catalogCache, error) {
store, release, err := ctrl.Runtime.Catalog(ctx, instanceID)
if err != nil {
return nil, err
}
v, err := store.NextControllerVersion(ctx)
if err != nil {
return nil, err
}
c := &catalogCache{
ctrl: ctrl,
store: store,
release: release,
version: v,
resources: make(map[string]map[string]*runtimev1.Resource),
dirty: make(map[string]*runtimev1.ResourceName),
stored: make(map[string]bool),
dag: dag2.New(nameStr),
cyclic: make(map[string]*runtimev1.ResourceName),
renamed: make(map[string]*runtimev1.ResourceName),
deleted: make(map[string]*runtimev1.ResourceName),
events: make(map[string]catalogEvent),
}
rs, err := store.FindResources(ctx)
if err != nil {
return nil, err
}
for _, r := range rs {
r2 := resourceFromDriver(r)
c.link(r2)
c.stored[nameStr(r2.Meta.Name)] = true
}
return c, nil
}
// close closes the catalog cache, flushing any changes to the underlying store.
func (c *catalogCache) close(ctx context.Context) error {
err := c.flush(ctx)
c.release()
return err
}
// flush flushes changes to the underlying store.
// Unlike other catalog functions, it is safe to call flush concurrently with calls to get and list (i.e. under a read lock).
func (c *catalogCache) flush(ctx context.Context) error {
for s, n := range c.dirty {
r, err := c.get(n, true)
if err != nil {
if !errors.Is(err, drivers.ErrResourceNotFound) {
return fmt.Errorf("flush: unexpected error from get: %w", err)
}
// Resource should be deleted from store
err = c.store.DeleteResource(ctx, c.version, n.Kind, n.Name)
if err != nil {
return err
}
delete(c.dirty, s)
delete(c.stored, s)
continue
}
// Resource should be saved in store
s := nameStr(r.Meta.Name)
if c.stored[s] {
// Updating
err = c.store.UpdateResource(ctx, c.version, resourceToDriver(r))
} else {
// Creating
err = c.store.CreateResource(ctx, c.version, resourceToDriver(r))
}
if err != nil {
return err
}
delete(c.dirty, s)
}
return nil
}
// checkLeader checks that we hold the current controller version number.
func (c *catalogCache) checkLeader(ctx context.Context) error {
err := c.store.CheckControllerVersion(ctx, c.version)
if err != nil {
return err
}
return nil
}
// list returns a list of resources in the catalog.
// Unlike other catalog functions, it is safe to call list concurrently with calls to get and flush (i.e. under a read lock).
func (c *catalogCache) list(kind string, withDeleted bool) ([]*runtimev1.Resource, error) {
if kind != "" {
n := len(c.resources[kind])
res := make([]*runtimev1.Resource, 0, n)
if withDeleted {
for _, r := range c.resources[kind] {
res = append(res, r)
}
} else {
for _, r := range c.resources[kind] {
if r.Meta.DeletedOn == nil {
res = append(res, r)
}
}
}
return res, nil
}
n := 0
for _, rs := range c.resources {
n += len(rs)
}
res := make([]*runtimev1.Resource, 0, n)
if withDeleted {
for _, rs := range c.resources {
for _, r := range rs {
res = append(res, r)
}
}
} else {
for _, rs := range c.resources {
for _, r := range rs {
if r.Meta.DeletedOn == nil {
res = append(res, r)
}
}
}
}
return res, nil
}
// get returns a resource from the catalog.
// Unlike other catalog functions, it is safe to call get concurrently with calls to list and flush (i.e. under a read lock).
func (c *catalogCache) get(n *runtimev1.ResourceName, withDeleted bool) (*runtimev1.Resource, error) {
rs := c.resources[n.Kind]
if rs == nil {
return nil, drivers.ErrResourceNotFound
}
r, ok := rs[strings.ToLower(n.Name)]
if !ok {
return nil, drivers.ErrResourceNotFound
}
if r.Meta.DeletedOn != nil && !withDeleted {
return nil, drivers.ErrResourceNotFound
}
return r, nil
}
// create creates a resource in the catalog.
// It will error if a resource with the same name already exists.
// If a soft-deleted resource exists with the same name, it will be overwritten (no longer deleted).
func (c *catalogCache) create(name *runtimev1.ResourceName, refs []*runtimev1.ResourceName, owner *runtimev1.ResourceName, paths []string, r *runtimev1.Resource) error {
existing, _ := c.get(name, true)
if existing != nil {
if existing.Meta.DeletedOn == nil {
return drivers.ErrResourceAlreadyExists
}
c.unlink(existing) // If creating a resource that's currently soft-deleted, it'll be like the previous delete never happened.
}
r.Meta = &runtimev1.ResourceMeta{
Name: name,
Refs: refs,
FilePaths: paths,
Owner: owner,
CreatedOn: timestamppb.Now(),
SpecUpdatedOn: timestamppb.Now(),
StateUpdatedOn: timestamppb.Now(),
}
if existing != nil {
r.Meta.Version = existing.Meta.Version + 1
r.Meta.SpecVersion = existing.Meta.SpecVersion + 1
}
c.link(r)
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// rename renames a resource in the catalog and sets the r.Meta.RenamedFrom field.
func (c *catalogCache) rename(name, newName *runtimev1.ResourceName) error {
r, err := c.get(name, false)
if err != nil {
return err
}
c.unlink(r)
r.Meta.RenamedFrom = r.Meta.Name
r.Meta.Name = newName
r.Meta.Version++
r.Meta.SpecVersion++
r.Meta.SpecUpdatedOn = timestamppb.Now()
c.link(r)
c.dirty[nameStr(r.Meta.RenamedFrom)] = r.Meta.RenamedFrom
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.RenamedFrom, nil, runtimev1.ResourceEvent_RESOURCE_EVENT_DELETE)
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// clearRenamedFrom clears the r.Meta.RenamedFrom field without bumping version numbers.
func (c *catalogCache) clearRenamedFrom(name *runtimev1.ResourceName) error {
r, err := c.get(name, false)
if err != nil {
return err
}
if r.Meta.RenamedFrom == nil {
return nil
}
c.unlink(r)
r.Meta.RenamedFrom = nil
c.link(r)
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateMeta updates the meta fields of a resource.
func (c *catalogCache) updateMeta(name *runtimev1.ResourceName, refs []*runtimev1.ResourceName, owner *runtimev1.ResourceName, paths []string) error {
r, err := c.get(name, false)
if err != nil {
return err
}
c.unlink(r)
r.Meta.Refs = refs
r.Meta.Owner = owner
r.Meta.FilePaths = paths
r.Meta.Version++
r.Meta.SpecVersion++
r.Meta.SpecUpdatedOn = timestamppb.Now()
c.link(r)
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateSpec updates the spec field of a resource.
func (c *catalogCache) updateSpec(name *runtimev1.ResourceName, from *runtimev1.Resource) error {
r, err := c.get(name, false)
if err != nil {
return err
}
// NOTE: No need to unlink/link because no indexed fields are edited.
err = c.ctrl.reconciler(name.Kind).AssignSpec(from, r)
if err != nil {
return err
}
r.Meta.Version++
r.Meta.SpecVersion++
r.Meta.SpecUpdatedOn = timestamppb.Now()
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateState updates the state field of a resource.
func (c *catalogCache) updateState(name *runtimev1.ResourceName, from *runtimev1.Resource) error {
r, err := c.get(name, false)
if err != nil {
return err
}
// NOTE: No need to unlink/link because no indexed fields are edited.
err = c.ctrl.reconciler(name.Kind).AssignState(from, r)
if err != nil {
return err
}
r.Meta.Version++
r.Meta.StateVersion++
r.Meta.StateUpdatedOn = timestamppb.Now()
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateError updates the reconcile_error field of a resource.
func (c *catalogCache) updateError(name *runtimev1.ResourceName, reconcileErr error) error {
r, err := c.get(name, false)
if err != nil {
return err
}
// NOTE: No need to unlink/link because no indexed fields are edited.
r.Meta.ReconcileError = reconcileErr.Error()
r.Meta.Version++
r.Meta.StateVersion++
r.Meta.StateUpdatedOn = timestamppb.Now()
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateDeleted sets the deleted_on field of a resource (a soft delete).
// Afterwards, the resource can still be accessed by passing withDeleted to the getters.
func (c *catalogCache) updateDeleted(name *runtimev1.ResourceName) error {
r, err := c.get(name, false)
if err != nil {
return err
}
c.unlink(r)
r.Meta.DeletedOn = timestamppb.Now()
r.Meta.Version++
r.Meta.SpecVersion++
r.Meta.SpecUpdatedOn = timestamppb.Now()
c.link(r)
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// updateStatus updates the ephemeral status fields on a resource.
// The values of these fields are reset next time a catalog cache is created.
func (c *catalogCache) updateStatus(name *runtimev1.ResourceName, status runtimev1.ReconcileStatus, reconcileOn time.Time) error {
r, err := c.get(name, true)
if err != nil {
return err
}
r.Meta.ReconcileStatus = status
if reconcileOn.IsZero() {
r.Meta.ReconcileOn = nil
} else {
r.Meta.ReconcileOn = timestamppb.New(reconcileOn)
}
c.addEvent(r.Meta.Name, r, runtimev1.ResourceEvent_RESOURCE_EVENT_WRITE)
return nil
}
// delete permanently deletes a resource from the catalog (a hard delete).
// Afterwards, the resource can no longer be accessed.
func (c *catalogCache) delete(name *runtimev1.ResourceName) error {
r, err := c.get(name, true)
if err != nil {
return err
}
c.unlink(r)
c.dirty[nameStr(r.Meta.Name)] = r.Meta.Name
c.addEvent(r.Meta.Name, nil, runtimev1.ResourceEvent_RESOURCE_EVENT_DELETE)
return nil
}
// link adds a resource to the cache and its indexes.
func (c *catalogCache) link(r *runtimev1.Resource) {
if c.resources[r.Meta.Name.Kind] == nil {
c.resources[r.Meta.Name.Kind] = make(map[string]*runtimev1.Resource)
}
c.resources[r.Meta.Name.Kind][strings.ToLower(r.Meta.Name.Name)] = r
s := nameStr(r.Meta.Name)
if r.Meta.DeletedOn == nil {
ok := c.dag.Add(r.Meta.Name, r.Meta.Refs...)
if !ok {
c.cyclic[s] = r.Meta.Name
}
} else {
c.deleted[s] = r.Meta.Name
}
if r.Meta.RenamedFrom != nil {
c.renamed[s] = r.Meta.Name
}
}
// unlink reverses a previous call to link.
func (c *catalogCache) unlink(r *runtimev1.Resource) {
s := nameStr(r.Meta.Name)
if _, ok := c.deleted[s]; ok {
return
}
delete(c.resources[r.Meta.Name.Kind], strings.ToLower(r.Meta.Name.Name))
c.dag.Remove(r.Meta.Name)
delete(c.cyclic, s)
delete(c.deleted, s)
delete(c.renamed, s)
}
// retryCyclicRefs attempts to re-link resources into the DAG that were previously rejected due to cyclic references.
// It returns a list of resource names that were successfully linked into the DAG.
func (c *catalogCache) retryCyclicRefs() []*runtimev1.ResourceName {
var res []*runtimev1.ResourceName
for s, n := range c.cyclic {
r, err := c.get(n, false)
if err != nil {
panic(err)
}
ok := c.dag.Add(n, r.Meta.Refs...)
if ok {
delete(c.cyclic, s)
res = append(res, n)
}
}
return res
}
// catalogEvent represents a change to a resource.
type catalogEvent struct {
event runtimev1.ResourceEvent
name *runtimev1.ResourceName
resource *runtimev1.Resource // will be nil if the event is a deletion
}
// addEvent tracks when a resource has been changed.
func (c *catalogCache) addEvent(n *runtimev1.ResourceName, r *runtimev1.Resource, e runtimev1.ResourceEvent) {
c.events[nameStr(n)] = catalogEvent{
event: e,
name: n,
resource: r,
}
if !c.hasEvents {
c.hasEvents = true
c.hasEventsCh <- struct{}{}
}
}
// clearEvents clears all buffered events.
// It should be called after consuming c.events.
func (c *catalogCache) resetEvents() {
c.hasEvents = false
c.events = make(map[string]catalogEvent)
}
// nameStr returns a string representation of a resource name.
func nameStr(r *runtimev1.ResourceName) string {
return fmt.Sprintf("%s/%s", r.Kind, r.Name)
}
// resourceFromDriver converts a drivers.Resource to a proto resource.
func resourceFromDriver(r drivers.Resource) *runtimev1.Resource {
res := &runtimev1.Resource{}
err := proto.Unmarshal(r.Data, res)
if err != nil {
panic(err)
}
// Reset ephemeral fields.
res.Meta.ReconcileStatus = runtimev1.ReconcileStatus_RECONCILE_STATUS_IDLE
res.Meta.ReconcileOn = nil
res.Meta.RenamedFrom = nil
return res
}
// resourceToDriver converts a proto resource to a drivers.Resource.
func resourceToDriver(r *runtimev1.Resource) drivers.Resource {
data, err := proto.Marshal(r)
if err != nil {
panic(err)
}
return drivers.Resource{
Kind: r.Meta.Name.Kind,
Name: r.Meta.Name.Name,
Data: data,
}
}