iodine 0.7.27 → 0.7.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271062484b7941686926625d08f09463c7f723a94c9a43b1ef9a3b85c2b0e2e2
-  data.tar.gz: 7914c3a6e093c53bc2ff78ed1f6bc0f376d5dcb69bb2086187238fc9666894eb
+  metadata.gz: b76690963cd5e669bee41bd2859f60164c3a9ce4dbcc56706864fe05ce5db049
+  data.tar.gz: cebe9da9b5206d2229e1ecefac594c26ffb548e0ff25aefba5429f0724e8a97f
 SHA512:
-  metadata.gz: 9ef504553715d08e8152e2a5195368965bdb71c9d6d52157a4796c58cb5533527008d29fa7fb03788df89f3a3c80db4210b4721b062291f0993529aae26f1347
-  data.tar.gz: f7afb8f4c3a0fbe19e396798f917d2c3d039d8ff318b43be2c059b73ec8cb079c80f1d4daa777aafc7206360aee2373d767c3e1089676ffbc70226c6b294681f
+  metadata.gz: d9799ff98973047f253fafedcb3f5dc70b2e7f04409c0eb415093e1d984eea3996f6b2cd7ee2dc87fbdacd94653a95299857f4bae5146188c91e9a656add6b36
+  data.tar.gz: f422ac357af80a1a60a5ffe4940cf25afce4132aae41aae9f94048f8e6250e43b1d0aca09bedf4f9dbc1e7f733f5b7c6c3fab12d5fe4ef6cbaa48d4923196554

data/CHANGELOG.md

@@ -6,6 +6,10 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+#### Change log v.0.7.28
+
+**Fix**: fixed an issue where iodine would crush (or hang) if unprotected exceptions were raised within a response body's `each` loop. This also fixes Fiber support when streaming with Roda (note: iodine will concat the body in a buffer before sending it). Credit to @adam12 (Adam Daniels) both for exposing the issue (#70) and testing possible solutions.
+
 #### Change log v.0.7.27
 
 **Compatibility**: (`iodine`) fixed the HTTP request `SCRIPT_NAME` variable (in the Rack `env`) to default to the global environment variable `SCRIPT_NAME` when `SCRIPT_NAME` isn't root (`/`). Credit to @thexa4 (Max Maton) for exposing this compatibility concern (issue #68).

data/README.md

@@ -36,6 +36,8 @@ Iodine is an **evented** framework with a simple API that ports much of the [C f
 
 Iodine is a C extension for Ruby, developed and optimized for Ruby MRI 2.2.2 and up... it should support the whole Ruby 2.0 MRI family, but CI tests start at Ruby 2.2.2.
 
+**Note**: iodine does **not** support the streaming when using Rack. Streaming over Rack should be avoided on any server, WebSockets, SSE and `Range` requests should always be preferred. On iodine no data will be sent before the whole of the data is available.
+
 ## Iodine - a fast & powerful HTTP + Websockets server with native Pub/Sub
 
 Iodine includes a light and fast HTTP and Websocket server written in C that was written according to the [Rack interface specifications](http://www.rubydoc.info/github/rack/rack/master/file/SPEC) and the [Websocket draft extension](./SPEC-Websocket-Draft.md).

data/ext/iodine/fio.h

@@ -423,35 +423,43 @@ Logging and testing helpers
 #define FIO_LOG_LEVEL_DEBUG 5
 
 #if FIO_LOG_LENGTH_LIMIT > 128
-#define FIO_LOG_LENGTH_ON_STACK FIO_LOG_LENGTH_LIMIT
-#define FIO_LOG_LENGTH_BORDER (FIO_LOG_LENGTH_LIMIT - 32)
+#define FIO_LOG____LENGTH_ON_STACK FIO_LOG_LENGTH_LIMIT
+#define FIO_LOG____LENGTH_BORDER (FIO_LOG_LENGTH_LIMIT - 32)
 #else
-#define FIO_LOG_LENGTH_ON_STACK (FIO_LOG_LENGTH_LIMIT + 32)
-#define FIO_LOG_LENGTH_BORDER FIO_LOG_LENGTH_LIMIT
+#define FIO_LOG____LENGTH_ON_STACK (FIO_LOG_LENGTH_LIMIT + 32)
+#define FIO_LOG____LENGTH_BORDER FIO_LOG_LENGTH_LIMIT
 #endif
 /** The logging level */
 int __attribute__((weak)) FIO_LOG_LEVEL;
 
+#pragma weak FIO_LOG2STDERR
+void __attribute__((format(printf, 1, 0), weak))
+FIO_LOG2STDERR(const char *format, ...) {
+  char tmp___log[FIO_LOG____LENGTH_ON_STACK];
+  va_list argv;
+  va_start(argv, format);
+  int len___log = vsnprintf(tmp___log, FIO_LOG_LENGTH_LIMIT - 2, format, argv);
+  va_end(argv);
+  if (len___log <= 0 || len___log >= FIO_LOG_LENGTH_LIMIT - 2) {
+    if (len___log >= FIO_LOG_LENGTH_LIMIT - 2) {
+      memcpy(tmp___log + FIO_LOG____LENGTH_BORDER, "... (warning: truncated).",
+             25);
+      len___log = FIO_LOG____LENGTH_BORDER + 25;
+    } else {
+      fwrite("ERROR: log output error (can't write).\n", 39, 1, stderr);
+      return;
+    }
+  }
+  tmp___log[len___log++] = '\n';
+  tmp___log[len___log] = '0';
+  fwrite(tmp___log, len___log, 1, stderr);
+}
+
 #ifndef FIO_LOG_PRINT
 #define FIO_LOG_PRINT(level, ...)                                              \
   do {                                                                         \
     if (level <= FIO_LOG_LEVEL) {                                              \
-      char tmp___log[FIO_LOG_LENGTH_ON_STACK];                                 \
-      int len___log =                                                          \
-          snprintf(tmp___log, FIO_LOG_LENGTH_LIMIT - 2, __VA_ARGS__);          \
-      if (len___log <= 0 || len___log >= FIO_LOG_LENGTH_LIMIT - 2) {           \
-        if (len___log >= FIO_LOG_LENGTH_LIMIT - 2) {                           \
-          memcpy(tmp___log + FIO_LOG_LENGTH_BORDER,                            \
-                 "... (warning: truncated).", 25);                             \
-          len___log = FIO_LOG_LENGTH_BORDER + 25;                              \
-        } else {                                                               \
-          fwrite("ERROR: log output error (can't write).\n", 39, 1, stderr);   \
-          break;                                                               \
-        }                                                                      \
-      }                                                                        \
-      tmp___log[len___log++] = '\n';                                           \
-      tmp___log[len___log] = '0';                                              \
-      fwrite(tmp___log, len___log, 1, stderr);                                 \
+      FIO_LOG2STDERR(__VA_ARGS__);                                             \
     }                                                                          \
   } while (0)
 #define FIO_LOG_DEBUG(...)                                                     \

data/ext/iodine/iodine_caller.c

@@ -18,6 +18,9 @@ typedef struct {
   VALUE *argv;
   ID method;
   int exception;
+  VALUE (*protected_task)(VALUE tsk_);
+  VALUE (*each_func)(VALUE block_arg, VALUE data, int argc, VALUE *argv);
+  VALUE each_udata;
 } iodine_rb_task_s;
 
 /* printout backtrace in case of exceptions */
@@ -47,6 +50,13 @@ static void *iodine_handle_exception(void *ignr) {
   return (void *)Qnil;
 }
 
+/* calls the Ruby each method within the protection block */
+static VALUE iodine_ruby_caller_perform_block(VALUE tsk_) {
+  iodine_rb_task_s *task = (void *)tsk_;
+  return rb_block_call(task->obj, task->method, task->argc, task->argv,
+                       task->each_func, task->each_udata);
+}
+
 /* calls the Ruby method within the protection block */
 static VALUE iodine_ruby_caller_perform(VALUE tsk_) {
   iodine_rb_task_s *task = (void *)tsk_;
@@ -56,7 +66,8 @@ static VALUE iodine_ruby_caller_perform(VALUE tsk_) {
 /* wrap the function call in exception handling block (uses longjmp) */
 static void *iodine_protect_ruby_call(void *task_) {
   int state = 0;
-  VALUE ret = rb_protect(iodine_ruby_caller_perform, (VALUE)(task_), &state);
+  VALUE ret = rb_protect(((iodine_rb_task_s *)task_)->protected_task,
+                         (VALUE)(task_), &state);
   if (state) {
     iodine_handle_exception(NULL);
   }
@@ -98,6 +109,7 @@ static VALUE iodine_call(VALUE obj, ID method) {
       .argc = 0,
       .argv = NULL,
       .method = method,
+      .protected_task = iodine_ruby_caller_perform,
   };
   void *rv = iodine_enterGVL(iodine_protect_ruby_call, &task);
   return (VALUE)rv;
@@ -110,6 +122,25 @@ static VALUE iodine_call2(VALUE obj, ID method, int argc, VALUE *argv) {
       .argc = argc,
       .argv = argv,
       .method = method,
+      .protected_task = iodine_ruby_caller_perform,
+  };
+  void *rv = iodine_enterGVL(iodine_protect_ruby_call, &task);
+  return (VALUE)rv;
+}
+
+/** Calls a Ruby method on a given object, protecting against exceptions. */
+static VALUE iodine_call_block(VALUE obj, ID method, int argc, VALUE *argv,
+                               VALUE udata,
+                               VALUE(each_func)(VALUE block_arg, VALUE udata,
+                                                int argc, VALUE *argv)) {
+  iodine_rb_task_s task = {
+      .obj = obj,
+      .argc = argc,
+      .argv = argv,
+      .method = method,
+      .protected_task = iodine_ruby_caller_perform_block,
+      .each_func = each_func,
+      .each_udata = udata,
   };
   void *rv = iodine_enterGVL(iodine_protect_ruby_call, &task);
   return (VALUE)rv;
@@ -131,6 +162,8 @@ struct IodineCaller_s IodineCaller = {
     /** Calls a C function outside the GVL. */
     .leaveGVL = iodine_leaveGVL,
     /** Calls a Ruby method on a given object, protecting against exceptions. */
+    .call_with_block = iodine_call_block,
+    /** Calls a Ruby method on a given object, protecting against exceptions. */
     .call = iodine_call,
     /** Calls a Ruby method on a given object, protecting against exceptions. */
     .call2 = iodine_call2,

data/ext/iodine/iodine_caller.h

@@ -14,6 +14,10 @@ extern struct IodineCaller_s {
   VALUE (*call)(VALUE obj, ID method);
   /** Calls a Ruby method on a given object, protecting against exceptions. */
   VALUE (*call2)(VALUE obj, ID method, int argc, VALUE *argv);
+  /** Calls a Ruby method on a given object, protecting against exceptions. */
+  VALUE(*call_with_block)
+  (VALUE obj, ID method, int argc, VALUE *argv, VALUE udata,
+   VALUE (*block_func)(VALUE block_argv1, VALUE udata, int argc, VALUE *argv));
   /** Returns the GVL state flag. */
   uint8_t (*in_GVL)(void);
   /** Forces the GVL state flag. */

data/ext/iodine/iodine_defer.c

@@ -414,4 +414,6 @@ void iodine_defer_initialize(void) {
   fio_state_callback_add(FIO_CALL_ON_START, iodine_start_io_thread, NULL);
   /* stop the IO thread before exit */
   fio_state_callback_add(FIO_CALL_ON_FINISH, iodine_defer_on_finish, NULL);
+  /* kill IO thread even after a non-graceful iodine shutdown (force-quit) */
+  fio_state_callback_add(FIO_CALL_AT_EXIT, iodine_defer_on_finish, NULL);
 }

data/ext/iodine/iodine_http.c

@@ -514,7 +514,8 @@ static int for_each_header_data(VALUE key, VALUE val, VALUE h_) {
 }
 
 // writes the body to the response object
-static VALUE for_each_body_string(VALUE str, VALUE body_) {
+static VALUE for_each_body_string(VALUE str, VALUE body_, int argc,
+                                  VALUE *argv) {
   // fprintf(stderr, "For_each - body\n");
   // write body
   if (TYPE(str) != T_STRING) {
@@ -525,6 +526,8 @@ static VALUE for_each_body_string(VALUE str, VALUE body_) {
     fiobj_str_write((FIOBJ)body_, RSTRING_PTR(str), RSTRING_LEN(str));
   }
   return Qtrue;
+  (void)argc;
+  (void)argv;
 }
 
 static inline int ruby2c_response_send(iodine_http_request_handle_s *handle,
@@ -559,8 +562,8 @@ static inline int ruby2c_response_send(iodine_http_request_handle_s *handle,
     // fprintf(stderr, "Review body as for-each ...\n");
     handle->body = fiobj_str_buf(1);
     handle->type = IODINE_HTTP_SENDBODY;
-    rb_block_call(body, each_method_id, 0, NULL, for_each_body_string,
-                  (VALUE)handle->body);
+    IodineCaller.call_with_block(body, each_method_id, 0, NULL,
+                                 (VALUE)handle->body, for_each_body_string);
     // we need to call `close` in case the object is an IO / BodyProxy
     if (rb_respond_to(body, close_method_id))
       IodineCaller.call(body, close_method_id);

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.27'.freeze
+  VERSION = '0.7.28'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.27
+  version: 0.7.28
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -202,7 +202,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 'Thank you for installing Iodine 0.7.27.
+post_install_message: 'Thank you for installing Iodine 0.7.28.
 
 '
 rdoc_options: []