pwwka 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92357bbf204f0558fb03ce13a7f13d8143d5259a
-  data.tar.gz: e10916ec0e829f164c26daa13ea0dcad72076001
+  metadata.gz: 34728502586c650b28ce76b44de9e7038ae5b980
+  data.tar.gz: 8732f047a559e0feae6469c1d68d0267b9537757
 SHA512:
-  metadata.gz: 45252ff1d13c6c001ac445d9e50fea106e0c1043b442391cf71a7c59571a54e560fca9fb638772bb5a78da1455616456ee8ebb3125fba6f95c96c3cb9f08f9ef
-  data.tar.gz: 269ef0814b600537de72bff6033b47e037629430b4108b75f41843adb5d3acc8ab79492b577877e5ea24b7730fd78869f33471cb62f84bc360099ac07533fab5
+  metadata.gz: 0cbb4d1b802b266e087adb0726ee3878c7f939ea4a920bc0f5a8044371437e7330b085a2a7382d8e85659442880723da35e691e4639e7f42473954994a4374bc
+  data.tar.gz: 67259184b9333de0cdb7df54d1f1b6a223ddf569932e1b3d574afac2d64eef8ee9d6b6006db1e405ce3a0ff9a71e7b22edd98aea38d4fa8e676bdfa3b5fa55be

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 sudo: true
 rvm:
-  - 2.3.1
-  - 2.2.4
+  - 2.3.3
+  - 2.4.2
 services:
   - docker
 before_install:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.14.0)
+    pwwka (0.15.0)
       activemodel
       activesupport
       bunny

data/README.md

@@ -37,6 +37,7 @@ Pwwka.configure do |config|
   config.delayed_exchange_name = "mycompany-topics-#{Rails.env}"
   config.options               = {allow_delayed: true}
   config.requeue_on_error      = true
+  config.default_prefetch      = 10
 end
 ```
 
@@ -211,6 +212,7 @@ It requires some environment variables to work:
 * `HANDLER_KLASS` (required) refers to the class you have to write in your app (equivalent to a `job` in Resque)
 * `QUEUE_NAME` (required) we must use named queues - see below
 * `ROUTING_KEY` (optional) defaults to `#.#` (all messages)
+* `PREFETCH` (optional) sets a [prefetch value](http://rubybunny.info/articles/queues.html#qos__prefetching_messages) for the subscriber
 
 You'll also need to bring the Rake task into your app.  For Rails, you'll need to edit the top-level `Rakefile`:
 

data/Rakefile

@@ -12,13 +12,3 @@ RSpec::Core::RakeTask.new(:spec)
 Bundler::GemHelper.install_tasks
 
 task default: :spec
-
-task :tag do
-  require "pwwka/version"
-  version = "v#{Pwwka::VERSION}"
-  sh("git tag #{version}")     { |ok,res| fail res.inspect unless ok }
-  sh("git push --tags origin") { |ok,res| fail res.inspect unless ok }
-end
-task release: [ :build, :tag ] do
-  sh("gem push --key rubygems_stitchfix_api_key pkg/pwwka-#{Pwwka::VERSION}.gem") { |ok,res| fail res.inspect unless ok }
-end

data/lib/pwwka/channel_connector.rb

@@ -8,13 +8,16 @@ module Pwwka
     # The channel_connector starts the connection to the message_bus
     # so it should only be instantiated by a method that has a strategy
     # for closing the connection
-    def initialize
+    def initialize(prefetch: nil)
       @configuration     = Pwwka.configuration
       connection_options = {automatically_recover: false}.merge(configuration.options)
       @connection        = Bunny.new(configuration.rabbit_mq_host,
                                   connection_options)
       @connection.start
       @channel           = @connection.create_channel
+      if prefetch
+        @channel.prefetch(prefetch.to_i)
+      end
     end
 
     def topic_exchange

data/lib/pwwka/configuration.rb

@@ -11,6 +11,7 @@ module Pwwka
     attr_accessor :options
     attr_accessor :async_job_klass
     attr_accessor :send_message_resque_backoff_strategy
+    attr_accessor :default_prefetch
     attr_reader   :requeue_on_error
     attr_writer   :app_id
     attr_writer   :error_handling_chain
@@ -27,6 +28,7 @@ module Pwwka
       @requeue_on_error = false
       @keep_alive_on_handler_klass_exceptions = false
       @async_job_klass = Pwwka::SendMessageAsyncJob
+      @default_prefetch = nil
     end
 
     def keep_alive_on_handler_klass_exceptions?
@@ -99,5 +101,9 @@ module Pwwka
         end
       end
     end
+
+    def default_prefetch=(val)
+      @default_prefetch = val.nil? ? val : val.to_i
+    end
   end
 end

data/lib/pwwka/receiver.rb

@@ -9,17 +9,17 @@ module Pwwka
     attr_reader :queue_name
     attr_reader :routing_key
 
-    def initialize(queue_name, routing_key)
+    def initialize(queue_name, routing_key, prefetch: Pwwka.configuration.default_prefetch)
       @queue_name        = queue_name
       @routing_key       = routing_key
-      @channel_connector = ChannelConnector.new
+      @channel_connector = ChannelConnector.new(prefetch: prefetch)
       @channel           = @channel_connector.channel
       @topic_exchange    = @channel_connector.topic_exchange
     end
 
-    def self.subscribe(handler_klass, queue_name, routing_key: "#.#", block: true)
+    def self.subscribe(handler_klass, queue_name, routing_key: "#.#", block: true, prefetch: Pwwka.configuration.default_prefetch)
       raise "#{handler_klass.name} must respond to `handle!`" unless handler_klass.respond_to?(:handle!)
-      receiver  = new(queue_name, routing_key)
+      receiver  = new(queue_name, routing_key, prefetch: prefetch)
       begin
         info "Receiving on #{queue_name}"
         receiver.topic_queue.subscribe(manual_ack: true, block: block) do |delivery_info, properties, payload|

data/lib/pwwka/tasks.rb

@@ -6,6 +6,8 @@ namespace :message_handler do
     handler_klass = ENV['HANDLER_KLASS'].constantize
     queue_name    = "#{ENV['QUEUE_NAME']}_#{Rails.env}"
     routing_key   = ENV['ROUTING_KEY'] || "#.#"
-    Pwwka::Receiver.subscribe(handler_klass, queue_name, routing_key: routing_key)
+    prefetch = ENV['PREFETCH'] || Pwwka.configuration.default_prefetch
+
+    Pwwka::Receiver.subscribe(handler_klass, queue_name, routing_key: routing_key, prefetch: prefetch)
   end
 end

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/owners.json

@@ -0,0 +1,7 @@
+{
+  "owners": [
+    {
+      "team": "platform"
+    }
+  ]
+}

data/spec/unit/channel_connector_spec.rb

@@ -4,21 +4,42 @@ require 'spec_helper.rb'
 # by the integration tests.
 describe Pwwka::ChannelConnector do
   let(:bunny_session) { instance_double(Bunny::Session) }
+  subject(:channel_connector) { described_class.new }
 
-  before do
-    allow(Bunny).to receive(:new).and_return(bunny_session)
-    allow(bunny_session).to receive(:start)
-    allow(bunny_session).to receive(:create_channel)
-    @default_allow_delayed = Pwwka.configuration.options[:allow_delayed]
-  end
+  describe "initialize" do
+    let(:bunny_channel) { instance_double(Bunny::Channel) }
 
-  after do
-    Pwwka.configuration.options[:allow_delayed] = @default_allow_delayed
-  end
+    before do
+      allow(Bunny).to receive(:new).and_return(bunny_session)
+      allow(bunny_session).to receive(:start)
+      allow(bunny_session).to receive(:create_channel).and_return(bunny_channel)
+    end
 
-  subject(:channel_connector) { described_class.new }
+    it "sets a prefetch value if configured to do so" do
+      expect(bunny_channel).to receive(:prefetch).with(10)
+
+      described_class.new(prefetch: 10)
+    end
+
+    it "does not set a prefetch value unless configured" do
+      expect(bunny_channel).not_to receive(:prefetch).with(10)
+
+      described_class.new
+    end
+  end
 
   describe "raise_if_delayed_not_allowed" do
+    before do
+      allow(Bunny).to receive(:new).and_return(bunny_session)
+      allow(bunny_session).to receive(:start)
+      allow(bunny_session).to receive(:create_channel)
+      @default_allow_delayed = Pwwka.configuration.options[:allow_delayed]
+    end
+
+    after do
+      Pwwka.configuration.options[:allow_delayed] = @default_allow_delayed
+    end
+
     context "delayed is configured" do
       it "does not blow up" do
         Pwwka.configuration.options[:allow_delayed] = true

data/spec/unit/configuration_spec.rb

@@ -119,4 +119,18 @@ describe Pwwka::Configuration do
       end
     end
   end
+
+  describe "#default_prefetch" do
+    it "is nil by default" do
+      expect(configuration.default_prefetch).to be_nil
+    end
+
+    it "is a number" do
+      configuration.default_prefetch = 10
+      expect(configuration.default_prefetch).to eq(10)
+      configuration.default_prefetch = "10"
+      expect(configuration.default_prefetch).to eq(10)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -224,6 +224,7 @@ files:
 - lib/pwwka/test_handler.rb
 - lib/pwwka/transmitter.rb
 - lib/pwwka/version.rb
+- owners.json
 - pwwka.gemspec
 - spec/integration/interrupted_receivers_spec.rb
 - spec/integration/send_and_receive_spec.rb
@@ -266,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Send and receive messages via RabbitMQ