websocketd in current and dev versions.

master
Karchnu 2020-10-01 17:43:32 +02:00
parent f62b41eadc
commit 58fec6f966
9 changed files with 719 additions and 206 deletions

View File

@ -1,5 +1,5 @@
name: ipcd
version: 0.6.0 # should follow libipc and ipc.cr bindings versions.
version: 0.7.0 # should follow libipc and ipc.cr bindings versions.
authors:
- karchnu <karchnu@karchnu.fr>
@ -10,11 +10,16 @@ description: |
dependencies:
ipc:
git: https://git.baguette.netlib.re/Baguette/ipc.cr
branch: poll
branch: master
baguette-crystal-base:
git: https://git.baguette.netlib.re/Baguette/baguette-crystal-base
branch: master
targets:
websocketd:
main: src/websocketd.cr
websocketd-dev:
main: src/websocketd-dev.cr
websocketc:
main: src/websocketc.cr

26
src/instance_storage.cr Normal file
View File

@ -0,0 +1,26 @@
# Link between fd and TCPSocket, WebSocket and IPC::Connection instances.
class InstanceStorage
property is_json : Hash(Int32, Bool)
property fd_to_websocket : Hash(Int32, WebSocket)
# So the GC won't close it.
property fd_to_socket : Hash(Int32, TCPSocket)
def initialize
@is_json = Hash(Int32,Bool).new
@fd_to_websocket = Hash(Int32, WebSocket).new
@fd_to_socket = Hash(Int32, TCPSocket).new
end
def remove_fd (fdclient : Int32)
puts "#{CBLUE}closing the client:#{CRESET} #{fdclient}"
# 1. remove the client and the service from is_json
@is_json.select! do |fd,v| fd != fdclient end
# 2. remove the client from fd_to_websocket
@fd_to_websocket.select! do |fd, ws| fd != fdclient end
# 3. remove the client from fd_to_socket
@fd_to_socket.select! do |fd, ws| fd != fdclient end
end
end

View File

@ -38,7 +38,14 @@ class HTTP::WebSocket
record Pong
record Close
record Error
record NotFinal
# record NotFinal
struct NotFinal
property message : String
property info : Protocol::PacketInfo
def initialize(@message, @info)
end
end
# :nodoc:
def run_once : Bytes | String | Close | Ping | Pong | NotFinal | Error
@ -73,6 +80,8 @@ class HTTP::WebSocket
@on_message.try &.call(@current_message.to_s)
@current_message.clear
return String.new message
else
return NotFinal.new String.new(message), info
end
when Protocol::Opcode::BINARY
message = @buffer[0, info.size]
@ -93,7 +102,7 @@ class HTTP::WebSocket
end
end
return NotFinal.new
raise "what the fuck?"
end
# Returns the websocket instance.

View File

@ -1,14 +1,23 @@
require "http/web_socket"
require "option_parser"
require "ipc"
require "./colors"
require "./utils"
require "./lib_modifications.cr"
uri = "ws://localhost:1234/pong"
class CLI
class_property uri = "ws://localhost:1234/pong"
class_property rounds = 1
end
OptionParser.parse do |parser|
parser.on "-u uri", "--uri uri", "URI" do |opturi|
uri = opturi
CLI.uri = opturi
end
parser.on "-r rounds", "--rounds nb-messages", "Nb messages to send." do |opt|
CLI.rounds = opt.to_i
end
parser.on "-h", "--help", "Show this help" do
@ -28,7 +37,8 @@ def read_then_print_hexa(ws : WebSocket)
end
def read(ws : WebSocket)
m = ws.read
puts "reading a message"
m = ws.run_once
if m.nil?
raise "empty message"
end
@ -46,8 +56,7 @@ def send(ws : WebSocket, m : String | Slice)
end
begin
ws = WebSocket.new(URI.parse(uri))
ws = WebSocket.new(URI.parse(CLI.uri))
puts "connection done: sending pong"
ws.on_close do |socket|
@ -55,22 +64,20 @@ begin
exit 0
end
if uri.ends_with? ".JSON"
json_message = STDIN.gets_to_end
json_message = json_message.chomp
puts "json_message: #{json_message}"
final_json_message = "{ \"mtype\": 2, \"payload\": #{json_message} }"
puts "final json message: #{final_json_message}"
send ws, final_json_message
# send ws, "{ \"mtype\": 2, \"payload\": \"coucou\" }"
read ws
message = if CLI.uri.ends_with? ".JSON"
IPC::Message.new(0, 2.to_u8, 3.to_u8, STDIN.gets_to_end).to_json
else
send ws, to_message(2, STDIN.gets_to_end)
read ws
IPC::Message.new(0, 2.to_u8, 3.to_u8, STDIN.gets_to_end).to_packet
end
puts "final message: #{message}"
CLI.rounds.times do |i|
send ws, message
pp! read ws
end
ws.close
ws.read
# pp! ws.run_once
rescue e
puts "Exception: #{e}"
end

343
src/websocketd-dev.cr Normal file
View File

@ -0,0 +1,343 @@
require "option_parser"
require "ipc"
require "socket"
require "./colors"
require "colorize"
require "json"
require "socket"
require "http/server"
require "base64"
require "digest"
require "./utils"
require "baguette-crystal-base"
require "./instance_storage.cr"
# All modifications to standard libraries go there.
require "./lib_modifications.cr"
class Context
# service instance parameters
# they can be changed via the cli
class_property service_name : String = "websocket"
class_property host : String = "0.0.0.0"
class_property port_to_listen : UInt16 = 1234
class_property timer_delay : Int32 = 30_000 # 30 seconds
end
OptionParser.parse do |parser|
parser.on "-l host", "--l host", "IP address to listen on." do |h|
Context.host = h
end
parser.on "-p port", "--port port", "Port to listen on." do |port|
Context.port_to_listen = port.to_u16
end
parser.on "-s service-name", "--service-name service-name", "Service name." do |name|
Context.service_name = name
end
parser.on "-t timer-delay", "--timer-delay timer-delay", "Timer delay (in seconds)" do |t|
Context.timer_delay = t.to_i32 * 1000 # stored in ms
end
parser.on "-v verbosity-level", "--verbosity level", "Verbosity." do |opt|
Baguette::Context.verbosity = opt.to_i
end
parser.on "-h", "--help", "Show this help" do
puts parser
exit 0
end
end
def sending_ping_messages
Context.context.fd_to_websocket.each do |fd, ws|
begin
ws.ping "hello from #{fd}"
rescue e
Baguette::Log.error "Exception: #{e}, already closed client #{fd}"
begin
Context.context.remove_fd fd
rescue e
Baguette::Log.error "Cannot remove #{fd} from clients: #{e}"
end
end
end
end
def ws_http_upgrade(client)
request = HTTP::Request.from_io client
if request.nil?
raise "#REQUEST IS NIL"
end
if request.is_a? HTTP::Status && request == HTTP::Status::BAD_REQUEST
raise "BAD REQUEST DAZE~"
end
if request.is_a? HTTP::Status
raise "Not bad request but still pretty bad: #{request.to_s}"
end
# FIXME: check they actually wanted to upgrade to websocket
key = request.headers["Sec-WebSocket-Key"]
response_key = Digest::SHA1.base64digest key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
# Baguette::Log.debug response_key
# HTTP inside bru
headers_header = "HTTP/1.1 101 Switching Protocols"
headers = HTTP::Headers {
"Upgrade" => "websocket",
"Connection" => "Upgrade",
"Sec-WebSocket-Accept" => response_key
}
headers = headers.map { |key, value| "#{key}: #{value[0]}\r\n" }.join
# requested service, fd
req_service = request.path.lchop.sub "ws/", ""
if req_service.ends_with? ".JSON"
Context.context.is_json[client.fd] = true
req_service = req_service.gsub /.JSON$/, ""
else
Context.context.is_json[client.fd] = false
end
# puts "#{headers_header}\n#{headers.to_s}\r\n"
client.send "#{headers_header}\n#{headers.to_s}\r\n"
wsclient = WebSocket.new client
wsclient.on_pong do |m|
Baguette::Log.debug "pong #{m}"
end
# registering the client into storing structures to avoid being garbage collected
Context.context.fd_to_socket[client.fd] = client
Context.context.fd_to_websocket[client.fd] = wsclient
return req_service, request
rescue e
Baguette::Log.error "Exception in ws_http_upgrade: #{e}"
raise "DROP IT"
end
def handle_new_clients(service, server)
# TODO: this is a lot of C-like notation, should be changed.
# In the client accept function
# 1. accept TCP/WS connection
client = server.accept
# 2. upgrade HTTP connections and get the service name in the URI path.
req_service, request = ws_http_upgrade client
# 3. connect to the service via ipc_connection_switched
serverfd : Int32 = 0
# LibIPC.ipc_connection_switched service.pointer, req_service, client.fd, Pointer(Libc::Int).null
spointer = pointerof(serverfd)
if req_service == "tracker"
req_service = "tracking"
end
LibIPC.ipc_connection_switched service.pointer, req_service, client.fd, spointer
if serverfd == 0
raise "Could not connect to #{req_service}"
end
# 4. change client callbacks via ipc_switching_callbacks
# only the client callbacks are changed, since the associated server is a simple libipc service
proc_cb_in = ->ws_cb_in(Int32, Pointer(LibIPC::Message), Int16*)
proc_cb_out = ->ws_cb_out(Int32, Pointer(LibIPC::Message))
LibIPC.ipc_switching_callbacks service.pointer, client.fd, proc_cb_in, proc_cb_out
# 5. In case the requested service is trackingd,
# the websocketd has to provide the IP address as the first message.
if req_service == "tracking"
# The proxy is configured to provide the X-Real-IP in the headers.
# If not found, we use the client address from the socket.
real_ip_address = request.headers["X-Real-IP"] || client.remote_address.address
Baguette::Log.info "trackingd - sending the IP address #{real_ip_address} to fd #{serverfd}"
# sfd = Context.context.switchtable[client.fd]
# message = IPC::Message.from_json(JSON).to_packet
# => JSON has to include these attributes: mtype, utype, payload
# message = IPC::Message.new mtype, utype, payload
# remote_address = client.remote_address.address
message = IPC::Message.new serverfd, 1, 1.to_u8, "{\"ipaddress\": \"#{real_ip_address}\"}"
service.send message
# serv = WrappedTCPFileDescriptor.new(fd: serverfd, family: Socket::Family::INET)
# serv.send message.to_packet
end
Baguette::Log.debug "new client: #{client.fd}"
rescue e
Baguette::Log.error "Exception in handle_new_client: #{e}"
unless client.nil?
client.close
end
end
def ws_cb_out(fd : Int32, pm : Pointer(LibIPC::Message))
# Baguette::Log.info "OUT fd is #{fd}"
wsclient = Context.context.fd_to_websocket[fd]
message = IPC::Message.new pm
# pp! message
if Context.context.is_json[fd]
buf = message.to_json
else
buf = message.to_packet
end
wsclient.send buf
return LibIPC::IPCCB::NoError
rescue e
Baguette::Log.error "Exception during message transfer: #{e}"
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
end
def ws_cb_in(fd : Int32, pm : LibIPC::Message*, more_to_read : Int16*)
# Baguette::Log.debug "IN fd is #{fd}"
wsclient = Context.context.fd_to_websocket[fd]
message = nil
begin
message = wsclient.run_once
rescue e
Baguette::Log.error "run_once FAILED: #{e}"
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
end
if wsclient.ws.io.empty?
more_to_read[0] = 0
else
more_to_read[0] = 1
end
if wsclient.closed?
Baguette::Log.info "client closed the connection"
Context.context.remove_fd fd
return LibIPC::IPCCB::Closing
end
if message.nil?
Baguette::Log.error "Reveiced a nil message"
Context.context.remove_fd fd
return LibIPC::IPCCB::Closing
end
case message
when String
if Context.context.is_json[fd]
ipc_message = IPC::Message.from_json(message)
ipc_message.copy_to_message_pointer pm
return LibIPC::IPCCB::NoError
end
else
# every other option should be dropped
case message
when WebSocket::Error
Baguette::Log.error "An error occured"
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
when WebSocket::Ping
Baguette::Log.debug "Received a ping message"
Context.context.remove_fd fd
return LibIPC::IPCCB::Ignore
when WebSocket::Pong
Baguette::Log.debug "Received a pong message"
return LibIPC::IPCCB::Ignore
when WebSocket::Close
Baguette::Log.debug "Received a close message"
Context.context.remove_fd fd
return LibIPC::IPCCB::Closing
when WebSocket::NotFinal
Baguette::Log.warning "Received only part of a message: NOT IMPLEMENTED"
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
when Bytes
# TODO: when receiving a binary message
# we should test the format and maybe its content
Baguette::Log.error "Received a binary message: NOT IMPLEMENTED, YET"
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
else
Baguette::Log.error "Received a websocket message with unknown type"
end
end
return LibIPC::IPCCB::Error
rescue e
Baguette::Log.error "Exception (receiving a message) #{e}"
# tcp = WrappedTCPFileDescriptor.new(fd: fd, family: Socket::Family::INET)
# tcp.close
Context.context.remove_fd fd
return LibIPC::IPCCB::Error
end
class Context
class_property context = InstanceStorage.new
end
def main
# by default, listen on any IP address
server = TCPServer.new(Context.host, Context.port_to_listen)
service = IPC::Server.new Context.service_name
service << server.fd
# Every few seconds, the service should trigger the timer
# Allowing the sending of Ping messages to clients
service.base_timer = Context.timer_delay
service.timer = Context.timer_delay
service.loop do |event|
# Baguette::Log.info "current state of the context:"
# service.pp
case event
when IPC::Event::Timer
Baguette::Log.debug "IPC::Event::Timer"
sending_ping_messages
when IPC::Event::Connection
Baguette::Log.debug "IPC::Event::Connection: fd #{event.fd}"
when IPC::Event::Disconnection
Baguette::Log.debug "IPC::Event::Disconnection: fd #{event.fd}"
Context.context.remove_fd event.fd
when IPC::Event::ExtraSocket
Baguette::Log.debug "IPC::Event::ExtraSocket: fd #{event.fd}"
if server.fd != event.fd
raise "Error: the only extra socket should be the TCP/WS server"
end
handle_new_clients(service, server)
when IPC::Event::Switch
Baguette::Log.debug "IPC::Event::Switch: fd #{event.fd}"
# raise "Not implemented."
when IPC::Event::MessageSent
Baguette::Log.debug "IPC::Event::MessageSent: fd #{event.fd}"
when IPC::Event::MessageReceived
Baguette::Log.debug "IPC::Event::Message: fd #{event.fd}"
raise "Not implemented."
end
end
end
main

View File

@ -11,37 +11,52 @@ require "base64"
require "digest"
require "./utils"
require "baguette-crystal-base"
require "colorize"
# All modifications to standard libraries go there.
require "./lib_modifications.cr"
# service instance parameters
# they can be changed via the cli
service_name = "websocket"
host = "0.0.0.0"
port_to_listen = 1234
timer_delay = 30_000.to_f64 # 30 seconds
class Context
# service instance parameters
# they can be changed via the cli
class_property service_name = "websocket"
class_property host = "0.0.0.0"
class_property port_to_listen : UInt16 = 1234
class_property timer_delay : Int32 = 30_000.to_i32
verbosity = 1
class_property print_messages = false
class_property print_timer = false
end
OptionParser.parse do |parser|
parser.on "-l host", "--l host", "IP address to listen on." do |h|
host = h
Context.host = h
end
parser.on "-p port", "--port port", "Port to listen on." do |port|
port_to_listen = port.to_u16
Context.port_to_listen = port.to_u16
end
parser.on "-s service-name", "--service-name service-name", "Service name." do |name|
service_name = name
Context.service_name = name
end
parser.on "-t timer-delay", "--timer-delay timer-delay", "Timer delay (in seconds)" do |t|
timer_delay = t.to_f64 * 1000 # stored in ms
Context.timer_delay = t.to_i32 * 1000
end
parser.on "-v verbosity-level", "--verbosity level", "Verbosity." do |opt|
verbosity = opt.to_i
Baguette::Context.verbosity = opt.to_i
end
parser.on "-T", "--print-timer", "Print timer." do
Context.print_timer = true
end
parser.on "-M", "--print-messages", "Print messages received and sent." do
Context.print_messages = true
end
parser.on "-h", "--help", "Show this help" do
@ -51,7 +66,7 @@ OptionParser.parse do |parser|
end
# Link between fd and TCPSocket, WebSocket and IPC::Connection instances.
# Link between fd and TCPSocket, WebSocket and IPC::Client instances.
class InstanceStorage
property service : IPC::SwitchingService
property switchtable : Hash(Int32, Int32)
@ -59,7 +74,7 @@ class InstanceStorage
property is_json : Hash(Int32, Bool)
property fd_to_tcpsocket : Hash(Int32, TCPSocket)
property fd_to_websocket : Hash(Int32, WebSocket)
property fd_to_ipcconnection : Hash(Int32, IPC::Connection)
property fd_to_ipcclient : Hash(Int32, IPC::Client)
def initialize (@service : IPC::SwitchingService)
# fdlist_client = [] of TCPSocket
@ -68,22 +83,34 @@ class InstanceStorage
@is_json = Hash(Int32,Bool).new
@fd_to_tcpsocket = Hash(Int32, TCPSocket).new
@fd_to_websocket = Hash(Int32, WebSocket).new
@fd_to_ipcconnection = Hash(Int32, IPC::Connection).new
@fd_to_ipcclient = Hash(Int32, IPC::Client).new
end
def remove_fd (fdclient : Int32)
puts "#{CBLUE}closing the client:#{CRESET} #{fdclient}"
# 1. closing both the client and the service
fdservice = @switchtable[fdclient]?
tcpfdc = @fd_to_tcpsocket[fdclient]
Baguette::Log.info "closing the client:#{CRESET} #{fdclient}"
if fdclient == -1
raise "fdclient is -1, nothing to do with it"
end
# 2. closing the TCP connections
tcpfdc.close unless tcpfdc.closed?
begin
# 1. closing both the client and the service
tcpfdc = @fd_to_tcpsocket[fdclient]
# 2. closing the TCP connections
tcpfdc.close unless tcpfdc.closed?
rescue e
Baguette::Log.error "remove_fd: 1 #{e}"
end
# 3. removing the client and the service fds from the loop check
@service.remove_fd (fdclient)
begin
@service.remove_fd (fdclient)
rescue e
Baguette::Log.error "remove_fd: 2 #{e}"
end
# 5. removing both the client and the service from the switchtable
fdservice = @switchtable[fdclient]?
@switchtable = @switchtable.select do |fdc, fds|
fdc != fdclient && fds != fdclient
end
@ -96,30 +123,45 @@ class InstanceStorage
fd != fdclient
end
unless fdservice.nil?
service = @fd_to_ipcconnection[fdservice]
service.close
begin
if fdservice.nil?
Baguette::Log.debug "client #{fdclient} aleady has its service removed"
else
@service.remove_fd (fdservice)
@fd_to_ipcconnection = @fd_to_ipcconnection.select do |k, v|
service = @fd_to_ipcclient[fdservice]
@fd_to_ipcclient = @fd_to_ipcclient.select do |k, v|
k != fdservice
end
@is_client = @is_client.select do |fd,v| fd != fdservice end
# perform the close at the end
# on crash, this service still is removed from the list of listened fd
service.close
end
rescue e
Baguette::Log.error "remove_fd: 3 #{e}"
end
rescue e
Baguette::Log.error "in InstanceStorage#remove_fd: #{e}"
end
end
class Context
class_property service = IPC::SwitchingService.new service_name
class_property context = InstanceStorage.new service
end
# by default, listen on any IP address
server = TCPServer.new(host, port_to_listen)
service = IPC::SwitchingService.new service_name
service << server.fd
context = InstanceStorage.new service
server = TCPServer.new(Context.host, Context.port_to_listen)
Context.service << server.fd
def websocket_client_connection(client, context : InstanceStorage)
def websocket_client_connection(client)
request = HTTP::Request.from_io client
# pp! request
if Context.print_messages
pp! request
end
if request.nil?
raise "#REQUEST IS NIL"
@ -150,7 +192,7 @@ def websocket_client_connection(client, context : InstanceStorage)
headers = headers.map { |key, value| "#{key}: #{value[0]}\r\n" }.join
# requested service, fd
req_service = request.path.lchop
req_service = request.path.lchop.sub "ws/", ""
if req_service.empty?
client.close
return
@ -160,49 +202,59 @@ def websocket_client_connection(client, context : InstanceStorage)
# To that end, the client may send the name of the service it wants to reach with the prefix ".JSON".
if req_service.ends_with? ".JSON"
context.is_json[client.fd] = true
Context.context.is_json[client.fd] = true
req_service = req_service.gsub /.JSON$/, ""
else
context.is_json[client.fd] = false
Context.context.is_json[client.fd] = false
end
websocket_connection_procedure req_service, client.fd, context
# TODO: if trackerd, send the IP address of the client
# Hack to preserve the daemon naming convention.
if req_service == "tracker"
puts "tracker - sending the IP address"
puts "connection from #{client.remote_address}"
sfd = context.switchtable[client.fd]
req_service = "tracking"
end
websocket_connection_procedure req_service, client.fd
# If the requested service is trackingd, send the IP address of the client
if req_service == "tracking"
real_ip_address = request.headers["X-Real-IP"]? || client.remote_address.address
sfd = Context.context.switchtable[client.fd]
Baguette::Log.info "trackingd - sending the IP address #{real_ip_address} to fd #{sfd}"
# message = IPC::Message.from_json(JSON).to_packet
# => JSON has to include these attributes: mtype, utype, payload
# message = IPC::Message.new mtype, utype, payload
remote_address = client.remote_address.address
message = IPC::Message.new 1, 1.to_u8, "{\"ipaddress\": \"#{remote_address}\"}"
message = IPC::Message.new sfd, 1, 1.to_u8, "{\"ipaddress\": \"#{real_ip_address}\"}"
if Context.print_messages
Baguette::Log.info "to trackingd: #{message.to_s}"
end
serv = WrappedTCPFileDescriptor.new(fd: sfd, family: Socket::Family::INET)
serv.send message.to_packet
end
# puts "#{headers_header}\n#{headers.to_s}\r\n"
if Context.print_messages
Baguette::Log.info "to client: #{headers_header}\n#{headers.to_s}"
end
client.send "#{headers_header}\n#{headers.to_s}\r\n"
wsclient = WebSocket.new client
wsclient.on_pong do |m|
puts "pong #{m}"
Baguette::Log.debug "pong #{m}"
end
context.is_client[client.fd] = true
Context.context.is_client[client.fd] = true
# listen to the client's file descriptor
context.service << client.fd
Context.context.service << client.fd
# puts "#{CBLUE}new client: #{client.fd}#{CRESET}"
# registering the client into storing structures to avoid being garbage collected
context.fd_to_tcpsocket[client.fd] = client
context.fd_to_websocket[client.fd] = wsclient
Context.context.fd_to_tcpsocket[client.fd] = client
Context.context.fd_to_websocket[client.fd] = wsclient
end
def closing_client (fdclient : Int, context : InstanceStorage)
context.remove_fd fdclient
def closing_client (fdclient : Int)
Baguette::Log.warning "Closing client #{fdclient}"
Context.context.remove_fd fdclient
end
# first message from the client: requested service name
@ -210,101 +262,157 @@ end
# 2. listening on the service fd
# 3. bounding both file descriptors (through switchtable hash)
# 4. indicating that the client is connected (in is_client)
def websocket_connection_procedure (requested_service : String, clientfd : Int32, context : InstanceStorage)
def websocket_connection_procedure (requested_service : String, clientfd : Int32)
begin
# 2. establishing a connection to the service
newservice = IPC::Connection.new requested_service
context.fd_to_ipcconnection[newservice.fd] = newservice
# 1. establishing a connection to the service
newservice = IPC::Client.new requested_service
new_service_fd = newservice.fd.not_nil!
Context.context.fd_to_ipcclient[new_service_fd] = newservice
# 3. listening on the client fd and the service fd
context.service << newservice.fd
# 2. listening on the client fd and the service fd
Context.context.service << new_service_fd
# cannot perform automatic switching due to websockets headers
# future version of the libipc lib should include some workaround, probably
# service.switch.add fdclient, newservice.fd
# 4. bounding the client and the service fd
context.switchtable[clientfd] = newservice.fd
context.switchtable[newservice.fd] = clientfd
# 3. bounding the client and the service fd
Context.context.switchtable[clientfd] = new_service_fd
Context.context.switchtable[new_service_fd] = clientfd
# 5. the client is then connected, send it a message
context.is_client[clientfd] = true
context.is_client[newservice.fd] = false
# 4. the client is then connected, send it a message
Context.context.is_client[clientfd] = true
Context.context.is_client[new_service_fd] = false
rescue e
puts "#{CRED}Exception during connection to the service:#{CRESET} #{e}"
context.remove_fd clientfd
Baguette::Log.error "Exception during connection to the service: #{e}"
Context.context.remove_fd clientfd
end
end
def websocket_switching_procedure (activefd : Int, context : InstanceStorage)
class FragmentBuffer
property buffer : String = String.new
end
def websocket_switching_procedure (activefd : Int)
begin
if context.is_client[activefd]
# Baguette::Log.title "activefd is #{activefd}"
if Context.context.is_client[activefd]
# Baguette::Log.title "activefd #{activefd} is a client"
# The client is a WebSocket on top of a TCP connection
client = context.fd_to_tcpsocket[activefd]
wsclient = context.fd_to_websocket[activefd]
client = Context.context.fd_to_tcpsocket[activefd]
wsclient = Context.context.fd_to_websocket[activefd]
fb = FragmentBuffer.new
loop do
begin
message = wsclient.run_once
rescue e
puts "#{CRED}Exception (receiving a message)#{CRESET} #{e}"
context.remove_fd activefd
return
Baguette::Log.error "Exception (receiving a message) #{e}"
Context.context.remove_fd activefd
break
end
# Checking the internals of WebSocket, then the contained IO within, to know if there is still something to read in the socket.
still_something_to_read = ! wsclient.ws.io.empty?
if wsclient.closed?
# puts "#{CBLUE}client is closed#{CRESET}"
context.remove_fd client.fd
return
Baguette::Log.info "client #{activefd} is closing"
Context.context.remove_fd activefd
break
end
if message.nil?
puts "#{CRED}message is nil#{CRESET}"
context.remove_fd client.fd
return
Baguette::Log.error "message received from #{activefd} is nil"
Context.context.remove_fd activefd
if still_something_to_read
Baguette::Log.info "Still something to read, but #{activefd} was removed"
next
end
break
end
case message
when WebSocket::Error
puts "#{CRED}An error occured#{CRESET}"
context.remove_fd client.fd
Baguette::Log.error "An error occured with client #{activefd}"
Context.context.remove_fd activefd
if still_something_to_read
Baguette::Log.debug "Still something to read, but #{activefd} was removed"
next
end
return
when WebSocket::Ping
# puts "#{CBLUE}Received a ping message#{CRESET}"
next if still_something_to_read
Baguette::Log.debug "Received a ping message"
if still_something_to_read
Baguette::Log.debug "Still something to read"
next
end
break
when WebSocket::Pong
# puts "#{CBLUE}Received a pong message#{CRESET}"
next if still_something_to_read
Baguette::Log.debug "Received a pong message"
if still_something_to_read
Baguette::Log.debug "Still something to read"
next
end
break
when WebSocket::Close
# puts "#{CBLUE}Received a close message#{CRESET}"
context.remove_fd client.fd
return
when WebSocket::NotFinal
# puts "#{CBLUE}Received only part of a message#{CRESET}"
next if still_something_to_read
Baguette::Log.debug "Received a close message"
Context.context.remove_fd activefd
if still_something_to_read
Baguette::Log.debug "Still something to read"
next
end
break
when WebSocket::NotFinal
Baguette::Log.warning "Received only part of a message"
# TODO: check if the message is OK when multiplexing
# pp! message
fb.buffer = fb.buffer + message.message
if still_something_to_read
Baguette::Log.debug "Still something to read"
next
end
break
when Bytes
# TODO: when receiving a binary message
# we should test the format and maybe its content
# puts "#{CBLUE}Received a binary message#{CRESET}"
Baguette::Log.warning "Received a binary message (not supported)"
if still_something_to_read
Baguette::Log.info "Still something to read"
next
end
end
if context.is_json[activefd] && message.is_a?(String)
# In case there was a previous messagee within a fragment.
if fb.buffer.size > 0
Baguette::Log.warning "SHOULD reconstitute the message!!"
end
if message.is_a?(String) && fb.buffer.size > 0
Baguette::Log.warning "Reconstitute the message!!"
message = fb.buffer + message
fb.buffer = String.new
end
if Context.context.is_json[activefd] && message.is_a?(String)
if Context.print_messages
j = JSON.parse message
Baguette::Log.info "received from client #{activefd}"
pp! j["payload"]
end
message = IPC::Message.from_json(message).to_packet
end
# client => service
fdservice = context.switchtable[activefd]
fdservice = Context.context.switchtable[activefd]
# XXX: this is not a TCP fd, but since behind the scene this is compatible, I'm hacking a bit
# Also, I changed the "finalize" method of the TCPFileDescriptor class not to close the socket
# when the object is GC.
serv = WrappedTCPFileDescriptor.new(fd: fdservice, family: Socket::Family::INET)
#serv = context.fd_to_ipcconnection[fdservice]
#serv = Context.context.fd_to_ipcclient[fdservice]
serv.send message
break unless still_something_to_read
@ -312,14 +420,19 @@ def websocket_switching_procedure (activefd : Int, context : InstanceStorage)
end # loop over the remaining messages to read on the websocket
else
# service => client
fdclient = context.switchtable[activefd]
wsclient = context.fd_to_websocket[fdclient]
fdclient = Context.context.switchtable[activefd]
wsclient = Context.context.fd_to_websocket[fdclient]
serv = context.fd_to_ipcconnection[activefd]
serv = Context.context.fd_to_ipcclient[activefd]
message = serv.read
if context.is_json[fdclient]
if Context.context.is_json[fdclient]
buf = message.to_json
if Context.print_messages
j = JSON.parse buf
Baguette::Log.info "received from service #{activefd}"
pp! j["payload"]
end
else
buf = message.to_packet
end
@ -327,26 +440,26 @@ def websocket_switching_procedure (activefd : Int, context : InstanceStorage)
wsclient.send buf
end
rescue e
puts "#{CRED}Exception during message transfer:#{CRESET} #{e}"
if context.is_client[activefd]
closing_client activefd, context
Baguette::Log.error "Exception during message transfer: #{e}"
if Context.context.is_client[activefd]
closing_client activefd
else
clientfd = context.switchtable[activefd]
closing_client clientfd, context
clientfd = Context.context.switchtable[activefd]
closing_client clientfd
end
end
end
def sending_ping_messages(context : InstanceStorage)
context.fd_to_websocket.each do |fd, ws|
def sending_ping_messages
Context.context.fd_to_websocket.each do |fd, ws|
begin
ws.ping "hello from #{fd}"
rescue e
puts "#{CRED}Exception: #{e}#{CRESET}, already closed client #{fd}"
Baguette::Log.error "#{CRED}Exception: #{e}#{CRESET}, already closed client #{fd}"
begin
context.remove_fd fd
Context.context.remove_fd fd
rescue e
puts "#{CRED}Cannot remove #{fd} from clients: #{e}#{CRESET}"
Baguette::Log.error "#{CRED}Cannot remove #{fd} from clients: #{e}#{CRESET}"
end
end
end
@ -354,60 +467,57 @@ end
# Every few seconds, the service should trigger the timer
# Allowing the sending of Ping messages to clients
service.base_timer = timer_delay
Context.service.base_timer = Context.timer_delay
service.loop do |event|
case event
when IPC::Event::Timer
if verbosity > 0
puts "#{CORANGE}IPC::Event::Timer#{CRESET}"
end
sending_ping_messages context
when IPC::Event::Connection
if verbosity > 0
puts "#{CBLUE}IPC::Event::Connection#{CRESET}: #{event.fd}"
end
when IPC::Event::Disconnection
if verbosity > 0
puts "#{CBLUE}IPC::Event::Disconnection#{CRESET}: #{event.fd}"
end
when IPC::Event::ExtraSocket
if verbosity > 0
puts "#{CBLUE}IPC::Event::ExtraSocket#{CRESET}: #{event.fd}"
end
Context.service.loop do |event|
begin
case event
when IPC::Event::Timer
Baguette::Log.info "IPC::Event::Timer" if Context.print_timer
sending_ping_messages
when IPC::Event::Connection
Baguette::Log.debug "IPC::Event::Connection: #{event.fd}"
# 1. accept new websocket clients
if server.fd == event.fd
client = server.accept
begin
websocket_client_connection client, context
puts "#{CBLUE}new client:#{CRESET} #{client.fd}" unless verbosity == 0
rescue e
puts "Exception: #{CRED}#{e}#{CRESET}"
client.close
when IPC::Event::Disconnection
Baguette::Log.debug "IPC::Event::Disconnection: #{event.fd}"
when IPC::Event::ExtraSocket
Baguette::Log.debug "IPC::Event::ExtraSocket: #{event.fd}"
# 1. accept new websocket clients
if server.fd == event.fd
client = server.accept
begin
websocket_client_connection client
Baguette::Log.info "new client: #{client.fd}"
rescue e
Baguette::Log.error "Exception: #{e}"
client.close
end
next
end
next
# 2. active fd != server fd
activefd = event.fd
if activefd <= 0
Baguette::Log.error "faulty activefd: #{activefd}"
end
websocket_switching_procedure activefd
when IPC::Event::Switch
Baguette::Log.debug "IPC::Event::Switch: from fd #{event.fd}"
raise "Not implemented."
# IPC::Event::Message has to be the last entry
# because ExtraSocket and Switch inherit from Message class
when IPC::Event::MessageSent
Baguette::Log.error "IPC::Event::MessageSent: #{event.fd}"
when IPC::Event::MessageReceived
Baguette::Log.debug "IPC::Event::MessageReceived: #{event.fd}"
raise "Not implemented."
end
# 2. active fd != server fd
activefd = event.fd
websocket_switching_procedure activefd, context
when IPC::Event::Switch
if verbosity > 0
puts "\033[36mIPC::Event::Switch#{CRESET}: from fd #{event.fd}"
end
raise "Not implemented."
when IPC::Event::MessageSent
puts "Message sent, for #{event.origin}"
when IPC::Event::MessageReceived
if verbosity > 0
puts "#{CBLUE}IPC::Event::Message#{CRESET}: #{event.fd}"
end
raise "Not implemented."
rescue e
Baguette::Log.error "IPC loop final catch: #{e}"
end
end

View File

@ -5,19 +5,13 @@ require "../test-ws"
ws_uri = "ws://localhost:1234/pong.JSON"
message = IPC::Message.from_json(%({ "mtype" : 3, "utype" : 30, "payload" : "coucou" }))
pong = IPC::Connection.new "pong"
Benchmark.ips do |bm|
bm.report("connection") do
c = IPC::Connection.new "pong"
c = IPC::Client.new "pong"
end
bm.report("connection through websocket") do
tws = TestWS.new ws_uri
end
end
#puts "sleeping 5 seconds"
#sleep 5
#
#Benchmark.ips do |bm|
# bm.report("connection through websocket") do
# tws = TestWS.new ws_uri
# end
#end

View File

@ -2,25 +2,44 @@ require "benchmark"
require "ipc"
require "../test-ws"
ws_uri = "ws://localhost:1234/pong"
ws_uri = "ws://localhost:1234/pong"
ws_uri_json = "ws://localhost:1234/pong.JSON"
ws_pong = TestWS.new ws_uri
ws_pong_json = TestWS.new ws_uri_json
pong = IPC::Connection.new "pong"
pong = IPC::Client.new "pong"
pong.base_timer = 100_000
pong.timer = 100_000
Benchmark.ips do |bm|
bm.report("direct: round trip time") do
pong.send 42, "coucou"
m = pong.read
# puts "direct: round trip time"
pong.send pong.server_fd.not_nil!, 42, "coucou"
::loop do
event = pong.wait_event do |event|
end
case event
when IPC::Event::MessageSent
# OK
when IPC::Event::MessageReceived
# puts "message received"
break
else
puts "event: #{event}"
end
end
end
bm.report("web sockets: round trip time") do
ws_pong.send 42, "coucou"
m = ws_pong.read
end
#bm.report("web sockets: round trip time") do
# # puts "web sockets: round trip time"
# ws_pong.send 42, "coucou"
# m = ws_pong.read
#end
bm.report("web sockets + json: round trip time") do
# puts "web sockets + json: round trip time"
ws_pong_json.send 42, "coucou"
m = ws_pong_json.read
end

View File

@ -10,12 +10,12 @@ require "../src/lib_modifications.cr"
require "json"
class TestIPC
property ipcc : IPC::Connection
property ipcc : IPC::Client
property is_json : Bool
def initialize(service_name : String)
@is_json = uri.ends_with? ".JSON"
@ipcc = IPC::Connection.new service_name
@ipcc = IPC::Client.new service_name
end
# TODO
@ -60,9 +60,9 @@ class TestWS
m : String | Bytes
if @is_json
m = IPC::Message.new(1.to_u8, type.to_u8, data).to_json
m = IPC::Message.new(0, 1.to_u8, type.to_u8, data).to_json
else
m = IPC::Message.new(1.to_u8, type.to_u8, data).to_packet
m = IPC::Message.new(0, 1.to_u8, type.to_u8, data).to_packet
end
@ws.send m