ruby_event_store-active_record 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1be9b7cd983f181f719012a18922ca7e3107b03c4c663b25d960bbf1c7b1cc0
-  data.tar.gz: 0c22a5c1a0b261e5cdb54a70f2c52a2bca38f25e7f97e095461b38e1257b8792
+  metadata.gz: 99bfa78c8c716d75bda5cec87447fc1bb066fd5fdf3e3c7c926e249a356f4f8d
+  data.tar.gz: b49cac2c1f50e481eeb0cb133a8e01c1bb8407b4a68b38047b27141b8192aa9e
 SHA512:
-  metadata.gz: 364917d7bd4cc7a6b1e745e03e76301cf7d413a8d1929c1c24dfe7042f5bd4c32758feb51eeffbeb9918b0248875650e3b66cfe6072d9bdcdc4677b05306a25a
-  data.tar.gz: 0ec4280ba169bad9bceb4c86450cbe8e089bba72fc03f2702311c2bf6f84a4dd66eb94cd85ec575760fcf8f31affb18caf89d409819e37d8752f6472c47b2d49
+  metadata.gz: 6222089207f19b557c8109d9a10f57deee52a4a94604a1680fc11c40518b1055c207ec01d1e0e8ae192377600e0955a321146e44eaabcbca3a4d02ff68cfc162
+  data.tar.gz: 7d53c6633aa51964148215c1af44b398d93ce122b53d47d9505d8357f8672782e5bc2c6ebf2ed30110086d021faf76aa5449264f2aafb628af3268b0e6fb9730

data/lib/ruby_event_store/active_record/event_repository.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/array"
-
 module RubyEventStore
   module ActiveRecord
     class EventRepository
@@ -9,12 +7,62 @@ module RubyEventStore
 
       def initialize(model_factory: WithDefaultModels.new, serializer:)
         @serializer = serializer
-
         @event_klass, @stream_klass = model_factory.call
+        if serializer == NULL && json_data_type?
+          warn <<~MSG
+            The data or metadata column is of a JSON/B type and expects a JSON string. 
+
+            Yet the repository serializer is configured as #{serializer} and it would not 
+            produce the expected JSON string. 
+
+            In ActiveRecord there's an implicit serialization to JSON for JSON/B column types 
+            that made it work so far. This behaviour is unfortunately also a source of undesired 
+            double serialization — first in the EventRepository, second in the ActiveRecord.
+            
+            In the past we've advised workarounds that introduced configuration incosistency 
+            with other data types and serialization formats, i.e. explicitly passing NULL serializer 
+            just for the JSON/B data types.
+
+            As of now this special ActiveRecord behaviour is disabled. You should be using JSON 
+            serializer back again:
+
+            RubyEventStore::ActiveRecord::EventRepository.new(serializer: JSON)
+          MSG
+        else
+          @event_klass.include(SkipJsonSerialization)
+        end
         @repo_reader = EventRepositoryReader.new(@event_klass, @stream_klass, serializer)
         @index_violation_detector = IndexViolationDetector.new(@event_klass.table_name, @stream_klass.table_name)
       end
 
+      def rescue_from_double_json_serialization!
+        if serializer == JSON && json_data_type?
+          @repo_reader.instance_eval { alias __record__ record }
+
+          @repo_reader.define_singleton_method :unwrap do |column_name, payload|
+            if String === payload && payload.start_with?("\{")
+              warn "Double serialization of #{column_name} column detected"
+              serializer.load(payload)
+            else
+              payload
+            end
+          end
+
+          @repo_reader.define_singleton_method :record do |record|
+            r = __record__(record)
+
+            Record.new(
+              event_id: r.event_id,
+              metadata: unwrap("metadata", r.metadata),
+              data: unwrap("data", r.data),
+              event_type: r.event_type,
+              timestamp: r.timestamp,
+              valid_at: r.valid_at,
+            )
+          end
+        end
+      end
+
       def append_to_stream(records, stream, expected_version)
         return if records.empty?
 
@@ -99,7 +147,7 @@ module RubyEventStore
                 stream: stream.name,
                 position: compute_position(resolved_version, index),
                 event_id: event_id,
-                created_at: Time.now.utc
+                created_at: Time.now.utc,
               }
             end
           @stream_klass.insert_all!(in_stream) unless stream.global?
@@ -129,7 +177,7 @@ module RubyEventStore
           metadata: serialized_record.metadata,
           event_type: serialized_record.event_type,
           created_at: record.timestamp,
-          valid_at: optimize_timestamp(record.valid_at, record.timestamp)
+          valid_at: optimize_timestamp(record.valid_at, record.timestamp),
         }
       end
 
@@ -139,7 +187,7 @@ module RubyEventStore
           data: serialized_record.data,
           metadata: serialized_record.metadata,
           event_type: serialized_record.event_type,
-          valid_at: optimize_timestamp(record.valid_at, record.timestamp)
+          valid_at: optimize_timestamp(record.valid_at, record.timestamp),
         }
       end
 
@@ -152,9 +200,7 @@ module RubyEventStore
       end
 
       def link_to_stream_(event_ids, stream, expected_version)
-        (
-          event_ids - @event_klass.where(event_id: event_ids).pluck(:event_id)
-        ).each { |id| raise EventNotFound.new(id) }
+        (event_ids - @event_klass.where(event_id: event_ids).pluck(:event_id)).each { |id| raise EventNotFound.new(id) }
         add_to_stream(event_ids, stream, expected_version)
       end
 
@@ -165,9 +211,13 @@ module RubyEventStore
           hashes << insert_hash(record, record.serialize(serializer))
           event_ids << record.event_id
         end
-        add_to_stream(event_ids, stream, expected_version) do
-          @event_klass.insert_all!(hashes)
-        end
+        add_to_stream(event_ids, stream, expected_version) { @event_klass.insert_all!(hashes) }
+      end
+
+      private
+
+      def json_data_type?
+        %i[data metadata].any? { |attr| @event_klass.column_for_attribute(attr).type.start_with?("json") }
       end
     end
   end

data/lib/ruby_event_store/active_record/event_repository_reader.rb

@@ -98,7 +98,8 @@ module RubyEventStore
         else
           stream = @stream_klass.includes(:event).where(stream: spec.stream.name)
           stream = stream.where(event_id: spec.with_ids) if spec.with_ids?
-          stream = stream.joins(:event).where(@event_klass.table_name => { event_type: spec.with_types }) if spec.with_types?
+          stream =
+            stream.joins(:event).where(@event_klass.table_name => { event_type: spec.with_types }) if spec.with_types?
           stream = stream.joins(:event).order(as_at(spec)) if spec.time_sort_by_as_at?
           stream = stream.joins(:event).order(as_of(spec)) if spec.time_sort_by_as_of?
           stream = stream.order(id: order(spec))
@@ -137,7 +138,7 @@ module RubyEventStore
         start_offset_condition(
           specification,
           @stream_klass.find_by!(event_id: specification.start, stream: specification.stream.name),
-          @stream_klass.table_name
+          @stream_klass.table_name,
         )
       rescue ::ActiveRecord::RecordNotFound
         raise EventNotFound.new(specification.start)
@@ -147,7 +148,7 @@ module RubyEventStore
         stop_offset_condition(
           specification,
           @stream_klass.find_by!(event_id: specification.stop, stream: specification.stream.name),
-          @stream_klass.table_name
+          @stream_klass.table_name,
         )
       rescue ::ActiveRecord::RecordNotFound
         raise EventNotFound.new(specification.stop)
@@ -157,7 +158,7 @@ module RubyEventStore
         start_offset_condition(
           specification,
           @event_klass.find_by!(event_id: specification.start),
-          @event_klass.table_name
+          @event_klass.table_name,
         )
       rescue ::ActiveRecord::RecordNotFound
         raise EventNotFound.new(specification.start)
@@ -167,7 +168,7 @@ module RubyEventStore
         stop_offset_condition(
           specification,
           @event_klass.find_by!(event_id: specification.stop),
-          @event_klass.table_name
+          @event_klass.table_name,
         )
       rescue ::ActiveRecord::RecordNotFound
         raise EventNotFound.new(specification.stop)
@@ -208,16 +209,14 @@ module RubyEventStore
       def record(record)
         record = record.event if @stream_klass === record
 
-        SerializedRecord
-          .new(
-            event_id: record.event_id,
-            metadata: record.metadata,
-            data: record.data,
-            event_type: record.event_type,
-            timestamp: record.created_at.iso8601(TIMESTAMP_PRECISION),
-            valid_at: (record.valid_at || record.created_at).iso8601(TIMESTAMP_PRECISION)
-          )
-          .deserialize(serializer)
+        SerializedRecord.new(
+          event_id: record.event_id,
+          metadata: record.metadata,
+          data: record.data,
+          event_type: record.event_type,
+          timestamp: record.created_at.iso8601(TIMESTAMP_PRECISION),
+          valid_at: (record.valid_at || record.created_at).iso8601(TIMESTAMP_PRECISION),
+        ).deserialize(serializer)
       end
     end
 

data/lib/ruby_event_store/active_record/generators/event_id_index_migration_generator.rb

@@ -22,8 +22,8 @@ module RubyEventStore
       def migration_template
         ERB.new(
           File.read(
-            File.join(absolute_path("./templates"), "add_event_id_index_to_event_store_events_in_streams_template.erb")
-          )
+            File.join(absolute_path("./templates"), "add_event_id_index_to_event_store_events_in_streams_template.erb"),
+          ),
         )
       end
 

data/lib/ruby_event_store/active_record/generators/foreign_key_on_event_id_migration_generator.rb

@@ -16,12 +16,12 @@ module RubyEventStore
       def each_migration(database_adapter, &block)
         case database_adapter
         when DatabaseAdapter::PostgreSQL
-          [
-            'add_foreign_key_on_event_id_to_event_store_events_in_streams',
-            'validate_add_foreign_key_on_event_id_to_event_store_events_in_streams'
+          %w[
+            add_foreign_key_on_event_id_to_event_store_events_in_streams
+            validate_add_foreign_key_on_event_id_to_event_store_events_in_streams
           ]
         else
-          ['add_foreign_key_on_event_id_to_event_store_events_in_streams']
+          ["add_foreign_key_on_event_id_to_event_store_events_in_streams"]
         end.each.with_index(&block)
       end
 
@@ -30,7 +30,9 @@ module RubyEventStore
       end
 
       def migration_code(database_adapter, migration_name)
-        migration_template(template_root(database_adapter), migration_name).result_with_hash(migration_version: migration_version)
+        migration_template(template_root(database_adapter), migration_name).result_with_hash(
+          migration_version: migration_version,
+        )
       end
 
       def migration_template(template_root, name)

data/lib/ruby_event_store/active_record/generators/migration_generator.rb

@@ -19,7 +19,10 @@ module RubyEventStore
       end
 
       def migration_code(database_adapter)
-        migration_template(template_root(database_adapter), "create_event_store_events").result_with_hash(migration_version: migration_version, data_type: database_adapter.data_type)
+        migration_template(template_root(database_adapter), "create_event_store_events").result_with_hash(
+          migration_version: migration_version,
+          data_type: database_adapter.data_type,
+        )
       end
 
       def template_root(database_adapter)

data/lib/ruby_event_store/active_record/generators/rails_migration_generator.rb

@@ -19,7 +19,7 @@ module RubyEventStore
         type: :string,
         default: "binary",
         desc:
-          "Configure the data type for `data` and `meta data` fields in migration (options: #{DatabaseAdapter::PostgreSQL.new.supported_data_types.join(", ")})"
+          "Configure the data type for `data` and `meta data` fields in migration (options: #{DatabaseAdapter::PostgreSQL.new.supported_data_types.join(", ")})",
       )
 
       def initialize(*args)

data/lib/ruby_event_store/active_record/index_violation_detector.rb

@@ -10,8 +10,7 @@ module RubyEventStore
         @mysql8_pkey_error = "for key '#{event_store_events}.index_#{event_store_events}_on_event_id'".freeze
         @mysql5_index_error = "for key 'index_#{event_store_events_in_streams}_on_stream_and_event_id'".freeze
         @mysql8_index_error =
-          "for key '#{event_store_events_in_streams}.index_#{event_store_events_in_streams}_on_stream_and_event_id'"
-            .freeze
+          "for key '#{event_store_events_in_streams}.index_#{event_store_events_in_streams}_on_stream_and_event_id'".freeze
         @sqlite3_pkey_error = "constraint failed: #{event_store_events}.event_id".freeze
         @sqlite3_index_error =
           "constraint failed: #{event_store_events_in_streams}.stream, #{event_store_events_in_streams}.event_id".freeze

data/lib/ruby_event_store/active_record/railtie.rb

@@ -2,6 +2,13 @@
 
 module RubyEventStore
   module ActiveRecord
-    Railtie = Class.new(::Rails::Railtie)
+    class Railtie < ::Rails::Railtie
+      initializer "ruby_event_store-active_record" do
+        ActiveSupport.on_load(:active_record) do
+          require_relative "../active_record/skip_json_serialization"
+          require_relative "../active_record/event"
+        end
+      end
+    end
   end
-end
+end

data/lib/ruby_event_store/active_record/rake_task.rb

@@ -6,13 +6,13 @@ load "ruby_event_store/active_record/tasks/migration_tasks.rake"
 
 include ActiveRecord::Tasks
 
-db_dir = ENV["DATABASE_DIR"] || './db'
+db_dir = ENV["DATABASE_DIR"] || "./db"
 
 task :environment do
   connection = ActiveRecord::Base.establish_connection(ENV["DATABASE_URL"])
   DatabaseTasks.env = connection.db_config.env_name
   DatabaseTasks.db_dir = db_dir
-  DatabaseTasks.migrations_paths = ENV["MIGRATIONS_PATH"] || File.join(db_dir, 'migrate')
+  DatabaseTasks.migrations_paths = ENV["MIGRATIONS_PATH"] || File.join(db_dir, "migrate")
 end
 
-load 'active_record/railties/databases.rake'
+load "active_record/railties/databases.rake"

data/lib/ruby_event_store/active_record/skip_json_serialization.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module RubyEventStore
+  module ActiveRecord
+    module SkipJsonSerialization
+      extend ActiveSupport::Concern
+
+      skip_json_serialization = ->(cast_type) do
+        %i[json jsonb].include?(cast_type.type) ? ActiveModel::Type::Value.new : cast_type
+      end
+
+      if ::ActiveRecord.version >= Gem::Version.new("7.2.0")
+        class_methods { define_method(:hook_attribute_type) { |name, cast_type| skip_json_serialization[cast_type] } }
+      else
+        included do
+          attribute :data, skip_json_serialization
+          attribute :metadata, skip_json_serialization
+        end
+      end
+    end
+  end
+end

data/lib/ruby_event_store/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module RubyEventStore
   module ActiveRecord
-    VERSION = "2.16.0"
+    VERSION = "2.17.0"
   end
 end

data/lib/ruby_event_store/active_record/with_abstract_base_class.rb

@@ -22,7 +22,7 @@ module RubyEventStore
           Class.new(@base_klass) do
             self.primary_key = :id
             self.table_name = "event_store_events"
-          end
+          end,
         )
       end
 
@@ -33,7 +33,7 @@ module RubyEventStore
             self.primary_key = :id
             self.table_name = "event_store_events_in_streams"
             belongs_to :event, primary_key: :event_id, class_name: "Event_#{instance_id}"
-          end
+          end,
         )
       end
     end

data/lib/ruby_event_store/active_record.rb

@@ -7,7 +7,6 @@ require_relative "active_record/generators/event_id_index_migration_generator"
 require_relative "active_record/generators/rails_event_id_index_migration_generator"
 require_relative "active_record/generators/foreign_key_on_event_id_migration_generator"
 require_relative "active_record/generators/rails_foreign_key_on_event_id_migration_generator"
-require_relative "active_record/event"
 require_relative "active_record/with_default_models"
 require_relative "active_record/with_abstract_base_class"
 require_relative "active_record/event_repository"
@@ -16,4 +15,9 @@ require_relative "active_record/event_repository_reader"
 require_relative "active_record/index_violation_detector"
 require_relative "active_record/pg_linearized_event_repository"
 require_relative "active_record/version"
-require_relative "active_record/railtie" if defined?(Rails::Engine)
+if defined?(Rails::Engine)
+  require_relative "active_record/railtie"
+else
+  require_relative "active_record/skip_json_serialization"
+  require_relative "active_record/event"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store-active_record
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Arkency
 bindir: bin
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_event_store
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 2.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 2.17.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ files:
 - lib/ruby_event_store/active_record/pg_linearized_event_repository.rb
 - lib/ruby_event_store/active_record/railtie.rb
 - lib/ruby_event_store/active_record/rake_task.rb
+- lib/ruby_event_store/active_record/skip_json_serialization.rb
 - lib/ruby_event_store/active_record/tasks/migration_tasks.rake
 - lib/ruby_event_store/active_record/version.rb
 - lib/ruby_event_store/active_record/with_abstract_base_class.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Persistent event repository implementation for RubyEventStore based on ActiveRecord
 test_files: []