freddy 2.2.0 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ccc6957f658f70ad21c03dbdd3a1477ae0e84cbb3c91c18b127fea5b02c2e67
-  data.tar.gz: d6f766526c1d60f8f324846cb92de6c284e3f22357545fc0590bba93ab8726e7
+  metadata.gz: 3d6513e834c71f74caf3c8417644369fddf4087d226d8160c0d72f63d6551db0
+  data.tar.gz: e4cd3e5016030ec1b5727d9764593d7af91c389b528458a2befeecc502a6600a
 SHA512:
-  metadata.gz: 7b3a9b5de12182558c09cad3f029fec1ab221688a56c6473d6b7fe110d55ea3d0fcf6f31106798190f54ef4ba8a362928d82c983eca23c8a7b6c32cede406e18
-  data.tar.gz: 3f0e57546ad9671ec00381a4da2b12c2e574d4a2d807a9929d65d2f81887dd3318f94a7a3bc4a4a388b4745a9576ae3648acebe6ecd634b70a1d2e605a6072e1
+  metadata.gz: 81581b4a9c227aebcfb7f96db79367e4d233502bc0586599500530bb339826371dad203f928e45b2e512f74469c87c8f6f591ca9602d0a14e2e6f047868dae61
+  data.tar.gz: '090195d2a78659ac91cfef94099dca0bdf382b52590b9298680cd17ed5a04586ee87f5ace05e2fb2a465dc8cf87a07c3504445d78f3d25d6839c34208b291a10'

data/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+
+
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@b55d7b91b55e61752dc6cbc2972f8e16fe6c1a02
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: rake release

data/README.md

@@ -11,6 +11,10 @@ logger = Logger.new(STDOUT)
 freddy = Freddy.build(logger, host: 'localhost', port: 5672, user: 'guest', pass: 'guest')
 ```
 
+## Releasing a new version
+
+A new version is created when a change is merged into the master branch that changes the version number in `freddy.gemspec`. A Github Action will create a tag for the version and push the `.gem` file to [rubygems.org](https://rubygems.org)
+
 ## Supported message queues
 
 These message queues have been tested and are working with Freddy. Other queues can be added easily:

data/lib/freddy/adapters/bunny_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'bunny'
+require 'forwardable'
 
 class Freddy
   module Adapters

data/lib/freddy/delivery.rb

@@ -25,7 +25,7 @@ class Freddy
     end
 
     def in_span(force_follows_from: false, &block)
-      name = "#{@exchange}.#{@routing_key} receive"
+      name = "#{Tracing.span_destination(@exchange, @routing_key)} process"
       kind = OpenTelemetry::Trace::SpanKind::CONSUMER
       producer_context = OpenTelemetry.propagation.extract(@metadata[:headers] || {})
 
@@ -36,8 +36,9 @@ class Freddy
         links << OpenTelemetry::Trace::Link.new(producer_span_context) if producer_span_context.valid?
 
         root_span = Freddy.tracer.start_root_span(name, attributes: span_attributes, links: links, kind: kind)
+
         OpenTelemetry::Trace.with_span(root_span) do
-          Freddy.tracer.in_span(name, attributes: span_attributes, links: links, kind: kind, &block)
+          block.call
         ensure
           root_span.finish
         end

data/lib/freddy/producers/reply_producer.rb

@@ -22,7 +22,7 @@ class Freddy
           routing_key: routing_key,
           content_type: CONTENT_TYPE
         )
-        Tracing.inject_tracing_information_to_properties!(properties)
+        Tracing.inject_tracing_information_to_properties!(properties, span)
 
         @exchange.publish Payload.dump(payload), properties
       ensure

data/lib/freddy/producers/send_and_forget_producer.rb

@@ -18,7 +18,7 @@ class Freddy
           routing_key: routing_key,
           content_type: CONTENT_TYPE
         )
-        Tracing.inject_tracing_information_to_properties!(properties)
+        Tracing.inject_tracing_information_to_properties!(properties, span)
 
         json_payload = Freddy::Encoding.compress(
           Payload.dump(payload),

data/lib/freddy/producers/send_and_wait_response_producer.rb

@@ -49,7 +49,7 @@ class Freddy
           correlation_id: correlation_id, reply_to: @response_queue.name,
           mandatory: true, type: 'request'
         )
-        Tracing.inject_tracing_information_to_properties!(properties)
+        Tracing.inject_tracing_information_to_properties!(properties, span)
 
         # Connection adapters handle thread safety for #publish themselves. No
         # need to lock this.

data/lib/freddy/tracing.rb

@@ -2,6 +2,8 @@
 
 class Freddy
   module Tracing
+    RESPONSE_QUEUE_PREFIX = 'amq.gen-'
+
     # NOTE: Make sure you finish the span youself.
     def self.span_for_produce(exchange, routing_key, payload, correlation_id: nil, timeout_in_seconds: nil)
       destination = exchange.name
@@ -23,15 +25,24 @@ class Freddy
       end
 
       Freddy.tracer.start_span(
-        ".#{routing_key} send",
+        "#{span_destination(destination, routing_key)} send",
         kind: OpenTelemetry::Trace::SpanKind::PRODUCER,
         attributes: attributes
       )
     end
 
-    def self.inject_tracing_information_to_properties!(properties)
+    def self.span_destination(destination, routing_key)
+      if routing_key.to_s.start_with?(RESPONSE_QUEUE_PREFIX)
+        "#{destination}.(response queue)"
+      else
+        "#{destination}.#{routing_key}"
+      end
+    end
+
+    def self.inject_tracing_information_to_properties!(properties, span)
+      context = OpenTelemetry::Trace.context_with_span(span)
       properties[:headers] ||= {}
-      OpenTelemetry.propagation.inject(properties[:headers])
+      OpenTelemetry.propagation.inject(properties[:headers], context: context)
     end
   end
 end

data/lib/freddy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Freddy
-  VERSION = '2.2.0'
+  VERSION = '2.2.4'
 end

data/spec/integration/tracing_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe 'Tracing' do
-  let(:logger) { spy }
+  let(:exporter) { SPAN_EXPORTER }
+
+  before do
+    exporter.reset
+  end
 
   context 'when receiving a traced request' do
     let(:freddy) { Freddy.build(logger, config) }
@@ -48,6 +52,14 @@ describe 'Tracing' do
       expect(current_receiver.fetch(:span_id)).not_to be_nil
       expect(current_receiver.fetch(:span_id)).not_to eq(trace_initiator.fetch(:span_id))
     end
+
+    it 'replaces generated queue names with (response queue)' do
+      freddy.deliver_with_response(destination, {})
+      names = exporter.finished_spans.map(&:name)
+
+      expect(names.any? { |name| name.include?('amq.gen-') }).to eq(false)
+      expect(names.any? { |name| name.include?('(response queue)') }).to eq(true)
+    end
   end
 
   context 'when receiving a nested traced request' do
@@ -128,10 +140,20 @@ describe 'Tracing' do
       end
       wait_for { @deliver_span }
 
+      expect(exporter.finished_spans.map(&:name))
+        .to match([
+                    /\.\w+ send/,
+                    'test',
+                    /freddy-topic\.\w+ process/
+                  ])
+
+      send_span = exporter.finished_spans.find { |span| span.name =~ /\.\w+ send/ }
+
       expect(@deliver_span.fetch(:trace_id)).not_to eq(initiator_span.fetch(:trace_id))
 
       link = @deliver_span.fetch(:links)[0]
       expect(link.span_context.trace_id).to eq(initiator_span.fetch(:trace_id))
+      expect(link.span_context.span_id).to eq(send_span.span_id)
     end
   end
 

data/spec/spec_helper.rb

@@ -11,6 +11,13 @@ require 'freddy'
 require 'logger'
 require 'hamster/experimental/mutable_set'
 
+SPAN_EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(SPAN_EXPORTER)
+
+OpenTelemetry::SDK.configure do |c|
+  c.add_span_processor(span_processor)
+end
+
 Thread.abort_on_exception = true
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.4
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -181,7 +182,7 @@ homepage: https://github.com/salemove/freddy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: API for inter-application messaging supporting acknowledgements and request-response
 test_files: