freddy 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c044f881fa44748647d92c0bb450755b69d3d1da6cbe23c87ff15e6724f415
-  data.tar.gz: f7b80d3bebfa4240727b1cdf1f6ef84449c3e91d5db1de81dd3a6a8cb4acc0df
+  metadata.gz: d728d028687af2cb365212bcbdc4bb278b2116ff665f64aa35ee75c057126455
+  data.tar.gz: '019059f31b8da95352ec6b66e47ec73ff762b5b8c82b912d044b6e1820f717b2'
 SHA512:
-  metadata.gz: ba8c640285852bec4f9d318ccc8278137401152a14580be46a9ec281aca5bec6c7ca6cfd674161afd7124d0c936c103513acd14283cc24310cc03d2a1572d5f9
-  data.tar.gz: d4abff33f63da251866dc5fb9dce48a088738aa88dc70d0351bd2b633742d118d05bc8de02e5d2274da14bbbe15d225673e90870a885157334f4f5d47d77f704
+  metadata.gz: 4eae3c233c958e0936d1da27dc99bc83274a2e673bc4107e2716617fd23c389a4c27632777ecefebb8a7a17a73246a3ba5c208436143d5a39b7030f446bb9e6b
+  data.tar.gz: 17901b6c33f2a454032b23e8afb195e5f37cc1481f75f77b9f88c759f225dd4b3e1bb5a0547d6c62c0730df8d9757215ec5d2fd3c35a199a71595e07348c3277

data/.github/workflows/publish.yml

@@ -15,8 +15,7 @@ jobs:
 
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@b55d7b91b55e61752dc6cbc2972f8e16fe6c1a02
+        uses: discourse/publish-rubygems-action@ec5415e2cc3509a5cc8c4eef9499cf3fb05f8391
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
           RELEASE_COMMAND: rake release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freddy (2.6.0)
+    freddy (2.8.0)
       bunny (~> 2.11)
       concurrent-ruby (~> 1.0)
       oj (~> 3.6)
@@ -14,16 +14,16 @@ GEM
   specs:
     amq-protocol (2.3.2)
     ast (2.4.2)
-    bunny (2.19.0)
+    bunny (2.22.0)
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.4.4)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    oj (3.13.21)
+    oj (3.15.0)
     opentelemetry-api (1.1.0)
     opentelemetry-common (0.19.6)
       opentelemetry-api (~> 1.0)
@@ -34,7 +34,7 @@ GEM
       opentelemetry-common (~> 0.19.3)
       opentelemetry-registry (~> 0.2)
       opentelemetry-semantic_conventions
-    opentelemetry-semantic_conventions (1.8.0)
+    opentelemetry-semantic_conventions (1.10.0)
       opentelemetry-api (~> 1.0)
     parallel (1.22.1)
     parser (3.1.2.0)
@@ -44,7 +44,7 @@ GEM
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbtree (0.4.5)
+    rbtree (0.4.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.10.0)

data/README.md

@@ -55,6 +55,11 @@ The message heading specify the `content-encoding` indicating the compression al
 freddy.deliver(destination, message, compress: 'zlib')
 ```
 
+#### Metadata through headers
+
+Send a message with arbitrary message metadata included in the message headers
+freddy.deliver(destination, message, headers: {'my-key' => 'my-value'})
+
 ### Request delivery
 
 #### Expiring messages

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -29,7 +29,7 @@ class Freddy
       private
 
       def create_queue
-        topic_exchange = @channel.topic(Freddy::FREDDY_TOPIC_EXCHANGE_NAME)
+        topic_exchange = @channel.topic(exchange_name)
 
         queue =
           if group
@@ -48,7 +48,7 @@ class Freddy
       def process_message(_queue, delivery)
         @consume_thread_pool.post do
           delivery.in_span do
-            yield delivery.payload, delivery.routing_key
+            yield delivery.payload, delivery.routing_key, delivery.timestamp
             @channel.acknowledge(delivery.tag)
           end
         rescue StandardError
@@ -76,6 +76,10 @@ class Freddy
       def on_exception
         @options.fetch(:on_exception, :ack)
       end
+
+      def exchange_name
+        @options.fetch(:exchange_name, Freddy::FREDDY_TOPIC_EXCHANGE_NAME)
+      end
     end
   end
 end

data/lib/freddy/delivery.rb

@@ -24,6 +24,10 @@ class Freddy
       @metadata.reply_to
     end
 
+    def timestamp
+      @metadata[:timestamp]
+    end
+
     def in_span(&block)
       name = "#{Tracing.span_destination(@exchange, @routing_key)} process"
       kind = OpenTelemetry::Trace::SpanKind::CONSUMER

data/lib/freddy/version.rb

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

data/lib/freddy.rb

@@ -117,8 +117,16 @@ class Freddy
   #   `:ack` simply acknowledges the message and re-raises the exception. `:reject`
   #   rejects the message without requeueing it. `:requeue` rejects the message with
   #   `requeue` flag.
+  # @option options [String] :exchange_name
+  #   Exchange to bind to. Default is `freddy-topic`.
   #
-  # @yield [message] Yields received message to the block
+  # @yield [message] Yields received message to the block.
+  # @yieldparam [Object] payload
+  #   Yields the received message's payload.
+  # @yieldparam [String] routing_key
+  #   Yields the received message's routing key.
+  # @yieldparam [Time] timestamp
+  #   Yields received message's timestamp.
   #
   # @return [#shutdown]
   #
@@ -158,6 +166,8 @@ class Freddy
   #   won't be discarded if timeout it set to 0 (default).
   # @option options [String] :compress (nil)
   #   - 'zlib' - compresses the payload with zlib
+  # @option options [Hash] :headers (nil)
+  #   Arbitrary headers to add as message metadata
   # @return [void]
   #
   # @example
@@ -168,6 +178,7 @@ class Freddy
     opts = {}
     opts[:expiration] = (timeout * 1000).to_i if timeout.positive?
     opts[:content_encoding] = compression_algorithm if compression_algorithm
+    opts[:headers] = options[:headers] if options[:headers]
 
     @send_and_forget_producer.produce(destination, payload, opts)
   end

data/spec/freddy/freddy_spec.rb

@@ -7,7 +7,15 @@ describe Freddy do
   let(:destination2) { random_destination }
   let(:payload)      { { pay: 'load' } }
 
-  after { freddy.close }
+  before do
+    @bunny = Bunny.new(config)
+    @bunny.start
+  end
+
+  after do
+    @bunny.close
+    freddy.close
+  end
 
   def respond_to(&block)
     freddy.respond_to(destination, &block)
@@ -72,6 +80,24 @@ describe Freddy do
         expect(@tapped_message).to eq(payload)
       end
     end
+
+    it 'accepts custom headers' do
+      headers = nil
+      queue = exclusive_subscribe do |_info, metadata, _payload|
+        headers = metadata[:headers]
+      end
+      freddy.deliver(queue, payload, headers: { 'foo' => 'bar' })
+
+      wait_for { headers }
+      expect(headers).to include({ 'foo' => 'bar' })
+    end
+  end
+
+  def exclusive_subscribe(&block)
+    channel = @bunny.create_channel
+    queue = channel.queue('', exclusive: true)
+    queue.subscribe(&block)
+    queue.name
   end
 
   context 'when making a synchronized request' do

data/spec/integration/tap_into_with_exchange_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'Tapping into with exchange identifier' do
+  let(:freddy) { Freddy.build(logger, **config) }
+
+  let(:connection) { Freddy::Adapters.determine.connect(config) }
+  let(:topic) { 'test_topic_exchange' }
+  let(:channel) { connection.create_channel }
+  let(:message_payload) { { test: 'test' }.to_json }
+  let(:expected_payload) { { test: 'test' } }
+  let(:publish_timestamp) { Time.now.to_i }
+
+  after do
+    connection.close
+    freddy.close
+  end
+
+  it 'receives message' do
+    freddy.tap_into('pattern.*', exchange_name: topic) do |payload, _routing_key, timestamp|
+      @received_payload = payload
+      @received_timestamp = timestamp
+    end
+
+    channel.topic(topic).publish(message_payload, { routing_key: 'pattern.random', timestamp: publish_timestamp })
+
+    wait_for { @received_payload }
+    wait_for { @received_timestamp }
+
+    expect(@received_payload).to eq(expected_payload)
+    expect(@received_timestamp.to_i).to eq(publish_timestamp)
+  end
+
+  it 'receives message with nil timestamp when timestamp is not published' do
+    received_timestamp = 0
+    freddy.tap_into('pattern.*', exchange_name: topic) do |_payload, _routing_key, timestamp|
+      received_timestamp = timestamp
+    end
+
+    channel.topic(topic).publish(message_payload, { routing_key: 'pattern.random' })
+    default_sleep
+
+    expect(received_timestamp).to eq(nil)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,7 @@ files:
 - spec/freddy/sync_response_container_spec.rb
 - spec/integration/concurrency_spec.rb
 - spec/integration/reply_spec.rb
+- spec/integration/tap_into_with_exchange_spec.rb
 - spec/integration/tap_into_with_group_spec.rb
 - spec/integration/tracing_spec.rb
 - spec/spec_helper.rb