freddy 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7e04742f9d67bcdce9f6bf6335d4ff12a1ac684a6059cffaeee00e44002426
-  data.tar.gz: 2bb02e320d0b0458a182105a82931f48681a27b4f995c789cd6e7a655f3b9251
+  metadata.gz: 55182881b38a721d174a649943e973134d3ebac9c0502b34cce14ddc503f33db
+  data.tar.gz: 2e0c118f4a4af53745b070d512a74bdc87245e8c8489ea6985d788b71ddd9eab
 SHA512:
-  metadata.gz: 3666fe665db677115174ae5d3d864cf3f67beccad3b5d7832be9497cece4296c516086b62af4c1b90514a67c69663dd56d9238ea02903880b6c9b8fb0fa26859
-  data.tar.gz: 14578870d95999f972b7638f0ad5a6d80ea3d326a0d1f565ea6a673bb9f9133a316b00f11506fec3ec6d13db94d157cbd70aea1023f20664d4532365dd3d8982
+  metadata.gz: b72b0edde6c555492c90a722d19e99ccc32cd49a8066e7a7fcde71625541c90b1a893980b98f002beadc0644132512954e6f4d7850f55b536ef3f4771e71c1b0
+  data.tar.gz: 79a42a9ea43f43a472066129ea8fe5a00c793c458fe36d482d51286dc45e44d7de3cfc2f0fd23828e05cb4d2fe95471b9304d59a1e09c27cbcbbdb53c33fc1c8

data/.github/workflows/ci.yml

@@ -27,5 +27,6 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
+        cache-version: 1
     - name: Run lint & tests
       run: bundle exec rake

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/.gitignore

@@ -1,5 +1,4 @@
 .bundle/
-Gemfile.lock
 pkg
 .tags
 .tags1

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    freddy (2.3.0)
+      bunny (~> 2.11)
+      oj (~> 3.6)
+      opentelemetry-api (~> 1.0.0.rc3)
+      opentelemetry-semantic_conventions (~> 1.0)
+      thread (~> 0.1)
+      zlib (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.2)
+    ast (2.4.2)
+    bunny (2.19.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    oj (3.13.2)
+    opentelemetry-api (1.0.0.rc3)
+    opentelemetry-common (0.19.1)
+      opentelemetry-api (~> 1.0.0.rc3)
+    opentelemetry-instrumentation-base (0.18.2)
+      opentelemetry-api (~> 1.0.0.rc3)
+    opentelemetry-sdk (1.0.0.rc3)
+      opentelemetry-api (~> 1.0.0.rc3)
+      opentelemetry-common (~> 0.19.1)
+      opentelemetry-instrumentation-base (~> 0.18.2)
+      opentelemetry-semantic_conventions
+    opentelemetry-semantic_conventions (1.6.0)
+      opentelemetry-api (~> 1.0.0.rc3)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rbtree (0.4.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    thread (0.2.2)
+    unicode-display_width (2.0.0)
+    zlib (1.1.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  freddy!
+  hamster (~> 3.0)
+  opentelemetry-sdk (~> 1.0.0.rc3)
+  pry
+  rake
+  rspec
+  rubocop (~> 1.19)
+  rubocop-rspec (~> 2.4)
+
+BUNDLED WITH
+   2.2.27

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/consumers/tap_into_consumer.rb

@@ -47,7 +47,7 @@ class Freddy
 
       def process_message(_queue, delivery)
         @consume_thread_pool.process do
-          delivery.in_span(force_follows_from: true) do
+          delivery.in_span do
             yield delivery.payload, delivery.routing_key
             @channel.acknowledge(delivery.tag)
           end

data/lib/freddy/delivery.rb

@@ -24,27 +24,13 @@ class Freddy
       @metadata.reply_to
     end
 
-    def in_span(force_follows_from: false, &block)
-      name = "#{@exchange}.#{@routing_key} receive"
+    def in_span(&block)
+      name = "#{Tracing.span_destination(@exchange, @routing_key)} process"
       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?
-
-        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)
-        ensure
-          root_span.finish
-        end
-      else
-        OpenTelemetry::Context.with_current(producer_context) do
-          Freddy.tracer.in_span(name, attributes: span_attributes, kind: kind, &block)
-        end
+      OpenTelemetry::Context.with_current(producer_context) do
+        Freddy.tracer.in_span(name, attributes: span_attributes, kind: kind, &block)
       end
     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.1'
+  VERSION = '2.3.0'
 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
@@ -120,18 +132,20 @@ describe 'Tracing' do
       freddy.close
     end
 
-    it 'creates a new trace and links it with the sender' do
-      initiator_span = nil
+    it 'continues the existing trace' do
       Freddy.tracer.in_span('test') do
-        initiator_span = current_span_attributes
         freddy.deliver(destination, {})
       end
       wait_for { @deliver_span }
 
-      expect(@deliver_span.fetch(:trace_id)).not_to eq(initiator_span.fetch(:trace_id))
+      expect(exporter.finished_spans.map(&:name))
+        .to match([
+                    /\.\w+ send/,
+                    'test',
+                    /freddy-topic\.\w+ process/
+                  ])
 
-      link = @deliver_span.fetch(:links)[0]
-      expect(link.span_context.trace_id).to eq(initiator_span.fetch(:trace_id))
+      expect(exporter.finished_spans.map(&:trace_id).uniq.count).to eq(1)
     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.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,12 +130,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENCE.txt
 - README.md
 - Rakefile
@@ -196,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: API for inter-application messaging supporting acknowledgements and request-response