hermes-rb 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a8150916885c53a7ec982a4a8b4c52b3ae181c372a49d848af7e1938c4e57d
-  data.tar.gz: 1df94ecfc4595c5c8e6c67d79750c4a2fbca4f1a7119a1f5c532b83890a9e1f8
+  metadata.gz: 01e56f5cf846518bbedba098f5d3129cea50b81390e948eb8b3640cd98b4ee58
+  data.tar.gz: d672a90b3b7ddec2b8c7fcf3a57307c208297362dd16191c11792f4d8ddc4d4f
 SHA512:
-  metadata.gz: 57bd2ad4a3a48368360bc1d7fcd42817ef698f326c423068b237123142707d64ca025af62cc8fc0bc9540a0cfe338d701124d73a19b3fe6795c98a7a91ff3a50
-  data.tar.gz: 89550087ed862bdeb2cb3472d766071f6504f8608ffad58c3fa164c756dee2775b91d7ee299a55949e8ba7d8a31750accaff0688269a13cf81185a924bf71cfc
+  metadata.gz: 9440e207aaddc314e99d66e87c9d0296b80df0280c2d4112e4d1b6530fcf3bf9da17fcdb44f398ae8f607cf6c4dbf4eed66ba44b6836d748781ce997100777d6
+  data.tar.gz: 55886c1f907cf1031bdf2fb8528bfa5e4efeb062161aef0e64c6b6bf601481eb411736b93e24b0b21b5a11636d0a308f5c73bce4508e2071698c7b670e5eceff

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+on: [pull_request]
+jobs:
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: '2.7', rails: '5.2' }
+          - { ruby: '3.0', rails: '6.1' }
+          - { ruby: '3.1', rails: '7.0' }
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails.${{ matrix.rails }}.gemfile
+      DATABASE_URL: "postgresql://postgres:postgres@127.0.0.1:5432/hermes-rb-test"
+      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
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: hermes-rb-test
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      rabbitmq:
+        image: rabbitmq
+        env:
+          RABBITMQ_DEFAULT_USER: guest
+          RABBITMQ_DEFAULT_PASS: guest
+        ports:
+          - 5672:5672
+        options: --health-cmd "rabbitmqctl node_health_check" --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-gemset

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/Appraisals

@@ -0,0 +1,12 @@
+%w[5.2 6.1 7.0].each do |version|
+  appraise "rails.#{version}" do
+    gem "activesupport", "~> #{version}.0"
+    gem "activerecord", "~> #{version}.0"
+
+    if version == "5.2"
+      gem "ddtrace", "< 1.0"
+    else
+      gem "ddtrace", "> 1.0"
+    end
+  end
+end

data/Changelog.md

@@ -2,6 +2,15 @@
 
 ## Master
 
+## 0.7.0
+- Add support for DDTrace v1
+
+## 0.6.1
+- Extend the list of sensitive keywords for Hermes::Logger::ParamsFilter
+
+## 0.6.0
+- Add Health check
+
 ## 0.5.0
 - Add Datadog tracer
 - Allow to provide a custom tracer

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes-rb (0.5.0)
+    hermes-rb (0.7.0)
       activerecord (>= 5)
       activesupport (>= 5)
       dry-container (~> 0)
@@ -12,36 +12,40 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     amq-protocol (2.3.2)
-    bunny (2.15.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    bunny (2.19.0)
       amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
     carrot-top (0.0.7)
       json
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     ddtrace (0.45.0)
       msgpack
     diff-lcs (1.4.4)
-    dry-configurable (0.12.1)
+    dry-configurable (0.15.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
     dry-struct (1.4.0)
@@ -54,23 +58,24 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    hutch (1.0.0)
-      activesupport (>= 4.2, < 7)
-      bunny (>= 2.15, < 2.16)
+    hutch (1.1.1)
+      activesupport (>= 4.2, < 8)
+      bunny (>= 2.19, < 3.0)
       carrot-top (~> 0.0.7)
-      multi_json (~> 1.14)
-    i18n (1.8.9)
+      multi_json (~> 1.15)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.5.1)
-    minitest (5.14.4)
+    json (2.6.2)
+    minitest (5.15.0)
     msgpack (1.4.2)
     multi_json (1.15.0)
     newrelic_rpm (6.15.0)
     pg (1.2.3)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rake (13.0.1)
-    request_store (1.5.0)
+    rbtree (0.4.5)
+    request_store (1.5.1)
       rack (>= 1.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -85,16 +90,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    set (1.0.2)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    thor (1.2.1)
     timecop (0.9.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     vcr (5.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
   bundler
   ddtrace
   hermes-rb!
@@ -106,4 +116,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -37,8 +37,8 @@ Rails.application.config.to_prepare do
     config.configure_hutch do |hutch|
       hutch.uri = ENV.fetch("HUTCH_URI")
       hutch.force_publisher_confirms = true
-      hutch.enable_http_api_use = false 
-      hutch.tracer = MyOwnCustomTracerIfIWantToDoSomethingCrazy 
+      hutch.enable_http_api_use = false
+      hutch.tracer = MyOwnCustomTracerIfIWantToDoSomethingCrazy
     end
     config.distributed_tracing_database_uri = ENV.fetch("DISTRIBUTED_TRACING_DATABASE_URI", nil)
     config.error_notification_service = Raven
@@ -47,7 +47,7 @@ Rails.application.config.to_prepare do
   event_handler.handle_events do
     handle Events::Example::Happened, with: Example::HappenedHandler
     handle Events::Example::SyncCallHappened, with: Example::SyncCallHappenedHandler, async: false
-    
+
     extra_consumer_config = -> do
       classic_queue
       quorum_queue initial_group_size: 3
@@ -148,7 +148,7 @@ If you don't care about it, you can leave it empty.
 
 12. `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)` 
+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. `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.
 
@@ -160,7 +160,7 @@ If you don't care about it, you can leave it empty.
 
 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:
    - 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.  
+   - 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
 
 If you want to handle RPC call, you need to add `rpc: true` flag. Keep in mind that RPC requires a synchronous processing and response, so you also need to set `async: false`. The routing key and correlation ID will be resolved based on the message that is published by the client. The payload that is sent back will be what event handler reutrns, so it might be a good idea to just return a hash so that you can operate on JSON easily.
@@ -459,6 +459,33 @@ end
 
 Hermes is just an extra layer on top of [hutch](https://github.com/gocardless/hutch), refer to Hutch's docs for more info about dealing with the workers and deployment.
 
+## Health Checks
+
+If you want to perform a health check, use `Hermes::Checks::HealthCheck.check`, which checks if it's possible to connect RabbitMQ via Hutch.
+
+The interface is compliant with `health_check`[https://github.com/ianheggie/health_check] gem. If you want to add the custom health check, just add this to the config:
+
+``` rb
+config.add_custom_check("hermes") do
+  Hermes::Checks::HealthCheck.check
+end
+```
+
+You can also use `bin/health_check` file to perform healthcheck - on success, the script exits with `0` status and on failure, it logs the error and exits with `1` status.
+
+To perform the actual check:
+
+1. Via `health_check` gem:
+```
+curl -v localhost:3000/health_check/hermes.json
+```
+
+2. Via binary:
+
+```
+bundle exec hermes_health_check
+```
+
 ## CircleCI config for installing RabbitMQ
 
 Use `- image: brandembassy/rabbitmq:latest`

data/bin/hermes_health_check

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/hermes-rb"
+
+result = Hermes::Checks::HealthCheck.check
+if result.empty?
+  exit 0
+else
+  Hermes::DependenciesContainer["logger"].log_health_check_failure(result)
+  exit 1
+end

data/gemfiles/rails.5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "ddtrace", "< 1.0"
+
+gemspec path: "../"

data/gemfiles/rails.6.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.1.0"
+gem "activerecord", "~> 6.1.0"
+gem "ddtrace", "> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails.7.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 7.0.0"
+gem "activerecord", "~> 7.0.0"
+gem "ddtrace", "> 1.0"
+
+gemspec path: "../"

data/hermes-rb.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = ["hermes_health_check"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dry-struct", "~> 1"
@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pg"
   spec.add_development_dependency "newrelic_rpm"
   spec.add_development_dependency "ddtrace"
+  spec.add_development_dependency "appraisal"
 end

data/lib/hermes/checks/health_check.rb

@@ -0,0 +1,14 @@
+module Hermes
+  module Checks
+    class HealthCheck
+      def self.check
+        broker = Hutch::Broker.new
+        broker.connect
+        broker.disconnect
+        ""
+      rescue StandardError => e
+        "[Hermes - #{e.message}] "
+      end
+    end
+  end
+end

data/lib/hermes/checks.rb

@@ -0,0 +1,5 @@
+module Hermes
+  module Checks
+    autoload :HealthCheck, "hermes/checks/health_check"
+  end
+end

data/lib/hermes/logger/params_filter.rb

@@ -2,7 +2,7 @@ module Hermes
   class Logger
     class ParamsFilter
       SENSITIVE_ATTRIBUTES_KEYWORDS = %w(token password credit_card card_number security_code verification_value
-        private_key signature api_key secret_key publishable_key).freeze
+        private_key signature api_key secret_key publishable_key client_key client_secret secret).freeze
       STRIPPED_VALUE = "[STRIPPED]".freeze
 
       private_constant :SENSITIVE_ATTRIBUTES_KEYWORDS, :STRIPPED_VALUE

data/lib/hermes/logger.rb

@@ -17,6 +17,10 @@ module Hermes
       backend.info "[Hutch] published event to: #{routing_key}, properties: #{properties}, body: #{strip_sensitive_info(body)} at #{timestamp}"
     end
 
+    def log_health_check_failure(error)
+      backend.info "[Hermes] health check failed: #{error}"
+    end
+
     private
 
     def strip_sensitive_info(body)

data/lib/hermes/rb/version.rb

@@ -1,5 +1,5 @@
 module Hermes
   module Rb
-    VERSION = "0.5.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/hermes/tracers/datadog.rb

@@ -11,7 +11,13 @@ module Hermes
       end
 
       def handle(message)
-        ::Datadog.tracer.trace(klass.class.name, service: "hermes", span_type: "rabbitmq") do
+        tracer = ::Datadog.respond_to?(:tracer) ? ::Datadog.tracer : "Datadog::Tracing".safe_constantize
+
+        tracer.trace(
+          klass.class.name || klass.class.to_s,
+          service: "hermes",
+          span_type: "rabbitmq"
+        ) do
           klass.process(message)
         end
       end

data/lib/hermes.rb

@@ -25,6 +25,7 @@ require "hermes/producer_error_handler"
 require "hermes/producer_error_handler/null_handler"
 require "hermes/producer_error_handler/safe_handler"
 require "hermes/tracers"
+require "hermes/checks"
 require "active_support"
 require "active_support/core_ext/string"
 require "active_record"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -206,17 +206,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A messenger of gods, delivering them via RabbitMQ with a little help
   from Hutch
 email:
 - dev@bookingsync.com
-executables: []
+executables:
+- hermes_health_check
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
+- Appraisals
 - Changelog.md
 - Gemfile
 - Gemfile.lock
@@ -224,12 +241,18 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/hermes_health_check
 - bin/setup
+- gemfiles/rails.5.2.gemfile
+- gemfiles/rails.6.1.gemfile
+- gemfiles/rails.7.0.gemfile
 - hermes-rb.gemspec
 - lib/hermes-rb.rb
 - lib/hermes.rb
 - lib/hermes/b_3_propagation_model_headers.rb
 - lib/hermes/base_event.rb
+- lib/hermes/checks.rb
+- lib/hermes/checks/health_check.rb
 - lib/hermes/configuration.rb
 - lib/hermes/consumer_builder.rb
 - lib/hermes/database_error_handler.rb
@@ -284,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A messenger of gods, delivering them via RabbitMQ with a little help from

data/.travis.yml

@@ -1,17 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-env:
-  - HUTCH_URI="amqp://guest:guest@localhost:5672"
-  - HUTCH_ENABLE_HTTP_API_USE=false
-dist: xenial
-addons:
-  apt:
-    packages:
-      - rabbitmq-server
-services:
-  - rabbitmq
-  - postgresql
-before_install: gem install bundler -v 2.1.4