/
strict_loading_test.rb
602 lines (461 loc) · 17.4 KB
/
strict_loading_test.rb
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
# frozen_string_literal: true
require "cases/helper"
require "models/developer"
require "models/contract"
require "models/company"
require "models/computer"
require "models/mentor"
require "models/project"
require "models/ship"
require "models/ship_part"
require "models/strict_zine"
require "models/interest"
require "models/treasure"
require "models/pirate"
class StrictLoadingTest < ActiveRecord::TestCase
fixtures :developers, :developers_projects, :projects, :ships
def test_strict_loading!
developer = Developer.first
assert_not_predicate developer, :strict_loading?
assert developer.strict_loading!
assert_predicate developer, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.audit_logs.to_a
end
assert_not developer.strict_loading!(false)
assert_not_predicate developer, :strict_loading?
assert_nothing_raised do
developer.audit_logs.to_a
end
assert developer.strict_loading!(mode: :n_plus_one_only)
assert developer.strict_loading_n_plus_one_only?
end
def test_strict_loading_n_plus_one_only_mode
developer = Developer.first
ship = Ship.first
ShipPart.create!(name: "Stern", ship: ship)
firm = Firm.create!(name: "NASA")
project = Project.create!(name: "Apollo", firm: firm)
ship.update_column(:developer_id, developer.id)
developer.projects << project
developer.reload
developer.strict_loading!(mode: :n_plus_one_only)
assert_predicate developer, :strict_loading?
# Does not raise when loading a has_many association (:projects)
assert_nothing_raised do
developer.projects.to_a
end
# strict_loading is enabled for has_many associations
assert developer.projects.all?(&:strict_loading?)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.projects.last.firm
end
# Does not raise when a belongs_to association (:ship) loads its
# has_many association (:parts)
assert_nothing_raised do
developer.ship.parts.to_a
end
# strict_loading is enabled for has_many through a belongs_to
assert_not developer.ship.strict_loading?
assert developer.ship.parts.all?(&:strict_loading?)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.ship.parts.first.trinkets.to_a
end
end
def test_strict_loading
Developer.all.each { |d| assert_not d.strict_loading? }
Developer.strict_loading.each { |d| assert d.strict_loading? }
end
def test_strict_loading_by_default
with_strict_loading_by_default(Developer) do
Developer.all.each { |d| assert d.strict_loading? }
Developer.strict_loading(false).each { |d| assert_not d.strict_loading? }
end
end
def test_strict_loading_by_default_can_be_set_per_model
model1 = Class.new(ActiveRecord::Base) do
self.table_name = "developers"
self.strict_loading_by_default = true
end.new
model2 = Class.new(ActiveRecord::Base) do
self.table_name = "developers"
self.strict_loading_by_default = false
end.new
assert_predicate model1, :strict_loading?
assert_not_predicate model2, :strict_loading?
end
def test_strict_loading_by_default_is_inheritable
with_strict_loading_by_default(ActiveRecord::Base) do
model1 = Class.new(ActiveRecord::Base) do
self.table_name = "developers"
end.new
model2 = Class.new(ActiveRecord::Base) do
self.table_name = "developers"
self.strict_loading_by_default = false
end.new
assert_predicate model1, :strict_loading?
assert_not_predicate model2, :strict_loading?
end
end
def test_raises_if_strict_loading_and_lazy_loading
dev = Developer.strict_loading.first
assert_predicate dev, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
dev.audit_logs.to_a
end
end
def test_raises_if_strict_loading_by_default_and_lazy_loading
with_strict_loading_by_default(Developer) do
dev = Developer.first
assert_predicate dev, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
dev.audit_logs.to_a
end
end
end
def test_strict_loading_is_ignored_in_validation_context
with_strict_loading_by_default(Developer) do
developer = Developer.first
assert_predicate developer, :strict_loading?
assert_nothing_raised do
AuditLogRequired.create! developer_id: developer.id, message: "i am a message"
end
end
end
def test_strict_loading_with_reflection_is_ignored_in_validation_context
with_strict_loading_by_default(Developer) do
developer = Developer.first
assert_predicate developer, :strict_loading?
developer.required_audit_logs.build(message: "I am message")
developer.save!
end
end
def test_strict_loading_has_one_reload
with_strict_loading_by_default(Developer) do
ship = Ship.create!(developer: Developer.first, name: "The Great Ship")
developer = Developer.preload(:ship).first
assert_predicate developer, :strict_loading?
assert_equal ship, developer.ship
developer.reload
assert_nothing_raised do
assert_equal ship, developer.ship
end
end
end
def test_strict_loading_with_has_many
with_strict_loading_by_default(Developer) do
devs = Developer.preload(:audit_logs).all
assert_nothing_raised do
devs.map(&:audit_logs).to_a
end
devs.reload
assert_nothing_raised do
devs.map(&:audit_logs).to_a
end
end
end
def test_strict_loading_with_has_many_singular_association_and_reload
with_strict_loading_by_default(Developer) do
dev = Developer.preload(:audit_logs).first
assert_nothing_raised do
dev.audit_logs.to_a
end
dev.reload
assert_nothing_raised do
dev.audit_logs.to_a
end
end
end
def test_strict_loading_with_has_many_through_cascade_down_to_middle_records
dev = Developer.first
firm = Firm.create!(name: "NASA")
contract = Contract.create!(developer: dev, firm: firm)
dev.contracts << contract
dev = Developer.strict_loading.includes(:firms).first
assert_predicate dev, :strict_loading?
[
proc { dev.firms.first.contracts.first },
proc { dev.contracts.first },
proc { dev.ship }
].each do |block|
assert_raises ActiveRecord::StrictLoadingViolationError do
block.call
end
end
end
def test_preload_audit_logs_are_strict_loading_because_parent_is_strict_loading
developer = Developer.first
3.times do
AuditLog.create(developer: developer, message: "I am message")
end
dev = Developer.includes(:audit_logs).strict_loading.first
assert_predicate dev, :strict_loading?
assert dev.audit_logs.all?(&:strict_loading?), "Expected all audit logs to be strict_loading"
end
def test_preload_audit_logs_are_strict_loading_because_it_is_strict_loading_by_default
with_strict_loading_by_default(AuditLog) do
developer = Developer.first
3.times do
AuditLog.create(developer: developer, message: "I am message")
end
dev = Developer.includes(:audit_logs).first
assert_not_predicate dev, :strict_loading?
assert dev.audit_logs.all?(&:strict_loading?), "Expected all audit logs to be strict_loading"
end
end
def test_eager_load_audit_logs_are_strict_loading_because_parent_is_strict_loading_in_hm_relation
developer = Developer.first
3.times do
AuditLog.create(developer: developer, message: "I am message")
end
dev = Developer.eager_load(:strict_loading_audit_logs).first
assert dev.strict_loading_audit_logs.all?(&:strict_loading?), "Expected all audit logs to be strict_loading"
dev = Developer.eager_load(:strict_loading_audit_logs).strict_loading(false).first
assert dev.audit_logs.none?(&:strict_loading?), "Expected no audit logs to be strict_loading"
end
def test_eager_load_audit_logs_are_strict_loading_because_parent_is_strict_loading
developer = Developer.first
3.times do
AuditLog.create(developer: developer, message: "I am message")
end
dev = Developer.eager_load(:audit_logs).strict_loading.first
assert_predicate dev, :strict_loading?
assert dev.audit_logs.all?(&:strict_loading?), "Expected all audit logs to be strict_loading"
dev = Developer.eager_load(:audit_logs).strict_loading(false).first
assert_not_predicate dev, :strict_loading?
assert dev.audit_logs.none?(&:strict_loading?), "Expected no audit logs to be strict_loading"
end
def test_eager_load_audit_logs_are_strict_loading_because_it_is_strict_loading_by_default
with_strict_loading_by_default(AuditLog) do
developer = Developer.first
3.times do
AuditLog.create(developer: developer, message: "I am message")
end
dev = Developer.eager_load(:audit_logs).first
assert_not_predicate dev, :strict_loading?
assert_predicate AuditLog.last, :strict_loading?
assert dev.audit_logs.all?(&:strict_loading?), "Expected all audit logs to be strict_loading"
end
end
def test_raises_on_unloaded_relation_methods_if_strict_loading
dev = Developer.strict_loading.first
assert_predicate dev, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
dev.audit_logs.first
end
end
def test_raises_on_unloaded_relation_methods_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
dev = Developer.first
assert_predicate dev, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
dev.audit_logs.first
end
end
end
def test_raises_on_lazy_loading_a_strict_loading_belongs_to_relation
mentor = Mentor.create!(name: "Mentor")
developer = Developer.first
developer.update_column(:mentor_id, mentor.id)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.strict_loading_mentor
end
end
def test_raises_on_lazy_loading_a_belongs_to_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
mentor = Mentor.create!(name: "Mentor")
developer = Developer.first
developer.update_column(:mentor_id, mentor.id)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.mentor
end
end
end
def test_strict_loading_can_be_turned_off_on_an_association_in_a_model_with_strict_loading_on
with_strict_loading_by_default(Developer) do
mentor = Mentor.create!(name: "Mentor")
developer = Developer.first
developer.update_column(:mentor_id, mentor.id)
assert_nothing_raised do
developer.strict_loading_off_mentor
end
end
end
def test_does_not_raise_on_eager_loading_a_strict_loading_belongs_to_relation
mentor = Mentor.create!(name: "Mentor")
Developer.first.update_column(:mentor_id, mentor.id)
developer = Developer.includes(:strict_loading_mentor).first
assert_nothing_raised { developer.strict_loading_mentor }
end
def test_does_not_raise_on_eager_loading_a_belongs_to_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
mentor = Mentor.create!(name: "Mentor")
Developer.first.update_column(:mentor_id, mentor.id)
developer = Developer.includes(:mentor).first
assert_nothing_raised { developer.mentor }
end
end
def test_raises_on_lazy_loading_a_strict_loading_has_one_relation
developer = Developer.first
ship = Ship.first
ship.update_column(:developer_id, developer.id)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.strict_loading_ship
end
end
def test_raises_on_lazy_loading_a_has_one_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
developer = Developer.first
ship = Ship.first
ship.update_column(:developer_id, developer.id)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.ship
end
end
end
def test_does_not_raise_on_eager_loading_a_strict_loading_has_one_relation
Ship.first.update_column(:developer_id, Developer.first.id)
developer = Developer.includes(:strict_loading_ship).first
assert_nothing_raised { developer.strict_loading_ship }
end
def test_does_not_raise_on_eager_loading_a_has_one_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
Ship.first.update_column(:developer_id, Developer.first.id)
developer = Developer.includes(:ship).first
assert_nothing_raised { developer.ship }
end
end
def test_raises_on_lazy_loading_a_strict_loading_has_many_relation
developer = Developer.first
AuditLog.create(
3.times.map do
{ developer_id: developer.id, message: "I am message" }
end
)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.strict_loading_opt_audit_logs.first
end
end
def test_raises_on_lazy_loading_a_has_many_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
developer = Developer.first
AuditLog.create(
3.times.map do
{ developer_id: developer.id, message: "I am message" }
end
)
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.audit_logs.first
end
end
end
def test_does_not_raise_on_eager_loading_a_strict_loading_has_many_relation
developer = Developer.first
AuditLog.create(
3.times.map do
{ developer_id: developer.id, message: "I am message" }
end
)
developer = Developer.includes(:strict_loading_opt_audit_logs).first
assert_nothing_raised { developer.strict_loading_opt_audit_logs.first }
end
def test_does_not_raise_on_eager_loading_a_has_many_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
developer = Developer.first
AuditLog.create(
3.times.map do
{ developer_id: developer.id, message: "I am message" }
end
)
developer = Developer.includes(:audit_logs).first
assert_nothing_raised { developer.audit_logs.first }
end
end
def test_raises_on_lazy_loading_a_strict_loading_habtm_relation
developer = Developer.first
developer.projects << Project.first
assert_not developer.strict_loading_projects.loaded?
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.strict_loading_projects.first
end
end
def test_raises_on_lazy_loading_a_habtm_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
developer = Developer.first
developer.projects << Project.first
assert_not developer.projects.loaded?
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.projects.first
end
end
end
def test_does_not_raise_on_eager_loading_a_strict_loading_habtm_relation
Developer.first.projects << Project.first
developer = Developer.includes(:strict_loading_projects).first
assert_nothing_raised { developer.strict_loading_projects.first }
end
def test_does_not_raise_on_eager_loading_a_habtm_relation_if_strict_loading_by_default
with_strict_loading_by_default(Developer) do
Developer.first.projects << Project.first
developer = Developer.includes(:projects).first
assert_nothing_raised { developer.projects.first }
end
end
def test_strict_loading_violation_raises_by_default
assert_equal :raise, ActiveRecord.action_on_strict_loading_violation
developer = Developer.first
assert_not_predicate developer, :strict_loading?
developer.strict_loading!
assert_predicate developer, :strict_loading?
assert_raises ActiveRecord::StrictLoadingViolationError do
developer.audit_logs.to_a
end
end
def test_strict_loading_violation_can_log_instead_of_raise
old_value = ActiveRecord.action_on_strict_loading_violation
ActiveRecord.action_on_strict_loading_violation = :log
assert_equal :log, ActiveRecord.action_on_strict_loading_violation
developer = Developer.first
assert_not_predicate developer, :strict_loading?
developer.strict_loading!
assert_predicate developer, :strict_loading?
assert_logged("Strict loading violation: Developer is marked for strict loading. The AuditLog association named :audit_logs cannot be lazily loaded.") do
developer.audit_logs.to_a
end
ensure
ActiveRecord.action_on_strict_loading_violation = old_value
end
private
def with_strict_loading_by_default(model)
previous_strict_loading_by_default = model.strict_loading_by_default
model.strict_loading_by_default = true
yield
ensure
model.strict_loading_by_default = previous_strict_loading_by_default
end
def assert_logged(message)
old_logger = ActiveRecord::Base.logger
log = StringIO.new
ActiveRecord::Base.logger = Logger.new(log)
begin
yield
log.rewind
assert_match message, log.read
ensure
ActiveRecord::Base.logger = old_logger
end
end
end
class StrictLoadingFixturesTest < ActiveRecord::TestCase
fixtures :strict_zines
test "strict loading violations are ignored on fixtures" do
ActiveRecord::FixtureSet.reset_cache
create_fixtures("strict_zines")
assert_nothing_raised do
strict_zines(:going_out).interests.to_a
end
assert_raises(ActiveRecord::StrictLoadingViolationError) do
StrictZine.first.interests.to_a
end
end
end