freddy 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: afcbdc550b2c021be177ce71767e874d88f62266
-  data.tar.gz: b385e9fc1aa1f12d01e42db629c8e669f56c08f8
+SHA256:
+  metadata.gz: 7ae99c2d347a67110923b71ffac1af46c706d177b39b82c3adaae4db3f686a1d
+  data.tar.gz: 557210126d3c4cdff8f0946ee5b6882e3334126c3cb0ae900df823f6e762fdd9
 SHA512:
-  metadata.gz: b850d5ce01a28ee9f1ed0762ac61ca293a36270d754f2065d5cfcfc4f8ee2f666584a0e82d60ebafc1c734692835bd39e38319b63fdbd2509862a4707db5f13d
-  data.tar.gz: 47cf5182652976f7966226142845fd3c64077046d5fbeb5b5627c20a4e2a69936b33f26731344f74273a32b778f01420299b5a80ca9147e802a897e72cb8081a
+  metadata.gz: a2ee88b1ec7e51523ae6b3851f07b398b9093d90b193712bce172a09764d2a683d0b5209ced2a4a524248d8ffab36074b8a0b65c662ef9844f319424ccb32e93
+  data.tar.gz: ea65f5f23e18c768098c1eec7edc299a146f0fc830a0a57b5e9d1f725b5fe6f0b442b017ecd08b80f6242424a6a0958b57c8514cdf015bca07e4d316e88edc56

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7']
+    services:
+      rabbitmq:
+        image: rabbitmq
+        ports:
+          - 5672:5672
+        options: --health-cmd "rabbitmqctl node_health_check" --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run lint & tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,39 +1,23 @@
-require: rubocop-rspec
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
 
-Metrics/AbcSize:
-  Enabled: no
-
-Metrics/BlockLength:
-  Enabled: no
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
-Metrics/MethodLength:
-  Enabled: no
-
-Style/Documentation:
-  Enabled: no
-
-RSpec/ExampleLength:
-  Enabled: no
-
-RSpec/MultipleExpectations:
+Lint/EmptyBlock:
   Enabled: no
 
-RSpec/MessageSpies:
-  Enabled: no
-
-RSpec/VerifiedDoubles:
+Metrics/AbcSize:
   Enabled: no
 
-RSpec/InstanceVariable:
+Metrics/BlockLength:
   Enabled: no
 
-RSpec/NestedGroups:
+Metrics/MethodLength:
   Enabled: no
 
-RSpec/DescribeClass:
+Style/Documentation:
   Enabled: no
 
 Style/FrozenStringLiteralComment:
@@ -42,8 +26,5 @@ Style/FrozenStringLiteralComment:
   Include:
     - 'lib/**/*'
 
-Performance/TimesMap:
-  Enabled: no
-
 Naming/FileName:
   Enabled: no

data/.ruby-gemset

@@ -1 +1 @@
-sm-messaging
+freddy

data/.ruby-version

@@ -1 +1 @@
-2.4
+2.7

data/Gemfile

@@ -1,11 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'codeclimate-test-reporter'
 gem 'hamster', '~> 3.0'
-gem 'opentracing_test_tracer', '~> 0.1'
+gem 'opentelemetry-sdk', '~> 1.0.0.rc3'
 gem 'pry'
 gem 'rspec'
-gem 'rubocop', '~> 0.54.0'
-gem 'rubocop-rspec', '~> 1.24.0'
+gem 'rubocop', '~> 1.19'
+gem 'rubocop-rspec', '~> 2.4'
 
 gemspec

data/README.md

@@ -1,8 +1,6 @@
 # Messaging API supporting acknowledgements and request-response
 
-[![Build Status](https://travis-ci.org/salemove/freddy.svg?branch=master)](https://travis-ci.org/salemove/freddy)
-[![Code Climate](https://codeclimate.com/github/salemove/freddy/badges/gpa.svg)](https://codeclimate.com/github/salemove/freddy)
-[![Test Coverage](https://codeclimate.com/github/salemove/freddy/badges/coverage.svg)](https://codeclimate.com/github/salemove/freddy/coverage)
+[![Build Status](https://github.com/salemove/freddy/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/salemove/freddy/actions/workflows/ci.yml?query=branch%3Amaster)
 
 ## Setup
 
@@ -121,6 +119,16 @@ freddy.tap_into "somebody.*.love"
 
 receives messages that are delivered to `somebody.to.love` but doesn't receive messages delivered to `someboy.not.to.love`
 
+It is also possible to tap using multiple patterns:
+
+```ruby
+freddy.tap_into(['user.created', 'user.deleted'], group: 'user-event') do
+  # This processes events from both user.created topic and user.deleted topic.
+  # It also groups them into one queue called 'user-event'. This ensures that
+  # only one listener within a group process a particular event.
+end
+```
+
 ## The ResponderHandler
 
 When responding to a message or tapping the ResponderHandler is returned.
@@ -137,14 +145,11 @@ responder_handler.shutdown
 
 ## Request Tracing
 
-Freddy supports [OpenTracing API|https://github.com/opentracing/opentracing-ruby]. You must set a global tracer which then freddy will use:
-```ruby
-OpenTracing.global_tracing = MyTracerImplementation.new(...)
-```
-
-Current trace can be accessed through a thread-local variable `OpenTracing.active_span`. Calling `deliver` or `deliver_with_response` will pass trace context to down-stream services.
+Freddy supports [OpenTelemetry API|https://github.com/open-telemetry/opentelemetry-ruby].
+The trace information is automatically passed through `deliver`,
+`deliver_with_response`, `respond_to` and `tap_into` calls.
 
-See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more information.
+This is not compatible with `opentelemetry-instrumentation-bunny` library.
 
 ## Notes about concurrency
 

data/freddy.gemspec

@@ -1,19 +1,17 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freddy/version'
 
 Gem::Specification.new do |spec|
-  spec.name = if RUBY_PLATFORM == 'java'
-                'freddy-jruby'
-              else
-                'freddy'
-              end
-  spec.version       = '1.4.2'
-  spec.authors       = ['Salemove TechMovers']
+  spec.name          = 'freddy'
+  spec.version       = Freddy::VERSION
+  spec.authors       = ['Glia TechMovers']
   spec.email         = ['techmovers@salemove.com']
   spec.description   = 'Messaging API'
   spec.summary       = 'API for inter-application messaging supporting acknowledgements and request-response'
-  spec.license       = 'Private'
+  spec.license       = 'MIT'
+  spec.homepage      = 'https://github.com/salemove/freddy'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -23,14 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 
-  if RUBY_PLATFORM == 'java'
-    spec.add_dependency 'march_hare', '~> 2.12.0'
-    spec.add_dependency 'symbolizer'
-  else
-    spec.add_dependency 'bunny', '~> 2.11'
-    spec.add_dependency 'oj', '~> 2.13'
-  end
-
-  spec.add_dependency 'opentracing', '~> 0.4'
+  spec.add_dependency 'bunny', '~> 2.11'
+  spec.add_dependency 'oj', '~> 3.6'
+  spec.add_dependency 'opentelemetry-api', '~> 1.0.0.rc3'
+  spec.add_dependency 'opentelemetry-semantic_conventions', '~> 1.0'
   spec.add_dependency 'thread', '~> 0.1'
 end

data/lib/freddy.rb

@@ -3,9 +3,11 @@
 require 'json'
 require 'thread/pool'
 require 'securerandom'
-require 'opentracing'
+require 'opentelemetry'
+require 'opentelemetry/semantic_conventions'
+require_relative './freddy/version'
 
-Dir[File.dirname(__FILE__) + '/freddy/*.rb'].each(&method(:require))
+Dir["#{File.dirname(__FILE__)}/freddy/*.rb"].sort.each(&method(:require))
 
 class Freddy
   FREDDY_TOPIC_EXCHANGE_NAME = 'freddy-topic'
@@ -26,22 +28,15 @@ class Freddy
   # @return [Freddy]
   #
   # @example
-  #   Freddy.build(Logger.new(STDOUT), user: 'thumper', pass: 'howdy')
-  def self.build(logger = Logger.new(STDOUT), max_concurrency: DEFAULT_MAX_CONCURRENCY, **config)
-    OpenTracing.global_tracer ||= OpenTracing::Tracer.new
-
+  #   Freddy.build(Logger.new($stdout), user: 'thumper', pass: 'howdy')
+  def self.build(logger = Logger.new($stdout), max_concurrency: DEFAULT_MAX_CONCURRENCY, **config)
     connection = Adapters.determine.connect(config)
     new(connection, logger, max_concurrency)
   end
 
-  # @deprecated Use {OpenTracing.active_span} instead
-  def self.trace
-    OpenTracing.active_span
-  end
-
-  # @deprecated Use OpenTracing ScopeManager instead
-  def self.trace=(trace)
-    OpenTracing.scope_manager.activate(trace) if OpenTracing.active_span != trace
+  # @private
+  def self.tracer
+    @tracer ||= OpenTelemetry.tracer_provider.tracer('freddy', Freddy::VERSION)
   end
 
   def initialize(connection, logger, max_concurrency)
@@ -111,6 +106,15 @@ class Freddy
   # @option options [String] :group
   #   only one of the listeners in given group will receive a message. All
   #   listeners will receive a message if the group is not specified.
+  # @option options [Boolean] :durable
+  #   Should the consumer queue be durable? Default is `false`. This option can
+  #   be used only in combination with option `:group`.
+  # @option options [Boolean] :on_exception
+  #   Defines consumer's behaviour when the callback fails to process a message
+  #   and raises an exception. Can be one of `:ack`, `:reject` or `:requeue`.
+  #   `:ack` simply acknowledges the message and re-raises the exception. `:reject`
+  #   rejects the message without requeueing it. `:requeue` rejects the message with
+  #   `requeue` flag.
   #
   # @yield [message] Yields received message to the block
   #
@@ -120,12 +124,12 @@ class Freddy
   #   freddy.tap_into 'notifications.*' do |message|
   #     puts "Notification showed #{message.inspect}"
   #   end
-  def tap_into(pattern, options = {}, &callback)
-    @logger.debug "Tapping into messages that match #{pattern}"
+  def tap_into(pattern_or_patterns, options = {}, &callback)
+    @logger.debug "Tapping into messages that match #{pattern_or_patterns}"
 
     Consumers::TapIntoConsumer.consume(
       thread_pool: Thread.pool(@prefetch_buffer_size),
-      pattern: pattern,
+      patterns: Array(pattern_or_patterns),
       channel: @connection.create_channel(prefetch: @prefetch_buffer_size),
       options: options,
       &callback

data/lib/freddy/adapters.rb

@@ -1,36 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'adapters/bunny_adapter'
+
 class Freddy
   module Adapters
     def self.determine
-      if RUBY_PLATFORM == 'java'
-        require_relative 'adapters/march_hare_adapter'
-        MarchHareAdapter
-      else
-        require_relative 'adapters/bunny_adapter'
-        BunnyAdapter
-      end
-    end
-
-    module Shared
-      class Queue
-        def initialize(queue)
-          @queue = queue
-        end
-
-        def bind(*args)
-          @queue.bind(*args)
-          self
-        end
-
-        def name
-          @queue.name
-        end
-
-        def message_count
-          @queue.message_count
-        end
-      end
+      BunnyAdapter
     end
   end
 end

data/lib/freddy/adapters/bunny_adapter.rb

@@ -34,7 +34,7 @@ class Freddy
           @channel = channel
         end
 
-        def_delegators :@channel, :topic, :default_exchange, :consumers, :acknowledge
+        def_delegators :@channel, :topic, :default_exchange, :consumers, :acknowledge, :reject
 
         def queue(*args)
           Queue.new(@channel.queue(*args))
@@ -47,12 +47,29 @@ class Freddy
         end
       end
 
-      class Queue < Shared::Queue
+      class Queue
+        def initialize(queue)
+          @queue = queue
+        end
+
+        def bind(*args)
+          @queue.bind(*args)
+          self
+        end
+
+        def name
+          @queue.name
+        end
+
+        def message_count
+          @queue.message_count
+        end
+
         def subscribe(manual_ack: false)
           @queue.subscribe(manual_ack: manual_ack) do |info, properties, payload|
             parsed_payload = Payload.parse(payload)
             delivery = Delivery.new(
-              parsed_payload, properties, info.routing_key, info.delivery_tag
+              parsed_payload, properties, info.routing_key, info.delivery_tag, info.exchange
             )
             yield(delivery)
           end

data/lib/freddy/consumers.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-Dir[File.dirname(__FILE__) + '/consumers/*.rb'].each(&method(:require))
+Dir["#{File.dirname(__FILE__)}/consumers/*.rb"].sort.each(&method(:require))

data/lib/freddy/consumers/respond_to_consumer.rb

@@ -35,21 +35,11 @@ class Freddy
 
       def process_message(delivery)
         @consume_thread_pool.process do
-          begin
-            scope = delivery.build_trace("freddy:respond:#{@destination}",
-                                         tags: {
-                                           'peer.address' => "#{@destination}:#{delivery.payload[:type]}",
-                                           'component' => 'freddy',
-                                           'span.kind' => 'server', # RPC
-                                           'message_bus.destination' => @destination,
-                                           'message_bus.correlation_id' => delivery.correlation_id
-                                         })
-
+          delivery.in_span do
             yield(delivery)
-          ensure
-            @channel.acknowledge(delivery.tag, false)
-            scope.close
           end
+        ensure
+          @channel.acknowledge(delivery.tag, false)
         end
       end
     end

data/lib/freddy/consumers/response_consumer.rb

@@ -7,11 +7,9 @@ class Freddy
         @logger = logger
       end
 
-      def consume(_channel, queue)
+      def consume(_channel, queue, &block)
         @logger.debug "Consuming messages on #{queue.name}"
-        queue.subscribe do |delivery|
-          yield(delivery)
-        end
+        queue.subscribe(&block)
       end
     end
   end

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -7,11 +7,13 @@ class Freddy
         new(*attrs).consume(&block)
       end
 
-      def initialize(thread_pool:, pattern:, channel:, options:)
+      def initialize(thread_pool:, patterns:, channel:, options:)
         @consume_thread_pool = thread_pool
-        @pattern = pattern
+        @patterns = patterns
         @channel = channel
         @options = options
+
+        raise 'Do not use durable queues without specifying a group' if durable? && !group
       end
 
       def consume(&block)
@@ -28,38 +30,52 @@ class Freddy
 
       def create_queue
         topic_exchange = @channel.topic(Freddy::FREDDY_TOPIC_EXCHANGE_NAME)
-        group = @options.fetch(:group, nil)
-
-        if group
-          @channel
-            .queue("groups.#{group}")
-            .bind(topic_exchange, routing_key: @pattern)
-        else
-          @channel
-            .queue('', exclusive: true)
-            .bind(topic_exchange, routing_key: @pattern)
+
+        queue =
+          if group
+            @channel.queue("groups.#{group}", durable: durable?)
+          else
+            @channel.queue('', exclusive: true)
+          end
+
+        @patterns.each do |pattern|
+          queue.bind(topic_exchange, routing_key: pattern)
         end
+
+        queue
       end
 
       def process_message(_queue, delivery)
         @consume_thread_pool.process do
-          begin
-            scope = delivery.build_trace("freddy:observe:#{@pattern}",
-                                         tags: {
-                                           'message_bus.destination' => @pattern,
-                                           'message_bus.correlation_id' => delivery.correlation_id,
-                                           'component' => 'freddy',
-                                           'span.kind' => 'consumer' # Message Bus
-                                         },
-                                         force_follows_from: true)
-
+          delivery.in_span(force_follows_from: true) do
             yield delivery.payload, delivery.routing_key
-          ensure
-            @channel.acknowledge(delivery.tag, false)
-            scope.close
+            @channel.acknowledge(delivery.tag)
+          end
+        rescue StandardError
+          case on_exception
+          when :reject
+            @channel.reject(delivery.tag)
+          when :requeue
+            @channel.reject(delivery.tag, true)
+          else
+            @channel.acknowledge(delivery.tag)
           end
+
+          raise
         end
       end
+
+      def group
+        @options.fetch(:group, nil)
+      end
+
+      def durable?
+        @options.fetch(:durable, false)
+      end
+
+      def on_exception
+        @options.fetch(:on_exception, :ack)
+      end
     end
   end
 end