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
|
# frozen_string_literal: true
require "cases/helper"
require "models/topic"
class TransactionInstrumentationTest < ActiveRecord::TestCase
self.use_transactional_tests = false
fixtures :topics
def test_start_transaction_is_triggered_when_the_transaction_is_materialized
transactions = []
subscriber = ActiveSupport::Notifications.subscribe("start_transaction.active_record") do |event|
assert event.payload[:connection]
transactions << event.payload[:transaction]
end
Topic.transaction do |transaction|
assert_empty transactions # A transaction call, per se, does not trigger the event.
topics(:first).touch
assert_equal [transaction], transactions
end
ensure
ActiveSupport::Notifications.unsubscribe(subscriber)
end
def test_start_transaction_is_not_triggered_for_ordinary_nested_calls
transactions = []
subscriber = ActiveSupport::Notifications.subscribe("start_transaction.active_record") do |event|
assert event.payload[:connection]
transactions << event.payload[:transaction]
end
Topic.transaction do |t1|
topics(:first).touch
assert_equal [t1], transactions
Topic.transaction do |_t2|
topics(:first).touch
assert_equal [t1], transactions
end
end
ensure
ActiveSupport::Notifications.unsubscribe(subscriber)
end
def test_start_transaction_is_triggered_for_requires_new
transactions = []
subscriber = ActiveSupport::Notifications.subscribe("start_transaction.active_record") do |event|
assert event.payload[:connection]
transactions << event.payload[:transaction]
end
Topic.transaction do |t1|
topics(:first).touch
assert_equal [t1], transactions
Topic.transaction(requires_new: true) do |t2|
topics(:first).touch
assert_equal [t1, t2], transactions
end
end
ensure
ActiveSupport::Notifications.unsubscribe(subscriber)
end
def test_transaction_instrumentation_on_commit
topic = topics(:fifth)
notified = false
expected_transaction = nil
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
assert event.payload[:connection]
assert_same expected_transaction, event.payload[:transaction]
assert_equal :commit, event.payload[:outcome]
notified = true
end
ActiveRecord::Base.transaction do |transaction|
expected_transaction = transaction
topic.update(title: "Ruby on Rails")
end
assert notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_on_rollback
topic = topics(:fifth)
notified = false
expected_transaction = nil
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
assert event.payload[:connection]
assert_same expected_transaction, event.payload[:transaction]
assert_equal :rollback, event.payload[:outcome]
notified = true
end
ActiveRecord::Base.transaction do |transaction|
expected_transaction = transaction
topic.update(title: "Ruby on Rails")
raise ActiveRecord::Rollback
end
assert notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_savepoints
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
real_transaction = savepoint_transaction = nil
ActiveRecord::Base.transaction do |transaction|
real_transaction = transaction
topic.update(title: "Sinatra")
ActiveRecord::Base.transaction(requires_new: true) do |transaction|
savepoint_transaction = transaction
topic.update(title: "Ruby on Rails")
end
end
assert_equal 2, events.count
savepoint_event, real_event = events
assert_same savepoint_transaction, savepoint_event.payload[:transaction]
assert_equal :commit, savepoint_event.payload[:outcome]
assert_same real_transaction, real_event.payload[:transaction]
assert_equal :commit, real_event.payload[:outcome]
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_restart_parent_transaction_on_commit
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
ActiveRecord::Base.transaction(requires_new: true) do
topic.update(title: "Ruby on Rails")
end
end
assert_equal 1, events.count
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_restart_parent_transaction_on_rollback
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
ActiveRecord::Base.transaction(requires_new: true) do
topic.update(title: "Ruby on Rails")
raise ActiveRecord::Rollback
end
raise ActiveRecord::Rollback
end
assert_equal 2, events.count
restart, real = events
assert_equal :restart, restart.payload[:outcome]
assert_equal :rollback, real.payload[:outcome]
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_unmaterialized_restart_parent_transactions
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
ActiveRecord::Base.transaction(requires_new: true) do
raise ActiveRecord::Rollback
end
end
assert_equal 0, events.count
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_materialized_restart_parent_transactions
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
topic.update(title: "Sinatra")
ActiveRecord::Base.transaction(requires_new: true) do
raise ActiveRecord::Rollback
end
end
assert_equal 1, events.count
event = events.first
assert_equal :commit, event.payload[:outcome]
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_restart_savepoint_parent_transactions
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
topic.update(title: "Sinatry")
ActiveRecord::Base.transaction(requires_new: true) do
ActiveRecord::Base.transaction(requires_new: true) do
topic.update(title: "Ruby on Rails")
raise ActiveRecord::Rollback
end
end
end
assert_equal 3, events.count
restart, savepoint, real = events
assert_equal :restart, restart.payload[:outcome]
assert_equal :commit, savepoint.payload[:outcome]
assert_equal :commit, real.payload[:outcome]
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_with_restart_savepoint_parent_transactions_on_commit
topic = topics(:fifth)
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
ActiveRecord::Base.transaction do
topic.update(title: "Sinatra")
ActiveRecord::Base.transaction(requires_new: true) do
end
end
assert_equal 1, events.count
event = events.first
assert_equal :commit, event.payload[:outcome]
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_only_fires_if_materialized
notified = false
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
notified = true
end
ActiveRecord::Base.transaction do
end
assert_not notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_only_fires_on_rollback_if_materialized
notified = false
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
notified = true
end
ActiveRecord::Base.transaction do
raise ActiveRecord::Rollback
end
assert_not notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_reconnecting_after_materialized_transaction_starts_new_event
events = []
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
events << event
end
Topic.transaction do
Topic.lease_connection.materialize_transactions
Topic.lease_connection.reconnect!(restore_transactions: true)
end
assert_equal 2, events.count
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_fires_before_after_commit_callbacks
notified = false
after_commit_triggered = false
topic_model = Class.new(ActiveRecord::Base) do
self.table_name = "topics"
after_commit do
after_commit_triggered = true
end
end
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
assert_not after_commit_triggered, "Transaction notification fired after the after_commit callback"
notified = true
end
topic_model.create!
assert notified
assert after_commit_triggered
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_fires_before_after_rollback_callbacks
notified = false
after_rollback_triggered = false
topic_model = Class.new(ActiveRecord::Base) do
self.table_name = "topics"
after_rollback do
after_rollback_triggered = true
end
end
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
assert_not after_rollback_triggered, "Transaction notification fired after the after_rollback callback"
notified = true
end
topic_model.transaction do
topic_model.create!
raise ActiveRecord::Rollback
end
assert notified
assert after_rollback_triggered
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_on_failed_commit
topic = topics(:fifth)
notified = false
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
notified = true
end
error = Class.new(StandardError)
assert_raises error do
ActiveRecord::Base.lease_connection.stub(:commit_db_transaction, -> (*) { raise error }) do
ActiveRecord::Base.transaction do
topic.update(title: "Ruby on Rails")
end
end
end
assert notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
unless in_memory_db?
def test_transaction_instrumentation_on_failed_rollback
topic = topics(:fifth)
notified = false
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
assert_equal :incomplete, event.payload[:outcome]
notified = true
end
error = Class.new(StandardError)
assert_raises error do
ActiveRecord::Base.lease_connection.stub(:rollback_db_transaction, -> (*) { raise error }) do
ActiveRecord::Base.transaction do
topic.update(title: "Ruby on Rails")
raise ActiveRecord::Rollback
end
end
end
assert notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
def test_transaction_instrumentation_on_failed_rollback_when_unmaterialized
notified = false
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
notified = true
end
error = Class.new(StandardError)
assert_raises error do
# Stubbing this method simulates an error that occurs when the transaction is still unmaterilized.
Topic.lease_connection.transaction_manager.stub(:rollback_transaction, -> (*) { raise error }) do
Topic.transaction do
raise ActiveRecord::Rollback
end
end
end
assert_not notified
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
end
def test_transaction_instrumentation_on_broken_subscription
topic = topics(:fifth)
error = Class.new(StandardError)
subscriber = ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
raise error
end
assert_raises(error) do
ActiveRecord::Base.transaction do
topic.update(title: "Ruby on Rails")
end
end
ensure
ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
end
end
|
