iknow_view_models 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85aa5f3dd882b989e6a4d1fa8d5d89be347f5f3c215af86851f1ef086d583472
-  data.tar.gz: d202810ca019d425b0de503b7a077d164d5919dc9206cf069e93b37ddf432334
+  metadata.gz: 40eb8cc78ae998113eac37ef9cd944ecefc1c4b0a71a492944ac88ff2bfa4077
+  data.tar.gz: cb7d430a809687598e365e54a0312e97fc6ee1938cfdd1c4f9f1bd924e8364a5
 SHA512:
-  metadata.gz: 3005ecb2044fd83003ccd444fb2b22d9787b74c929f157573baa084d4d3dff1b2f24d86e30f1ee9bd1e03604a4a0f9a57ec7431cadaea28faa45eda235dbcd28
-  data.tar.gz: 82971047b73442cbccaf9e3e80f1386dc373329b91f94260f2daeeb5794f99b3502cc47b911a62da38f7d0932b9fea49ae72319de9fb2d79f8be6035e0a34110
+  metadata.gz: dd1c4215f6e9bafaf68c618d4ba59541089016d4dcea45ab90892489cc6ada0183f95a6d07ae88899fc54d5a9bf37a3619e70bc62c54ed9c5b9de57eeec5f37f
+  data.tar.gz: e1cd93bf28d4ad96ac347effeb96d9bbbd6a1ec9a09944091d8127555b1c22ca2e97bfa7f5ce670f86cf42647b06d3e1da13a842935eb0bd39e44c303af666ab

data/lib/iknow_view_models/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowViewModels
-  VERSION = '3.10.0'
+  VERSION = '3.11.0'
 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/lib/view_model/active_record/controller.rb

@@ -56,9 +56,14 @@ module ViewModel::ActiveRecord::Controller
   end
 
   def destroy(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context)
+    viewmodel_ids = parse_param(
+      :id, with: IknowParams::Serializer::ArrayOf.new(ViewmodelIdSerializer, allow_singleton: true))
+
     viewmodel_class.transaction do
-      view = viewmodel_class.find(viewmodel_id, eager_include: false)
-      view.destroy!(deserialize_context: deserialize_context)
+      views = viewmodel_class.find(viewmodel_ids, eager_include: false)
+      views.each do |view|
+        view.destroy!(deserialize_context: deserialize_context)
+      end
     end
     render_viewmodel(nil)
   end
@@ -91,8 +96,28 @@ module ViewModel::ActiveRecord::Controller
 
   private
 
+  # Viewmodel ids are permitted to be either integers or strings
+  class ViewmodelIdSerializer < IknowParams::Serializer
+    def initialize
+      super(::Object)
+    end
+
+    def load(val)
+      case val
+      when ::Integer, ::String
+        val
+      else
+        raise IknowParams::Serializer::LoadError.new(
+                "Incorrect type for #{self.class.name}: #{val.inspect}:#{val.class.name}")
+      end
+    end
+
+    set_singleton!
+    json_value!
+  end
+
   def viewmodel_id
-    parse_param(:id)
+    parse_param(:id, with: ViewmodelIdSerializer)
   end
 
   def migrated_deep_schema_version

data/lib/view_model/active_record/controller_base.rb

@@ -156,11 +156,13 @@ module ActionDispatch
                   name_route = { as: '' } # Only one route may take the name
                   post('', action: :create, **name_route.extract!(:as)) unless except.include?(:create) || !add_shallow_routes
                   get('',  action: :index,  **name_route.extract!(:as)) unless except.include?(:index)  || !add_shallow_routes
+                  delete('', action: :destroy, as: :bulk_delete) unless except.include?(:destroy) || !add_shallow_routes
                 end
               end
             else
               collection do
                 get('', action: :index, as: '') unless except.include?(:index)
+                delete('', action: :destroy, as: :bulk_delete) unless except.include?(:destroy)
               end
             end
           end

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

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

@@ -167,6 +167,22 @@ class ViewModel::ActiveRecord::ControllerTest < ActiveSupport::TestCase
   end
 
   def test_destroy
+    other_parent = make_parent
+    parentcontroller = ParentController.new(params: { id: [@parent.id, other_parent.id] })
+    parentcontroller.invoke(:destroy)
+
+    assert_equal(200, parentcontroller.status)
+
+    assert(Parent.where(id: @parent.id).blank?, "record doesn't exist after delete")
+    assert(Parent.where(id: other_parent.id).blank?, "record doesn't exist after delete")
+
+    assert_equal({ 'data' => nil },
+                 parentcontroller.hash_response)
+
+    assert_all_hooks_nested_inside_parent_hook(parentcontroller.hook_trace)
+  end
+
+  def test_batch_destroy
     parentcontroller = ParentController.new(params: { id: @parent.id })
     parentcontroller.invoke(:destroy)
 

metadata

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