OpenNeo/impress
OpenNeo/impress
1
0
Fork 1
Code Pull requests Activity

Make Item's update_cached_fields callback more reliable

Browse source 
In our tests, I discovered an unexpected behavior where calling
`item.swf_assets << swf_asset` wasn't updating computed fields
correctly.

This isn't something we actually do in-app, I think the modeling system
happened to trigger the callbacks in a way that still worked fine?

But I think this is a good idea for reliability, since caching is such
a notoriously difficult thing to get right anyway! And it makes our
tests simpler and clearer.

Specifically, `compatible_body_ids` references `swf_assets`, which, I'm
kinda surprised, *doesn't* include the newly-added asset yet when the
`ParentSwfAssetRelationship.after_save` hook runs while calling
`item.swf_assets << swf_asset`. Reloading it fixes this!
This commit is contained in:
Emi Matchu 2024-11-19 14:26:06 -08:00
parent af5187edb6
commit 39bed6b157
2 changed files with 4 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
app/models/item.rb
View file

@ -263,6 +263,10 @@ class Item < ApplicationRecord
end end
def update_cached_fields def update_cached_fields
# Reload our associations, so they include any new records.
swf_assets.reload
# Then, compute and save our cached fields.
self.cached_occupied_zone_ids = occupied_zone_ids self.cached_occupied_zone_ids = occupied_zone_ids
self.cached_compatible_body_ids = compatible_body_ids(use_cached: false) self.cached_compatible_body_ids = compatible_body_ids(use_cached: false)
self.save! self.save!

12
spec/models/item_spec.rb
View file

@ -90,9 +90,6 @@ RSpec.describe Item do
before do before do
item.swf_assets << build_item_asset(zones(:wings), body_id: 1) item.swf_assets << build_item_asset(zones(:wings), body_id: 1)
item.swf_assets << build_item_asset(zones(:wings), body_id: 2) item.swf_assets << build_item_asset(zones(:wings), body_id: 2)
# HACK: I don't understand why the first asset is triggering the hooks
# for cached fields, but the second isn't? Idk, force an update.
item.update_cached_fields
end end
it_behaves_like "a not-fully-modeled item" it_behaves_like "a not-fully-modeled item"
@ -112,9 +109,6 @@ RSpec.describe Item do
item.swf_assets << build_item_asset(zones(:wings), body_id: 2) item.swf_assets << build_item_asset(zones(:wings), body_id: 2)
item.swf_assets << build_item_asset(zones(:wings), body_id: 3) item.swf_assets << build_item_asset(zones(:wings), body_id: 3)
item.swf_assets << build_item_asset(zones(:wings), body_id: 4) item.swf_assets << build_item_asset(zones(:wings), body_id: 4)
# HACK: I don't understand why the first asset is triggering the hooks
# for cached fields, but the second isn't? Idk, force an update.
item.update_cached_fields
end end
it_behaves_like "a fully-modeled item" it_behaves_like "a fully-modeled item"
@ -155,9 +149,6 @@ RSpec.describe Item do
before do before do
item.swf_assets << build_item_asset(zones(:wings), body_id: 11) item.swf_assets << build_item_asset(zones(:wings), body_id: 11)
item.swf_assets << build_item_asset(zones(:wings), body_id: 12) item.swf_assets << build_item_asset(zones(:wings), body_id: 12)
# HACK: I don't understand why the first asset is triggering the hooks
# for cached fields, but the second isn't? Idk, force an update.
item.update_cached_fields
end end
it_behaves_like "a not-fully-modeled item" it_behaves_like "a not-fully-modeled item"
@ -177,9 +168,6 @@ RSpec.describe Item do
item.swf_assets << build_item_asset(zones(:wings), body_id: 12) item.swf_assets << build_item_asset(zones(:wings), body_id: 12)
item.swf_assets << build_item_asset(zones(:wings), body_id: 13) item.swf_assets << build_item_asset(zones(:wings), body_id: 13)
item.swf_assets << build_item_asset(zones(:wings), body_id: 4) item.swf_assets << build_item_asset(zones(:wings), body_id: 4)
# HACK: I don't understand why the first asset is triggering the hooks
# for cached fields, but the second isn't? Idk, force an update.
item.update_cached_fields
end end
it_behaves_like "a fully-modeled item" it_behaves_like "a fully-modeled item"