rswim 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 672b410f63b01447de5ba794f65d20f4da0fc0966381c39d3fa333cd21482717
+  data.tar.gz: 369e88eeaf54294cda7b98ad65c9ee6f8c79c00b8ba362e9e3d844fb6f450ada
+SHA512:
+  metadata.gz: 7236a1d7c5159b4113672f3eca7c931b9978ab54a353ea44198000e0894c4ef9266b9fcb2dcf6045476402057748682388200322a2b2eba3f9754c10c5091402
+  data.tar.gz: 48f657cd9ff5d89cb93d9c684d546e876dba5b02a16183b50c0794b37e779f989bf9869e39de5aa2c91539ed39fa2380af091c2cf754ac50bdd37628d1477e06

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1 @@
+# 1.0.0 Complete implementation for UDP plus simple, human readable serialisation of messages

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rswim.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    rswim (1.0.0)
+      zeitwerk (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.16.2)
+      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)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  byebug
+  fuubar (~> 2.5)
+  guard-rspec (~> 4.7)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rswim!
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Erik Madsen
+
+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,72 @@
+# RSwim
+
+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.
+
+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.
+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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rswim'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rswim
+
+## Usage
+
+Example:
+```ruby
+  require 'rswim'
+
+  port = 4545
+
+  # known, running nodes to connect with initially.
+  seed_hosts = ['192.168.1.42', '192.168.1.43']
+
+  puts "Starting node"
+
+  # Instantiate node, setting my_host to nil to auto detect host IP.
+  node = RSwim::Node.udp(nil, seed_hosts, port)
+
+  # Subscribe to updates
+  node.subscribe do |host, status|
+    puts "Update: #{host} entered state #{status}"
+  end
+
+  puts "Ready\n"
+  begin
+    # Run node (blocking)
+    node.start
+  rescue Interrupt
+  end
+  puts "\nDone"
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beatmadsen/rswim.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rswim"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/run_node

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby --jit
+require "bundler/setup"
+require 'rswim'
+puts "Ruby version: #{RUBY_VERSION}"
+
+PORT = 4545
+
+puts "Enter seed nodes"
+input = gets
+seed_hosts = input.split(" ")
+abort 'EOF' if seed_hosts.nil?
+puts "Operating with no seed nodes" if seed_hosts.empty?
+
+puts "Starting node"
+
+# Instantiate node, setting my_host to nil to auto detect host IP.
+node = RSwim::Node.udp(nil, seed_hosts, PORT)
+
+# Subscribe to updates
+node.subscribe do |host, status|
+  puts "Update: #{host} entered state #{status}"
+end
+
+puts "Ready\n"
+begin
+  # Run node (blocking)
+  node.start
+rescue Interrupt
+end
+puts "\nDone"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rswim.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'zeitwerk'
+require 'byebug'
+
+# frozen_string_literal: true
+
+class MyInflector < Zeitwerk::Inflector
+  def camelize(basename, _abspath)
+    case basename
+    when 'rswim' then 'RSwim'
+    else super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector = MyInflector.new
+loader.setup
+
+module RSwim
+  K = 3
+
+  # Protocol time, millis
+  T_MS = 30_000
+
+  # Roundtrip time, millis
+  R_MS = 10_000
+
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/rswim/agent.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RSwim
+  module Agent
+    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)
+      end
+
+      def subscribe(&block)
+        @state.subscribe(&block)
+      end
+
+      def run
+        loop do
+          elapsed_seconds = pause
+          output_messages = @state.advance(@pipe.inbound, elapsed_seconds)
+          output_messages.each { |message| @pipe.send(message) }
+        end
+      end
+
+      protected
+
+      def pause
+        raise 'implement this in a subclass'
+      end
+
+      def monotonic_seconds
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    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)
+        super(pipe, node_member_id, seed_member_ids, t_ms, r_ms)
+        @sleep_time_seconds = sleep_time_seconds
+      end
+
+      protected
+
+      def pause
+        t = monotonic_seconds
+        sleep @sleep_time_seconds
+        t′ = monotonic_seconds
+        t′ - t
+      end
+    end
+
+    class FiberBased < Base
+      def run
+        @f = Fiber.new { super }
+      end
+
+      def resume
+        @f.resume
+      end
+
+      protected
+
+      def pause
+        t = monotonic_seconds
+        Fiber.yield
+        t′ = monotonic_seconds
+        t′ - t
+      end
+    end
+  end
+end

data/lib/rswim/directory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RSwim
+  class Directory
+    def initialize
+      @i = 0
+      @ids = {}
+      @hosts = {}
+    end
+
+    def id(host)
+      result = @ids[host]
+      if result.nil?
+        @i += 1
+        @ids[host] = @i
+        @hosts[@i] = host
+        @i
+      else
+        result
+      end
+    end
+
+    def host(id)
+      @hosts[id]
+    end
+  end
+end