rage-iodine 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7dd77022028a6bdd65a929622793240c5c6d844ed91b46741a7964ef8b734b
-  data.tar.gz: a03c8b323b45d88304cb628201bce9a90d8eb31263b0bc7ebf303beb09c2ce25
+  metadata.gz: 15eb3d0d5e2834bc02a3e116dd07cd2fa36a73ad56ff7812579f1406a6d2874a
+  data.tar.gz: 3d9c061fe439e73a262a3c6ce0cd07f56d3ba2226b309caec539e202701e2249
 SHA512:
-  metadata.gz: e5d438ae9a488b9d814b43bb915adb2035bf64f094740d8ead2ef4a402f3e095ac894e50608bba819e7bb5abc26c8aff1cfe902022cebb8deb165976ff1095f3
-  data.tar.gz: fc9ae3246f6226feafca77dc6c0d52d73629c107daea5fffaa95bb89cfe4775b522d8222f90336e8dcc4e30a794a678a0dab316ebcb564c28d932107d485ede5
+  metadata.gz: 2b8d6ed6f9372e1cbfdd089de2e6d9941e2ef20da98ac5f47e603bcd5369ea4afb51b89fb7e80e01869f4752a8679bcf094d60f3a29930641c98fabe2c3481d9
+  data.tar.gz: 39f880d839140587dde14e5e1fa3b68bdbb0e35db97333de28a0d024d9d3c8b18cb3575098baeaa813cfc8eb03b459e3042bf6a70aeeec5f57b60557eafddb38

data/CHANGELOG.md

@@ -6,6 +6,42 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+#### Change log v.3.0.0 (2023-12-09)
+
+**Update**: Schedule request fibers.
+
+#### Change log v.2.3.0 (2023-11-27)
+
+**Fix**: Correctly handle non-persistent HTTP connections.
+
+#### Change log v.2.2.0 (2023-11-20)
+
+**Update**: Add `gen_request_tag` and `gen_timestamp` methods.
+
+**Fix**: Use separate buffer for writing.
+
+#### Change log v.2.1.1 (2023-11-09)
+
+**Fix**: Correctly update the fulfilled flag.
+
+**Fix**: Always send a response.
+
+#### Change log v.2.1.0 (2023-11-03)
+
+**Fix**: Return an error on timeouts.
+
+#### Change log v.2.0.0 (2023-10-31)
+
+**Update**: Parse params.
+
+#### Change log v.1.8.0 (2023-09-25)
+
+**Fix**: Free up memory when closing the protocol.
+
+#### Change log v.1.7.58 (2023-09-15)
+
+**Update**: Allow to pause and resume fiber requests.
+
 #### Change log v.0.7.57 (2023-09-04)
 
 **Fix**: Fixes possible name collision when loading gem (`.rb` vs. `.so` loading). Credit to @noraj (Alexandre ZANNI) for opening issue #148. Credit to @janbiedermann (Jan Biedermann) for discovering the root cause and offering a solution.

data/Gemfile

@@ -5,6 +5,7 @@ group :test do
   gem 'rspec'
   gem 'rack'
   gem 'http'
+  gem "rage-rb"
 end
 
 # Specify your gem's dependencies in iodine.gemspec

data/ext/iodine/http.c

@@ -737,6 +737,8 @@ static void http_resume_wrapper(intptr_t uuid, fio_protocol_s *p_, void *arg) {
   http_pause_handle_s *http = arg;
   http_s *h = http->h;
   h->udata = http->udata;
+  h->fiber = http->fiber;
+  h->subscription = http->subscription;
   http_vtable_s *vtbl = (http_vtable_s *)h->private_data.vtbl;
   if (http->task)
     http->task(h);
@@ -769,6 +771,8 @@ void http_pause(http_s *h, void (*task)(http_pause_handle_s *http)) {
       .uuid = p->uuid,
       .h = h,
       .udata = h->udata,
+      .fiber = h->fiber,
+      .subscription = h->subscription,
   };
   vtbl->http_on_pause(h, p);
   fio_defer(http_pause_wrapper, http, (void *)((uintptr_t)task));

data/ext/iodine/http.h

@@ -128,11 +128,8 @@ typedef struct {
   /** in case the request was paused, this will hold a Ruby fiber, that was scheduled during the request. */
   void *fiber;
 
-  /**
-   * in case the request needs to be paused, Iodine will subscribe to a channel with this name;
-   * once Ruby finishes processing, it will publish to this channel telling Iodine the request can be resumed.
-   */
-  FIOBJ request_id;
+  /** in case the request needs to be paused, Iodine will subscribe to a channel identified by this object. */
+  void *subscription;
 } http_s;
 
 /**
@@ -283,6 +280,8 @@ struct http_pause_handle_s {
   uintptr_t uuid;
   http_s *h;
   void *udata;
+  void *fiber;
+  void *subscription;
   void (*task)(http_s *);
   void (*fallback)(void *);
 };

data/ext/iodine/http_internal.h

@@ -97,10 +97,6 @@ HTTP request/response object management
 
 static inline void http_s_new(http_s *h, http_fio_protocol_s *owner,
                               http_vtable_s *vtbl) {
-  FIOBJ request_id = fiobj_str_buf(14);
-  fiobj_str_write(request_id, "req:", 4);
-  fiobj_str_write_i(request_id, (uint32_t)fio_rand64());
-
   *h = (http_s){
       .private_data =
           {
@@ -110,8 +106,7 @@ static inline void http_s_new(http_s *h, http_fio_protocol_s *owner,
           },
       .headers = fiobj_hash_new(),
       .received_at = fio_last_tick(),
-      .status = 200,
-      .request_id = request_id,
+      .status = 200
   };
 }
 
@@ -129,9 +124,9 @@ static inline void http_s_destroy(http_s *h, uint8_t log) {
   fiobj_free(h->cookies);
   fiobj_free(h->body);
   fiobj_free(h->params);
-  fiobj_free(h->request_id);
 
-  IodineStore.remove((VALUE)h->fiber);
+  h->fiber = NULL;
+  h->subscription = NULL;
 
   *h = (http_s){
     .private_data.vtbl = h->private_data.vtbl,

data/ext/iodine/iodine_http.c

@@ -60,7 +60,9 @@ static ID each_method_id;
 static ID attach_method_id;
 static ID iodine_call_proc_id;
 static ID fiber_result_var_id;
-static VALUE http_wait_directive;
+static ID fiber_id_method_id;
+static VALUE rb_cFiber;
+static ID schedule_method_id;
 
 static VALUE env_template_no_upgrade;
 static VALUE env_template_websockets;
@@ -118,7 +120,7 @@ typedef struct {
     IODINE_HTTP_XSENDFILE,
     IODINE_HTTP_EMPTY,
     IODINE_HTTP_ERROR,
-    IODINE_HTTP_WAIT,
+    IODINE_HTTP_DEFERRED,
   } type;
   enum iodine_upgrade_type_enum {
     IODINE_UPGRADE_NONE = 0,
@@ -470,9 +472,6 @@ static inline VALUE copy2env(iodine_http_request_handle_s *handle) {
       /* no TLS, no forwarding, assume `http`, which is the default */
     }
   }
-  {
-    rb_hash_aset(env, IODINE_REQUEST_ID, rb_str_new_cstr(fiobj_obj2cstr(handle->h->request_id).data));
-  }
 
   /* add all remaining headers */
   fiobj_each1(h->headers, 0, iodine_copy2env_task, (void *)env);
@@ -674,33 +673,36 @@ Handling HTTP requests
 static inline void *iodine_handle_request_in_GVL(void *handle_) {
   iodine_http_request_handle_s *handle = handle_;
   VALUE rbresponse = 0;
-  VALUE env = 0;
+  VALUE env = 0, tmp;
   http_s *h = handle->h;
   if (!h->udata)
     goto err_not_found;
 
-  // create / register env variable
-  env = copy2env(handle);
-  // create rack.io
-  VALUE tmp = IodineRackIO.create(h, env);
-  // pass env variable to handler
-  rbresponse =
-      IodineCaller.call2((VALUE)h->udata, iodine_call_proc_id, 1, &env);
-  // close rack.io
-  IodineRackIO.close(tmp);
+  if (handle->type == IODINE_HTTP_DEFERRED) {
+    // the deferred response is now ready so fetch it from the fiber
+    rbresponse = rb_ivar_get((VALUE)h->fiber, fiber_result_var_id);
+  } else {
+    // create / register env variable
+    env = copy2env(handle);
+    // create rack.io
+    tmp = IodineRackIO.create(h, env);
+    // pass env variable to handler
+    rbresponse = IodineCaller.call2((VALUE)h->udata, iodine_call_proc_id, 1, &env);
+    IodineStore.add(rbresponse);
+    // close rack.io
+    IodineRackIO.close(tmp);
+
+    // if there's a fiber in the http_s object means the request has to be deferred
+    if (h->fiber)
+      goto defer;
+  }
+
   // test handler's return value
   if (rbresponse == 0 || rbresponse == Qnil || TYPE(rbresponse) != T_ARRAY) {
     goto internal_error;
   }
 
   tmp = rb_ary_entry(rbresponse, 0);
-  // rack will return `[:__http_defer__, fiber_to_wait_on]` in case the request needs to be paused
-  if (TYPE(tmp) == T_SYMBOL && tmp == http_wait_directive) {
-    h->fiber = (void *)IodineStore.add(rb_ary_entry(rbresponse, 1));
-    goto defer;
-  }
-
-  IodineStore.add(rbresponse);
   // set response status
   if (TYPE(tmp) == T_STRING) {
     char *data = RSTRING_PTR(tmp);
@@ -739,8 +741,7 @@ static inline void *iodine_handle_request_in_GVL(void *handle_) {
   // review each header and write it to the response.
   rb_hash_foreach(response_headers, for_each_header_data, (VALUE)(h));
   // review for upgrade.
-  if ((intptr_t)h->status < 300 &&
-      ruby2c_review_upgrade(handle, rbresponse, env))
+  if (handle->type != IODINE_HTTP_DEFERRED && (intptr_t)h->status < 300 && ruby2c_review_upgrade(handle, rbresponse, env))
     goto external_done;
   // send the request body.
   if (ruby2c_response_send(handle, rbresponse, env))
@@ -749,68 +750,31 @@ static inline void *iodine_handle_request_in_GVL(void *handle_) {
 finish:
   IodineStore.remove(rbresponse);
   IodineStore.remove(env);
-  return NULL;
+  return (void *)rbresponse;
 
 external_done:
   IodineStore.remove(rbresponse);
   IodineStore.remove(env);
   handle->type = IODINE_HTTP_NONE;
-  return NULL;
+  return (void *)rbresponse;
 
 err_not_found:
   IodineStore.remove(rbresponse);
   IodineStore.remove(env);
   h->status = 404;
   handle->type = IODINE_HTTP_ERROR;
-  return NULL;
+  return (void *)rbresponse;
 
 internal_error:
   IodineStore.remove(rbresponse);
   IodineStore.remove(env);
   h->status = 500;
   handle->type = IODINE_HTTP_ERROR;
-  return NULL;
+  return (void *)rbresponse;
 
 defer:
   IodineStore.remove(env);
-  handle->type = IODINE_HTTP_WAIT;
-  return NULL;
-}
-
-// called once a request that was paused previously needs to be resumed
-static inline void *iodine_handle_deferred_request_in_GVL(void *handle_) {
-  iodine_http_request_handle_s *handle = handle_;
-  http_s *h = handle->h;
-
-  VALUE rbresponse = rb_ivar_get((VALUE)h->fiber, fiber_result_var_id);
-  VALUE tmp = rb_ary_entry(rbresponse, 0);
-
-  // set response status
-  if (TYPE(tmp) == T_STRING) {
-    char *data = RSTRING_PTR(tmp);
-    h->status = fio_atol(&data);
-  } else if (TYPE(tmp) == T_FIXNUM) {
-    h->status = FIX2ULONG(tmp);
-  } else {
-    goto internal_error;
-  }
-
-  // handle header copy from ruby land to C land.
-  VALUE response_headers = rb_ary_entry(rbresponse, 1);
-
-  // review each header and write it to the response.
-  rb_hash_foreach(response_headers, for_each_header_data, (VALUE)(h));
-
-  // send the request body.
-  if (ruby2c_response_send(handle, rbresponse, 0))
-    goto internal_error;
-
-  return NULL;
-
-internal_error:
-  h->status = 500;
-  handle->type = IODINE_HTTP_ERROR;
-  return NULL;
+  return (void *)rbresponse;
 }
 
 static inline void
@@ -856,10 +820,13 @@ static inline void http_resume_deferred_request_handler(http_s *h) {
   iodine_http_request_handle_s handle = (iodine_http_request_handle_s){
     .h = h,
     .upgrade = IODINE_UPGRADE_NONE,
+    .type = IODINE_HTTP_DEFERRED,
   };
 
-  IodineCaller.enterGVL((void *(*)(void *))iodine_handle_deferred_request_in_GVL,
-                        &handle);
+  IodineCaller.enterGVL((void *(*)(void *))iodine_handle_request_in_GVL, &handle);
+
+  IodineStore.remove((VALUE)h->fiber);
+  fio_unsubscribe((subscription_s *)h->subscription);
 
   iodine_perform_handle_action(handle);
 }
@@ -868,17 +835,26 @@ static inline void on_iodine_request_id_message(fio_msg_s *msg) {
   http_resume((http_pause_handle_s *)msg->udata1, http_resume_deferred_request_handler, NULL);
 }
 
-static inline void http_close_deferred_request_handler(void *sub) {
-  fio_unsubscribe((subscription_s *)sub);
-}
-
-// when Ruby sends a message into the `request_id` channel means the fiber attached to
-// to the `http_s h` var can be resumed
 static inline void http_pause_request_handler(http_pause_handle_s *s) {
-  subscription_s *sub = fio_subscribe(.channel = fiobj_obj2cstr(s->h->request_id),
+  VALUE fiber_id = rb_funcall((VALUE)s->fiber, fiber_id_method_id, 0);
+
+  subscription_s *sub = fio_subscribe(.channel = {0, RSTRING_LEN(fiber_id), RSTRING_PTR(fiber_id)},
                                       .on_message = on_iodine_request_id_message,
                                       .udata1 = (void *)s);
-  fio_uuid_link(s->uuid, (void *)sub, http_close_deferred_request_handler);
+
+  s->subscription = (void *)sub;
+}
+
+static VALUE fiber_request_block(RB_BLOCK_CALL_FUNC_ARGLIST(_, handle_)) {
+  VALUE fiber_id = rb_funcall(rb_fiber_current(), fiber_id_method_id, 0);
+
+  iodine_http_request_handle_s *handle = (iodine_http_request_handle_s *)handle_;
+  VALUE rbresponse = (VALUE)IodineCaller.enterGVL((void *(*)(void *))iodine_handle_request_in_GVL, handle);
+
+  fio_publish(.channel = {0, RSTRING_LEN(fiber_id), RSTRING_PTR(fiber_id)});
+  rb_ivar_set(rb_fiber_current(), fiber_result_var_id, rbresponse);
+
+  return rbresponse;
 }
 
 static void on_rack_request(http_s *h) {
@@ -886,11 +862,14 @@ static void on_rack_request(http_s *h) {
       .h = h,
       .upgrade = IODINE_UPGRADE_NONE,
   };
-  IodineCaller.enterGVL((void *(*)(void *))iodine_handle_request_in_GVL,
-                        &handle);
 
-  if (handle.type == IODINE_HTTP_WAIT) {
-    http_pause(handle.h, http_pause_request_handler);
+  VALUE fiber = rb_block_call(rb_cFiber, schedule_method_id, 0, NULL, fiber_request_block, (VALUE)&handle);
+
+  // the fiber encountered blocking IO and yielded - pause the request
+  if (rb_fiber_alive_p(fiber)) {
+    IodineStore.add(fiber);
+    h->fiber = (void *)fiber;
+    http_pause(h, http_pause_request_handler);
   } else {
     iodine_perform_handle_action(handle);
   }
@@ -1270,7 +1249,9 @@ void iodine_init_http(void) {
   attach_method_id = rb_intern("attach_fd");
   iodine_call_proc_id = rb_intern("call");
   fiber_result_var_id = rb_intern("@__result");
-  http_wait_directive = ID2SYM(rb_intern("__http_defer__"));
+  fiber_id_method_id = rb_intern("__get_id");
+  rb_cFiber = rb_const_get(rb_cObject, rb_intern("Fiber"));
+  schedule_method_id = rb_intern("schedule");
 
   IodineUTF8Encoding = rb_enc_find("UTF-8");
   IodineBinaryEncoding = rb_enc_find("binary");

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '2.3.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-iodine
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Boaz Segev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake