iknow_view_models 3.9.2 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13912eaa6913049d8b8a5ac98d135d25f23abbfedf3046ba9c1a12ee92bae45d
-  data.tar.gz: 9d8c5abafd90bac5cfa955aa152b89d03cd0657f3923edb5e7ef5e534cd5e4a1
+  metadata.gz: 417eb3615156fa48cf438ead03e2ea33e323c5baa7d411b1e0fafcea5050acb1
+  data.tar.gz: cdede3ad865389a0d006725819595aec6da1ea417e9d061452ef3198a39af3d8
 SHA512:
-  metadata.gz: 3072dd149b35d236ca79f0a2a22232bf30274a05a141ce77f74358a1c2ac9b72f7c877879bbff1508c71fae477d0ebdff4daf2c35347bf71e07cc3811e4227c2
-  data.tar.gz: d42c834cf4e569b8685a9e787fc9ea01de1bc656f5f5cfd6255228806556823368f2685913414b68c84d23474b19d33329803d89c47525c91194f1b2a88d2b26
+  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.9.2'
+  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/lib/view_model/active_record/controller.rb

@@ -3,6 +3,7 @@
 require 'view_model/active_record/controller_base'
 require 'view_model/active_record/collection_nested_controller'
 require 'view_model/active_record/singular_nested_controller'
+require 'view_model/controller/migration_versions'
 
 # Controller for accessing an ViewModel::ActiveRecord
 # Provides for the following routes:
@@ -16,8 +17,7 @@ module ViewModel::ActiveRecord::Controller
   include ViewModel::ActiveRecord::ControllerBase
   include ViewModel::ActiveRecord::CollectionNestedController
   include ViewModel::ActiveRecord::SingularNestedController
-
-  MIGRATION_VERSION_HEADER = 'X-ViewModel-Versions'
+  include ViewModel::Controller::MigrationVersions
 
   def show(scope: nil, viewmodel_class: self.viewmodel_class, serialize_context: new_serialize_context(viewmodel_class: viewmodel_class))
     view = nil
@@ -95,51 +95,6 @@ module ViewModel::ActiveRecord::Controller
     parse_param(:id)
   end
 
-  def migration_versions
-    @migration_versions ||=
-      begin
-        specified_migration_versions.reject do |viewmodel_class, required_version|
-          viewmodel_class.schema_version == required_version
-        end.freeze
-      end
-  end
-
-  def specified_migration_versions
-    @specified_migration_versions ||=
-      begin
-        version_spec =
-          if params.include?(:versions)
-            params[:versions]
-          elsif request.headers.include?(MIGRATION_VERSION_HEADER)
-            begin
-              JSON.parse(request.headers[MIGRATION_VERSION_HEADER])
-            rescue JSON::ParserError
-              raise ViewModel::Error.new(status: 400, detail: "Invalid JSON in #{MIGRATION_VERSION_HEADER}")
-            end
-          else
-            {}
-          end
-
-        versions =
-          IknowParams::Parser.parse_value(
-            version_spec,
-            with: IknowParams::Serializer::HashOf.new(
-              IknowParams::Serializer::String, IknowParams::Serializer::Integer))
-
-        migration_versions = {}
-
-        versions.each do |view_name, required_version|
-          viewmodel_class = ViewModel::Registry.for_view_name(view_name)
-          migration_versions[viewmodel_class] = required_version
-        rescue ViewModel::DeserializationError::UnknownView
-          # Ignore requests to migrate types that no longer exist
-          next
-        end
-
-        migration_versions.freeze
-      end
-  end
-
   def migrated_deep_schema_version
     ViewModel::Migrator.migrated_deep_schema_version(viewmodel_class, migration_versions, include_referenced: true)
   end

data/lib/view_model/controller/migration_versions.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ViewModel::Controller::MigrationVersions
+  extend ActiveSupport::Concern
+
+  MIGRATION_VERSION_HEADER = 'X-ViewModel-Versions'
+
+  def migration_versions
+    @migration_versions ||=
+      begin
+        specified_migration_versions.reject do |viewmodel_class, required_version|
+          viewmodel_class.schema_version == required_version
+        end.freeze
+      end
+  end
+
+  def specified_migration_versions
+    @specified_migration_versions ||=
+      begin
+        version_spec =
+          if params.include?(:versions)
+            params[:versions]
+          elsif request.headers.include?(MIGRATION_VERSION_HEADER)
+            begin
+              JSON.parse(request.headers[MIGRATION_VERSION_HEADER])
+            rescue JSON::ParserError
+              raise ViewModel::Error.new(status: 400, detail: "Invalid JSON in #{MIGRATION_VERSION_HEADER}")
+            end
+          else
+            {}
+          end
+
+        versions =
+          IknowParams::Parser.parse_value(
+            version_spec,
+            with: IknowParams::Serializer::HashOf.new(
+              IknowParams::Serializer::String, IknowParams::Serializer::Integer))
+
+        migration_versions = {}
+
+        versions.each do |view_name, required_version|
+          viewmodel_class = ViewModel::Registry.for_view_name(view_name)
+          migration_versions[viewmodel_class] = required_version
+        rescue ViewModel::DeserializationError::UnknownView
+          # Ignore requests to migrate types that no longer exist
+          next
+        end
+
+        migration_versions.freeze
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.9.2
+  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
@@ -428,6 +428,7 @@ files:
 - lib/view_model/changes.rb
 - lib/view_model/config.rb
 - lib/view_model/controller.rb
+- lib/view_model/controller/migration_versions.rb
 - lib/view_model/deserialization_error.rb
 - lib/view_model/deserialize_context.rb
 - lib/view_model/error.rb