-
Notifications
You must be signed in to change notification settings - Fork 257
/
bulkcheck.go
251 lines (211 loc) · 7.57 KB
/
bulkcheck.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
package v1
import (
"context"
"sync"
v1 "github.com/authzed/authzed-go/proto/authzed/api/v1"
"github.com/jzelinskie/stringz"
"google.golang.org/grpc/status"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/graph"
"github.com/authzed/spicedb/internal/graph/computed"
datastoremw "github.com/authzed/spicedb/internal/middleware/datastore"
"github.com/authzed/spicedb/internal/middleware/usagemetrics"
"github.com/authzed/spicedb/internal/namespace"
"github.com/authzed/spicedb/internal/services/shared"
"github.com/authzed/spicedb/internal/taskrunner"
"github.com/authzed/spicedb/pkg/genutil"
"github.com/authzed/spicedb/pkg/genutil/mapz"
"github.com/authzed/spicedb/pkg/genutil/slicez"
"github.com/authzed/spicedb/pkg/middleware/consistency"
dispatchv1 "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
"github.com/authzed/spicedb/pkg/spiceerrors"
)
// bulkChecker contains the logic to allow ExperimentalService/BulkCheckPermission and
// PermissionsService/CheckBulkPermissions to share the same implementation.
type bulkChecker struct {
maxAPIDepth uint32
maxCaveatContextSize int
maxConcurrency uint16
dispatch dispatch.Dispatcher
}
func (bc *bulkChecker) checkBulkPermissions(ctx context.Context, req *v1.CheckBulkPermissionsRequest) (*v1.CheckBulkPermissionsResponse, error) {
atRevision, checkedAt, err := consistency.RevisionFromContext(ctx)
if err != nil {
return nil, err
}
if len(req.Items) > maxBulkCheckCount {
return nil, NewExceedsMaximumChecksErr(uint64(len(req.Items)), maxBulkCheckCount)
}
// Compute a hash for each requested item and record its index(es) for the items, to be used for sorting of results.
itemCount, err := genutil.EnsureUInt32(len(req.Items))
if err != nil {
return nil, err
}
itemIndexByHash := mapz.NewMultiMapWithCap[string, int](itemCount)
for index, item := range req.Items {
itemHash, err := computeCheckBulkPermissionsItemHash(item)
if err != nil {
return nil, err
}
itemIndexByHash.Add(itemHash, index)
}
// Identify checks with same permission+subject over different resources and group them. This is doable because
// the dispatching system already internally supports this kind of batching for performance.
groupedItems, err := groupItems(ctx, groupingParameters{
atRevision: atRevision,
maxCaveatContextSize: bc.maxCaveatContextSize,
maximumAPIDepth: bc.maxAPIDepth,
}, req.Items)
if err != nil {
return nil, err
}
bulkResponseMutex := sync.Mutex{}
tr := taskrunner.NewPreloadedTaskRunner(ctx, bc.maxConcurrency, len(groupedItems))
respMetadata := &dispatchv1.ResponseMeta{
DispatchCount: 1,
CachedDispatchCount: 0,
DepthRequired: 1,
DebugInfo: nil,
}
usagemetrics.SetInContext(ctx, respMetadata)
orderedPairs := make([]*v1.CheckBulkPermissionsPair, len(req.Items))
addPair := func(pair *v1.CheckBulkPermissionsPair) error {
pairItemHash, err := computeCheckBulkPermissionsItemHash(pair.Request)
if err != nil {
return err
}
found, ok := itemIndexByHash.Get(pairItemHash)
if !ok {
return spiceerrors.MustBugf("missing expected item hash")
}
for _, index := range found {
orderedPairs[index] = pair
}
return nil
}
appendResultsForError := func(params *computed.CheckParameters, resourceIDs []string, err error) error {
rewritten := shared.RewriteError(ctx, err, &shared.ConfigForErrors{
MaximumAPIDepth: bc.maxAPIDepth,
})
statusResp, ok := status.FromError(rewritten)
if !ok {
// If error is not a gRPC Status, fail the entire bulk check request.
return err
}
bulkResponseMutex.Lock()
defer bulkResponseMutex.Unlock()
for _, resourceID := range resourceIDs {
reqItem, err := requestItemFromResourceAndParameters(params, resourceID)
if err != nil {
return err
}
if err := addPair(&v1.CheckBulkPermissionsPair{
Request: reqItem,
Response: &v1.CheckBulkPermissionsPair_Error{
Error: statusResp.Proto(),
},
}); err != nil {
return err
}
}
return nil
}
appendResultsForCheck := func(params *computed.CheckParameters, resourceIDs []string, metadata *dispatchv1.ResponseMeta, results map[string]*dispatchv1.ResourceCheckResult) error {
bulkResponseMutex.Lock()
defer bulkResponseMutex.Unlock()
for _, resourceID := range resourceIDs {
reqItem, err := requestItemFromResourceAndParameters(params, resourceID)
if err != nil {
return err
}
if err := addPair(&v1.CheckBulkPermissionsPair{
Request: reqItem,
Response: pairItemFromCheckResult(results[resourceID]),
}); err != nil {
return err
}
}
respMetadata.DispatchCount += metadata.DispatchCount
respMetadata.CachedDispatchCount += metadata.CachedDispatchCount
return nil
}
for _, group := range groupedItems {
group := group
slicez.ForEachChunk(group.resourceIDs, MaxBulkCheckDispatchChunkSize, func(resourceIDs []string) {
tr.Add(func(ctx context.Context) error {
ds := datastoremw.MustFromContext(ctx).SnapshotReader(atRevision)
// Ensure the check namespaces and relations are valid.
err := namespace.CheckNamespaceAndRelations(ctx,
[]namespace.TypeAndRelationToCheck{
{
NamespaceName: group.params.ResourceType.Namespace,
RelationName: group.params.ResourceType.Relation,
AllowEllipsis: false,
},
{
NamespaceName: group.params.Subject.Namespace,
RelationName: stringz.DefaultEmpty(group.params.Subject.Relation, graph.Ellipsis),
AllowEllipsis: true,
},
}, ds)
if err != nil {
return appendResultsForError(group.params, resourceIDs, err)
}
// Call bulk check to compute the check result(s) for the resource ID(s).
rcr, metadata, err := computed.ComputeBulkCheck(ctx, bc.dispatch, *group.params, resourceIDs)
if err != nil {
return appendResultsForError(group.params, resourceIDs, err)
}
return appendResultsForCheck(group.params, resourceIDs, metadata, rcr)
})
})
}
// Run the checks in parallel.
if err := tr.StartAndWait(); err != nil {
return nil, err
}
return &v1.CheckBulkPermissionsResponse{CheckedAt: checkedAt, Pairs: orderedPairs}, nil
}
func toCheckBulkPermissionsRequest(req *v1.BulkCheckPermissionRequest) *v1.CheckBulkPermissionsRequest {
items := make([]*v1.CheckBulkPermissionsRequestItem, len(req.Items))
for i, item := range req.Items {
items[i] = &v1.CheckBulkPermissionsRequestItem{
Resource: item.Resource,
Permission: item.Permission,
Subject: item.Subject,
Context: item.Context,
}
}
return &v1.CheckBulkPermissionsRequest{Items: items}
}
func toBulkCheckPermissionResponse(resp *v1.CheckBulkPermissionsResponse) *v1.BulkCheckPermissionResponse {
pairs := make([]*v1.BulkCheckPermissionPair, len(resp.Pairs))
for i, pair := range resp.Pairs {
pairs[i] = &v1.BulkCheckPermissionPair{}
pairs[i].Request = &v1.BulkCheckPermissionRequestItem{
Resource: pair.Request.Resource,
Permission: pair.Request.Permission,
Subject: pair.Request.Subject,
Context: pair.Request.Context,
}
switch t := pair.Response.(type) {
case *v1.CheckBulkPermissionsPair_Item:
pairs[i].Response = &v1.BulkCheckPermissionPair_Item{
Item: &v1.BulkCheckPermissionResponseItem{
Permissionship: t.Item.Permissionship,
PartialCaveatInfo: t.Item.PartialCaveatInfo,
},
}
case *v1.CheckBulkPermissionsPair_Error:
pairs[i].Response = &v1.BulkCheckPermissionPair_Error{
Error: t.Error,
}
default:
panic("unknown CheckBulkPermissionResponse pair response type")
}
}
return &v1.BulkCheckPermissionResponse{
CheckedAt: resp.CheckedAt,
Pairs: pairs,
}
}