event_store_client 2.3.0 → 3.1.0

data/lib/event_store_client/mapper/default.rb

@@ -18,7 +18,7 @@ module EventStoreClient
       # @param event [EventStoreClient::DeserializedEvent]
       # @return [EventStoreClient::SerializedEvent]
       def serialize(event)
-        Serializer::EventSerializer.call(event, serializer: serializer)
+        Serializer::EventSerializer.call(event, serializer: serializer, config: config)
       end
 
       # @param event_or_raw_event [EventStoreClient::DeserializedEvent, EventStore::Client::Streams::ReadResp::ReadEvent::RecordedEvent, EventStore::Client::PersistentSubscriptions::ReadResp::ReadEvent::RecordedEvent]

data/lib/event_store_client/mapper/encrypted.rb

@@ -32,7 +32,7 @@ module EventStoreClient
         # Links don't need to be encrypted
         return Default.new(serializer: serializer, config: config).serialize(event) if event.link?
 
-        serialized = Serializer::EventSerializer.call(event, serializer: serializer)
+        serialized = Serializer::EventSerializer.call(event, serializer: serializer, config: config)
         encryption_schema =
           if event.class.respond_to?(:encryption_schema)
             event.class.encryption_schema
@@ -70,7 +70,7 @@ module EventStoreClient
         decrypted_data =
           EventStoreClient::DataDecryptor.new(
             data: event.data,
-            schema: event.metadata['encryption'],
+            schema: event.custom_metadata['encryption'],
             repository: key_repository
           ).call
         event.class.new(**event.to_h.merge(data: decrypted_data, skip_validation: true))

data/lib/event_store_client/rspec/has_option_matcher.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# This matcher is defined to test options which are defined by using
+# EventStoreClient::Extensions::OptionsExtension option. Example:
+# Let's say you have next class
+# class SomeClass
+#   include EventStoreClient::Extensions::OptionsExtension
+#
+#   option(:some_opt) { '1' }
+# end
+#
+# To test that its instance has the proper option with the proper default value you can use this
+# matcher:
+# RSpec.describe SomeClass do
+#   subject { described_class.new }
+#
+#   # Check that :some_opt is present
+#   it { is_expected.to have_option(:some_opt) }
+#   # Check that :some_opt is present and has the correct default value
+#   it { is_expected.to have_option(:some_opt).with_default_value('1') }
+# end
+#
+# If you have more complex implementation of default value of your option - you should handle it
+# customly. For example:
+# class SomeClass
+#   include EventStoreClient::Extensions::OptionsExtension
+#
+#   option(:some_opt) { calc_value }
+# end
+# You could test it like so:
+# RSpec.described SomeClass do
+#   let(:instance) { described_class.new }
+#
+#   describe ':some_opt default value' do
+#     subject { instance.some_opt }
+#
+#     let(:value) { 'some val' }
+#
+#     before do
+#       allow(instance).to receive(:calc_value).and_return(value)
+#     end
+#
+#     it { is_expected.to eq(value) }
+#   end
+# end
+RSpec::Matchers.define :has_option do |option_name|
+  match do |obj|
+    option_presence = obj.class.respond_to?(:options) && obj.class.options.include?(option_name)
+    if @default_value
+      option_presence && obj.class.allocate.public_send(option_name) == @default_value
+    else
+      option_presence
+    end
+  end
+
+  failure_message do |obj|
+    option_presence = obj.class.respond_to?(:options) && obj.class.options.include?(option_name)
+    if option_presence && @default_value
+      msg = "Expected #{obj.class} to have `#{option_name.inspect}' option with #{@default_value.inspect}"
+      msg += ' default value, but default value is'
+      msg += " #{obj.class.allocate.public_send(option_name).inspect}"
+    else
+      msg = "Expected #{obj} to have `#{option_name.inspect}' option."
+    end
+
+    msg
+  end
+
+  description do
+    expected_list = RSpec::Matchers::EnglishPhrasing.list(expected)
+    sentences =
+      @chained_method_clauses.map do |(method_name, method_args)|
+        next '' if method_name == :required_kwargs
+
+        english_name = RSpec::Matchers::EnglishPhrasing.split_words(method_name)
+        arg_list = RSpec::Matchers::EnglishPhrasing.list(method_args)
+        " #{english_name}#{arg_list}"
+      end.join
+
+    "have#{expected_list} option#{sentences}"
+  end
+
+  chain :with_default_value do |val|
+    @default_value = val
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_option, :has_option

data/lib/event_store_client/serializer/event_deserializer.rb

@@ -7,8 +7,8 @@ module EventStoreClient
     class EventDeserializer
       class << self
         # @param raw_event [EventStore::Client::Streams::ReadResp::ReadEvent::RecordedEvent, EventStore::Client::PersistentSubscriptions::ReadResp::ReadEvent::RecordedEvent]
-        # @param serializer [#serialize, #deserialize]
         # @param config [EventStoreClient::Config]
+        # @param serializer [#serialize, #deserialize]
         # @return [EventStoreClient::DeserializedEvent]
         def call(raw_event, config:, serializer: Serializer::Json)
           new(config: config, serializer: serializer).call(raw_event)
@@ -19,6 +19,7 @@ module EventStoreClient
       private :serializer, :config
 
       # @param serializer [#serialize, #deserialize]
+      # @param config [EventStoreClient::Config]
       def initialize(serializer:, config:)
         @serializer = serializer
         @config = config
@@ -29,7 +30,7 @@ module EventStoreClient
       def call(raw_event)
         data = serializer.deserialize(normalize_serialized(raw_event.data))
         custom_metadata = serializer.deserialize(normalize_serialized(raw_event.custom_metadata))
-        metadata = custom_metadata.merge(raw_event.metadata.to_h)
+        metadata = raw_event.metadata.to_h
 
         event_class(metadata['type']).new(
           skip_validation: true,
@@ -38,6 +39,7 @@ module EventStoreClient
           type: metadata['type'],
           data: data,
           metadata: metadata,
+          custom_metadata: custom_metadata,
           stream_revision: raw_event.stream_revision,
           commit_position: raw_event.commit_position,
           prepare_position: raw_event.prepare_position,

data/lib/event_store_client/serializer/event_serializer.rb

@@ -3,35 +3,39 @@
 module EventStoreClient
   module Serializer
     class EventSerializer
-      ALLOWED_EVENT_METADATA = %w[type content-type created_at].freeze
+      # So far there are only these keys can be persisted in the metadata. You can pass **whatever**
+      # you want into a metadata hash, but all keys, except these - will be rejected. Define
+      # whitelisted keys and cut unwanted keys explicitly(later in this class).
+      ALLOWED_EVENT_METADATA = %w[type content-type].freeze
 
       class << self
         # @param event [EventStoreClient::DeserializedEvent]
+        # @param config [EventStoreClient::Config]
         # @param serializer [#serialize, #deserialize]
         # @return [EventStoreClient::SerializedEvent]
-        def call(event, serializer: Serializer::Json)
-          new(serializer: serializer).call(event)
+        def call(event, config:, serializer: Serializer::Json)
+          new(serializer: serializer, config: config).call(event)
         end
       end
 
-      attr_reader :serializer
-      private :serializer
+      attr_reader :serializer, :config
+      private :serializer, :config
 
       # @param serializer [#serialize, #deserialize]
-      def initialize(serializer:)
+      # @param config [EventStoreClient::Config]
+      def initialize(serializer:, config:)
         @serializer = serializer
+        @config = config
       end
 
       # @param event [EventStoreClient::DeserializedEvent]
       # @return [EventStoreClient::SerializedEvent]
       def call(event)
-        event_metadata = metadata(event)
-        event_custom_metadata = custom_metadata(event, event_metadata)
         SerializedEvent.new(
           id: event.id || SecureRandom.uuid,
           data: data(event),
-          custom_metadata: event_custom_metadata,
-          metadata: event_metadata.slice(*ALLOWED_EVENT_METADATA),
+          metadata: metadata(event),
+          custom_metadata: custom_metadata(event),
           serializer: serializer
         )
       end
@@ -42,17 +46,24 @@ module EventStoreClient
       # @return [Hash]
       def metadata(event)
         metadata = serializer.deserialize(serializer.serialize(event.metadata))
-        metadata['created_at'] ||= Time.now.utc.to_s
-        metadata
+        # 'created' is returned in the metadata hash of the event when reading from a stream. It,
+        # however, can not be overridden - it is always defined automatically by EventStore db when
+        # appending new event. Thus, just ignore it - no need even to mention it in the
+        # #log_metadata_difference method's message.
+        metadata = metadata.slice(*(metadata.keys - ['created']))
+        filtered_metadata = metadata.slice(*ALLOWED_EVENT_METADATA)
+        log_metadata_difference(metadata) unless filtered_metadata == metadata
+        filtered_metadata
       end
 
+      # Compute custom metadata for the event. **Exactly these** values you can see in ES admin's
+      # web UI under "Metadata" section of the event.
       # @param event [EventStoreClient::DeserializedEvent]
-      # @param metadata [Hash]
       # @return [Hash]
-      def custom_metadata(event, metadata)
-        metadata.
-          slice('created_at', 'encryption', 'content-type', 'transaction').
-          merge('type' => event.type.to_s)
+      def custom_metadata(event)
+        custom_metadata = serializer.deserialize(serializer.serialize(event.custom_metadata))
+        custom_metadata['created_at'] ||= Time.now.utc.to_s
+        custom_metadata
       end
 
       # @param event [EventStoreClient::DeserializedEvent]
@@ -64,6 +75,19 @@ module EventStoreClient
 
         serializer.deserialize(serializer.serialize(event.data))
       end
+
+      # @param metadata [Hash]
+      # @return [void]
+      def log_metadata_difference(metadata)
+        rest_hash = metadata.slice(*(metadata.keys - ALLOWED_EVENT_METADATA))
+        debug_message = <<~TEXT
+          Next keys were filtered from metadata during serialization: \
+          #{(metadata.keys - ALLOWED_EVENT_METADATA).map(&:inspect).join(', ')}. If you would like \
+          to provide your custom values in the metadata - please provide them via custom_metadata. \
+          Example: EventStoreClient::DeserializedEvent.new(custom_metadata: #{rest_hash.inspect})
+        TEXT
+        config.logger&.debug(debug_message)
+      end
     end
   end
 end

data/lib/event_store_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventStoreClient
-  VERSION = '2.3.0'
+  VERSION = '3.1.0'
 end

data/lib/event_store_client.rb

@@ -2,7 +2,9 @@
 
 require 'json'
 require 'set'
+require 'securerandom'
 
+require 'event_store_client/errors'
 require 'event_store_client/serializer/json'
 require 'event_store_client/serializer/event_serializer'
 require 'event_store_client/serializer/event_deserializer'
@@ -29,7 +31,7 @@ module EventStoreClient
     end
 
     # @param name [Symbol, String]
-    # @return [EventStore::Config]
+    # @return [EventStoreClient::Config]
     def config(name = :default)
       @config[name] ||= Config.new(name: name)
     end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-monads
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Easy to use client for event-sources applications written in ruby
 email:
 - sebastian@driggl.com
@@ -221,10 +221,12 @@ files:
 - lib/event_store_client/data_encryptor.rb
 - lib/event_store_client/deserialized_event.rb
 - lib/event_store_client/encryption_metadata.rb
+- lib/event_store_client/errors.rb
 - lib/event_store_client/extensions/options_extension.rb
 - lib/event_store_client/mapper.rb
 - lib/event_store_client/mapper/default.rb
 - lib/event_store_client/mapper/encrypted.rb
+- lib/event_store_client/rspec/has_option_matcher.rb
 - lib/event_store_client/serialized_event.rb
 - lib/event_store_client/serializer/event_deserializer.rb
 - lib/event_store_client/serializer/event_serializer.rb
@@ -244,14 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby integration for https://eventstore.org