iknow_view_models 3.7.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b0920a06f9988d3cc846a4bf1fb592525891adb09ba44e3e7ccded40ed18c2b
-  data.tar.gz: 70267048408dbef5eaeb162465ffb2583e93fcd562f5d75d38c0ea7c7dca096d
+  metadata.gz: 1fb4421931099dc325d159573afcd9ea3529f6e29b4ac80f60d3628c9812df4c
+  data.tar.gz: 97d730c4d0a28ec9ce257906f69a1dd79e1b99c5fe025067ad57ba4ca9774931
 SHA512:
-  metadata.gz: a47fe00e8aaac20252a8508438adcf916946f4f5e4e34beabf342d530a30e5b9dbd1837c3422cd38fec8c60ecb0c0e95d1aae76a45b47fde8a66340b5346c3b4
-  data.tar.gz: d327bfab6f0c9a985aa4b44995deb51879b9e854d3bec028ebe48dc3eedd4d14158a20e960f16ab7dfcffb80d3ce4d11979f2fb46833e91a07be3f23d056fbc3
+  metadata.gz: 53aff699c92efd1c334333b2f417444498c504b2f91ea57a00741e3e6e1e259c988723b23e68a7f2c16fba1a6906786471748f5adf5dc2797ca2a4d0924f10df
+  data.tar.gz: b739f19369e3282f6e897a000f04bb56b432796acbe78ca70777e349eef8f39a4058488032f4b42eeda0c4c7c4f60e9b4dba1fba1f2cf253a3c2bd960ff753e3

data/lib/iknow_view_models/version.rb

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

data/lib/view_model/migrator.rb

@@ -39,7 +39,26 @@ class ViewModel
     def migrate!(serialization)
       references = (serialization['references'] ||= {})
 
-      migrate_tree!(serialization, references: references)
+      # First visit everything except references; there's no issue with adding
+      # new references during this.
+      migrate_tree!(serialization.except('references'), references: references)
+
+      # While visiting references itself, we need to take care that we can
+      # concurrently modify them (e.g. by adding new referenced views).
+      # Moreover, such added references must themselves be visited, as they'll
+      # be synthesized at the current version and so may need to be migrated
+      # down to the client's requested version.
+      visited_refs = []
+      loop do
+        unvisited_refs = references.keys - visited_refs
+        break if unvisited_refs.empty?
+
+        unvisited_refs.each do |ref|
+          migrate_tree!(references[ref], references: references)
+        end
+
+        visited_refs.concat(unvisited_refs)
+      end
 
       GarbageCollection.garbage_collect_references!(serialization)
 
@@ -112,10 +131,11 @@ class ViewModel
       path = @paths[view_name]
       return false unless path
 
-      # We assume that an unspecified source version is the same as the required
-      # version.
       required_version, current_version = @versions[view_name]
+      return false if source_version == current_version
 
+      # We assume that an unspecified source version is the same as the required
+      # version (i.e. the version demanded by the client request).
       unless source_version.nil? || source_version == required_version
         raise ViewModel::Migration::UnspecifiedVersionError.new(view_name, source_version)
       end

data/lib/view_model/reference.rb

@@ -29,5 +29,13 @@ class ViewModel
     def hash
       [viewmodel_class, model_id].hash
     end
+
+    # Generate a stable reference key for this viewmodel using type name and id
+    def stable_reference
+      raise RuntimeError.new('Model id required to generate a stable reference') unless model_id
+
+      hash = Digest::SHA256.base64digest("#{viewmodel_class.name}.#{model_id}")
+      "ref:h:#{hash}"
+    end
   end
 end

data/lib/view_model/references.rb

@@ -37,12 +37,13 @@ class ViewModel
 
     private
 
-    # Ensure stable reference ids for the same (persisted) viewmodels.
+    # Ensure stable reference keys for the same (persisted) viewmodels. For
+    # unpersisted viewmodels, use a counter to generate a reference key unique
+    # to this serialization.
     def new_ref!(viewmodel)
       vm_ref = viewmodel.to_reference
       if vm_ref.model_id
-        hash = Digest::SHA256.base64digest("#{vm_ref.viewmodel_class.name}.#{vm_ref.model_id}")
-        "ref:h:#{hash}"
+        vm_ref.stable_reference
       else
         format('ref:i:%06<count>d', count: (@last_ref += 1))
       end

data/test/helpers/viewmodel_spec_helpers.rb

@@ -295,6 +295,14 @@ module ViewModelSpecHelpers
     end
   end
 
+  module ReferencedList
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::List
+    def model_attributes
+      super.merge(viewmodel: ->(_v) { root! })
+    end
+  end
+
   module ParentAndHasOneChild
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::Base

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

@@ -436,16 +436,17 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       let(:migrator) { down_migrator }
       let(:subject) do
         ser = current_serialization.deep_dup
-        raise ArgumentError.new("Expected no references") if ser.has_key?('references')
+        raise ArgumentError.new('Expected no references') if ser.has_key?('references')
+
         ser
       end
 
       let(:expected_result) do
         {
           'data' => v1_serialization_data.deep_dup.deep_merge(
-            { ViewModel::MIGRATED_ATTRIBUTE => true }
+            { ViewModel::MIGRATED_ATTRIBUTE => true },
           ),
-          'references' => v1_serialization_references
+          'references' => v1_serialization_references,
         }
       end
 
@@ -460,7 +461,8 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       let(:migrator) { up_migrator }
       let(:subject) do
         ser = v1_serialization.deep_dup
-        raise ArgumentError.new("Expected references") unless ser.has_key?('references')
+        raise ArgumentError.new('Expected references') unless ser.has_key?('references')
+
         ser
       end
 
@@ -480,4 +482,96 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       end
     end
   end
+
+  describe 'concurrently inserting a reference' do
+    include ViewModelSpecHelpers::ReferencedList
+    let(:migration_versions) { { viewmodel_class => 1 } }
+
+    # Use a list with two members
+    def new_model
+      model_class.new(name: 'root',
+                      next: model_class.new(name: 'old-tail'))
+    end
+
+    # Define a down migration that matches the old tail to insert a new tail
+    # after it, and the new tail to change its name.
+    def model_attributes
+      super.merge(
+        viewmodel: ->(v) {
+          self.schema_version = 2
+
+          migrates from: 1, to: 2 do
+            down do |view, refs|
+              case view['name']
+              when 'old-tail'
+                view['next'] = { ViewModel::REFERENCE_ATTRIBUTE => 'ref:s:new_tail' }
+                refs['ref:s:new_tail'] = {
+                  ViewModel::TYPE_ATTRIBUTE    => v.view_name,
+                  ViewModel::VERSION_ATTRIBUTE => v.schema_version,
+                  'id' => 100, # entirely fake
+                  'name' => 'new-tail',
+                  'next' => nil,
+                }
+
+              when 'new-tail'
+                view['name'] = 'newer-tail'
+              end
+            end
+          end
+        },
+      )
+    end
+
+    let(:v1_serialization_data) do
+      {
+        ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+        ViewModel::VERSION_ATTRIBUTE => 1,
+        ViewModel::ID_ATTRIBUTE => viewmodel.id,
+        'name' => viewmodel.name,
+        'next' => { ViewModel::REFERENCE_ATTRIBUTE => viewmodel.next.to_reference.stable_reference },
+        ViewModel::MIGRATED_ATTRIBUTE => true,
+      }
+    end
+
+    let(:v1_serialization_references) do
+      old_tail = viewmodel.next
+      old_tail_ref = old_tail.to_reference.stable_reference
+      {
+        old_tail_ref => {
+          ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+          ViewModel::VERSION_ATTRIBUTE => 1,
+          ViewModel::ID_ATTRIBUTE => old_tail.id,
+          'name' => 'old-tail',
+          'next' => { ViewModel::REFERENCE_ATTRIBUTE => 'ref:s:new_tail' },
+          ViewModel::MIGRATED_ATTRIBUTE => true,
+        },
+        'ref:s:new_tail' => {
+          ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+          ViewModel::VERSION_ATTRIBUTE => 1,
+          ViewModel::ID_ATTRIBUTE => 100,
+          'name' => 'newer-tail',
+          'next' => nil,
+          ViewModel::MIGRATED_ATTRIBUTE => true,
+        },
+      }
+    end
+
+    let(:v1_serialization) do
+      {
+        'data' => v1_serialization_data,
+        'references' => v1_serialization_references,
+      }
+    end
+
+    describe 'downwards' do
+      let(:migrator) { down_migrator }
+      let(:subject) { current_serialization.deep_dup }
+
+      it 'migrates' do
+        migrate!
+
+        assert_equal(v1_serialization, subject)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.1
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack