-
Notifications
You must be signed in to change notification settings - Fork 246
/
relationships.go
408 lines (340 loc) · 13.3 KB
/
relationships.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
package v1
import (
"context"
"fmt"
"time"
v1 "github.com/authzed/authzed-go/proto/authzed/api/v1"
grpcvalidate "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/validator"
"github.com/jzelinskie/stringz"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/samber/lo"
"google.golang.org/protobuf/proto"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/middleware"
datastoremw "github.com/authzed/spicedb/internal/middleware/datastore"
"github.com/authzed/spicedb/internal/middleware/handwrittenvalidation"
"github.com/authzed/spicedb/internal/middleware/streamtimeout"
"github.com/authzed/spicedb/internal/middleware/usagemetrics"
"github.com/authzed/spicedb/internal/namespace"
"github.com/authzed/spicedb/internal/relationships"
"github.com/authzed/spicedb/internal/services/shared"
"github.com/authzed/spicedb/pkg/cursor"
"github.com/authzed/spicedb/pkg/datastore"
"github.com/authzed/spicedb/pkg/datastore/options"
"github.com/authzed/spicedb/pkg/datastore/pagination"
"github.com/authzed/spicedb/pkg/middleware/consistency"
core "github.com/authzed/spicedb/pkg/proto/core/v1"
dispatchv1 "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
"github.com/authzed/spicedb/pkg/tuple"
"github.com/authzed/spicedb/pkg/util"
"github.com/authzed/spicedb/pkg/zedtoken"
)
var writeUpdateCounter = promauto.NewHistogramVec(prometheus.HistogramOpts{
Namespace: "spicedb",
Subsystem: "v1",
Name: "write_relationships_updates",
Help: "The update counts for the WriteRelationships calls",
Buckets: []float64{0, 1, 2, 5, 10, 15, 25, 50, 100, 250, 500, 1000},
}, []string{"kind"})
// PermissionsServerConfig is configuration for the permissions server.
type PermissionsServerConfig struct {
// MaxUpdatesPerWrite holds the maximum number of updates allowed per
// WriteRelationships call.
MaxUpdatesPerWrite uint16
// MaxPreconditionsCount holds the maximum number of preconditions allowed
// on a WriteRelationships or DeleteRelationships call.
MaxPreconditionsCount uint16
// MaximumAPIDepth is the default/starting depth remaining for API calls made
// to the permissions server.
MaximumAPIDepth uint32
// StreamingAPITimeout is the timeout for streaming APIs when no response has been
// recently received.
StreamingAPITimeout time.Duration
// MaxCaveatContextSize defines the maximum length of the request caveat context in bytes
MaxCaveatContextSize int
// MaxRelationshipContextSize defines the maximum length of a relationship's context in bytes
MaxRelationshipContextSize int
// MaxDatastoreReadPageSize defines the maximum number of relationships loaded from the
// datastore in one query.
MaxDatastoreReadPageSize uint64
}
// NewPermissionsServer creates a PermissionsServiceServer instance.
func NewPermissionsServer(
dispatch dispatch.Dispatcher,
config PermissionsServerConfig,
) v1.PermissionsServiceServer {
configWithDefaults := PermissionsServerConfig{
MaxPreconditionsCount: defaultIfZero(config.MaxPreconditionsCount, 1000),
MaxUpdatesPerWrite: defaultIfZero(config.MaxUpdatesPerWrite, 1000),
MaximumAPIDepth: defaultIfZero(config.MaximumAPIDepth, 50),
StreamingAPITimeout: defaultIfZero(config.StreamingAPITimeout, 30*time.Second),
MaxCaveatContextSize: defaultIfZero(config.MaxCaveatContextSize, 4096),
MaxRelationshipContextSize: defaultIfZero(config.MaxRelationshipContextSize, 25_000),
MaxDatastoreReadPageSize: defaultIfZero(config.MaxDatastoreReadPageSize, 1_000),
}
return &permissionServer{
dispatch: dispatch,
config: configWithDefaults,
WithServiceSpecificInterceptors: shared.WithServiceSpecificInterceptors{
Unary: middleware.ChainUnaryServer(
grpcvalidate.UnaryServerInterceptor(true),
handwrittenvalidation.UnaryServerInterceptor,
usagemetrics.UnaryServerInterceptor(),
),
Stream: middleware.ChainStreamServer(
grpcvalidate.StreamServerInterceptor(true),
handwrittenvalidation.StreamServerInterceptor,
usagemetrics.StreamServerInterceptor(),
streamtimeout.MustStreamServerInterceptor(configWithDefaults.StreamingAPITimeout),
),
},
}
}
type permissionServer struct {
v1.UnimplementedPermissionsServiceServer
shared.WithServiceSpecificInterceptors
dispatch dispatch.Dispatcher
config PermissionsServerConfig
}
func (ps *permissionServer) checkFilterComponent(ctx context.Context, objectType, optionalRelation string, ds datastore.Reader) error {
relationToTest := stringz.DefaultEmpty(optionalRelation, datastore.Ellipsis)
allowEllipsis := optionalRelation == ""
return namespace.CheckNamespaceAndRelation(ctx, objectType, relationToTest, allowEllipsis, ds)
}
func (ps *permissionServer) checkFilterNamespaces(ctx context.Context, filter *v1.RelationshipFilter, ds datastore.Reader) error {
if err := ps.checkFilterComponent(ctx, filter.ResourceType, filter.OptionalRelation, ds); err != nil {
return err
}
if subjectFilter := filter.OptionalSubjectFilter; subjectFilter != nil {
subjectRelation := ""
if subjectFilter.OptionalRelation != nil {
subjectRelation = subjectFilter.OptionalRelation.Relation
}
if err := ps.checkFilterComponent(ctx, subjectFilter.SubjectType, subjectRelation, ds); err != nil {
return err
}
}
return nil
}
func (ps *permissionServer) ReadRelationships(req *v1.ReadRelationshipsRequest, resp v1.PermissionsService_ReadRelationshipsServer) error {
ctx := resp.Context()
atRevision, revisionReadAt, err := consistency.RevisionFromContext(ctx)
if err != nil {
return shared.RewriteError(ctx, err)
}
ds := datastoremw.MustFromContext(ctx).SnapshotReader(atRevision)
if err := ps.checkFilterNamespaces(ctx, req.RelationshipFilter, ds); err != nil {
return shared.RewriteError(ctx, err)
}
usagemetrics.SetInContext(ctx, &dispatchv1.ResponseMeta{
DispatchCount: 1,
})
limit := 0
var startCursor options.Cursor
rrRequestHash, err := computeReadRelationshipsRequestHash(req)
if err != nil {
return shared.RewriteError(ctx, err)
}
if req.OptionalCursor != nil {
decodedCursor, err := cursor.DecodeToDispatchCursor(req.OptionalCursor, rrRequestHash)
if err != nil {
return shared.RewriteError(ctx, err)
}
if len(decodedCursor.Sections) != 1 {
return shared.RewriteError(ctx, NewInvalidCursorErr("did not find expected resume relationship"))
}
parsed := tuple.Parse(decodedCursor.Sections[0])
if parsed == nil {
return shared.RewriteError(ctx, NewInvalidCursorErr("could not parse resume relationship"))
}
startCursor = options.Cursor(parsed)
}
pageSize := ps.config.MaxDatastoreReadPageSize
if req.OptionalLimit > 0 {
limit = int(req.OptionalLimit)
if uint64(limit) < pageSize {
pageSize = uint64(limit)
}
}
tupleIterator, err := pagination.NewPaginatedIterator(
ctx,
ds,
datastore.RelationshipsFilterFromPublicFilter(req.RelationshipFilter),
pageSize,
options.ByResource,
startCursor,
)
if err != nil {
return shared.RewriteError(ctx, err)
}
defer tupleIterator.Close()
response := &v1.ReadRelationshipsResponse{
ReadAt: revisionReadAt,
}
targetRel := tuple.NewRelationship()
targetCaveat := &v1.ContextualizedCaveat{}
returnedCount := 0
dispatchCursor := &dispatchv1.Cursor{
AtRevision: atRevision.String(),
Sections: []string{""},
}
for tpl := tupleIterator.Next(); tpl != nil; tpl = tupleIterator.Next() {
if limit > 0 && returnedCount >= limit {
break
}
if tupleIterator.Err() != nil {
return shared.RewriteError(ctx, fmt.Errorf("error when reading tuples: %w", tupleIterator.Err()))
}
dispatchCursor.Sections[0] = tuple.StringWithoutCaveat(tpl)
encodedCursor, err := cursor.EncodeFromDispatchCursor(dispatchCursor, rrRequestHash)
if err != nil {
return shared.RewriteError(ctx, err)
}
tuple.MustToRelationshipMutating(tpl, targetRel, targetCaveat)
response.Relationship = targetRel
response.AfterResultCursor = encodedCursor
err = resp.Send(response)
if err != nil {
return shared.RewriteError(ctx, fmt.Errorf("error when streaming tuple: %w", err))
}
returnedCount++
}
if tupleIterator.Err() != nil {
return shared.RewriteError(ctx, fmt.Errorf("error when reading tuples: %w", tupleIterator.Err()))
}
tupleIterator.Close()
return nil
}
func (ps *permissionServer) WriteRelationships(ctx context.Context, req *v1.WriteRelationshipsRequest) (*v1.WriteRelationshipsResponse, error) {
ds := datastoremw.MustFromContext(ctx)
// Ensure that the updates and preconditions are not over the configured limits.
if len(req.Updates) > int(ps.config.MaxUpdatesPerWrite) {
return nil, shared.RewriteError(
ctx,
NewExceedsMaximumUpdatesErr(uint16(len(req.Updates)), ps.config.MaxUpdatesPerWrite),
)
}
if len(req.OptionalPreconditions) > int(ps.config.MaxPreconditionsCount) {
return nil, shared.RewriteError(
ctx,
NewExceedsMaximumPreconditionsErr(uint16(len(req.OptionalPreconditions)), ps.config.MaxPreconditionsCount),
)
}
// Check for duplicate updates and create the set of caveat names to load.
updateRelationshipSet := util.NewSet[string]()
for _, update := range req.Updates {
tupleStr := tuple.StringRelationshipWithoutCaveat(update.Relationship)
if !updateRelationshipSet.Add(tupleStr) {
return nil, shared.RewriteError(
ctx,
NewDuplicateRelationshipErr(update),
)
}
if proto.Size(update.Relationship.OptionalCaveat) > ps.config.MaxRelationshipContextSize {
return nil, shared.RewriteError(
ctx,
NewMaxRelationshipContextError(update, ps.config.MaxRelationshipContextSize),
)
}
}
// Execute the write operation(s).
tupleUpdates := tuple.UpdateFromRelationshipUpdates(req.Updates)
revision, err := ds.ReadWriteTx(ctx, func(rwt datastore.ReadWriteTransaction) error {
// Validate the preconditions.
for _, precond := range req.OptionalPreconditions {
if err := ps.checkFilterNamespaces(ctx, precond.Filter, rwt); err != nil {
return err
}
}
tuples := lo.Map(tupleUpdates, func(item *core.RelationTupleUpdate, _ int) *core.RelationTuple {
return item.Tuple
})
// Validate the updates.
err := relationships.ValidateRelationships(ctx, rwt, tuples)
if err != nil {
return shared.RewriteError(ctx, err)
}
usagemetrics.SetInContext(ctx, &dispatchv1.ResponseMeta{
// One request per precondition and one request for the actual writes.
DispatchCount: uint32(len(req.OptionalPreconditions)) + 1,
})
if err := checkPreconditions(ctx, rwt, req.OptionalPreconditions); err != nil {
return err
}
return rwt.WriteRelationships(ctx, tupleUpdates)
})
if err != nil {
return nil, shared.RewriteError(ctx, err)
}
// Log a metric of the counts of the different kinds of update operations.
updateCountByOperation := make(map[v1.RelationshipUpdate_Operation]int, 0)
for _, update := range req.Updates {
updateCountByOperation[update.Operation]++
}
for kind, count := range updateCountByOperation {
writeUpdateCounter.WithLabelValues(v1.RelationshipUpdate_Operation_name[int32(kind)]).Observe(float64(count))
}
return &v1.WriteRelationshipsResponse{
WrittenAt: zedtoken.MustNewFromRevision(revision),
}, nil
}
func (ps *permissionServer) DeleteRelationships(ctx context.Context, req *v1.DeleteRelationshipsRequest) (*v1.DeleteRelationshipsResponse, error) {
if len(req.OptionalPreconditions) > int(ps.config.MaxPreconditionsCount) {
return nil, shared.RewriteError(
ctx,
NewExceedsMaximumPreconditionsErr(uint16(len(req.OptionalPreconditions)), ps.config.MaxPreconditionsCount),
)
}
ds := datastoremw.MustFromContext(ctx)
deletionProgress := v1.DeleteRelationshipsResponse_DELETION_PROGRESS_COMPLETE
revision, err := ds.ReadWriteTx(ctx, func(rwt datastore.ReadWriteTransaction) error {
if err := ps.checkFilterNamespaces(ctx, req.RelationshipFilter, rwt); err != nil {
return err
}
var deleteMutations []*core.RelationTupleUpdate
if req.OptionalLimit > 0 {
limit := uint64(req.OptionalLimit)
deleteMutations = make([]*core.RelationTupleUpdate, 0, limit)
limitPlusOne := limit + 1
filter := datastore.RelationshipsFilterFromPublicFilter(req.RelationshipFilter)
iter, err := rwt.QueryRelationships(ctx, filter, options.WithLimit(&limitPlusOne))
if err != nil {
return shared.RewriteError(ctx, err)
}
defer iter.Close()
for tpl := iter.Next(); tpl != nil; tpl = iter.Next() {
if iter.Err() != nil {
return shared.RewriteError(ctx, err)
}
if len(deleteMutations) == int(limit) {
deletionProgress = v1.DeleteRelationshipsResponse_DELETION_PROGRESS_PARTIAL
if !req.OptionalAllowPartialDeletions {
return shared.RewriteError(ctx, NewCouldNotTransactionallyDeleteErr(req.RelationshipFilter, req.OptionalLimit))
}
break
}
deleteMutations = append(deleteMutations, tuple.Delete(tpl))
}
iter.Close()
}
usagemetrics.SetInContext(ctx, &dispatchv1.ResponseMeta{
// One request per precondition and one request for the actual delete.
DispatchCount: uint32(len(req.OptionalPreconditions)) + 1,
})
if err := checkPreconditions(ctx, rwt, req.OptionalPreconditions); err != nil {
return err
}
if len(deleteMutations) > 0 {
return rwt.WriteRelationships(ctx, deleteMutations)
}
return rwt.DeleteRelationships(ctx, req.RelationshipFilter)
})
if err != nil {
return nil, shared.RewriteError(ctx, err)
}
return &v1.DeleteRelationshipsResponse{
DeletedAt: zedtoken.MustNewFromRevision(revision),
DeletionProgress: deletionProgress,
}, nil
}