iknow_view_models 3.2.10 → 3.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 280c8d764916ec30bb500e2f0e982131416d27ea51a3a25d1cd7e3908bb4ad5b
-  data.tar.gz: 50d202b87cde141ac58ad82a5de6b73332f9b60a71c23fbbd378ba6c1def8184
+  metadata.gz: 2a75096a1b8ac47eee4ff5b2a303a0d447cfe8e93668f579bb697b863947eaa5
+  data.tar.gz: ca0edc9b15a0b436d36d7b12dbd8f4255008ad4a6cd6d1ed23a352a989013fa1
 SHA512:
-  metadata.gz: 51333e3292118de4b71e8869ea4843be804ad2d24ce0c7296918c3f09b0df93740561afeb466b4a8874a1b5b667922b664745e994151b8fe47ce458bb087d14d
-  data.tar.gz: 999d1feb717d4ef5ce11b400abf67772c5b70fd7c91cf3e328f14e5ff66a373b7c98aa5f701cb436cf4bf7df448bc553fca96131de570cead59734e8131c4788
+  metadata.gz: 683a95fe51734a420f87f4709942314ec03ee32a8a95a63487bb4495eaad7a61c0f6ba4216d67ee31f33acf9f593607833eebcd3fd9e1dfd8a4f3440a337f249
+  data.tar.gz: e889492e1e0b76a3f8b3ed8775c16fa6f67f6a45eb9ed14e09f53f41b3dc6a1675d093eec75ba2b94d79567238d22d4996236a5388dafb5ee078fb9760d0c97e

data/lib/iknow_view_models/version.rb

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

data/lib/view_model.rb

@@ -377,3 +377,4 @@ require 'view_model/deserialize_context'
 require 'view_model/changes'
 require 'view_model/schemas'
 require 'view_model/error_view'
+require 'view_model/garbage_collection'

data/lib/view_model/active_record/cache.rb

@@ -177,28 +177,27 @@ class ViewModel::ActiveRecord::Cache
           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 given the chance to inspect/alter the contents
-          # of referenced views, only their presence: it's strictly less
-          # powerful than migrations on a fully serialized tree, as the only
-          # possible action on a referenced child is to delete it. The effect of
-          # this is that for sufficiently complex migrations where a parent view
-          # must introduce children or alter the contents of its referenced
-          # children, we may have to avoid caching while the migration is in
-          # use.
+          # 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!(builder.attributes!, references: dummy_references)
+          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) }

data/lib/view_model/active_record/controller.rb

@@ -71,7 +71,7 @@ module ViewModel::ActiveRecord::Controller
     super.tap do |update_hash, refs|
       if migration_versions.present?
         migrator = ViewModel::UpMigrator.new(migration_versions)
-        migrator.migrate!([update_hash, refs], references: refs)
+        migrator.migrate!({ 'data' => update_hash, 'references' => refs })
       end
     end
   end
@@ -84,7 +84,7 @@ module ViewModel::ActiveRecord::Controller
       if migration_versions.present?
         tree = jbuilder.attributes!
         migrator = ViewModel::DownMigrator.new(migration_versions)
-        migrator.migrate!(tree, references: tree['references'])
+        migrator.migrate!(tree)
       end
     end
   end

data/lib/view_model/garbage_collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class ViewModel::GarbageCollection
+  class << self
+    def garbage_collect_references!(serialization)
+      return unless serialization.has_key?('references')
+
+      roots      = serialization.except('references')
+      references = serialization['references']
+
+      worklist = Set.new(collect_references(roots))
+      visited  = Set.new
+
+      while (live = worklist.first)
+        worklist.delete(live)
+        visited << live
+        collect_references(references[live]) do |ref|
+          worklist << ref unless visited.include?(ref)
+        end
+      end
+
+      references.keep_if { |ref, _val| visited.include?(ref) }
+    end
+
+    private
+
+    ## yield each reference encountered in tree
+    def collect_references(tree, &block)
+      return enum_for(__method__, tree) unless block_given?
+
+      case tree
+      when Hash
+        if tree.size == 1 && (ref = tree[ViewModel::REFERENCE_ATTRIBUTE])
+          block.(ref)
+        else
+          tree.each_value { |t| collect_references(t, &block) }
+        end
+      when Array
+        tree.each { |t| collect_references(t, &block) }
+      end
+    end
+  end
+end

data/lib/view_model/migrator.rb

@@ -2,6 +2,8 @@
 
 class ViewModel
   class Migrator
+    EXCLUDE_FROM_MIGRATION = '_exclude_from_migration'
+
     class << self
       def migrated_deep_schema_version(viewmodel_class, required_versions, include_referenced: true)
         deep_schema_version = viewmodel_class.deep_schema_version(include_referenced: include_referenced)
@@ -34,27 +36,37 @@ class ViewModel
       end
     end
 
-    def migrate!(node, references:)
+    def migrate!(serialization)
+      migrate_tree!(serialization, references: serialization['references'] || {})
+      GarbageCollection.garbage_collect_references!(serialization)
+    end
+
+    private
+
+    def migrate_tree!(node, references:)
       case node
       when Hash
         if (type = node[ViewModel::TYPE_ATTRIBUTE])
           version = node[ViewModel::VERSION_ATTRIBUTE]
 
+          # We allow subtrees to be excluded from migration. This is used
+          # internally to permit stub references that are not a full
+          # serialization of the referenced type: see ViewModel::Cache.
+          return if node[EXCLUDE_FROM_MIGRATION]
+
           if migrate_viewmodel!(type, version, node, references)
             node[ViewModel::MIGRATED_ATTRIBUTE] = true
           end
         end
 
         node.each_value do |child|
-          migrate!(child, references: references)
+          migrate_tree!(child, references: references)
         end
       when Array
-        node.each { |child| migrate!(child, references: references) }
+        node.each { |child| migrate_tree!(child, references: references) }
       end
     end
 
-    private
-
     def migrate_viewmodel!(_view_name, _version, _view_hash, _references)
       raise RuntimeError.new('abstract method')
     end

data/test/helpers/viewmodel_spec_helpers.rb

@@ -141,10 +141,10 @@ module ViewModelSpecHelpers
     end
   end
 
-  module ParentAndBelongsToChildWithMigration
+  module ParentAndChildMigrations
     extend ActiveSupport::Concern
-    include ViewModelSpecHelpers::ParentAndBelongsToChild
-    def model_attributes
+  
+  def model_attributes
       super.merge(
         schema: ->(t) { t.integer :new_field, default: 1, null: false },
         viewmodel: ->(_v) {
@@ -206,6 +206,12 @@ module ViewModelSpecHelpers
     end
   end
 
+  module ParentAndBelongsToChildWithMigration
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndBelongsToChild
+    include ViewModelSpecHelpers::ParentAndChildMigrations
+  end
+
   module ParentAndSharedBelongsToChild
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::ParentAndBelongsToChild

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

@@ -122,7 +122,7 @@ class ViewModel::ActiveRecord
 
       if migration_versions.present?
         migrator = ViewModel::DownMigrator.new(migration_versions)
-        migrator.migrate!([data, refs], references: refs)
+        migrator.migrate!({ 'data' => data, 'references' => refs })
       end
 
       [data, refs]

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

@@ -24,25 +24,39 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
   let(:up_migrator) { ViewModel::UpMigrator.new(migration_versions) }
 
   def migrate!
-    migrator.migrate!(subject, references: {})
+    migrator.migrate!(subject)
   end
 
-  let(:current_serialization) { ViewModel.serialize_to_hash(viewmodel) }
+  let(:current_serialization) do
+    ctx = viewmodel_class.new_serialize_context
+    view = ViewModel.serialize_to_hash(viewmodel, serialize_context: ctx)
+    refs = ctx.serialize_references_to_hash
+    { 'data' => view, 'references' => refs }
+  end
 
-  let(:v2_serialization) do
+  let(:v2_serialization_data) do
     {
-      ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
-      ViewModel::VERSION_ATTRIBUTE => 2,
-      ViewModel::ID_ATTRIBUTE => viewmodel.id,
-      'name' => viewmodel.name,
-      'old_field' => 1,
-      'child' => {
-        ViewModel::TYPE_ATTRIBUTE => child_viewmodel_class.view_name,
+        ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
         ViewModel::VERSION_ATTRIBUTE => 2,
-        ViewModel::ID_ATTRIBUTE => viewmodel.child.id,
-        'name' => viewmodel.child.name,
-        'former_field' => 'former_value',
-      },
+        ViewModel::ID_ATTRIBUTE => viewmodel.id,
+        'name' => viewmodel.name,
+        'old_field' => 1,
+        'child' => {
+          ViewModel::TYPE_ATTRIBUTE => child_viewmodel_class.view_name,
+          ViewModel::VERSION_ATTRIBUTE => 2,
+          ViewModel::ID_ATTRIBUTE => viewmodel.child.id,
+          'name' => viewmodel.child.name,
+          'former_field' => 'former_value',
+        },
+    }
+  end
+
+  let(:v2_serialization_references) { {} }
+
+  let(:v2_serialization) do
+    {
+      'data' => v2_serialization_data,
+      'references' => v2_serialization_references,
     }
   end
 
@@ -56,14 +70,15 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       let(:expected_result) do
         v2_serialization.deep_merge(
           {
-            ViewModel::MIGRATED_ATTRIBUTE => true,
-            'old_field' => -1,
-            'child' => {
+            'data' => {
               ViewModel::MIGRATED_ATTRIBUTE => true,
-              'former_field' => 'reconstructed',
+              'old_field' => -1,
+              'child' => {
+                ViewModel::MIGRATED_ATTRIBUTE => true,
+                'former_field' => 'reconstructed',
+              },
             },
-          },
-        )
+          })
       end
 
       it 'migrates' do
@@ -85,15 +100,21 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
 
     describe 'upwards' do
       let(:migrator) { up_migrator }
-      let(:subject) { v2_serialization.deep_dup }
+      let(:subject_data) { v2_serialization_data.deep_dup }
+      let(:subject_references) { v2_serialization_references.deep_dup }
+      let(:subject) { { 'data' => subject_data, 'references' => subject_references } }
 
       let(:expected_result) do
         current_serialization.deep_merge(
-          ViewModel::MIGRATED_ATTRIBUTE => true,
-          'new_field' => 3,
-          'child' => {
-            ViewModel::MIGRATED_ATTRIBUTE => true,
-          },
+          {
+            'data' => {
+              ViewModel::MIGRATED_ATTRIBUTE => true,
+              'new_field' => 3,
+              'child' => {
+                ViewModel::MIGRATED_ATTRIBUTE => true,
+              },
+            },
+          }
         )
       end
 
@@ -104,9 +125,8 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       end
 
       describe 'with version unspecified' do
-        let(:subject) do
-          v2_serialization
-            .except(ViewModel::VERSION_ATTRIBUTE)
+        let(:subject_data) do
+          v2_serialization_data.except(ViewModel::VERSION_ATTRIBUTE)
         end
 
         it 'treats it as the requested version' do
@@ -116,8 +136,8 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       end
 
       describe 'with a version not in the specification' do
-        let(:subject) do
-          v2_serialization
+        let(:subject_data) do
+          v2_serialization_data
             .except('old_field')
             .deep_merge(ViewModel::VERSION_ATTRIBUTE => 3, 'mid_field' => 1)
         end
@@ -132,8 +152,8 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       describe 'from an unreachable version' do
         let(:migration_versions) { { viewmodel_class => 2, child_viewmodel_class => 1 } }
 
-        let(:subject) do
-          v2_serialization.deep_merge(
+        let(:subject_data) do
+          v2_serialization_data.deep_merge(
             'child' => { ViewModel::VERSION_ATTRIBUTE => 1 },
           )
         end
@@ -148,8 +168,8 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       describe 'in an undefined direction' do
         let(:migration_versions) { { viewmodel_class => 1, child_viewmodel_class => 2 } }
 
-        let(:subject) do
-          v2_serialization.except('old_field').merge(ViewModel::VERSION_ATTRIBUTE => 1)
+        let(:subject_data) do
+          v2_serialization_data.except('old_field').merge(ViewModel::VERSION_ATTRIBUTE => 1)
         end
 
         it 'raises' do
@@ -161,6 +181,75 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
     end
   end
 
+  describe 'garbage collection' do
+    include ViewModelSpecHelpers::ParentAndSharedBelongsToChild
+
+    # current (v2) features the shared child, v1 did not
+    def model_attributes
+      super.merge(
+        viewmodel: ->(_v) {
+          self.schema_version = 2
+          migrates from: 1, to: 2 do
+            down do |view, refs|
+              view.delete('child')
+            end
+          end
+        })
+    end
+
+    # current (v2) refers to another child, v1 did not
+    def child_attributes
+      super.merge(
+        schema: ->(t) { t.references :child, foreign_key: true },
+        model: ->(m) {
+          belongs_to :child, inverse_of: :parent, dependent: :destroy
+          has_one :parent, inverse_of: :child, class_name: self.name
+        },
+        viewmodel: ->(_v) {
+          self.schema_version = 2
+          association :child
+          migrates from: 1, to: 2 do
+            down do |view, refs|
+              view.delete('child')
+            end
+          end
+        })
+    end
+
+    def new_model
+      model_class.new(name: 'm1',
+                      child: child_model_class.new(
+                        name: 'c1',
+                        child: child_model_class.new(
+                          name: 'c2')))
+    end
+
+
+    let(:migrator) { down_migrator }
+    let(:migration_versions) { { viewmodel_class => 1, child_viewmodel_class => 1 } }
+
+    let(:subject) { current_serialization.deep_dup }
+
+    let(:expected_result) do
+      {
+        'data' => {
+          ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+          ViewModel::VERSION_ATTRIBUTE => 1,
+          ViewModel::ID_ATTRIBUTE => viewmodel.id,
+          ViewModel::MIGRATED_ATTRIBUTE => true,
+          'name' => viewmodel.name,
+        },
+        'references' => {},
+      }
+    end
+
+    it 'migrates' do
+      migrate!
+
+      assert_equal(expected_result, subject)
+    end
+  end
+
   describe 'without migrations' do
     describe 'to an unreachable version' do
       include ViewModelSpecHelpers::ParentAndBelongsToChild

data/test/unit/view_model/garbage_collection_test.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'minitest/unit'
+
+require 'view_model'
+require 'view_model/garbage_collection'
+
+class ViewModel::GarbageCollectionTest < ActiveSupport::TestCase
+  extend Minitest::Spec::DSL
+
+  # Generate a viewmodel-serialization alike from a minimal structure
+  # @param [Hash<Symbol, Array<Symbol>] structure mapping from id to referenced ids
+  # @param [Hash<Symbol, Array<Symbol>] data_ids list of ids of data elements
+  def mock_serialization(data_skeleton, refs_skeleton)
+    data       = []
+    references = {}
+
+    generate(data_skeleton) do |id, body|
+      data << body
+    end
+
+    generate(refs_skeleton) do |id, body|
+      references[id] = body
+    end
+
+    {
+      "data"       => data,
+      "references" => references,
+    }
+  end
+
+  def generate(skeleton)
+    skeleton.each do |id, referred|
+      yield id, ({
+        ViewModel::ID_ATTRIBUTE => id,
+        :children               => referred.map do |referred_id|
+          { ViewModel::REFERENCE_ATTRIBUTE => referred_id }
+        end
+      })
+    end
+  end
+
+  def retained_ids(data_skeleton, refs_skeleton)
+    serialization = mock_serialization(data_skeleton, refs_skeleton)
+    ViewModel::GarbageCollection.garbage_collect_references!(serialization)
+    Set.new(
+      (serialization['data'].map { |x| x[ViewModel::ID_ATTRIBUTE] }) +
+        (serialization['references'].keys),
+    )
+  end
+
+  it 'keeps all roots' do
+    assert_equal(
+      Set.new([:a, :b, :c]),
+      retained_ids({ a: [], b: [], c: [] }, {})
+    )
+  end
+
+  it 'keeps a list' do
+    assert_equal(
+      Set.new([:a, :b, :c, :d]),
+      retained_ids({ a: [:b], }, { b: [:c], c: [:d], d: [] }),
+    )
+  end
+
+  it 'keeps a child with a removed reference' do
+    assert_equal(
+      Set.new([:a, :z]),
+      retained_ids({ a: [:z], }, { b: [:z], z: [] }),
+    )
+  end
+
+  it 'prunes a list at the head' do
+    assert_equal(
+      Set.new([:a]),
+      retained_ids({ a: [], }, { b: [:c], c: [:d], d: [] }),
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.2.10
+  version: 3.2.11
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -414,6 +414,7 @@ files:
 - lib/view_model/deserialize_context.rb
 - lib/view_model/error.rb
 - lib/view_model/error_view.rb
+- lib/view_model/garbage_collection.rb
 - lib/view_model/migratable_view.rb
 - lib/view_model/migration.rb
 - lib/view_model/migration/no_path_error.rb
@@ -467,6 +468,7 @@ files:
 - test/unit/view_model/callbacks_test.rb
 - test/unit/view_model/controller_test.rb
 - test/unit/view_model/deserialization_error/unique_violation_test.rb
+- test/unit/view_model/garbage_collection_test.rb
 - test/unit/view_model/record_test.rb
 - test/unit/view_model/registry_test.rb
 - test/unit/view_model/traversal_context_test.rb
@@ -527,6 +529,7 @@ test_files:
 - test/unit/view_model/callbacks_test.rb
 - test/unit/view_model/controller_test.rb
 - test/unit/view_model/deserialization_error/unique_violation_test.rb
+- test/unit/view_model/garbage_collection_test.rb
 - test/unit/view_model/record_test.rb
 - test/unit/view_model/registry_test.rb
 - test/unit/view_model/traversal_context_test.rb