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
|
package schema
import (
"context"
"fmt"
"slices"
"github.com/authzed/spicedb/pkg/datastore"
core "github.com/authzed/spicedb/pkg/proto/core/v1"
"github.com/authzed/spicedb/pkg/schemadsl/compiler"
)
// Resolver is an interface defined for resolving referenced namespaces and caveats when constructing
// and validating a type system.
type Resolver interface {
// LookupDefinition lookups up a namespace definition, also returning whether it was pre-validated.
LookupDefinition(ctx context.Context, name string) (*core.NamespaceDefinition, bool, error)
// LookupCaveat lookups up a caveat.
LookupCaveat(ctx context.Context, name string) (*Caveat, error)
}
// ResolverForDatastoreReader returns a Resolver for a datastore reader.
func ResolverForDatastoreReader(ds datastore.Reader) *DatastoreResolver {
return &DatastoreResolver{
ds: ds,
}
}
// PredefinedElements are predefined namespaces and/or caveats to give to a resolver.
type PredefinedElements struct {
Definitions []*core.NamespaceDefinition
Caveats []*Caveat
}
func (pe PredefinedElements) combineWith(other PredefinedElements) PredefinedElements {
return PredefinedElements{
Definitions: append(slices.Clone(pe.Definitions), other.Definitions...),
Caveats: append(slices.Clone(pe.Caveats), other.Caveats...),
}
}
// ResolverForPredefinedDefinitions returns a resolver for predefined namespaces and caveats.
func ResolverForPredefinedDefinitions(predefined PredefinedElements) Resolver {
return &DatastoreResolver{
predefined: predefined,
}
}
// ResolverForSchema returns a resolver for a schema.
func ResolverForSchema(schema compiler.CompiledSchema) Resolver {
return ResolverForPredefinedDefinitions(
PredefinedElements{
Definitions: schema.ObjectDefinitions,
Caveats: schema.CaveatDefinitions,
},
)
}
// DatastoreResolver is a resolver implementation for a datastore, to look up schema stored in the underlying storage.
type DatastoreResolver struct {
ds datastore.Reader
predefined PredefinedElements
}
// LookupDefinition lookups up a namespace definition, also returning whether it was pre-validated.
func (r *DatastoreResolver) LookupDefinition(ctx context.Context, name string) (*core.NamespaceDefinition, bool, error) {
if len(r.predefined.Definitions) > 0 {
for _, def := range r.predefined.Definitions {
if def.Name == name {
return def, false, nil
}
}
}
if r.ds == nil {
return nil, false, asTypeError(NewDefinitionNotFoundErr(name))
}
ns, _, err := r.ds.ReadNamespaceByName(ctx, name)
return ns, true, err
}
// WithPredefinedElements adds elements (definitions and caveats) that will be used as a local overlay
// for the datastore, often for validation.
func (r *DatastoreResolver) WithPredefinedElements(predefined PredefinedElements) Resolver {
return &DatastoreResolver{
ds: r.ds,
predefined: predefined.combineWith(r.predefined),
}
}
// LookupCaveat lookups up a caveat.
func (r *DatastoreResolver) LookupCaveat(ctx context.Context, name string) (*Caveat, error) {
if len(r.predefined.Caveats) > 0 {
for _, caveat := range r.predefined.Caveats {
if caveat.Name == name {
return caveat, nil
}
}
}
if r.ds == nil {
return nil, asTypeError(NewCaveatNotFoundErr(name))
}
cr, ok := r.ds.(datastore.CaveatReader)
if !ok {
return nil, fmt.Errorf("caveats are not supported on this datastore type")
}
caveatDef, _, err := cr.ReadCaveatByName(ctx, name)
return caveatDef, err
}
|
