propono 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53dbc7f715b2bb37de7874a88c8b3f968ea1fc4f
-  data.tar.gz: 11bce43d6c3753af3af92c9c91b293a376fae392
+SHA256:
+  metadata.gz: a9f4ef61f2fc61c86555f4ce3d2b8774066507e41d28c9e9b192b983f4f5c7a2
+  data.tar.gz: 60c26c57e8751eb45f9ebd10b43ee6d02445a274295a04aeeee8a3537354664b
 SHA512:
-  metadata.gz: 235e0650f5f1be3b1240b57b87c48fd66609cb2e7d915b8e6a409ed67e8475c680540cf0fc021aaa408915e3643c307a32afd1b5f1150c945b4ce7e361b0cffd
-  data.tar.gz: 221535790828808e5451dc8ba3ff32aa882c719d840c9d25cf5f4619839d22b1c2fa0e3dde48aa71a75bb6723f607516f4a56c75c3c8899a8354425b1bdf66ec
+  metadata.gz: a062a3fea085d58e0502d9e3a4b9e37c33e601a49fa59b7ac470a22587752458d0510242baceb4ae026bd121b5b5c22f0e29027a5de09dbf310301bda9093234
+  data.tar.gz: 4263d2200e6be98b1a6b99f7ba67d6af0661db8dd8427d5b362d79f18532c7c4af428fea750d36de01fc0c7558e9dc7726cc065cf1c7c90a9b77125c37b2e09e

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-# 2.0.0 / 2017-03-14
+# 2.2.0 / 2019-09-21
+* [FEATURE] Add setting to disable slow queue
+
+# 2.1.0 / 2017-03-14
 * [FEATURE] Added visibility_timeout to listen
 
 # 2.0.0 / 2017-03-14

data/README.md

@@ -23,7 +23,7 @@ Propono::Client.new.publish('some-topic', "The Best Message Ever")
 
 ## Changes from v1 to v2
 
-Version 2 of Propono changed a few things: 
+Version 2 of Propono changed a few things:
 - We moved from a global interface to a client interface. Rather than calling `publish` and equivalent on `Propono`, you should now initialize a `Propono::Client` and then call everything on that client. This fixes issues with thread safety and global config.
 - We have also removed the dependancy on Fog and instead switch to the `sns` and `sqs` mini-gems of `aws-sdk`.
 - UDP and TCP support have been removed, and `subscribe_by_post` has been removed.
@@ -99,11 +99,17 @@ Propono::Client.new do |config|
 
   config.max_retries = "The number of retries if a message raises an exception before being placed on the failed queue"
   config.num_messages_per_poll = "The number of messages retrieved per poll to SQS"
+
+  config.slow_queue_enabled = true
 end
 ```
 
 ### Options
 
+#### Async
+
+By default messages are posted inline, blocking the main thread. The `async: true` option can be sent when posting a message, which will spawn a new thread for the message networking calls, and unblocking the main thread.
+
 #### Visiblity Timeout
 
 For certain tasks (e.g. video processing), being able to hold messages for longer is important. To achieve this, the [visibility timeout of a message](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) can be changed on the call to listen. e.g.
@@ -114,6 +120,10 @@ client.listen('long-running-tasks', visiblity_timeout: 3600) do |message|
 end
 ```
 
+### Slow Queue
+
+The slow queue can be disabled by setting `slow_queue_enabled` to `false`. This will yield performance improvements if you do not make use of the "slow queue" functionality.
+
 These can all also be set using the `client.config.access_key = "..."` syntax.
 
 ### Is it any good?

data/lib/propono/components/aws_client.rb

@@ -43,7 +43,7 @@ module Propono
     def set_sqs_policy(queue, policy)
       sqs_client.set_queue_attributes(
         queue_url: queue.url,
-        attributes: { "Policy": policy }
+        attributes: { Policy: policy }
       )
     end
 

data/lib/propono/configuration.rb

@@ -22,6 +22,7 @@ module Propono
     add_setting :logger
     add_setting :max_retries
     add_setting :num_messages_per_poll
+    add_setting :slow_queue_enabled, required: false
 
     add_setting :use_iam_profile, required: false
     add_setting :queue_suffix,    required: false
@@ -32,7 +33,8 @@ module Propono
         queue_suffix:          "",
         use_iam_profile:       false,
         max_retries:           0,
-        num_messages_per_poll: 10
+        num_messages_per_poll: 1,
+        slow_queue_enabled:    true
       }
     end
 

data/lib/propono/services/queue_listener.rb

@@ -28,14 +28,14 @@ module Propono
     def drain
       raise ProponoError.new("topic_name is nil") unless topic_name
       true while read_messages_from_queue(main_queue, 10, long_poll: false)
-      true while read_messages_from_queue(slow_queue, 10, long_poll: false)
+      true while read_messages_from_queue(slow_queue, 10, long_poll: false) if propono_config.slow_queue_enabled
     end
 
     private
 
     def read_messages
       read_messages_from_queue(main_queue, propono_config.num_messages_per_poll) ||
-      read_messages_from_queue(slow_queue, 1)
+        (propono_config.slow_queue_enabled ?  read_messages_from_queue(slow_queue, 1) : nil)
     end
 
     def read_messages_from_queue(queue, num_messages, long_poll: true)

data/lib/propono/version.rb

@@ -1,3 +1,3 @@
 module Propono
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/test/configuration_test.rb

@@ -65,7 +65,7 @@ module Propono
     end
 
     def test_default_num_messages_per_poll
-      assert_equal 10, propono_config.num_messages_per_poll
+      assert_equal 1, propono_config.num_messages_per_poll
     end
 
     def test_num_messages_per_poll

data/test/services/queue_listener_test.rb

@@ -58,6 +58,7 @@ module Propono
       end
     end
 
+    # Keep this test in sync with the one below, just with the config enabled
     def test_drain_should_continue_if_queue_empty
       @listener.expects(:read_messages_from_queue).with(@slow_queue, 10, long_poll: false).returns(false)
       @listener.expects(:read_messages_from_queue).with(@queue, 10, long_poll: false).returns(false)
@@ -65,6 +66,16 @@ module Propono
       assert true
     end
 
+    # Keep this test in sync with the one above, just with the config disabled
+    def test_drain_ignores_slow_queue_if_disabled
+      propono_config.slow_queue_enabled = false
+
+      @listener.expects(:read_messages_from_queue).with(@slow_queue, 10, long_poll: false).never
+      @listener.expects(:read_messages_from_queue).with(@queue, 10, long_poll: false).returns(false)
+      @listener.drain
+      assert true
+    end
+
     def test_drain_raises_with_nil_topic
       listener = QueueListener.new(aws_client, propono_config, nil) {}
       assert_raises ProponoError do
@@ -217,6 +228,7 @@ module Propono
       @listener.send(:move_to_corrupt_queue, @sqs_message1)
     end
 
+    # Keep this test in sync with the one below, just with the config enabled
     def test_if_no_messages_read_from_normal_queue_read_from_slow_queue
       main_queue = mock
       @listener.stubs(main_queue: main_queue)
@@ -228,6 +240,20 @@ module Propono
       @listener.send(:read_messages)
     end
 
+    # Keep this test in sync with the one above, just with the config disabled
+    def ignore_slow_queue_if_disabled
+      propono_config.slow_queue_enabled = false
+
+      main_queue = mock
+      @listener.stubs(main_queue: main_queue)
+      slow_queue = mock
+      @listener.stubs(slow_queue: slow_queue)
+
+      @listener.expects(:read_messages_from_queue).with(main_queue, propono_config.num_messages_per_poll).returns(false)
+      @listener.expects(:read_messages_from_queue).with(slow_queue, 1).never
+      @listener.send(:read_messages)
+    end
+
     def test_if_read_messages_from_normal_do_not_read_from_slow_queue
       main_queue = mock
       @listener.stubs(main_queue: main_queue)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: propono
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - MalcyL
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
@@ -177,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: General purpose pub/sub library built on top of AWS SNS and SQS
@@ -199,4 +198,3 @@ test_files:
 - test/services/queue_listener_test.rb
 - test/test_helper.rb
 - test/utils/hash_test.rb
-has_rdoc: