iodine 0.7.9 → 0.7.10

data/ext/iodine/iodine_mustache.c

@@ -65,7 +65,7 @@ b = a.map {|s| s.length }
 puts "static char *html_escape_strs[] = {", a.to_s.slice(1..-2) ,"};",
      "static uint8_t html_escape_len[] = {", b.to_s.slice(1..-2),"};"
 */
-static char *html_escape_strs[] = {
+static const char *html_escape_strs[] = {
     "�", "", "", "", "", "", "",
     "", "", "	", "
", "", "", "
",
     "", "", "", "", "", "", "",

data/ext/iodine/redis_engine.c

@@ -359,8 +359,8 @@ static void resp_on_sub_message(struct redis_engine_internal_s *i, FIOBJ msg) {
     if (FIOBJ_TYPE(msg) != FIOBJ_T_STRING || fiobj_obj2cstr(msg).len != 4 ||
         fiobj_obj2cstr(msg).data[0] != 'P') {
       FIO_LOG_WARNING("(redis) unexpected data format in "
-                      "subscription stream:");
-      FIO_LOG_STATE("     %s\n", fiobj_obj2cstr(msg).data);
+                      "subscription stream:\n     %s",
+                      fiobj_obj2cstr(msg).data);
     }
   } else {
     // FIOBJ *ary = fiobj_ary2ptr(msg);
@@ -840,10 +840,10 @@ FIO_IGNORE_MACRO(struct redis_engine_create_args args) {
   }
 
   if (!args.address.data || !args.address.len) {
-    args.address = (fio_str_info_s){.len = 9, .data = "localhost"};
+    args.address = (fio_str_info_s){.len = 9, .data = (char *)"localhost"};
   }
   if (!args.port.data || !args.port.len) {
-    args.port = (fio_str_info_s){.len = 4, .data = "6379"};
+    args.port = (fio_str_info_s){.len = 4, .data = (char *)"6379"};
   }
   redis_engine_s *r =
       fio_malloc(sizeof(*r) + args.port.len + 1 + args.address.len + 1 +

data/ext/iodine/websockets.c

@@ -526,15 +526,6 @@ typedef struct {
   void *udata;
 } websocket_sub_data_s;
 
-static void websocket_on_unsubscribe(void *u1, void *u2) {
-  websocket_sub_data_s *d = u2;
-  if (d->on_unsubscribe) {
-    d->on_unsubscribe(d->udata);
-  }
-  free(d);
-  (void)u1;
-}
-
 static inline void websocket_on_pubsub_message_direct_internal(fio_msg_s *msg,
                                                                uint8_t txt) {
   fio_protocol_s *pr =
@@ -563,7 +554,6 @@ static inline void websocket_on_pubsub_message_direct_internal(fio_msg_s *msg,
     break;
   }
   if (pre_wrapped) {
-    // fprintf(stderr, "INFO: WebSocket Pub/Sub optimized for broadcast\n");
     fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
     goto finish;
   }
@@ -607,6 +597,25 @@ static void websocket_on_pubsub_message(fio_msg_s *msg) {
   fio_protocol_unlock(pr, FIO_PR_LOCK_TASK);
 }
 
+static void websocket_on_unsubscribe(void *u1, void *u2) {
+  websocket_sub_data_s *d = u2;
+  if (d->on_unsubscribe) {
+    d->on_unsubscribe(d->udata);
+  }
+
+  if ((intptr_t)d->on_message == (intptr_t)WEBSOCKET_OPTIMIZE_PUBSUB) {
+    websocket_optimize4broadcasts(WEBSOCKET_OPTIMIZE_PUBSUB, 0);
+  } else if ((intptr_t)d->on_message ==
+             (intptr_t)WEBSOCKET_OPTIMIZE_PUBSUB_TEXT) {
+    websocket_optimize4broadcasts(WEBSOCKET_OPTIMIZE_PUBSUB_TEXT, 0);
+  } else if ((intptr_t)d->on_message ==
+             (intptr_t)WEBSOCKET_OPTIMIZE_PUBSUB_BINARY) {
+    websocket_optimize4broadcasts(WEBSOCKET_OPTIMIZE_PUBSUB_BINARY, 0);
+  }
+  free(d);
+  (void)u1;
+}
+
 /**
  * Returns a subscription ID on success and 0 on failure.
  */
@@ -621,18 +630,28 @@ uintptr_t websocket_subscribe(struct websocket_subscribe_s args) {
       .on_message = args.on_message,
       .on_unsubscribe = args.on_unsubscribe,
   };
-  subscription_s *sub = fio_subscribe(
-          .channel = args.channel, .match = args.match,
-          .on_unsubscribe = websocket_on_unsubscribe,
-          .on_message =
-              (args.on_message
-                   ? websocket_on_pubsub_message
-                   : args.force_binary
-                         ? websocket_on_pubsub_message_direct_bin
-                         : args.force_text
-                               ? websocket_on_pubsub_message_direct_txt
-                               : websocket_on_pubsub_message_direct),
-          .udata1 = (void *)args.ws->fd, .udata2 = d);
+  void (*handler)(fio_msg_s *) = websocket_on_pubsub_message;
+  if (!args.on_message) {
+    intptr_t br_type;
+    if (args.force_binary) {
+      br_type = WEBSOCKET_OPTIMIZE_PUBSUB_BINARY;
+      handler = websocket_on_pubsub_message_direct_bin;
+    } else if (args.force_text) {
+      br_type = WEBSOCKET_OPTIMIZE_PUBSUB_TEXT;
+      handler = websocket_on_pubsub_message_direct_txt;
+    } else {
+      br_type = WEBSOCKET_OPTIMIZE_PUBSUB;
+      handler = websocket_on_pubsub_message_direct;
+    }
+    websocket_optimize4broadcasts(br_type, 1);
+    d->on_message =
+        (void (*)(ws_s *, fio_str_info_s, fio_str_info_s, void *))br_type;
+  }
+  subscription_s *sub =
+      fio_subscribe(.channel = args.channel, .match = args.match,
+                    .on_unsubscribe = websocket_on_unsubscribe,
+                    .on_message = handler, .udata1 = (void *)args.ws->fd,
+                    .udata2 = d);
   if (!sub) {
     /* don't free `d`, return (`d` freed by fio_subscribe) */
     return 0;

data/ext/iodine/websockets.h

@@ -152,19 +152,11 @@ void websocket_unsubscribe(ws_s *ws, uintptr_t subscription_id);
 /**
  * Enables (or disables) broadcast optimizations.
  *
- * When using WebSocket pub/sub system is originally optimized for either
- * non-direct transmission (messages are handled by callbacks) or direct
- * transmission to 1-3 clients per channel (on average), meaning that the
- * majority of the messages are meant for a single recipient (or multiple
- * callback recipients) and only some are expected to be directly transmitted to
- * a group.
+ * This is performed automatically by the `websocket_subscribe` function.
+ * However, this function is provided for enabling the pub/sub metadata based
+ * optimizations for external connections / subscriptions.
  *
- * However, when most messages are intended for direct transmission to more than
- * 3 clients (on average), certain optimizations can be made to improve memory
- * consumption (minimize duplication or WebSocket network data).
- *
- * This function allows enablement (or disablement) of these optimizations.
- * These optimizations include:
+ * This function allows enablement (or disablement) of these optimizations:
  *
  * * WEBSOCKET_OPTIMIZE_PUBSUB - optimize all direct transmission messages,
  *                               best attempt to detect Text vs. Binary data.
@@ -174,6 +166,15 @@ void websocket_unsubscribe(ws_s *ws, uintptr_t subscription_id);
  * Note: to disable an optimization it should be disabled the same amount of
  * times it was enabled - multiple optimization enablements for the same type
  * are merged, but reference counted (disabled when reference is zero).
+ *
+ * Note2: The pub/sub metadata type ID will match the optimnization type
+ * requested (i.e., `WEBSOCKET_OPTIMIZE_PUBSUB`) and the optimized data is a
+ * FIOBJ String containing a pre-encoded WebSocket packet ready to be sent.
+ * i.e.:
+ *
+ *     FIOBJ pre_wrapped = (FIOBJ)fio_message_metadata(msg,
+ *                               WEBSOCKET_OPTIMIZE_PUBSUB);
+ *     fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
  */
 void websocket_optimize4broadcasts(intptr_t type, int enable);
 

data/iodine.gemspec

@@ -31,8 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2' # Because earlier versions had been discontinued
 
-  spec.add_dependency 'rack', '>= 1.0', '< 3.0'
-
   spec.requirements << 'A Unix based system: Linux / macOS / BSD.'
   spec.requirements << 'An updated C compiler.'
   spec.requirements << 'Ruby >= 2.2.2 required for Rack 2.'

data/lib/iodine.rb

@@ -63,6 +63,10 @@ module Iodine
     #
     # This is recommended, see {Iodine::Rack::Utils} for details.
     def self.patch_rack
+      begin
+        require 'rack'
+      rescue LoadError => e
+      end
     ::Rack::Utils.class_eval do
       Iodine::Base::MonkeyPatch::RackUtils.methods(false).each do |m|
         ::Rack::Utils.define_singleton_method(m,

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.9'.freeze
+  VERSION = '0.7.10'.freeze
 end

data/lib/rack/handler/iodine.rb

@@ -24,13 +24,11 @@ ENV['RACK_HANDLER'] = 'iodine'
 begin
   require 'rack/handler' unless defined?(Rack::Handler)
   Rack::Handler::WEBrick = ::Iodine::Rack # Rack::Handler.get(:iodine)
-rescue Exception
-
+rescue LoadError
 end
 
 begin
   ::Rack::Handler.register('iodine', 'Iodine::Rack') if defined?(::Rack::Handler)
   ::Rack::Handler.register('Iodine', 'Iodine::Rack') if defined?(::Rack::Handler)
-rescue Exception
-
+rescue StandardError
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,34 +111,20 @@ files:
 - Rakefile
 - SPEC-PubSub-Draft.md
 - SPEC-Websocket-Draft.md
-- bin/config.ru
 - bin/console
-- bin/echo
-- bin/http-big
-- bin/http-hello
-- bin/http-playground
-- bin/mustache.rb
-- bin/playground
+- bin/info.md
+- bin/mustache_bench.rb
 - bin/poc/Gemfile.lock
 - bin/poc/README.md
 - bin/poc/config.ru
 - bin/poc/gemfile
 - bin/poc/www/index.html
-- bin/raw-rbhttp
-- bin/raw-rbhttp-em
-- bin/raw_broadcast
-- bin/test_with_faye
-- bin/updated api
-- bin/ws-broadcast
-- bin/ws-echo
 - examples/config.ru
 - examples/echo.ru
 - examples/hello.ru
-- examples/info.md
 - examples/pubsub_engine.ru
 - examples/redis.ru
 - examples/shootout.ru
-- examples/test_template.mustache
 - exe/iodine
 - ext/iodine/extconf.rb
 - ext/iodine/fio.c
@@ -244,7 +210,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 'Thank you for installing Iodine 0.7.9.
+post_install_message: 'Thank you for installing Iodine 0.7.10.
 
 '
 rdoc_options: []

data/bin/config.ru

@@ -1,97 +0,0 @@
-require 'benchmark'
-require 'rack/sendfile'
-require 'rack/lint'
-
-# There are a number of possible applications to run in this file,
-# because I use it to test stuff.
-#
-# This value (app) sets which of the different applications will run.
-#
-# Valid values are "hello", "slow" (debugs env values), "simple"
-app = 'hello'
-
-# This is a simple Hello World Rack application, for benchmarking.
-HELLO_RESPONSE = [200, { 'Content-Type'.freeze => 'text/html'.freeze,
-        'Content-Length'.freeze => '16'.freeze }.freeze,
- ['Hello from Rack!'.freeze]].freeze
-
-hello = proc do |_env|
-  HELLO_RESPONSE
-end
-
-slow = proc do |env|
-  request = Rack::Request.new(env)
-  # Benchmark.bm do |bm|
-  #   bm.report('Reading from env Hash to a string X 1000') { 1000.times { out = "ENV:\r\n#{env.to_a.map { |h| "#{h[0]}: #{h[1]}" } .join "\n"}\n" } }
-  #   bm.report('Creating the Rack::Request (can\'t repeat)') { 1.times { request = Rack::Request.new(env) } }
-  # end
-  if request.path_info == '/source'.freeze
-    [200, { 'X-Sendfile' => File.expand_path(__FILE__) }, []]
-  elsif request.path_info == '/file'.freeze
-    [200, { 'X-Header' => 'This was a Rack::Sendfile response' }, File.open(__FILE__)]
-  else
-    out = "ENV:\n<br/>\n#{env.to_a.map { |h| "#{h[0]}: #{h[1]}" } .join "\n<br/>\n"}\n<br/>\n"
-    out += "\n<br/>\nRequest Path: #{request.path_info}\n<br/>\nParams:\n<br/>\n#{request.params.to_a.map { |h| "#{h[0]}: #{h[1]}" } .join "\n<br/>\n"}\n<br/>\n" unless request.params.empty?
-    [200, { 'Content-Type'.freeze => 'text/html'.freeze,
-            'Content-Length'.freeze => out.length.to_s },
-     [out]]
- end
-end
-
-simple = proc do |env|
-  request = Rack::Request.new(env)
-  if request.path_info == '/source'.freeze
-    [200, { 'X-Sendfile' => File.expand_path(__FILE__) }, []]
-  elsif request.path_info == '/file'.freeze
-    [200, { 'X-Header' => 'This was a Rack::Sendfile response' }, File.open(__FILE__)]
-  else
-    [200, { 'Content-Type'.freeze => 'text/html'.freeze,
-            'Content-Length'.freeze => request.path_info.length.to_s },
-     [request.path_info]]
- end
-end
-
-logo_png = nil
-
-big = proc do |_env|
-  logo_png ||= IO.binread '../logo.png'
-  [200, { 'Content-Length'.freeze => logo_png.length.to_s , 'Content-Type'.freeze => 'image/png'.freeze}, [logo_png]]
-end
-
-bigX = proc do |_env|
-  logo_png ||= IO.binread '../logo.png'
-  [200, { 'Content-Length'.freeze => logo_png.length.to_s , 'Content-Type'.freeze => 'image/png'.freeze, 'X-Sendfile'.freeze => '../logo.png'.freeze}, [logo_png]]
-end
-
-case app
-when 'simple'
-  use Rack::Sendfile
-  run simple
-when 'hello'
-  run hello
-when 'big'
-  run big
-when 'bigX'
-  run bigX
-when 'slow'
-  use Rack::Lint
-  run slow
-else
-  run hello
-end
-
-# ab -n 1000000 -c 2000 -k http://127.0.0.1:3000/
-# wrk -c400 -d5 -t12 http://localhost:3000/
-#
-# ab -n 1000000 -c 2000 -r http://127.0.0.1:3000/
-# wrk -c400 -d5 -t12 -H"Connection: close" http://localhost:3000/
-#
-# def cycle
-#   puts `wrk -c4000 -d5 -t12 http://localhost:3000/`
-#   sleep(2)
-#   puts `wrk -c4000 -d5 -t12 http://localhost:3000/source`
-#   sleep(3)
-#   puts `wrk -c200 -d5 -t12 http://localhost:3000/file`
-#    true
-# end
-# sleep(10) while cycle

data/bin/echo

@@ -1,46 +0,0 @@
-#!/usr/bin/env ruby
-
-# this will compile Iodine and run an echo server.
-
-# # test using:
-# telnet localhost 3000
-
-Dir.chdir(File.expand_path(File.join('..', '..'), __FILE__))
-puts `rake clean`
-puts `rake compile`
-
-require 'benchmark'
-$LOAD_PATH.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__)
-require 'bundler/setup'
-require 'iodine'
-
-class EchoProtocol
-  @timeout = 10
-
-  def self.on_start
-    puts '* Echo service is now running.'
-  end
-
-  def on_open
-    puts 'New connection'
-  end
-
-  def ping
-    write "-- are you there?\n"
-  end
-
-  # `on_message` is an optional alternative to the `on_data` callback.
-  # `on_message` has a 1Kb buffer that recycles itself for memory optimization.
-  def on_message(buffer)
-    # writing will never block and will use a buffer written in C when needed.
-    write! "Echo: #{buffer}"
-    puts buffer.dump
-    close if buffer =~ /^bye[\r\n]/i
-  end
-end
-
-# create the server object and setup any settings we might need.
-Iodine.listen 3000, EchoProtocol
-Iodine.threads = 10
-# server.processes = 1
-Iodine.start

data/bin/http-big

@@ -1,63 +0,0 @@
-#!/usr/bin/env ruby
-
-# this will compile Iodine and run an HTTP server "Hello World" example.
-Dir.chdir(File.expand_path(File.join('..', '..'), __FILE__))
-puts `rake clean`
-puts `rake compile`
-
-require 'benchmark'
-$LOAD_PATH.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__)
-require 'bundler/setup'
-require 'iodine'
-require 'rack'
-
-# create the server object and setup any settings we might need.
-Iodine::Rack
-Iodine.threads ||= 1
-Iodine.processes ||= 1 # 4
-Iodine::Rack.public = '~/Documents/Scratch'
-count = 2
-logo_png = IO.binread './logo.png'
-Iodine::Rack.app = proc { |_env| [200, { 'Content-Length'.freeze => logo_png.length.to_s , 'Content-Type'.freeze => 'image/png'.freeze}, [logo_png]] }
-puts Iodine::Rack.address
-Iodine.start
-
-# puts env.to_a.map { |pair| pair.join(': ') } .join("\n").to_s;
-
-# puts "Press enter to start (#{Process.pid})"
-# gets
-
-###############
-## for testing:
-
-# def nag
-#   puts `ab -n 200000 -c 2000 -k http://127.0.0.1:3000/`
-#   sleep 2
-# end
-#
-# nag while true
-#
-# def nag
-#   puts `wrk -c2000 -d10 -t4 http://localhost:3000/`
-#   sleep 3
-# end
-#
-# nag while true
-
-# ab -n 100000 -c 200 -k http://127.0.0.1:3000/
-# ab -n 100000 -c 4000 -k http://127.0.0.1:3000/
-# ab -n 1000000 -c 20000 -k http://127.0.0.1:3000/
-# ~/ruby/wrk/wrk -c400 -d10 -t12 http://localhost:3000/
-# wrk -c200 -d4 -t12 http://localhost:3000/
-# RACK_ENV="production" rackup -p 3000 -s iodine
-
-# thor --amount 5000 ws://localhost:3000/echo
-# thor --amount 5000 ws://localhost:3000/broadcast
-
-# 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");};
-# for(i = 0; i< 256; i++) {
-#   ws = new WebSocket("ws://localhost:3000");
-#   ws.onmessage = function(e) {console.log("Got message!"); console.log(e.data); e.target.close(); };
-#   ws.onclose = function(e) {console.log("closed")};
-#   ws.onopen = function(e) {e.target.send("hi");};
-# };