ruote-amqp 2.2.0 → 2.3.0

data/lib/ruote-amqp/launchitem_listener.rb

@@ -1,22 +0,0 @@
-
-module RuoteAMQP
-
-  #
-  # Got replaced by RuoteAMQP::Receiver
-  #
-  # This class is kept for backward compatibility.
-  #
-  class LaunchitemListener < ::RuoteAMQP::Receiver
-
-    # Start a new LaunchItem listener
-    #
-    # @param [ Ruote::Engine, Ruote::Storage ] A configured ruote engine or storage instance
-    # @param opts :queue / :unsubscribe
-    #
-    def initialize(engine_or_storage, opts={})
-
-      super(engine_or_storage, opts.merge(:launchitems => :only))
-    end
-  end
-end
-

data/lib/ruote-amqp/participant.rb

@@ -1,241 +0,0 @@
-
-require 'ruote/part/local_participant'
-require 'ruote-amqp'
-
-
-module RuoteAMQP
-
-  #
-  # = AMQP Participants
-  #
-  # The RuoteAMQP::ParticipantProxy allows you to send workitems (serialized as
-  # JSON) or messages to any AMQP queues right from the process
-  # definition. When combined with the RuoteAMQP::Receiver you can easily
-  # leverage an extremely powerful local/remote participant
-  # combinations.
-  #
-  # For local/remote participants The local part of the
-  # RuoteAMQP::ParticipantProxy relies on the presence of a
-  # RuoteAMQP::Receiver. Workitems are sent to the remote participant
-  # and the local part does not normally reply to the engine.  Instead
-  # the engine will continue when a reply is received on the
-  # 'ruote_workitems' queue (see RuoteAMQP::Receiver).
-  #
-  # Of course, the standard :forget => true format can be used even
-  # with remote particpants and :forget can even be set as a default in
-  # the options.
-  #
-  # A simple way to create a remote participant to act upon workitems
-  # is to use the daemon-kit ruote responder.
-  #
-  # Simple AMQP messages are treated as 'fire and forget' and the flow
-  # will continue when the local participant has queued the message
-  # for sending. (As there is no meaningful way to receive a workitem
-  # in reply).
-  #
-  # == Configuration
-  #
-  # AMQP configuration is handled by directly manipulating the
-  # values of the +AMQP.settings+ hash, as provided by the AMQP
-  # gem. No AMQP defaults are set by the participant.
-  #
-  # == Usage
-  #
-  # Define the queue used by an AMQP participant :
-  #
-  #   engine.register_participant(
-  #     :delete_user, RuoteAMQP::ParticipantProxy, 'queue' => 'user_manager')
-  #
-  # Sending a workitem to the remote participant defined above:
-  #
-  #   Ruote.process_definition do
-  #     sequence do
-  #       delete_user
-  #     end
-  #   end
-  #
-  # Let the local participant reply to the engine without involving
-  # the receiver
-  #
-  #   Ruote.process_definition do
-  #     sequence do
-  #       delete_user :forget => true
-  #     end
-  #   end
-  #
-  # Setting up the participant in a slightly more 'raw' way:
-  #
-  #   engine.register_participant(
-  #     :amqp, RuoteAMQP::ParticipantProxy )
-  #
-  # Sending a workitem to a specific queue:
-  #
-  #   Ruote.process_definition do
-  #     sequence do
-  #       amqp :queue => 'test', 'command' => '/run/regression_test'
-  #     end
-  #   end
-  #
-  # Setup a 'fire and forget' participant that always replies to the
-  # engine:
-  #
-  #   engine.register_participant(
-  #     :jfdi, RuoteAMQP::ParticipantProxy, 'forget' => true )
-  #
-  # Sending a message example to a specific queue (both steps are
-  # equivalent):
-  #
-  #   Ruote.process_definition do
-  #     sequence do
-  #       amqp :queue => 'test', :message => 'foo'
-  #       amqp :queue => 'test', :message => 'foo', :forget => true
-  #     end
-  #   end
-  #
-  #
-  # == AMQP notes
-  #
-  # The participant currently only makes use of direct
-  # exchanges. Possible future improvements might see use for topic
-  # and fanout exchanges as well.
-  #
-  # The direct exchanges are always marked as durable by the
-  # participant, and messages are marked as persistent by default (see
-  # #RuoteAMQP)
-  #
-  class ParticipantProxy
-
-    include Ruote::LocalParticipant
-
-    # The following parameters are used in the process definition.
-    #
-    # An options hash with the same keys to provide defaults is
-    # accepted at registration time (see above).
-    #
-    # * :queue => (string) The AMQP queue used by the remote participant.
-    #   nil by default.
-    # * :forget => (bool) Whether the flow should block until the remote
-    #   participant replies.
-    #   false by default
-    #
-    def initialize(options)
-
-      RuoteAMQP.start!
-
-      @options = {
-        'queue' => nil,
-        'forget' => false,
-      }.merge(options.inject({}) { |h, (k, v)|
-        h[k.to_s] = v; h
-      })
-        #
-        # the inject is here to make sure that all options have String keys
-    end
-
-    # Process the workitem at hand. By default the workitem will be
-    # published to the direct exchange specified in the +queue+
-    # workitem parameter. You can specify a +message+ workitem
-    # parameter to have that sent instead of the workitem.
-    #
-    def consume(workitem)
-
-      target_queue = determine_queue(workitem)
-
-      raise 'no queue specified (outbound delivery)' unless target_queue
-
-      q = MQ.queue(target_queue, :durable => true)
-      forget = determine_forget(workitem)
-
-      opts = {
-        :persistent => RuoteAMQP.use_persistent_messages?,
-        :content_type => 'application/json' }
-
-      if message = workitem.fields['message'] || workitem.params['message']
-
-        forget = true # sending a message implies 'forget' => true
-
-        q.publish(message, opts)
-
-      else
-
-        q.publish(encode_workitem(workitem), opts)
-      end
-
-      reply_to_engine(workitem) if forget
-    end
-
-    # (Stops the underlying queue subscription)
-    #
-    def stop
-
-      RuoteAMQP.stop!
-    end
-
-    def cancel(fei, flavour)
-      #
-      # TODO : sending a cancel item is not a bad idea, especially if the
-      #        job done over the amqp fence lasts...
-      #
-    end
-
-    # The current AMQP (0.6.7) has 1 queue per thread. If you let the default
-    # "one thread per participant consume call" kick in, you'll end up with
-    # 1 queue per consume call (and...)
-    #
-    # So, by returning true here, we force the queue to be always the same.
-    #
-    # Many thanks to https://github.com/weifeng365 for reporting this issue
-    # and suggesting the fix.
-    #
-    # TODO : should we have something to close queues when the engine / worker
-    #        shuts down ?
-    #        or is it already covered in the #stop ?
-    #
-    def do_not_thread
-
-      true
-    end
-
-    private
-
-    def determine_forget(workitem)
-
-      return workitem.params['forget'] if workitem.params.has_key?('forget')
-      return @options['forget'] if @options.has_key?('forget')
-      false
-    end
-
-    def determine_queue(workitem)
-
-      workitem.params['queue'] || @options['queue']
-    end
-
-    # Encodes the workitem as JSON. Makes sure to add to the field 'params'
-    # an entry named 'participant_options' which contains the options of
-    # this participant.
-    #
-    def encode_workitem(wi)
-
-      wi.params['participant_options'] = @options
-
-      Rufus::Json.encode(wi.to_h)
-    end
-  end
-
-  #
-  # Kept for backward compatibility.
-  #
-  # You should use RuoteAMQP::ParticipantProxy.
-  #
-  class Participant < ParticipantProxy
-
-    def initialize(options)
-      puts '=' * 80
-      puts "RuoteAMQP::Participant will be deprecated soon (2.1.12)"
-      puts "please use RuoteAMQP::ParticipantProxy instead"
-      puts '=' * 80
-      super
-    end
-  end
-end
-

data/lib/ruote-amqp/receiver.rb

@@ -1,147 +0,0 @@
-
-require 'ruote-amqp'
-
-
-module RuoteAMQP
-
-  #
-  # = AMQP Receiver
-  #
-  # Used in conjunction with the RuoteAMQP::Participant, the WorkitemListener
-  # subscribes to a specific direct exchange and monitors for
-  # incoming workitems. It expects workitems to arrive serialized as
-  # JSON.
-  #
-  # == Configuration
-  #
-  # AMQP configuration is handled by directly manipulating the values of
-  # the +AMQP.settings+ hash, as provided by the AMQP gem. No
-  # defaults are set by the listener. The only +option+ parsed by
-  # the initializer of the workitem listener is the +queue+ key (Hash
-  # expected). If no +queue+ key is set, the listener will subscribe
-  # to the +ruote_workitems+ direct exchange for workitems, otherwise it will
-  # subscribe to the direct exchange provided.
-  #
-  # == Usage
-  #
-  # Register the engine or storage with the listener:
-  #
-  #   RuoteAMQP::Receiver.new(engine_or_storage)
-  #
-  # The workitem listener leverages the asynchronous nature of the amqp gem,
-  # so no timers are setup when initialized.
-  #
-  # == Options
-  #
-  # :queue and :launchitems
-  #
-  # See the RuoteAMQP::Participant docs for information on sending
-  # workitems out to remote participants, and have them send replies
-  # to the correct direct exchange specified in the workitem
-  # attributes.
-  #
-  class Receiver < Ruote::Receiver
-
-    attr_reader :queue
-
-    # Starts a new Receiver
-    #
-    # Two arguments for this method.
-    #
-    # The first oone should be a Ruote::Engine, a Ruote::Storage or
-    # a Ruote::Worker instance.
-    #
-    # The second one is a hash for options. There are two known options :
-    #
-    # :queue for setting the queue on which to listen (defaults to
-    # 'ruote_workitems').
-    #
-    # The :launchitems option :
-    #
-    #   :launchitems => true
-    #     # the receiver accepts workitems and launchitems
-    #   :launchitems => false
-    #     # the receiver only accepts workitems
-    #   :launchitems => :only
-    #     # the receiver only accepts launchitems
-    #
-    def initialize(engine_or_storage, opts={})
-
-      super(engine_or_storage)
-
-      @launchitems = opts[:launchitems]
-
-      @queue =
-        opts[:queue] ||
-        (@launchitems == :only ? 'ruote_launchitems' : 'ruote_workitems')
-
-      RuoteAMQP.start!
-
-      if opts[:unsubscribe]
-        MQ.queue(@queue, :durable => true).unsubscribe
-        sleep 0.300
-      end
-
-      MQ.queue(@queue, :durable => true).subscribe do |message|
-        if AMQP.closing?
-          # do nothing, we're going down
-        else
-          handle(message)
-        end
-      end
-    end
-
-    def stop
-
-      RuoteAMQP.stop!
-    end
-
-    # (feel free to overwrite me)
-    #
-    def decode_workitem(msg)
-
-      (Rufus::Json.decode(msg) rescue nil)
-    end
-
-    private
-
-    def handle(msg)
-
-      item = decode_workitem(msg)
-
-      return unless item.is_a?(Hash)
-
-      not_li = ! item.has_key?('definition')
-
-      return if @launchitems == :only && not_li
-      return unless @launchitems || not_li
-
-      if not_li
-        receive(item) # workitem resumes in its process instance
-      else
-        launch(item) # new process instance launch
-      end
-
-    rescue => e
-      # something went wrong
-      # let's simply discard the message
-      $stderr.puts('=' * 80)
-      $stderr.puts(self.class.name)
-      $stderr.puts("couldn't handle incoming message :")
-      $stderr.puts('')
-      $stderr.puts(msg.inspect)
-      $stderr.puts('')
-      $stderr.puts(Rufus::Json.pretty_encode(item)) rescue nil
-      $stderr.puts('')
-      $stderr.puts(e.inspect)
-      $stderr.puts(e.backtrace)
-      $stderr.puts('=' * 80)
-    end
-
-    def launch(hash)
-
-      super(hash['definition'], hash['fields'] || {}, hash['variables'] || {})
-    end
-  end
-end
-

data/lib/ruote-amqp/version.rb

@@ -1,6 +0,0 @@
-
-module RuoteAMQP
-
-  VERSION = '2.2.0'
-end
-

data/lib/ruote-amqp/workitem_listener.rb

@@ -1,12 +0,0 @@
-
-module RuoteAMQP
-
-  #
-  # Got replaced by RuoteAMQP::Receiver
-  #
-  # This class is kept for backward compatibility.
-  #
-  class WorkitemListener < ::RuoteAMQP::Receiver
-  end
-end
-

data/spec/launchitem_listener_spec.rb

@@ -1,70 +0,0 @@
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-#
-# NOTE : RuoteAMQP::LaunchitemListener has been depreacted in favour of
-#        RuoteAMQP::Receiver
-#
-
-describe RuoteAMQP::LaunchitemListener do
-
-  after(:each) do
-    purge_engine
-  end
-
-  it 'launches processes' do
-
-    json = {
-      'definition' => %{
-        Ruote.process_definition :name => 'test' do
-          sequence do
-            echo '${f:foo}'
-          end
-        end
-      },
-      'fields' => { 'foo' => 'bar' }
-    }.to_json
-
-    RuoteAMQP::LaunchitemListener.new(@engine)
-
-    MQ.queue('ruote_launchitems', :durable => true).publish(json)
-
-    sleep 0.5
-
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
-
-    @tracer.to_s.should == 'bar'
-  end
-
-  it 'discards corrupt process definitions' do
-
-    json = {
-      'definition' => %{
-        I'm a broken process definition
-      },
-      'fields' => { 'foo' => 'bar' }
-    }.to_json
-
-    RuoteAMQP::LaunchitemListener.new(@engine, :unsubscribe => true)
-
-    serr = String.new
-    err = StringIO.new(serr, 'w+')
-    $stderr = err
-
-    MQ.queue('ruote_launchitems', :durable => true).publish(json)
-
-    sleep 0.5
-
-    err.close
-    $stderr = STDERR
-
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
-
-    @tracer.to_s.should == ''
-
-    serr.should match(/^===/)
-  end
-end
-

data/spec/ruote_amqp_spec.rb

@@ -1,18 +0,0 @@
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-
-describe RuoteAMQP do
-
-  it "uses persistent messages by default" do
-
-    RuoteAMQP.use_persistent_messages?.should be_true
-  end
-
-  it "allows switching to transient messages" do
-
-    RuoteAMQP.use_persistent_messages = false
-    RuoteAMQP.use_persistent_messages?.should be_false
-  end
-end
-

data/spec/support/ruote_helpers.rb

@@ -1,29 +0,0 @@
-
-module RuoteSpecHelpers
-
-  def purge_engine
-
-    # TODO : adapt to ruote 2.1.10
-  end
-
-  def run_definition(pdef)
-
-    wfid = @engine.launch(pdef)
-
-    #r = @engine.wait_for(wfid)
-    #@engine.wait_for(wfid) if r['action'] == 'ceased'
-    #  # make sure to wait for 'terminated'
-    @engine.wait_for(:inactive)
-
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
-
-    purge_engine
-  end
-
-  def noisy(on = true)
-
-    @engine.context.logger.noisy = on
-  end
-end
-

data/spec/support/ruote_matchers.rb

@@ -1,51 +0,0 @@
-
-RSpec::Matchers.define :have_errors do |*args|
-
-  match do |engine|
-
-    @ps = if wfid = args.shift
-      engine.processes(wfid)
-    else
-      engine.processes.first
-    end
-
-    @ps ? (@ps.errors.size != 0) : false
-  end
-
-  failure_message_for_should do |engine|
-
-    "Expected engine to have errors, but didn't"
-  end
-
-  failure_message_for_should_not do |engine|
-
-    "Expected the engine to not have errors, but it did.\n" +
-    @ps.errors.map { |e| "  * error: #{e.message}\n\"#{e.trace}\"" }.join("\n")
-  end
-
-  description do
-  end
-end
-
-RSpec::Matchers.define :have_remaining_expressions do
-
-  match do |engine|
-
-    (engine.storage.get_many('expressions').size != 0)
-  end
-
-  failure_message_for_should do |engine|
-
-    "Expected engine to have processes remaining, but it didn't"
-  end
-
-  failure_message_for_should_not do |engine|
-
-    "Expected engine to have no processes remaining, but it did." +
-    "#{engine.storage.get_many('expressions').inspect}"
-  end
-
-  description do
-  end
-end
-

data/spec/workitem_listener_spec.rb

@@ -1,66 +0,0 @@
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-#
-# NOTE : RuoteAMQP::WorkitemListener has been depreacted in favour of
-#        RuoteAMQP::Receiver
-#
-
-
-describe RuoteAMQP::WorkitemListener do
-
-  after(:each) do
-    purge_engine
-  end
-
-  it "handles replies" do
-
-    pdef = Ruote.process_definition :name => 'test' do
-      set :field => 'foo', :value => 'foo'
-      sequence do
-        echo '${f:foo}'
-        amqp :queue => 'test7'
-        echo '${f:foo}'
-      end
-    end
-
-    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
-
-    RuoteAMQP::WorkitemListener.new(@engine, :unsubscribe => true)
-
-    #@engine.noisy = true
-
-    wfid = @engine.launch(pdef)
-
-    workitem = nil
-
-    begin
-      Timeout::timeout(5) do
-
-        MQ.queue('test7', :durable => true).subscribe { |msg|
-          wi = Ruote::Workitem.new(Rufus::Json.decode(msg))
-          workitem = wi if wi.wfid == wfid
-        }
-
-        loop do
-          break unless workitem.nil?
-          sleep 0.1
-        end
-      end
-    rescue Timeout::Error
-      violated "Timeout waiting for message"
-    end
-
-    workitem.fields['foo'] = 'bar'
-
-    MQ.queue('ruote_workitems', :durable => true).publish(Rufus::Json.encode(workitem.to_h), :persistent => true)
-
-    @engine.wait_for(wfid)
-
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
-
-    @tracer.to_s.should == "foo\nbar"
-  end
-end
-