forked from SkygearIO/skygear-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
recordutil.go
663 lines (566 loc) · 16.7 KB
/
recordutil.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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
package handler
import (
"context"
"fmt"
"reflect"
"time"
"github.com/Sirupsen/logrus"
"github.com/skygeario/skygear-server/pkg/server/asset"
"github.com/skygeario/skygear-server/pkg/server/plugin/hook"
"github.com/skygeario/skygear-server/pkg/server/skydb"
"github.com/skygeario/skygear-server/pkg/server/skyerr"
)
func injectSigner(record *skydb.Record, store asset.Store) {
for _, value := range record.Data {
switch v := value.(type) {
case *skydb.Asset:
if signer, ok := store.(asset.URLSigner); ok {
v.Signer = signer
} else {
log.Warnf("Failed to acquire asset URLSigner, please check configuration")
}
}
}
}
type recordModifyFunc func(*recordModifyRequest, *recordModifyResponse) skyerr.Error
func atomicModifyFunc(req *recordModifyRequest, resp *recordModifyResponse, mFunc recordModifyFunc) recordModifyFunc {
return func(req *recordModifyRequest, resp *recordModifyResponse) (err skyerr.Error) {
txDB, ok := req.Db.(skydb.TxDatabase)
if !ok {
err = skyerr.NewError(skyerr.NotSupported, "database impl does not support transaction")
return
}
txErr := withTransaction(txDB, func() error {
return mFunc(req, resp)
})
if len(resp.ErrMap) > 0 {
info := map[string]interface{}{}
for recordID, err := range resp.ErrMap {
info[recordID.String()] = err
}
return skyerr.NewErrorWithInfo(skyerr.AtomicOperationFailure,
"Atomic Operation rolled back due to one or more errors",
info)
} else if txErr != nil {
err = skyerr.NewErrorWithInfo(skyerr.AtomicOperationFailure,
"Atomic Operation rolled back due to an error",
map[string]interface{}{"innerError": txErr})
}
return
}
}
func withTransaction(txDB skydb.TxDatabase, do func() error) (err error) {
err = txDB.Begin()
if err != nil {
return
}
err = do()
if err != nil {
if rbErr := txDB.Rollback(); rbErr != nil {
log.Errorf("Failed to rollback: %v", rbErr)
}
} else {
err = txDB.Commit()
}
return
}
type recordModifyRequest struct {
Db skydb.Database
Conn skydb.Conn
AssetStore asset.Store
HookRegistry *hook.Registry
Atomic bool
WithMasterKey bool
Context context.Context
UserInfo *skydb.UserInfo
// Save only
RecordsToSave []*skydb.Record
// Delete Only
RecordIDsToDelete []skydb.RecordID
}
type recordModifyResponse struct {
ErrMap map[skydb.RecordID]skyerr.Error
SchemaUpdated bool
SavedRecords []*skydb.Record
DeletedRecordIDs []skydb.RecordID
}
type recordFetcher struct {
db skydb.Database
conn skydb.Conn
withMasterKey bool
creationAccessCacheMap map[string]skydb.RecordACL
}
func newRecordFetcher(db skydb.Database, conn skydb.Conn, withMasterKey bool) recordFetcher {
return recordFetcher{
db: db,
conn: conn,
withMasterKey: withMasterKey,
creationAccessCacheMap: map[string]skydb.RecordACL{},
}
}
func (f recordFetcher) getCreationAccess(recordType string) skydb.RecordACL {
creationAccess, creationAccessCached := f.creationAccessCacheMap[recordType]
if creationAccessCached == false {
var err error
creationAccess, err = f.conn.GetRecordAccess(recordType)
if err == nil && creationAccess != nil {
f.creationAccessCacheMap[recordType] = creationAccess
}
}
return creationAccess
}
func (f recordFetcher) fetchOrCreateRecord(recordID skydb.RecordID, userInfo *skydb.UserInfo) (record *skydb.Record, err skyerr.Error) {
dbRecord := skydb.Record{}
if dbErr := f.db.Get(recordID, &dbRecord); dbErr != nil {
if dbErr == skydb.ErrRecordNotFound {
// new record
if f.withMasterKey {
return
}
creationAccess := f.getCreationAccess(recordID.Type)
if !creationAccess.Accessible(userInfo, skydb.CreateLevel) {
err = skyerr.NewError(
skyerr.PermissionDenied,
"no permission to create",
)
}
return
}
return nil, skyerr.MakeError(dbErr)
}
record = &dbRecord
if !f.withMasterKey && !dbRecord.Accessible(userInfo, skydb.WriteLevel) {
err = skyerr.NewError(
skyerr.PermissionDenied,
"no permission to modify",
)
}
return
}
func removeRecordFieldTypeHints(r *skydb.Record) {
for k, v := range r.Data {
switch v.(type) {
case skydb.Sequence:
delete(r.Data, k)
case skydb.Unknown:
delete(r.Data, k)
}
}
}
// recordSaveHandler iterate the record to perform the following:
// 1. Query the db for original record
// 2. Execute before save hooks with original record and new record
// 3. Clean up some transport only data (sequence for example) away from record
// 4. Populate meta data and save the record (like updated_at/by)
// 5. Execute after save hooks with original record and new record
func recordSaveHandler(req *recordModifyRequest, resp *recordModifyResponse) skyerr.Error {
db := req.Db
records := req.RecordsToSave
fetcher := newRecordFetcher(db, req.Conn, req.WithMasterKey)
// fetch records
originalRecordMap := map[skydb.RecordID]*skydb.Record{}
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
dbRecord, err := fetcher.fetchOrCreateRecord(record.ID, req.UserInfo)
if dbRecord == nil || err != nil {
return err
}
var origRecord skydb.Record
copyRecord(&origRecord, dbRecord)
injectSigner(&origRecord, req.AssetStore)
originalRecordMap[origRecord.ID] = &origRecord
mergeRecord(dbRecord, record)
*record = *dbRecord
return
})
// execute before save hooks
if req.HookRegistry != nil {
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
originalRecord, ok := originalRecordMap[record.ID]
// FIXME: Hot-fix for issues #528
// Defaults for record attributes should be provided
// before executing hooks
if !ok {
record.OwnerID = req.UserInfo.ID
}
err = req.HookRegistry.ExecuteHooks(req.Context, hook.BeforeSave, record, originalRecord)
return
})
}
// derive and extend record schema
schemaExtended, err := extendRecordSchema(db, records)
if err != nil {
log.WithField("err", err).Errorln("failed to migrate record schema")
if myerr, ok := err.(skyerr.Error); ok {
return myerr
}
return skyerr.NewError(skyerr.IncompatibleSchema, "failed to migrate record schema")
}
// remove bogus field, they are only for schema change
for _, r := range records {
removeRecordFieldTypeHints(r)
}
// save records
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
now := timeNow()
var deltaRecord skydb.Record
originalRecord, ok := originalRecordMap[record.ID]
if !ok {
originalRecord = &skydb.Record{}
record.OwnerID = req.UserInfo.ID
record.CreatedAt = now
record.CreatorID = req.UserInfo.ID
}
record.UpdatedAt = now
record.UpdaterID = req.UserInfo.ID
deriveDeltaRecord(&deltaRecord, originalRecord, record)
if dbErr := db.Save(&deltaRecord); dbErr != nil {
err = skyerr.MakeError(dbErr)
}
injectSigner(&deltaRecord, req.AssetStore)
*record = deltaRecord
return
})
if req.Atomic && len(resp.ErrMap) > 0 {
return skyerr.NewError(skyerr.UnexpectedError, "atomic operation failed")
}
// execute after save hooks
if req.HookRegistry != nil {
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
originalRecord, _ := originalRecordMap[record.ID]
err = req.HookRegistry.ExecuteHooks(req.Context, hook.AfterSave, record, originalRecord)
if err != nil {
log.Errorf("Error occurred while executing hooks: %s", err)
}
return
})
}
resp.SavedRecords = records
resp.SchemaUpdated = schemaExtended
return nil
}
type recordFunc func(*skydb.Record) skyerr.Error
func executeRecordFunc(recordsIn []*skydb.Record, errMap map[skydb.RecordID]skyerr.Error, rFunc recordFunc) (recordsOut []*skydb.Record) {
for _, record := range recordsIn {
if err := rFunc(record); err != nil {
errMap[record.ID] = err
} else {
recordsOut = append(recordsOut, record)
}
}
return
}
func copyRecord(dst, src *skydb.Record) {
*dst = *src
dst.Data = map[string]interface{}{}
for key, value := range src.Data {
dst.Data[key] = value
}
}
func mergeRecord(dst, src *skydb.Record) {
dst.ID = src.ID
dst.ACL = src.ACL
if src.DatabaseID != "" {
dst.DatabaseID = src.DatabaseID
}
if dst.Data == nil {
dst.Data = map[string]interface{}{}
}
for key, value := range src.Data {
dst.Data[key] = value
}
}
// Derive fields in delta which is either new or different from base, and
// write them in dst.
//
// It is the caller's reponsibility to ensure that base and delta identify
// the same record
func deriveDeltaRecord(dst, base, delta *skydb.Record) {
dst.ID = delta.ID
if delta.ACL != nil {
dst.ACL = delta.ACL
} else {
dst.ACL = base.ACL
}
dst.OwnerID = delta.OwnerID
dst.CreatedAt = delta.CreatedAt
dst.CreatorID = delta.CreatorID
dst.UpdatedAt = delta.UpdatedAt
dst.UpdaterID = delta.UpdaterID
dst.Data = map[string]interface{}{}
for key, value := range delta.Data {
if baseValue, ok := base.Data[key]; ok {
// TODO(limouren): might want comparison that performs better
if !reflect.DeepEqual(value, baseValue) {
dst.Data[key] = value
}
} else {
dst.Data[key] = value
}
}
}
func extendRecordSchema(db skydb.Database, records []*skydb.Record) (bool, error) {
recordSchemaMergerMap := map[string]schemaMerger{}
for _, record := range records {
recordType := record.ID.Type
merger, ok := recordSchemaMergerMap[recordType]
if !ok {
merger = newSchemaMerger()
}
merger.Extend(deriveRecordSchema(record.Data))
// The map hold the value of Schema Merger. After we have
// updated the Schema Merger, we have to copy the value
// of Schema Merger back to the map.
recordSchemaMergerMap[recordType] = merger
}
extended := false
for recordType, merger := range recordSchemaMergerMap {
schema, err := merger.Schema()
if err != nil {
return false, err
}
schemaExtended, err := db.Extend(recordType, schema)
if err != nil {
return false, err
}
if schemaExtended {
log.
WithField("type", recordType).
WithField("schema", schema).
Info("Schema Extended")
extended = true
}
}
return extended, nil
}
func recordDeleteHandler(req *recordModifyRequest, resp *recordModifyResponse) skyerr.Error {
db := req.Db
recordIDs := req.RecordIDsToDelete
var records []*skydb.Record
for _, recordID := range recordIDs {
if recordID.Type == db.UserRecordType() {
resp.ErrMap[recordID] = skyerr.NewError(skyerr.PermissionDenied, "cannot delete user record")
continue
}
var record skydb.Record
if dbErr := db.Get(recordID, &record); dbErr != nil {
if dbErr == skydb.ErrRecordNotFound {
resp.ErrMap[recordID] = skyerr.NewError(skyerr.ResourceNotFound, "record not found")
} else {
resp.ErrMap[recordID] = skyerr.MakeError(dbErr)
}
} else {
if req.WithMasterKey || record.Accessible(req.UserInfo, skydb.WriteLevel) {
records = append(records, &record)
} else {
resp.ErrMap[recordID] = skyerr.NewError(
skyerr.PermissionDenied,
"no permission to delete",
)
}
}
}
if req.HookRegistry != nil {
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
err = req.HookRegistry.ExecuteHooks(req.Context, hook.BeforeDelete, record, nil)
return
})
}
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
if dbErr := db.Delete(record.ID); dbErr != nil {
return skyerr.MakeError(dbErr)
}
return nil
})
if req.Atomic && len(resp.ErrMap) > 0 {
return skyerr.NewError(skyerr.UnexpectedError, "atomic operation failed")
}
if req.HookRegistry != nil {
records = executeRecordFunc(records, resp.ErrMap, func(record *skydb.Record) (err skyerr.Error) {
err = req.HookRegistry.ExecuteHooks(req.Context, hook.AfterDelete, record, nil)
if err != nil {
log.Errorf("Error occurred while executing hooks: %s", err)
}
return
})
}
for _, record := range records {
resp.DeletedRecordIDs = append(resp.DeletedRecordIDs, record.ID)
}
return nil
}
type schemaMerger struct {
finalSchema skydb.RecordSchema
err error
}
func newSchemaMerger() schemaMerger {
return schemaMerger{finalSchema: skydb.RecordSchema{}}
}
func (m *schemaMerger) Extend(schema skydb.RecordSchema) {
if m.err != nil {
return
}
for key, dataType := range schema {
if originalType, ok := m.finalSchema[key]; ok {
if originalType != dataType {
m.err = fmt.Errorf("type conflict on column = %s, %s -> %s", key, originalType, dataType)
return
}
}
m.finalSchema[key] = dataType
}
}
func (m schemaMerger) Schema() (skydb.RecordSchema, error) {
return m.finalSchema, m.err
}
func deriveRecordSchema(m skydb.Data) skydb.RecordSchema {
schema := skydb.RecordSchema{}
log.Debugf("%v", m)
for key, value := range m {
switch val := value.(type) {
default:
log.WithFields(logrus.Fields{
"key": key,
"value": value,
}).Panicf("got unrecgonized type = %T", value)
case nil:
// do nothing
case int64:
schema[key] = skydb.FieldType{
Type: skydb.TypeInteger,
}
case float64:
schema[key] = skydb.FieldType{
Type: skydb.TypeNumber,
}
case string:
schema[key] = skydb.FieldType{
Type: skydb.TypeString,
}
case time.Time:
schema[key] = skydb.FieldType{
Type: skydb.TypeDateTime,
}
case bool:
schema[key] = skydb.FieldType{
Type: skydb.TypeBoolean,
}
case *skydb.Asset:
schema[key] = skydb.FieldType{
Type: skydb.TypeAsset,
}
case skydb.Reference:
v := value.(skydb.Reference)
schema[key] = skydb.FieldType{
Type: skydb.TypeReference,
ReferenceType: v.Type(),
}
case skydb.Location:
schema[key] = skydb.FieldType{
Type: skydb.TypeLocation,
}
case skydb.Sequence:
schema[key] = skydb.FieldType{
Type: skydb.TypeSequence,
}
case skydb.Unknown:
schema[key] = skydb.FieldType{
Type: skydb.TypeUnknown,
UnderlyingType: val.UnderlyingType,
}
case map[string]interface{}, []interface{}:
schema[key] = skydb.FieldType{
Type: skydb.TypeJSON,
}
}
}
return schema
}
func eagerIDs(db skydb.Database, records []skydb.Record, query skydb.Query) map[string][]skydb.RecordID {
eagers := map[string][]skydb.RecordID{}
for _, transientExpression := range query.ComputedKeys {
if transientExpression.Type != skydb.KeyPath {
continue
}
keyPath := transientExpression.Value.(string)
eagers[keyPath] = make([]skydb.RecordID, len(records))
}
for i, record := range records {
for keyPath := range eagers {
ref := getReferenceWithKeyPath(db, &record, keyPath)
if ref.IsEmpty() {
continue
}
eagers[keyPath][i] = ref.ID
}
}
return eagers
}
// getReferenceWithKeyPath returns a reference for use in eager loading
// It handles the case where reserved attribute is a string ID instead of
// a referenced ID.
func getReferenceWithKeyPath(db skydb.Database, record *skydb.Record, keyPath string) skydb.Reference {
valueAtKeyPath := record.Get(keyPath)
if valueAtKeyPath == nil {
return skydb.NewEmptyReference()
}
if ref, ok := valueAtKeyPath.(skydb.Reference); ok {
return ref
}
// If the value at key path is not a reference, it could be a string
// ID of a user record.
switch keyPath {
case "_owner_id", "_created_by", "_updated_by":
strID, ok := valueAtKeyPath.(string)
if !ok {
return skydb.NewEmptyReference()
}
return skydb.NewReference(db.UserRecordType(), strID)
default:
return skydb.NewEmptyReference()
}
}
func doQueryEager(db skydb.Database, eagersIDs map[string][]skydb.RecordID) map[string]map[string]*skydb.Record {
eagerRecords := map[string]map[string]*skydb.Record{}
for keyPath, ids := range eagersIDs {
log.Debugf("Getting value for keypath %v", keyPath)
eagerScanner, err := db.GetByIDs(ids)
if err != nil {
log.Debugf("No Records found in the eager load key path: %s", keyPath)
eagerRecords[keyPath] = map[string]*skydb.Record{}
continue
}
for eagerScanner.Scan() {
er := eagerScanner.Record()
if eagerRecords[keyPath] == nil {
eagerRecords[keyPath] = map[string]*skydb.Record{}
}
eagerRecords[keyPath][er.ID.Key] = &er
}
eagerScanner.Close()
}
return eagerRecords
}
func getRecordCount(db skydb.Database, query *skydb.Query, results *skydb.Rows) (uint64, error) {
if results != nil {
recordCount := results.OverallRecordCount()
if recordCount != nil {
return *recordCount, nil
}
}
recordCount, err := db.QueryCount(query)
if err != nil {
return 0, err
}
return recordCount, nil
}
func queryResultInfo(db skydb.Database, query *skydb.Query, results *skydb.Rows) (map[string]interface{}, error) {
resultInfo := map[string]interface{}{}
if query.GetCount {
recordCount, err := getRecordCount(db, query, results)
if err != nil {
return nil, err
}
resultInfo["count"] = recordCount
}
return resultInfo, nil
}