event_store_client 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ff17cd8c1913a09f27fd8ae0c846309b54d984ca81faa8291b769357ead3ec
-  data.tar.gz: b658667a55cc43ba62995e1369e4b8b0f2ee2c950b08dc5dfd19da75e1af430f
+  metadata.gz: f072cd6b9f3a8cb41ac746eed4cb472cf0581c042c117082076c9f29b391bbd5
+  data.tar.gz: 3fa6712c4be66e24b97bf364c22cbca1318a7681e1bc5ea765268ea19495545e
 SHA512:
-  metadata.gz: 6ece79e50bb8a38629587ad87fc6b69e4dea30fd2edb83f34a5fbc5daa760eb11970a02475c6258769d3ba0c9b108bd0bec0464398885e8ae909884650f37047
-  data.tar.gz: 3cc3551a091362045c125b0ea1ef014a0f798a0683401c5c13a43688d570809a185f74d4f7f5e405f442101e906edd4e0f42282114d8e0910cae1cbbb9884635
+  metadata.gz: b0d8489a114c666079639e76817a01f1986df193434cdf0efc22e5fea968e4670e96176a433464ac2f5669f3bfdae5ef94a7b2f19b87a5ef891aebef5c6f65e2
+  data.tar.gz: 4e9ae526f384e00b2f4d5739b4f825f5336d87a9193e02f01ee87f94282c385344750653d844074e431ae1d59bad93270a362caa8d92c1a2972544e037372620

data/docs/configuration.md

@@ -6,15 +6,52 @@ Currently only one setup is supported. For example, you can't configure a connec
 
 Configuration options:
 
-| name                 | value                                                                                | default value                           | description                                                                                                                                                                                                                              |
-|----------------------|--------------------------------------------------------------------------------------|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| eventstore_url      | String                                                                               | `'esdb://localhost:2113'`               | Connection string. See description of possible values below.                                                                                                                                                                            |
-| per_page             | Integer                                                                              | `20`                                    | Number of events to return in one response.                                                                                                                                                                                              |
-| mapper               | `EventStoreClient::Mapper::Default.new` or `EventStoreClient::Mapper::Encrypted.new` | `EventStoreClient::Mapper::Default.new` | An object that is responsible for serialization / deserialization and encryption / decryption of events.                                                                                                                                     |
-| default_event_class  | `DeserializedEvent` or any class, inherited from it                                  | `DeserializedEvent`                     | This class will be used during the deserialization process when deserializer fails to resolve an event's class from response.                                                                                                             |
-| logger               | `Logger`                                                                             | `nil`                                   | A logger that would log messages from `event_store_client` and `grpc` gems.                                                                                                                                                               |
-| skip_deserialization | Boolean                                                                              | `false`                                 | Whether to skip event deserialization using the given `mapper` setting. If you set it to `true` decryption will be skipped as well. It is useful when you want to defer deserialization and handle it later by yourself. |
-| skip_decryption      | Boolean                                                                              | `false`                                 | Whether to skip decrypting encrypted event payloads.                                                                                                                                                                                                       |
+| name                 | value                                                                                | default value                                                                                                                     | description                                                                                                                                                                                                                                           |
+|----------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| eventstore_url      | String                                                                               | `'esdb://localhost:2113'`                                                                                                         | Connection string. See description of possible values below.                                                                                                                                                                                          |
+| per_page             | Integer                                                                              | `20`                                                                                                                              | Number of events to return in one response.                                                                                                                                                                                                           |
+| mapper               | `EventStoreClient::Mapper::Default.new` or `EventStoreClient::Mapper::Encrypted.new` | `EventStoreClient::Mapper::Default.new`                                                                                           | An object that is responsible for serialization / deserialization and encryption / decryption of events.                                                                                                                                              |
+| default_event_class  | `DeserializedEvent` or any class, inherited from it                                  | `DeserializedEvent`                                                                                                               | This class will be used during the deserialization process when deserializer fails to resolve an event's class from response.                                                                                                                         |
+| logger               | `Logger`                                                                             | `nil`                                                                                                                             | A logger that would log messages from `event_store_client` and `grpc` gems.                                                                                                                                                                           |
+| skip_deserialization | Boolean                                                                              | `false`                                                                                                                           | Whether to skip event deserialization using the given `mapper` setting. If you set it to `true` decryption will be skipped as well. It is useful when you want to defer deserialization and handle it later by yourself.                              |
+| skip_decryption      | Boolean                                                                              | `false`                                                                                                                           | Whether to skip decrypting encrypted event payloads.                                                                                                                                                                                                  |
+| channel_args      | Hash                                                                                 | `{ 'grpc.min_reconnect_backoff_ms' => 100, 'grpc.max_reconnect_backoff_ms' => 100, 'grpc.initial_reconnect_backoff_ms' => 100 }` | GRPC-specific connection options. This hash will be passed into the `:channel_args` argument of a Stub class of your request. More GRPC options can be found [here](https://github.com/grpc/grpc/blob/master/include/grpc/impl/codegen/grpc_types.h). |
+
+## A note about channel_args option
+
+When defining the custom value of this option - the default value will be reverse-merged into it. So, for example, if you would like to set `grpc.min_reconnect_backoff_ms` like so:
+
+```ruby
+EventStoreClient.configure do |config|
+  config.channel_args = { 'grpc.min_reconnect_backoff_ms' => 200 }
+end
+```
+
+the resulting `channel_args` value will be
+
+```ruby
+{ 
+  "grpc.min_reconnect_backoff_ms" => 200, 
+  "grpc.max_reconnect_backoff_ms" => 100, 
+  "grpc.initial_reconnect_backoff_ms" => 100
+}
+```
+
+This behaviour is intentional. So, if you want to override them all - you should do it explicitly. Example:
+
+```ruby
+EventStoreClient.configure do |config|
+  config.channel_args = { 
+    'grpc.min_reconnect_backoff_ms' => 500,
+    'grpc.max_reconnect_backoff_ms' => 500,
+    'grpc.initial_reconnect_backoff_ms' => 500
+  }
+end
+```
+
+It could be useful when you have high ping to your EventStore DB server.
+
+Besides, there is an option which you can't change - `grpc.enable_retries`. It always defaults to `0`. This is because `event_store_client` implements its own retry functional.
 
 ## Connection string
 
@@ -83,3 +120,11 @@ Possible options:
 | grpcRetryAttempts    | Integer                                         | `3`           | Number of times to retry GRPC requests. Does not apply to discovery requests. Final number of requests in cases of error will be initial request + grpcRetryAttempts.                                                                                  |
 | grpcRetryInterval    | Integer                                         | `100`         | Milliseconds. Delay between GRPC requests. retries.                                                                                                                                                                                                      |
 | throwOnAppendFailure | Boolean                                         | `true`        | Defines if append requests should immediately raise an error. If set to `false`, request will be retried in case of a server error.                                                                                                                       |
+
+Examples:
+
+```
+esdb://localhost:2113/?tls=false
+esdb+discover://localhost:2113/?grpcRetryAttempts=3&grpcRetryInterval=300&discoverInterval=200
+esdb://localhost:2113,localhost:2114,localhost:2115/?gossipTimeout=500&maxDiscoverAttempts=3
+```

data/lib/event_store_client/adapters/grpc/cluster/insecure_connection.rb

@@ -11,7 +11,7 @@ module EventStoreClient
           stub_class.new(
             "#{host}:#{port}",
             :this_channel_is_insecure,
-            channel_args: channel_args,
+            channel_args: config.channel_args,
             timeout: (timeout / 1000.0 if timeout)
           )
         end

data/lib/event_store_client/adapters/grpc/cluster/secure_connection.rb

@@ -13,7 +13,7 @@ module EventStoreClient
           stub_class.new(
             "#{host}:#{port}",
             channel_credentials,
-            channel_args: channel_args,
+            channel_args: config.channel_args,
             timeout: (timeout / 1000.0 if timeout)
           )
         end

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

@@ -55,23 +55,6 @@ module EventStoreClient
       def call(stub_class)
         raise NotImplementedError
       end
-
-      private
-
-      # Common channel arguments for all GRPC requests.
-      # Available channel arguments are described here
-      # https://github.com/grpc/grpc/blob/master/include/grpc/impl/codegen/grpc_types.h
-      # @return [Hash]
-      def channel_args
-        {
-          # disable build-in GRPC retries functional
-          'grpc.enable_retries' => 0,
-          # These three options reduce delays between failed requests.
-          'grpc.min_reconnect_backoff_ms' => 100, # milliseconds
-          'grpc.max_reconnect_backoff_ms' => 100, # milliseconds
-          'grpc.initial_reconnect_backoff_ms' => 100 # milliseconds
-        }
-      end
     end
   end
 end

data/lib/event_store_client/adapters/grpc/generated/shared_pb.rb

@@ -4,6 +4,7 @@
 require 'google/protobuf'
 
 require 'google/protobuf/empty_pb'
+require 'google/protobuf/any_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("shared.proto", :syntax => :proto3) do
@@ -55,6 +56,30 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "event_store.client.BadRequest" do
       optional :message, :string, 1
     end
+    add_message "event_store.client.Status" do
+      optional :code, :enum, 1, "event_store.client.Code"
+      optional :message, :string, 2
+      optional :details, :message, 3, "google.protobuf.Any"
+    end
+    add_enum "event_store.client.Code" do
+      value :OK, 0
+      value :CANCELLED, 1
+      value :UNKNOWN, 2
+      value :INVALID_ARGUMENT, 3
+      value :DEADLINE_EXCEEDED, 4
+      value :NOT_FOUND, 5
+      value :ALREADY_EXISTS, 6
+      value :PERMISSION_DENIED, 7
+      value :UNAUTHENTICATED, 16
+      value :RESOURCE_EXHAUSTED, 8
+      value :FAILED_PRECONDITION, 9
+      value :ABORTED, 10
+      value :OUT_OF_RANGE, 11
+      value :UNIMPLEMENTED, 12
+      value :INTERNAL, 13
+      value :UNAVAILABLE, 14
+      value :DATA_LOSS, 15
+    end
   end
 end
 
@@ -73,5 +98,7 @@ module EventStore
     InvalidTransaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("event_store.client.InvalidTransaction").msgclass
     MaximumAppendSizeExceeded = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("event_store.client.MaximumAppendSizeExceeded").msgclass
     BadRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("event_store.client.BadRequest").msgclass
+    Status = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("event_store.client.Status").msgclass
+    Code = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("event_store.client.Code").enummodule
   end
 end

data/lib/event_store_client/adapters/grpc/generated/streams_pb.rb

@@ -4,7 +4,6 @@
 require 'google/protobuf'
 
 require_relative 'shared_pb'
-require_relative 'status_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/timestamp_pb'
@@ -211,7 +210,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :correlation_id, :message, 1, "event_store.client.UUID"
       optional :stream_identifier, :message, 4, "event_store.client.StreamIdentifier"
       oneof :result do
-        optional :error, :message, 2, "google.rpc.Status"
+        optional :error, :message, 2, "event_store.client.Status"
         optional :success, :message, 3, "event_store.client.streams.BatchAppendResp.Success"
       end
       oneof :expected_stream_position do

data/lib/event_store_client/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module EventStoreClient
+  class Config
+    include Extensions::OptionsExtension
+
+    CHANNEL_ARGS_DEFAULTS = {
+      # These three options reduce delays between failed requests.
+      'grpc.min_reconnect_backoff_ms' => 100, # milliseconds
+      'grpc.max_reconnect_backoff_ms' => 100, # milliseconds
+      'grpc.initial_reconnect_backoff_ms' => 100 # milliseconds
+    }.freeze
+
+    option(:eventstore_url) { 'esdb://localhost:2113' }
+    option(:per_page) { 20 }
+    option(:mapper) { Mapper::Default.new }
+    option(:default_event_class) { DeserializedEvent }
+    option(:logger)
+    option(:skip_deserialization) { false }
+    option(:skip_decryption) { false }
+    # GRPC-specific connection options. This hash will be passed into the `:channel_args` argument
+    # of a Stub class of your request. More GRPC options can be found here
+    # https://github.com/grpc/grpc/blob/master/include/grpc/impl/codegen/grpc_types.h
+    option(:channel_args) # Hash
+
+    def eventstore_url=(value)
+      @eventstore_url =
+        if value.is_a?(Connection::Url)
+          value
+        else
+          Connection::UrlParser.new.call(value)
+        end
+    end
+
+    # @param logger [Logger, nil]
+    # @return [Logger, nil]
+    def logger=(logger)
+      ::GRPC.define_singleton_method :logger do
+        @logger ||= logger.nil? ? ::GRPC::DefaultLogger::NoopLogger.new : logger
+      end
+      @logger = logger
+    end
+
+    # @param val [Hash, nil]
+    # @return [Hash]
+    def channel_args=(val)
+      channel_args = CHANNEL_ARGS_DEFAULTS.merge(val&.transform_keys(&:to_s) || {})
+      # This options always defaults to `0`. This is because `event_store_client` implements its
+      # own retry functional.
+      channel_args['grpc.enable_retries'] = 0
+      @channel_args = channel_args
+    end
+  end
+end

data/lib/event_store_client/configuration.rb

@@ -1,57 +1,8 @@
 # frozen_string_literal: true
 
 module EventStoreClient
-  class Config
-    include Extensions::OptionsExtension
-
-    option(:eventstore_url) { 'esdb://localhost:2113' }
-    option(:per_page) { 20 }
-    option(:mapper) { Mapper::Default.new }
-    option(:default_event_class) { DeserializedEvent }
-    option(:logger)
-    option(:skip_deserialization) { false }
-    option(:skip_decryption) { false }
-
-    def eventstore_url=(value)
-      @eventstore_url =
-        if value.is_a?(Connection::Url)
-          value
-        else
-          Connection::UrlParser.new.call(value)
-        end
-    end
-
-    # @param logger [Logger, nil]
-    # @return [Logger, nil]
-    def logger=(logger)
-      ::GRPC.define_singleton_method :logger do
-        @logger ||= logger.nil? ? ::GRPC::DefaultLogger::NoopLogger.new : logger
-      end
-      @logger = logger
-    end
-  end
-
-  class << self
-    def configure
-      yield(config) if block_given?
-    end
-
-    def config
-      @config ||= Config.new
-    end
-
-    def client
-      GRPC::Client.new
-    end
-  end
-
-  # Configuration module to be included in classes required configured variables
-  # Usage: include EventStore::Configuration
-  # config.eventstore_url
-  #
   module Configuration
-    # An instance of the EventStoreClient's configuration
-    #
+    # @return [EventStoreClient::Config]
     def config
       EventStoreClient.config
     end

data/lib/event_store_client/connection/url.rb

@@ -52,6 +52,14 @@ module EventStoreClient
       option(:grpc_retry_attempts) { 3 }
       # Delay between GRPC request retries
       option(:grpc_retry_interval) { 100 } # milliseconds
+
+      # @param other [EventStoreClient::Connection::Url, Object]
+      # @return [Boolean]
+      def ==(other)
+        return false unless other.is_a?(Url)
+
+        options_hash == other.options_hash
+      end
     end
   end
 end

data/lib/event_store_client/version.rb

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

data/lib/event_store_client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-module EventStoreClient
-end
-
 require 'json'
 require 'set'
 
@@ -18,8 +15,27 @@ require 'event_store_client/connection/url'
 require 'event_store_client/connection/url_parser'
 require 'event_store_client/deserialized_event'
 require 'event_store_client/serialized_event'
+require 'event_store_client/config'
 require 'event_store_client/configuration'
 
 require 'event_store_client/mapper'
 
 require 'event_store_client/adapters/grpc'
+
+module EventStoreClient
+  class << self
+    def configure
+      yield(config) if block_given?
+    end
+
+    # @return [EventStore::Config]
+    def config
+      @config ||= Config.new
+    end
+
+    # @return [EventStore::GRPC::Client]
+    def client
+      GRPC::Client.new
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -191,7 +191,6 @@ files:
 - lib/event_store_client/adapters/grpc/discover.rb
 - lib/event_store_client/adapters/grpc/generated/cluster_pb.rb
 - lib/event_store_client/adapters/grpc/generated/cluster_services_pb.rb
-- lib/event_store_client/adapters/grpc/generated/code_pb.rb
 - lib/event_store_client/adapters/grpc/generated/gossip_pb.rb
 - lib/event_store_client/adapters/grpc/generated/gossip_services_pb.rb
 - lib/event_store_client/adapters/grpc/generated/monitoring_pb.rb
@@ -205,7 +204,6 @@ files:
 - lib/event_store_client/adapters/grpc/generated/serverfeatures_pb.rb
 - lib/event_store_client/adapters/grpc/generated/serverfeatures_services_pb.rb
 - lib/event_store_client/adapters/grpc/generated/shared_pb.rb
-- lib/event_store_client/adapters/grpc/generated/status_pb.rb
 - lib/event_store_client/adapters/grpc/generated/streams_pb.rb
 - lib/event_store_client/adapters/grpc/generated/streams_services_pb.rb
 - lib/event_store_client/adapters/grpc/generated/users_pb.rb
@@ -216,6 +214,7 @@ files:
 - lib/event_store_client/adapters/grpc/shared/options/stream_options.rb
 - lib/event_store_client/adapters/grpc/shared/streams/process_response.rb
 - lib/event_store_client/adapters/grpc/shared/streams/process_responses.rb
+- lib/event_store_client/config.rb
 - lib/event_store_client/configuration.rb
 - lib/event_store_client/connection/url.rb
 - lib/event_store_client/connection/url_parser.rb

data/lib/event_store_client/adapters/grpc/generated/code_pb.rb

@@ -1,34 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: code.proto
-
-require 'google/protobuf'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("code.proto", :syntax => :proto3) do
-    add_enum "google.rpc.Code" do
-      value :OK, 0
-      value :CANCELLED, 1
-      value :UNKNOWN, 2
-      value :INVALID_ARGUMENT, 3
-      value :DEADLINE_EXCEEDED, 4
-      value :NOT_FOUND, 5
-      value :ALREADY_EXISTS, 6
-      value :PERMISSION_DENIED, 7
-      value :UNAUTHENTICATED, 16
-      value :RESOURCE_EXHAUSTED, 8
-      value :FAILED_PRECONDITION, 9
-      value :ABORTED, 10
-      value :OUT_OF_RANGE, 11
-      value :UNIMPLEMENTED, 12
-      value :INTERNAL, 13
-      value :UNAVAILABLE, 14
-      value :DATA_LOSS, 15
-    end
-  end
-end
-
-module Google
-  module Rpc
-    Code = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.rpc.Code").enummodule
-  end
-end

data/lib/event_store_client/adapters/grpc/generated/status_pb.rb

@@ -1,23 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: status.proto
-
-require 'google/protobuf'
-
-require 'google/protobuf/any_pb'
-require_relative 'code_pb'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("status.proto", :syntax => :proto3) do
-    add_message "google.rpc.Status" do
-      optional :code, :enum, 1, "google.rpc.Code"
-      optional :message, :string, 2
-      optional :details, :message, 3, "google.protobuf.Any"
-    end
-  end
-end
-
-module Google
-  module Rpc
-    Status = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.rpc.Status").msgclass
-  end
-end