-
-
Notifications
You must be signed in to change notification settings - Fork 179
/
config.go
494 lines (409 loc) · 12 KB
/
config.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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
package core
import (
"context"
"fmt"
"log"
"os"
"path/filepath"
"strings"
"time"
"github.com/dosco/graphjin/core/internal/qcode"
"github.com/dosco/graphjin/internal/util"
"github.com/spf13/afero"
"github.com/spf13/viper"
)
// Core struct contains core specific config value
type Config struct {
// SecretKey is used to encrypt opaque values such as
// the cursor. Auto-generated if not set
SecretKey string `mapstructure:"secret_key"`
// DisableAllowList when set to true entirely disables the
// allow list workflow and all queries are always compiled
// even in production (Warning possible security concern)
DisableAllowList bool `mapstructure:"disable_allow_list"`
// ConfigPath is the default path to find all configuration
// files and scripts under
ConfigPath string `mapstructure:"config_path"`
// ScriptPath if the path to the script files if not set the
// path is assumed to be the same as the config path
ScriptPath string `mapstructure:"script_path"`
// SetUserID forces the database session variable `user.id` to
// be set to the user id
SetUserID bool `mapstructure:"set_user_id"`
// DefaultBlock ensures that in anonymous mode (role 'anon') all tables
// are blocked from queries and mutations. To open access to tables in
// anonymous mode they have to be added to the 'anon' role config
DefaultBlock bool `mapstructure:"default_block"`
// Vars is a map of hardcoded variables that can be leveraged in your
// queries. (eg. variable admin_id will be $admin_id in the query)
Vars map[string]string `mapstructure:"variables"`
// HeaderVars is a map of dynamic variables that map to http header values
HeaderVars map[string]string `mapstructure:"header_variables"`
// Blocklist is a list of tables and columns that should be filtered
// out from any and all queries
Blocklist []string
// Resolvers contain the configs for custom resolvers. For example the `remote_api`
// resolver would join json from a remote API into your query response
Resolvers []ResolverConfig
// Tables contains all table specific configuration such as aliased tables
// creating relationships between tables, etc
Tables []Table
// RolesQuery if set enabled attribute based access control. This query
// is used to fetch the user attribute that then dynamically define the users
// role
RolesQuery string `mapstructure:"roles_query"`
// Roles contains all the configuration for all the roles you want to support
// `user` and `anon` are two default roles. User role is for when a user ID is
// available and Anon when it's not
//
// If you're using the RolesQuery config to enable atribute based acess control then
// you can add more custom roles
Roles []Role
// Inflections is to add additionally singular to plural mappings
// to the engine (eg. sheep: sheep)
Inflections []string `mapstructure:"inflections"`
// Disable inflections. Inflections are deprecated and will be
// removed in next major version
EnableInflection bool `mapstructure:"enable_inflection"`
// Customize singular suffix
// By default is set to "ByID"
SingularSuffix string `mapstructure:"singular_suffix"`
// Database type name Defaults to 'postgres' (options: mysql, postgres)
DBType string `mapstructure:"db_type"`
// Log warnings and other debug information
Debug bool
// SubsPollDuration is the database polling duration (in seconds)
// used by subscriptions to query for updates.
// Default set to 5 seconds
SubsPollDuration time.Duration `mapstructure:"subs_poll_duration"`
// DefaultLimit sets the default max limit (number of rows) when a
// limit is not defined in the query or the table role config
// Default set to 20
DefaultLimit int `mapstructure:"default_limit"`
// DisableAgg disables all aggregation functions like count, sum, etc
DisableAgg bool `mapstructure:"disable_agg_functions"`
// DisableFuncs disables all functions like count, length, etc
DisableFuncs bool `mapstructure:"disable_functions"`
// EnableCamelcase enables autp camel case terms in GraphQL to snake case in SQL
EnableCamelcase bool `mapstructure:"enable_camelcase"`
// Enable production mode. This defaults to true if GO_ENV is set to
// "production". When true the allow list is enforced
Production bool
// DBSchemaPollDuration sets the duration for polling the database
// schema to detect changes to it. GraphJin is reinitialized when a
// change is detected
DBSchemaPollDuration time.Duration `mapstructure:"db_schema_poll_duration"`
rtmap map[string]refunc
tmap map[string]qcode.TConfig
}
// Table struct defines a database table
type Table struct {
Name string
Schema string
Table string
Type string
Blocklist []string
Columns []Column
OrderBy map[string][]string `mapstructure:"order_by"`
}
// Column struct defines a database column
type Column struct {
ID int32
Name string
Type string
Primary bool
Array bool
ForeignKey string `mapstructure:"related_to"`
}
// Role struct contains role specific access control values for for all database tables
type Role struct {
Name string
Match string
Tables []RoleTable
tm map[string]*RoleTable
}
// RoleTable struct contains role specific access control values for a database table
type RoleTable struct {
Name string
Schema string
ReadOnly bool `mapstructure:"read_only"`
Query *Query
Insert *Insert
Update *Update
Upsert *Upsert
Delete *Delete
}
// Query struct contains access control values for query operations
type Query struct {
Limit int
Filters []string
Columns []string
DisableFunctions bool `mapstructure:"disable_functions"`
Block bool
}
// Insert struct contains access control values for insert operations
type Insert struct {
Filters []string
Columns []string
Presets map[string]string
Block bool
}
// Insert struct contains access control values for update operations
type Update struct {
Filters []string
Columns []string
Presets map[string]string
Block bool
}
type Upsert struct {
Filters []string
Columns []string
Presets map[string]string
Block bool
}
// Delete struct contains access control values for delete operations
type Delete struct {
Filters []string
Columns []string
Block bool
}
// Resolver interface is used to create custom resolvers
// Custom resolvers must return a JSON value to be merged into
// the response JSON.
//
// Example Redis Resolver:
/*
type Redis struct {
Addr string
client redis.Client
}
func newRedis(v map[string]interface{}) (*Redis, error) {
re := &Redis{}
if err := mapstructure.Decode(v, re); err != nil {
return nil, err
}
re.client := redis.NewClient(&redis.Options{
Addr: re.Addr,
Password: "", // no password set
DB: 0, // use default DB
})
return re, nil
}
func (r *remoteAPI) Resolve(req ResolverReq) ([]byte, error) {
val, err := rdb.Get(ctx, req.ID).Result()
if err != nil {
return err
}
return val, nil
}
func main() {
conf := core.Config{
Resolvers: []Resolver{
Name: "cached_profile",
Type: "redis",
Table: "users",
Column: "id",
Props: []ResolverProps{
"addr": "localhost:6379",
},
},
}
gj.conf.SetResolver("redis", func(v ResolverProps) (Resolver, error) {
return newRedis(v)
})
gj, err := core.NewGraphJin(conf, db)
if err != nil {
log.Fatal(err)
}
}
*/
type Resolver interface {
Resolve(context.Context, ResolverReq) ([]byte, error)
}
// ResolverProps is a map of properties from the resolver config to be passed
// to the customer resolver's builder (new) function
type ResolverProps map[string]interface{}
// ResolverConfig struct defines a custom resolver
type ResolverConfig struct {
Name string
Type string
Schema string
Table string
Column string
StripPath string `mapstructure:"strip_path"`
Props ResolverProps `mapstructure:",remain"`
}
type ResolverReq struct {
ID string
Sel *qcode.Select
Log *log.Logger
*ReqConfig
}
// AddRoleTable function is a helper function to make it easy to add per-table
// row-level config
func (c *Config) AddRoleTable(role, table string, conf interface{}) error {
var r *Role
for i := range c.Roles {
if strings.EqualFold(c.Roles[i].Name, role) {
r = &c.Roles[i]
break
}
}
if r == nil {
nr := Role{Name: role}
c.Roles = append(c.Roles, nr)
r = &c.Roles[len(c.Roles)-1]
}
var schema string
if v := strings.SplitN(table, ".", 2); len(v) == 2 {
schema = v[0]
table = v[1]
}
var t *RoleTable
for i := range r.Tables {
if strings.EqualFold(r.Tables[i].Name, table) &&
strings.EqualFold(r.Tables[i].Schema, schema) {
t = &r.Tables[i]
break
}
}
if t == nil {
nt := RoleTable{Name: table, Schema: schema}
r.Tables = append(r.Tables, nt)
t = &r.Tables[len(r.Tables)-1]
}
switch v := conf.(type) {
case Query:
t.Query = &v
case Insert:
t.Insert = &v
case Update:
t.Update = &v
case Upsert:
t.Upsert = &v
case Delete:
t.Delete = &v
default:
return fmt.Errorf("unsupported object type: %t", v)
}
return nil
}
func (c *Config) RemoveRoleTable(role, table string) error {
ri := -1
for i := range c.Roles {
if strings.EqualFold(c.Roles[i].Name, role) {
ri = i
break
}
}
if ri == -1 {
return fmt.Errorf("role not found: %s", role)
}
tables := c.Roles[ri].Tables
ti := -1
var schema string
if v := strings.SplitN(table, ".", 2); len(v) == 2 {
schema = v[0]
table = v[1]
}
for i, t := range tables {
if strings.EqualFold(t.Name, table) &&
strings.EqualFold(t.Schema, schema) {
ti = i
break
}
}
if ti == -1 {
return fmt.Errorf("table not found: %s", table)
}
c.Roles[ri].Tables = append(tables[:ti], tables[ti+1:]...)
if len(c.Roles[ri].Tables) == 0 {
c.Roles = append(c.Roles[:ri], c.Roles[ri+1:]...)
}
return nil
}
func (c *Config) SetResolver(name string, fn refunc) error {
if c.rtmap == nil {
c.rtmap = make(map[string]refunc)
}
if _, ok := c.rtmap[name]; ok {
return fmt.Errorf("resolver defined: %s", name)
}
c.rtmap[name] = fn
return nil
}
// ReadInConfig reads in the config file for the environment specified in the GO_ENV
// environment variable. This is the best way to create a new GraphJin config.
func ReadInConfig(configFile string) (*Config, error) {
return readInConfig(configFile, nil)
}
// ReadInConfigFS is the same as ReadInConfig but it also takes a filesytem as an argument
func ReadInConfigFS(configFile string, fs afero.Fs) (*Config, error) {
return readInConfig(configFile, fs)
}
func readInConfig(configFile string, fs afero.Fs) (*Config, error) {
cp := filepath.Dir(configFile)
vi := newViper(cp, filepath.Base(configFile))
if fs != nil {
vi.SetFs(fs)
}
if err := vi.ReadInConfig(); err != nil {
return nil, err
}
if pcf := vi.GetString("inherits"); pcf != "" {
cf := vi.ConfigFileUsed()
vi = newViper(cp, pcf)
if fs != nil {
vi.SetFs(fs)
}
if err := vi.ReadInConfig(); err != nil {
return nil, err
}
if v := vi.GetString("inherits"); v != "" {
return nil, fmt.Errorf("inherited config (%s) cannot itself inherit (%s)", pcf, v)
}
vi.SetConfigFile(cf)
if err := vi.MergeInConfig(); err != nil {
return nil, err
}
}
for _, e := range os.Environ() {
if strings.HasPrefix(e, "GJ_") || strings.HasPrefix(e, "SJ_") {
kv := strings.SplitN(e, "=", 2)
util.SetKeyValue(vi, kv[0], kv[1])
}
}
c := &Config{
ConfigPath: filepath.Dir(vi.ConfigFileUsed()),
}
if err := vi.Unmarshal(&c); err != nil {
return nil, fmt.Errorf("failed to decode config, %v", err)
}
return c, nil
}
func newViper(configPath, configFile string) *viper.Viper {
vi := viper.New()
if filepath.Ext(configFile) != "" {
vi.SetConfigFile(filepath.Join(configPath, configFile))
} else {
vi.SetConfigName(configFile)
vi.AddConfigPath(configPath)
vi.AddConfigPath("./config")
}
return vi
}
func GetConfigName() string {
ge := strings.TrimSpace(strings.ToLower(os.Getenv("GO_ENV")))
switch ge {
case "production", "prod":
return "prod"
case "staging", "stage":
return "stage"
case "testing", "test":
return "test"
case "development", "dev", "":
return "dev"
default:
return ge
}
}