iodine 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f1e30dc08b1f6e19e59689fc251f50d1fe2de15377c36d9d6c0244a3a569352
-  data.tar.gz: 3ea55ee5a0c809ba5f3bbde618beef72a2dd151242f5aadbf2b68c0d3a403d68
+  metadata.gz: 6ab6a6656db6e8d26002bb029212f5d5d65b8cfeaddf5550416ce796dc16dc70
+  data.tar.gz: aa23fa7aab530a3b448c2a52e63dffe52c8d8aee1e9259b53c7523e81b379876
 SHA512:
-  metadata.gz: d0a8c45de3d93f4e7304a172b8111ea8cd0c5e727431fccb06982b930d596c571c3319819d72221dffe82cde14211bdefc1795ffc275fc8a5ba5255036bb81da
-  data.tar.gz: 537d0c329cf43df25ca7318b99d049cc590103e2b65bb90058dc246b6d0442404ec70eda473f6d97d6020f4b7f4163a270f0dcc2e8a9285298fd07ca4c712808
+  metadata.gz: 51e9ac58a76b225d55ad354de3a1c25b25f7b286e88e819c3d067ddbc568521bdd9b87d1da9b7528b24528ccf7517f4762ef11a39894dfcacda8584d812526ee
+  data.tar.gz: 2623b6ea0a7957f92d8686ca80c2f8e6bbf61cf1a04dd0b1d49e20f6e25aa8b6dfdf35f2faa68d9929ec67cecdce0618c57abdf584038713b2e26d75a316bcb2

data/CHANGELOG.md

@@ -6,6 +6,15 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+
+#### Change log v.0.7.8
+
+**Fix**: `unsubscribe` possibly wouldn't unsubscribe from a connection-bound subscription when instructed to do so. This was discovered during a review of a issue #45 submitted by @ojab.
+
+**Fix**: Documentation typo fixed by @ojab in PR#46.
+
+**Fix**: Documentation errors exposed by @ojab regarding the pub/sub specification draft and the WebSocket/SSE specification draft.
+
 #### Change log v.0.7.7
 
 **Fix**: (facil.io) fixed critical issue with cookies, where no more than a single cookie could be set (duplicate headers would be zeroed out before being set). Credit to @ojab for exposing the issue.

data/SPEC-PubSub-Draft.md

@@ -14,15 +14,17 @@ This should simplify the idiomatic `subscribe` / `publish` approach to real-time
 
 ## Pub/Sub handling
 
-Conforming Pub/Sub implementations **MUST** extend the WebSocket and SSE callback objects to implement the following pub/sub related methods (this requires that either the Pub/Sub implementation has knowledge about the Server OR that the Server has knowledge about the Pub/Sub implementation):
+Conforming Pub/Sub implementations **MUST** implement the following pub/sub related methods within the WebSocket/SSE `client` object (as defined in the Rack WebSockets / EventSource specification draft):
 
-* `subscribe(to, opt = {}) { |from, message| optional_block }` where `opt` is a Hash object that supports the following possible keys (undefined keys *SHOULD* be ignored):
+* `subscribe(to, opt = {}) { |from, message| optional_block }` where `to` is a named *channel* and `opt` is a Hash object that *SHOULD* support the following possible keys (unsupported keys *MUST* be ignored):
 
-    * `:match` indicates a matching algorithm should be applied. Possible values should include [`:redis`](https://github.com/antirez/redis/blob/398b2084af067ae4d669e0ce5a63d3bc89c639d3/src/util.c#L46-L167), [`:nats`](https://nats.io/documentation/faq/#wildcards) or [`:rabbitmq`](https://www.rabbitmq.com/tutorials/tutorial-five-ruby.html). Pub/Sub implementations should support some or all of these common pattern resolution schemes.
+    * `:match` indicates a matching algorithm should be applied to the `to` variable (`to` is a pattern).
     
-    * `:handler` is an alternative to the optional block. It should accept Proc like opbjects (objects that answer to `call(from, msg)`).
+        Possible values should include [`:redis`](https://github.com/antirez/redis/blob/398b2084af067ae4d669e0ce5a63d3bc89c639d3/src/util.c#L46-L167), [`:nats`](https://nats.io/documentation/faq/#wildcards) or [`:rabbitmq`](https://www.rabbitmq.com/tutorials/tutorial-five-ruby.html). Pub/Sub implementations *MAY* support none, some or all of these common pattern resolution schemes.
+    
+    * `:handler` is an alternative to the optional block. It should accept Proc like objects (objects that answer to `.call(from, msg)`).
 
-    * If an optional `block` (or `:handler`) is provided, if will be called when a publication was received. Otherwise, the message alone (**not** the channel data) should be sent directly to the WebSocket / EventSource client.
+    * If an optional `block` (or `:handler`) is provided, if will be called when a publication was received. Otherwise, the message alone (**not** the channel data) **MUST** be sent directly to the WebSocket / EventSource client.
 
     * `:as` accepts either `:text` or `:binary` Symbol objects.
 
@@ -30,19 +32,17 @@ Conforming Pub/Sub implementations **MUST** extend the WebSocket and SSE callbac
 
         This will dictate the encoding for outgoing WebSocket message when publications are directly sent to the client (as a text message or a binary blob). `:text` will be the default value for a missing `:as` option.
     
-    If the `subscribe` method is called within a WebSocket / SSE Callback object, the subscription must be associated with the Callback object and closed automatically when the connection is closed.
+    If a subscription to `to` already exists, it should be *replaced* by the new subscription (the old subscription should be canceled / unsubscribed).
 
-    If the `subscribe` method isn't called from within a connection, it should be considered a global (non connection related) subscription and a `block` or `:handler` **MUST** be provided. 
+    When the `subscribe` method is called within a WebSocket / SSE Callback object, the subscription must be closed automatically when the connection is closed.
     
-    The `subscribe` method must return a subscription object if a subscription was scheduled (not necessarily performed). If it's already known that the subscription would fail, the method should return `nil`.
-
-    The subscription object **MUST** support the method `close` (that will close the subscription).
+    The `subscribe` method **MUST** return `nil` on a known failure (i.e., when the connection is already closed), or any truthful value on success.
 
-    The subscription object **MAY** support the method `to_s` (that will return a String representing the stream / channel / pattern).
+    A global variation for this method (allowing global subscriptions to be created) **SHOULD** be made available as `Rack::PubSub.subscribe`.
 
-    The subscription object **MUST** support the method `==(str)` where `str` is a String object (that will return true if the subscription matches the String.
+    When the `subscribe` method isn't called from within a connection, it should be considered a global (non connection related) subscription and an exception should be raised if a `block` or `:handler` isn't provided by the user.
 
-    A global variation for this method (allowing global subscriptions to be created) MUST be defined as `Rack::PubSub.subscribe`.
+* `unsubscribe(from)` should cancel a subscription to the `from` named channel / pattern.
 
 * `publish(to, message, engine = nil)` (preferably supporting named arguments) where:
 

data/SPEC-Websocket-Draft.md

@@ -31,7 +31,7 @@ The historical use of `upgrade.websocket?` and `upgrade.websocket` (iodine 0.4.x
 
 WebSocket and EventSource connection upgrade and handling is performed using a Callback Object.
 
-The Callback Object should be a class (or an instance of such class) where **instances** implement any of the following callbacks:
+The Callback Object could be a any object which implements any of the following callbacks:
 
 * `on_open(client)` WILL be called once the connection had been established.
 
@@ -102,14 +102,12 @@ Server settings **MAY** (not required) be provided to allow for customization an
 
 * **Client**:
 
-    When a client decides to upgrade a request, they will place an appropriate Callback Object (either a class or an instance) in the `env['rack.upgrade']` Hash key.
+    When a client decides to upgrade a request, they will place an appropriate Callback Object in the `env['rack.upgrade']` Hash key.
 
 * **Server**:
 
     1. The server will review the `env` Hash *before* sending the response. If the `env['rack.upgrade']` was set, the server will perform the upgrade.
 
-        **If the callback handler is a Class object, the server will create a new instance of that class**.
-
     2. The server will send the correct response status and headers, as well as any headers present in the response object. The server will also perform any required housekeeping, such as closing the response body, if it exists.
 
          The response status provided by the response object shall be ignored and the correct response status shall be set by the server.

data/ext/iodine/iodine_connection.c

@@ -499,7 +499,7 @@ static VALUE iodine_pubsub_subscribe(int argc, VALUE *argv, VALUE self) {
       if (args.block) {
         IodineStore.remove(args.block);
       }
-      return Qnil; /* cannot subscribe a closed connection. */
+      return Qnil; /* cannot subscribe a closed / invalid connection. */
     }
     if (args.block == Qnil && args.binary) {
       args.block = Qtrue;
@@ -518,9 +518,8 @@ static VALUE iodine_pubsub_subscribe(int argc, VALUE *argv, VALUE self) {
       fio_unsubscribe(sub);
       fio_unlock(&c->lock);
       return Qnil;
-    } else {
-      iodine_sub_add(&c->subscriptions, sub);
     }
+    iodine_sub_add(&c->subscriptions, sub);
     fio_unlock(&c->lock);
   } else {
     fio_lock(&sub_lock);
@@ -546,20 +545,20 @@ Returns `false` if the subscription didn't exist.
 static VALUE iodine_pubsub_unsubscribe(VALUE self, VALUE name) {
   // clang-format on
   iodine_connection_data_s *c = NULL;
+  fio_lock_i *s_lock = &sub_lock;
+  fio_subhash_s *subs = &sub_global;
   VALUE ret;
-  if (TYPE(self) == T_MODULE) {
-    fio_lock(&sub_lock);
-    ret = iodine_sub_unsubscribe(&sub_global, IODINE_RSTRINFO(name));
-    fio_unlock(&sub_lock);
-  } else {
+  if (TYPE(self) != T_MODULE) {
     c = iodine_connection_validate_data(self);
-    if (!c) {
+    if (!c || c->info.uuid == -1) {
       return Qnil; /* cannot unsubscribe a closed connection. */
     }
-    fio_lock(&sub_lock);
-    ret = iodine_sub_unsubscribe(&sub_global, IODINE_RSTRINFO(name));
-    fio_unlock(&sub_lock);
+    s_lock = &c->lock;
+    subs = &c->subscriptions;
   }
+  fio_lock(s_lock);
+  ret = iodine_sub_unsubscribe(subs, IODINE_RSTRINFO(name));
+  fio_unlock(s_lock);
   return ret;
 }
 

data/ext/iodine/iodine_http.c

@@ -514,7 +514,7 @@ static inline int ruby2c_response_send(iodine_http_request_handle_s *handle,
   VALUE body = rb_ary_entry(rbresponse, 2);
   if (handle->h->status < 200 || handle->h->status == 204 ||
       handle->h->status == 304) {
-    if (rb_respond_to(body, close_method_id))
+    if (body && rb_respond_to(body, close_method_id))
       IodineCaller.call(body, close_method_id);
     body = Qnil;
     handle->type = IODINE_HTTP_NONE;
@@ -523,6 +523,7 @@ static inline int ruby2c_response_send(iodine_http_request_handle_s *handle,
   if (TYPE(body) == T_ARRAY) {
     if (RARRAY_LEN(body) == 0) { // only headers
       handle->type = IODINE_HTTP_EMPTY;
+      return 0;
     } else if (RARRAY_LEN(body) == 1) { // [String] is likely
       body = rb_ary_entry(body, 0);
       // fprintf(stderr, "Body was a single item array, unpacket to string\n");
@@ -634,7 +635,7 @@ static inline void *iodine_handle_request_in_GVL(void *handle_) {
   // close rack.io
   IodineRackIO.close(tmp);
   // test handler's return value
-  if (rbresponse == 0 || rbresponse == Qnil)
+  if (rbresponse == 0 || rbresponse == Qnil || TYPE(rbresponse) != T_ARRAY)
     goto internal_error;
   IodineStore.add(rbresponse);
 

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.7'.freeze
+  VERSION = '0.7.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -244,7 +244,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 'Thank you for installing Iodine 0.7.7.
+post_install_message: 'Thank you for installing Iodine 0.7.8.
 
 '
 rdoc_options: []