-
Notifications
You must be signed in to change notification settings - Fork 874
Expand file tree
/
Copy pathDistributedTransactionTests.cs
More file actions
633 lines (537 loc) · 23.6 KB
/
DistributedTransactionTests.cs
File metadata and controls
633 lines (537 loc) · 23.6 KB
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
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using System.Transactions;
using NUnit.Framework;
using static Npgsql.Tests.TestUtil;
namespace Npgsql.Tests;
[NonParallelizable]
public class DistributedTransactionTests : TestBase
{
[Test]
public void Two_connections_rollback_implicit_enlistment()
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOnDataSource;
using (new TransactionScope())
using (var conn1 = dataSource.OpenConnection())
using (var conn2 = dataSource.OpenConnection())
{
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
conn2.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test2')");
}
Retry(() =>
{
AssertNoDistributedIdentifier();
AssertNoPreparedTransactions();
AssertNumberOfRows(adminConn, table, 0);
});
}
[Test]
public void Two_connections_rollback_explicit_enlistment()
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOffDataSource;
using (var conn1 = dataSource.OpenConnection())
using (var conn2 = dataSource.OpenConnection())
using (new TransactionScope())
{
conn1.EnlistTransaction(Transaction.Current);
conn2.EnlistTransaction(Transaction.Current);
Assert.That(conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')"), Is.EqualTo(1), "Unexpected first insert rowcount");
Assert.That(conn2.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test2')"), Is.EqualTo(1), "Unexpected second insert rowcount");
}
Retry(() =>
{
AssertNoDistributedIdentifier();
AssertNoPreparedTransactions();
AssertNumberOfRows(adminConn, table, 0);
});
}
[Test]
public void Two_connections_commit()
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOnDataSource;
using (var scope = new TransactionScope())
using (var conn1 = dataSource.OpenConnection())
using (var conn2 = dataSource.OpenConnection())
{
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
conn2.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test2')");
scope.Complete();
}
Retry(() =>
{
AssertNoDistributedIdentifier();
AssertNoPreparedTransactions();
AssertNumberOfRows(adminConn, table, 2);
});
}
[Test]
public void Two_connections_with_failure()
{
// Use our own data source since this test breaks the connection with a critical failure, affecting database state tracking.
using var dataSource = CreateDataSource(csb => csb.Enlist = true);
using var adminConn = dataSource.OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
using var scope = new TransactionScope();
using var conn1 = dataSource.OpenConnection();
using var conn2 = dataSource.OpenConnection();
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
conn2.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test2')");
conn1.ExecuteNonQuery($"SELECT pg_terminate_backend({conn2.ProcessID})");
scope.Complete();
Assert.That(() => scope.Dispose(), Throws.Exception.TypeOf<TransactionAbortedException>());
AssertNoDistributedIdentifier();
AssertNoPreparedTransactions();
AssertNumberOfRows(adminConn, table, 0);
}
[Test(Description = "Transaction race, bool distributed")]
[Explicit("Fails on Appveyor (https://ci.appveyor.com/project/roji/npgsql/build/3.3.0-250)")]
public void Transaction_race([Values(false, true)] bool distributed)
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOnDataSource;
for (var i = 1; i <= 100; i++)
{
var eventQueue = new ConcurrentQueue<TransactionEvent>();
try
{
using (var tx = new TransactionScope())
using (var conn1 = dataSource.OpenConnection())
{
eventQueue.Enqueue(new TransactionEvent("Scope started, connection enlisted"));
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
eventQueue.Enqueue(new TransactionEvent("Insert done"));
if (distributed)
{
EnlistResource.EscalateToDistributed(eventQueue);
AssertHasDistributedIdentifier();
}
else
{
EnlistResource.EnlistVolatile(eventQueue);
AssertNoDistributedIdentifier();
}
tx.Complete();
eventQueue.Enqueue(new TransactionEvent("Scope completed"));
}
eventQueue.Enqueue(new TransactionEvent("Scope disposed"));
AssertNoDistributedIdentifier();
if (distributed)
{
// There may be a race condition here, where the prepared transaction above still hasn't completed.
// This is by design of MS DTC. Giving it up to 100ms to complete. If it proves flaky, raise
// maxLoop.
const int maxLoop = 20;
for (var j = 0; j < maxLoop; j++)
{
Thread.Sleep(10);
try
{
AssertNumberOfRows(adminConn, table, i);
break;
}
catch
{
if (j == maxLoop - 1)
throw;
}
}
}
else
AssertNumberOfRows(adminConn, table, i);
}
catch (Exception ex)
{
Assert.Fail($"""
Failed at iteration {i}.
Events:
{FormatEventQueue(eventQueue)}
Exception {ex}
""");
}
}
}
[Test(Description = "Connection reuse race after transaction, bool distributed"), Explicit]
public void Connection_reuse_race_after_transaction([Values(false, true)] bool distributed)
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOffDataSource;
for (var i = 1; i <= 100; i++)
{
var eventQueue = new ConcurrentQueue<TransactionEvent>();
try
{
using var conn1 = dataSource.OpenConnection();
using (var scope = new TransactionScope())
{
conn1.EnlistTransaction(Transaction.Current);
eventQueue.Enqueue(new TransactionEvent("Scope started, connection enlisted"));
if (distributed)
{
EnlistResource.EscalateToDistributed(eventQueue);
AssertHasDistributedIdentifier();
}
else
{
EnlistResource.EnlistVolatile(eventQueue);
AssertNoDistributedIdentifier();
}
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
eventQueue.Enqueue(new TransactionEvent("Insert done"));
scope.Complete();
eventQueue.Enqueue(new TransactionEvent("Scope completed"));
}
eventQueue.Enqueue(new TransactionEvent("Scope disposed"));
Assert.DoesNotThrow(() => conn1.ExecuteScalar($"SELECT COUNT(*) FROM {table}"));
}
catch (Exception ex)
{
Assert.Fail($"""
Failed at iteration {i}.
Events:
{FormatEventQueue(eventQueue)}
Exception {ex}
""");
}
}
}
[Test(Description = "Connection reuse race after rollback, bool distributed"), Explicit("Currently failing.")]
public void Connection_reuse_race_after_rollback([Values(false, true)] bool distributed)
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOffDataSource;
for (var i = 1; i <= 100; i++)
{
var eventQueue = new ConcurrentQueue<TransactionEvent>();
try
{
using var conn1 = dataSource.OpenConnection();
using (new TransactionScope())
{
conn1.EnlistTransaction(Transaction.Current);
eventQueue.Enqueue(new TransactionEvent("Scope started, connection enlisted"));
if (distributed)
{
EnlistResource.EscalateToDistributed(eventQueue);
AssertHasDistributedIdentifier();
}
else
{
EnlistResource.EnlistVolatile(eventQueue);
AssertNoDistributedIdentifier();
}
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
eventQueue.Enqueue(new TransactionEvent("Insert done"));
eventQueue.Enqueue(new TransactionEvent("Scope not completed"));
}
eventQueue.Enqueue(new TransactionEvent("Scope disposed"));
conn1.EnlistTransaction(null);
eventQueue.Enqueue(new TransactionEvent("Connection enlisted with null"));
Assert.DoesNotThrow(() => conn1.ExecuteScalar($"SELECT COUNT(*) FROM {table}"));
}
catch (Exception ex)
{
Assert.Fail($"""
Failed at iteration {i}.
Events:
{FormatEventQueue(eventQueue)}
Exception {ex}
""");
}
}
}
[Test(Description = "Connection reuse race chaining transactions, bool distributed")]
[Explicit]
public void Connection_reuse_race_chaining_transaction([Values(false, true)] bool distributed)
{
using var adminConn = OpenConnection();
var table = CreateTempTable(adminConn, "name TEXT");
var dataSource = EnlistOffDataSource;
for (var i = 1; i <= 100; i++)
{
var eventQueue = new ConcurrentQueue<TransactionEvent>();
try
{
using var conn1 = dataSource.OpenConnection();
using (var scope = new TransactionScope())
{
eventQueue.Enqueue(new TransactionEvent("First scope started"));
conn1.EnlistTransaction(Transaction.Current);
eventQueue.Enqueue(new TransactionEvent("First scope, connection enlisted"));
if (distributed)
{
EnlistResource.EscalateToDistributed(eventQueue);
AssertHasDistributedIdentifier();
}
else
{
EnlistResource.EnlistVolatile(eventQueue);
AssertNoDistributedIdentifier();
}
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
eventQueue.Enqueue(new TransactionEvent("First insert done"));
scope.Complete();
eventQueue.Enqueue(new TransactionEvent("First scope completed"));
}
eventQueue.Enqueue(new TransactionEvent("First scope disposed"));
using (var scope = new TransactionScope())
{
eventQueue.Enqueue(new TransactionEvent("Second scope started"));
conn1.EnlistTransaction(Transaction.Current);
eventQueue.Enqueue(new TransactionEvent("Second scope, connection enlisted"));
if (distributed)
{
EnlistResource.EscalateToDistributed(eventQueue);
AssertHasDistributedIdentifier();
}
else
{
EnlistResource.EnlistVolatile(eventQueue);
AssertNoDistributedIdentifier();
}
conn1.ExecuteNonQuery($"INSERT INTO {table} (name) VALUES ('test1')");
eventQueue.Enqueue(new TransactionEvent("Second insert done"));
scope.Complete();
eventQueue.Enqueue(new TransactionEvent("Second scope completed"));
}
eventQueue.Enqueue(new TransactionEvent("Second scope disposed"));
}
catch (Exception ex)
{
Assert.Fail($"""
Failed at iteration {i}.
Events:
{FormatEventQueue(eventQueue)}
Exception {ex}
""");
}
}
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/5246")]
public void Transaction_complete_with_undisposed_connections()
{
using var deleteOuter = new TransactionScope();
using (var delImidiate = new TransactionScope(TransactionScopeOption.RequiresNew))
{
var deleteNow = EnlistOnDataSource.OpenConnection();
deleteNow.ExecuteNonQuery("SELECT 'del_now'");
var deleteNow2 = EnlistOnDataSource.OpenConnection();
deleteNow2.ExecuteNonQuery("SELECT 'del_now2'");
delImidiate.Complete();
}
var deleteConn = EnlistOnDataSource.OpenConnection();
deleteConn.ExecuteNonQuery("SELECT 'delete, this should commit last'");
deleteOuter.Complete();
}
#region Utilities
// MSDTC is asynchronous, i.e. Commit/Rollback may return before the transaction has actually completed in the database;
// so allow some time for assertions to succeed.
static void Retry(Action action)
{
const int Retries = 50;
for (var i = 0; i < Retries; i++)
{
try
{
action();
return;
}
catch (AssertionException)
{
if (i == Retries - 1)
{
throw;
}
Thread.Sleep(100);
}
}
}
void AssertNoPreparedTransactions()
=> Assert.That(GetNumberOfPreparedTransactions(), Is.EqualTo(0), "Prepared transactions found");
int GetNumberOfPreparedTransactions()
{
var dataSource = EnlistOffDataSource;
using (var conn = dataSource.OpenConnection())
using (var cmd = new NpgsqlCommand("SELECT COUNT(*) FROM pg_prepared_xacts WHERE database = @database", conn))
{
cmd.Parameters.Add(new NpgsqlParameter("database", conn.Database));
return (int)(long)cmd.ExecuteScalar()!;
}
}
void AssertNumberOfRows(NpgsqlConnection connection, string table, int expected)
=> Assert.That(connection.ExecuteScalar($"SELECT COUNT(*) FROM {table}"), Is.EqualTo(expected), "Unexpected data count");
static void AssertNoDistributedIdentifier()
=> Assert.That(Transaction.Current?.TransactionInformation.DistributedIdentifier ?? Guid.Empty, Is.EqualTo(Guid.Empty), "Distributed identifier found");
static void AssertHasDistributedIdentifier()
=> Assert.That(Transaction.Current?.TransactionInformation.DistributedIdentifier ?? Guid.Empty, Is.Not.EqualTo(Guid.Empty), "Distributed identifier not found");
NpgsqlDataSource EnlistOnDataSource { get; set; } = default!;
NpgsqlDataSource EnlistOffDataSource { get; set; } = default!;
static string FormatEventQueue(ConcurrentQueue<TransactionEvent> eventQueue)
{
eventQueue.Enqueue(new TransactionEvent(@"-------------
Start formatting event queue, going to sleep a bit for late events
-------------"));
Thread.Sleep(20);
var eventsMessage = new StringBuilder();
foreach (var evt in eventQueue)
{
eventsMessage.AppendLine(evt.Message);
}
return eventsMessage.ToString();
}
// Idea from NHibernate test project, DtcFailuresFixture
public class EnlistResource : IEnlistmentNotification
{
public static int Counter { get; set; }
readonly bool _shouldRollBack;
readonly string _name;
readonly ConcurrentQueue<TransactionEvent>? _eventQueue;
public static void EnlistVolatile(ConcurrentQueue<TransactionEvent> eventQueue)
=> EnlistVolatile(false, eventQueue);
public static void EnlistVolatile(bool shouldRollBack = false, ConcurrentQueue<TransactionEvent>? eventQueue = null)
=> Enlist(false, shouldRollBack, eventQueue);
public static void EscalateToDistributed(ConcurrentQueue<TransactionEvent> eventQueue)
=> EscalateToDistributed(false, eventQueue);
public static void EscalateToDistributed(bool shouldRollBack = false, ConcurrentQueue<TransactionEvent>? eventQueue = null)
=> Enlist(true, shouldRollBack, eventQueue);
static void Enlist(bool durable, bool shouldRollBack, ConcurrentQueue<TransactionEvent>? eventQueue)
{
Counter++;
var name = $"{(durable ? "Durable" : "Volatile")} resource {Counter}";
var resource = new EnlistResource(shouldRollBack, name, eventQueue);
if (durable)
Transaction.Current!.EnlistDurable(Guid.NewGuid(), resource, EnlistmentOptions.None);
else
Transaction.Current!.EnlistVolatile(resource, EnlistmentOptions.None);
Transaction.Current.TransactionCompleted += resource.Current_TransactionCompleted!;
eventQueue?.Enqueue(new TransactionEvent(name + ": enlisted"));
}
EnlistResource(bool shouldRollBack, string name, ConcurrentQueue<TransactionEvent>? eventQueue)
{
_shouldRollBack = shouldRollBack;
_name = name;
_eventQueue = eventQueue;
}
public void Prepare(PreparingEnlistment preparingEnlistment)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": prepare phase start"));
Thread.Sleep(1);
if (_shouldRollBack)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": prepare phase, calling rollback-ed"));
preparingEnlistment.ForceRollback();
}
else
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": prepare phase, calling prepared"));
preparingEnlistment.Prepared();
}
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": prepare phase end"));
}
public void Commit(Enlistment enlistment)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": commit phase start"));
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": commit phase, calling done"));
enlistment.Done();
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": commit phase end"));
}
public void Rollback(Enlistment enlistment)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": rollback phase start"));
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": rollback phase, calling done"));
enlistment.Done();
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": rollback phase end"));
}
public void InDoubt(Enlistment enlistment)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": in-doubt phase start"));
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": in-doubt phase, calling done"));
enlistment.Done();
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": in-doubt phase end"));
}
void Current_TransactionCompleted(object sender, TransactionEventArgs e)
{
_eventQueue?.Enqueue(new TransactionEvent(_name + ": transaction completed start"));
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": transaction completed middle"));
Thread.Sleep(1);
_eventQueue?.Enqueue(new TransactionEvent(_name + ": transaction completed end"));
}
}
public class TransactionEvent(string message)
{
public string Message { get; } = $"{message} (TId {Thread.CurrentThread.ManagedThreadId})";
}
#endregion Utilities
#region Setup
[OneTimeSetUp]
public void OneTimeSetUp()
{
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
Assert.Ignore("Distributed transactions are only supported on Windows");
return;
}
using var connection = OpenConnection();
// Make sure prepared transactions are enabled in postgresql.conf (disabled by default)
if (int.Parse((string)connection.ExecuteScalar("SHOW max_prepared_transactions")!) == 0)
{
IgnoreExceptOnBuildServer("max_prepared_transactions is set to 0 in your postgresql.conf");
return;
}
// Roll back any lingering prepared transactions from failed previous runs
var lingeringTransactions = new List<string>();
using (var cmd = new NpgsqlCommand("SELECT gid FROM pg_prepared_xacts WHERE database=@database", connection))
{
cmd.Parameters.AddWithValue("database", new NpgsqlConnectionStringBuilder(ConnectionString).Database!);
using var reader = cmd.ExecuteReader();
while (reader.Read())
lingeringTransactions.Add(reader.GetString(0));
}
foreach (var xactGid in lingeringTransactions)
connection.ExecuteNonQuery($"ROLLBACK PREPARED '{xactGid}'");
EnlistOnDataSource = CreateDataSource(csb => csb.Enlist = true);
EnlistOffDataSource = CreateDataSource(csb => csb.Enlist = false);
}
[OneTimeTearDown]
public void OnTimeTearDown()
{
EnlistOnDataSource?.Dispose();
EnlistOnDataSource = null!;
EnlistOffDataSource?.Dispose();
EnlistOffDataSource = null!;
}
[SetUp]
public void SetUp()
=> EnlistResource.Counter = 0;
internal static string CreateTempTable(NpgsqlConnection conn, string columns)
{
var tableName = "temp_table" + Interlocked.Increment(ref _tempTableCounter);
conn.ExecuteNonQuery(@$"
START TRANSACTION; SELECT pg_advisory_xact_lock(0);
DROP TABLE IF EXISTS {tableName} CASCADE;
COMMIT;
CREATE TABLE {tableName} ({columns})");
return tableName;
}
#endregion
}