nanite 0.4.1.2

data/lib/nanite/mapper_proxy.rb

@@ -0,0 +1,67 @@
+module Nanite
+
+  # This class allows sending requests to nanite agents without having
+  # to run a local mapper.
+  # It is used by Actor.request which can be used by actors than need
+  # to send requests to remote agents.
+  # All requests go through the mapper for security purposes.
+  class MapperProxy
+        
+    $:.push File.dirname(__FILE__)
+    require 'amqp'
+  
+    include AMQPHelper
+    
+    attr_accessor :pending_requests, :identity, :options, :amqp, :serializer
+
+    # Accessor for actor
+    def self.instance
+      @@instance if defined?(@@instance)
+    end
+
+    def initialize(id, opts)
+      @options = opts || {}
+      @identity = id
+      @pending_requests = {}
+      @amqp = start_amqp(options)
+      @serializer = Serializer.new(options[:format])
+      @@instance = self
+    end
+
+    # Send request to given agent through the mapper
+    def request(type, payload = '', opts = {}, &blk)
+      raise "Mapper proxy not initialized" unless identity && options
+      request = Request.new(type, payload, nil, opts)
+      request.from = identity
+      request.token = Identity.generate
+      request.persistent = opts.key?(:persistent) ? opts[:persistent] : options[:persistent]
+      pending_requests[request.token] = 
+        { :intermediate_handler => opts[:intermediate_handler], :result_handler => blk }
+      Nanite::Log.info("SEND #{request.to_s([:tags, :target])}")
+      amqp.fanout('request', :no_declare => options[:secure]).publish(serializer.dump(request))
+    end    
+
+    def push(type, payload = '', opts = {})
+      raise "Mapper proxy not initialized" unless identity && options
+      push = Push.new(type, payload, nil, opts)
+      push.from = identity
+      push.token = Identity.generate
+      push.persistent = opts.key?(:persistent) ? opts[:persistent] : options[:persistent]
+      Nanite::Log.info("SEND #{push.to_s([:tags, :target])}")
+      amqp.fanout('request', :no_declare => options[:secure]).publish(serializer.dump(push))
+    end    
+    
+    # Handle intermediary result
+    def handle_intermediate_result(res)
+      handlers = pending_requests[res.token]
+      handlers[:intermediate_handler].call(res) if handlers && handlers[:intermediate_handler]
+    end
+    
+    # Handle final result
+    def handle_result(res)
+      handlers = pending_requests.delete(res.token)
+      handlers[:result_handler].call(res) if handlers && handlers[:result_handler]
+    end
+
+  end
+end

data/lib/nanite/nanite_dispatcher.rb

@@ -0,0 +1,92 @@
+module Nanite
+  class Dispatcher
+    attr_reader :registry, :serializer, :identity, :amq, :options
+    attr_accessor :evmclass
+
+    def initialize(amq, registry, serializer, identity, options)
+      @amq = amq
+      @registry = registry
+      @serializer = serializer
+      @identity = identity
+      @options = options
+      @evmclass = EM
+      @evmclass.threadpool_size = (@options[:threadpool_size] || 20).to_i
+    end
+
+    def dispatch(deliverable)
+      prefix, meth = deliverable.type.split('/')[1..-1]
+      meth ||= :index
+      actor = registry.actor_for(prefix)
+
+      operation = lambda do
+        begin
+          intermediate_results_proc = lambda { |*args| self.handle_intermediate_results(actor, meth, deliverable, *args) }
+          args = [ deliverable.payload ]
+          args.push(deliverable) if actor.method(meth).arity == 2
+          actor.send(meth, *args, &intermediate_results_proc)
+        rescue Exception => e
+          handle_exception(actor, meth, deliverable, e)
+        end
+      end
+      
+      callback = lambda do |r|
+        if deliverable.kind_of?(Request)
+          r = Result.new(deliverable.token, deliverable.reply_to, r, identity)
+          Nanite::Log.info("SEND #{r.to_s([])}")
+          amq.queue(deliverable.reply_to, :no_declare => options[:secure]).publish(serializer.dump(r))
+        end
+        r # For unit tests
+      end
+
+      if @options[:single_threaded] || @options[:thread_poolsize] == 1
+        @evmclass.next_tick { callback.call(operation.call) }
+      else
+        @evmclass.defer(operation, callback)
+      end
+    end
+
+    protected
+
+    def handle_intermediate_results(actor, meth, deliverable, *args)
+      messagekey = case args.size
+      when 1
+        'defaultkey'
+      when 2
+        args.first.to_s
+      else
+        raise ArgumentError, "handle_intermediate_results passed unexpected number of arguments (#{args.size})"
+      end
+      message = args.last
+      @evmclass.defer(lambda {
+        [deliverable.reply_to, IntermediateMessage.new(deliverable.token, deliverable.reply_to, identity, messagekey, message)]
+      }, lambda { |r|
+        amq.queue(r.first, :no_declare => options[:secure]).publish(serializer.dump(r.last))
+      })
+    end
+
+    private
+
+    def describe_error(e)
+      "#{e.class.name}: #{e.message}\n #{e.backtrace.join("\n  ")}"
+    end
+
+    def handle_exception(actor, meth, deliverable, e)
+      error = describe_error(e)
+      Nanite::Log.error(error)
+      begin
+        if actor.class.exception_callback
+          case actor.class.exception_callback
+          when Symbol, String
+            actor.send(actor.class.exception_callback, meth.to_sym, deliverable, e)
+          when Proc
+            actor.instance_exec(meth.to_sym, deliverable, e, &actor.class.exception_callback)
+          end
+        end
+      rescue Exception => e1
+        error = describe_error(e1)
+        Nanite::Log.error(error)
+      end
+      error
+    end
+  end
+end

data/lib/nanite/packets.rb

@@ -0,0 +1,365 @@
+module Nanite
+  # Base class for all Nanite packets,
+  # knows how to dump itself to JSON
+  class Packet
+
+    attr_accessor :size
+
+    def initialize
+      raise NotImplementedError.new("#{self.class.name} is an abstract class.")
+    end
+
+    def to_json(*a)
+      js = {
+        'json_class'   => self.class.name,
+        'data'         => instance_variables.inject({}) {|m,ivar| m[ivar.to_s.sub(/@/,'')] = instance_variable_get(ivar); m }
+      }.to_json(*a)
+      js = js.chop + ",\"size\":#{js.size}}"
+      js
+    end
+
+    # Log representation
+    def to_s(filter=nil)
+      res = "[#{ self.class.to_s.split('::').last.
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        downcase }]"
+      res += " (#{size.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")} bytes)" if size && !size.to_s.empty?
+      res
+    end
+
+    # Log friendly name for given agent id
+    def id_to_s(id)
+      case id
+        when /^mapper-/ then 'mapper'
+        when /^nanite-(.*)/ then Regexp.last_match(1)
+        else id
+      end
+    end
+
+  end
+
+  # packet that means start of a file transfer
+  # operation
+  class FileStart < Packet
+
+    attr_accessor :filename, :token, :dest
+
+    def initialize(filename, dest, token, size=nil)
+      @filename = filename
+      @dest = dest
+      @token = token
+      @size = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['filename'], i['dest'], i['token'], o['size'])
+    end
+
+    def to_s
+      "#{super} <#{token}> #{filename} to #{dest}"
+    end
+  end
+
+  # packet that means end of a file transfer
+  # operation
+  class FileEnd < Packet
+
+    attr_accessor :token, :meta
+
+    def initialize(token, meta, size=nil)
+      @token = token
+      @meta  = meta
+      @size = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['token'], i['meta'], o['size'])
+    end
+
+    def to_s
+      "#{super} <#{token}> meta #{meta}"
+    end
+  end
+
+  # packet that carries data chunks during a file transfer
+  class FileChunk < Packet
+
+    attr_accessor :chunk, :token
+
+    def initialize(token, size=nil, chunk=nil)
+      @chunk = chunk
+      @token = token
+      @size = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['token'], o['size'], i['chunk'])
+    end
+
+    def to_s
+      "#{super} <#{token}>"
+    end
+  end
+
+  # packet that means a work request from mapper
+  # to actor node
+  #
+  # type     is a service name
+  # payload  is arbitrary data that is transferred from mapper to actor
+  #
+  # Options:
+  # from     is sender identity
+  # token    is a generated request id that mapper uses to identify replies
+  # reply_to is identity of the node actor replies to, usually a mapper itself
+  # selector is the selector used to route the request
+  # target   is the target nanite for the request
+  # persistent signifies if this request should be saved to persistent storage by the AMQP broker
+  class Request < Packet
+
+    attr_accessor :from, :payload, :type, :token, :reply_to, :selector, :target, :persistent, :tags
+
+    DEFAULT_OPTIONS = {:selector => :least_loaded}
+
+    def initialize(type, payload, size=nil, opts={})
+      opts = DEFAULT_OPTIONS.merge(opts)
+      @type       = type
+      @payload    = payload
+      @size       = size
+      @from       = opts[:from]
+      @token      = opts[:token]
+      @reply_to   = opts[:reply_to]
+      @selector   = opts[:selector]
+      @target     = opts[:target]
+      @persistent = opts[:persistent]
+      @tags       = opts[:tags] || []
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['type'], i['payload'], o['size'], { :from     => i['from'],     :token      => i['token'],
+                                                :reply_to => i['reply_to'], :selector   => i['selector'],
+                                                :target   => i['target'],   :persistent => i['persistent'],
+                                                :tags     => i['tags'] })
+    end
+
+    def to_s(filter=nil)
+      log_msg = "#{super} <#{token}> #{type}"
+      log_msg += " from #{id_to_s(from)}" if filter.nil? || filter.include?(:from)
+      log_msg += " to #{id_to_s(target)}" if target && (filter.nil? || filter.include?(:target))
+      log_msg += ", reply_to #{id_to_s(reply_to)}" if reply_to && (filter.nil? || filter.include?(:reply_to))
+      log_msg += ", tags #{tags.inspect}" if tags && !tags.empty? && (filter.nil? || filter.include?(:tags))
+      log_msg += ", payload #{payload.inspect}" if filter.nil? || filter.include?(:payload)
+      log_msg
+    end
+
+  end
+
+  # packet that means a work push from mapper
+  # to actor node
+  #
+  # type     is a service name
+  # payload  is arbitrary data that is transferred from mapper to actor
+  #
+  # Options:
+  # from     is sender identity
+  # token    is a generated request id that mapper uses to identify replies
+  # selector is the selector used to route the request
+  # target   is the target nanite for the request
+  # persistent signifies if this request should be saved to persistent storage by the AMQP broker
+  class Push < Packet
+
+    attr_accessor :from, :payload, :type, :token, :selector, :target, :persistent, :tags
+
+    DEFAULT_OPTIONS = {:selector => :least_loaded}
+
+    def initialize(type, payload, size=nil, opts={})
+      opts = DEFAULT_OPTIONS.merge(opts)
+      @type       = type
+      @payload    = payload
+      @size       = size
+      @from       = opts[:from]
+      @token      = opts[:token]
+      @selector   = opts[:selector]
+      @target     = opts[:target]
+      @persistent = opts[:persistent]
+      @tags       = opts[:tags] || []
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['type'], i['payload'], o['size'], { :from       => i['from'],       :token  => i['token'],
+                                                :selector   => i['selector'],   :target => i['target'],
+                                                :persistent => i['persistent'], :tags   => i['tags'] })
+    end
+
+    def to_s(filter=nil)
+      log_msg = "#{super} <#{token}> #{type}"
+      log_msg += " from #{id_to_s(from)}" if filter.nil? || filter.include?(:from)
+      log_msg += ", target #{id_to_s(target)}" if target && (filter.nil? || filter.include?(:target))
+      log_msg += ", tags #{tags.inspect}" if tags && !tags.empty? && (filter.nil? || filter.include?(:tags))
+      log_msg += ", payload #{payload.inspect}" if filter.nil? || filter.include?(:payload)
+      log_msg
+    end
+  end
+
+  # packet that means a work result notification sent from actor to mapper
+  #
+  # from     is sender identity
+  # results  is arbitrary data that is transferred from actor, a result of actor's work
+  # token    is a generated request id that mapper uses to identify replies
+  # to       is identity of the node result should be delivered to
+  class Result < Packet
+
+    attr_accessor :token, :results, :to, :from
+
+    def initialize(token, to, results, from, size=nil)
+      @token = token
+      @to = to
+      @from = from
+      @results = results
+      @size = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['token'], i['to'], i['results'], i['from'], o['size'])
+    end
+
+    def to_s(filter=nil)
+      log_msg = "#{super} <#{token}>"
+      log_msg += " from #{id_to_s(from)}" if filter.nil? || filter.include?(:from)
+      log_msg += " to #{id_to_s(to)}" if filter.nil? || filter.include?(:to)
+      log_msg += " results: #{results.inspect}" if filter.nil? || filter.include?(:results)
+      log_msg
+    end
+  end
+
+  # packet that means an intermediate status notification sent from actor to mapper. is appended to a list of messages matching messagekey.
+  #
+  # from     is sender identity
+  # messagekey is a string that can become part of a redis key, which identifies the name under which the message is stored
+  # message  is arbitrary data that is transferred from actor, an intermediate result of actor's work
+  # token    is a generated request id that mapper uses to identify replies
+  # to       is identity of the node result should be delivered to
+  class IntermediateMessage < Packet
+
+    attr_accessor :token, :messagekey, :message, :to, :from
+
+    def initialize(token, to, from, messagekey, message, size=nil)
+      @token      = token
+      @to         = to
+      @from       = from
+      @messagekey = messagekey
+      @message    = message
+      @size       = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['token'], i['to'], i['from'], i['messagekey'], i['message'], o['size'])
+    end
+
+    def to_s
+      "#{super} <#{token}> from #{id_to_s(from)}, key #{messagekey}"
+    end
+  end
+
+  # packet that means an availability notification sent from actor to mapper
+  #
+  # from     is sender identity
+  # services is a list of services provided by the node
+  # status   is a load of the node by default, but may be any criteria
+  #          agent may use to report it's availability, load, etc
+  class Register < Packet
+
+    attr_accessor :identity, :services, :status, :tags
+
+    def initialize(identity, services, status, tags, size=nil)
+      @status   = status
+      @tags     = tags
+      @identity = identity
+      @services = services
+      @size     = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['identity'], i['services'], i['status'], i['tags'], o['size'])
+    end
+
+    def to_s
+      log_msg = "#{super} #{id_to_s(identity)}"
+      log_msg += ", services: #{services.join(', ')}" if services && !services.empty?
+      log_msg += ", tags: #{tags.join(', ')}" if tags && !tags.empty?
+      log_msg
+    end
+  end
+
+  # packet that means deregister an agent from the mappers
+  #
+  # from     is sender identity
+  class UnRegister < Packet
+
+    attr_accessor :identity
+
+    def initialize(identity, size=nil)
+      @identity = identity
+      @size = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['identity'], o['size'])
+    end
+  
+    def to_s
+      "#{super} #{id_to_s(identity)}"
+    end
+  end
+
+  # heartbeat packet
+  #
+  # identity is sender's identity
+  # status   is sender's status (see Register packet documentation)
+  class Ping < Packet
+
+    attr_accessor :identity, :status
+
+    def initialize(identity, status, size=nil)
+      @status   = status
+      @identity = identity
+      @size     = size
+    end
+
+    def self.json_create(o)
+      i = o['data']
+      new(i['identity'], i['status'], o['size'])
+    end
+
+    def to_s
+      "#{super} #{id_to_s(identity)} status #{status}"
+    end
+
+  end
+
+  # packet that is sent by workers to the mapper
+  # when worker initially comes online to advertise
+  # it's services
+  class Advertise < Packet
+
+    def initialize(size=nil)
+      @size = size
+    end
+    
+    def self.json_create(o)
+      new(o['size'])
+    end
+
+  end
+ 
+end
+