-
-
Notifications
You must be signed in to change notification settings - Fork 242
/
preload_associations.go
546 lines (475 loc) · 15.5 KB
/
preload_associations.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
package pop
import (
"fmt"
"reflect"
"regexp"
"strings"
"github.com/gobuffalo/flect"
"github.com/gobuffalo/pop/v6/internal/defaults"
"github.com/gobuffalo/pop/v6/logging"
"github.com/jmoiron/sqlx"
"github.com/jmoiron/sqlx/reflectx"
)
var validFieldRegexp = regexp.MustCompile(`^(([a-zA-Z0-9]*)(\.[a-zA-Z0-9]+)?)+$`)
// NewModelMetaInfo creates the meta info details for the model passed
// as a parameter.
func NewModelMetaInfo(model *Model) *ModelMetaInfo {
mmi := &ModelMetaInfo{}
mmi.Model = model
mmi.init()
return mmi
}
// NewAssociationMetaInfo creates the meta info details for the passed association.
func NewAssociationMetaInfo(fi *reflectx.FieldInfo) *AssociationMetaInfo {
ami := &AssociationMetaInfo{}
ami.FieldInfo = fi
ami.init()
return ami
}
// ModelMetaInfo a type to abstract all fields information regarding
// to a model. A model is representation of a table in the
// database.
type ModelMetaInfo struct {
*reflectx.StructMap
Model *Model
mapper *reflectx.Mapper
nestedFields map[string][]string
}
func (mmi *ModelMetaInfo) init() {
m := reflectx.NewMapper("")
mmi.mapper = m
t := reflectx.Deref(reflect.TypeOf(mmi.Model.Value))
if t.Kind() == reflect.Slice || t.Kind() == reflect.Array {
t = reflectx.Deref(t.Elem())
}
mmi.StructMap = m.TypeMap(t)
mmi.nestedFields = make(map[string][]string)
}
func (mmi *ModelMetaInfo) iterate(fn func(reflect.Value)) {
modelValue := reflect.Indirect(reflect.ValueOf(mmi.Model.Value))
if modelValue.Kind() == reflect.Slice || modelValue.Kind() == reflect.Array {
for i := 0; i < modelValue.Len(); i++ {
fn(modelValue.Index(i))
}
return
}
fn(modelValue)
}
func (mmi *ModelMetaInfo) getDBFieldTaggedWith(value string) *reflectx.FieldInfo {
for _, fi := range mmi.Index {
if fi.Field.Tag.Get("db") == value {
if len(fi.Children) > 0 {
return fi.Children[0]
}
return fi
}
}
return nil
}
func (mmi *ModelMetaInfo) preloadFields(fields ...string) ([]*reflectx.FieldInfo, error) {
if len(fields) == 0 {
return mmi.Index, nil
}
var preloadFields []*reflectx.FieldInfo
for _, f := range fields {
if !validFieldRegexp.MatchString(f) {
return preloadFields, fmt.Errorf("association field '%s' does not match the format %s", f, "'<field>' or '<field>.<nested-field>'")
}
if strings.Contains(f, ".") {
fname := f[:strings.Index(f, ".")]
mmi.nestedFields[fname] = append(mmi.nestedFields[fname], f[strings.Index(f, ".")+1:])
f = f[:strings.Index(f, ".")]
}
preloadField := mmi.GetByPath(f)
if preloadField == nil {
return preloadFields, fmt.Errorf("field %s does not exist in model %s", f, mmi.Model.TableName())
}
var exist bool
for _, pf := range preloadFields {
if pf.Path == preloadField.Path {
exist = true
}
}
if !exist {
preloadFields = append(preloadFields, preloadField)
}
}
return preloadFields, nil
}
// AssociationMetaInfo a type to abstract all field information
// regarding to an association. An association is a field
// that has defined a tag like 'has_many', 'belongs_to',
// 'many_to_many' and 'has_one'.
type AssociationMetaInfo struct {
*reflectx.FieldInfo
*reflectx.StructMap
}
func (ami *AssociationMetaInfo) init() {
mapper := reflectx.NewMapper("")
t := reflectx.Deref(ami.FieldInfo.Field.Type)
if t.Kind() == reflect.Slice || t.Kind() == reflect.Array {
t = reflectx.Deref(t.Elem())
}
ami.StructMap = mapper.TypeMap(t)
}
func (ami *AssociationMetaInfo) toSlice() reflect.Value {
ft := reflectx.Deref(ami.Field.Type)
var vt reflect.Value
if ft.Kind() == reflect.Slice || ft.Kind() == reflect.Array {
vt = reflect.New(ft)
} else {
vt = reflect.New(reflect.SliceOf(ft))
}
return vt
}
func (ami *AssociationMetaInfo) getDBFieldTaggedWith(value string) *reflectx.FieldInfo {
for _, fi := range ami.StructMap.Index {
if fi.Field.Tag.Get("db") == value {
if len(fi.Children) > 0 {
return fi.Children[0]
}
return fi
}
}
return nil
}
func (ami *AssociationMetaInfo) fkName() string {
t := ami.Field.Type
if t.Kind() == reflect.Slice || t.Kind() == reflect.Array {
t = reflectx.Deref(t.Elem())
}
fkName := fmt.Sprintf("%s%s", flect.Underscore(flect.Singularize(t.Name())), "_id")
fkNameTag := flect.Underscore(ami.Field.Tag.Get("fk_id"))
return defaults.String(fkNameTag, fkName)
}
// preload is the query mode used to load associations from database
// similar to the active record default approach on Rails.
func preload(tx *Connection, model interface{}, fields ...string) error {
mmi := NewModelMetaInfo(NewModel(model, tx.Context()))
preloadFields, err := mmi.preloadFields(fields...)
if err != nil {
return err
}
var associations []*AssociationMetaInfo
for _, fieldInfo := range preloadFields {
if isFieldAssociation(fieldInfo.Field) && fieldInfo.Parent.Name == "" {
associations = append(associations, NewAssociationMetaInfo(fieldInfo))
}
}
for _, asoc := range associations {
if asoc.Field.Tag.Get("has_many") != "" {
err := preloadHasMany(tx, asoc, mmi)
if err != nil {
return err
}
}
if asoc.Field.Tag.Get("has_one") != "" {
err := preloadHasOne(tx, asoc, mmi)
if err != nil {
return err
}
}
if asoc.Field.Tag.Get("belongs_to") != "" {
err := preloadBelongsTo(tx, asoc, mmi)
if err != nil {
return err
}
}
if asoc.Field.Tag.Get("many_to_many") != "" {
err := preloadManyToMany(tx, asoc, mmi)
if err != nil {
return err
}
}
}
return nil
}
func isFieldAssociation(field reflect.StructField) bool {
for _, associationLabel := range []string{"has_many", "has_one", "belongs_to", "many_to_many"} {
if field.Tag.Get(associationLabel) != "" {
return true
}
}
return false
}
func preloadHasMany(tx *Connection, asoc *AssociationMetaInfo, mmi *ModelMetaInfo) error {
// 1) get all associations ids.
// 1.1) In here I pick ids from model meta info directly.
ids := []interface{}{}
mmi.Model.iterate(func(m *Model) error {
ids = append(ids, m.ID())
return nil
})
if len(ids) == 0 {
return nil
}
// 2) load all associations constraint by model ids.
fk := asoc.Field.Tag.Get("fk_id")
if fk == "" {
fk = mmi.Model.associationName()
}
q := tx.Q()
q.eager = false
q.eagerFields = []string{}
slice := asoc.toSlice()
if strings.TrimSpace(asoc.Field.Tag.Get("order_by")) != "" {
q.Order(asoc.Field.Tag.Get("order_by"))
}
err := q.Where(fmt.Sprintf("%s in (?)", fk), ids).All(slice.Interface())
if err != nil {
return err
}
// 2.1) load all nested associations from this assoc.
if asocNestedFields, ok := mmi.nestedFields[asoc.Path]; ok {
for _, asocNestedField := range asocNestedFields {
if err := preload(tx, slice.Interface(), asocNestedField); err != nil {
return err
}
}
}
// 3) iterate over every model and fill it with the assoc.
foreignField := asoc.getDBFieldTaggedWith(fk)
mmi.iterate(func(mvalue reflect.Value) {
for i := 0; i < slice.Elem().Len(); i++ {
asocValue := slice.Elem().Index(i)
valueField := reflect.Indirect(mmi.mapper.FieldByName(asocValue, foreignField.Path))
if mmi.mapper.FieldByName(mvalue, "ID").Interface() == valueField.Interface() ||
reflect.DeepEqual(mmi.mapper.FieldByName(mvalue, "ID"), valueField) {
// IMPORTANT
//
// FieldByName will initialize the value. It is important that this happens AFTER
// we checked whether the field should be set. Otherwise, we'll set a zero value!
//
// This is most likely the reason for https://github.com/gobuffalo/pop/issues/139
modelAssociationField := mmi.mapper.FieldByName(mvalue, asoc.Name)
switch {
case modelAssociationField.Kind() == reflect.Slice || modelAssociationField.Kind() == reflect.Array:
modelAssociationField.Set(reflect.Append(modelAssociationField, asocValue))
case modelAssociationField.Kind() == reflect.Ptr:
modelAssociationField.Elem().Set(reflect.Append(modelAssociationField.Elem(), asocValue))
default:
modelAssociationField.Set(asocValue)
}
}
}
})
return nil
}
func preloadHasOne(tx *Connection, asoc *AssociationMetaInfo, mmi *ModelMetaInfo) error {
// 1) get all associations ids.
ids := []interface{}{}
mmi.Model.iterate(func(m *Model) error {
ids = append(ids, m.ID())
return nil
})
if len(ids) == 0 {
return nil
}
// 2) load all associations constraint by model ids.
fk := asoc.Field.Tag.Get("fk_id")
if fk == "" {
fk = mmi.Model.associationName()
}
q := tx.Q()
q.eager = false
q.eagerFields = []string{}
slice := asoc.toSlice()
err := q.Where(fmt.Sprintf("%s in (?)", fk), ids).All(slice.Interface())
if err != nil {
return err
}
// 2.1) load all nested associations from this assoc.
if asocNestedFields, ok := mmi.nestedFields[asoc.Path]; ok {
for _, asocNestedField := range asocNestedFields {
if err := preload(tx, slice.Interface(), asocNestedField); err != nil {
return err
}
}
}
// 3) iterate over every model and fill it with the assoc.
foreignField := asoc.getDBFieldTaggedWith(fk)
mmi.iterate(func(mvalue reflect.Value) {
for i := 0; i < slice.Elem().Len(); i++ {
asocValue := slice.Elem().Index(i)
if mmi.mapper.FieldByName(mvalue, "ID").Interface() == mmi.mapper.FieldByName(asocValue, foreignField.Path).Interface() ||
reflect.DeepEqual(mmi.mapper.FieldByName(mvalue, "ID"), mmi.mapper.FieldByName(asocValue, foreignField.Path)) {
// IMPORTANT
//
// FieldByName will initialize the value. It is important that this happens AFTER
// we checked whether the field should be set. Otherwise, we'll set a zero value!
//
// This is most likely the reason for https://github.com/gobuffalo/pop/issues/139
modelAssociationField := mmi.mapper.FieldByName(mvalue, asoc.Name)
switch {
case modelAssociationField.Kind() == reflect.Slice || modelAssociationField.Kind() == reflect.Array:
modelAssociationField.Set(reflect.Append(modelAssociationField, asocValue))
case modelAssociationField.Kind() == reflect.Ptr:
modelAssociationField.Elem().Set(asocValue)
default:
modelAssociationField.Set(asocValue)
}
}
}
})
return nil
}
func preloadBelongsTo(tx *Connection, asoc *AssociationMetaInfo, mmi *ModelMetaInfo) error {
// 1) get all associations ids.
fi := mmi.getDBFieldTaggedWith(asoc.fkName())
if fi == nil {
fi = mmi.getDBFieldTaggedWith(fmt.Sprintf("%s%s", flect.Underscore(asoc.Path), "_id"))
}
fkids := []interface{}{}
mmi.iterate(func(val reflect.Value) {
if !isFieldNilPtr(val, fi) {
fkids = append(fkids, mmi.mapper.FieldByName(val, fi.Path).Interface())
}
})
if len(fkids) == 0 {
return nil
}
// 2) load all associations constraint by association fields ids.
fk := "id"
q := tx.Q()
q.eager = false
q.eagerFields = []string{}
slice := asoc.toSlice()
err := q.Where(fmt.Sprintf("%s in (?)", fk), fkids).All(slice.Interface())
if err != nil {
return err
}
// 2.1) load all nested associations from this assoc.
if asocNestedFields, ok := mmi.nestedFields[asoc.Path]; ok {
for _, asocNestedField := range asocNestedFields {
if err := preload(tx, slice.Interface(), asocNestedField); err != nil {
return err
}
}
}
// 3) iterate over every model and fill it with the assoc.
mmi.iterate(func(mvalue reflect.Value) {
if isFieldNilPtr(mvalue, fi) {
return
}
for i := 0; i < slice.Elem().Len(); i++ {
asocValue := slice.Elem().Index(i)
fkField := reflect.Indirect(mmi.mapper.FieldByName(mvalue, fi.Path))
field := mmi.mapper.FieldByName(asocValue, "ID")
if fkField.Interface() == field.Interface() || reflect.DeepEqual(fkField, field) {
// IMPORTANT
//
// FieldByName will initialize the value. It is important that this happens AFTER
// we checked whether the field should be set. Otherwise, we'll set a zero value!
//
// This is most likely the reason for https://github.com/gobuffalo/pop/issues/139
modelAssociationField := mmi.mapper.FieldByName(mvalue, asoc.Name)
switch {
case modelAssociationField.Kind() == reflect.Slice || modelAssociationField.Kind() == reflect.Array:
modelAssociationField.Set(reflect.Append(modelAssociationField, asocValue))
case modelAssociationField.Kind() == reflect.Ptr:
modelAssociationField.Elem().Set(asocValue)
default:
modelAssociationField.Set(asocValue)
}
}
}
})
return nil
}
func preloadManyToMany(tx *Connection, asoc *AssociationMetaInfo, mmi *ModelMetaInfo) error {
// 1) get all associations ids.
// 1.1) In here I pick ids from model meta info directly.
ids := []interface{}{}
mmi.Model.iterate(func(m *Model) error {
ids = append(ids, m.ID())
return nil
})
if len(ids) == 0 {
return nil
}
// 2) load all associations.
// 2.1) In here I pick the label name from association.
manyToManyTableName := asoc.Field.Tag.Get("many_to_many")
modelAssociationName := mmi.Model.associationName()
assocFkName := asoc.fkName()
if strings.Contains(manyToManyTableName, ":") {
modelAssociationName = strings.TrimSpace(manyToManyTableName[strings.Index(manyToManyTableName, ":")+1:])
manyToManyTableName = strings.TrimSpace(manyToManyTableName[:strings.Index(manyToManyTableName, ":")])
}
sql := fmt.Sprintf("SELECT %s, %s FROM %s WHERE %s in (?)", modelAssociationName, assocFkName, manyToManyTableName, modelAssociationName)
sql, args, _ := sqlx.In(sql, ids)
sql = tx.Dialect.TranslateSQL(sql)
cn, err := tx.Store.Transaction()
if err != nil {
return err
}
txlog(logging.SQL, cn, sql, args...)
rows, err := cn.Queryx(sql, args...)
if err != nil {
return err
}
mapAssoc := map[string][]interface{}{}
fkids := []interface{}{}
for rows.Next() {
row, err := rows.SliceScan()
if err != nil {
return err
}
if len(row) > 0 {
if _, ok := row[0].([]uint8); ok { // -> it's UUID
row[0] = string(row[0].([]uint8))
}
if _, ok := row[1].([]uint8); ok { // -> it's UUID
row[1] = string(row[1].([]uint8))
}
key := fmt.Sprintf("%v", row[0])
mapAssoc[key] = append(mapAssoc[key], row[1])
fkids = append(fkids, row[1])
}
}
if err := rows.Err(); err != nil {
return err
}
q := tx.Q()
q.eager = false
q.eagerFields = []string{}
if strings.TrimSpace(asoc.Field.Tag.Get("order_by")) != "" {
q.Order(asoc.Field.Tag.Get("order_by"))
}
slice := asoc.toSlice()
q.Where("id in (?)", fkids).All(slice.Interface())
// 2.2) load all nested associations from this assoc.
if asocNestedFields, ok := mmi.nestedFields[asoc.Path]; ok {
for _, asocNestedField := range asocNestedFields {
if err := preload(tx, slice.Interface(), asocNestedField); err != nil {
return err
}
}
}
// 3) iterate over every model and fill it with the assoc.
mmi.iterate(func(mvalue reflect.Value) {
id := mmi.mapper.FieldByName(mvalue, "ID").Interface()
if assocFkIds, ok := mapAssoc[fmt.Sprintf("%v", id)]; ok {
for i := 0; i < slice.Elem().Len(); i++ {
asocValue := slice.Elem().Index(i)
for _, fkid := range assocFkIds {
if fmt.Sprintf("%v", fkid) == fmt.Sprintf("%v", mmi.mapper.FieldByName(asocValue, "ID").Interface()) {
// IMPORTANT
//
// FieldByName will initialize the value. It is important that this happens AFTER
// we checked whether the field should be set. Otherwise, we'll set a zero value!
//
// This is most likely the reason for https://github.com/gobuffalo/pop/issues/139
modelAssociationField := mmi.mapper.FieldByName(mvalue, asoc.Name)
modelAssociationField.Set(reflect.Append(modelAssociationField, asocValue))
}
}
}
}
})
return nil
}
func isFieldNilPtr(val reflect.Value, fi *reflectx.FieldInfo) bool {
fieldValue := reflectx.FieldByIndexesReadOnly(val, fi.Index)
return fieldValue.Kind() == reflect.Ptr && fieldValue.IsNil()
}