rswim 1.0.0

data/lib/rswim/message.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RSwim
+  class Message
+    attr_reader :to, :from, :type, :payload
+
+    def initialize(to, from, type, payload = {})
+      @to = to
+      @from = from
+      @type = type
+      @payload = payload
+    end
+
+    def to_s
+      "message of type #{type} from #{from} to #{to} with #{payload[:updates].to_a.size} updates"
+    end
+  end
+end

data/lib/rswim/node.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module RSwim
+  class Node
+    def initialize(my_host, seed_hosts)
+      @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)
+    end
+
+    def self.udp(my_host, seed_hosts, port)
+      Integration::Udp::Node.new(my_host, seed_hosts, port)
+    end
+
+    def subscribe(&block)
+      @agent.subscribe do |id, status|
+        host = @directory.host(id)
+        block.call(host, status)
+      end
+    end
+
+    # blocks until interrupted
+    def start
+      logger.info 'starting node'
+      before_start
+      @agent.run
+    rescue StandardError => e
+      logger.debug("Error: #{e}")
+    end
+
+    protected
+
+    def before_start
+      raise 'must be implemented in subclass'
+    end
+
+    def logger
+      @_logger ||= begin
+        RSwim::Logger.new(self.class, STDERR)
+      end
+    end
+  end
+end

data/lib/rswim/pipe.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RSwim
+  class Pipe
+    def self.simple
+      Simple.new
+    end
+
+    def initialize(q_in, q_out)
+      @q_in = q_in
+      @q_out = q_out
+    end
+
+    def send(message)
+      @q_out << message
+    end
+
+    # returns list of inputs. Empty if none have been received
+    def inbound
+      Array.new(@q_in.size) { @q_in.pop }.tap(&:compact!)
+    end
+
+    class Simple < Pipe
+      attr_reader :q_in, :q_out
+
+      def initialize
+        @q_in, @q_out = 2.times.map { Queue.new }
+        super(@q_in, @q_out)
+      end
+    end
+  end
+end

data/lib/rswim/protocol_state.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RSwim
+  class ProtocolState
+    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)
+      @node_member_id = node_member_id
+      @t = @r = 1
+    end
+
+    def subscribe(&block)
+      @member_pool.subscribe(&block)
+    end
+
+    def advance(input_messages, elapsed_seconds)
+      @t += elapsed_seconds * 1000
+      @t = 0 if @t >= @t_ms
+
+      @r += elapsed_seconds * 1000
+      @r = 0 if @r >= @r_ms
+
+      input_messages.each do |message|
+        raise 'message must be of type Message' unless message.is_a? Message
+
+        update_member(message)
+      end
+
+      @member_pool.update_members(elapsed_seconds)
+      output_messages = @member_pool.prepare_output
+
+      # TODO: more deterministic steady state mechanism,
+      # e.g. output_messages = @member_pool.next_steady_state(elapsed_seconds)
+      # using a flag set by member state
+      3.times do
+        @member_pool.update_members(0)
+        output_messages.concat(@member_pool.prepare_output)
+      end
+
+      @member_pool.send_ping_to_random_healthy_member if @t == 0
+
+      3.times do
+        @member_pool.update_members(0)
+        output_messages.concat(@member_pool.prepare_output)
+      end
+
+      @member_pool.status_report if @r == 0
+
+      output_messages
+    end
+
+    private
+
+    def logger
+      @_logger ||= Logger.new(self.class, STDERR)
+    end
+
+    def update_member(message)
+      @member_pool.update_member(message)
+    # rescue StandardError => e
+    #   logger.error(e)
+    end
+  end
+end

data/lib/rswim/status_report.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RSwim
+  class StatusReport
+    class << self
+
+      def print(node_member_id, members)
+        b = members.map { |k, m| "#{k}: #{m.prepare_update_entry.status}\n" }.join
+        a = <<~REPORT
+
+        ==========================================
+        Status report for node #{node_member_id}:
+        ==========================================
+
+        #{b}
+        ==========================================
+
+        REPORT
+        logger.info(a)
+      end
+
+      private
+
+      def logger
+        @_logger ||= Logger.new(self, 'log/status.log', 10, 1024000)
+      end
+    end
+  end
+end

data/lib/rswim/update_entry.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module RSwim
+  class UpdateEntry
+    attr_reader :member_id, :status, :incarnation_number, :propagation_count
+
+    def initialize(member_id, status, incarnation_number, propagation_count = 0)
+      @member_id = member_id
+      @status = status
+      @incarnation_number = incarnation_number
+      @propagation_count = propagation_count
+    end
+
+    def increment_propagation_count
+      @propagation_count += 1
+    end
+  end
+end

data/lib/rswim/version.rb

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

data/rswim.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rswim/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rswim"
+  spec.version       = RSwim::VERSION
+  spec.authors       = ["Erik Madsen"]
+  spec.email         = ["beatmadsen@gmail.com"]
+
+  spec.summary       = %q{Ruby implementation of the SWIM gossip protocol}
+  spec.description   = %q{RSwim is a Ruby implementation of the SWIM gossip protocol, a mechanism for discovering new peers and getting updates about liveness of existing peers in a network.}
+  spec.homepage      = "https://github.com/beatmadsen/rswim"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/beatmadsen/rswim"
+  spec.metadata["changelog_uri"] = "https://github.com/beatmadsen/rswim/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'zeitwerk', '~> 2.2'
+
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'fuubar', '~> 2.5'
+  spec.add_development_dependency 'byebug'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: rswim
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erik Madsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSwim is a Ruby implementation of the SWIM gossip protocol, a mechanism
+  for discovering new peers and getting updates about liveness of existing peers in
+  a network.
+email:
+- beatmadsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/run_node
+- bin/setup
+- lib/rswim.rb
+- lib/rswim/agent.rb
+- lib/rswim/directory.rb
+- lib/rswim/integration/deserializer.rb
+- lib/rswim/integration/serializer.rb
+- lib/rswim/integration/udp/node.rb
+- lib/rswim/logger.rb
+- lib/rswim/member/ack_responder.rb
+- lib/rswim/member/base.rb
+- lib/rswim/member/forwarding_state/base.rb
+- lib/rswim/member/forwarding_state/forwarding_ack.rb
+- lib/rswim/member/forwarding_state/ready.rb
+- lib/rswim/member/health_state/alive.rb
+- lib/rswim/member/health_state/base.rb
+- lib/rswim/member/health_state/confirmed.rb
+- lib/rswim/member/health_state/suspected.rb
+- lib/rswim/member/me.rb
+- lib/rswim/member/peer.rb
+- lib/rswim/member/transmission_state/awaiting_ack.rb
+- lib/rswim/member/transmission_state/base.rb
+- lib/rswim/member/transmission_state/off.rb
+- lib/rswim/member/transmission_state/ready.rb
+- lib/rswim/member/transmission_state/sending_ping.rb
+- lib/rswim/member/transmission_state/sending_ping_request.rb
+- lib/rswim/member_pool.rb
+- lib/rswim/message.rb
+- lib/rswim/node.rb
+- lib/rswim/pipe.rb
+- lib/rswim/protocol_state.rb
+- lib/rswim/status_report.rb
+- lib/rswim/update_entry.rb
+- lib/rswim/version.rb
+- log/.keep
+- rswim.gemspec
+- tmp/.keep
+homepage: https://github.com/beatmadsen/rswim
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of the SWIM gossip protocol
+test_files: []