rswim 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 672b410f63b01447de5ba794f65d20f4da0fc0966381c39d3fa333cd21482717
-  data.tar.gz: 369e88eeaf54294cda7b98ad65c9ee6f8c79c00b8ba362e9e3d844fb6f450ada
+  metadata.gz: b9a936a878b5bdbfd6503ac3693577d73a894d77d6d25a9b5794354595cb4b3b
+  data.tar.gz: 806de89b6fb5e6fdb4af90ba60d71c0af839a41a34dbfcd8f5ae40155a25856d
 SHA512:
-  metadata.gz: 7236a1d7c5159b4113672f3eca7c931b9978ab54a353ea44198000e0894c4ef9266b9fcb2dcf6045476402057748682388200322a2b2eba3f9754c10c5091402
-  data.tar.gz: 48f657cd9ff5d89cb93d9c684d546e876dba5b02a16183b50c0794b37e779f989bf9869e39de5aa2c91539ed39fa2380af091c2cf754ac50bdd37628d1477e06
+  metadata.gz: 439d9eac5fa4ce3d610190ae6f7d1e39fdebad50a699b37678d28d2c3f2c2d51917e9feedbea03f39ccd2e47f70a703fff36a2be425d79b211881025168fd8dc
+  data.tar.gz: 6736caa12593b49b06956580f1698ac009a8202d3f71a6473e9b68b35eb8cf7dee5071266f7fe19cd07396405509c4836a33257c1ec65984de02838605165bfa

data/.gitignore

@@ -15,3 +15,4 @@
 # rspec failure tracking
 .rspec_status
 .byebug_history
+.DS_Store

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.2

data/CHANGELOG.md

@@ -1 +1,2 @@
 # 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`

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rswim (1.0.0)
+    rswim (2.0.0)
+      slop (~> 4.9)
       zeitwerk (~> 2.2)
 
 GEM
@@ -10,18 +11,18 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.13.1)
-    formatador (0.2.5)
-    fuubar (2.5.0)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    fuubar (2.5.1)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
-    guard (2.16.2)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -29,7 +30,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    listen (3.2.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -38,36 +39,37 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    ruby-progressbar (1.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
-    thor (1.0.1)
-    zeitwerk (2.4.0)
+    slop (4.9.1)
+    thor (1.1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (>= 2.2.10)
   byebug
   fuubar (~> 2.5)
   guard-rspec (~> 4.7)
@@ -76,4 +78,4 @@ DEPENDENCIES
   rswim!
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -4,7 +4,8 @@ RSwim is a Ruby implementation of the SWIM gossip protocol, a mechanism for disc
 
 It is an implementation inspired by the original [SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol](https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf) paper by Abhinandan Das, Indranil Gupta, Ashish Motivala.
 
-The implementation is kept intentionally simple and limited to the features described in the paper.
+The implementation is kept intentionally simple and limited to the features described in the paper, except for the addition in version 2.0.0 of the ability to piggyback custom state on the liveness propagation mechanism, see `RSwim::Node#append_custom_state`
+
 No attempts have been made to address known security issues such as Byzantine attacks.
 
 Currently RSwim runs on UDP with a custom, human readable serialization format.
@@ -27,6 +28,7 @@ Or install it yourself as:
     $ gem install rswim
 
 ## Usage
+To try out a small demo script, execute `bin/run_node --help` for more information.
 
 Example:
 ```ruby
@@ -43,9 +45,19 @@ Example:
   node = RSwim::Node.udp(nil, seed_hosts, port)
 
   # Subscribe to updates
-  node.subscribe do |host, status|
-    puts "Update: #{host} entered state #{status}"
+  node.subscribe do |host, status, custom_state|
+    puts "Update: #{host} entered liveness state #{status} with custom state #{custom_state}"
   end
+  
+  # Periodically append new state for publishing
+  Thread.new do
+    uptime = 0
+    loop do
+      sleep(5)
+      uptime += 5
+      node.append_custom_state(:uptime_seconds, uptime)
+    end
+  end.abort_on_exception = true
 
   puts "Ready\n"
   begin

data/bin/run_node

@@ -1,30 +1,59 @@
 #!/usr/bin/env ruby --jit
-require "bundler/setup"
+require 'bundler/setup'
+require 'slop'
 require 'rswim'
-puts "Ruby version: #{RUBY_VERSION}"
 
 PORT = 4545
 
-puts "Enter seed nodes"
-input = gets
-seed_hosts = input.split(" ")
+opts = Slop.parse do |o|
+  o.array '-s', '--seeds', 'a comma separated list of seed nodes'
+  o.bool '-d', '--debug', 'turn on debug logging'
+  o.on '--help' do
+    puts o
+    exit
+  end
+  o.on '-v', '--version' do
+    puts RSwim::VERSION
+    exit
+  end
+end
+
+puts "Ruby version: #{RUBY_VERSION}"
+
+RSwim::Logger.level = ::Logger::DEBUG if opts.debug?
+seed_hosts = opts[:seeds]
 abort 'EOF' if seed_hosts.nil?
-puts "Operating with no seed nodes" if seed_hosts.empty?
 
-puts "Starting node"
+if seed_hosts.empty?
+  puts 'Operating with no seed nodes'
+else
+  seed_hosts.each { |h| puts "Seed node: #{h}" }
+end
+
+puts 'Starting node'
 
 # Instantiate node, setting my_host to nil to auto detect host IP.
-node = RSwim::Node.udp(nil, seed_hosts, PORT)
+node = RSwim::Node.udp(nil, seed_hosts, PORT, 3_500, 1_000)
 
 # Subscribe to updates
-node.subscribe do |host, status|
-  puts "Update: #{host} entered state #{status}"
+node.subscribe do |host, status, custom_state|
+  puts "Update: #{host} entered liveness state #{status} with custom state #{custom_state}"
 end
 
+Thread.new do
+  uptime = 0
+  loop do
+    sleep(5)
+    uptime += 5
+    node.append_custom_state(:uptime_seconds, uptime)
+  end
+end.abort_on_exception = true
+
 puts "Ready\n"
 begin
   # Run node (blocking)
   node.start
 rescue Interrupt
+  puts "\nShutting down gracefully"
 end
 puts "\nDone"

data/lib/rswim/agent.rb

@@ -5,7 +5,7 @@ module RSwim
     class Base
       def initialize(pipe, node_member_id, seed_member_ids, t_ms, r_ms)
         @pipe = pipe
-        @state = ProtocolState.new(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)
@@ -20,8 +20,16 @@ module RSwim
         end
       end
 
+      def append_custom_state(key, value)
+        @state.append_custom_state(key, value)
+      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
+
       def pause
         raise 'implement this in a subclass'
       end
@@ -32,7 +40,7 @@ module RSwim
     end
 
     class SleepBased < Base
-      def initialize(pipe, node_member_id, seed_member_ids, sleep_time_seconds = 0.1, t_ms = T_MS, r_ms = R_MS)
+      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
       end

data/lib/rswim/integration/deserializer.rb

@@ -26,26 +26,32 @@ module RSwim
       protected
 
       def logger
-        @_logger ||= begin
-          RSwim::Logger.new(self.class, STDERR)
-        end
+        @_logger ||= RSwim::Logger.new(self.class, $stderr)
       end
 
       private
 
       def parse_updates(lines)
         lines.map do |l|
-          begin
-            # host status incarnation_number
-            host, status, incarnation_number = l.strip.split(' ')
-            id = @directory.id(host)
-            UpdateEntry.new(id, status.to_sym, incarnation_number.to_i)
-          rescue StandardError => e
-            logger.debug("Failed to parse line `#{l}`: #{e}")
-            nil
-          end
+          # host status incarnation_number
+          host, status, incarnation_number, *pairs = l.strip.split(' ')
+          id = @directory.id(host)
+          custom_state = parse_custom_state(pairs)
+
+          UpdateEntry.new(id, status.to_sym, incarnation_number.to_i, custom_state)
+        rescue StandardError => e
+          logger.debug("Failed to parse line `#{l}`: #{e}")
+          nil
         end.tap(&:compact!)
       end
+
+      def parse_custom_state(pairs)
+        pairs.each_slice(2).map do |(key, value)|
+          raise 'bad custom state' if !key.end_with?(':') || value.nil?
+
+          [key[0..-2].to_sym, value]
+        end.to_h
+      end
     end
   end
 end

data/lib/rswim/integration/serializer.rb

@@ -10,9 +10,11 @@ module RSwim
       def serialize(message)
         l1 = message.type.to_s.gsub(/_/, '-')
         l1 << " #{@directory.host(message.payload[:target_id])}" if message.type == :ping_req
+
         message.payload[:updates].to_a.each do |update|
           # host status incarnation_number
           l1 << "\n#{@directory.host(update.member_id)} #{update.status} #{update.incarnation_number}"
+          l1 << " #{serialize_custom_state(update.custom_state)}" unless update.custom_state.empty?
         end
         l1
       end
@@ -20,9 +22,13 @@ module RSwim
       protected
 
       def logger
-        @_logger ||= begin
-          RSwim::Logger.new(self.class, STDERR)
-        end
+        @_logger ||= RSwim::Logger.new(self.class, STDERR)
+      end
+
+      private
+
+      def serialize_custom_state(custom_state)
+        custom_state.map { |k, v| "#{k}: #{v}" }.join(' ')
       end
     end
   end

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

@@ -5,10 +5,11 @@ require 'socket'
 module RSwim
   module Integration
     module Udp
+      # Node implementation that sends and listens using UDP
       class Node < RSwim::Node
-        def initialize(my_host, seed_hosts, port)
-          my_host ||= Socket.ip_address_list.find { |x| x.ipv4_private? }.ip_address
-          super(my_host, seed_hosts)
+        def initialize(my_host, seed_hosts, port, t_ms, r_ms)
+          my_host ||= Socket.ip_address_list.find(&:ipv4_private?).ip_address
+          super(my_host, seed_hosts, t_ms, r_ms)
           @port = port
         end
 
@@ -19,39 +20,35 @@ module RSwim
           @out_s = UDPSocket.new
           @in_s.bind(@my_host, @port)
           logger.info "node listening on UDP port #{@port}"
-          Thread.new { receive }.tap { |t| t.abort_on_exception = true }
-          Thread.new { send }.tap { |t| t.abort_on_exception = true }
+          Thread.new { receive }.abort_on_exception = true
+          Thread.new { send }.abort_on_exception = true
         end
 
         private
 
         def send
           loop do
-            begin
-              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
+            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
-            begin
-              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.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'
         end

data/lib/rswim/member/base.rb

@@ -5,6 +5,7 @@ module RSwim
     class Base
       def initialize(id)
         @id = id
+        @incarnation_number = 0        
       end
     end
   end

data/lib/rswim/member/health_state/alive.rb

@@ -4,20 +4,32 @@ module RSwim
   module Member
     module HealthState
       class Alive < Base
-        def initialize(id, member_pool, update_entry = UpdateEntry.new(id, :alive, 0, 0))
+        def initialize(id, node_member_id, member_pool, must_propagate: false)
           super
           @failed_to_reply = false
         end
 
         def advance(_elapsed_seconds)
           if @failed_to_reply
-            ue = UpdateEntry.new(@id, :suspected, @update_entry.incarnation_number, -1)
-            Suspected.new(@id, @member_pool, ue, true)
+            Suspected.new(@id, @node_member_id, @member_pool, must_propagate: true, send_ping_request: true)
           else
             self
           end
         end
 
+        def update_suspicion(status, old_incarnation_number, gossip_incarnation_number)
+          case status
+          when :confirmed then Confirmed.new(@id, @node_member_id, @member_pool)
+          when :suspected
+            if gossip_incarnation_number >= old_incarnation_number
+              Suspected.new(@id, @node_member_id, @member_pool, send_ping_request: false)
+            else
+              self
+            end
+          when :alive then self
+          end
+        end
+
         def member_failed_to_reply
           @failed_to_reply = true
         end
@@ -25,6 +37,10 @@ module RSwim
         def can_be_pinged?
           true
         end
+
+        def status
+          :alive
+        end
       end
     end
   end

data/lib/rswim/member/health_state/base.rb

@@ -4,56 +4,26 @@ module RSwim
   module Member
     module HealthState
       class Base
-        attr_reader :update_entry
+        attr_reader :propagation_count
 
-        def initialize(id, member_pool, update_entry)
+        def initialize(id, node_member_id, member_pool, must_propagate:)
           @member_pool = member_pool
           @id = id
-          @update_entry = update_entry
+          @node_member_id = node_member_id
+          @propagation_count = must_propagate ? -2 : 0
           logger.debug("Member with id #{id} entered new state: #{self.class}")
         end
 
-        def advance(_elapsed_seconds)
-          self
+        def increment_propagation_count
+          @propagation_count += 1
         end
 
-        def update_suspicion(status, incarnation_number)
-          incarnation_number ||= @update_entry.incarnation_number
-          s0 = @update_entry.status
-          i0 = @update_entry.incarnation_number
-          case status
-          when :confirmed
-            if (s0 == :confirmed)
-              self
-            else
-              ue = UpdateEntry.new(@id, status, incarnation_number, 0)
-              Confirmed.new(@id, @member_pool, ue)
-            end
-          when :suspected
-            if (s0 == :suspected && incarnation_number > i0) ||
-               (s0 == :alive && incarnation_number >= i0)
-              ue = UpdateEntry.new(@id, status, incarnation_number, 0)
-              Suspected.new(@id, @member_pool, ue, false)
-            else
-              self
-            end
-          when :alive
-            if (s0 == :suspected && incarnation_number > i0) ||
-               (s0 == :alive && incarnation_number > i0)
-              ue = UpdateEntry.new(@id, status, incarnation_number, 0)
-              Alive.new(@id, @member_pool, ue)
-            else
-              self
-            end
-          end
+        def advance(_elapsed_seconds)
+          self
         end
 
         def member_failed_to_reply; end
 
-        def increment_propagation_count
-          @update_entry.increment_propagation_count
-        end
-
         def can_be_pinged?
           false
         end
@@ -61,9 +31,7 @@ module RSwim
         protected
 
         def logger
-          @_logger ||= begin
-            RSwim::Logger.new("unknown node", STDERR)
-          end
+          @_logger ||= RSwim::Logger.new("Node #{@node_member_id}", STDERR)
         end
       end
     end

data/lib/rswim/member/health_state/confirmed.rb

@@ -4,7 +4,7 @@ module RSwim
   module Member
     module HealthState
       class Confirmed < Base
-        def initialize(id, member_pool, update_entry)
+        def initialize(id, node_member_id, member_pool, must_propagate: false)
           super
           @member_halted = false
           @member_removed = false
@@ -17,7 +17,7 @@ module RSwim
             @member_pool.halt_member(@id)
             @member_halted = true
           end
-          
+
           if !@member_removed && @life_time_seconds > 10
             @member_pool.remove_member(@id)
             @member_removed = true
@@ -25,6 +25,14 @@ module RSwim
 
           self
         end
+
+        def update_suspicion(_status, _old_incarnation_number, _gossip_incarnation_number)
+          self
+        end
+
+        def status
+          :confirmed
+        end
       end
     end
   end

data/lib/rswim/member/health_state/suspected.rb

@@ -4,8 +4,8 @@ module RSwim
   module Member
     module HealthState
       class Suspected < Base
-        def initialize(id, member_pool, update_entry, send_ping_request)
-          super(id, member_pool, update_entry)
+        def initialize(id, node_member_id, member_pool, send_ping_request:, must_propagate: false)
+          super(id, node_member_id, member_pool, must_propagate: must_propagate)
           @ping_request_sent = !send_ping_request
           @life_time_seconds = 0
         end
@@ -17,15 +17,33 @@ module RSwim
             @ping_request_sent = true
           end
           if @life_time_seconds > 60
-            Confirmed.new(@id, @member_pool, UpdateEntry.new(@id, :confirmed, @update_entry.incarnation_number, -2))
+            # TODO: make sure to propagate this information with priority
+            Confirmed.new(@id, @node_member_id, @member_pool, must_propagate: true)
           else
             self
           end
         end
 
+        def update_suspicion(status, old_incarnation_number, gossip_incarnation_number)
+          case status
+          when :confirmed then Confirmed.new(@id, @node_member_id, @member_pool)
+          when :suspected then self
+          when :alive
+            if gossip_incarnation_number > old_incarnation_number
+              Alive.new(@id, @node_member_id, @member_pool)
+            else
+              self
+            end
+          end
+        end
+
         def can_be_pinged?
           true
         end
+
+        def status
+          :suspected
+        end
       end
     end
   end

data/lib/rswim/member/me.rb

@@ -2,12 +2,17 @@
 
 module RSwim
   module Member
+    # Member behaviour of local node ("me")
     class Me < Base
       def initialize(id)
         super
         @ack_responder = AckResponder.new(id)
-        @incarnation_number = 0
         @propagation_count = 0
+        @custom_state = {}
+      end
+
+      def increment_propagation_count
+        @propagation_count += 1
       end
 
       def schedule_ack(member_id)
@@ -18,21 +23,20 @@ module RSwim
         @ack_responder.prepare_output
       end
 
-      def update_suspicion(status, incarnation_number)
-        if status != :alive && incarnation_number == @incarnation_number
-          @incarnation_number += 1
-
-          # making sure to get priority in being propagated
-          @propagation_count = -10
-        end
+      def append_custom_state(key, value)
+        @custom_state[key] = value
+        propagate_change
       end
 
-      def increment_propagation_count
-        @propagation_count += 1
+      def incorporate_gossip(update_entry)
+        if update_entry.incarnation_number >= @incarnation_number &&
+           (update_entry.status != :alive || update_entry.custom_state != @custom_state)
+          propagate_change
+        end
       end
 
       def prepare_update_entry
-        UpdateEntry.new(@id, :alive, @incarnation_number, @propagation_count)
+        UpdateEntry.new(@id, :alive, @incarnation_number, @custom_state, @propagation_count)
       end
 
       def update(elapsed_seconds); end
@@ -40,6 +44,15 @@ module RSwim
       def can_be_pinged?
         false
       end
+
+      private
+
+      def propagate_change
+        @incarnation_number += 1
+
+        # making sure to get priority in being propagated
+        @propagation_count = -10
+      end
     end
   end
 end

data/lib/rswim/member/peer.rb

@@ -6,9 +6,11 @@ module RSwim
       def initialize(id, node_member_id, member_pool)
         super(id)
         @member_pool = member_pool
+        @node_member_id = node_member_id
         @transmission_state = TransmissionState::Ready.new(id, node_member_id, member_pool)
-        @health_state = HealthState::Alive.new(id, member_pool)
+        @health_state = HealthState::Alive.new(id, node_member_id, member_pool)
         @forwarding_state = ForwardingState::Ready.new(id, node_member_id)
+        @custom_state_holder = CustomStateHolder.new(id, node_member_id)
       end
 
       ## Messages
@@ -28,8 +30,7 @@ module RSwim
         @transmission_state.enqueue_ping_from(source_id)
       end
 
-
-      ## Callbacks
+      # # Callbacks
 
       #  call this when you received ack from member
       def replied_with_ack
@@ -44,11 +45,10 @@ module RSwim
         @health_state.member_failed_to_reply
       end
 
-
       ## Commands
 
       def halt
-        @transmission_state = TransmissionState::Off.new(@id)
+        @transmission_state = TransmissionState::Off.new(@id, @node_member_id)
       end
 
       def forward_ack
@@ -61,25 +61,68 @@ module RSwim
         @health_state = @health_state.advance(elapsed_seconds)
       end
 
+      def increment_propagation_count
+        @health_state.increment_propagation_count
+        @custom_state_holder.increment_propagation_count
+      end
+
       def prepare_output
         [@transmission_state, @forwarding_state].flat_map(&:prepare_output)
       end
 
       def prepare_update_entry
-        @health_state.update_entry
-      end
-
-      def increment_propagation_count
-        @health_state.increment_propagation_count
+        pc = [@health_state, @custom_state_holder].map!(&:propagation_count).min
+        UpdateEntry.new(@id, @health_state.status, @incarnation_number, @custom_state_holder.state, pc)
       end
 
-      def update_suspicion(status, incarnation_number=nil)
-        @health_state = @health_state.update_suspicion(status, incarnation_number)
+      def incorporate_gossip(update_entry)
+        update_custom_state(update_entry.custom_state, update_entry.incarnation_number)
+        update_suspicion(update_entry.status, update_entry.incarnation_number)
+        @incarnation_number = update_entry.incarnation_number if update_entry.incarnation_number > @incarnation_number
       end
 
       def can_be_pinged?
         @health_state.can_be_pinged?
       end
+
+      private
+
+      def update_custom_state(new_state, incarnation_number)
+        should_update = new_state != @custom_state_holder.state && incarnation_number > @incarnation_number
+        @custom_state_holder.state = new_state if should_update
+      end
+
+
+      def update_suspicion(status, incarnation_number = nil)
+        old_incarnation_number = @incarnation_number
+        incarnation_number ||= @incarnation_number
+        @health_state = @health_state.update_suspicion(status, old_incarnation_number, incarnation_number)
+      end
+
+      class CustomStateHolder
+        attr_reader :propagation_count, :state
+
+        def initialize(id, node_member_id)
+          @id = id
+          @node_member_id = node_member_id
+          @state = {}
+          @propagation_count = 0
+        end
+
+        def state=(arg)
+          @state = arg
+          @propagation_count = 0
+          logger.debug("Member with id #{@id} updated custom state: #{@state}")
+        end
+
+        def increment_propagation_count
+          @propagation_count += 1
+        end
+
+        def logger
+          @_logger ||= RSwim::Logger.new("Node #{@node_member_id}", $stderr)
+        end
+      end
     end
   end
 end

data/lib/rswim/member/transmission_state/off.rb

@@ -4,8 +4,8 @@ module RSwim
   module Member
     module TransmissionState
       class Off < Base
-        def initialize(id)
-          super(id, nil, nil, [], [])
+        def initialize(id, node_member_id)
+          super(id, node_member_id, nil, [], [])
         end
 
         def member_replied_with_ack

data/lib/rswim/member_pool.rb

@@ -11,9 +11,13 @@ module RSwim
       @subscribers = []
     end
 
+    def append_custom_state(key, value)
+      @me.append_custom_state(key, value)
+    end
+
     def update_member(message)
       updates = message.payload[:updates]
-      update_suspicions(updates) unless updates.nil?
+      incorporate_gossip(updates) unless updates.nil?
 
       sender = member(message.from) # NB: records member if not seen before
       case message.type
@@ -41,19 +45,19 @@ module RSwim
       @subscribers << block
     end
 
-
     def prepare_output
+      ms = @members.values.flat_map(&:prepare_output)
+      return ms if ms.empty?
+
       update_entries = @members.map { |_k, member| member.prepare_update_entry }
-                               # .select { |entry| entry.propagation_count < 5 }
-                               .sort_by { |entry| entry.propagation_count } # sort ascending!
+                               .sort_by(&:propagation_count) # sort ascending!
                                .take(15) # TODO: constant
 
       update_entries.each do |entry|
-        publish(entry.member_id, entry.status) if entry.propagation_count.zero?
+        publish(entry) if entry.propagation_count.zero?
         member(entry.member_id).increment_propagation_count
       end
 
-      ms = @members.values.flat_map(&:prepare_output)
       ms.each { |message| message.payload[:updates] = update_entries }
       ms
     end
@@ -62,8 +66,7 @@ module RSwim
       ms = @members.values.select(&:can_be_pinged?)
       return if ms.empty?
 
-      index = ms.one? ? 0 : rand(ms.size)
-      member = ms[index]
+      member = random_member(ms)
       member.ping!
     end
 
@@ -83,6 +86,7 @@ module RSwim
 
     def remove_member(member_id)
       raise 'boom' if member_id == @node_member_id
+
       @members.delete(member_id)
     end
 
@@ -94,20 +98,29 @@ module RSwim
       member(member_id).failed_to_reply
     end
 
+    protected
+
+    def random_member(members)
+      index = members.one? ? 0 : rand(members.size)
+      members[index]
+    end
+
     private
 
-    def publish(member_id, status)
-      @subscribers.each { |s| s.call(member_id, status) }
+    def publish(update_entry)
+      @subscribers.each { |s| s.call(update_entry) }
     end
 
-    def update_suspicions(updates)
+    def incorporate_gossip(updates)
       updates.each do |u|
-        member(u.member_id).update_suspicion(u.status, u.incarnation_number)
+        m = member(u.member_id)
+        m.incorporate_gossip(u)
       end
     end
 
     def member(id)
       raise 'boom' if id.nil?
+
       @members[id] ||= Member::Peer.new(id, @node_member_id, self)
     end
   end

data/lib/rswim/message.rb

@@ -14,5 +14,9 @@ module RSwim
     def to_s
       "message of type #{type} from #{from} to #{to} with #{payload[:updates].to_a.size} updates"
     end
+
+    def ==(other)
+      %i[to from type payload].all? { |a| send(a) == other.send(a) }
+    end
   end
 end

data/lib/rswim/node.rb

@@ -4,7 +4,7 @@ require 'socket'
 
 module RSwim
   class Node
-    def initialize(my_host, seed_hosts)
+    def initialize(my_host, seed_hosts, t_ms, r_ms)
       @my_host = my_host
       @directory = Directory.new
       @my_id = @directory.id(@my_host)
@@ -12,27 +12,31 @@ module RSwim
       @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)
+      @agent = RSwim::Agent::SleepBased.new(@pipe, @my_id, seed_ids, t_ms, r_ms)
     end
 
-    def self.udp(my_host, seed_hosts, port)
-      Integration::Udp::Node.new(my_host, seed_hosts, port)
+    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 subscribe(&block)
-      @agent.subscribe do |id, status|
-        host = @directory.host(id)
-        block.call(host, status)
+      @agent.subscribe do |update_entry|
+        host = @directory.host(update_entry.member_id)
+        block.call(host, update_entry.status, update_entry.custom_state)
       end
     end
 
+    def append_custom_state(key, value)
+      @agent.append_custom_state(key, value)
+    end
+
     # blocks until interrupted
     def start
       logger.info 'starting node'
       before_start
       @agent.run
     rescue StandardError => e
-      logger.debug("Error: #{e}")
+      logger.error("Node failed: #{e}")
     end
 
     protected
@@ -42,9 +46,7 @@ module RSwim
     end
 
     def logger
-      @_logger ||= begin
-        RSwim::Logger.new(self.class, STDERR)
-      end
+      @_logger ||= RSwim::Logger.new(self.class, $stderr)
     end
   end
 end

data/lib/rswim/protocol_state.rb

@@ -5,7 +5,7 @@ module RSwim
     def initialize(node_member_id, seed_member_ids, t_ms, r_ms)
       @t_ms = t_ms
       @r_ms = r_ms
-      @member_pool = MemberPool.new(node_member_id, seed_member_ids)
+      @member_pool = new_member_pool(node_member_id, seed_member_ids)
       @node_member_id = node_member_id
       @t = @r = 1
     end
@@ -14,6 +14,10 @@ module RSwim
       @member_pool.subscribe(&block)
     end
 
+    def append_custom_state(key, value)
+      @member_pool.append_custom_state(key, value)
+    end
+
     def advance(input_messages, elapsed_seconds)
       @t += elapsed_seconds * 1000
       @t = 0 if @t >= @t_ms
@@ -50,6 +54,12 @@ module RSwim
       output_messages
     end
 
+    protected
+
+    def new_member_pool(node_member_id, seed_member_ids)
+      MemberPool.new(node_member_id, seed_member_ids)
+    end
+
     private
 
     def logger

data/lib/rswim/update_entry.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
+
 module RSwim
   class UpdateEntry
-    attr_reader :member_id, :status, :incarnation_number, :propagation_count
+    attr_reader :member_id, :status, :incarnation_number, :propagation_count, :custom_state
 
-    def initialize(member_id, status, incarnation_number, propagation_count = 0)
+    def initialize(member_id, status, incarnation_number, custom_state, propagation_count = 0)
       @member_id = member_id
       @status = status
       @incarnation_number = incarnation_number
+      @custom_state = custom_state
       @propagation_count = propagation_count
     end
 
-    def increment_propagation_count
-      @propagation_count += 1
+    def ==(other)
+      %i[member_id status incarnation_number propagation_count custom_state].all? do |a|
+        send(a) == other.send(a)
+      end
     end
   end
 end

data/lib/rswim/version.rb

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

data/rswim.gemspec

@@ -26,9 +26,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 3.0.0'
+  
   spec.add_dependency 'zeitwerk', '~> 2.2'
+  spec.add_dependency 'slop', '~> 4.9'
 
-  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'guard-rspec', '~> 4.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswim
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Erik Madsen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
-  type: :development
+        version: '4.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '4.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +187,7 @@ metadata:
   homepage_uri: https://github.com/beatmadsen/rswim
   source_code_uri: https://github.com/beatmadsen/rswim
   changelog_uri: https://github.com/beatmadsen/rswim/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,15 +195,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby implementation of the SWIM gossip protocol
 test_files: []