freddy 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b2906e383a27fec45165c162d2a0a7a3a299dfdf390c599cf42288d75e5f3e
-  data.tar.gz: 882a6d64838f723c43c58189cd0b9786df758bdd357ea23dfcb2954c454fb92f
+  metadata.gz: 7ae99c2d347a67110923b71ffac1af46c706d177b39b82c3adaae4db3f686a1d
+  data.tar.gz: 557210126d3c4cdff8f0946ee5b6882e3334126c3cb0ae900df823f6e762fdd9
 SHA512:
-  metadata.gz: b0d5031e6308383f5905f40ecc817945be9dd6df1f0abc6be662867d8d5b39b6c57ed0615d56d26d46ddcfe9dc05b4bc2d7a86b8f46d89d5ed118963b0c36063
-  data.tar.gz: 816406b89fb3fbac83fffd15b5d283755096675dc4f9095b041c585d950a47a11c46bb1ef1545747b08775c705531b7c383327d06bdba2175a96cb7bf6f3732b
+  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
 
@@ -147,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.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.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', '~> 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'
 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)

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

@@ -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

@@ -47,33 +47,21 @@ class Freddy
 
       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
-
             @channel.acknowledge(delivery.tag)
-          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
-          ensure
-            scope.close
           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
 

data/lib/freddy/delivery.rb

@@ -4,11 +4,12 @@ class Freddy
   class Delivery
     attr_reader :routing_key, :payload, :tag
 
-    def initialize(payload, metadata, routing_key, tag)
+    def initialize(payload, metadata, routing_key, tag, exchange)
       @payload = payload
       @metadata = metadata
       @routing_key = routing_key
       @tag = tag
+      @exchange = exchange
     end
 
     def correlation_id
@@ -23,20 +24,52 @@ class Freddy
       @metadata.reply_to
     end
 
-    def build_trace(operation_name, tags: {}, force_follows_from: false)
-      carrier = TraceCarrier.new(@metadata)
-      parent = OpenTracing.global_tracer.extract(OpenTracing::FORMAT_TEXT_MAP, carrier)
-
-      references =
-        if !parent
-          []
-        elsif force_follows_from
-          [OpenTracing::Reference.follows_from(parent)]
-        else
-          [OpenTracing::Reference.child_of(parent)]
+    def in_span(force_follows_from: false, &block)
+      name = "#{@exchange}.#{@routing_key} receive"
+      kind = OpenTelemetry::Trace::SpanKind::CONSUMER
+      producer_context = OpenTelemetry.propagation.extract(@metadata[:headers] || {})
+
+      if force_follows_from
+        producer_span_context = OpenTelemetry::Trace.current_span(producer_context).context
+
+        links = []
+        links << OpenTelemetry::Trace::Link.new(producer_span_context) if producer_span_context.valid?
+
+        # In general we should start a new trace here and just link two traces
+        # together. But Zipkin (which we currently use) doesn't support links.
+        # So even though the root trace could finish before anything here
+        # starts executing, we'll continue with the root trace here as well.
+        OpenTelemetry::Context.with_current(producer_context) do
+          Freddy.tracer.in_span(name, attributes: span_attributes, links: links, kind: kind, &block)
         end
+      else
+        OpenTelemetry::Context.with_current(producer_context) do
+          Freddy.tracer.in_span(name, attributes: span_attributes, kind: kind, &block)
+        end
+      end
+    end
+
+    private
+
+    def span_attributes
+      destination_kind = @exchange == '' ? 'queue' : 'topic'
+
+      attributes = {
+        'payload.type' => (@payload[:type] || 'unknown').to_s,
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM => 'rabbitmq',
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_DESTINATION => @exchange,
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_DESTINATION_KIND => destination_kind,
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_RABBITMQ_ROUTING_KEY => @routing_key,
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION => 'receive'
+      }
+
+      # There's no correlation_id when a message was sent using
+      # `Freddy#deliver`.
+      if correlation_id
+        attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_CONVERSATION_ID] = correlation_id
+      end
 
-      OpenTracing.start_active_span(operation_name, references: references, tags: tags)
+      attributes
     end
   end
 end