foreign_actor 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+.bundle
+Gemfile.lock
+coverage/
+doc/
+tests/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'celluloid', git: 'git://github.com/celluloid/celluloid.git'
+
+group(:test) do
+  gem 'eetee',          '=  0.0.1'
+  gem 'mocha',          '~> 0.12.0'
+  gem 'factory_girl'
+  
+  gem 'simplecov'
+  gem 'guard',          '~> 1.5.4'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+
+# parameters:
+#  output     => the formatted to use
+#  backtrace  => number of lines, nil =  everything
+guard 'bacon', :output => "BetterOutput", :backtrace => nil do
+  watch(%r{^lib/foreign_actor/(.+)\.rb$})     { |m| "specs/unit/#{m[1]}_spec.rb" }
+  watch(%r{specs/.+\.rb$})
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Julien Ammous
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# What is this ?
+
+I wanted to combine two great libraries for concurrent work: Crossroads (zeromq fork) and Celluloid.
+Foreign Actor is my attempt at building a simple way to distribute celluloid actors
+in multiple processes/machines, the idea is to be able to move an actor to another process with no change to the actor itself and minimal changes on the server and client side code.
+
+
+# How ?
+I used the Crossroads library (zeromq fork) to achieve my goal using XREQ/XREP sockets, this allows multiple clients with multiple workers, each clients being able to make calls with
+or without a return value.
+
+Here is what it looks like:
+![](docs/design.png "Architecture")
+
+In this picture the square boxes are processes while the rounded box are the services (actors).
+In a standard client/server interaction one client connects to one or more server and to do so
+needs to know the addresses of all of them, in my case the device process is here to simplify this: both clients and workers connects to it which allows as a direct result things like adding
+a worker in live, you just start it, it connects to the device and it can starts to process requests immediately.
+Something to note is that each of these processes can run on a different physical machine
+allowing effectively to distribute jobs on multiple cores as well as multiple machines.
+
+
+# Constraints
+Since the arguments to the actions are serialized using MessagePack they need to be serializable by it, which means that you can only send basic types to a foreign actor but messagepack allows everything you need really:
+- Integers
+- Floats (ex: 2.34)
+- Strings (ex: "a cat")
+- Hash
+- Boolean
+- Nil
+- Array (ex: [1, "a cat", {"a" : nil}])
+
+Why not going with Marshal ? Because I don't want to close the door to another language, you
+can well imagine calling a service which is in fact provided bya C server, a python server or
+anything else, I just see no reason to close that door.
+
+
+# Examples
+You can look at the example and example2 folder.
+
+
+# TODO
+- handle workers crash better, the client should be informed instead of waiting for a timeout.
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  
+  # do not generate coverage report under travis
+  # unless ENV['TRAVIS']
+    
+  #   require 'simplecov'
+  #   SimpleCov.command_name "E.T."
+  #   SimpleCov.start do
+  #     add_filter ".*_spec"
+  #     add_filter "/helpers/"
+  #   end
+  # end
+  
+  require 'eetee'
+  
+  runner = EEtee::Runner.new
+  runner.run_pattern('specs/**/*_spec.rb')
+  runner.report_results()
+  
+end
+

data/bin/device

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require 'ffi-rxs'
+require 'yaml'
+
+context = XS::Context.new
+poller = XS::Poller.new
+
+path = nil
+
+if ARGV.size == 0
+  path = 'device.yml'
+elsif ARGV
+  path = ARGV[0]
+end
+
+unless path && File.exists?(path)
+  puts "Usage: #{File.basename($0)} <config_path>"
+  exit(1)
+end
+
+puts "Using #{path}"
+
+conf = YAML.load_file(path)
+endpoints = []
+
+Pipe = Struct.new(:front, :back) do
+  
+end
+
+conf.each do |name, paths|
+  frontend = context.socket(XS::XREP)
+  backend = context.socket(XS::XREQ)
+
+  frontend.bind(paths['front'])
+  backend.bind(paths['back'])
+
+  poller.register_readable(frontend)
+  poller.register_readable(backend)
+
+  
+  endpoints << Pipe.new(frontend, backend)
+end
+
+
+trap('INT'){ exit }
+trap('TERM'){ exit }
+
+loop do
+  poller.poll()
+  poller.readables.each do |socket|
+    endpoints.each do |p|
+      if socket === p.front
+        loop do
+          socket.recv_string(message = "")
+          more = socket.more_parts?
+          p.back.send_string(message, more ? XS::SNDMORE : 0)
+          break unless more
+        end
+        next
+        
+      elsif socket === p.back
+        loop do
+          socket.recv_string(message = "")
+          more = socket.more_parts?
+          p.front.send_string(message, more ? XS::SNDMORE : 0)
+          break unless more
+        end
+        next
+      end
+    end
+    
+  end
+end
+

data/bin/puppetmaster.rb

@@ -0,0 +1,100 @@
+
+require 'ffi-rxs'
+
+class PuppetMaster
+  def initialize(workers_endpoint, client_endpoint)
+    @context = XS::Context.new
+    @source_id = nil
+    
+    @workers_socket = @context.socket(XS::XREQ)
+    @clients_socket = @context.socket(XS::XREP)
+    
+    @workers_socket.bind(workers_endpoint)
+    @clients_socket.bind(client_endpoint)
+    
+    @control_socket_srv = @context.socket(XS::PAIR)
+    @control_socket_cl = @context.socket(XS::PAIR)
+    
+    addr = "inproc://ctrl"
+    @control_socket_srv.bind(addr)
+    @control_socket_cl.connect(addr)
+  end
+  
+  
+  def start()
+    trap('INT'){ @control_socket_cl.send_string('') }
+    trap('TERM'){ @control_socket_cl.send_string('') }
+    
+    poller = XS::Poller.new
+    poller.register_readable(@workers_socket)
+    poller.register_readable(@clients_socket)
+    # control socket
+    poller.register_readable(@control_socket_srv)
+    
+    exit = false
+    
+    while exit == false
+      poller.poll
+      poller.readables.each do |s|
+        if s == @control_socket_srv
+          puts "Exiting..."
+          exit = true
+        else
+          redirect_data(s)
+        end
+      end
+    end
+    
+  end
+  
+  
+  def redirect_data(from)
+    # read whole message
+    msg = receive_msg(from)
+    if msg
+      # store the source_id
+      if from == @clients_socket
+        @source_id = msg.shift
+        
+        # send to the other side
+        handle_xs_err(@workers_socket, :send_string, msg[0], XS::DONTWAIT)
+        
+      else
+        handle_xs_err(@clients_socket, :send_string, @source_id, XS::DONTWAIT | XS::SNDMORE)
+        handle_xs_err(@clients_socket, :send_string, msg[0], XS::DONTWAIT)
+        
+      end
+    end
+    
+  end
+  
+private
+  def receive_msg(s)
+    parts = []
+    loop do
+      data = ""
+      if s.recv_string(data, XS::DONTWAIT) == -1
+        raise "error while reading socket: #{}"
+      end
+      parts << data
+      break unless s.more_parts?
+    end
+    
+    parts
+    
+  rescue
+    nil
+  end
+  
+  def handle_xs_err(s, method, *args)
+    rc = s.send(method, *args)
+    unless XS::Util.resultcode_ok?(rc)
+      raise "error: #{method}: #{XS::Util.error_string}"
+    end
+  end
+  
+end
+
+puts "Started."
+PuppetMaster.new('tcp://127.0.0.1:7001', 'tcp://127.0.0.1:7000').start
+

data/docs/design.graphml

@@ -0,0 +1,221 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
+  <!--Created by yFiles for Java 2.8-->
+  <key for="graphml" id="d0" yfiles.type="resources"/>
+  <key for="port" id="d1" yfiles.type="portgraphics"/>
+  <key for="port" id="d2" yfiles.type="portgeometry"/>
+  <key for="port" id="d3" yfiles.type="portuserdata"/>
+  <key attr.name="url" attr.type="string" for="node" id="d4"/>
+  <key attr.name="description" attr.type="string" for="node" id="d5"/>
+  <key for="node" id="d6" yfiles.type="nodegraphics"/>
+  <key attr.name="Description" attr.type="string" for="graph" id="d7"/>
+  <key attr.name="url" attr.type="string" for="edge" id="d8"/>
+  <key attr.name="description" attr.type="string" for="edge" id="d9"/>
+  <key for="edge" id="d10" yfiles.type="edgegraphics"/>
+  <graph edgedefault="directed" id="G">
+    <data key="d7"/>
+    <node id="n0">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="26.0" width="92.0" x="590.0" y="489.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="1.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="21.853515625" x="35.0732421875" y="3.93359375">W1</y:NodeLabel>
+          <y:Shape type="roundrectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n1">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="120.0" width="122.0" x="579.0" y="477.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="sides" modelPosition="s" textColor="#000000" visible="true" width="45.15625" x="38.421875" y="124.0">Worker</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n2">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="41.0" width="109.0" x="495.0" y="390.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="42.185546875" x="33.4072265625" y="11.43359375">Device</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n3">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="60.0" width="74.0" x="327.0" y="240.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="37.861328125" x="18.0693359375" y="20.93359375">Client</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n4">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="60.0" width="74.0" x="452.0" y="240.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="37.861328125" x="18.0693359375" y="20.93359375">Client</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n5">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="60.0" width="74.0" x="577.0" y="240.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="37.861328125" x="18.0693359375" y="20.93359375">Client</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n6">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="60.0" width="74.0" x="702.0" y="240.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="37.861328125" x="18.0693359375" y="20.93359375">Client</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n7">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="26.0" width="92.0" x="416.0" y="529.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="1.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="21.853515625" x="35.0732421875" y="3.93359375">W2</y:NodeLabel>
+          <y:Shape type="roundrectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n8">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="26.0" width="92.0" x="416.0" y="489.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="1.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="internal" modelPosition="c" textColor="#000000" visible="true" width="21.853515625" x="35.0732421875" y="3.93359375">W1</y:NodeLabel>
+          <y:Shape type="roundrectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="n9">
+      <data key="d5"/>
+      <data key="d6">
+        <y:ShapeNode>
+          <y:Geometry height="120.0" width="122.0" x="405.0" y="477.0"/>
+          <y:Fill hasColor="false" transparent="false"/>
+          <y:BorderStyle color="#000000" type="line" width="2.0"/>
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="sides" modelPosition="s" textColor="#000000" visible="true" width="45.15625" x="38.421875" y="124.0">Worker</y:NodeLabel>
+          <y:Shape type="rectangle"/>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge id="e0" source="n0" target="n1">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="none" target="standard"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e1" source="n8" target="n9">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="none" target="standard"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e2" source="n3" target="n2">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e3" source="n4" target="n2">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e4" source="n5" target="n2">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e5" source="n6" target="n2">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e6" source="n2" target="n9">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+    <edge id="e7" source="n2" target="n1">
+      <data key="d10">
+        <y:PolyLineEdge>
+          <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/>
+          <y:LineStyle color="#000000" type="line" width="1.0"/>
+          <y:Arrows source="delta" target="delta"/>
+          <y:BendStyle smoothed="false"/>
+        </y:PolyLineEdge>
+      </data>
+    </edge>
+  </graph>
+  <data key="d0">
+    <y:Resources/>
+  </data>
+</graphml>