freddy 1.7.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b2906e383a27fec45165c162d2a0a7a3a299dfdf390c599cf42288d75e5f3e
-  data.tar.gz: 882a6d64838f723c43c58189cd0b9786df758bdd357ea23dfcb2954c454fb92f
+  metadata.gz: 9c7e04742f9d67bcdce9f6bf6335d4ff12a1ac684a6059cffaeee00e44002426
+  data.tar.gz: 2bb02e320d0b0458a182105a82931f48681a27b4f995c789cd6e7a655f3b9251
 SHA512:
-  metadata.gz: b0d5031e6308383f5905f40ecc817945be9dd6df1f0abc6be662867d8d5b39b6c57ed0615d56d26d46ddcfe9dc05b4bc2d7a86b8f46d89d5ed118963b0c36063
-  data.tar.gz: 816406b89fb3fbac83fffd15b5d283755096675dc4f9095b041c585d950a47a11c46bb1ef1545747b08775c705531b7c383327d06bdba2175a96cb7bf6f3732b
+  metadata.gz: 3666fe665db677115174ae5d3d864cf3f67beccad3b5d7832be9497cece4296c516086b62af4c1b90514a67c69663dd56d9238ea02903880b6c9b8fb0fa26859
+  data.tar.gz: 14578870d95999f972b7638f0ad5a6d80ea3d326a0d1f565ea6a673bb9f9133a316b00f11506fec3ec6d13db94d157cbd70aea1023f20664d4532365dd3d8982

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.6']
+    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.6

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
 
@@ -24,39 +22,60 @@ These message queues have been tested and are working with Freddy. Other queues
 ### Simple delivery
 
 #### Send and forget
+
 Sends a `message` to the given `destination`. If there is no consumer then the
 message stays in the queue until somebody consumes it.
+
 ```ruby
-  freddy.deliver(destination, message)
+freddy.deliver(destination, message)
 ```
 
 #### Expiring messages
+
 Sends a `message` to the given `destination`. If nobody consumes the message in
 `timeout` seconds then the message is discarded. This is useful for showing
 notifications that must happen in a certain timeframe but where we don't really
 care if it reached the destination or not.
+
 ```ruby
 freddy.deliver(destination, message, timeout: 5)
 ```
 
+#### Compressed messages
+
+Sends a `message` to the given `destination`. If `compress` is passed as an option parameter, it will compress the 
+payload according to the algorithm provided. Currently the `zlib` algorithm is implemented to compress the payload. 
+The message heading specify the `content-encoding` indicating the compression algorithm used. 
+
+```ruby
+freddy.deliver(destination, message, compress: 'zlib')
+```
+
 ### Request delivery
+
 #### Expiring messages
+
 Sends a `message` to the given `destination`. Has a default timeout of 3 and
 discards the message from the queue if a response hasn't been returned in that
 time.
+
 ```ruby
 response = freddy.deliver_with_response(destination, message)
 ```
 
 #### Persistant messages
+
 Sends a `message` to the given `destination`. Keeps the message in the queue if
 a timeout occurs.
+
 ```ruby
 response = freddy.deliver_with_response(destination, message, timeout: 4, delete_on_timeout: false)
 ```
 
 #### Errors
+
 `deliver_with_response` raises an error if an error is returned. This can be handled by rescuing from `Freddy::InvalidRequestError` and `Freddy::TimeoutError` as:
+
 ```ruby
 begin
   response = freddy.deliver_with_response 'Q', {}
@@ -68,6 +87,7 @@ rescue Freddy::TimeoutError => e
 ```
 
 ## Responding to messages
+
 ```ruby
 freddy.respond_to destination do |message, msg_handler|
   # ...
@@ -75,8 +95,9 @@ end
 ```
 
 The callback is called with 2 arguments
-  * the parsed message (note that in the message all keys are symbolized)
-  * the `MessageHandler` (described further down)
+
+* the parsed message (note that in the message all keys are symbolized)
+* the `MessageHandler` (described further down)
 
 ## The MessageHandler
 
@@ -84,17 +105,20 @@ When responding to messages the MessageHandler is given as the second argument.
 
 The following operations are supported:
 
-  * responding with a successful response
+* responding with a successful response
+
 ```ruby
 msg_handler.success(response = nil)
 ```
 
-  * responding with an error response
+* responding with an error response
+
 ```ruby
 msg_handler.error(error: "Couldn't process message")
 ```
 
 ## Tapping into messages
+
 When it's necessary to receive messages but not consume them, consider tapping.
 
 ```ruby
@@ -134,37 +158,34 @@ end
 ## The ResponderHandler
 
 When responding to a message or tapping the ResponderHandler is returned.
+
 ```ruby
 responder_handler = freddy.respond_to ....
 ```
 
 The following operations are supported:
 
-  * stop responding
+* stop responding
+
 ```ruby
 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(...)
-```
+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.
 
-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.
-
-See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more information.
+This is not compatible with `opentelemetry-instrumentation-bunny` library.
 
 ## Notes about concurrency
 
 *freddy* uses a thread pool to run concurrent responders. The thread pool is unique for each *tap_into* and *respond_to* responder. Thread pool size can be configured by passing the configuration option *max_concurrency*. Its default value is 4. e.g. If your application has 2 *respond_to* responders and 1 *tap_into* responder with *max_concurrency* set to 3 then your application may process up to 9 messages in parallel.
 
-
 Note that while it is possible to use *deliver_with_response* inside a *respond_to* block,
 it is not possible to use another *respond_to* block inside a different *respond_to* block.
 
-
 Note also that other configuration options for freddy users
 such as pool sizes for DB connections need to match or exceed *max_concurrency*
 to avoid running out of resources.

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.7.0'
+  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.6'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -23,14 +21,10 @@ 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', '~> 3.6'
-  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'
+  spec.add_dependency 'zlib', '~> 1.1'
 end

data/lib/freddy/adapters/bunny_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'bunny'
+require 'forwardable'
 
 class Freddy
   module Adapters
@@ -47,12 +48,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)
+            parsed_payload = Payload.parse(payload, properties[:content_encoding])
             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/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/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