action_subscriber 1.3.0 → 1.4.0.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae5b2f882ea1029a22240ed01ebe6c7182413df3
-  data.tar.gz: 6b231f3f390ec2b9f9f4445a414dbcd8996e4f6c
+  metadata.gz: de37da8295015a4541ae74344a94d9d0bd8e17a0
+  data.tar.gz: 1e76a445b345492f5fe2b323ee4d30e93e6242d0
 SHA512:
-  metadata.gz: c86487cde5cdc57eb02fcc8188916b1e497e225a27fde9e4e22c4265d8542de32253bbb0c2800d9bfd16382fca3bf692e44fcaec8d9991e9d3dca7acde30fa0c
-  data.tar.gz: c8042ece3e2d8867e4d8ef9ba844cba7057277f9a4018d28e1cb035324ff909856142e19189ecf5b67d4265e3f7b6aba2de736ce2c80750ca446a92488bb57c9
+  metadata.gz: e29df8d1d6c5eaad8da7109064a5cd51b8439e895e8e078fcb5f178b6c98765c8eb0a88575ec33898d54ca10aea008890c3f84fb38ef9533e51add3d63f39682
+  data.tar.gz: fc1681979af3ae3f52be362704560c1da355c1b62e52755078fd3cd749c1e95f9feafe9117b1cf32108174b9fa65da0a0c7fcbc92ec59c8e21b9189fe626a5b2

data/lib/action_subscriber.rb

@@ -14,6 +14,7 @@ require "action_subscriber/version"
 require "action_subscriber/default_routing"
 require "action_subscriber/dsl"
 require "action_subscriber/configuration"
+require "action_subscriber/message_retry"
 require "action_subscriber/middleware"
 require "action_subscriber/rabbit_connection"
 require "action_subscriber/subscribable"

data/lib/action_subscriber/base.rb

@@ -80,7 +80,8 @@ module ActionSubscriber
       yield
       acknowledge
     rescue => error
-      reject
+      ::ActionSubscriber::MessageRetry.redeliver_message_with_backoff(env)
+      acknowledge
       raise error
     end
 

data/lib/action_subscriber/bunny/subscriber.rb

@@ -24,8 +24,10 @@ module ActionSubscriber
               :content_type => properties[:content_type],
               :delivery_tag => delivery_info.delivery_tag,
               :exchange => delivery_info.exchange,
+              :headers => properties.headers,
               :message_id => nil,
               :routing_key => delivery_info.routing_key,
+              :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(self, encoded_payload, properties)
             enqueue_env(env)
@@ -45,8 +47,10 @@ module ActionSubscriber
               :content_type => properties.content_type,
               :delivery_tag => delivery_info.delivery_tag,
               :exchange => delivery_info.exchange,
+              :headers => properties.headers,
               :message_id => properties.message_id,
               :routing_key => delivery_info.routing_key,
+              :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(self, encoded_payload, properties)
             enqueue_env(env)

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -12,16 +12,18 @@ module ActionSubscriber
         times_to_pop = [::ActionSubscriber::Threadpool.ready_size, ::ActionSubscriber.config.times_to_pop].min
         times_to_pop.times do
           queues.each do |queue|
-            header, encoded_payload = queue.pop(queue_subscription_options)
+            metadata, encoded_payload = queue.pop(queue_subscription_options)
             next unless encoded_payload
             ::ActiveSupport::Notifications.instrument "popped_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
             properties = {
               :channel => queue.channel,
-              :content_type => header.content_type,
-              :delivery_tag => header.delivery_tag,
-              :exchange => header.exchange,
-              :message_id => header.message_id,
-              :routing_key => header.routing_key,
+              :content_type => metadata.content_type,
+              :delivery_tag => metadata.delivery_tag,
+              :exchange => metadata.exchange,
+              :headers => _normalized_headers(metadata),
+              :message_id => metadata.message_id,
+              :routing_key => metadata.routing_key,
+              :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(self, encoded_payload, properties)
             enqueue_env(env)
@@ -35,15 +37,17 @@ module ActionSubscriber
       def auto_subscribe!
         queues.each do |queue|
           queue.channel.prefetch = ::ActionSubscriber.config.prefetch if acknowledge_messages?
-          consumer = queue.subscribe(queue_subscription_options) do |header, encoded_payload|
+          consumer = queue.subscribe(queue_subscription_options) do |metadata, encoded_payload|
             ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
             properties = {
               :channel => queue.channel,
-              :content_type => header.content_type,
-              :delivery_tag => header.delivery_tag,
-              :exchange => header.exchange,
-              :message_id => header.message_id,
-              :routing_key => header.routing_key,
+              :content_type => metadata.content_type,
+              :delivery_tag => metadata.delivery_tag,
+              :exchange => metadata.exchange,
+              :headers => _normalized_headers(metadata),
+              :message_id => metadata.message_id,
+              :routing_key => metadata.routing_key,
+              :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(self, encoded_payload, properties)
             enqueue_env(env)
@@ -66,6 +70,13 @@ module ActionSubscriber
           end
         end
       end
+
+      def _normalized_headers(metadata)
+        return {} unless metadata.headers
+        metadata.headers.each_with_object({}) do |(header,value), hash|
+          hash[header] = value.to_s
+        end
+      end
     end
   end
 end

data/lib/action_subscriber/message_retry.rb

@@ -0,0 +1,60 @@
+module ActionSubscriber
+  module MessageRetry
+    SCHEDULE = {
+      2  =>        100,
+      3  =>        500,
+      4  =>      2_500,
+      5  =>     12_500,
+      6  =>     62_500,
+      7  =>    312_500,
+      8  =>  1_562_500,
+      9  =>  7_812_500,
+      10 => 39_062_500,
+    }.freeze
+
+    def self.redeliver_message_with_backoff(env)
+      next_attempt = get_last_attempt_number(env) + 1
+      ttl = SCHEDULE[next_attempt]
+      return unless ttl
+      with_exchange(env, ttl) do |exchange|
+        exchange.publish(env.encoded_payload, retry_options(env, next_attempt))
+      end
+    end
+
+    # Private Implementation
+    def self.get_last_attempt_number(env)
+      attempt_header = env.headers.fetch("as-attempt", "1")
+      attempt_header.to_i
+    end
+
+    def self.retry_headers(env, attempt)
+      env.headers.reject do |key, val|
+        key == "x-death"
+      end.merge({"as-attempt" => attempt.to_s})
+    end
+
+    def self.retry_options(env, attempt)
+      {
+        :content_type => env.content_type,
+        :routing_key => env.routing_key,
+        :headers => retry_headers(env, attempt),
+      }
+    end
+
+    def self.with_exchange(env, ttl)
+      exchange_retry_name = "#{env.exchange}_retry_#{ttl}"
+      queue_retry_name = "#{env.queue}_retry_#{ttl}"
+      channel = RabbitConnection.subscriber_connection.create_channel
+      begin
+        channel.confirm_select
+        exchange = channel.topic(exchange_retry_name)
+        queue = channel.queue(queue_retry_name, :arguments => {"x-dead-letter-exchange" => env.exchange, "x-message-ttl" => ttl})
+        queue.bind(exchange, :routing_key => env.routing_key)
+        yield(exchange)
+        channel.wait_for_confirms
+      ensure
+        channel.close rescue nil
+      end
+    end
+  end
+end

data/lib/action_subscriber/middleware/env.rb

@@ -6,8 +6,10 @@ module ActionSubscriber
       attr_reader :content_type,
                   :encoded_payload,
                   :exchange,
+                  :headers,
                   :message_id,
                   :routing_key,
+                  :queue,
                   :subscriber
 
       ##
@@ -18,16 +20,18 @@ module ActionSubscriber
       #         :content_type => String
       #         :delivery_tag => String (the message identifier to send back to rabbitmq for acknowledgement)
       #         :exchange => String
+      #         :headers => Hash[ String => String ]
       #         :message_id => String
       #         :routing_key => String
-      
       def initialize(subscriber, encoded_payload, properties)
         @channel = properties.fetch(:channel)
         @content_type = properties.fetch(:content_type)
         @delivery_tag = properties.fetch(:delivery_tag)
         @encoded_payload = encoded_payload
         @exchange = properties.fetch(:exchange)
+        @headers = properties.fetch(:headers) || {}
         @message_id = properties.fetch(:message_id)
+        @queue = properties.fetch(:queue)
         @routing_key = properties.fetch(:routing_key)
         @subscriber = subscriber
       end

data/lib/action_subscriber/rspec.rb

@@ -17,8 +17,10 @@ module ActionSubscriber
       :content_type => "text/plain",
       :delivery_tag => "XYZ",
       :exchange => "events",
+      :headers => {},
       :message_id => "MSG-123",
       :routing_key => "amigo.user.created",
+      :queue => "test.amigo.user.created",
     }.freeze
 
     # Create a new subscriber instance. Available options are:
@@ -73,8 +75,10 @@ end
       :content_type => "text/plain",
       :delivery_tag => "XYZ",
       :exchange => "events",
+      :headers => {},
       :message_id => "MSG-123",
       :routing_key => "amigo.user.created",
+      :queue => "test.amigo.user.created",
     }}
   end
 

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "1.3.0"
+  VERSION = "1.4.0.pre0"
 end

data/spec/integration/at_least_once_spec.rb

@@ -17,7 +17,7 @@ describe "at_least_once! mode", :integration => true do
     exchange = channel.topic("events")
     exchange.publish("GrumpFace", :routing_key => "gorby_puff.grumpy")
 
-    verify_expectation_within(1.0) do
+    verify_expectation_within(2.0) do
       expect($messages).to eq Set.new(["GrumpFace::0","GrumpFace::1","GrumpFace::2"])
     end
   end

data/spec/integration/custom_headers_spec.rb

@@ -0,0 +1,27 @@
+class PrankSubscriber < ActionSubscriber::Base
+  publisher :pikitis
+
+  def pulled
+    $messages << env.headers
+  end
+end
+
+describe "Custom Headers Are Published and Received", :integration => true do
+  let(:headers) { { "Custom" => "content/header" } }
+
+  it "works for auto_pop!" do
+    ::ActionSubscriber::Publisher.publish("pikitis.prank.pulled", "Yo Knope!", "events", :headers => headers)
+    verify_expectation_within(2.0) do
+      ::ActionSubscriber.auto_pop!
+      expect($messages).to eq(Set.new([headers]))
+    end
+  end
+
+  it "works for auto_subscriber!" do
+    ::ActionSubscriber.auto_subscribe!
+    ::ActionSubscriber::Publisher.publish("pikitis.prank.pulled", "Yo Knope!", "events", :headers => headers)
+    verify_expectation_within(2.0) do
+      expect($messages).to eq(Set.new([headers]))
+    end
+  end
+end

data/spec/lib/action_subscriber/middleware/env_spec.rb

@@ -7,8 +7,10 @@ describe ActionSubscriber::Middleware::Env do
     :delivery_tag => "XYZ",
     :encoded_payload => encoded_payload,
     :exchange => "events",
+    :headers => {},
     :message_id => "MSG-1234",
     :routing_key => "amigo.user.created",
+    :queue => "test.amigo.user.created",
   } }
   let(:subscriber) { UserSubscriber }
 
@@ -17,8 +19,10 @@ describe ActionSubscriber::Middleware::Env do
   specify { expect(subject.action).to eq("created") }
   specify { expect(subject.content_type).to eq(properties[:content_type]) }
   specify { expect(subject.exchange).to eq(properties[:exchange]) }
+  specify { expect(subject.headers).to eq(properties[:headers]) }
   specify { expect(subject.message_id).to eq(properties[:message_id]) }
   specify { expect(subject.routing_key).to eq(properties[:routing_key]) }
+  specify { expect(subject.queue).to eq(properties[:queue]) }
 
   describe "#acknowledge" do
     it "sends an acknowledgement to rabbitmq" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0.pre0
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,6 +203,7 @@ files:
 - lib/action_subscriber/default_routing.rb
 - lib/action_subscriber/dsl.rb
 - lib/action_subscriber/march_hare/subscriber.rb
+- lib/action_subscriber/message_retry.rb
 - lib/action_subscriber/middleware.rb
 - lib/action_subscriber/middleware/active_record/connection_management.rb
 - lib/action_subscriber/middleware/active_record/query_cache.rb
@@ -223,6 +224,7 @@ files:
 - spec/integration/at_most_once_spec.rb
 - spec/integration/automatic_reconnect_spec.rb
 - spec/integration/basic_subscriber_spec.rb
+- spec/integration/custom_headers_spec.rb
 - spec/integration/decoding_payloads_spec.rb
 - spec/integration/manual_acknowledgement_spec.rb
 - spec/lib/action_subscriber/base_spec.rb
@@ -255,9 +257,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8
@@ -271,6 +273,7 @@ test_files:
 - spec/integration/at_most_once_spec.rb
 - spec/integration/automatic_reconnect_spec.rb
 - spec/integration/basic_subscriber_spec.rb
+- spec/integration/custom_headers_spec.rb
 - spec/integration/decoding_payloads_spec.rb
 - spec/integration/manual_acknowledgement_spec.rb
 - spec/lib/action_subscriber/base_spec.rb