File size: 12,861 Bytes
fea99b3 | 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 | package entutils_test
import (
"context"
"database/sql"
"fmt"
"sync"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/openmeterio/openmeter/openmeter/testutils"
"github.com/openmeterio/openmeter/pkg/framework/entutils"
db1 "github.com/openmeterio/openmeter/pkg/framework/entutils/testutils/ent1/db"
db2 "github.com/openmeterio/openmeter/pkg/framework/entutils/testutils/ent2/db"
"github.com/openmeterio/openmeter/pkg/framework/transaction"
)
// db1Adapter and db2Adapter implement the generic SomeDB interface as DB adapters
// and implement the entutils.TxCreator and entutils.TxUser interfaces to allow for transaction handling
type SomeDB[T any] interface {
Get(ctx context.Context, id string) (*T, error)
Save(ctx context.Context, value *T) (*T, error)
}
type SomeDBTx[T any] interface {
SomeDB[T]
entutils.TxCreator
entutils.TxUser[SomeDB[T]]
}
type db1Adapter struct {
db *db1.Client
}
func (d *db1Adapter) Get(ctx context.Context, id string) (*db1.Example1, error) {
return d.db.Example1.Get(ctx, id)
}
func (d *db1Adapter) Save(ctx context.Context, value *db1.Example1) (*db1.Example1, error) {
return d.db.Example1.Create().
SetID(value.ID).
SetExampleValue1(value.ExampleValue1).
Save(ctx)
}
// we have to implement the TxCreator and TxUser interfaces
func (d *db1Adapter) Tx(ctx context.Context) (context.Context, transaction.Driver, error) {
txCtx, rawConfig, eDriver, err := d.db.HijackTx(ctx, &sql.TxOptions{
ReadOnly: false,
})
if err != nil {
return nil, nil, fmt.Errorf("failed to hijack transaction: %w", err)
}
return txCtx, entutils.NewTxDriver(eDriver, rawConfig), nil
}
func (d *db1Adapter) Self() SomeDB[db1.Example1] {
return d
}
func (d *db1Adapter) WithTx(ctx context.Context, tx *entutils.TxDriver) SomeDB[db1.Example1] {
txClient := db1.NewTxClientFromRawConfig(ctx, *tx.GetConfig())
res := &db1Adapter{db: txClient.Client()}
return res
}
var _ SomeDBTx[db1.Example1] = &db1Adapter{}
type db2Adapter struct {
db *db2.Client
}
func (d *db2Adapter) Get(ctx context.Context, id string) (*db2.Example2, error) {
return d.db.Example2.Get(ctx, id)
}
func (d *db2Adapter) Save(ctx context.Context, value *db2.Example2) (*db2.Example2, error) {
return d.db.Example2.Create().
SetID(value.ID).
SetExampleValue2(value.ExampleValue2).
Save(ctx)
}
// we have to implement the TxCreator and TxUser interfaces
func (d *db2Adapter) Tx(ctx context.Context) (context.Context, transaction.Driver, error) {
txCtx, rawConfig, eDriver, err := d.db.HijackTx(ctx, &sql.TxOptions{
ReadOnly: false,
})
if err != nil {
return nil, nil, fmt.Errorf("failed to hijack transaction: %w", err)
}
return txCtx, entutils.NewTxDriver(eDriver, rawConfig), nil
}
func (d *db2Adapter) Self() SomeDB[db2.Example2] {
return d
}
func (d *db2Adapter) WithTx(ctx context.Context, tx *entutils.TxDriver) SomeDB[db2.Example2] {
txClient := db2.NewTxClientFromRawConfig(ctx, *tx.GetConfig())
return &db2Adapter{db: txClient.Client()}
}
var _ SomeDBTx[db2.Example2] = &db2Adapter{}
func TestTransaction(t *testing.T) {
tc := []struct {
name string
run func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2])
}{
{
name: "Should roll back everything when cb returns an error",
run: func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2]) {
ctx := context.Background()
var ent1Id string
var ent2Id string
_, err := transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// create entities
ec1, err := db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "1",
ExampleValue1: "value1",
})
if err != nil {
return nil, err
}
ec2, err := db2Adapter.WithTx(ctx, tx).Save(ctx, &db2.Example2{
ID: "2",
ExampleValue2: "value2",
})
if err != nil {
return nil, err
}
// save it's id for later
ent1Id = ec1.ID
ent2Id = ec2.ID
// check it exists in transaction
ent1, err := db1Adapter.WithTx(ctx, tx).Get(ctx, ent1Id)
assert.NoError(t, err)
assert.NotNil(t, ent1)
ent2, err := db2Adapter.WithTx(ctx, tx).Get(ctx, ent2Id)
assert.NoError(t, err)
assert.NotNil(t, ent2)
assert.NoError(t, err)
return nil, fmt.Errorf("lets roll back")
})
assert.Equal(t, "lets roll back", err.Error())
// check that it wasn't persisted
ent1, err := db1Adapter.Get(ctx, ent1Id)
assert.Error(t, err)
assert.Nil(t, ent1)
ent2, err := db2Adapter.Get(ctx, ent2Id)
assert.Error(t, err)
assert.Nil(t, ent2)
},
},
{
name: "Should commit everything by default",
run: func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2]) {
ctx := context.Background()
var ent1Id string
var ent2Id string
_, err := transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// create entities
ec1, err := db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "1",
ExampleValue1: "value1",
})
if err != nil {
return nil, err
}
ec2, err := db2Adapter.WithTx(ctx, tx).Save(ctx, &db2.Example2{
ID: "2",
ExampleValue2: "value2",
})
if err != nil {
return nil, err
}
// save it's id for later
ent1Id = ec1.ID
ent2Id = ec2.ID
// check it exists in transaction
ent1, err := db1Adapter.WithTx(ctx, tx).Get(ctx, ent1Id)
assert.NoError(t, err)
assert.NotNil(t, ent1)
ent2, err := db2Adapter.WithTx(ctx, tx).Get(ctx, ent2Id)
assert.NoError(t, err)
assert.NotNil(t, ent2)
return nil, nil
})
if err != nil {
t.Fatalf("failed to run transaction %s", err)
}
// check that it was persisted
ent1, err := db1Adapter.Get(ctx, ent1Id)
assert.NoError(t, err)
ent2, err := db2Adapter.Get(ctx, ent2Id)
assert.NoError(t, err)
assert.NotNil(t, ent1)
assert.Equal(t, ent1Id, ent1.ID)
assert.NotNil(t, ent2)
assert.Equal(t, ent2Id, ent2.ID)
},
},
{
name: "Should roll back everything if context is canceled",
run: func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2]) {
ctx, cancel := context.WithCancel(context.Background())
var ent1Id string
var ent2Id string
wg := sync.WaitGroup{}
ch := make(chan bool)
wg.Add(1)
go func() {
defer wg.Done()
_, err := transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
panic(err)
}
// create entities
ec1, err := db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "1",
ExampleValue1: "value1",
})
if err != nil {
return nil, err
}
ec2, err := db2Adapter.WithTx(ctx, tx).Save(ctx, &db2.Example2{
ID: "2",
ExampleValue2: "value2",
})
if err != nil {
return nil, err
}
// save it's id for later
ent1Id = ec1.ID
ent2Id = ec2.ID
// check it exists in transaction
ent1, err := db1Adapter.WithTx(ctx, tx).Get(ctx, ent1Id)
assert.NoError(t, err)
assert.NotNil(t, ent1)
ent2, err := db2Adapter.WithTx(ctx, tx).Get(ctx, ent2Id)
assert.NoError(t, err)
assert.NotNil(t, ent2)
// we write to the channel to signify that we have written
ch <- true
// we wait to simulate some other code in the transaction
time.Sleep(100 * time.Millisecond)
return nil, nil
})
assert.ErrorContains(t, err, "transaction has already been committed or rolled back")
}()
// we cancel the context after the writes have finished
wg.Add(1)
go func() {
defer wg.Done()
// we wait for the channel signifying that the other routine has written
<-ch
cancel()
}()
wg.Wait()
// check that it was rolled back
ent1, err := db1Adapter.Get(context.TODO(), ent1Id)
assert.Error(t, err)
assert.Nil(t, ent1)
ent2, err := db2Adapter.Get(context.TODO(), ent2Id)
assert.Error(t, err)
assert.Nil(t, ent2)
},
},
{
name: "Should not error if called nested",
run: func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2]) {
ctx := context.Background()
// start outer transaction
_, err := transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// do something in outer transaction first
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "1",
})
if err != nil {
return nil, err
}
// start inner transaction
_, err = transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// do something else in the inner transaction
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "2",
})
if err != nil {
return nil, err
}
return nil, nil
})
if err != nil {
return nil, err
}
// do a third thing
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "3",
})
return nil, err
})
if err != nil {
t.Fatalf("failed to run transaction %s", err)
}
// validate all 3 items were saved
ent1, err := db1Adapter.Get(ctx, "1")
assert.NoError(t, err)
assert.NotNil(t, ent1)
ent2, err := db1Adapter.Get(ctx, "2")
assert.NoError(t, err)
assert.NotNil(t, ent2)
ent3, err := db1Adapter.Get(ctx, "3")
assert.NoError(t, err)
assert.NotNil(t, ent3)
},
},
{
name: "Should allow rollback of child scope while keeping contents of parent",
run: func(t *testing.T, db1Adapter SomeDBTx[db1.Example1], db2Adapter SomeDBTx[db2.Example2]) {
ctx := context.Background()
// start outer transaction
_, err := transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// do something in outer transaction first
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "1",
})
if err != nil {
return nil, err
}
// start inner transaction
_, err = transaction.Run(ctx, db1Adapter, func(ctx context.Context) (*interface{}, error) {
tx, err := entutils.GetDriverFromContext(ctx)
if err != nil {
t.Fatal(err)
}
// do something else in the inner transaction
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "2",
})
if err != nil {
return nil, err
}
return nil, fmt.Errorf("lets roll back")
})
// we assert for this error but then continue execution as if nothing happened
assert.Equal(t, "lets roll back", err.Error())
// do a third thing
_, err = db1Adapter.WithTx(ctx, tx).Save(ctx, &db1.Example1{
ID: "3",
})
if err != nil {
return nil, err
}
return nil, err
})
if err != nil {
t.Fatalf("failed to run transaction %s", err)
}
ent1, err := db1Adapter.Get(ctx, "1")
assert.Nil(t, err)
assert.NotNil(t, ent1)
// validate that middle item was rolled back
ent2, err := db1Adapter.Get(ctx, "2")
assert.True(t, db1.IsNotFound(err))
assert.Nil(t, ent2)
ent3, err := db1Adapter.Get(ctx, "3")
assert.Nil(t, err)
assert.NotNil(t, ent3)
},
},
}
for _, tt := range tc {
tt := tt
t.Run(tt.name, func(t *testing.T) {
// create isolated pg db for tests
driver := testutils.InitPostgresDB(t, testutils.PostgresDBStateEmpty)
defer driver.PGDriver.Close()
defer driver.EntDriver.Close()
// build db clients
db1Client := db1.NewClient(db1.Driver(driver.EntDriver.Driver()))
db2Client := db2.NewClient(db2.Driver(driver.EntDriver.Driver()))
if err := db1Client.Schema.Create(context.Background()); err != nil {
t.Fatalf("failed to migrate database %s", err)
}
if err := db2Client.Schema.Create(context.Background()); err != nil {
t.Fatalf("failed to migrate database %s", err)
}
db1 := &db1Adapter{db: db1Client}
db2 := &db2Adapter{db: db2Client}
tt.run(t, db1, db2)
})
}
}
|