-
Notifications
You must be signed in to change notification settings - Fork 245
/
caching.go
464 lines (397 loc) · 14.5 KB
/
caching.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
package caching
import (
"context"
"fmt"
"sync"
"testing"
"unsafe"
"github.com/dustin/go-humanize"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require"
"golang.org/x/exp/maps"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/dispatch/keys"
"github.com/authzed/spicedb/pkg/cache"
v1 "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
"github.com/authzed/spicedb/pkg/spiceerrors"
)
const (
errCachingInitialization = "error initializing caching dispatcher: %w"
prometheusNamespace = "spicedb"
)
// Dispatcher is a dispatcher with cacheInst-in caching.
type Dispatcher struct {
d dispatch.Dispatcher
c cache.Cache
keyHandler keys.Handler
checkTotalCounter prometheus.Counter
checkFromCacheCounter prometheus.Counter
reachableResourcesTotalCounter prometheus.Counter
reachableResourcesFromCacheCounter prometheus.Counter
lookupResourcesTotalCounter prometheus.Counter
lookupResourcesFromCacheCounter prometheus.Counter
lookupSubjectsTotalCounter prometheus.Counter
lookupSubjectsFromCacheCounter prometheus.Counter
}
func DispatchTestCache(t testing.TB) cache.Cache {
cache, err := cache.NewCache(&cache.Config{
NumCounters: 1000,
MaxCost: 1 * humanize.MiByte,
})
require.Nil(t, err)
return cache
}
// NewCachingDispatcher creates a new dispatch.Dispatcher which delegates
// dispatch requests and caches the responses when possible and desirable.
func NewCachingDispatcher(cacheInst cache.Cache, metricsEnabled bool, prometheusSubsystem string, keyHandler keys.Handler) (*Dispatcher, error) {
if cacheInst == nil {
cacheInst = cache.NoopCache()
}
checkTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "check_total",
})
checkFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "check_from_cache_total",
})
lookupResourcesTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_resources_total",
})
lookupResourcesFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_resources_from_cache_total",
})
reachableResourcesTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "reachable_resources_total",
})
reachableResourcesFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "reachable_resources_from_cache_total",
})
lookupSubjectsTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_subjects_total",
})
lookupSubjectsFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_subjects_from_cache_total",
})
if metricsEnabled && prometheusSubsystem != "" {
err := prometheus.Register(checkTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(checkFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupResourcesTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupResourcesFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(reachableResourcesTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(reachableResourcesFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupSubjectsTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupSubjectsFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
}
if keyHandler == nil {
keyHandler = &keys.DirectKeyHandler{}
}
return &Dispatcher{
d: fakeDelegate{},
c: cacheInst,
keyHandler: keyHandler,
checkTotalCounter: checkTotalCounter,
checkFromCacheCounter: checkFromCacheCounter,
reachableResourcesTotalCounter: reachableResourcesTotalCounter,
reachableResourcesFromCacheCounter: reachableResourcesFromCacheCounter,
lookupResourcesTotalCounter: lookupResourcesTotalCounter,
lookupResourcesFromCacheCounter: lookupResourcesFromCacheCounter,
lookupSubjectsTotalCounter: lookupSubjectsTotalCounter,
lookupSubjectsFromCacheCounter: lookupSubjectsFromCacheCounter,
}, nil
}
// SetDelegate sets the internal delegate to the specific dispatcher instance.
func (cd *Dispatcher) SetDelegate(delegate dispatch.Dispatcher) {
cd.d = delegate
}
// DispatchCheck implements dispatch.Check interface
func (cd *Dispatcher) DispatchCheck(ctx context.Context, req *v1.DispatchCheckRequest) (*v1.DispatchCheckResponse, error) {
cd.checkTotalCounter.Inc()
requestKey, err := cd.keyHandler.CheckCacheKey(ctx, req)
if err != nil {
return &v1.DispatchCheckResponse{Metadata: &v1.ResponseMeta{}}, err
}
// Disable caching when debugging is enabled.
if cachedResultRaw, found := cd.c.Get(requestKey); found {
var response v1.DispatchCheckResponse
if err := response.UnmarshalVT(cachedResultRaw.([]byte)); err != nil {
return &v1.DispatchCheckResponse{Metadata: &v1.ResponseMeta{}}, err
}
if req.Metadata.DepthRemaining >= response.Metadata.DepthRequired {
cd.checkFromCacheCounter.Inc()
// If debugging is requested, add the req and the response to the trace.
if req.Debug == v1.DispatchCheckRequest_ENABLE_BASIC_DEBUGGING {
response.Metadata.DebugInfo = &v1.DebugInformation{
Check: &v1.CheckDebugTrace{
Request: req,
Results: maps.Clone(response.ResultsByResourceId),
IsCachedResult: true,
},
}
}
return &response, nil
}
}
computed, err := cd.d.DispatchCheck(ctx, req)
// We only want to cache the result if there was no error
if err == nil {
adjustedComputed := computed.CloneVT()
adjustedComputed.Metadata.CachedDispatchCount = adjustedComputed.Metadata.DispatchCount
adjustedComputed.Metadata.DispatchCount = 0
adjustedComputed.Metadata.DebugInfo = nil
adjustedBytes, err := adjustedComputed.MarshalVT()
if err != nil {
return &v1.DispatchCheckResponse{Metadata: &v1.ResponseMeta{}}, err
}
cd.c.Set(requestKey, adjustedBytes, sliceSize(adjustedBytes))
}
// Return both the computed and err in ALL cases: computed contains resolved
// metadata even if there was an error.
return computed, err
}
// DispatchExpand implements dispatch.Expand interface and does not do any caching yet.
func (cd *Dispatcher) DispatchExpand(ctx context.Context, req *v1.DispatchExpandRequest) (*v1.DispatchExpandResponse, error) {
resp, err := cd.d.DispatchExpand(ctx, req)
return resp, err
}
// DispatchReachableResources implements dispatch.ReachableResources interface.
func (cd *Dispatcher) DispatchReachableResources(req *v1.DispatchReachableResourcesRequest, stream dispatch.ReachableResourcesStream) error {
cd.reachableResourcesTotalCounter.Inc()
if req.OptionalLimit == 0 {
return spiceerrors.MustBugf("a limit must be specified on reachable resources to use with the caching dispatcher")
}
requestKey, err := cd.keyHandler.ReachableResourcesCacheKey(stream.Context(), req)
if err != nil {
return err
}
if cachedResultRaw, found := cd.c.Get(requestKey); found {
cd.reachableResourcesFromCacheCounter.Inc()
for _, slice := range cachedResultRaw.([][]byte) {
var response v1.DispatchReachableResourcesResponse
if err := response.UnmarshalVT(slice); err != nil {
return fmt.Errorf("could not publish cached reachable resources result: %w", err)
}
if err := stream.Publish(&response); err != nil {
return fmt.Errorf("could not publish cached reachable resources result: %w", err)
}
}
return nil
}
var (
mu sync.Mutex
toCacheResults [][]byte
)
wrapped := &dispatch.WrappedDispatchStream[*v1.DispatchReachableResourcesResponse]{
Stream: stream,
Ctx: stream.Context(),
Processor: func(result *v1.DispatchReachableResourcesResponse) (*v1.DispatchReachableResourcesResponse, bool, error) {
adjustedResult := result.CloneVT()
adjustedResult.Metadata.CachedDispatchCount = adjustedResult.Metadata.DispatchCount
adjustedResult.Metadata.DispatchCount = 0
adjustedResult.Metadata.DebugInfo = nil
adjustedBytes, err := adjustedResult.MarshalVT()
if err != nil {
return nil, false, err
}
mu.Lock()
toCacheResults = append(toCacheResults, adjustedBytes)
mu.Unlock()
return result, true, nil
},
}
if err := cd.d.DispatchReachableResources(req, wrapped); err != nil {
return err
}
var size int64
for _, slice := range toCacheResults {
size += sliceSize(slice)
}
cd.c.Set(requestKey, toCacheResults, size)
return nil
}
func sliceSize(xs []byte) int64 {
// Slice Header + Slice Contents
return int64(int(unsafe.Sizeof(xs)) + len(xs))
}
// DispatchLookupResources implements dispatch.LookupResources interface.
func (cd *Dispatcher) DispatchLookupResources(req *v1.DispatchLookupResourcesRequest, stream dispatch.LookupResourcesStream) error {
cd.lookupResourcesTotalCounter.Inc()
if req.OptionalLimit == 0 {
return spiceerrors.MustBugf("a limit must be specified on lookup resources to use with the caching dispatcher")
}
requestKey, err := cd.keyHandler.LookupResourcesCacheKey(stream.Context(), req)
if err != nil {
return err
}
if cachedResultRaw, found := cd.c.Get(requestKey); found {
cd.lookupResourcesFromCacheCounter.Inc()
for _, slice := range cachedResultRaw.([][]byte) {
var response v1.DispatchLookupResourcesResponse
if err := response.UnmarshalVT(slice); err != nil {
return err
}
if err := stream.Publish(&response); err != nil {
// don't wrap error with additional context, as it may be a grpc status.Status.
// status.FromError() is unable to unwrap status.Status values, and as a consequence
// the Dispatcher wouldn't properly propagate the gRPC error code
return err
}
}
return nil
}
var (
mu sync.Mutex
toCacheResults [][]byte
)
wrapped := &dispatch.WrappedDispatchStream[*v1.DispatchLookupResourcesResponse]{
Stream: stream,
Ctx: stream.Context(),
Processor: func(result *v1.DispatchLookupResourcesResponse) (*v1.DispatchLookupResourcesResponse, bool, error) {
adjustedResult := result.CloneVT()
adjustedResult.Metadata.CachedDispatchCount = adjustedResult.Metadata.DispatchCount
adjustedResult.Metadata.DispatchCount = 0
adjustedResult.Metadata.DebugInfo = nil
adjustedBytes, err := adjustedResult.MarshalVT()
if err != nil {
return &v1.DispatchLookupResourcesResponse{Metadata: &v1.ResponseMeta{}}, false, err
}
mu.Lock()
toCacheResults = append(toCacheResults, adjustedBytes)
mu.Unlock()
return result, true, nil
},
}
if err := cd.d.DispatchLookupResources(req, wrapped); err != nil {
return err
}
var size int64
for _, slice := range toCacheResults {
size += sliceSize(slice)
}
cd.c.Set(requestKey, toCacheResults, size)
return nil
}
// DispatchLookupSubjects implements dispatch.LookupSubjects interface.
func (cd *Dispatcher) DispatchLookupSubjects(req *v1.DispatchLookupSubjectsRequest, stream dispatch.LookupSubjectsStream) error {
cd.lookupSubjectsTotalCounter.Inc()
requestKey, err := cd.keyHandler.LookupSubjectsCacheKey(stream.Context(), req)
if err != nil {
return err
}
if cachedResultRaw, found := cd.c.Get(requestKey); found {
cd.lookupSubjectsFromCacheCounter.Inc()
for _, slice := range cachedResultRaw.([][]byte) {
var response v1.DispatchLookupSubjectsResponse
if err := response.UnmarshalVT(slice); err != nil {
return err
}
if err := stream.Publish(&response); err != nil {
// don't wrap error with additional context, as it may be a grpc status.Status.
// status.FromError() is unable to unwrap status.Status values, and as a consequence
// the Dispatcher wouldn't properly propagate the gRPC error code
return err
}
}
return nil
}
var (
mu sync.Mutex
toCacheResults [][]byte
)
wrapped := &dispatch.WrappedDispatchStream[*v1.DispatchLookupSubjectsResponse]{
Stream: stream,
Ctx: stream.Context(),
Processor: func(result *v1.DispatchLookupSubjectsResponse) (*v1.DispatchLookupSubjectsResponse, bool, error) {
adjustedResult := result.CloneVT()
adjustedResult.Metadata.CachedDispatchCount = adjustedResult.Metadata.DispatchCount
adjustedResult.Metadata.DispatchCount = 0
adjustedResult.Metadata.DebugInfo = nil
adjustedBytes, err := adjustedResult.MarshalVT()
if err != nil {
return &v1.DispatchLookupSubjectsResponse{Metadata: &v1.ResponseMeta{}}, false, err
}
mu.Lock()
toCacheResults = append(toCacheResults, adjustedBytes)
mu.Unlock()
return result, true, nil
},
}
if err := cd.d.DispatchLookupSubjects(req, wrapped); err != nil {
return err
}
var size int64
for _, slice := range toCacheResults {
size += sliceSize(slice)
}
cd.c.Set(requestKey, toCacheResults, size)
return nil
}
func (cd *Dispatcher) Close() error {
prometheus.Unregister(cd.checkTotalCounter)
prometheus.Unregister(cd.checkFromCacheCounter)
prometheus.Unregister(cd.reachableResourcesTotalCounter)
prometheus.Unregister(cd.reachableResourcesFromCacheCounter)
prometheus.Unregister(cd.lookupResourcesTotalCounter)
prometheus.Unregister(cd.lookupResourcesFromCacheCounter)
prometheus.Unregister(cd.lookupSubjectsFromCacheCounter)
prometheus.Unregister(cd.lookupSubjectsTotalCounter)
if cache := cd.c; cache != nil {
cache.Close()
}
return nil
}
func (cd *Dispatcher) ReadyState() dispatch.ReadyState {
if cd.c == nil {
return dispatch.ReadyState{
IsReady: false,
Message: "caching dispatcher is missing cache",
}
}
if cd.d == nil {
return dispatch.ReadyState{
IsReady: false,
Message: "caching dispatcher is missing delegate dispatcher",
}
}
return cd.d.ReadyState()
}
// Always verify that we implement the interfaces
var _ dispatch.Dispatcher = &Dispatcher{}