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
|
package decode
import (
"errors"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path"
"path/filepath"
"regexp"
"strings"
"github.com/rs/zerolog/log"
"gopkg.in/yaml.v3"
composable "github.com/authzed/spicedb/pkg/composableschemadsl/compiler"
"github.com/authzed/spicedb/pkg/composableschemadsl/generator"
"github.com/authzed/spicedb/pkg/schemadsl/compiler"
"github.com/authzed/spicedb/pkg/schemadsl/input"
"github.com/authzed/spicedb/pkg/spiceerrors"
"github.com/authzed/spicedb/pkg/validationfile"
"github.com/authzed/spicedb/pkg/validationfile/blocks"
)
var playgroundPattern = regexp.MustCompile("^.*/s/.*/schema|relationships|assertions|expected.*$")
// SchemaRelationships holds the schema (as a string) and a list of
// relationships (as a string) in the format from the devtools download API.
type SchemaRelationships struct {
Schema string `yaml:"schema"`
Relationships string `yaml:"relationships"`
}
// Func will decode into the supplied object.
type Func func(out interface{}) ([]byte, bool, error)
// DecoderForURL returns the appropriate decoder for a given URL.
// Some URLs have special handling to dereference to the actual file.
func DecoderForURL(u *url.URL) (d Func, err error) {
switch s := u.Scheme; s {
case "", "file":
d = fileDecoder(u)
case "http", "https":
d = httpDecoder(u)
default:
err = fmt.Errorf("%s scheme not supported", s)
}
return
}
func fileDecoder(u *url.URL) Func {
return func(out interface{}) ([]byte, bool, error) {
file, err := os.Open(u.Path)
if err != nil {
return nil, false, err
}
data, err := io.ReadAll(file)
if err != nil {
return nil, false, err
}
isOnlySchema, err := unmarshalAsYAMLOrSchemaWithFile(data, out, u.Path)
return data, isOnlySchema, err
}
}
func httpDecoder(u *url.URL) Func {
rewriteURL(u)
return directHTTPDecoder(u)
}
func rewriteURL(u *url.URL) {
// match playground urls
if playgroundPattern.MatchString(u.Path) {
u.Path = u.Path[:strings.LastIndex(u.Path, "/")]
u.Path += "/download"
return
}
switch u.Hostname() {
case "gist.github.com":
u.Host = "gist.githubusercontent.com"
u.Path = path.Join(u.Path, "/raw")
case "pastebin.com":
if ok, _ := path.Match("/raw/*", u.Path); ok {
return
}
u.Path = path.Join("/raw/", u.Path)
}
}
func directHTTPDecoder(u *url.URL) Func {
return func(out interface{}) ([]byte, bool, error) {
log.Debug().Stringer("url", u).Send()
r, err := http.Get(u.String())
if err != nil {
return nil, false, err
}
defer r.Body.Close()
data, err := io.ReadAll(r.Body)
if err != nil {
return nil, false, err
}
isOnlySchema, err := unmarshalAsYAMLOrSchema("", data, out)
return data, isOnlySchema, err
}
}
// Uses the files passed in the args and looks for the specified schemaFile to parse the YAML.
func unmarshalAsYAMLOrSchemaWithFile(data []byte, out interface{}, filename string) (bool, error) {
if strings.Contains(string(data), "schemaFile:") && !strings.Contains(string(data), "schema:") {
if err := yaml.Unmarshal(data, out); err != nil {
return false, err
}
validationFile, ok := out.(*validationfile.ValidationFile)
if !ok {
return false, fmt.Errorf("could not cast unmarshalled file to validationfile")
}
// Need to join the original filepath with the requested filepath
// to construct the path to the referenced schema file.
// NOTE: This does not allow for yaml files to transitively reference
// each other's schemaFile fields.
// TODO: enable this behavior
schemaPath := filepath.Join(path.Dir(filename), validationFile.SchemaFile)
if !filepath.IsLocal(schemaPath) {
// We want to prevent access of files that are outside of the folder
// where the command was originally invoked. This should do that.
return false, fmt.Errorf("schema filepath %s must be local to where the command was invoked", schemaPath)
}
file, err := os.Open(schemaPath)
if err != nil {
return false, err
}
data, err = io.ReadAll(file)
if err != nil {
return false, err
}
}
return unmarshalAsYAMLOrSchema(filename, data, out)
}
func unmarshalAsYAMLOrSchema(filename string, data []byte, out interface{}) (bool, error) {
inputString := string(data)
// Check for indications of a schema-only file.
if !strings.Contains(inputString, "schema:") && !strings.Contains(inputString, "relationships:") {
if err := compileSchemaFromData(filename, inputString, out); err != nil {
return false, err
}
return true, nil
}
if !strings.Contains(inputString, "schema:") && !strings.Contains(inputString, "schemaFile:") {
// If there is no schema and no schemaFile and it doesn't compile then it must be yaml with missing fields
if err := compileSchemaFromData(filename, inputString, out); err != nil {
return false, errors.New("either schema or schemaFile must be present")
}
return true, nil
}
// Try to unparse as YAML for the validation file format.
if err := yaml.Unmarshal(data, out); err != nil {
return false, err
}
return false, nil
}
// compileSchemaFromData attempts to compile using the old DSL and the new composable DSL,
// but prefers the new DSL.
// It returns the errors returned by both compilations.
func compileSchemaFromData(filename, schemaString string, out interface{}) error {
var (
standardCompileErr error
composableCompiled *composable.CompiledSchema
composableCompileErr error
vfile validationfile.ValidationFile
)
vfile = *out.(*validationfile.ValidationFile)
vfile.Schema = blocks.ParsedSchema{
SourcePosition: spiceerrors.SourcePosition{LineNumber: 1, ColumnPosition: 1},
}
_, standardCompileErr = compiler.Compile(compiler.InputSchema{
Source: input.Source("schema"),
SchemaString: schemaString,
}, compiler.AllowUnprefixedObjectType())
if standardCompileErr == nil {
vfile.Schema.Schema = schemaString
}
inputSourceFolder := filepath.Dir(filename)
composableCompiled, composableCompileErr = composable.Compile(composable.InputSchema{
SchemaString: schemaString,
}, composable.AllowUnprefixedObjectType(), composable.SourceFolder(inputSourceFolder))
if composableCompileErr == nil {
compiledSchemaString, _, err := generator.GenerateSchema(composableCompiled.OrderedDefinitions)
if err != nil {
return fmt.Errorf("could not generate string schema: %w", err)
}
vfile.Schema.Schema = compiledSchemaString
}
err := errors.Join(standardCompileErr, composableCompileErr)
*out.(*validationfile.ValidationFile) = vfile
return err
}
|
