rswim 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9a936a878b5bdbfd6503ac3693577d73a894d77d6d25a9b5794354595cb4b3b
-  data.tar.gz: 806de89b6fb5e6fdb4af90ba60d71c0af839a41a34dbfcd8f5ae40155a25856d
+  metadata.gz: 2cdad1327bf5ba2e7fd3a2d975b7f0ad507d99952b9c2b2d01269f4f3b813f25
+  data.tar.gz: 2050c00ddb9eec045103645d269683ad0454d664d92026f6849f80428e1483ff
 SHA512:
-  metadata.gz: 439d9eac5fa4ce3d610190ae6f7d1e39fdebad50a699b37678d28d2c3f2c2d51917e9feedbea03f39ccd2e47f70a703fff36a2be425d79b211881025168fd8dc
-  data.tar.gz: 6736caa12593b49b06956580f1698ac009a8202d3f71a6473e9b68b35eb8cf7dee5071266f7fe19cd07396405509c4836a33257c1ec65984de02838605165bfa
+  metadata.gz: 17a26dc6da80bc10db656b7127f2e72c7bb77d962eec38fc63830aa5b5d4642c8e3650fb8c4d2b860efac2e1eaa12c590c98f31dc1e4092adec31018c8b558bf
+  data.tar.gz: 9563514c494f896b54098b80b1636a20323a84d07b5f9b689577e592592edc6ae480449fcf7020ae1ad79b72084a7d087967983f9b2229a712de9d4712e95d8e

data/CHANGELOG.md

@@ -1,2 +1,3 @@
 # 1.0.0 Complete implementation for UDP plus simple, human readable serialisation of messages
 # 2.0.0 Piggyback custom state on the liveness propagation mechanism using `RSwim::Node#append_custom_state`
+# 2.1.0 Use non-blocking I/O by means of `Fiber.shedule` with the scheduler provided by the Async gem

data/Gemfile.lock

@@ -1,17 +1,25 @@
 PATH
   remote: .
   specs:
-    rswim (2.0.0)
+    rswim (2.1.0)
+      async (~> 1.30)
       slop (~> 4.9)
       zeitwerk (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    async (1.30.1)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
     byebug (11.1.3)
     coderay (1.1.3)
+    console (1.13.1)
+      fiber-local
     diff-lcs (1.4.4)
     ffi (1.15.4)
+    fiber-local (1.0.0)
     formatador (0.3.0)
     fuubar (2.5.1)
       rspec-core (~> 3.0)
@@ -36,6 +44,7 @@ GEM
     lumberjack (1.2.8)
     method_source (1.0.0)
     nenv (0.3.0)
+    nio4r (2.5.8)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -63,6 +72,7 @@ GEM
     shellany (0.0.1)
     slop (4.9.1)
     thor (1.1.0)
+    timers (4.3.3)
     zeitwerk (2.4.2)
 
 PLATFORMS

data/bin/async_loop

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby --jit
+require 'bundler/setup'
+require 'async'
+require 'rswim'
+
+PORT = 4545
+
+@stuff = []
+
+def read
+  if @stuff.empty?
+    sleep 2
+  end
+  Array.new(@stuff.size) { @stuff.pop }
+end 
+
+puts "Ready\n"
+begin
+  # Run node (blocking)
+  Async do
+    Fiber.schedule do
+      in_s = UDPSocket.new
+      my_host = "localhost" # Socket.ip_address_list.find(&:ipv4_private?).ip_address
+      
+      in_s.bind(my_host, PORT)
+      loop do
+        text, sender = in_s.recvfrom(10_000)
+        puts "received #{text} from network"
+        @stuff << text
+      end
+    end
+    loop { puts "Read: #{read }" }
+  end
+rescue Interrupt
+  puts "\nShutting down gracefully"
+end
+puts "\nDone"

data/lib/rswim/agent.rb

@@ -2,7 +2,48 @@
 
 module RSwim
   module Agent
-    class Base
+    # Non-blocking agent that is explicitly advanced
+    class PushBased
+      def initialize(node_member_id, seed_member_ids, t_ms, r_ms)
+        @state = new_protocol_state(node_member_id, seed_member_ids, t_ms, r_ms)
+      end
+
+      def subscribe(&block)
+        @state.subscribe(&block)
+      end
+
+      def append_custom_state(key, value)
+        @state.append_custom_state(key, value)
+      end
+
+      def run
+        @t0 = monotonic_seconds
+      end
+
+      def advance(messages)
+        raise 'not running' if @t0.nil?
+
+        t1 = monotonic_seconds
+        elapsed_seconds = t1 - @t0
+        @t0 = t1
+        @state.advance(messages, elapsed_seconds)
+      end
+
+      protected
+
+      def new_protocol_state(node_member_id, seed_member_ids, t_ms, r_ms)
+        ProtocolState.new(node_member_id, seed_member_ids, t_ms, r_ms)
+      end
+
+      private
+
+      def monotonic_seconds
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+
+    # Blocking agent that pops messages from pipe, processes them and pauses before repeating
+    class PullBased
       def initialize(pipe, node_member_id, seed_member_ids, t_ms, r_ms)
         @pipe = pipe
         @state = new_protocol_state(node_member_id, seed_member_ids, t_ms, r_ms)
@@ -39,7 +80,7 @@ module RSwim
       end
     end
 
-    class SleepBased < Base
+    class SleepBased < PullBased
       def initialize(pipe, node_member_id, seed_member_ids, t_ms, r_ms, sleep_time_seconds = 0.1)
         super(pipe, node_member_id, seed_member_ids, t_ms, r_ms)
         @sleep_time_seconds = sleep_time_seconds
@@ -55,7 +96,7 @@ module RSwim
       end
     end
 
-    class FiberBased < Base
+    class FiberBased < PullBased
       def run
         @f = Fiber.new { super }
       end

data/lib/rswim/integration/udp/io_loop.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RSwim
+  module Integration
+    module UDP
+      class Sender
+        def initialize(port, out_q)
+          @out_q = out_q
+          @port = port
+          @out_s = UDPSocket.new
+        end
+
+        def run
+          Async do
+            loop do
+              wire_messages = @out_q.pop
+              wire_messages.each do |(host, wire_message)|
+                logger.debug "about to send message to #{host} on port #{@port}"
+                Fiber.schedule do
+                  @out_s.send(wire_message, 0, host, @port)
+                rescue StandardError => e
+                  logger.debug("Error while sending: #{e}")
+                end
+              end
+            end
+          end
+        end
+
+        private
+
+        def logger
+          @_logger ||= RSwim::Logger.new(self.class, $stderr)
+        end
+      end
+
+      class IOLoop < RSwim::IOLoop
+        def initialize(agent, serializer, deserializer, directory, sleep_time_seconds, my_host, port)
+          super(agent, serializer, deserializer, directory, sleep_time_seconds)
+          @my_host = my_host
+          @port = port
+        end
+
+        protected
+
+        def before_run
+          @in_s = UDPSocket.new
+          @in_s.bind(@my_host, @port)
+          @out_q = Queue.new
+          Thread.new { Sender.new(@port, @out_q).run }.abort_on_exception = true
+        end
+
+        def read
+          text, sender = @in_s.recvfrom(10_000)
+          [sender[3], text]
+        rescue StandardError => e
+          logger.debug("Error while receiving: #{e}")
+        end
+
+        def send(wire_messages)
+          @out_q << wire_messages
+        rescue StandardError => e
+          logger.debug("Error while sending: #{e}")
+        end
+      end
+    end
+  end
+end

data/lib/rswim/integration/udp/node.rb

@@ -1,56 +1,21 @@
 # frozen_string_literal: true
 
-require 'socket'
-
 module RSwim
   module Integration
-    module Udp
+    module UDP
       # Node implementation that sends and listens using UDP
       class Node < RSwim::Node
         def initialize(my_host, seed_hosts, port, t_ms, r_ms)
+          @port = port
           my_host ||= Socket.ip_address_list.find(&:ipv4_private?).ip_address
           super(my_host, seed_hosts, t_ms, r_ms)
-          @port = port
         end
 
         protected
 
-        def before_start
-          @in_s = UDPSocket.new
-          @out_s = UDPSocket.new
-          @in_s.bind(@my_host, @port)
-          logger.info "node listening on UDP port #{@port}"
-          Thread.new { receive }.abort_on_exception = true
-          Thread.new { send }.abort_on_exception = true
-        end
-
-        private
-
-        def send
-          loop do
-            message = @pipe.q_out.pop
-            wire_message = @serializer.serialize(message)
-            host = @directory.host(message.to)
-            logger.debug "about to send message to #{host}"
-            @out_s.send(wire_message, 0, host, @port)
-          rescue StandardError => e
-            logger.debug("Error while sending: #{e}")
-          end
-          logger.info 'node no longer receiving'
-        end
-
-        def receive
-          loop do
-            logger.debug 'about to recieve message'
-            text, sender = @in_s.recvfrom(10_000)
-
-            message = @deserializer.deserialize(sender[3], text)
-            logger.debug "received #{message}"
-            @pipe.q_in << message
-          rescue StandardError => e
-            logger.debug("Error while receiving: #{e}")
-          end
-          logger.info 'node no longer receiving'
+        def create_io_loop
+          raise 'bad setup' if @port.nil?
+          IOLoop.new(@agent, @serializer, @deserializer, @directory, @sleep_time_seconds, @my_host, @port)
         end
       end
     end

data/lib/rswim/io_loop.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RSwim
+  class IOLoop
+    def initialize(agent, serializer, deserializer, directory, sleep_time_seconds)
+      @agent = agent
+      @serializer = serializer
+      @deserializer = deserializer
+      @directory = directory
+      @sleep_time_seconds = sleep_time_seconds
+      @read_buffer = []
+    end
+
+    def run
+      before_run
+      Async do
+        start_producer
+        loop do
+          in_messages = consume_read_buffer
+          logger.debug "advancing agent with #{in_messages.size} messages"
+          out_messages = @agent.advance(in_messages)
+          wire_messages = out_messages.map do |message|
+            wire_message = @serializer.serialize(message)
+            host = @directory.host(message.to)
+            [host, wire_message]
+          end
+          logger.debug "sending #{wire_messages.size} messages from agent to other hosts"
+          send(wire_messages)
+        rescue StandardError => e
+          logger.debug("Error in I/O loop: #{e}")
+        end
+        logger.info 'node no longer receiving'
+      end
+    end
+
+    protected
+
+    def before_run; end
+
+    def read
+      raise 'implemented in subclass'
+    end
+
+    def send(_wire_messages)
+      raise 'implemented in subclass'
+    end
+
+    def logger
+      @_logger ||= RSwim::Logger.new(self.class, $stderr)
+    end
+
+    private
+
+    def start_producer
+      Fiber.schedule do
+        loop do
+          logger.debug 'about to recieve message'
+          sender_host, wire_message = read
+          continue if wire_message.nil?
+          logger.debug "Read #{wire_message} from host #{sender_host}"
+          message = @deserializer.deserialize(sender_host, wire_message)
+          unless message.nil?
+            logger.debug "Wire message deserialized to #{message}"
+            @read_buffer << message
+          end
+        end
+      end
+    end
+
+    def consume_read_buffer
+      if @read_buffer.empty?
+        logger.debug "sleeping for #{@sleep_time_seconds} seconds while waiting for buffered messages"
+        sleep @sleep_time_seconds
+      end
+      Array.new(@read_buffer.size) { @read_buffer.pop }
+    end
+  end
+end

data/lib/rswim/node.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
-require 'socket'
-
 module RSwim
   class Node
+    def self.udp(my_host, seed_hosts, port, t_ms = T_MS, r_ms = R_MS)
+      Integration::UDP::Node.new(my_host, seed_hosts, port, t_ms, r_ms)
+    end
+
     def initialize(my_host, seed_hosts, t_ms, r_ms)
       @my_host = my_host
       @directory = Directory.new
       @my_id = @directory.id(@my_host)
       @deserializer = Integration::Deserializer.new(@directory, @my_id)
       @serializer = Integration::Serializer.new(@directory)
-      @pipe = RSwim::Pipe.simple
-      seed_ids = seed_hosts.map { |host| @directory.id(host) }
-      @agent = RSwim::Agent::SleepBased.new(@pipe, @my_id, seed_ids, t_ms, r_ms)
-    end
-
-    def self.udp(my_host, seed_hosts, port, t_ms = T_MS, r_ms = R_MS)
-      Integration::Udp::Node.new(my_host, seed_hosts, port, t_ms, r_ms)
+      @seed_ids = seed_hosts.map { |host| @directory.id(host) }
+      @t_ms = t_ms
+      @r_ms = r_ms
+      @agent = RSwim::Agent::PushBased.new(@my_id, @seed_ids, t_ms, r_ms)
+      @sleep_time_seconds = r_ms / 1_000
+      @io_loop = create_io_loop
     end
 
     def subscribe(&block)
@@ -30,18 +31,17 @@ module RSwim
       @agent.append_custom_state(key, value)
     end
 
-    # blocks until interrupted
     def start
       logger.info 'starting node'
-      before_start
       @agent.run
+      @io_loop.run
     rescue StandardError => e
       logger.error("Node failed: #{e}")
     end
 
     protected
 
-    def before_start
+    def create_io_loop
       raise 'must be implemented in subclass'
     end
 

data/lib/rswim/pipe.rb

@@ -24,8 +24,7 @@ module RSwim
       attr_reader :q_in, :q_out
 
       def initialize
-        @q_in, @q_out = 2.times.map { Queue.new }
-        super(@q_in, @q_out)
+        super(Queue.new, Queue.new)
       end
     end
   end

data/lib/rswim/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSwim
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/rswim.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'socket'
 require 'zeitwerk'
-require 'byebug'
+require 'async'
 
 # frozen_string_literal: true
 
@@ -10,6 +11,8 @@ class MyInflector < Zeitwerk::Inflector
   def camelize(basename, _abspath)
     case basename
     when 'rswim' then 'RSwim'
+    when 'udp' then 'UDP'
+    when 'io_loop' then 'IOLoop'
     else super
     end
   end
@@ -29,5 +32,4 @@ module RSwim
   R_MS = 10_000
 
   class Error < StandardError; end
-  # Your code goes here...
 end

data/rswim.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency 'zeitwerk', '~> 2.2'
   spec.add_dependency 'slop', '~> 4.9'
-
+  spec.add_dependency 'async', '~> 1.30'
+  
   spec.add_development_dependency "bundler", ">= 2.2.10"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswim
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Erik Madsen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.9'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/async_loop
 - bin/console
 - bin/run_node
 - bin/setup
@@ -150,7 +165,9 @@ files:
 - lib/rswim/directory.rb
 - lib/rswim/integration/deserializer.rb
 - lib/rswim/integration/serializer.rb
+- lib/rswim/integration/udp/io_loop.rb
 - lib/rswim/integration/udp/node.rb
+- lib/rswim/io_loop.rb
 - lib/rswim/logger.rb
 - lib/rswim/member/ack_responder.rb
 - lib/rswim/member/base.rb