iodine 0.7.48 → 0.7.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1718fc25cba1ab9a96c643a16e34413067b30b6706659ca77becf907a92bafe6
-  data.tar.gz: 1b3fc0945e54e6eedf7e1fa27956cecfe46e80c8a43078f305343a9eb3497f50
+  metadata.gz: 222b90cff0e761d924b2a3f7cba4f8914727cf87619602781a8a6ad3bc824e97
+  data.tar.gz: 3935cf93e8874392560949a07ad990d94501d4b31ddabb2e825ef3c6cbc41539
 SHA512:
-  metadata.gz: 70945896acf5a4497254bd631bcc427bde4051813c65d44d43567c0283a40c61a1ecefa547985ee481981a21e4bcf4d3380076fbc5816eed2fdc06a487553e64
-  data.tar.gz: bfba77e38f598db62a893ad356ad40485a9dfc768355357bc8242227991ecf8c24354f2f30e52d3afcf1d8f1c62b0fec15c7a2baec309c5b29d6b042918ff259
+  metadata.gz: 736cac5605c0234d77390184460acc6771abac50de525ea4df9cc48026e5b58312afc55d336026901373f123fab59d6baa86314cf2d5955da094c1bdc669c4ac
+  data.tar.gz: 2229bccab50dd9b530338c3c326c6b52f90983e06210c2beb88ecb27dd57a66fcfca005155ae46c35724e938b62e7aceb47cec939d1fe2ea724235fc48816466

data/.github/workflows/ruby.yml

@@ -0,0 +1,42 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Building iodine
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.3', '2.7', '3.0', '3.2']
+        os: [ubuntu-latest, macos-latest] # , windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby # see https://github.com/ruby/setup-ruby#versioning)
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Build and Test Iodine
+      run: |
+        echo CFLAGS = $CFLAGS
+        echo cflags = $cflags
+        echo HOME = $HOME
+        ruby -e 'puts Gem.default_dir'
+        bundle exec rake install
+#       env VERBOSE=1 bundle exec rspec --format documentation
+#    - name: Run tests
+#      run: bundle exec rake

data/CHANGELOG.md

@@ -6,6 +6,18 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+#### Change log v.0.7.50
+
+**Fix**: Fixes some compatibility issues with Rack 3.0. Credit to @taku0 for opening issue #131.
+
+**Fix**: Fixes compilation on Ruby 3.x - deprecation of `rc_cData`. Credit to Mohammad A. Ali (@oldmoe) for opening issue #128.
+
+#### Change log v.0.7.49
+
+**Fix**: Fixes an issue where named arguments for `subscribe` might not be properly recognized.
+
+**Security**: Fixes an issue where a malformed WebSocket continuation frame might crash a worker process. Credit to @fabio for exposing this issue and opening issue #127.
+
 #### Change log v.0.7.48 (2022-06-28)
 
 **Fix**: Fixes an issue with `pong` WebSocket frames when a client sends a WebSocket `ping`. Credit to Lucas Kuan (@lucaskuan) for finding this issue and for PR #124.

data/README.md

@@ -1,7 +1,7 @@
 # iodine - Why Settle for a fast HTTP / WebSocket Server with native Pub/Sub?
 
 [![Gem](https://img.shields.io/gem/dt/iodine.svg)](https://rubygems.org/gems/iodine)
-[![Build Status](https://travis-ci.org/boazsegev/iodine.svg?branch=master)](https://travis-ci.org/boazsegev/iodine)
+[![Build Status](https://github.com/boazsegev/iodine/actions/workflows/ruby.yml/badge.svg)](https://github.com/boazsegev/iodine/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/iodine.svg)](https://badge.fury.io/rb/iodine)
 [![Inline docs](http://inch-ci.org/github/boazsegev/iodine.svg?branch=master)](http://www.rubydoc.info/github/boazsegev/iodine/master/frames)
 [![GitHub](https://img.shields.io/badge/GitHub-Open%20Source-blue.svg)](https://github.com/boazsegev/iodine)
@@ -37,7 +37,7 @@ Since iodine wraps much of the [C facil.io framework](https://github.com/boazseg
 
 * Iodine is ideal for **Linux/Unix** based systems (i.e. macOS, Ubuntu, FreeBSD etc'), which are ideal for evented IO (while Windows and Solaris are better at IO *completion* events, which are very different).
 
-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.
+Iodine is a C extension for Ruby, developed and optimized for Ruby MRI 2.3 and up... it should support the whole Ruby 2.x and 3.x MRI family, but CI tests start at Ruby 2.3.
 
 **Note**: iodine does **not** support streaming when using Rack. It's recommended to avoid blocking the server when using `body.each` since the `each` loop will block the iodine's thread until it's finished and iodine won't send any data before the loop is done.
 

data/examples/config.ru

@@ -12,6 +12,9 @@
 #
 #      ab -c 2000 -t 5 -n 1000000 -k http://127.0.0.1:3000/
 #      wrk -c2000 -d5 -t12 http://localhost:3000/
+#
+# Test websocket echo using the browser. For example:
+#      ws = new WebSocket("ws://localhost:3000"); ws.onmessage = function(e) {console.log("Got message!"); console.log(e.data);}; ws.onclose = function(e) {console.log("closed")}; ws.onopen = function(e) {ws.send("hi");};
 
 
 # A simple router - Checks for Websocket Upgrade and answers HTTP.

data/examples/rack3.ru

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# adjusted from the code suggested by @taku0 (GitHub issue #131)
+require 'rack'
+require 'iodine'
+
+run { |env|
+  response = Rack::Response.new(nil, 204)
+  response.set_cookie('aaa', 'aaa')
+  response.set_cookie('bbb', 'bbb')
+  response.finish
+}

data/exe/iodine

@@ -16,6 +16,7 @@ begin
     end
   end
 rescue LoadError
+  puts "WARNING: The gam `rack` wasn't loaded before iodine started loading the rack app, using custom loader."
   module Iodine
     module Base
       module Rack
@@ -133,8 +134,9 @@ rescue LoadError
           #   end
           #
           #   run Heartbeat
-          def run(app)
-            @run = app
+          def run(app = nil, &block)
+            raise ArgumentError, "Both app and block given!" if app && block_given?
+            @run = app || block
           end
 
           # Takes a lambda or block that is used to warm-up the application.
@@ -214,28 +216,29 @@ module Iodine
 
       def self.try_file filename
         return nil unless File.exist? filename
-        return Iodine::Base::Rack::Builder.parse_file filename
+        result = Iodine::Base::Rack::Builder.parse_file filename
+        return result[0] if(result.is_a?(Array))
+        return result
       end
 
       def self.get_app_opts
-        app, opt = nil, nil
+        app, opt = nil, Hash.new
         filename = Iodine::DEFAULT_SETTINGS[:filename_]
         if filename
-          app, opt = try_file filename
-          app, opt = try_file "#{filename}.ru" unless opt
-          unless opt
+          app = try_file(filename)
+          app = try_file("#{filename}.ru") unless app
+          unless app
             puts "* Couldn't find #{filename}\n  testing for config.ru\n"
-            app, opt = try_file "config.ru"
+            app = try_file "config.ru"
           end
         else
-          app, opt = try_file "config.ru";
+          app = try_file "config.ru";
         end
 
-        unless opt
+        unless app
           puts "WARNING: Ruby application not found#{ filename ? " - missing both #{filename} and config.ru" : " - missing config.ru"}."
           if Iodine::DEFAULT_SETTINGS[:public]
             puts "         Running only static file service."
-            opt = Hash.new
             app = Proc.new { [404, {}, "Not Found!"] }
           else
             puts "\nERROR: Couldn't run Ruby application, check command line arguments."

data/ext/iodine/extconf.rb

@@ -1,4 +1,5 @@
 require 'mkmf'
+require 'fileutils'
 
 # Test polling
 def iodine_test_polling_support

data/ext/iodine/fio.c

@@ -3689,7 +3689,8 @@ closed:
   return -1;
 
 flush_rw_hook:
-  flushed = uuid_data(uuid).rw_hooks->flush(uuid, uuid_data(uuid).rw_udata);
+  if(uuid_data(uuid).rw_hooks)
+    flushed = uuid_data(uuid).rw_hooks->flush(uuid, uuid_data(uuid).rw_udata);
   fio_unlock(&uuid_data(uuid).sock_lock);
   if (!flushed)
     return 0;
@@ -3749,7 +3750,8 @@ size_t fio_flush_all(void) {
     return 0;
   size_t count = 0;
   for (uintptr_t i = 0; i <= fio_data->max_protocol_fd; ++i) {
-    if ((fd_data(i).open || fd_data(i).packet) && fio_flush(fd2uuid(i)) > 0)
+    if ((fd_data(i).open || fd_data(i).packet) &&
+        fd_data(i).rw_hooks && fio_flush(fd2uuid(i)) > 0)
       ++count;
   }
   return count;

data/ext/iodine/iodine_connection.c

@@ -518,10 +518,10 @@ static iodine_sub_args_s iodine_subscribe_args(int argc, VALUE *argv) {
     /* single argument must be a Hash / channel name */
     if (TYPE(argv[0]) == T_HASH) {
       rb_opt = argv[0];
-      ret.channel = rb_hash_aref(argv[0], to_id);
+      ret.channel = rb_hash_aref(argv[0], ID2SYM(to_id));
       if (ret.channel == Qnil || ret.channel == Qfalse) {
         /* temporary backport support */
-        ret.channel = rb_hash_aref(argv[0], channel_id);
+        ret.channel = rb_hash_aref(argv[0], ID2SYM(channel_id));
         if (ret.channel != Qnil) {
           FIO_LOG_WARNING("use of :channel in subscribe is deprecated.");
         }
@@ -546,13 +546,16 @@ static iodine_sub_args_s iodine_subscribe_args(int argc, VALUE *argv) {
   Check_Type(ret.channel, T_STRING);
 
   if (rb_opt) {
-    if (rb_hash_aref(rb_opt, as_id) == binary_id) {
+    VALUE tmp = Qnil;
+    if ((tmp = rb_hash_aref(rb_opt, ID2SYM(as_id))) != Qnil &&
+        TYPE(tmp) == T_SYMBOL && rb_sym2id(tmp) == binary_id) {
       ret.binary = 1;
     }
-    if (rb_hash_aref(rb_opt, match_id) == redis_id) {
+    if ((tmp = rb_hash_aref(rb_opt, ID2SYM(match_id))) != Qnil &&
+        TYPE(tmp) == T_SYMBOL && rb_sym2id(tmp) == redis_id) {
       ret.pattern = FIO_MATCH_GLOB;
     }
-    ret.block = rb_hash_aref(rb_opt, handler_id);
+    ret.block = rb_hash_aref(rb_opt, ID2SYM(handler_id));
     if (ret.block != Qnil) {
       IodineStore.add(ret.block);
     }
@@ -900,7 +903,8 @@ void iodine_connection_init(void) {
   IodineStore.add(RAWSymbol);
 
   // define the Connection Class and it's methods
-  ConnectionKlass = rb_define_class_under(IodineModule, "Connection", rb_cData);
+  ConnectionKlass =
+      rb_define_class_under(IodineModule, "Connection", rb_cObject);
   rb_define_alloc_func(ConnectionKlass, iodine_connection_data_alloc_c);
   rb_define_method(ConnectionKlass, "write", iodine_connection_write, 1);
   rb_define_method(ConnectionKlass, "close", iodine_connection_close, 0);

data/ext/iodine/iodine_http.c

@@ -477,6 +477,10 @@ Handling the HTTP response
 static int for_each_header_data(VALUE key, VALUE val, VALUE h_) {
   http_s *h = (http_s *)h_;
   // fprintf(stderr, "For_each - headers\n");
+  if (TYPE(val) == T_NIL)
+    return ST_CONTINUE;
+  if (TYPE(val) == T_ARRAY)
+    goto array_style_multi_value;
   if (TYPE(key) != T_STRING)
     key = IodineCaller.call(key, iodine_to_s_id);
   if (TYPE(key) != T_STRING)
@@ -515,6 +519,14 @@ static int for_each_header_data(VALUE key, VALUE val, VALUE h_) {
   fiobj_free(name);
   // no errors, return 0
   return ST_CONTINUE;
+
+array_style_multi_value:
+  for (size_t i = 0, end = RARRAY_LEN(val); i < end; ++i) {
+    if (for_each_header_data(key, RARRAY_AREF(val, i), h_) == ST_CONTINUE)
+      continue;
+    return ST_STOP;
+  }
+  return ST_CONTINUE;
 }
 
 // writes the body to the response object
@@ -940,15 +952,15 @@ intptr_t iodine_http_listen(iodine_connection_args_s args){
     support_xsendfile = 1;
   }
   IodineStore.add(args.handler);
-  #ifdef __MINGW32__
-    intptr_t uuid = http_listen(
+#ifdef __MINGW32__
+  intptr_t uuid = http_listen(
       args.port.data, args.address.data, .on_request = on_rack_request,
       .on_upgrade = on_rack_upgrade, .udata = (void *)args.handler,
       .timeout = args.timeout, .ws_timeout = args.ping,
       .ws_max_msg_size = args.max_msg, .max_header_size = args.max_headers,
       .on_finish = free_iodine_http, .log = args.log,
       .max_body_size = args.max_body, .public_folder = args.public.data);
-  #else
+#else
   intptr_t uuid = http_listen(
       args.port.data, args.address.data, .on_request = on_rack_request,
       .on_upgrade = on_rack_upgrade, .udata = (void *)args.handler,
@@ -956,7 +968,7 @@ intptr_t iodine_http_listen(iodine_connection_args_s args){
       .ws_max_msg_size = args.max_msg, .max_header_size = args.max_headers,
       .on_finish = free_iodine_http, .log = args.log,
       .max_body_size = args.max_body, .public_folder = args.public.data);
-  #endif
+#endif
   if (uuid == -1)
     return uuid;
 
@@ -1066,11 +1078,11 @@ intptr_t iodine_ws_connect(iodine_connection_args_s args) {
   FIOBJ url_tmp = FIOBJ_INVALID;
   if (!args.url.data) {
     url_tmp = fiobj_str_buf(64);
-  #ifndef __MINGW32__
+#ifndef __MINGW32__
     if (args.tls)
       fiobj_str_write(url_tmp, "wss://", 6);
     else
-  #endif
+#endif
       fiobj_str_write(url_tmp, "ws://", 5);
     if (!is_unix_socket) {
       fiobj_str_write(url_tmp, args.address.data, args.address.len);
@@ -1087,11 +1099,11 @@ intptr_t iodine_ws_connect(iodine_connection_args_s args) {
   }
 
 #ifdef __MINGW32__
-  intptr_t uuid = http_connect(
-      args.url.data, (is_unix_socket ? args.address.data : NULL),
-      .udata = request_data_create(&args),
-      .on_response = ws_client_http_connected,
-      .on_finish = ws_client_http_connection_finished);
+  intptr_t uuid =
+      http_connect(args.url.data, (is_unix_socket ? args.address.data : NULL),
+                   .udata = request_data_create(&args),
+                   .on_response = ws_client_http_connected,
+                   .on_finish = ws_client_http_connection_finished);
 #else
   intptr_t uuid = http_connect(
       args.url.data, (is_unix_socket ? args.address.data : NULL),

data/ext/iodine/iodine_mustache.c

@@ -558,7 +558,7 @@ void iodine_init_mustache(void) {
   rb_global_variable(&filename_id);
   rb_global_variable(&data_id);
   rb_global_variable(&template_id);
-  VALUE tmp = rb_define_class_under(IodineModule, "Mustache", rb_cData);
+  VALUE tmp = rb_define_class_under(IodineModule, "Mustache", rb_cObject);
   rb_define_alloc_func(tmp, iodine_mustache_data_alloc_c);
   rb_define_method(tmp, "initialize", iodine_mustache_new, -1);
   rb_define_method(tmp, "render", iodine_mustache_render, 1);

data/ext/iodine/iodine_store.c

@@ -132,7 +132,7 @@ struct IodineStorage_s IodineStore = {
 void iodine_storage_init(void) {
   fio_store_capa_require(&iodine_storage, 512);
   VALUE tmp =
-      rb_define_class_under(rb_cObject, "IodineObjectStorage", rb_cData);
+      rb_define_class_under(rb_cObject, "IodineObjectStorage", rb_cObject);
   VALUE storage_obj =
       TypedData_Wrap_Struct(tmp, &storage_type_struct, &iodine_storage);
   // rb_global_variable(&iodine_storage_obj);

data/ext/iodine/iodine_tls.c

@@ -241,7 +241,7 @@ void iodine_init_tls(void) {
   IODINE_MAKE_SYM(private_key);
   IODINE_MAKE_SYM(password);
 
-  IodineTLSClass = rb_define_class_under(IodineModule, "TLS", rb_cData);
+  IodineTLSClass = rb_define_class_under(IodineModule, "TLS", rb_cObject);
   rb_define_alloc_func(IodineTLSClass, iodine_tls_data_alloc_c);
   rb_define_method(IodineTLSClass, "initialize", iodine_tls_new, -1);
   rb_define_method(IodineTLSClass, "use_certificate",

data/ext/iodine/websocket_parser.h

@@ -453,6 +453,7 @@ static uint64_t websocket_consume(void *buffer, uint64_t len, void *udata,
       fprintf(stderr, "ERROR: WebSocket protocol error - unmasked data.\n");
 #endif
       websocket_on_protocol_error(udata);
+      return 0;
     }
     /* call callback */
     switch (pos[0] & 15) {

data/ext/iodine/websockets.c

@@ -127,6 +127,8 @@ struct ws_s {
   struct buffer_s buffer;
   /** data length (how much of the buffer actually used). */
   size_t length;
+  /** total data length (including continuation frames). */
+  size_t total_length;
   /** message buffer. */
   FIOBJ msg;
   /** latest text state. */
@@ -155,20 +157,24 @@ static void websocket_on_unwrapped(void *ws_p, void *msg, uint64_t len,
                                    char first, char last, char text,
                                    unsigned char rsv) {
   ws_s *ws = ws_p;
+  if (!ws)
+    return;
   if (last && first) {
     ws->on_message(ws, (fio_str_info_s){.data = msg, .len = len},
                    (uint8_t)text);
     return;
   }
+  if (ws->msg == FIOBJ_INVALID)
+    ws->msg = fiobj_str_buf(len);
+  ws->total_length += len;
   if (first) {
     ws->is_text = (uint8_t)text;
-    if (ws->msg == FIOBJ_INVALID)
-      ws->msg = fiobj_str_buf(len);
-    fiobj_str_resize(ws->msg, 0);
   }
   fiobj_str_write(ws->msg, msg, len);
   if (last) {
     ws->on_message(ws, fiobj_obj2cstr(ws->msg), ws->is_text);
+    fiobj_str_resize(ws->msg, 0);
+    ws->total_length = 0;
   }
 
   (void)rsv;
@@ -261,7 +267,7 @@ static void on_data(intptr_t sockfd, fio_protocol_s *ws_) {
       websocket_buffer_peek(ws->buffer.data, ws->length);
   const uint64_t raw_length = info.packet_length + info.head_length;
   /* test expected data amount */
-  if (ws->max_msg_size < raw_length) {
+  if (ws->max_msg_size < raw_length + ws->total_length) {
     /* too big */
     websocket_close(ws);
     return;

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.48'.freeze
+  VERSION = '0.7.50'.freeze
 end

data/lib/rack/handler/iodine.rb

@@ -1,7 +1,7 @@
 require 'iodine' unless defined?(::Iodine::VERSION)
 
 module Iodine
-  # Iodine's {Iodine::Rack} module provides a Rack complient interface (connecting Iodine to Rack) for an HTTP and Websocket Server.
+  # Iodine's {Iodine::Rack} module provides a Rack compliant interface (connecting Iodine to Rack) for an HTTP and Websocket Server.
   module Rack
 
     # Runs a Rack app, as par the Rack handler requirements.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.48
+  version: 0.7.50
 platform: ruby
 authors:
 - Boaz Segev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,9 +122,9 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -148,6 +148,7 @@ files:
 - examples/etag.ru
 - examples/hello.ru
 - examples/pubsub_engine.ru
+- examples/rack3.ru
 - examples/redis.ru
 - examples/shootout.ru
 - examples/sub-protocols.ru
@@ -245,7 +246,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Iodine 0.7.48.
+  Thank you for installing Iodine 0.7.50.
   Remember: if iodine supports your business, it's only fair to give value back (code contributions / donations).
 rdoc_options: []
 require_paths:
@@ -268,7 +269,7 @@ requirements:
 - Ruby >= 2.5.0 recommended.
 - TLS requires OpenSSL >= 1.1.0.
 - Or Windows with Ruby >= 3.0.0 build with MingW and MingW as compiler.
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: iodine - a fast HTTP / Websocket Server with Pub/Sub support, optimized for

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-arch:
-  - amd64
-  - arm64
-os:
-  - linux
-  # - osx
-before_install:
-  - gem install bundler -v 1.10.6
-  - bundle install
-rvm:
-  - 2.7.1
-  - 2.6.5
-  - 2.5.7
-  - 2.4.9
-  - 2.3.8
-  - 2.2.2
-notifications:
-  email: false
-sudo: required
-dist: xenial
-addons:
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - gcc
-script:
-  - echo CFLAGS = $CFLAGS
-  - echo cflags = $cflags
-  - bundle exec rake install
-  - env VERBOSE=1 bundle exec rspec --format documentation