event_store_client 1.3.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 700f420a0fa9e3fb0352784f3bc0431cac18216130ba397897dfb77c98a4f7c6
-  data.tar.gz: e408f3a666dd7f1e95634591923bf8df51ce30c6b521cd9042072f551e5ff645
+  metadata.gz: dc7d6f48fb89cf1d9ac826310efcbd4eaf5ba60b61b0d9d100d95615e576ad0a
+  data.tar.gz: e9214e8026af433ddcd3804f8d6920a3298d7497cceca0dcefae73d41bce8e3e
 SHA512:
-  metadata.gz: 2232248c19c04924effd9bab97271f5a0bf3e7b4cf4e56e5453fc32a27c56d587777239b48d0aafc026c265b1086691aa5e8c04e7863209d9bb1e07c046946e6
-  data.tar.gz: 2db191ee47dae6f22b5858ab85bde4d3129af6220f534d9b11e502150058c7211285afa2562aae70ae08877e21c8d2205c8d1400ec8365e10567e7c5295b7afc
+  metadata.gz: 786b74bc83aa6a20682818097f219f139e582428b74aa89378ec587ce9a6bd163c7e9d599392ffdbaee5763768d72d0d0dcf6215cccbdf3c661cc5545a382b31
+  data.tar.gz: dd0add2a3050b272c163b67a5a93b25c33cf0f1a1e5008a18bb371faa84a74e44ed6133ccf6ea5f1fb90b86f5bd84f2bfd0dcc2b256f40424f88574762c7f2b2

data/lib/event_store_client/adapters/grpc/client.rb

@@ -11,7 +11,7 @@ module EventStoreClient
       #
       def append_to_stream(stream_name, events, options: {})
         Commands::Streams::Append.new.call(
-          stream_name, events, options: {}
+          stream_name, events, options: options
         )
       end
 

data/lib/event_store_client/adapters/grpc/commands/streams/append.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'grpc'
-require 'event_store_client/adapters/grpc/generated/streams_pb.rb'
-require 'event_store_client/adapters/grpc/generated/streams_services_pb.rb'
+require 'event_store_client/adapters/grpc/generated/streams_pb'
+require 'event_store_client/adapters/grpc/generated/streams_services_pb'
 
 require 'event_store_client/adapters/grpc/commands/command'
 
@@ -14,45 +14,94 @@ module EventStoreClient
           use_request EventStore::Client::Streams::AppendReq
           use_service EventStore::Client::Streams::Streams::Stub
 
+          ALLOWED_EVENT_METADATA = %w[type content-type created_at].freeze
+
           # @api private
-          # TODO: Add support to verify the expected version
-          def call(stream, events, options: {}) # rubocop:disable Lint/UnusedMethodArgument,Metrics/LineLength
+          def call(stream, events, options: {})
+            return unless events.any?
+
             serialized_events = events.map { |event| config.mapper.serialize(event) }
 
-            serialized_events.each do |event|
-              event_metadata = JSON.parse(event.metadata)
-              custom_metadata = {
-                "type": event.type,
-                "created_at": Time.now,
-                'content-type': event_metadata['content-type']
-              }
-              custom_metadata['encryption'] = event_metadata['encryption'] unless event_metadata['encryption'].nil?
-              custom_metadata['transaction'] = event_metadata['transaction'] unless event_metadata['transaction'].nil?
-              event_metadata = event_metadata.select { |k| ['type', 'content-type', 'created_at'].include?(k) }
-
-              payload = [
-                request.new(
-                  options: {
-                    stream_identifier: {
-                      streamName: stream
-                    },
-                    any: {}
-                  }
-                ),
-                request.new(
-                  proposed_message: {
-                    id: {
-                      string: SecureRandom.uuid
-                    },
-                    data: event.data.b,
-                    custom_metadata: JSON.generate(custom_metadata),
-                    metadata: event_metadata
-                  }
-                )
-              ]
-              service.append(payload, metadata: metadata)
+            expected_version = options[:expected_version]
+
+            res = nil
+            serialized_events.each_with_index do |event, i|
+              expected_version += i if expected_version
+              res = append(stream, event, expected_version)
+              break if res.failure?
             end
-            Success(events)
+
+            res.success? ? Success(events) : Failure(res.failure)
+          end
+
+          private
+
+          def append(stream, event, expected_version)
+            event_metadata = JSON.parse(event.metadata)
+
+            payload = append_request_payload(
+              options(stream, expected_version),
+              message(
+                data: event.data.b,
+                event_metadata: event_metadata.select { |k| ALLOWED_EVENT_METADATA.include?(k) },
+                custom_metadata: custom_metadata(event.type, event_metadata)
+              )
+            )
+
+            resp = service.append(payload, metadata: metadata)
+
+            validate_response(resp)
+          end
+
+          def custom_metadata(event_type, event_metadata)
+            {
+              type: event_type,
+              created_at: Time.current,
+              encryption: event_metadata['encryption'],
+              'content-type': event_metadata['content-type'],
+              transaction: event_metadata['transaction']
+            }.compact
+          end
+
+          def append_request_payload(options, message)
+            [
+              request.new(
+                options: options
+              ),
+              request.new(
+                proposed_message: message
+              )
+            ]
+          end
+
+          def options(stream, expected_version)
+            {
+              stream_identifier: {
+                streamName: stream
+              },
+              revision: expected_version,
+              any: (expected_version ? nil : {})
+            }.compact
+          end
+
+          def message(data:, event_metadata:, custom_metadata:)
+            {
+              id: {
+                string: SecureRandom.uuid
+              },
+              data: data,
+              custom_metadata: JSON.generate(custom_metadata),
+              metadata: event_metadata
+            }
+          end
+
+          def validate_response(resp)
+            return Success() if resp.success
+
+            Failure(
+              "current version: #{resp.wrong_expected_version.current_revision} | "\
+              "expected: #{resp.wrong_expected_version.expected_revision}"
+            )
           end
         end
       end

data/lib/event_store_client/configuration.rb

@@ -8,35 +8,37 @@ module EventStoreClient
 
   # Supported adapters: %i[api in_memory grpc]
   #
-  setting :adapter, :grpc
-  setting :verify_ssl, true
+  setting :adapter, default: :grpc
+  setting :verify_ssl, default: true
 
-  setting :error_handler, ErrorHandler.new
-  setting :eventstore_url, 'http://localhost:2113' do |value|
+  setting :error_handler, default: ErrorHandler.new
+  setting :eventstore_url, default: 'http://localhost:2113' do |value|
     value.is_a?(URI) ? value : URI(value)
   end
 
-  setting :eventstore_user, 'admin'
-  setting :eventstore_password, 'changeit'
+  setting :eventstore_user, default: 'admin'
+  setting :eventstore_password, default: 'changeit'
 
-  setting :db_port, 2113
+  setting :db_port, default: 2113
 
-  setting :per_page, 20
-  setting :pid_path, 'tmp/poll.pid'
+  setting :per_page, default: 20
+  setting :pid_path, default: 'tmp/poll.pid'
 
-  setting :service_name, 'default'
+  setting :service_name, default: 'default'
 
-  setting :mapper, Mapper::Default.new
+  setting :mapper, default: Mapper::Default.new
+
+  setting :default_event_class, default: EventStoreClient::DeserializedEvent
 
   setting :subscriptions_repo
 
   setting :logger
 
-  setting :socket_error_retry_sleep, 0.5
-  setting :socket_error_retry_count, 3
+  setting :socket_error_retry_sleep, default: 0.5
+  setting :socket_error_retry_count, default: 3
 
-  setting :grpc_unavailable_retry_sleep, 0.5
-  setting :grpc_unavailable_retry_count, 3
+  setting :grpc_unavailable_retry_sleep, default: 0.5
+  setting :grpc_unavailable_retry_count, default: 3
 
   def self.configure
     yield(config) if block_given?

data/lib/event_store_client/deserialized_event.rb

@@ -4,36 +4,55 @@ require 'dry/schema'
 
 module EventStoreClient
   class DeserializedEvent
-    attr_reader :id
-    attr_reader :type
-    attr_reader :title
-    attr_reader :data
-    attr_reader :metadata
-
-    def schema
-      Dry::Schema.Params do
-      end
-    end
+    InvalidDataError = Class.new(StandardError)
+    private_constant :InvalidDataError
+
+    attr_reader :id, :type, :title, :data, :metadata
 
+    # @args [Hash] opts
+    # @option opts [Boolean] :skip_validation
+    # @option opts [Hash] :data
+    # @option opts [Hash] :metadata
+    # @option opts [String] :type
+    # @option opts [String] :title
+    # @option opts [UUID] :id
+    #
     def initialize(args = {})
-      validation = schema.call(args[:data] || {}) unless args[:skip_validation]
+      validate(args[:data]) unless args[:skip_validation]
+
       @data = args.fetch(:data) { {} }
-      @metadata = args.fetch(:metadata) { {} }.merge(
-        'type' => self.class.name,
-        'content-type' => content_type
-      )
-      if !args[:skip_validation] && validation.errors.any?
-        @metadata.merge!('validation-errors' => validation.errors.to_h)
-      end
+      @metadata =
+        args.fetch(:metadata) { {} }
+            .merge(
+              'type' => self.class.name,
+              'content-type' => payload_content_type
+            )
+
       @type = args[:type] || self.class.name
       @title = args[:title]
       @id = args[:id]
     end
 
-    def content_type
+    # event schema
+    def schema; end
+
+    # content type of the event data
+    def payload_content_type
       return 'application/json' if EventStoreClient.config.adapter == :grpc
 
       'application/vnd.eventstore.events+json'
     end
+
+    private
+
+    def validate(data)
+      return unless schema
+
+      validation = schema.call(data || {})
+
+      return unless validation.errors.any?
+
+      raise(InvalidDataError.new(message: "#{schema.class.name} #{validation.errors.to_h}"))
+    end
   end
 end

data/lib/event_store_client/mapper/default.rb

@@ -20,7 +20,7 @@ module EventStoreClient
           begin
             Object.const_get(event.type)
           rescue NameError
-            EventStoreClient::DeserializedEvent
+            EventStoreClient.config.default_event_class
           end
         event_class.new(
           skip_validation: true,

data/lib/event_store_client/mapper/encrypted.rb

@@ -68,7 +68,7 @@ module EventStoreClient
           begin
             Object.const_get(event.type)
           rescue NameError
-            EventStoreClient::DeserializedEvent
+            EventStoreClient.config.default_event_class
           end
 
         event_class.new(

data/lib/event_store_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable