freddy 2.1.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49a24c63763b6d607d1b5ee60ca4f65211a212999ca5852637c6a567ed6b13d2
-  data.tar.gz: da8e0b5d8818df0b054a66412c61b9b57f5648295b1a81f0e7f79b017cae66ba
+  metadata.gz: 6be4b4b6d953f837c24d9c55f990e4e75872c13e6c11007d8f61ed335681faa2
+  data.tar.gz: 863042876b2ed673001cd53f296567ad91420864b96cbed5ed02fb6fd7820b22
 SHA512:
-  metadata.gz: 6323a6cb6f468a10c3395c318d3edb9f9de1de984b6f995786fceb17ca8b7a5b37adcc87649ade6caa7868da7671b09bf01d92365d9c46b9c0fa4b6a0a1e4db5
-  data.tar.gz: c41436342bcb7523f236c4ecec8ba77c0d990fef21aaaff7e3ea9f56071e2797b84faa3266fb176e01d452c1d706e82825c673ac83ac1f4bb4d8ed94f59e5d3a
+  metadata.gz: 002f901659f670dc1561db4ddc97d10e5a9d9b689369897628f1844fa0ffc65f759493fe96bc7541f6b7c204427bb584133fa3b306e19752b133a42b1b077a52
+  data.tar.gz: d2383b11b79800aabf6a0f0fe52a51f900a12c5ebcf17e64be8ca5e31243bd183dadb662e17c14416b0ee3e7d5ad26cbe00e067f7c39b709133a019082358fe8

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] || {})
 
@@ -35,12 +35,12 @@ class Freddy
         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)
+        root_span = Freddy.tracer.start_root_span(name, attributes: span_attributes, links: links, kind: kind)
+
+        OpenTelemetry::Trace.with_span(root_span) do
+          block.call
+        ensure
+          root_span.finish
         end
       else
         OpenTelemetry::Context.with_current(producer_context) do
@@ -60,7 +60,7 @@ class Freddy
         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'
+        OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION => 'process'
       }
 
       # There's no correlation_id when a message was sent using

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,12 +25,20 @@ 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.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)
       properties[:headers] ||= {}
       OpenTelemetry.propagation.inject(properties[:headers])

data/lib/freddy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Freddy
-  VERSION = '2.1.0'
+  VERSION = '2.2.3'
 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
@@ -106,11 +118,48 @@ describe 'Tracing' do
     end
   end
 
+  context 'when receiving a broadcast' do
+    let(:freddy) { Freddy.build(logger, config) }
+    let(:destination) { random_destination }
+
+    before do
+      freddy.tap_into(destination) do
+        @deliver_span = current_span_attributes
+      end
+    end
+
+    after do
+      freddy.close
+    end
+
+    it 'creates a new trace and links it with the sender' do
+      initiator_span = nil
+      Freddy.tracer.in_span('test') do
+        initiator_span = current_span_attributes
+        freddy.deliver(destination, {})
+      end
+      wait_for { @deliver_span }
+
+      expect(exporter.finished_spans.map(&:name))
+        .to match([
+                    /\.\w+ send/,
+                    'test',
+                    /freddy-topic\.\w+ process/
+                  ])
+
+      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))
+    end
+  end
+
   def current_span_attributes
     {
       trace_id: current_span.context.trace_id,
       parent_id: current_span.parent_span_id,
-      span_id: current_span.context.span_id
+      span_id: current_span.context.span_id,
+      links: current_span.links || []
     }
   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.1.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-10-11 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"
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: API for inter-application messaging supporting acknowledgements and request-response