jackhammer 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0723d73e45b52cb78fa09945bcdc744c3d9e03ac49a97a362ce6cd97452c3b
-  data.tar.gz: afa8b40a275678cf67d1cff434bebd531f59e1a850fd7f23d4c412472eb5d510
+  metadata.gz: 4aa6bdf41e8005dbbfbcdc2bacfc4fae0a8e182cb35b62fea8d961ba350ef600
+  data.tar.gz: 7ce9c945039c1e09b4cec7406c6c1e767f5bc91baf76ace5a9dcdca940f7991b
 SHA512:
-  metadata.gz: 275da503e2f3b64c0a5b7b7d831416dcd84507ea98e8e14d736bbd38bb8f288ced5557108e3e3ea824ddf6dbcc9f0547ad91b68488704eafd779d1a8743ce80d
-  data.tar.gz: c5950cb078350bdb19a502cdf7d80a32166d7a4fe5ad6ab441054c014df4f9718818cc7a9e8cd5b1aa1fb7cb40f4eee833a8f5c2cc081d8082854134346734b5
+  metadata.gz: e6ace137b8bac8709c3c38cf7fe0109cda7a13e4fe59d4900bb059f9b1403c445eb67419375a9d1c7c438c84d8d55949bb59291f53aa9982f9658364f43a6283
+  data.tar.gz: b2d6807b73211b09db3db88bc02de9d2d0509a4451c4b1fc252d92e98eb5b864038c25f3482169fe0325d58b820a5a659c16efea077bf32c668a9fafd2f90ec5

data/.dependabot/config.yml

@@ -9,10 +9,3 @@ update_configs:
     allowed_updates:
       - match:
           update_type: "all"
-    automerged_updates:
-      - match:
-          dependency_type: "development"
-          update_type: "all"
-      - match:
-          dependency_type: "production"
-          update_type: "all"

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to track an issue that has been identified
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Mutation/Query**
+
+**URL and HTTP method (for non-GQL):**
+
+**Sentry or Logs URL:**
+
+**User/authentication details**
+Impacted user name or service account
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,22 @@
+---
+name: New story
+about: Add a new story for implementation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the solution**
+A clear and concise description of what you want to happen.
+When will this feature be done?
+
+**Describe the users**
+Who are we building this feature for?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+Link to any applicable documents describing the feature.
+
+**Designs**
+Link to any applicable designs on Invision.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+<!--- Describe your changes in detail -->
+
+## Related issue(s)
+<!--- GH issue number -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+
+## Screenshots (if appropriate):
+<!--- Please add any screenshots of the feature. -->
+
+## Related PRs
+<!--- Please add links to any related PRs (backend, component packages, etc). -->

data/.github/workflows/auto-approve.yml

@@ -0,0 +1,16 @@
+# automatically approve PRs submitted by Dependabot or Renofidev
+# this will allow Dependabot to automatically merge dependency update PRs where CI passes
+# from: https://github.com/hmarr/auto-approve-action
+name: Auto approve dependency upgrades PRs
+
+on:
+  pull_request
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hmarr/auto-approve-action@v2.0.0
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,29 @@
+name: automerge
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - synchronize
+      - opened
+      - edited
+      - ready_for_review
+      - reopened
+      - unlocked
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.11.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/Gemfile.lock

@@ -1,59 +1,83 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.3.3)
+    jackhammer (1.4.0)
       bunny (~> 2.14)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amq-protocol (2.3.0)
-    ast (2.4.0)
-    bunny (2.14.4)
-      amq-protocol (~> 2.3, >= 2.3.0)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    amq-protocol (2.3.2)
+    ast (2.4.1)
+    bunny (2.17.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
-    byebug (11.1.1)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.0.5)
-      ast (~> 2.4.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
       rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   bundler
   bunny-mock
   byebug

data/README.md

@@ -90,6 +90,8 @@ module MyApp
       config.publish_options    = { mandatory: true, persistent: true }
       config.yaml_config        = "config/jackhammer.yml"
       config.app_name           = "my_app"
+      config.client_middleware.use MyClientMiddleware, some_arg: 1, other_arg: 2
+      config.server_middleware.use MyServerMiddleware
     end
   end
 end
@@ -162,10 +164,47 @@ The intent of the options might not be obvious by looking at the name.
   overridden by passing the same options as arguments in your code).
 - **yaml_config** defines the file location of the Topic Exchange YAML
   configuration file.
+- **client_middleware** defines hooks that will be executed prior to publishing a message to a topic
+- **server_middleware** defines hooks that will be executed prior to running the message handler
 
 You can find defaults specified in the Jackhammer::Configuration class
 constructor.
 
+### Middleware
+
+Middleware allows you to hook into message publishing (client) and handling (server).
+
+It can be used to transform the passed in arguments before passing them along or to halt the execution completely.
+The execution will be halted if the middleware instance does not yield.
+
+#### Example client middleware
+
+```ruby
+class MyClientMiddleware
+  def initialize(name)
+    @name = name
+  end
+  
+  def call(message, options)
+    options[:headers][:hello] = @name
+
+    yield message, options
+  end
+end
+```
+
+#### Example server middleware
+
+```ruby
+class MyServerMiddleware
+  def call(handler:, delivery_info:, properties:, content:)
+    puts "Hello, #{properties[:headers]['name']}!"
+
+    yield handler: handler, delivery_info: delivery_info, properties: properties, content: content
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop:auto_correct spec]
+task default: %i[spec rubocop:auto_correct]

data/jackhammer.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6'
+
   spec.add_dependency 'bunny', '~> 2.14'
 
+  spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'bunny-mock'
   spec.add_development_dependency 'byebug'

data/lib/jackhammer.rb

@@ -7,6 +7,7 @@ require 'jackhammer/exceptions'
 require 'jackhammer/log'
 require 'jackhammer/configuration'
 require 'jackhammer/message_receiver'
+require 'jackhammer/middleware_collection'
 require 'jackhammer/queue_name'
 require 'jackhammer/queue'
 require 'jackhammer/topic'
@@ -46,5 +47,13 @@ module Jackhammer
         opts[:headers][:time] ||= time.iso8601
       end
     end
+
+    def client_middleware
+      configuration.client_middleware
+    end
+
+    def server_middleware
+      configuration.server_middleware
+    end
   end
 end

data/lib/jackhammer/cli.rb

@@ -5,7 +5,7 @@ module Jackhammer
     attr_reader :logger, :opts
 
     def initialize(options = {})
-      @logger = Logger.new STDERR
+      @logger = Logger.new $stderr
       @opts = { require: './config/environment' }.merge(options)
     end
 

data/lib/jackhammer/configuration.rb

@@ -2,6 +2,7 @@ module Jackhammer
   class Configuration
     attr_accessor(
       :app_name,
+      :client_middleware,
       :connection_options,
       :connection_url,
       :environment,
@@ -9,6 +10,7 @@ module Jackhammer
       :logger,
       :publish_options,
       :server,
+      :server_middleware,
       :yaml_config
     )
 
@@ -20,6 +22,8 @@ module Jackhammer
       @logger = Logger.new IO::NULL
       @publish_options = { mandatory: true, persistent: true }
       @yaml_config = './config/jackhammer.yml'
+      @client_middleware = MiddlewareCollection.new
+      @server_middleware = MiddlewareCollection.new
     end
 
     def self.instance

data/lib/jackhammer/configuration_validator.rb

@@ -0,0 +1,60 @@
+module Jackhammer
+  class ConfigurationValidator
+    attr_accessor :config_yaml, :environment, :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def validate
+      validate_environment_defined
+      return if errors.any?
+      validate_topic_exchange_defined
+      return if errors.any?
+      validate_queues_defined
+      return if errors.any?
+      validate_handlers_defined
+    end
+
+    def validate_environment_defined
+      return if config_yaml[environment]
+
+      add_error("Environment '#{environment}' is not defined")
+    end
+
+    def validate_topic_exchange_defined
+      return if config_yaml[environment].keys.any?
+
+      add_error("Environment '#{environment}' does not define a topic exchange")
+    end
+
+    def validate_queues_defined
+      topics = config_yaml[environment].keys
+      topics.each do |topic|
+        begin
+          next if config_yaml[environment][topic]['queues']
+        rescue StandardError
+          false
+        end
+
+        add_error("Topic '#{topic}' does not define any queues")
+      end
+    end
+
+    def validate_handlers_defined
+      config_yaml[environment].each do |exchange_name, exchange_config|
+        exchange_config['queues'].each do |qconfig|
+          Object.const_get(qconfig['handler'])
+        rescue NameError
+          add_error("Uninitialized constant #{qconfig['handler']}")
+        end
+      end
+    end
+
+    private
+
+    def add_error(str)
+      @errors << str
+    end
+  end
+end

data/lib/jackhammer/message_receiver.rb

@@ -15,6 +15,8 @@ module Jackhammer
       else
         handler.call message
       end
+    ensure
+      ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
     end
   end
 end

data/lib/jackhammer/middleware_collection.rb

@@ -0,0 +1,29 @@
+module Jackhammer
+  class MiddlewareCollection
+    def initialize
+      @entries = []
+    end
+
+    def use(klass, *args, &block)
+      @entries << Entry.new(klass: klass, args: args, block: block)
+    end
+
+    def call(*args, &block)
+      call_chain = @entries.map(&:instantiate) + [block]
+
+      traverse = proc do |*arguments|
+        call_chain.shift.call(*arguments, &traverse) unless call_chain.empty?
+      end
+
+      traverse.call(*args)
+    end
+
+    Entry = Struct.new(:klass, :args, :block, keyword_init: true) do
+      def instantiate
+        return klass unless klass.respond_to?(:new)
+
+        klass.new(*args, &block)
+      end
+    end
+  end
+end

data/lib/jackhammer/queue.rb

@@ -13,7 +13,15 @@ module Jackhammer
       queue.subscribe do |delivery_info, properties, content|
         Log.info { [delivery_info.inspect, properties.inspect].join(' || ') }
         Log.debug { content }
-        handler_object.call content
+
+        Jackhammer.server_middleware.call(
+          handler: handler_object,
+          delivery_info: delivery_info,
+          properties: properties,
+          content: content
+        ) do |**args|
+          args.fetch(:handler).call args.fetch(:content)
+        end
       rescue StandardError => e
         Log.error e
         Jackhammer.configuration.exception_adapter.call e

data/lib/jackhammer/queue_name.rb

@@ -7,7 +7,7 @@ module Jackhammer
     def self.from_routing_key(routing_key)
       fail(InvalidConfigError, "app_name must be set to determine queue_name from routing_key") if app_name.to_s.empty?
 
-      "#{app_name}_#{routing_key}_q".gsub(/[^\w]+/, '_').gsub(/[_]+/, '_')
+      "#{app_name}_#{routing_key}_q".gsub(/[^\w]+/, '_').squeeze('_')
     end
   end
 end

data/lib/jackhammer/rake_task.rb

@@ -0,0 +1,71 @@
+require 'rake'
+require 'rake/tasklib'
+require 'yaml'
+require 'jackhammer/configuration_validator'
+
+module Jackhammer
+  class RakeTask < ::Rake::TaskLib
+    # Name of test task. (default is :jackhammer)
+    attr_accessor :name
+
+    # File path of the configuration file. (default is ./config/jackhammer.yml)
+    attr_accessor :path
+
+    # Description of the test task. (default is 'Validate Jackhammer
+    # configuration')
+    attr_accessor :description
+
+    # Task prerequisites.
+    attr_accessor :deps
+
+    # Specifies the environment to inspect. (default is 'production')
+    attr_accessor :env
+
+    def initialize
+      super
+      @name = :jackhammer
+      @env = 'production'
+      @path = './config/jackhammer.yml'
+      @description = 'Validate Jackhammer configuration'
+      @deps = []
+      yield self if block_given?
+      if @name.is_a?(Hash)
+        @deps = @name.values.first
+        @name = @name.keys.first
+      end
+      define
+    end
+
+    def define
+      desc @description
+      task @name => Array(deps) do
+        validator = ConfigurationValidator.new
+        validator.config_yaml = YAML.safe_load(File.read(@path), [], [], true)
+        validator.environment = env
+        validator.validate
+        print_results validator.errors
+      end
+    end
+
+    private
+
+    def print_results(errors)
+      puts "Jackhammer configuration #{path}\n"
+      if errors.any?
+        puts red("Problems identified: #{errors.size}\n")
+        errors.each { |error| puts red(error) }
+        exit 1
+      else
+        puts green('OK')
+      end
+    end
+
+    def red(text)
+      "\e[1;31m#{text}\e[0m"
+    end
+
+    def green(text)
+      "\e[1;32m#{text}\e[0m"
+    end
+  end
+end

data/lib/jackhammer/topic.rb

@@ -15,7 +15,9 @@ module Jackhammer
     # We're expecting the client to specify at least the routing_key in options
     # for each message published.
     def publish(message, options)
-      topic.publish message, Jackhammer.publish_options(options)
+      Jackhammer.client_middleware.call(message, Jackhammer.publish_options(options)) do |msg, opts|
+        topic.publish msg, opts
+      end
     end
 
     def queues

data/lib/jackhammer/version.rb

@@ -1,3 +1,3 @@
 module Jackhammer
-  VERSION = '1.3.3'.freeze
+  VERSION = '1.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Scott Serok
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dependabot/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/story.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -158,11 +178,14 @@ files:
 - lib/jackhammer.rb
 - lib/jackhammer/cli.rb
 - lib/jackhammer/configuration.rb
+- lib/jackhammer/configuration_validator.rb
 - lib/jackhammer/exceptions.rb
 - lib/jackhammer/log.rb
 - lib/jackhammer/message_receiver.rb
+- lib/jackhammer/middleware_collection.rb
 - lib/jackhammer/queue.rb
 - lib/jackhammer/queue_name.rb
+- lib/jackhammer/rake_task.rb
 - lib/jackhammer/server.rb
 - lib/jackhammer/topic.rb
 - lib/jackhammer/topic_manager.rb
@@ -181,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Jackhammer is an opinionated facade over RabbitMQ Bunny