agoo 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f159d050def385814b8fecb4b3d28cd638bedaa658543881a74f2587957260
-  data.tar.gz: 72a2429c4eb44db0ddf7a033d7fde7a7fcdc112e032b9102340d7fb74a92f68b
+  metadata.gz: 4b76a004b8311f4a6966175ff830f0f38babc63efddde69c39a7b4ccc3d90b4a
+  data.tar.gz: 3356bf438fb1ebdcf6aa9c2d22c3536e5f5fe7c23cd909962effc965d269fc7d
 SHA512:
-  metadata.gz: bc963d7748c0406fa4e82133af064ec1c97607e3cc6c1695939fc5869b35d83f134b7ae440386f06531e9b65d27fcdb9bbc7db9122bdc5fdb1987f5f049703b3
-  data.tar.gz: fe94670810539c14abba9cdaba57843e1cbd0c8425b72d18d9ac036ee83fc95d513263cac5b2e0156dd94a8a908d70ea26e1fadd50334b7faa7bf5b94c88e38d
+  metadata.gz: 200da7c5f41b3822cdcb68a0ddd79e7c66a976e33da33245eafa9a66907166be3144874c889c98ac6891a0f2c46746019fcdf100e18df8f6d4a3884355dc7986
+  data.tar.gz: 1753cd691ec0bd0443a5a2d6e7af894ca56d705a9e6c3ebe645f4be7ae2156784bc94b4d3dcf6ecb17a5a4003831991120ebb19cade82435fb0599cf71d605e0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+### 2.4.0 - 2018-07-04
+
+- Rack hijack now supported.
+
+- Upgraded handler `on_error` now supported and called on Websocket or SSE errors.
+
 ### 2.3.0 - 2018-06-29
 
 - Added an `env` method to the upgrade (Websocket and SSE) client.

data/ext/agoo/con.c

@@ -152,6 +152,25 @@ page_response(Con c, Page p, char *hend) {
     return false;
 }
 
+static void
+push_error(Upgraded up, const char *msg, int mlen) {
+    if (NULL != up && Qnil != up->handler && up->on_error) {
+	Req	req = request_create(mlen);
+
+	if (NULL == req) {
+	    return;
+	}
+	memcpy(req->msg, msg, mlen);
+	req->msg[mlen] = '\0';
+	req->up = up;
+	req->method = ON_ERROR;
+	req->handler_type = PUSH_HOOK;
+	req->handler = up->handler;
+	upgraded_ref(up);
+	queue_push(&the_server.eval_queue, (void*)req);
+    }
+}
+
 // Returns:
 //  0 - when header has not been read
 //  message length - when length can be determined
@@ -487,6 +506,9 @@ con_ws_read(Con c) {
 	    if (0 == cnt) {
 		log_cat(&warn_cat, "Nothing to read. Client closed socket on connection %llu.", (unsigned long long)c->id);
 	    } else {
+		char	msg[1024];
+		int	len = snprintf(msg, sizeof(msg) - 1, "Failed to read WebSocket message. %s.", strerror(errno));
+		push_error(c->up, msg, len);
 		log_cat(&warn_cat, "Failed to read WebSocket message. %s.", strerror(errno));
 	    }
 	}
@@ -525,10 +547,16 @@ con_ws_read(Con c) {
 		}
 		break;
 	    case WS_OP_CONT:
-	    default:
+	    default: {
+		char	msg[1024];
+		int	len = snprintf(msg, sizeof(msg) - 1, "WebSocket op 0x%02x not supported on %llu.",
+				       op, (unsigned long long)c->id);
+
+		push_error(c->up, msg, len);
 		log_cat(&error_cat, "WebSocket op 0x%02x not supported on %llu.", op, (unsigned long long)c->id);
 		return true;
 	    }
+	    }
 	}
 	if (NULL != c->req) {
 	    mlen = c->req->mlen;
@@ -638,9 +666,15 @@ con_ws_write(Con c) {
     if (NULL == message) {
 	if (res->ping) {
 	    if (0 > (cnt = send(c->sock, ping_msg, sizeof(ping_msg) - 1, 0))) {
+		char	msg[1024];
+		int	len;
+
 		if (EAGAIN == errno) {
 		    return false;
 		}
+		len = snprintf(msg, sizeof(msg) - 1, "Socket error @ %llu.", (unsigned long long)c->id);
+		push_error(c->up, msg, len);
+		
 		log_cat(&error_cat, "Socket error @ %llu.", (unsigned long long)c->id);
 		ws_req_close(c);
 		res_destroy(res);
@@ -649,9 +683,14 @@ con_ws_write(Con c) {
 	    }
 	} else if (res->pong) {
 	    if (0 > (cnt = send(c->sock, pong_msg, sizeof(pong_msg) - 1, 0))) {
+		char	msg[1024];
+		int	len;
+
 		if (EAGAIN == errno) {
 		    return false;
 		}
+		len = snprintf(msg, sizeof(msg) - 1, "Socket error @ %llu.", (unsigned long long)c->id);
+		push_error(c->up, msg, len);
 		log_cat(&error_cat, "Socket error @ %llu.", (unsigned long long)c->id);
 		ws_req_close(c);
 		res_destroy(res);
@@ -691,9 +730,14 @@ con_ws_write(Con c) {
 	}
     }
     if (0 > (cnt = send(c->sock, message->text + c->wcnt, message->len - c->wcnt, 0))) {
+	char	msg[1024];
+	int	len;
+
 	if (EAGAIN == errno) {
 	    return false;
 	}
+	len = snprintf(msg, sizeof(msg) - 1, "Socket error @ %llu.", (unsigned long long)c->id);
+	push_error(c->up, msg, len);
 	log_cat(&error_cat, "Socket error @ %llu.", (unsigned long long)c->id);
 	ws_req_close(c);
 	
@@ -741,9 +785,14 @@ con_sse_write(Con c) {
 	}
     }
     if (0 > (cnt = send(c->sock, message->text + c->wcnt, message->len - c->wcnt, 0))) {
+	char	msg[1024];
+	int	len;
+
 	if (EAGAIN == errno) {
 	    return false;
 	}
+	len = snprintf(msg, sizeof(msg) - 1, "Socket error @ %llu.", (unsigned long long)c->id);
+	push_error(c->up, msg, len);
 	log_cat(&error_cat, "Socket error @ %llu.", (unsigned long long)c->id);
 	ws_req_close(c);
 	
@@ -923,7 +972,11 @@ poll_setup(Con c, struct pollfd *pp) {
     pp->revents = 0;
     pp++;
     for (; NULL != c; c = c->next) {
-	if (c->dead) {
+	if (c->dead || 0 == c->sock) {
+	    continue;
+	}
+	if (c->hijacked) {
+	    c->sock = 0;
 	    continue;
 	}
 	c->pp = pp;
@@ -1085,7 +1138,7 @@ con_loop(void *x) {
 		goto CON_CHECK;
 	    }
 	CON_CHECK:
-	    if (c->dead) {
+	    if (c->dead || 0 == c->sock) {
 		if (remove_dead_res(c)) {
 		    goto CON_RM;
 		}

data/ext/agoo/con.h

@@ -32,6 +32,7 @@ typedef struct _Con {
     double		timeout;
     bool		closing;
     bool		dead;
+    volatile bool	hijacked;
     Req			req;
     Res			res_head;
     Res			res_tail;

data/ext/agoo/method.h

@@ -20,6 +20,7 @@ typedef enum {
     ON_CLOSE	= 'X', // use for on_close callback
     ON_SHUTDOWN	= 'S', // use for on_shotdown callback
     ON_EMPTY	= 'E', // use for on_drained callback
+    ON_ERROR	= 'F', // use for on_error callback
 } Method;
 
 #endif // __AGOO_METHOD_H__

data/ext/agoo/request.c

@@ -26,6 +26,9 @@ static VALUE	post_val = Qundef;
 static VALUE	put_val = Qundef;
 static VALUE	query_string_val = Qundef;
 static VALUE	rack_errors_val = Qundef;
+static VALUE	rack_hijack_io_val = Qundef;
+static VALUE	rack_hijack_val = Qundef;
+static VALUE	rack_hijackq_val = Qundef;
 static VALUE	rack_input_val = Qundef;
 static VALUE	rack_logger_val = Qundef;
 static VALUE	rack_multiprocess_val = Qundef;
@@ -546,7 +549,7 @@ rack_logger(VALUE self) {
  * request is a more efficient encapsulation of the rack environment.
  */
 VALUE
-request_env(Req req) {
+request_env(Req req, VALUE self) {
     if (Qnil == req->env) {
 	volatile VALUE	env = rb_hash_new();
     
@@ -570,6 +573,17 @@ request_env(Req req) {
 	rb_hash_aset(env, rack_run_once_val, Qfalse);
 	rb_hash_aset(env, rack_logger_val, req_rack_logger(req));
 	rb_hash_aset(env, rack_upgrade_val, req_rack_upgrade(req));
+	rb_hash_aset(env, rack_hijackq_val, Qtrue);
+
+	// TBD should return IO on #call and set hijack_io on env object that
+	//  has a call method that wraps the req->res->con->sock then set the
+	//  sock to 0 or maybe con. mutex? env[rack.hijack_io] = IO.new(sock,
+	//  "rw") - maybe it works.
+	//
+	// set a flag on con to indicate it has been hijacked
+	// then set sock to 0 in con loop and destroy con
+	rb_hash_aset(env, rack_hijack_val, self);
+	rb_hash_aset(env, rack_hijack_io_val, Qnil);
 
 	req->env = env;
     }
@@ -590,7 +604,7 @@ to_h(VALUE self) {
     if (NULL == r) {
 	rb_raise(rb_eArgError, "Request is no longer valid.");
     }
-    return request_env(r);
+    return request_env(r, self);
 }
 
 /* Document-method: to_s
@@ -606,6 +620,33 @@ to_s(VALUE self) {
     return rb_funcall(h, rb_intern("to_s"), 0);
 }
 
+/* Document-method: call
+ *
+ * call-seq: call()
+ *
+ * Returns an IO like object and hijacks the connection.
+ */
+static VALUE
+call(VALUE self) {
+    Req			r = DATA_PTR(self);
+    VALUE		args[1];
+    volatile VALUE	io;
+
+    if (NULL == r) {
+	rb_raise(rb_eArgError, "Request is no longer valid.");
+    }
+    r->res->con->hijacked = true;
+
+    // TBD try basic IO first. If that fails define a socket class
+    // is a mode needed?
+
+    args[0] = INT2NUM(r->res->con->sock);
+
+    io = rb_class_new_instance(1, args, rb_cIO);
+    rb_hash_aset(r->env, rack_hijack_io_val, io);
+    
+    return io;
+}
 void
 request_destroy(Req req) {
     DEBUG_FREE(mem_req, req)
@@ -649,6 +690,7 @@ request_init(VALUE mod) {
     rb_define_method(req_class, "headers", headers, 0);
     rb_define_method(req_class, "body", body, 0);
     rb_define_method(req_class, "rack_logger", rack_logger, 0);
+    rb_define_method(req_class, "call", call, 0);
 
     new_id = rb_intern("new");
     
@@ -674,6 +716,9 @@ request_init(VALUE mod) {
     put_val = rb_str_new_cstr("PUT");				rb_gc_register_address(&put_val);
     query_string_val = rb_str_new_cstr("QUERY_STRING");		rb_gc_register_address(&query_string_val);
     rack_errors_val = rb_str_new_cstr("rack.errors");		rb_gc_register_address(&rack_errors_val);
+    rack_hijack_io_val = rb_str_new_cstr("rack.hijack_io");	rb_gc_register_address(&rack_hijack_io_val);
+    rack_hijack_val = rb_str_new_cstr("rack.hijack");		rb_gc_register_address(&rack_hijack_val);
+    rack_hijackq_val = rb_str_new_cstr("rack.hijack?");		rb_gc_register_address(&rack_hijackq_val);
     rack_input_val = rb_str_new_cstr("rack.input");		rb_gc_register_address(&rack_input_val);
     rack_logger_val = rb_str_new_cstr("rack.logger");		rb_gc_register_address(&rack_logger_val);
     rack_multiprocess_val = rb_str_new_cstr("rack.multiprocess");rb_gc_register_address(&rack_multiprocess_val);

data/ext/agoo/request.h

@@ -44,7 +44,7 @@ typedef struct _Req {
 extern Req	request_create(size_t mlen);
 extern void	request_init(VALUE mod);
 extern VALUE	request_wrap(Req req);
-extern VALUE	request_env(Req req);
+extern VALUE	request_env(Req req, VALUE self);
 extern void	request_destroy(Req req);
 
 #endif // __AGOO_REQUEST_H__

data/ext/agoo/server.c

@@ -56,6 +56,7 @@ static ID	call_id;
 static ID	each_id;
 static ID	on_close_id;
 static ID	on_drained_id;
+static ID	on_error_id;
 static ID	on_message_id;
 static ID	on_request_id;
 static ID	to_i_id;
@@ -508,7 +509,7 @@ static VALUE
 handle_rack_inner(void *x) {
     Req			req = (Req)x;
     Text		t;
-    volatile VALUE	env = request_env(req);
+    volatile VALUE	env = request_env(req, request_wrap(req));
     volatile VALUE	res = rb_funcall(req->handler, call_id, 1, env);
     volatile VALUE	hv;
     volatile VALUE	bv;
@@ -516,6 +517,10 @@ handle_rack_inner(void *x) {
     const char		*status_msg;
     int			bsize = 0;
 
+    if (req->res->con->hijacked) {
+	queue_wakeup(&the_server.con_queue);
+	return false;
+    }
     rb_check_type(res, T_ARRAY);
     if (3 != RARRAY_LEN(res)) {
 	rb_raise(rb_eArgError, "a rack call() response must be an array of 3 members.");
@@ -599,7 +604,7 @@ handle_rack_inner(void *x) {
 		break;
 	    }
 	    req->handler_type = PUSH_HOOK;
-	    upgraded_create(req->res->con, req->handler, request_env(req));
+	    upgraded_create(req->res->con, req->handler, request_env(req, Qnil));
 	    t->len = snprintf(t->text, 1024, "HTTP/1.1 101 %s\r\n", status_msg);
 	    t = ws_add_headers(req, t);
 	    break;
@@ -611,7 +616,7 @@ handle_rack_inner(void *x) {
 		break;
 	    }
 	    req->handler_type = PUSH_HOOK;
-	    upgraded_create(req->res->con, req->handler, request_env(req));
+	    upgraded_create(req->res->con, req->handler, request_env(req, Qnil));
 	    t = sse_upgrade(req, t);
 	    res_set_message(req->res, t);
 	    queue_wakeup(&the_server.con_queue);
@@ -708,6 +713,14 @@ handle_push_inner(void *x) {
     case ON_SHUTDOWN:
 	rb_funcall(req->handler, rb_intern("on_shutdown"), 1, req->up->wrap);
 	break;
+    case ON_ERROR:
+	if (req->up->on_msg) {
+	    volatile VALUE	rstr = rb_str_new(req->msg, req->mlen);
+
+	    rb_enc_associate(rstr, rb_ascii8bit_encoding());
+	    rb_funcall(req->handler, on_error_id, 2, req->up->wrap, rstr);
+	}
+	break;
     case ON_EMPTY:
 	rb_funcall(req->handler, on_drained_id, 1, req->up->wrap);
 	break;
@@ -1034,6 +1047,7 @@ server_init(VALUE mod) {
     each_id = rb_intern("each");
     on_close_id = rb_intern("on_close");
     on_drained_id = rb_intern("on_drained");
+    on_error_id = rb_intern("on_error");
     on_message_id = rb_intern("on_message");
     on_request_id = rb_intern("on_request");
     to_i_id = rb_intern("to_i");

data/ext/agoo/upgraded.c

@@ -351,6 +351,7 @@ upgraded_create(Con c, VALUE obj, VALUE env) {
 	up->on_close = rb_respond_to(obj, rb_intern("on_close"));
 	up->on_shut = rb_respond_to(obj, rb_intern("on_shutdown"));
 	up->on_msg = rb_respond_to(obj, rb_intern("on_message"));
+	up->on_error = rb_respond_to(obj, rb_intern("on_error"));
 	up->wrap = Data_Wrap_Struct(upgraded_class, NULL, NULL, up);
 	up->subjects = NULL;
 	up->prev = NULL;

data/ext/agoo/upgraded.h

@@ -24,6 +24,7 @@ typedef struct _Upgraded {
     bool		on_close;
     bool		on_shut;
     bool		on_msg;
+    bool		on_error;
 } *Upgraded;
 
 extern void	upgraded_init(VALUE mod);

data/lib/agoo/version.rb

@@ -1,5 +1,5 @@
 
 module Agoo
   # Agoo version.
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/test/hijack_test.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__)
+$root_dir = File.dirname(File.expand_path(File.dirname(__FILE__)))
+%w(lib ext).each do |dir|
+  $: << File.join($root_dir, dir)
+end
+
+require 'minitest'
+require 'minitest/autorun'
+require 'net/http'
+
+require 'oj'
+
+require 'agoo'
+
+class RackHandlerTest < Minitest::Test
+
+  class HijackHandler
+    def call(env)
+      io = env['rack.hijack'].call
+      io.write(%|HTTP/1.1 200 OK
+Content-Length: 11
+
+hello world|)
+      io.flush
+      [ -1, {}, []]
+    end
+  end
+
+  def test_hijack
+    begin
+      Agoo::Log.configure(dir: '',
+			  console: true,
+			  classic: true,
+			  colorize: true,
+			  states: {
+			    INFO: false,
+			    DEBUG: false,
+			    connect: false,
+			    request: false,
+			    response: false,
+			    eval: true,
+			  })
+
+      Agoo::Server.init(6471, 'root', thread_count: 1)
+
+      handler = HijackHandler.new
+      Agoo::Server.handle(:GET, "/hijack", handler)
+
+      Agoo::Server.start()
+
+      jack
+
+    ensure
+      Agoo.shutdown
+    end
+  end
+
+  def jack
+    uri = URI('http://localhost:6471/hijack')
+    req = Net::HTTP::Get.new(uri)
+    # Set the headers the way we want them.
+    req['Accept-Encoding'] = '*'
+    req['User-Agent'] = 'Ruby'
+    req['Host'] = 'localhost:6471'
+
+    res = Net::HTTP.start(uri.hostname, uri.port) { |h|
+      h.request(req)
+    }
+    content = res.body
+
+    assert_equal('hello world', content, 'content mismatch')
+  end
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agoo
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -107,6 +107,7 @@ files:
 - lib/agoo/version.rb
 - lib/rack/handler/agoo.rb
 - test/base_handler_test.rb
+- test/hijack_test.rb
 - test/log_test.rb
 - test/rack_handler_test.rb
 - test/static_test.rb
@@ -148,5 +149,6 @@ summary: An HTTP server
 test_files:
 - test/log_test.rb
 - test/rack_handler_test.rb
+- test/hijack_test.rb
 - test/base_handler_test.rb
 - test/static_test.rb