Skip to content

Commit bcf3358

Browse files
zaarothbf4
authored andcommitted
Ensuring read_multi works with fragment cache. (#1814)
* Ensuring read_multi works with fragment cache.
1 parent 32a3b53 commit bcf3358

File tree

3 files changed

+40
-8
lines changed

3 files changed

+40
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Breaking changes:
77
Features:
88

99
Fixes:
10+
- [#1814] (https://github.com/rails-api/active_model_serializers/pull/1814) Ensuring read_multi works with fragment cache
1011

1112
Misc:
1213

lib/active_model/serializer/caching.rb

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ def object_cache_keys(collection_serializer, adapter_instance, include_directive
197197
def object_cache_key(serializer, adapter_instance)
198198
return unless serializer.present? && serializer.object.present?
199199

200-
serializer.class.cache_enabled? ? serializer.cache_key(adapter_instance) : nil
200+
(serializer.class.cache_enabled? || serializer.class.fragment_cache_enabled?) ? serializer.cache_key(adapter_instance) : nil
201201
end
202202
end
203203

@@ -211,7 +211,7 @@ def fetch_attributes(fields, cached_attributes, adapter_instance)
211211
end
212212
end
213213
elsif serializer_class.fragment_cache_enabled?
214-
fetch_attributes_fragment(adapter_instance)
214+
fetch_attributes_fragment(adapter_instance, cached_attributes)
215215
else
216216
attributes(fields, true)
217217
end
@@ -230,7 +230,8 @@ def fetch(adapter_instance, cache_options = serializer_class._cache_options)
230230
# 1. Determine cached fields from serializer class options
231231
# 2. Get non_cached_fields and fetch cache_fields
232232
# 3. Merge the two hashes using adapter_instance#fragment_cache
233-
def fetch_attributes_fragment(adapter_instance)
233+
# rubocop:disable Metrics/AbcSize
234+
def fetch_attributes_fragment(adapter_instance, cached_attributes = {})
234235
serializer_class._cache_options ||= {}
235236
serializer_class._cache_options[:key] = serializer_class._cache_key if serializer_class._cache_key
236237
fields = serializer_class.fragmented_attributes
@@ -243,15 +244,17 @@ def fetch_attributes_fragment(adapter_instance)
243244
cached_fields = fields[:cached].dup
244245
key = cache_key(adapter_instance)
245246
cached_hash =
246-
serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
247-
hash = attributes(cached_fields, true)
248-
include_directive = JSONAPI::IncludeDirective.new(cached_fields - hash.keys)
249-
hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
247+
cached_attributes.fetch(key) do
248+
serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
249+
hash = attributes(cached_fields, true)
250+
include_directive = JSONAPI::IncludeDirective.new(cached_fields - hash.keys)
251+
hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
252+
end
250253
end
251-
252254
# Merge both results
253255
adapter_instance.fragment_cache(cached_hash, non_cached_hash)
254256
end
257+
# rubocop:enable Metrics/AbcSize
255258

256259
def cache_key(adapter_instance)
257260
return @cache_key if defined?(@cache_key)

test/cache_test.rb

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,34 @@ def test_fetch_attributes_from_cache
321321
end
322322
end
323323

324+
def test_cache_read_multi_with_fragment_cache_enabled
325+
post_serializer = Class.new(ActiveModel::Serializer) do
326+
cache except: [:body]
327+
end
328+
329+
serializers = ActiveModel::Serializer::CollectionSerializer.new([@post, @post], serializer: post_serializer)
330+
331+
Timecop.freeze(Time.current) do
332+
# Warming up.
333+
options = {}
334+
adapter_options = {}
335+
adapter_instance = ActiveModelSerializers::Adapter::Attributes.new(serializers, adapter_options)
336+
serializers.serializable_hash(adapter_options, options, adapter_instance)
337+
338+
# Should find something with read_multi now
339+
adapter_options = {}
340+
serializers.serializable_hash(adapter_options, options, adapter_instance)
341+
cached_attributes = adapter_options.fetch(:cached_attributes)
342+
343+
include_directive = ActiveModelSerializers.default_include_directive
344+
manual_cached_attributes = ActiveModel::Serializer.cache_read_multi(serializers, adapter_instance, include_directive)
345+
346+
refute_equal 0, cached_attributes.size
347+
refute_equal 0, manual_cached_attributes.size
348+
assert_equal manual_cached_attributes, cached_attributes
349+
end
350+
end
351+
324352
def test_serializer_file_path_on_nix
325353
path = '/Users/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb'
326354
caller_line = "#{path}:1:in `<top (required)>'"

0 commit comments

Comments
 (0)