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
|
// Copyright 2019-present Facebook Inc. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.
package hooks
import (
"context"
"fmt"
"sort"
"testing"
"github.com/facebook/ent/entc/integration/hooks/ent"
"github.com/facebook/ent/entc/integration/hooks/ent/card"
"github.com/facebook/ent/entc/integration/hooks/ent/enttest"
"github.com/facebook/ent/entc/integration/hooks/ent/hook"
"github.com/facebook/ent/entc/integration/hooks/ent/migrate"
"github.com/facebook/ent/entc/integration/hooks/ent/user"
_ "github.com/mattn/go-sqlite3"
"github.com/stretchr/testify/require"
)
func TestSchemaHooks(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
_, err := client.Card.Create().SetNumber("123").Save(ctx)
require.EqualError(t, err, "card number is too short", "error is returned from hook")
crd := client.Card.Create().SetNumber("1234").SaveX(ctx)
require.Equal(t, "unknown", crd.Name, "name was set by hook")
client.Use(func(next ent.Mutator) ent.Mutator {
return hook.CardFunc(func(ctx context.Context, m *ent.CardMutation) (ent.Value, error) {
name, ok := m.Name()
require.True(t, !ok && name == "", "should be the first hook to execute")
return next.Mutate(ctx, m)
})
})
client.Card.Create().SetNumber("1234").SaveX(ctx)
_, err = client.Card.Update().Save(ctx)
require.EqualError(t, err, "OpUpdate operation is not allowed")
}
func TestRuntimeHooks(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithOptions(ent.Log(t.Log)), enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
var calls int
client.Use(func(next ent.Mutator) ent.Mutator {
return ent.MutateFunc(func(ctx context.Context, m ent.Mutation) (ent.Value, error) {
calls++
return next.Mutate(ctx, m)
})
})
client.Card.Create().SetNumber("1234").SaveX(ctx)
client.User.Create().SetName("a8m").SaveX(ctx)
require.Equal(t, 2, calls)
client = client.Debug()
client.Card.Create().SetNumber("1234").SaveX(ctx)
client.User.Create().SetName("a8m").SaveX(ctx)
require.Equal(t, 4, calls, "debug client should keep thr same hooks")
}
func TestRuntimeChain(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
defer client.Close()
var (
chain hook.Chain
values []int
)
for value := 0; value < 5; value++ {
chain = chain.Append(func(next ent.Mutator) ent.Mutator {
return ent.MutateFunc(func(ctx context.Context, m ent.Mutation) (ent.Value, error) {
values = append(values, value)
return next.Mutate(ctx, m)
})
})
}
client.User.Use(chain.Hook())
client.User.Create().SetName("alexsn").SaveX(ctx)
require.Len(t, values, 5)
require.True(t, sort.IntsAreSorted(values))
}
func TestMutationClient(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
client.Card.Use(func(next ent.Mutator) ent.Mutator {
return hook.CardFunc(func(ctx context.Context, m *ent.CardMutation) (ent.Value, error) {
id, _ := m.OwnerID()
usr := m.Client().User.GetX(ctx, id)
m.SetName(usr.Name)
return next.Mutate(ctx, m)
})
})
a8m := client.User.Create().SetName("a8m").SaveX(ctx)
crd := client.Card.Create().SetNumber("1234").SetOwner(a8m).SaveX(ctx)
require.Equal(t, a8m.Name, crd.Name)
}
func TestMutationTx(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
client.Card.Use(func(next ent.Mutator) ent.Mutator {
return hook.CardFunc(func(ctx context.Context, m *ent.CardMutation) (ent.Value, error) {
tx, err := m.Tx()
if err != nil {
return nil, err
}
if err := tx.Rollback(); err != nil {
return nil, err
}
return nil, fmt.Errorf("rolled back")
})
})
tx, err := client.Tx(ctx)
require.NoError(t, err)
a8m := tx.User.Create().SetName("a8m").SaveX(ctx)
crd, err := tx.Card.Create().SetNumber("1234").SetOwner(a8m).Save(ctx)
require.EqualError(t, err, "rolled back")
require.Nil(t, crd)
_, err = tx.Card.Query().All(ctx)
require.Error(t, err, "tx already rolled back")
}
func TestDeletion(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
client.User.Use(func(next ent.Mutator) ent.Mutator {
return hook.UserFunc(func(ctx context.Context, m *ent.UserMutation) (ent.Value, error) {
if !m.Op().Is(ent.OpDeleteOne) {
return next.Mutate(ctx, m)
}
id, ok := m.ID()
if !ok {
return nil, fmt.Errorf("missing id")
}
m.Client().Card.Delete().Where(card.HasOwnerWith(user.ID(id))).ExecX(ctx)
return next.Mutate(ctx, m)
})
})
a8m := client.User.Create().SetName("a8m").SaveX(ctx)
for i := 0; i < 5; i++ {
client.Card.Create().SetNumber(fmt.Sprintf("card-%d", i)).SetOwner(a8m).SaveX(ctx)
}
client.User.DeleteOne(a8m).ExecX(ctx)
require.Zero(t, client.User.Query().CountX(ctx))
require.Zero(t, client.Card.Query().CountX(ctx))
}
func TestOldValues(t *testing.T) {
ctx := context.Background()
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
// Querying old fields post mutation should fail.
client.Card.Use(hook.On(func(next ent.Mutator) ent.Mutator {
return hook.CardFunc(func(ctx context.Context, m *ent.CardMutation) (ent.Value, error) {
value, err := next.Mutate(ctx, m)
require.NoError(t, err)
_, err = m.OldNumber(ctx)
require.Error(t, err)
return value, nil
})
}, ent.OpUpdateOne))
crd := client.Card.Create().SetNumber("1234").SetName("a8m").SaveX(ctx)
client.Card.UpdateOneID(crd.ID).SetName("a8m").SaveX(ctx)
// A typed hook.
client.User.Use(hook.On(func(next ent.Mutator) ent.Mutator {
return hook.UserFunc(func(ctx context.Context, m *ent.UserMutation) (ent.Value, error) {
name, err := m.OldName(ctx)
if err != nil {
return nil, err
}
require.Equal(t, "a8m", name)
return next.Mutate(ctx, m)
})
}, ent.OpUpdateOne))
// A generic hook (executed on all types).
client.Use(hook.On(func(next ent.Mutator) ent.Mutator {
return ent.MutateFunc(func(ctx context.Context, m ent.Mutation) (ent.Value, error) {
namer, ok := m.(interface {
OldName(context.Context) (string, error)
})
if !ok {
// Skip if the mutation does not have
// a method for getting the old name.
return next.Mutate(ctx, m)
}
name, err := namer.OldName(ctx)
if err != nil {
return nil, err
}
require.Equal(t, "a8m", name)
value, err := next.Mutate(ctx, m)
if err != nil {
return nil, err
}
_, err = namer.OldName(ctx)
require.NoError(t, err)
return value, nil
})
}, ent.OpUpdateOne))
// A generic hook (executed on all types).
client.Use(hook.Unless(func(next ent.Mutator) ent.Mutator {
return ent.MutateFunc(func(ctx context.Context, m ent.Mutation) (ent.Value, error) {
namer, ok := m.(interface {
OldName(context.Context) (string, error)
})
if !ok {
// Skip if the mutation does not have
// a method for getting the old name.
return next.Mutate(ctx, m)
}
name, err := namer.OldName(ctx)
if err != nil {
return nil, err
}
require.Equal(t, "a8m", name)
value, err := next.Mutate(ctx, m)
if err != nil {
return nil, err
}
_, err = namer.OldName(ctx)
require.NoError(t, err)
return value, nil
})
}, ^ent.OpUpdateOne))
a8m := client.User.Create().SetName("a8m").SaveX(ctx)
require.Equal(t, "a8m", a8m.Name)
_, err := client.User.UpdateOne(a8m).SetName("Ariel").SetVersion(a8m.Version).Save(ctx)
require.EqualError(t, err, "version field must be incremented by 1")
a8m = client.User.UpdateOne(a8m).SetName("Ariel").SetVersion(a8m.Version + 1).SaveX(ctx)
require.Equal(t, "Ariel", a8m.Name)
}
func TestConditions(t *testing.T) {
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)))
defer client.Close()
var calls int
defer func() { require.Equal(t, 2, calls) }()
client.Card.Use(hook.If(func(next ent.Mutator) ent.Mutator {
return hook.CardFunc(func(ctx context.Context, m *ent.CardMutation) (ent.Value, error) {
require.True(t, m.Op().Is(ent.OpUpdateOne))
calls++
return next.Mutate(ctx, m)
})
}, hook.Or(
hook.HasFields(card.FieldName),
hook.HasClearedFields(card.FieldName),
)))
client.User.Use(hook.If(func(next ent.Mutator) ent.Mutator {
return hook.UserFunc(func(ctx context.Context, m *ent.UserMutation) (ent.Value, error) {
require.True(t, m.Op().Is(ent.OpUpdate))
incr, exists := m.AddedWorth()
require.True(t, exists)
require.EqualValues(t, 100, incr)
return next.Mutate(ctx, m)
})
}, hook.HasAddedFields(user.FieldWorth)))
ctx := context.Background()
crd := client.Card.Create().SetNumber("9876").SaveX(ctx)
crd = crd.Update().SetName("alexsn").SaveX(ctx)
crd = crd.Update().ClearName().SaveX(ctx)
client.Card.DeleteOne(crd).ExecX(ctx)
alexsn := client.User.Create().SetName("alexsn").SaveX(ctx)
client.User.Update().Where(user.ID(alexsn.ID)).AddWorth(100).SaveX(ctx)
client.User.DeleteOne(alexsn).ExecX(ctx)
}
|
