hermes-rb 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f84d7c23f44dbdf7aabfa38122dd94c231c907b04d4aabe6ec444feef5ba7b2
-  data.tar.gz: 2eaf59a2dbca4952a7eaaa7fe053bcee8c9e783235fead16034b45ceb4850668
+  metadata.gz: 94bc121c20cdf80f4be52db46705782fae1f33fd2e8361d2d0b0f584680f2f84
+  data.tar.gz: badec7fcc51dc9952988e586a25fbf3b1fafb790decd629ee10d5ab895f29ad0
 SHA512:
-  metadata.gz: 31728fa8f53e90d0317e964c92f3b3a8bc1e879821b12f46ec0441b5027f60c6983a4afe8d473a51954894ed8221941c7d8ceed78f45650aa9a791fa70964af7
-  data.tar.gz: 5950b3d5121580f9948c818ecdbf3d66f102ea118e74382f8e4d1943deb8fe226d492df55b9535c938ac1b1a7f06f74c73e848a0e03c27d5b0db1d4b9f4514e9
+  metadata.gz: 20fb54844b44a01513257e0dbaa17be96c626d50435cea0ac0773b765a153e190bc8946f7fcdc6540a7ad313ce352ef92cc31c966325fe339c1314484fefc248
+  data.tar.gz: 06a98ecb7d2843dabcf9719de5373e948d1b1826fae3bdb5361671497ad7d00f731e954485c0db1793fab7e369c7b308aa14b3fac3319e4ae37fa8c21661255c

data/.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
       DISTRIBUTED_TRACING_DATABASE_URI: "postgresql://postgres:postgres@127.0.0.1:5432/hermes-rb-test"
       HUTCH_URI: "amqp://guest:guest@127.0.0.1:5672"
       HUTCH_ENABLE_HTTP_API_USE: false
+      DD_PROFILING_NO_EXTENSION: true
     services:
       postgres:
         image: postgres:14

data/Changelog.md

@@ -2,6 +2,14 @@
 
 ## Master
 
+## 0.7.3
+
+- Handle database reconnection in synchronous flow
+- Improve test coverage of `Hermes::Logger::ParamsFilter` - cover regular expressions
+
+## 0.7.2
+- Clear Hermes.origin_headers after calling event handlers
+
 ## 0.7.1
 - Fix Hermes::DistributedTraceRepository so that it properly applies mapper that modifies event body
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes-rb (0.7.1)
+    hermes-rb (0.7.3)
       activerecord (>= 5)
       activesupport (>= 5)
       dry-container (~> 0)
@@ -12,12 +12,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -36,24 +36,27 @@ GEM
     ddtrace (0.45.0)
       msgpack
     diff-lcs (1.4.4)
-    dry-container (0.10.0)
+    dry-container (0.11.0)
       concurrent-ruby (~> 1.0)
-    dry-core (0.8.0)
+    dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.3.0)
-    dry-logic (1.2.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-struct (1.4.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.5)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
       ice_nine (~> 0.11)
-    dry-types (1.5.1)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
     hutch (1.1.1)
       activesupport (>= 4.2, < 8)
       bunny (>= 2.19, < 3.0)
@@ -63,12 +66,12 @@ GEM
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.6.2)
-    minitest (5.16.2)
+    minitest (5.16.3)
     msgpack (1.4.2)
     multi_json (1.15.0)
     newrelic_rpm (6.15.0)
     pg (1.2.3)
-    rack (2.2.4)
+    rack (3.0.1)
     rake (13.0.1)
     rbtree (0.4.5)
     request_store (1.5.1)
@@ -86,15 +89,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    set (1.0.2)
+    set (1.0.3)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
     thor (1.2.1)
     timecop (0.9.2)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     vcr (5.0.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -30,6 +30,7 @@ Rails.application.config.to_prepare do
     config.adapter = Rails.application.config.async_messaging_adapter
     config.application_prefix = "my_app"
     config.background_processor = HermesHandlerJob
+    config.database_connection_provider = ActiveRecord::Base.connection
     config.enqueue_method = :perform_async
     config.event_handler = event_handler
     config.clock = Time.zone
@@ -87,14 +88,15 @@ end
 
 If you know what you are doing, you don't necessarily have to process things in the background. As long as the class implements the expected interface, you can do anything you want.
 
-5. `event_handler` - an instance of event handler/storage, just use what is shown in the example. Notice that you can also pass extra consumer config lambda that will be evaluated within the context of Hutch consumer.
-6. `clock` - a clock object that is time-zone aware, implementing `now` method.
-7. `configure_hutch` - a way to configure Hutch:
+5. `database_connection_provider` - an object responding to `reconnect!`. It is used during synchronous flow to ensure a valid connection. Optional.
+6. `event_handler` - an instance of event handler/storage, just use what is shown in the example. Notice that you can also pass extra consumer config lambda that will be evaluated within the context of Hutch consumer.
+7. `clock` - a clock object that is time-zone aware, implementing `now` method.
+8. `configure_hutch` - a way to configure Hutch:
    - `uri` - the URI for RabbitMQ, required.
    - `force_publisher_confirms` - defaults to `true`
    - `enable_http_api_use` - defaults to `false`
    - `tracer` - defaults to `Hermes::Tracers::Datadog` if you use Datadog, `Hutch::Tracers::NewRelic` for NewRelic and `Hutch::Tracers::NullTracer` if you use neither Datadog, nor NewRelic. Check APM section for more details if you want to provide a custom tracer.
-8. `event_handler.handle_events` - that's how you declare events and their handlers. The event handler is an object that responds to `call` method and takes `event` as an argument. All events should ideally be subclasses of `Hermes::BaseEvent`
+9. `event_handler.handle_events` - that's how you declare events and their handlers. The event handler is an object that responds to `call` method and takes `event` as an argument. All events should ideally be subclasses of `Hermes::BaseEvent`
 
 This class inherits from `Dry::Struct`, so getting familiar with [dry-struct gem](https://dry-rb.org/gems/dry-struct/) would be beneficial. Here is an example event:
 
@@ -122,9 +124,9 @@ To avoid unexpected problems, don't use restricted names for attribtes such as `
 
 You can also specify whether the event should be processed asynchronously using `background_processor` (default behavior) or synchronously. If you want the event to be processed synchronously, e.g. when doing RPC, use `async: false` option.
 
-9. `rpc_call_timeout` - a timeout for RPC calls, defaults to 10 seconds. Can be also customized per instance of RPC Client (covered later). Optional.
+10. `rpc_call_timeout` - a timeout for RPC calls, defaults to 10 seconds. Can be also customized per instance of RPC Client (covered later). Optional.
 
-10. `instrumenter` - instrumenter object responding to `instrument` method taking one string argument, one optional hash argument and a block.
+11. `instrumenter` - instrumenter object responding to `instrument` method taking one string argument, one optional hash argument and a block.
 
 For example:
 
@@ -144,21 +146,21 @@ end
 
 If you don't care about it, you can leave it empty.
 
-11. `distributed_tracing_database_uri` - If you want to enable distributed tracing, specify Postgres database URI. Optional.
+12. `distributed_tracing_database_uri` - If you want to enable distributed tracing, specify Postgres database URI. Optional.
 
-12. `distributed_tracing_database_table` - Table name for storing traces, by default it's `hermes_distributed_traces`. Optional.
+13. `distributed_tracing_database_table` - Table name for storing traces, by default it's `hermes_distributed_traces`. Optional.
 
-13. `distributes_tracing_mapper` - an object responding to `call` method taking one argument (a hash of attributes) which must return a hash as well. This hash will be used for assigning attributes when creating `Hermes::DistributedTrace`. It defaults to `Hermes::DistributedTrace::Mapper`, which uses `logger_params_filter` to remove sensitive info (this config option is covered below). You can either provide a custom mapper or pass a custom params filter, for example: `Hermes::DistributedTrace::Mapper.new(params_filter: custom_params_filter)`
+14. `distributes_tracing_mapper` - an object responding to `call` method taking one argument (a hash of attributes) which must return a hash as well. This hash will be used for assigning attributes when creating `Hermes::DistributedTrace`. It defaults to `Hermes::DistributedTrace::Mapper`, which uses `logger_params_filter` to remove sensitive info (this config option is covered below). You can either provide a custom mapper or pass a custom params filter, for example: `Hermes::DistributedTrace::Mapper.new(params_filter: custom_params_filter)`
 
-14. `error_notification_service` - an object responding to `capture_exception` method taking one argument (error). Its interface is based on `Raven` from [Sentry Raven](https://github.com/getsentry/sentry-ruby/tree/master/sentry-raven). By default `Hermes::NullErrorNotificationService` is used, which does nothing. Optional.
+15. `error_notification_service` - an object responding to `capture_exception` method taking one argument (error). Its interface is based on `Raven` from [Sentry Raven](https://github.com/getsentry/sentry-ruby/tree/master/sentry-raven). By default `Hermes::NullErrorNotificationService` is used, which does nothing. Optional.
 
-15. `database_error_handler` - `an object responding to `call` method taking one argument (error). Used when storing distributed traces. By default it uses `Hermes::DatabaseErrorHandler` which depends on `error_notification_service`, so in most cases, you will probably want to just configure `error_notification_service`. Optional.
+16. `database_error_handler` - `an object responding to `call` method taking one argument (error). Used when storing distributed traces. By default it uses `Hermes::DatabaseErrorHandler` which depends on `error_notification_service`, so in most cases, you will probably want to just configure `error_notification_service`. Optional.
 
-16. `enable_safe_producer` - a method requiring a job class implementing `enqueue` method that will be responsible for retrying delivery of the event later in case it fails. Check `Safe Event Producer` section for more details.
+17. `enable_safe_producer` - a method requiring a job class implementing `enqueue` method that will be responsible for retrying delivery of the event later in case it fails. Check `Safe Event Producer` section for more details.
 
-17. `producer_retryable` - used when `safe_producer` was enabled via (`enable_safe_producer`). By default, it is a method retrying delivery 3 times rescuing from `StandardError` each time. The object responsible for this behavior by default is: `Hermes::Retryable.new(times: 3, errors: [StandardError])`.
+18. `producer_retryable` - used when `safe_producer` was enabled via (`enable_safe_producer`). By default, it is a method retrying delivery 3 times rescuing from `StandardError` each time. The object responsible for this behavior by default is: `Hermes::Retryable.new(times: 3, errors: [StandardError])`.
 
-18. `logger_params_filter` - a service used as params filter for logger, to make sure no sensitive data will be logged. It defaults to `Hermes::Logger::ParamsFilter` which already performs some filtering but it might not be enough in your case. If you are not satisfied with the defaults, you have 2 options, which are especially simple in Rails apps:
+19. `logger_params_filter` - a service used as params filter for logger, to make sure no sensitive data will be logged. It defaults to `Hermes::Logger::ParamsFilter` which already performs some filtering but it might not be enough in your case. If you are not satisfied with the defaults, you have 2 options, which are especially simple in Rails apps:
    - provide custom array of sensitive attributes and still use a default filter: `Hermes::Logger::ParamsFilter.new(sensitive_keywords: Rails.application.config.filter_parameters)`.
    - provide custom filter object, which responds to `call` method and takes 2 arguments: attribute name and its value and performs mutation by using `gsub!` (don't worry, the entire body is cloned before passing it to the filter, so nothing unexpected will happen). This is compatible with the interface of `Rails.application.config.filter_parameters` when you use a custom filter there. In such case, you can do something like this: `Rails.application.config.filter_parameters = [Proc.new { |k, v| do_something_custom_here(k, v) }]` and then just assign `Rails.application.config.filter_parameters.first` in the Hermes config.
 ## RPC

data/lib/hermes/configuration.rb

@@ -4,7 +4,7 @@ module Hermes
       :background_processor, :enqueue_method, :event_handler, :rpc_call_timeout,
       :instrumenter, :distributed_tracing_database_uri, :distributed_tracing_database_table,
       :distributes_tracing_mapper, :database_error_handler, :error_notification_service, :producer_error_handler,
-      :producer_error_handler_job_class, :producer_retryable, :logger_params_filter, :tracer
+      :producer_error_handler_job_class, :producer_retryable, :logger_params_filter, :tracer, :database_connection_provider
 
     def configure_hutch
       yield hutch

data/lib/hermes/consumer_builder.rb

@@ -25,6 +25,7 @@ module Hermes
               config.background_processor.public_send(config.enqueue_method, event_class.to_s, body, headers)
               logger.log_enqueued(event_class, body, headers, config.clock.now)
             else
+              ensure_database_connection!
               result = event_processor.call(event_class.to_s, body, headers)
               event = result.event
               response = result.response
@@ -58,6 +59,10 @@ module Hermes
         def event_processor
           Hermes::DependenciesContainer["event_processor"]
         end
+
+        def ensure_database_connection!
+          config.database_connection_provider.reconnect! if config.database_connection_provider
+        end
       end
 
       register_consumer(consumer_name, consumer)

data/lib/hermes/event_processor.rb

@@ -19,12 +19,13 @@ module Hermes
 
     def call(event_class, body, headers)
       event = Object.const_get(event_class).from_body_and_headers(body, headers)
-      Hermes.origin_headers = headers
 
-      instrumenter.instrument("Hermes.EventProcessor.#{event_class}") do
-        response = infer_handler(event_class).call(event)
-        distributed_trace_repository.create(event)
-        ProcessingResult.new(event, response)
+      Hermes.with_origin_headers(headers) do
+        instrumenter.instrument("Hermes.EventProcessor.#{event_class}") do
+          response = infer_handler(event_class).call(event)
+          distributed_trace_repository.create(event)
+          ProcessingResult.new(event, response)
+        end
       end
     end
 

data/lib/hermes/rb/version.rb

@@ -1,5 +1,5 @@
 module Hermes
   module Rb
-    VERSION = "0.7.1"
+    VERSION = "0.7.3"
   end
 end

data/lib/hermes.rb

@@ -50,6 +50,16 @@ module Hermes
   def self.origin_headers=(headers)
     DependenciesContainer["global_store"][ORIGIN_HEADERS_KEY] = headers.to_h
   end
+
+  def self.clear_origin_headers
+    DependenciesContainer["global_store"].delete(ORIGIN_HEADERS_KEY)
+  end
+
+  def self.with_origin_headers(headers)
+    self.origin_headers = headers
+
+    yield.tap { clear_origin_headers }
+  end
 end
 
 require "hermes/distributed_trace"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes-rb
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct