iknow_view_models 3.10.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85aa5f3dd882b989e6a4d1fa8d5d89be347f5f3c215af86851f1ef086d583472
-  data.tar.gz: d202810ca019d425b0de503b7a077d164d5919dc9206cf069e93b37ddf432334
+  metadata.gz: 417eb3615156fa48cf438ead03e2ea33e323c5baa7d411b1e0fafcea5050acb1
+  data.tar.gz: cdede3ad865389a0d006725819595aec6da1ea417e9d061452ef3198a39af3d8
 SHA512:
-  metadata.gz: 3005ecb2044fd83003ccd444fb2b22d9787b74c929f157573baa084d4d3dff1b2f24d86e30f1ee9bd1e03604a4a0f9a57ec7431cadaea28faa45eda235dbcd28
-  data.tar.gz: 82971047b73442cbccaf9e3e80f1386dc373329b91f94260f2daeeb5794f99b3502cc47b911a62da38f7d0932b9fea49ae72319de9fb2d79f8be6035e0a34110
+  metadata.gz: ada26778b54ffb60a825d408fe40f05c8a4aa93cbac7b5519b2338b5afb4cadfda0d1eb7b359b65584f88fbb9cadea4a35a7d2ba0aad9fb8e4d8ec9d5f894e03
+  data.tar.gz: b70d2b42d4a599c3d284dbb96c4506c8ff7b6104108ebcb7126c554fcd671eb0bad04dc4df5a1006f76af272a71c5ca46f54736bf4961821dd7f22160d46fada

data/lib/iknow_view_models/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowViewModels
-  VERSION = '3.10.0'
+  VERSION = '3.10.1'
 end

data/lib/view_model/active_record/cache.rb

@@ -30,8 +30,21 @@ class ViewModel::ActiveRecord::Cache
     end
 
     def render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, migration_versions: {}, locked: false, serialize_context: viewmodel_class.new_serialize_context)
-      worker = CacheWorker.new(migration_versions: migration_versions, serialize_context: serialize_context)
-      worker.render_from_cache(viewmodel_class, ids, initial_viewmodels: initial_viewmodels, locked: locked)
+      ignore_existing = false
+      begin
+        worker = CacheWorker.new(migration_versions: migration_versions, serialize_context: serialize_context, ignore_existing: ignore_existing)
+        worker.render_from_cache(viewmodel_class, ids, initial_viewmodels: initial_viewmodels, locked: locked)
+      rescue StaleCachedReference
+        # If the cache contents contained a unresolvable stale reference, retry
+        # while ignoring existing cached values (thereby updating the cache). This
+        # will have the side-effect of duplicate Before/AfterVisit callbacks.
+        if ignore_existing
+          raise
+        else
+          ignore_existing = true
+          retry
+        end
+      end
     end
   end
 
@@ -76,18 +89,25 @@ class ViewModel::ActiveRecord::Cache
                                  migration_versions: migration_versions, serialize_context: serialize_context)
   end
 
+  class StaleCachedReference < StandardError
+    def initialize(error)
+      super("Cached value contained stale reference: #{error.message}")
+    end
+  end
+
   class CacheWorker
     SENTINEL = Object.new
     WorklistEntry = Struct.new(:ref_name, :viewmodel)
 
     attr_reader :migration_versions, :serialize_context, :resolved_references
 
-    def initialize(migration_versions:, serialize_context:)
+    def initialize(migration_versions:, serialize_context:, ignore_existing: false)
       @worklist                = {} # Hash[type_name, Hash[id, WorklistEntry]]
       @resolved_references     = {} # Hash[refname, json]
       @migration_versions      = migration_versions
       @migrated_cache_versions = {}
       @serialize_context       = serialize_context
+      @ignore_existing         = ignore_existing
     end
 
     def render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, locked: false)
@@ -104,7 +124,7 @@ class ViewModel::ActiveRecord::Cache
 
         ids_to_render = ids.to_set
 
-        if viewmodel_class < CacheableView
+        if viewmodel_class < CacheableView && !@ignore_existing
           # Load existing serializations from the cache
           cached_serializations = load_from_cache(viewmodel_class.viewmodel_cache, ids)
           cached_serializations.each do |id, data|
@@ -168,7 +188,7 @@ class ViewModel::ActiveRecord::Cache
           @resolved_references[entry.ref_name] = SENTINEL
         end
 
-        if viewmodel_class < CacheableView
+        if viewmodel_class < CacheableView && !@ignore_existing
           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
@@ -181,8 +201,18 @@ class ViewModel::ActiveRecord::Cache
           h[id] = entry.viewmodel if entry.viewmodel
         end
 
-        viewmodels = find_and_preload_viewmodels(viewmodel_class, required_entries.keys,
-                                                 available_viewmodels: available_viewmodels)
+        viewmodels =
+          begin
+            find_and_preload_viewmodels(viewmodel_class, required_entries.keys,
+                                        available_viewmodels: available_viewmodels)
+          rescue ViewModel::DeserializationError::NotFound => e
+            # We encountered a reference to an entity that does not exist.
+            # If this reference was potentially found in cached data, it
+            # could be stale: we can retry without using the cache.
+            # If the reference was obtained directly, it indicates invalid
+            # data such as an invalid foreign key, and we cannot recover.
+            raise StaleCachedReference.new(e)
+          end
 
         loaded_serializations = serialize_and_cache(viewmodels)
         loaded_serializations.each do |id, data|

data/test/unit/view_model/active_record/cache_test.rb

@@ -209,11 +209,27 @@ class ViewModel::ActiveRecord
         end
 
         it 'returns the right serialization with provided locked initial viewmodel' do
-          locked_root_view = viewmodel_class.new(model_class.lock("FOR SHARE").find(root.id))
+          locked_root_view = viewmodel_class.new(model_class.lock('FOR SHARE').find(root.id))
           fetched_result = parse_result(fetch_with_cache(initial_viewmodels: [locked_root_view], locked: true))
 
           value(fetched_result).must_equal(serialize_from_database)
         end
+
+        it 'handles a stale cached reference' do
+          # Fetch to populate the cache
+          initial_result = parse_result(fetch_with_cache)
+          value(initial_result).must_equal(serialize_from_database)
+
+          # Destroy the shared child and its cache without invalidating the cached parent cache
+          root.update_columns(shared_id: nil)
+          shared.destroy!
+          shared_viewmodel_class.viewmodel_cache.clear
+
+          fetched_result = parse_result(fetch_with_cache)
+          value(fetched_result).must_equal(serialize_from_database)
+          fetched_view = fetched_result.first.first
+          value(fetched_view['shared']).must_be_nil
+        end
       end
 
       describe 'with migrations' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.10.1
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack