symphony 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a99b3dc3c9e5a87d5a1bb25c28bf3255f19ad8aa2843ff543e068f4c768ac3
-  data.tar.gz: 1c083a2547cbb2abc3ce39676679745541343bc02a275c7042c4327769335d81
+  metadata.gz: 4a3df7405c545cb568ef001dd1287e51bc2e2de8184d8b5ef43204b5fca7599b
+  data.tar.gz: 2abfd45b2447a5660feae02c67f9bbd5d856a68ba69cd391c9b7101e9a1a4582
 SHA512:
-  metadata.gz: a33510957bbd58b6be49c65a14726237c01c300f071b51799135c64962ec327f69bcce74912387b207d9964489f03b8ac614f7ccbc28eb97da992cbf6dd1bfba
-  data.tar.gz: 1a5f13e6a1f59997d947ca5f6775e9d524f21f577865ae7ad9b60972bf113841865d0f444c3bd0494cc313fbb62759873ebd8d89a19f220c6c266a717ce27b74
+  metadata.gz: a2bf4f256cb6605cbadfb03e6432a61cd036bf372ce8c97db932e3eafef0d22d9a8bf3e6907c772a271258fee096a5b87fd9a8f285b03302e94d922d65ccbff4
+  data.tar.gz: e384f2e9edbb3dc43e773e8cfa69be3bd316c8cbfa233d7ee93ab3865c67e90110f223671775d7318282cbee3ccbfed7d3a3ab17581f51f17edcee212f519bfb

data.tar.gz.sig

@@ -1,2 +1,4 @@
-����sK�CkQ����%�@M�������/�
-�j�S�*���p������O�qg=\�"�M�/�<woW[�3��+'�&Z�$��;���O=��F	z?b`����Q���!��n%GM����$/N�`1��`Z���
+��a�
���qsJ;1���`��M�`�a��6��J���
+��oH�t?�.Oq�;1t#
+�tl(�#���u�I�
+�a����Sծ�|�Q�S�`�Ϸv���NM�O���߽n�\�`J��

data/History.rdoc

@@ -2,6 +2,14 @@
 
 ---
 
+== v0.14.0 [2020-07-23] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Allow `x-queue-type` to be specified for a `Task`. Thanks to
+  Alyssa Verkade <averkade@costar.com> for the patch.
+
+
 == v0.13.0 [2020-03-09] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/README.md

@@ -1,7 +1,10 @@
 # symphony
 
 home
-: https://hg.sr.ht/~ged/symphony
+: https://hg.sr.ht/~ged/Symphony
+
+code
+: https://hg.sr.ht/~ged/Symphony/browse
 
 docs
 : https://deveiate.org/code/symphony

data/USAGE.rdoc

@@ -79,14 +79,14 @@ calling #run on the class itself.
 == The Simplest Task
 
     #!/usr/bin/env ruby
-    
+
     require 'symphony'
-    
+
     class Test < Symphony::Task
-        
+
         # Process all events
         subscribe_to '#'
-        
+
         def work( payload, metadata )
             puts "I received an event: %p with a payload of %p" % [
                 metadata[ :delivery_info ][ :routing_key ],
@@ -95,7 +95,7 @@ calling #run on the class itself.
             return true
         end
     end
-    
+
     Symphony.load_config( 'etc/config.yml' )
     Test.run
 
@@ -239,13 +239,13 @@ By default, Symphony will try and create a queue based on the Class
 name of the task.  You can override this per-task.
 
     class Test < Symphony::Task
-        
+
         # Process all events
         subscribe_to '#'
-        
+
         # I don't want to connect to a 'test' queue, lets make it interesting:
         queue_name 'shazzzaaaam'
-            
+
         def work( payload, metadata )
         ...
 
@@ -261,14 +261,28 @@ can tell a task to create a persistent queue instead of an auto-delete queue:
 
 == Queue Re-binding
 
-If you want Symphony to re-bind a worker's queue when it starts up, you call tell it to with +always_rebind+:
+If you want Symphony to re-bind a worker's queue when it starts up, you call
+tell it to with +always_rebind+:
 
     always_rebind true
 
-Note that re-binding doesn't *unbind* from the existing pattern/s, so you'll 
+Note that re-binding doesn't *unbind* from the existing pattern/s, so you'll
 need to account for this in the Task's +work+ method.
 
 
+== Queue Type
+
+If you're running a version of RabbitMQ that supports the `x-queue-type`
+argument (e.g., for quorum queues), you can specify a value for it using the
+`queue_type` declaration:
+
+    queue_type 'quorum'
+
+Note that several other queue settings might not work with some kinds of
+queues; the validity of the combination of the task's settings are left to
+the implementor.
+
+
 = Plugins
 
 Plugins change or enhance the behavior of a Symphony::Task.
@@ -287,7 +301,7 @@ the process name to display a total count and jobs per second rate.
         prepend Symphony::Metrics
         # ...
     end
-        
+
 
 == Routing
 
@@ -300,13 +314,13 @@ receive multiple message topics much easier to maintain and test.
 
     class Test < Symphony::Task
         include Symphony::Routing
-        
+
         on 'users.create', 'workstation.create' do |payload, metadata|
             puts "A user or workstation wants to be created!"
             # ...
             return true
         end
-        
+
         on 'users.delete' do |payload, metadata|
             puts "A user wants to be deleted!"
             return true

data/lib/symphony.rb

@@ -12,7 +12,7 @@ module Symphony
 	       Configurability
 
 	# Library version constant
-	VERSION = '0.13.0'
+	VERSION = '0.14.0'
 
 	# Version-control revision constant
 	REVISION = %q$Revision$

data/lib/symphony/queue.rb

@@ -150,13 +150,14 @@ class Symphony::Queue
 
 	### Create a new Queue for the specified +task_class+.
 	def initialize( task_class )
-		@name          = task_class.queue_name
-		@acknowledge   = task_class.acknowledge
-		@consumer_tag  = task_class.consumer_tag
-		@routing_keys  = task_class.routing_keys
-		@prefetch      = task_class.prefetch
-		@persistent    = task_class.persistent
-		@always_rebind = task_class.always_rebind
+		@name            = task_class.queue_name
+		@acknowledge     = task_class.acknowledge
+		@consumer_tag    = task_class.consumer_tag
+		@routing_keys    = task_class.routing_keys
+		@prefetch        = task_class.prefetch
+		@persistent      = task_class.persistent
+		@always_rebind   = task_class.always_rebind
+		@amqp_queue_type = task_class.queue_type
 
 		@amqp_queue    = nil
 		@shutting_down = false
@@ -195,6 +196,10 @@ class Symphony::Queue
 	# Whether or not to re-bind the queue to the exchange during setup
 	attr_predicate :always_rebind
 
+	##
+	# The -x-queue-type of the queue, if any
+	attr_reader :amqp_queue_type
+
 	##
 	# The underlying Bunny::Queue this object manages
 	attr_reader :amqp_queue
@@ -256,19 +261,20 @@ class Symphony::Queue
 		exchange = self.class.amqp_exchange
 		channel = self.class.amqp_channel
 		created_queue = false
-		queue         = nil
 
-		begin
-			queue = channel.queue( self.name, passive: true )
+		queue = begin
+			existing_queue = channel.queue( self.name, passive: true )
 			channel.prefetch( prefetch_count )
 			self.log.info "Using pre-existing queue: %s" % [ self.name ]
+			existing_queue
 		rescue Bunny::NotFound => err
 			self.log.info "%s; creating a new queue instead." % [ err.message ]
 			created_queue = true
 			channel = self.class.reset_amqp_channel
 			channel.prefetch( prefetch_count )
 
-			queue = channel.queue( self.name, auto_delete: !self.persistent )
+			arguments = { 'x-queue-type' => self.amqp_queue_type }.compact
+			channel.queue( self.name, auto_delete: !self.persistent, arguments: arguments )
 		end
 
 		if self.always_rebind? || created_queue

data/lib/symphony/task.rb

@@ -53,6 +53,7 @@ class Symphony::Task
 	@prefetch      = 10
 	@persistent    = false
 	@always_rebind = false
+	@queue_type    = nil
 
 
 	### Create a new Task object and listen for work. Exits with the code returned
@@ -88,6 +89,7 @@ class Symphony::Task
 		super
 
 		subclass.instance_variable_set( :@queue, nil )
+		subclass.instance_variable_set( :@queue_type, nil )
 		subclass.instance_variable_set( :@always_rebind, false )
 		subclass.instance_variable_set( :@routing_keys, Set.new )
 		subclass.instance_variable_set( :@acknowledge, true )
@@ -143,6 +145,16 @@ class Symphony::Task
 	end
 
 
+	### Specify an x-queue-type for the underlying queue
+	def self::queue_type( type=nil )
+		if type
+			@queue_type = type
+		end
+
+		return @queue_type
+	end
+
+
 	### Set up one or more topic key patterns to use when binding the Task's queue
 	### to the exchange.
 	def self::subscribe_to( *routing_keys )

data/spec/symphony/queue_spec.rb

@@ -128,7 +128,33 @@ RSpec.describe Symphony::Queue do
 			expect( new_channel ).to receive( :prefetch ).
 				with( Symphony::Queue::DEFAULT_PREFETCH )
 			expect( new_channel ).to receive( :queue ).
-				with( queue.name, auto_delete: true ).
+				with( queue.name, auto_delete: true, arguments: {} ).
+				and_return( amqp_queue )
+			expect( amqp_queue ).to receive( :bind ).
+				with( described_class.amqp_exchange, routing_key: 'floppy.rabbit.#' )
+
+			expect( queue.create_amqp_queue ).to be( amqp_queue )
+		end
+
+
+		it "can declare the queue's x-queue-type" do
+			testing_task_class.subscribe_to( 'floppy.rabbit.#' )
+			testing_task_class.queue_type( 'classic' )
+			expect( described_class.amqp_channel ).to receive( :queue ).
+				with( queue.name, passive: true ).
+				and_raise( Bunny::NotFound.new("no such queue", described_class.amqp_channel, true) )
+			expect( described_class.amqp_channel ).to receive( :open? ).
+				and_return( false )
+
+			# Channel is reset after queue creation fails
+			new_channel = double( "New AMQP channel" )
+			amqp_queue = double( "AMQP queue" )
+			allow( described_class.amqp_session ).to receive( :create_channel ).
+				and_return( new_channel )
+			expect( new_channel ).to receive( :prefetch ).
+				with( Symphony::Queue::DEFAULT_PREFETCH )
+			expect( new_channel ).to receive( :queue ).
+				with( queue.name, auto_delete: true, arguments: { 'x-queue-type' => 'classic' } ).
 				and_return( amqp_queue )
 			expect( amqp_queue ).to receive( :bind ).
 				with( described_class.amqp_exchange, routing_key: 'floppy.rabbit.#' )

data/spec/symphony/task_spec.rb

@@ -99,6 +99,23 @@ RSpec.describe Symphony::Task do
 		end
 
 
+		it "can set the x-queue-type for the queue" do
+			task = Class.new( described_class ) do
+				queue_name 'wascally.wabbit'
+				queue_type 'classic'
+			end
+			expect( task.queue_type ).to eq( 'classic' )
+		end
+
+
+		it "has a queue type of nil if unspecified" do
+			task = Class.new( described_class ) do
+				queue_name 'wascally.wabbit'
+			end
+			expect( task.queue_type ).to eq( nil )
+		end
+
+
 		it "can set the number of messages to prefetch" do
 			task_class.prefetch( 10 )
 			expect( task_class.prefetch ).to eq( 10 )

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: symphony
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Michael Granger
 - Mahlon E. Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
   XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configurability
@@ -169,6 +169,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -246,14 +260,16 @@ files:
 - spec/symphony/task_group_spec.rb
 - spec/symphony/task_spec.rb
 - spec/symphony_spec.rb
-homepage: https://hg.sr.ht/~ged/symphony
+homepage: https://hg.sr.ht/~ged/Symphony
 licenses:
 - BSD-3-Clause
 metadata:
-  homepage_uri: https://hg.sr.ht/~ged/symphony
+  homepage_uri: https://hg.sr.ht/~ged/Symphony
   documentation_uri: https://deveiate.org/code/symphony
   changelog_uri: https://deveiate.org/code/symphony/History_md.html
-post_install_message: 
+  source_uri: https://hg.sr.ht/~ged/Symphony/browse
+  bug_tracker_uri: https://todo.sr.ht/~ged/Symphony/browse
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Symphony is a subscription-based asynchronous job system.
 test_files: []