Class: ViewModel::ActiveRecord::Cache::CacheWorker
- Inherits:
-
Object
- Object
- ViewModel::ActiveRecord::Cache::CacheWorker
- Defined in:
- lib/view_model/active_record/cache.rb
Defined Under Namespace
Classes: WorklistEntry
Constant Summary collapse
- SENTINEL =
Object.new
Instance Attribute Summary collapse
-
#migration_versions ⇒ Object
readonly
Returns the value of attribute migration_versions.
-
#resolved_references ⇒ Object
readonly
Returns the value of attribute resolved_references.
-
#serialize_context ⇒ Object
readonly
Returns the value of attribute serialize_context.
Instance Method Summary collapse
- #add_refs_to_worklist(cacheable_references) ⇒ Object
- #add_viewmodels_to_worklist(referenced_viewmodels) ⇒ Object
-
#cacheable_reference(viewmodel) ⇒ Object
Store VM references in the cache as viewmodel name + id pairs.
-
#find_and_preload_viewmodels(viewmodel_class, ids, available_viewmodels: nil) ⇒ Object
Resolves viewmodels for the provided ids from the database or available_viewmodels and shallowly preloads them.
-
#initialize(migration_versions:, serialize_context:) ⇒ CacheWorker
constructor
A new instance of CacheWorker.
-
#load_from_cache(viewmodel_cache, ids) ⇒ Object
Loads the specified entities from the cache and returns a hash of id=>serialized_view.
- #migrated_cache_version(viewmodel_cache) ⇒ Object
- #render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, locked: false) ⇒ Object
- #resolve_references! ⇒ Object
-
#serialize_and_cache(viewmodels) ⇒ Object
Serializes the specified preloaded viewmodels and returns a hash of id=>serialized_view.
Constructor Details
#initialize(migration_versions:, serialize_context:) ⇒ CacheWorker
Returns a new instance of CacheWorker.
85 86 87 88 89 90 91 |
# File 'lib/view_model/active_record/cache.rb', line 85 def initialize(migration_versions:, serialize_context:) @worklist = {} # Hash[type_name, Hash[id, WorklistEntry]] @resolved_references = {} # Hash[refname, json] @migration_versions = migration_versions @migrated_cache_versions = {} @serialize_context = serialize_context end |
Instance Attribute Details
#migration_versions ⇒ Object (readonly)
Returns the value of attribute migration_versions.
83 84 85 |
# File 'lib/view_model/active_record/cache.rb', line 83 def migration_versions @migration_versions end |
#resolved_references ⇒ Object (readonly)
Returns the value of attribute resolved_references.
83 84 85 |
# File 'lib/view_model/active_record/cache.rb', line 83 def resolved_references @resolved_references end |
#serialize_context ⇒ Object (readonly)
Returns the value of attribute serialize_context.
83 84 85 |
# File 'lib/view_model/active_record/cache.rb', line 83 def serialize_context @serialize_context end |
Instance Method Details
#add_refs_to_worklist(cacheable_references) ⇒ Object
301 302 303 304 305 306 307 |
# File 'lib/view_model/active_record/cache.rb', line 301 def add_refs_to_worklist(cacheable_references) cacheable_references.each do |ref_name, (type, id)| next if resolved_references.has_key?(ref_name) (@worklist[type] ||= {})[id] = WorklistEntry.new(ref_name, nil) end end |
#add_viewmodels_to_worklist(referenced_viewmodels) ⇒ Object
309 310 311 312 313 314 315 |
# File 'lib/view_model/active_record/cache.rb', line 309 def add_viewmodels_to_worklist(referenced_viewmodels) referenced_viewmodels.each do |ref_name, viewmodel| next if resolved_references.has_key?(ref_name) (@worklist[viewmodel.class.view_name] ||= {})[viewmodel.id] = WorklistEntry.new(ref_name, viewmodel) end end |
#cacheable_reference(viewmodel) ⇒ Object
Store VM references in the cache as viewmodel name + id pairs.
297 298 299 |
# File 'lib/view_model/active_record/cache.rb', line 297 def cacheable_reference(viewmodel) [viewmodel.class.view_name, viewmodel.id] end |
#find_and_preload_viewmodels(viewmodel_class, ids, available_viewmodels: nil) ⇒ Object
Resolves viewmodels for the provided ids from the database or available_viewmodels and shallowly preloads them.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/view_model/active_record/cache.rb', line 271 def find_and_preload_viewmodels(viewmodel_class, ids, available_viewmodels: nil) viewmodels = [] if available_viewmodels.present? ids = ids.reject do |id| if (vm = available_viewmodels[id]) viewmodels << vm end end end if ids.present? found = viewmodel_class.find(ids, eager_include: false, lock: 'FOR SHARE') viewmodels.concat(found) end ViewModel.preload_for_serialization(viewmodels, include_referenced: false, lock: 'FOR SHARE') viewmodels end |
#load_from_cache(viewmodel_cache, ids) ⇒ Object
Loads the specified entities from the cache and returns a hash of id=>serialized_view. Any references encountered are added to the worklist.
202 203 204 205 206 207 208 209 |
# File 'lib/view_model/active_record/cache.rb', line 202 def load_from_cache(viewmodel_cache, ids) cached_serializations = viewmodel_cache.load(ids, migrated_cache_version(viewmodel_cache)) cached_serializations.each_with_object({}) do |(id, cached_serialization), result| add_refs_to_worklist(cached_serialization[:ref_cache]) result[id] = cached_serialization[:data] end end |
#migrated_cache_version(viewmodel_cache) ⇒ Object
195 196 197 |
# File 'lib/view_model/active_record/cache.rb', line 195 def migrated_cache_version(viewmodel_cache) @migrated_cache_versions[viewmodel_cache] ||= viewmodel_cache.migrated_cache_version(migration_versions) end |
#render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, locked: false) ⇒ Object
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 |
# File 'lib/view_model/active_record/cache.rb', line 93 def render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, locked: false) viewmodel_class.transaction do root_serializations = Array.new(ids.size) # Collect input array positions for each id, allowing duplicates positions = ids.each_with_index.with_object({}) do |(id, i), h| (h[id] ||= []) << i end # If duplicates are specified, fetch each only once ids = positions.keys ids_to_render = ids.to_set if viewmodel_class < CacheableView # Load existing serializations from the cache cached_serializations = load_from_cache(viewmodel_class.viewmodel_cache, ids) cached_serializations.each do |id, data| positions[id].each do |idx| root_serializations[idx] = data end end ids_to_render.subtract(cached_serializations.keys) # If initial root viewmodels were provided, call hooks on any # viewmodels which were rendered from the cache to ensure that the # root is visible (in isolation). Other than this, no traversal # callbacks are performed for cache-rendered views. This particularly # requires care for references: if a visible view may refer to # non-visible cacheable views, those referenced views will not be # access control checked. initial_viewmodels&.each do |v| next unless cached_serializations.has_key?(v.id) serialize_context.run_callback(ViewModel::Callbacks::Hook::BeforeVisit, v) serialize_context.run_callback(ViewModel::Callbacks::Hook::AfterVisit, v) end end # Render remaining views. If initial viewmodels have been locked, we may # use them to serialize from, otherwise we must reload with share lock # in find_and_preload. available_viewmodels = if locked initial_viewmodels&.each_with_object({}) do |vm, h| h[vm.id] = vm if ids_to_render.include?(vm.id) end end viewmodels = find_and_preload_viewmodels(viewmodel_class, ids_to_render.to_a, available_viewmodels: available_viewmodels) loaded_serializations = serialize_and_cache(viewmodels) loaded_serializations.each do |id, data| positions[id].each do |idx| root_serializations[idx] = data end end # recursively resolve referenced views self.resolve_references! [root_serializations, self.resolved_references] end end |
#resolve_references! ⇒ Object
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 |
# File 'lib/view_model/active_record/cache.rb', line 160 def resolve_references! @serialize_context = serialize_context.for_references while @worklist.present? type_name, required_entries = @worklist.shift viewmodel_class = ViewModel::Registry.for_view_name(type_name) required_entries.each do |_id, entry| @resolved_references[entry.ref_name] = SENTINEL end if viewmodel_class < CacheableView cached_serializations = load_from_cache(viewmodel_class.viewmodel_cache, required_entries.keys) cached_serializations.each do |id, data| ref_name = required_entries.delete(id).ref_name @resolved_references[ref_name] = data end end # Load remaining entries from database available_viewmodels = required_entries.each_with_object({}) do |(id, entry), h| h[id] = entry.viewmodel if entry.viewmodel end viewmodels = find_and_preload_viewmodels(viewmodel_class, required_entries.keys, available_viewmodels: available_viewmodels) loaded_serializations = serialize_and_cache(viewmodels) loaded_serializations.each do |id, data| ref_name = required_entries[id].ref_name @resolved_references[ref_name] = data end end end |
#serialize_and_cache(viewmodels) ⇒ Object
Serializes the specified preloaded viewmodels and returns a hash of id=>serialized_view. If the viewmodel type is cacheable, it will be added to the cache. Any references encountered during serialization are added to the worklist.
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 |
# File 'lib/view_model/active_record/cache.rb', line 215 def serialize_and_cache(viewmodels) viewmodels.each_with_object({}) do |viewmodel, result| builder = Jbuilder.new do |json| ViewModel.serialize(viewmodel, json, serialize_context: serialize_context) end # viewmodels referenced from roots referenced_viewmodels = serialize_context.extract_referenced_views! if migration_versions.present? migrator = ViewModel::DownMigrator.new(migration_versions) # This migration isn't able to affect the contents of referenced # views, only their presence. The references will be themselves # rendered (and migrated) independently later. We mark the dummy # references provided to exclude their partial contents from being # themselves migrated. dummy_references = referenced_viewmodels.transform_values do |ref_vm| { ViewModel::TYPE_ATTRIBUTE => ref_vm.class.view_name, ViewModel::VERSION_ATTRIBUTE => ref_vm.class.schema_version, ViewModel::ID_ATTRIBUTE => ref_vm.id, ViewModel::Migrator::EXCLUDE_FROM_MIGRATION => true, }.freeze end migrator.migrate!({ 'data' => builder.attributes!, 'references' => dummy_references }) # Removed dummy references can be removed from referenced_viewmodels. referenced_viewmodels.keep_if { |k, _| dummy_references.has_key?(k) } # Introduced dummy references cannot be handled. if dummy_references.keys != referenced_viewmodels.keys version = migration_versions[viewmodel.class] raise ViewModel::Error.new( status: 500, detail: "Down-migration for cacheable view #{viewmodel.class} to v#{version} must not introduce new shared references") end end data_serialization = builder.target! add_viewmodels_to_worklist(referenced_viewmodels) if viewmodel.class < CacheableView cacheable_references = referenced_viewmodels.transform_values { |vm| cacheable_reference(vm) } target_cache = viewmodel.class.viewmodel_cache target_cache.store(viewmodel.id, migrated_cache_version(target_cache), data_serialization, cacheable_references) end result[viewmodel.id] = data_serialization end end |