smith 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28699a1628e95ca70d8b4885013ca54a4ffd10a9
-  data.tar.gz: 40d84936049ef5870edb312f7b929cba7190e560
+  metadata.gz: 5b0a3ce48b208c5e828b780e7cc46b9acaf52db8
+  data.tar.gz: 3ef6cffd4dbe62b2b385744ed02f85a667f22ada
 SHA512:
-  metadata.gz: d2fde06efa6ae03bee3ae7256e94e6ff050df99099c3a568a4627de290dbcb2acf87f5c877449e3f8e9a0a80817fb28081c011fbf0a95c74eca567b6236f70a3
-  data.tar.gz: 36ae72308f09a898e5db3caf9fb235e9e5a66a6a59ac71e6ba112aaad0fa937507cbb2c2511895883a0b47a2e0ba95dc64f81dd2247c2aa2a34fc04cc88b6053
+  metadata.gz: e154e8e5f9a581e8f68bb663cd9509daa56c7e1d0d7844c536c2566e3bdb19d0123e83dae47741107813e473a41f4f31173023ed06655d3724ffb730ab640b7d
+  data.tar.gz: 1960ac4441479753ac6e7bce7da67533d04497c292a7dac43e2041deb8f2e9383fcfd74be9a5a7d83b6884cf826cfdd2c77ccd0ce21798e0267960c3d8c4388f

data/lib/smith/agent.rb

@@ -32,7 +32,7 @@ module Smith
         c.completion do |completion|
           acknowledge_start do
             @on_running.call(@on_running_completion)
-            logger.info { "Agent started: #{name}:[#{pid}]." }
+            logger.info { "Agent started: #{name}, UUID: #{uuid}, PID: #{pid}" }
           end
         end
       end
@@ -49,9 +49,7 @@ module Smith
         c.completion do |completion|
           acknowledge_stop do
             @state = :stopping
-            Smith.stop do
-              logger.info { "Agent stopped: #{name}:[#{pid}]." }
-            end
+            Smith.stop
           end
         end
       end

data/lib/smith/agent_process.rb

@@ -199,8 +199,9 @@ module Smith
       Process.detach(agent_process.pid)
     end
 
+    # FIXME: This doesn't appear to be being called.
     def self.acknowledge_start(agent_process, &blk)
-      logger.info { "Agent started: #{agent_process.uuid}" }
+      logger.info { "Agent started: #{agent_process.name}, UUID: #{agent_process.uuid}, PID: #{agent_process.pid}" }
     end
 
     def self.stop(agent_process)
@@ -209,7 +210,7 @@ module Smith
           if count > 0
             sender.publish(ACL::AgentCommand.new(:command => 'stop'))
           else
-            logger.warn { "Agent is not listening. Setting state to dead." }
+            logger.warn { "Agent is not listening. Setting state to dead: #{agent_process.name}, UUID: #{agent_process.uuid}, PID: #{agent_process.pid}" }
             agent_process.no_process_running
           end
         end
@@ -223,7 +224,7 @@ module Smith
 
     def self.acknowledge_stop(agent_process)
       agent_process.delete
-      logger.info { "Agent stopped: #{agent_process.uuid}" }
+      logger.info { "Agent stopped: #{agent_process.name}, UUID: #{agent_process.uuid}, PID: #{agent_process.pid}" }
     end
 
     # This needs to use the PID class to verify if an agent is still running.
@@ -234,7 +235,8 @@ module Smith
           logger.info { "Agent's pid is 0. The agent probably didn't start correctly. Cleaning up." }
           agent_process.delete
         else
-          logger.info { "Sending kill signal: #{agent_process.pid}: #{agent_process.uuid}" }
+          logger.info { "Sending signal: TERM, #{agent_process.name}, UUID: #{agent_process.uuid}, PID: #{agent_process.pid}" }
+
           begin
             Process.kill('TERM', agent_process.pid)
           rescue

data/lib/smith/application/agency.rb

@@ -95,7 +95,7 @@ module Smith
     def dead(agent_data)
       agent_exists?(agent_data.uuid) do |agent_process|
         if agent_process.no_process_running
-          logger.fatal { "Agent is dead: #{agent_data.uuid}" }
+          logger.fatal { "Agent is dead: #{agent_process.name}, UUID: #{agent_process.uuid}, PID: #{agent_process.pid}" }
         end
       end
     end

data/lib/smith/bootstrap.rb

@@ -25,6 +25,9 @@ module Smith
       # thrown in setup_control_queue, for example, it just kills
       # the agent without it actually raising the exception.
       Thread.abort_on_exception = true
+
+      EventMachine.error_handler { |e| terminate!(e) }
+
       @agent_name = name
       @agent_uuid = uuid
     end
@@ -33,7 +36,8 @@ module Smith
       logger.debug { "Installing default signal handlers" }
       %w{TERM INT QUIT}.each do |sig|
         @agent.install_signal_handler(sig) do |sig|
-          logger.error { "Agent received: signal #{sig}: #{agent.name} (#{agent.uuid})" }
+          logger.error { "Received signal #{sig}: #{agent.name}, UUID: #{agent.uuid}, PID: #{agent.pid}." }
+
           terminate!
         end
       end
@@ -71,19 +75,16 @@ module Smith
 
       if Smith.running?
         send_dead_message
-        unlink_pid_file
-        Smith.stop
+        shutdown
       else
-        logger.debug { "Reconnecting to AMQP Broker." }
         Smith.start do
           send_dead_message
-          unlink_pid_file
-          Smith.stop
+          shutdown
         end
       end
     end
 
-    # Clean shutdown of the agent.
+    # Cleanly shutdown of the agent.
     def shutdown
       unlink_pid_file
       Smith.stop if Smith.running?
@@ -128,7 +129,7 @@ module Smith
         @agent.__send__(:__exception_handler, exception) if @agent
         logger.error { format_exception(exception) }
       end
-      logger.error { "Terminating: #{@agent_uuid}." }
+      logger.error { "Terminating: #{@agent_name}, UUID: #{@agent_uuid}, PID: #{@pid.pid}." }
     end
 
     # Add the ../lib to the load path. This assumes the directory
@@ -168,18 +169,9 @@ Smith.compile_acls
 
 bootstrapper = Smith::AgentBootstrap.new(name, uuid)
 
-# I've tried putting the exception handling in the main reactor log
-# but it doesn't do anything. I know there's a reason for this but I
-# don't what it is at the moment. Just beware that whenever there
-# is an exception the reactor is not going going to be running.
-begin
-  Smith.start do
-    if bootstrapper.load_agent
-      bootstrapper.signal_handlers
-      bootstrapper.start!
-    end
+Smith.start do
+  if bootstrapper.load_agent
+    bootstrapper.signal_handlers
+    bootstrapper.start!
   end
-  bootstrapper.shutdown
-rescue Exception => e
-  bootstrapper.terminate!(e)
 end

data/lib/smith/logger.rb

@@ -69,7 +69,7 @@ module Smith
       end
 
       def __reload
-        @logger = Logging.logger[self.class.to_s || 'main']
+        @logger = Logging.logger[(self.is_a?(Module)) ? name : self.class.name]
         @logger.caller_tracing = @@__trace
         @reload = false
       end

data/lib/smith/messaging/receiver.rb

@@ -18,6 +18,7 @@ module Smith
         @acl_type_cache = AclTypeCache.instance
 
         @foo_options = {
+          :error_queue => opts.delete(:error_queue) { false },
           :auto_ack => option_or_default(@queue_def.options, :auto_ack, true),
           :threading => option_or_default(@queue_def.options, :threading, false)}
 
@@ -95,7 +96,7 @@ module Smith
             if !queue.subscribed?
               opts = @options.subscribe
               logger.debug { "Subscribing to: [queue]:#{@queue_def.denormalise} [options]:#{opts}" }
-              queue.subscribe(opts) do |metadata,payload|
+              queue.subscribe(opts) do |metadata, payload|
                 if payload
                   on_message(metadata, payload, requeue_options, &blk)
                 else
@@ -234,14 +235,20 @@ module Smith
       end
     end
 
+    # This class gets passed into the receive block and is a representation of
+    # both the message and the message metadata. It also handles requeues and
+    # retries. In short it's very much a convenience class which is why I have
+    # no idea what to call it!
+    #
     class Foo
       include Smith::Logger
 
       attr_accessor :metadata
 
       def initialize(metadata, data, opts={}, requeue_opts, &blk)
+        @opts = opts
         @metadata = metadata
-        @reply_queue = opts[:reply_queue]
+        @reply_queue = @opts[:reply_queue]
         @requeue_opts = requeue_opts
 
         @acl_type_cache = AclTypeCache.instance
@@ -253,14 +260,14 @@ module Smith
 
         @message = clazz.new.parse_from_string(data)
 
-        if opts[:threading]
+        if @opts[:threading]
           EM.defer do
             blk.call(@message, self)
-            ack if opts[:auto_ack]
+            ack if @opts[:auto_ack]
           end
         else
           blk.call(@message, self)
-          ack if opts[:auto_ack]
+          ack if @opts[:auto_ack]
         end
       end
 
@@ -289,6 +296,40 @@ module Smith
       end
       alias :call :ack
 
+      # Publish the ACL to the error queue set up for this queue. This method is only
+      # available if the :error_queue option is set to true. Note this is the
+      # receive queue name which in most cases is the same at the sender name
+      # but if you are using fanout queues it will be different.
+      #
+      # @param [ACL] acl Optional ACL. With any options this method will fail the entire
+      #                  ACL. This may not be what you want though. So this opton allows
+      #                  you to fail another ACL. WARNING: there is no type checking at
+      #                  the moment. If you publish an ACL that this agent can't process
+      #                  and republish that ACL at a future date the agent will blow up.
+      #
+      # @param [Hash] opts Options hash. This currently only supports on option:
+      #   :ack. If you publish a different ACL from the one received you will have to
+      #   ack that message yourself and make sure `:ack => nil`
+      #
+      # @yieldparam [Fixnum] The number of ACLs on the error queue.
+      #
+      def fail(acl=nil, opts={:ack => true}, &blk)
+        if @opts[:error_queue]
+          message = (acl) ? acl : @message
+          Sender.new("#{queue_name}.error") do |queue|
+            logger.debug { "Republishing ACL to error queue: \"#{queue.queue_name}\"" }
+            queue.publish(message) do
+              queue.number_of_messages do |count|
+                @metadata.ack if opts[:ack]
+                blk && blk && blk.call(count + 1)
+              end
+            end
+          end
+        else
+          raise ArgumentError, "You cannot fail this queue as you haven't specified the :error_queue option"
+        end
+      end
+
       # Make #call invoke ack. This makes the following idiom possible:
       #
       # receiver('queue').subscribe do |payload, receiver|
@@ -309,6 +350,23 @@ module Smith
       def correlation_id
         @metadata.correlation_id
       end
+
+      # Return the queue_name. Note this is the receive queue name which in
+      # most cases is the same at the sender name but if you are using fanout
+      # queues it will be different.
+      #
+      # @return [String] the name of the queue
+      #
+      def queue_name
+        begin
+          @a561facf ||= @metadata.channel.queues.detect { |queue| queue.bindings.first[:exchange] == @metadata.exchange }.name.gsub(/^#{Smith.config.smith.namespace}\./, '')
+        rescue NoMethodError
+          # If `bingings` is empty then an exception will be raised. I cannot
+          # see how it can possibly happend but if it does raise a slightly
+          # more informative exceptino
+          raise "Missing queue. This cannot happen and probably represents a bug. Exchange: #{@metadata.exchange}"
+        end
+      end
     end
   end
 end

data/lib/smith/version.rb

@@ -1,3 +1,3 @@
 module Smith
-  VERSION = "0.8.3"
+  VERSION = "0.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smith
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Richard Heycock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp