iknow_view_models 3.6.5 → 3.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea15135f8f921a083f88184fb1602c2cb1ab1654845bf7d29b5d6a35ce4a1e93
-  data.tar.gz: cbb335d8125222a4e5efdb6fc5ae6317a6c1e74d86270885b68d2e482742f392
+  metadata.gz: eb322edf3edec85adb744dba24cab64e15914716f16cfa5ec6bb75de5fcb8e33
+  data.tar.gz: 4b41f0f4ba1fa9a3d7568ee8b0005c4139e8186c91244c7aa04ff8b3bae19fce
 SHA512:
-  metadata.gz: cde2777790785631ba0407ddd576931b05257bb1f51544927c4f9750ec0472cd45f87a9cfc3536271ead56f7b7decbc548f3f401ca23ae48a28bb11c2a6b67dd
-  data.tar.gz: 0bc8000d9cdf342248e2c9cd24e40f8fd4386f34b01891b022785747f9eda8474a19201cc1c72af8d526632ca9493d97eef00e59da3c683ba7bd8d1083790cc2
+  metadata.gz: a51e6a510110c90e3b4a77d0f3da2df2191e68d12137cd9ab040a97125f799e8292ae86c9b53f39b85ebb589d785fa791e8bf56883b122d6b08bfc15b2a0f702
+  data.tar.gz: 03c790566b0304ab4333e632fd81ba8886425ee8a45f1edb2fc5c777af7e2bcbfccecaa947c8a3001d47711ed8dee4132dcb4b52284cd799b915e147de9daf35

data/lib/iknow_view_models/version.rb

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

data/lib/view_model/active_record.rb

@@ -174,6 +174,12 @@ class ViewModel::ActiveRecord < ViewModel::Record
               .run!(deserialize_context: deserialize_context)
         end
       end
+    rescue ViewModel::DeserializationError => e
+      if (new_error = customize_deserialization_error(e))
+        raise new_error
+      else
+        raise
+      end
     end
 
     # Constructs a preload specification of the required models for

data/lib/view_model/deserialization_error.rb

@@ -347,7 +347,7 @@ class ViewModel
       # back when we can't.
       def self.from_exception(exception, nodes = [])
         case exception.cause
-        when PG::UniqueViolation
+        when PG::UniqueViolation, PG::ExclusionViolation
           UniqueViolation.from_postgres_error(exception.cause, nodes)
         else
           self.new(exception.message, nodes)
@@ -357,36 +357,60 @@ class ViewModel
 
     class UniqueViolation < DeserializationError
       status 400
-      attr_reader :detail, :constraint, :columns, :values
+      attr_reader :detail, :constraint, :columns, :values, :conflicts
 
-      PG_ERROR_FIELD_CONSTRAINT_NAME = 'n'.ord # Not exposed in pg gem
       def self.from_postgres_error(err, nodes)
         result         = err.result
-        constraint     = result.error_field(PG_ERROR_FIELD_CONSTRAINT_NAME)
-        message_detail = result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
+        constraint     = result.error_field(PG::PG_DIAG_CONSTRAINT_NAME)
+        message_detail = result.error_field(PG::PG_DIAG_MESSAGE_DETAIL)
 
-        columns, values = parse_message_detail(message_detail)
+        columns, values, conflicts = parse_message_detail(message_detail)
 
         unless columns
           # Couldn't parse the detail message, fall back on an unparsed error
           return DatabaseConstraint.new(err.message, nodes)
         end
 
-        self.new(err.message, constraint, columns, values, nodes)
+        self.new(err.message, constraint, columns, values, conflicts, nodes)
       end
 
       class << self
         DETAIL_PREFIX = 'Key ('
-        DETAIL_SUFFIX = ') already exists.'
-        DETAIL_INFIX  = ')=('
+        UNIQUE_SUFFIX_TEMPLATE    = /\A\)=\((?<values>.*)\) already exists\.\z/
+        EXCLUSION_SUFFIX_TEMPLATE = /\A\)=\((?<values>.*)\) conflicts with existing key \(.*\)=\((?<conflicts>.*)\)\.\z/
+
         def parse_message_detail(detail)
           stream = detail.dup
-
           return nil unless stream.delete_prefix!(DETAIL_PREFIX)
-          return nil unless stream.delete_suffix!(DETAIL_SUFFIX)
 
           # The message should start with an identifier list: pop off identifier
           # tokens while we can.
+          identifiers = parse_identifiers(stream)
+          return nil if identifiers.nil?
+
+          # The message should now contain ")=(" followed by the value list and
+          # the suffix, potentially including a conflict list. We consider the
+          # value and conflict lists to be essentially unparseable because they
+          # are free to contain commas and no escaping is used. We make a best
+          # effort to extract them anyway.
+          values, conflicts =
+            if (m = UNIQUE_SUFFIX_TEMPLATE.match(stream))
+              m.values_at(:values)
+            elsif (m = EXCLUSION_SUFFIX_TEMPLATE.match(stream))
+              m.values_at(:values, :conflicts)
+            else
+              return nil
+            end
+
+          return identifiers, values, conflicts
+        end
+
+        private
+
+        QUOTED_IDENTIFIER   = /\A"(?:[^"]|"")+"/.freeze
+        UNQUOTED_IDENTIFIER = /\A(?:\p{Alpha}|_)(?:\p{Alnum}|_)*/.freeze
+
+        def parse_identifiers(stream)
           identifiers = []
 
           identifier = parse_identifier(stream)
@@ -401,18 +425,9 @@ class ViewModel
             identifiers << identifier
           end
 
-          # The message should now contain ")=(" followed by the (unparseable)
-          # value list.
-          return nil unless stream.delete_prefix!(DETAIL_INFIX)
-
-          [identifiers, stream]
+          identifiers
         end
 
-        private
-
-        QUOTED_IDENTIFIER   = /\A"(?:[^"]|"")+"/.freeze
-        UNQUOTED_IDENTIFIER = /\A(?:\p{Alpha}|_)(?:\p{Alnum}|_)*/.freeze
-
         def parse_identifier(stream)
           if (identifier = stream.slice!(UNQUOTED_IDENTIFIER))
             identifier
@@ -424,16 +439,17 @@ class ViewModel
         end
       end
 
-      def initialize(detail, constraint, columns, values, nodes = [])
+      def initialize(detail, constraint, columns, values, conflicts, nodes = [])
         @detail     = detail
         @constraint = constraint
         @columns    = columns
         @values     = values
+        @conflicts  = conflicts
         super(nodes)
       end
 
       def meta
-        super.merge(constraint: @constraint, columns: @columns, values: @values)
+        super.merge(constraint: @constraint, columns: @columns, values: @values, conflicts: @conflicts)
       end
     end
 

data/lib/view_model/record.rb

@@ -102,6 +102,12 @@ class ViewModel::Record < ViewModel
 
         viewmodel
       end
+    rescue ViewModel::DeserializationError => e
+      if (new_error = customize_deserialization_error(e))
+        raise new_error
+      else
+        raise
+      end
     end
 
     def deserialize_members_from_view(viewmodel, view_hash, references:, deserialize_context:)
@@ -164,6 +170,14 @@ class ViewModel::Record < ViewModel
 
       @model_class = type
     end
+
+    # Overriding this method allows matching and customization of deserialization
+    # errors in individual viewmodel types. This method is called on error from
+    # #deserialize_from_view. If a value is returned, that exception is raised
+    # instead.
+    def customize_deserialization_error(e)
+      nil
+    end
   end
 
   delegate :model_class, to: 'self.class'

data/test/unit/view_model/active_record_test.rb

@@ -445,6 +445,44 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
     end
   end
 
+  class CustomizedErrorTest < ActiveSupport::TestCase
+    include ARVMTestUtilities
+    class TestError < ViewModel::Error; end
+
+    def before_all
+      super
+
+      build_viewmodel(:Model) do
+        define_schema do |t|
+          t.integer :value, null: false
+        end
+
+        define_model do
+        end
+
+        define_viewmodel do
+          root!
+
+          attribute :value
+        end
+      end
+
+      ModelView.define_singleton_method(:customize_deserialization_error) do |e|
+        TestError.new if e.is_a?(ViewModel::DeserializationError::DatabaseConstraint)
+      end
+    end
+
+    def test_customized_error
+      m = Model.create!(value: 1)
+
+      assert_raises(TestError) do
+        alter_by_view!(ModelView, m) do |view, refs|
+          view['value'] = nil
+        end
+      end
+    end
+  end
+
   # Parent view should be correctly passed down the tree when deserializing
   class DeferredConstraintTest < ActiveSupport::TestCase
     include ARVMTestUtilities
@@ -455,6 +493,7 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
       build_viewmodel(:List) do
         define_schema do |t|
           t.integer :child_id
+          t.integer :value
         end
 
         define_model do
@@ -464,9 +503,11 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
         define_viewmodel do
           root!
           association :child
+          attribute :value
         end
       end
       List.connection.execute('ALTER TABLE lists ADD CONSTRAINT unique_child UNIQUE (child_id) DEFERRABLE INITIALLY DEFERRED')
+      List.connection.execute('ALTER TABLE lists ADD CONSTRAINT excluded_value EXCLUDE USING btree (value WITH =) DEFERRABLE INITIALLY DEFERRED')
     end
 
     def test_deferred_constraint_violation
@@ -483,13 +524,37 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
       constraint = 'unique_child'
       columns    = ['child_id']
       values     = l1.child.id.to_s
+      conflicts  = nil
+
+      assert_match(/#{constraint}/, ex.message)
+      assert_equal(constraint, ex.constraint)
+      assert_equal(columns, ex.columns)
+      assert_equal(values, ex.values)
+
+      assert_equal({ constraint: constraint, columns: columns, values: values, conflicts: conflicts, nodes: [] }, ex.meta)
+    end
+
+    def test_deferred_exclusion_violation
+      l1 = List.create!(value: 1)
+      l2 = List.create!
+
+      ex = assert_raises(ViewModel::DeserializationError::UniqueViolation) do
+        alter_by_view!(ListView, l2) do |view, refs|
+          view['value'] = 1
+        end
+      end
+
+      constraint = 'excluded_value'
+      columns    = ['value']
+      values     = '1'
+      conflicts  = '1'
 
       assert_match(/#{constraint}/, ex.message)
       assert_equal(constraint, ex.constraint)
       assert_equal(columns, ex.columns)
       assert_equal(values, ex.values)
 
-      assert_equal({ constraint: constraint, columns: columns, values: values, nodes: [] }, ex.meta)
+      assert_equal({ constraint: constraint, columns: columns, values: values, conflicts: conflicts, nodes: [] }, ex.meta)
     end
   end
 end

data/test/unit/view_model/deserialization_error/unique_violation_test.rb

@@ -34,7 +34,15 @@ class ViewModel::DeserializationError::UniqueViolationTest < ActiveSupport::Test
       let(:detail_message) { 'Key (x)=(a) already exists.' }
 
       it 'parses the key and value' do
-        expect(parse).to eq([['x'], 'a'])
+        expect(parse).to eq([['x'], 'a', nil])
+      end
+    end
+
+    describe 'with a exclusion conflict' do
+      let(:detail_message) { 'Key (x)=(a) conflicts with existing key (x)=(z).' }
+
+      it 'parses the key and value' do
+        expect(parse).to eq([['x'], 'a', 'z'])
       end
     end
 
@@ -42,7 +50,7 @@ class ViewModel::DeserializationError::UniqueViolationTest < ActiveSupport::Test
       let(:detail_message) { 'Key (x, y)=(a, b) already exists.' }
 
       it 'parses the keys and value' do
-        expect(parse).to eq([['x', 'y'], 'a, b'])
+        expect(parse).to eq([['x', 'y'], 'a, b', nil])
       end
     end
 
@@ -50,7 +58,7 @@ class ViewModel::DeserializationError::UniqueViolationTest < ActiveSupport::Test
       let(:detail_message) { 'Key ("x, y", z)=(a, b, c) already exists.' }
 
       it 'parses the keys and value' do
-        expect(parse).to eq([['x, y', 'z'], 'a, b, c'])
+        expect(parse).to eq([['x, y', 'z'], 'a, b, c', nil])
       end
     end
 
@@ -58,7 +66,7 @@ class ViewModel::DeserializationError::UniqueViolationTest < ActiveSupport::Test
       let(:detail_message) { 'Key ("""x"", ""y""", z)=(a, b, c) already exists.' }
 
       it 'parses the keys and value' do
-        expect(parse).to eq([['"x", "y"', 'z'], 'a, b, c'])
+        expect(parse).to eq([['"x", "y"', 'z'], 'a, b, c', nil])
       end
     end
 
@@ -66,7 +74,7 @@ class ViewModel::DeserializationError::UniqueViolationTest < ActiveSupport::Test
       let(:detail_message) { 'Key (a, b)=(a, b)=(c, d) already exists.' }
 
       it 'parses the keys and value' do
-        expect(parse).to eq([['a', 'b'], 'a, b)=(c, d'])
+        expect(parse).to eq([['a', 'b'], 'a, b)=(c, d', nil])
       end
     end
   end

metadata

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