MEChat 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e81b866dee38480b59aa955074aae862729bb58570f5f712cddf9f197c5359f
+  data.tar.gz: 408448930057f827d762744384b41bec7eea5046d25ec3311b9f4608b80a67fd
+SHA512:
+  metadata.gz: c3f4f4f96a05311799f72b2ba0a81b2482bcd5495c2f5c1aeb3d9c8bc53d236bcb4377c2bf6757f84c387f9c4097cba4e0fce543a7d57fed5b71bc6602757454
+  data.tar.gz: bef9f54ec1492c3eb3a6543bfb7da6e4403b3709a79d56410c47584e987594b60ea993030d31dc68823d5d6d65dc1c1a9ecf7053fbbd2dca6f7a7eb420a32527

data/Chat.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require 'grpc'
+require 'MEChat_pb'
+require 'MEChat_services_pb'
+require_relative './logger.rb'
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+class Chat < DistributedChat::ChatService::Service
+
+  def initialize ip,port,node_service
+    @node_service = node_service
+    @ip = ip
+    @port = port
+    @logger = MQTTLogger.new topic: "chat", ip: "#{ip.ip_address}:#{port}"
+  end
+
+  private def send_reply(ip:)
+    chat = DistributedChat::ChatService::Stub.new("#{ip.ip_address}:#{ip.ip_port}", :this_channel_is_insecure)
+    chat.release_critical_section(DistributedChat::Request.new(
+      username: "#{ip.ip_address}:#{ip.ip_port}",
+      message: "Reply",
+      timestamp: $alg.clock
+    ))
+    @logger.info "Sent reply to #{ip.ip_address}:#{ip.ip_port}"
+  end
+
+  def send_message(msg, _call)
+    $messages << msg
+    puts "#{msg.username}: #{msg.message}"
+    DistributedChat::Response.new status_code: 0
+  end
+
+  def request_critical_section(req,_call)
+    request = {:ip => Addrinfo.getaddrinfo(req.username.split(":")[0..-2].join(":"),req.username.split(":")[-1].to_i)[0], :message => req}
+    if $crit_section === 0
+      send_reply ip: request[:ip]
+    elsif $crit_section < 2 && request[:message].timestamp < $alg.clock
+      send_reply ip: request[:ip]
+    else
+      $alg.requests << request
+    end
+    DistributedChat::Response.new status_code: 0
+  end
+
+  def release_critical_section(req,_call)
+    $alg.replies << Addrinfo.getaddrinfo(req.username.split(":")[0..-2].join(":"),req.username.split(":")[-1].to_i)[0]
+    $alg.clock = [req.timestamp,$alg.clock].max + 1
+    DistributedChat::Response.new status_code: 0
+  end
+end

data/NodeDiscovery.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'grpc'
+require 'MEChat_pb'
+require 'MEChat_services_pb'
+require_relative './logger.rb'
+require 'socket'
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+class NodeInfoEnum
+  def initialize(nodes)
+    @nodes = nodes
+  end
+
+  def each
+    if block_given?
+      @nodes.each do |node|
+        yield DistributedChat::NodeInfo.new(address: node.address, port: node.port)
+      end
+    else
+      enum_for(:each)
+    end
+  end
+end
+class NodeDiscoveryImpl < DistributedChat::NodeDiscovery::Service
+
+  def initialize ip, port
+    @ip = ip
+    @port = port
+    @logger = MQTTLogger.new topic: "nodediscovery", ip: "#{ip.ip_address}:#{port}"
+  end
+  def register_node(node_info, _call)
+    if $nodes.find { |x| x.address === node_info.address && x.port === node_info.port }
+      @logger.warn node_info.address + ":" + node_info.port.to_s + " already registered"
+      raise GRPC::BadStatus.new(GRPC::Core::StatusCodes::ALREADY_EXISTS, "Node with ip: " + node_info.address + ":" + node_info.port.to_s + " already registered")
+    else
+      $nodes.push node_info
+      puts node_info.address + ":" + node_info.port.to_s + " joined network"
+      @logger.info "Registered node with ip:" + node_info.address + ":" + node_info.port.to_s
+    end
+    nodes_to_return = $nodes.reject { |x| x.address === node_info.address && x.port === node_info.port }
+    to_remove = []
+    nodes_to_return.each do |node|
+      begin
+        nodediscovery = DistributedChat::NodeDiscovery::Stub.new("#{node.address}:#{node.port}", :this_channel_is_insecure)
+        nodediscovery.register_node(DistributedChat::NodeInfo.new(address: node_info.address, port: node_info.port))
+      rescue GRPC::Unavailable => e
+        to_remove << node
+      end
+    end
+    $nodes -= to_remove
+    nodes_to_return -= to_remove
+    nodes_to_return << DistributedChat::NodeInfo.new(address: @ip.ip_address, port: @port)
+    NodeInfoEnum.new(nodes_to_return).each
+  end
+
+  def get_nodes(req,_call)
+    @logger.info "#{_call.peer[5..-1]} with username #{req.username} requested nodes list"
+    NodeInfoEnum.new($nodes).each
+  end
+
+  def get_nodes_local
+    $nodes
+  end
+
+end

data/bin/chatdsva

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../main.rb'
+
+Main.new.main
+

data/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require 'grpc'
+require 'MEChat_pb'
+require 'MEChat_services_pb'
+require_relative './NodeDiscovery.rb'
+require_relative './logger.rb'
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+class Client
+
+  def initialize(ip: Addrinfo)
+    @ip = ip
+    @logger = MQTTLogger.new topic: "chat", ip: "#{ip.ip_address}:#{$port.to_s}"
+  end
+
+  def connect(ip:)
+    nodediscovery = DistributedChat::NodeDiscovery::Stub.new("#{ip.ip_address}:#{ip.ip_port}", :this_channel_is_insecure)
+    nodediscovery.register_node(DistributedChat::NodeInfo.new(address: @ip.ip_address, port: $port)).each do |node|
+      $nodes.push node
+    end
+
+  end
+
+  private def request_critical_section
+    $alg.mutex.synchronize do
+      $alg.clock += 1
+      to_remove = []
+      $nodes.each do |node|
+        begin
+          chat = DistributedChat::ChatService::Stub.new("#{node.address}:#{node.port}", :this_channel_is_insecure)
+          @logger.info "Sent request to #{node.address}:#{node.port}"
+          chat.request_critical_section(DistributedChat::Request.new(
+            username: "#{@ip.ip_address}:#{$port.to_s}",
+            message: "Request",
+            timestamp: $alg.clock
+          ))
+        rescue GRPC::Unavailable
+          to_remove << node
+        end
+      end
+      $nodes -= to_remove
+    end
+  end
+
+  private def send_reply(ip:)
+    chat = DistributedChat::ChatService::Stub.new("#{ip.ip_address}:#{ip.ip_port}", :this_channel_is_insecure)
+    chat.release_critical_section(DistributedChat::Request.new(
+      username: "#{ip.ip_address}:#{ip.ip_port}",
+      message: "Reply",
+      timestamp: $alg.clock
+    ))
+    @logger.info "Sent reply to #{ip.ip_address}:#{ip.ip_port}"
+  end
+
+  private def release_critical_section
+    $alg.mutex.synchronize do
+      $alg.requests.each do |request|
+        send_reply(ip: request[:ip])
+      end
+      $alg.requests.clear
+      $alg.replies.clear
+    end
+  end
+
+  def run
+    new_msg = gets.chomp
+    while new_msg != "exit"
+    $crit_section = 1
+    request_critical_section
+    sleepdur = 0
+    while $alg.replies.length < $nodes.length
+      sleepdur += 0.1
+      @logger.info "#{@ip.ip_address}:#{$port.to_s} waiting for replies"
+      sleep 0.1
+      if sleepdur % 5 == 0
+        puts "Waiting for replies. #{$alg.replies.length}/#{$nodes.length} replies received"
+      end
+    end
+    $crit_section = 2
+    $nodes.each do |node|
+      chat = DistributedChat::ChatService::Stub.new("#{node.address}:#{node.port}", :this_channel_is_insecure)
+      chat.send_message(DistributedChat::Request.new(username: "#{@ip.ip_address}:#{$port.to_s}", message: new_msg, timestamp: $alg.clock))
+      @logger.info "Sent message \"#{new_msg}\" to #{node.address}:#{node.port}"
+    end
+    $messages.push DistributedChat::Request.new(username: "#{@ip.ip_address}:#{$port.to_s}", message: new_msg, timestamp: $alg.clock)
+    release_critical_section
+    $crit_section = 0
+    new_msg = gets.chomp
+    end
+  end
+end

data/lib/MEChat_pb.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: MEChat.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x0cMEChat.proto\x12\x10\x64istributed_chat\"?\n\x07Request\x12\x10\n\x08username\x18\x01 \x01(\t\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\x11\n\ttimestamp\x18\x03 \x01(\x05\"\x1f\n\x08Response\x12\x13\n\x0bstatus_code\x18\x01 \x01(\x05\"O\n\x08NodeInfo\x12\x0f\n\x07\x61\x64\x64ress\x18\x01 \x01(\t\x12\x0c\n\x04port\x18\x02 \x01(\x05\x12\x16\n\ttimestamp\x18\x03 \x01(\x05H\x00\x88\x01\x01\x42\x0c\n\n_timestamp2\xf5\x01\n\x0b\x43hatService\x12\x44\n\x0bSendMessage\x12\x19.distributed_chat.Request\x1a\x1a.distributed_chat.Response\x12O\n\x16RequestCriticalSection\x12\x19.distributed_chat.Request\x1a\x1a.distributed_chat.Response\x12O\n\x16ReleaseCriticalSection\x12\x19.distributed_chat.Request\x1a\x1a.distributed_chat.Response2\x9e\x01\n\rNodeDiscovery\x12H\n\x0cRegisterNode\x12\x1a.distributed_chat.NodeInfo\x1a\x1a.distributed_chat.NodeInfo0\x01\x12\x43\n\x08GetNodes\x12\x19.distributed_chat.Request\x1a\x1a.distributed_chat.NodeInfo0\x01\x42\t\xaa\x02\x06MEChatb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module DistributedChat
+  Request = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("distributed_chat.Request").msgclass
+  Response = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("distributed_chat.Response").msgclass
+  NodeInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("distributed_chat.NodeInfo").msgclass
+end

data/lib/MEChat_services_pb.rb

@@ -0,0 +1,43 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: MEChat.proto for package 'distributed_chat'
+
+require 'grpc'
+require 'MEChat_pb'
+
+module DistributedChat
+  module ChatService
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'distributed_chat.ChatService'
+
+      # Method to send a message to the chat
+      rpc :SendMessage, ::DistributedChat::Request, ::DistributedChat::Response
+      # Method to request access to the critical section
+      rpc :RequestCriticalSection, ::DistributedChat::Request, ::DistributedChat::Response
+      # Method to release access to the critical section
+      rpc :ReleaseCriticalSection, ::DistributedChat::Request, ::DistributedChat::Response
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+  # Define RPC methods for the distributed chat service
+  module NodeDiscovery
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'distributed_chat.NodeDiscovery'
+
+      rpc :RegisterNode, ::DistributedChat::NodeInfo, stream(::DistributedChat::NodeInfo)
+      rpc :GetNodes, ::DistributedChat::Request, stream(::DistributedChat::NodeInfo)
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/logger.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'mqtt'
+
+class MQTTLogger
+  def initialize (topic: String, ip: String)
+    @client = MQTT::Client.new
+    @client.host = 'fireup.studio'
+    @client.connect
+    @topic = topic
+    @ip = ip
+  end
+
+  private def log level, msg
+    @client.publish(@topic, "#{@ip}|#{level}|#{msg}", retain=false)
+  end
+
+  def info msg
+    log "INFO",msg
+  end
+
+  def warn msg
+    log "WARN",msg
+  end
+
+  def error msg
+    log "ERROR",msg
+  end
+
+  def finalize
+    @client.disconnect
+  end
+end

data/main.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require 'grpc'
+require 'MEChat_pb'
+require 'MEChat_services_pb'
+require_relative './NodeDiscovery.rb'
+require_relative './server.rb'
+require_relative './client.rb'
+require_relative './ricart_agrawala.rb'
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+$port = RandomPort::Pool::SINGLETON.acquire
+$nodes = []
+$messages = []
+$crit_section = 0
+$alg = RicartAgrawala.new
+
+class Main
+
+  def pick_ip
+    addrs = Socket.ip_address_list.reject( &:ipv4_loopback? )
+                  .reject( &:ipv6_loopback? )
+    puts "Please select by which IP to present to other nodes"
+    addrs.each_with_index do |x,i|
+      puts "[#{i}] #{x.ip_address}"
+    end
+    puts "[#{addrs.length}] Manual IP"
+    picked = gets.to_i 10
+    return addrs[picked] unless picked.to_i >= addrs.length
+    Addrinfo.getaddrinfo(gets.chomp,80)[0]
+  end
+
+  def get_other_ip
+    puts "[J]oin network or [C]reate new network?"
+    choice = gets.chomp
+    return Addrinfo.getaddrinfo("224.0.0.1",80)[0] if choice.downcase[0] == "c"
+    puts "Please enter IP of a node in the network you wish to join"
+    ip = gets.chomp
+    puts "Please enter port of a node in the network you wish to join"
+    port = gets.to_i 10
+    Addrinfo.getaddrinfo(ip,port)[0]
+  end
+
+  def main
+    ip = pick_ip
+    connect_ip = get_other_ip
+    server = Thread.new { Server.new(ip: ip).run }
+    if connect_ip.ipv4_multicast?
+      client = Thread.new { Client.new(ip: ip).run }
+    else
+      client = Thread.new { Client.new(ip: ip).connect(ip: connect_ip); Client.new(ip: ip).run }
+    end
+    server.join
+    client.join
+  end
+
+end

data/ricart_agrawala.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'thread'
+
+class RicartAgrawala
+  attr_accessor :clock, :replies, :requests
+  attr_reader :mutex
+
+  def initialize
+    @clock = 0
+    @replies = []
+    @requests = []
+    @mutex = Mutex.new
+  end
+end

data/server.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'grpc'
+require 'random-port'
+require 'MEChat_pb'
+require 'MEChat_services_pb'
+require_relative './NodeDiscovery.rb'
+require_relative './Chat.rb'
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+class Server
+  def initialize(ip: Addrinfo)
+    @ip = ip
+  end
+
+  def run
+
+    node_discovery = NodeDiscoveryImpl.new @ip, $port
+    chat = Chat.new @ip,$port,node_discovery
+
+    server = GRPC::RpcServer.new
+    server.add_http2_port("0.0.0.0:#{$port.to_s}", :this_port_is_insecure)
+    server.handle(node_discovery)
+    server.handle(chat)
+    puts "Server side running on " + $port.to_s
+
+    server.run_till_terminated_or_interrupted(['int', 'SIGTERM'])
+
+  end
+end
+
+# Server.new.run

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: MEChat
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Lukas Kaufmann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: random-port
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: SHM Chat app using gRPC and Ricart-Agrawala algorithm
+email: kaufmlu1@fel.cvut.cz
+executables:
+- chatdsva
+extensions: []
+extra_rdoc_files: []
+files:
+- Chat.rb
+- NodeDiscovery.rb
+- bin/chatdsva
+- client.rb
+- lib/MEChat_pb.rb
+- lib/MEChat_services_pb.rb
+- logger.rb
+- main.rb
+- ricart_agrawala.rb
+- server.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+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.4.10
+signing_key:
+specification_version: 4
+summary: gRPC Ruby shared memory chat app
+test_files: []