iodine 0.6.5 → 0.7.0

data/ext/iodine/websockets.h

@@ -7,18 +7,13 @@ Feel free to copy, use and enjoy according to the license provided.
 #ifndef H_WEBSOCKETS_H
 #define H_WEBSOCKETS_H
 
-#include "http.h"
+#include <http.h>
 
 /* support C++ */
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/**
-The protocol / service identifier.
-*/
-extern char *WEBSOCKET_ID_STR;
-
 /** used internally: attaches the Websocket protocol to the socket. */
 void websocket_attach(intptr_t uuid, http_settings_s *http_settings,
                       websocket_settings_s *args, void *data, size_t length);
@@ -28,34 +23,36 @@ Websocket information
 ***************************************************************************** */
 
 /** Returns the opaque user data associated with the websocket. */
-void *websocket_udata(ws_s *ws);
+void *websocket_udata_get(ws_s *ws);
 
 /**
-Sets the opaque user data associated with the websocket.
-
-Returns the old value, if any.
-*/
+ * Sets the opaque user data associated with the websocket.
+ *
+ * Returns the old value, if any.
+ */
 void *websocket_udata_set(ws_s *ws, void *udata);
 
 /**
-Returns the underlying socket UUID.
-
-This is only relevant for collecting the protocol object from outside of
-websocket events, as the socket shouldn't be written to.
-*/
+ * Returns the underlying socket UUID.
+ *
+ * This is only relevant for collecting the protocol object from outside of
+ * websocket events, as the socket shouldn't be written to.
+ */
 intptr_t websocket_uuid(ws_s *ws);
 
 /**
-Counts the number of websocket connections.
-*/
-size_t websocket_count(void);
+ * Returns 1 if the WebSocket connection is in Client mode (connected to a
+ * remote server) and 0 if the connection is in Server mode (a connection
+ * established using facil.io's HTTP server).
+ */
+uint8_t websocket_is_client(ws_s *ws);
 
 /* *****************************************************************************
 Websocket Connection Management (write / close)
 ***************************************************************************** */
 
 /** Writes data to the websocket. Returns -1 on failure (0 on success). */
-int websocket_write(ws_s *ws, void *data, size_t size, uint8_t is_text);
+int websocket_write(ws_s *ws, fio_str_info_s msg, uint8_t is_text);
 /** Closes a websocket connection. */
 void websocket_close(ws_s *ws);
 
@@ -70,48 +67,32 @@ Supports pub/sub engines (see {pubsub.h}) that can connect to a backend service
 such as Redis.
 
 The default pub/sub engine (if `NULL` or unspecified) will publish the messages
-to the process cluster (all the processes in `facil_run`).
+to the process cluster (all the processes in `fio_run`).
 
 To publish to a channel, use the API provided in {pubsub.h}.
 ***************************************************************************** */
 
-/** Pub/sub engine type. Engine documentation is in `pubsub.h` */
-typedef struct pubsub_engine_s pubsub_engine_s;
-
-/** Incoming pub/sub messages will be passed along using this data structure. */
-typedef struct {
-  /** the websocket receiving the message. */
-  ws_s *ws;
-  /** the Websocket pub/sub subscription ID. */
-  uintptr_t subscription_id;
-  /** the channel where the message was published. */
-  FIOBJ channel;
-  /** the published message. */
-  FIOBJ message;
-  /** user opaque data. */
-  void *udata;
-} websocket_pubsub_notification_s;
-
 /** Possible arguments for the {websocket_subscribe} function. */
 struct websocket_subscribe_s {
   /** the websocket receiving the message. REQUIRED. */
   ws_s *ws;
   /** the channel where the message was published. */
-  FIOBJ channel;
+  fio_str_info_s channel;
   /**
    * The callback that handles pub/sub notifications.
    *
    * Default: send directly to websocket client.
    */
-  void (*on_message)(websocket_pubsub_notification_s notification);
+  void (*on_message)(ws_s *ws, fio_str_info_s channel, fio_str_info_s msg,
+                     void *udata);
   /**
    * An optional cleanup callback for the `udata`.
    */
   void (*on_unsubscribe)(void *udata);
   /** User opaque data, passed along to the notification. */
   void *udata;
-  /** Use pattern matching for channel subscription. */
-  unsigned use_pattern : 1;
+  /** An optional callback for pattern matching. */
+  fio_match_fn match;
   /**
    * When using client forwarding (no `on_message` callback), this indicates if
    * messages should be sent to the client as binary blobs, which is the safest
@@ -151,17 +132,6 @@ uintptr_t websocket_subscribe(struct websocket_subscribe_s args);
 #define websocket_subscribe(wbsckt, ...)                                       \
   websocket_subscribe((struct websocket_subscribe_s){.ws = wbsckt, __VA_ARGS__})
 
-/**
- * Finds an existing subscription (in case the subscription ID wasn't saved).
- * See {struct websocket_subscribe_s} for possible arguments.
- *
- * Returns the existing subscription's ID (if exists) or 0 (no subscription).
- */
-uintptr_t websocket_find_sub(struct websocket_subscribe_s args);
-
-#define websocket_find_sub(wbsckt, ...)                                        \
-  websocket_find_sub((struct websocket_subscribe_s){.ws = wbsckt, __VA_ARGS__})
-
 /**
  * Unsubscribes from a channel.
  *
@@ -172,71 +142,40 @@ uintptr_t websocket_find_sub(struct websocket_subscribe_s args);
  */
 void websocket_unsubscribe(ws_s *ws, uintptr_t subscription_id);
 
-/* *****************************************************************************
-Websocket Tasks - within a single process scope, NOT and entire cluster
-***************************************************************************** */
+/** Optimize generic broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB (-32)
+/** Optimize text broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB_TEXT (-33)
+/** Optimize binary broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB_BINARY (-34)
 
-/** The named arguments for `websocket_each` */
-struct websocket_each_args_s {
-  /** The websocket originating the task. It will be excluded for the loop. */
-  ws_s *origin;
-  /** The task (function) to be performed. This is required. */
-  void (*task)(ws_s *ws_target, void *arg);
-  /** User opaque data to be passed along. */
-  void *arg;
-  /** The on_finish callback is always called. Good for cleanup. */
-  void (*on_finish)(ws_s *origin, void *arg);
-};
 /**
- * DEPRECATION NOTICE: this function will be removed in favor of pub/sub logic.
+ * Enables (or disables) broadcast optimizations.
  *
- * Performs a task on each websocket connection that shares the same process
- * (except the originating `ws_s` connection which is allowed to be NULL).
- */
-void __attribute__((deprecated))
-websocket_each(struct websocket_each_args_s args);
-#define websocket_each(...)                                                    \
-  websocket_each((struct websocket_each_args_s){__VA_ARGS__})
-
-/**
- * DEPRECATION NOTICE: this function will be removed in favor of pub/sub logic.
+ * 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.
  *
- * The Arguments passed to the `websocket_write_each` function / macro are
- * defined here, for convinience of calling the function.
- */
-struct websocket_write_each_args_s {
-  /** The originating websocket client will be excluded from the `write`.
-   * Can be NULL. */
-  ws_s *origin;
-  /** The data to be written to the websocket - required(!) */
-  void *data;
-  /** The length of the data to be written to the websocket - required(!) */
-  size_t length;
-  /** Text mode vs. binary mode. Defaults to binary mode. */
-  uint8_t is_text;
-  /** Set to 1 to send the data to websockets where this application is the
-   * client. Defaults to 0 (the data is sent to all clients where this
-   * application is the server). */
-  uint8_t as_client;
-  /** A filter callback, allowing us to exclude some clients.
-   * Should return 1 to send data and 0 to exclude. */
-  uint8_t (*filter)(ws_s *ws_to, void *arg);
-  /** A callback called once all the data was sent. */
-  void (*on_finished)(ws_s *ws_origin, void *arg);
-  /** A user specified argumernt passed to each of the callbacks. */
-  void *arg;
-};
-/**
-Writes data to each websocket connection that shares the same process
-(except the originating `ws_s` connection which is allowed to be NULL).
-
-Accepts a sing `struct websocket_write_each_args_s` argument. See the struct
-details for possible arguments.
+ * 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:
+ *
+ * * WEBSOCKET_OPTIMIZE_PUBSUB - optimize all direct transmission messages,
+ *                               best attempt to detect Text vs. Binary data.
+ * * WEBSOCKET_OPTIMIZE_PUBSUB_TEXT - optimize direct pub/sub text messages.
+ * * WEBSOCKET_OPTIMIZE_PUBSUB_BINARY - optimize direct pub/sub binary messages.
+ *
+ * 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).
  */
-int __attribute__((deprecated))
-websocket_write_each(struct websocket_write_each_args_s args);
-#define websocket_write_each(...)                                              \
-  websocket_write_each((struct websocket_write_each_args_s){__VA_ARGS__})
+void websocket_optimize4broadcasts(intptr_t type, int enable);
 
 #ifdef __cplusplus
 } /* extern "C" */

data/lib/iodine.rb

@@ -3,7 +3,7 @@ require 'socket'
 require 'iodine/version'
 require 'iodine/iodine'
 
-# Iodine is an HTTP / WebSocket server as well as an Evented Network Tool Library.
+# Iodine is an HTTP / WebSocket server as well as an Evented Network Tool Library. In essense, Iodine is a Ruby port for the [facil.io](http://facil.io) C library.
 #
 # Here is a simple telnet based echo server using Iodine (see full list at {Iodine::Connection}):
 #

data/lib/iodine/mustache.rb

@@ -0,0 +1,140 @@
+module Iodine
+  # Iodine includes a strict and extra safe Mustache templating engine.
+  #
+  # The Iodine Mustache templating engine provides increased XSS protection through agressive HTML escaping. It's also faster than the original (Ruby based) Mustache templating engine.
+  #
+  # Another difference is that the Iodine Mustache templating engine always loads the templates from the disk, allowing for patial template path resolution.
+  #
+  # There's no monkey-patch for `mustache` Ruby gem since the API is incompatible.
+  #
+  # You can benchmark the Iodine Mustache performance and decide if you wish to switch from the Ruby implementation.
+  # 
+  #     require 'benchmark/ips'
+  #     require 'mustache'
+  #     require 'iodine'
+  #
+  #     def benchmark_mustache
+  #       # benchmark code was copied, in part, from:
+  #       #   https://github.com/mustache/mustache/blob/master/benchmarks/render_collection_benchmark.rb
+  #       template = """
+  #       {{#products}}
+  #         <div class='product_brick'>
+  #           <div class='container'>
+  #             <div class='element'>
+  #               <img src='images/{{image}}' class='product_miniature' />
+  #             </div>
+  #             <div class='element description'>
+  #               <a href={{url}} class='product_name block bold'>
+  #                 {{external_index}}
+  #               </a>
+  #             </div>
+  #           </div>
+  #         </div>
+  #       {{/products}}
+  #       """
+  #
+  #       IO.write "test_template.mustache", template
+  #
+  #       data_1 = {
+  #         products: [ {
+  #           :external_index=>"This <product> should've been \"properly\" escaped.",
+  #           :url=>"/products/7",
+  #           :image=>"products/product.jpg"
+  #         } ]
+  #       }
+  #
+  #       data_10 = {
+  #         products: []
+  #       }
+  #
+  #       10.times do
+  #         data_10[:products] << {
+  #           :external_index=>"product",
+  #           :url=>"/products/7",
+  #           :image=>"products/product.jpg"
+  #         }
+  #       end
+  #
+  #       data_100 = {
+  #         products: []
+  #       }
+  #
+  #       100.times do
+  #         data_100[:products] << {
+  #           :external_index=>"product",
+  #           :url=>"/products/7",
+  #           :image=>"products/product.jpg"
+  #         }
+  #       end
+  #
+  #       data_1000 = {
+  #         products: []
+  #       }
+  #
+  #       1000.times do
+  #         data_1000[:products] << {
+  #           :external_index=>"product",
+  #           :url=>"/products/7",
+  #           :image=>"products/product.jpg"
+  #         }
+  #       end
+  #
+  #       data_1000_escaped = {
+  #         products: []
+  #       }
+  #
+  #       1000.times do
+  #         data_1000_escaped[:products] << {
+  #           :external_index=>"This <product> should've been \"properly\" escaped.",
+  #           :url=>"/products/7",
+  #           :image=>"products/product.jpg"
+  #         }
+  #       end
+  #
+  #       view = Mustache.new
+  #       view.template = template
+  #       view.render # Call render once so the template will be compiled
+  #       iodine_view = Iodine::Mustache.new("test_template")
+  #
+  #       puts "Ruby Mustache rendering (and HTML escaping) results in:",
+  #            view.render(data_1), "",
+  #            "Notice that Iodine::Mustache rendering (and HTML escaping) results in agressive escaping:",
+  #            iodine_view.render(data_1), "", "----"
+  #
+  #       # return;
+  #
+  #       Benchmark.ips do |x|
+  #         x.report("Ruby Mustache render list of 10") do |times|
+  #           view.render(data_10)
+  #         end
+  #         x.report("Iodine::Mustache render list of 10") do |times|
+  #           iodine_view.render(data_10)
+  #         end
+  #
+  #         x.report("Ruby Mustache render list of 100") do |times|
+  #           view.render(data_100)
+  #         end
+  #         x.report("Iodine::Mustache render list of 100") do |times|
+  #           iodine_view.render(data_100)
+  #         end
+  #
+  #         x.report("Ruby Mustache render list of 1000") do |times|
+  #           view.render(data_1000)
+  #         end
+  #         x.report("Iodine::Mustache render list of 1000") do |times|
+  #           iodine_view.render(data_1000)
+  #         end
+  #
+  #         x.report("Ruby Mustache render list of 1000 with escaped data") do |times|
+  #           view.render(data_1000_escaped)
+  #         end
+  #         x.report("Iodine::Mustache render list of 1000 with escaped data") do |times|
+  #           iodine_view.render(data_1000_escaped)
+  #         end
+  #       end
+  #     end
+  #
+  #     benchmark_mustache
+  class Mustache
+  end
+end

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.6.5'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -137,6 +137,7 @@ files:
 - bin/http-big
 - bin/http-hello
 - bin/http-playground
+- bin/mustache.rb
 - bin/playground
 - bin/poc/Gemfile.lock
 - bin/poc/README.md
@@ -157,35 +158,19 @@ files:
 - examples/pubsub_engine.ru
 - examples/redis.ru
 - examples/shootout.ru
+- examples/test_template.mustache
 - exe/iodine
-- ext/iodine/defer.c
-- ext/iodine/defer.h
-- ext/iodine/evio.c
-- ext/iodine/evio.h
-- ext/iodine/evio_callbacks.c
-- ext/iodine/evio_epoll.c
-- ext/iodine/evio_kqueue.c
 - ext/iodine/extconf.rb
-- ext/iodine/facil.c
-- ext/iodine/facil.h
+- ext/iodine/fio.c
+- ext/iodine/fio.h
 - ext/iodine/fio_ary.h
-- ext/iodine/fio_base64.c
-- ext/iodine/fio_base64.h
 - ext/iodine/fio_cli.c
 - ext/iodine/fio_cli.h
 - ext/iodine/fio_hashmap.h
 - ext/iodine/fio_json_parser.h
-- ext/iodine/fio_llist.h
-- ext/iodine/fio_mem.c
-- ext/iodine/fio_mem.h
-- ext/iodine/fio_random.c
-- ext/iodine/fio_random.h
-- ext/iodine/fio_sha1.c
-- ext/iodine/fio_sha1.h
-- ext/iodine/fio_sha2.c
-- ext/iodine/fio_sha2.h
 - ext/iodine/fio_siphash.c
 - ext/iodine/fio_siphash.h
+- ext/iodine/fio_str.h
 - ext/iodine/fio_tmpfile.h
 - ext/iodine/fiobj.h
 - ext/iodine/fiobj4sock.h
@@ -197,6 +182,9 @@ files:
 - ext/iodine/fiobj_hash.h
 - ext/iodine/fiobj_json.c
 - ext/iodine/fiobj_json.h
+- ext/iodine/fiobj_mem.h
+- ext/iodine/fiobj_mustache.c
+- ext/iodine/fiobj_mustache.h
 - ext/iodine/fiobj_numbers.c
 - ext/iodine/fiobj_numbers.h
 - ext/iodine/fiobj_str.c
@@ -227,6 +215,8 @@ files:
 - ext/iodine/iodine_http.h
 - ext/iodine/iodine_json.c
 - ext/iodine/iodine_json.h
+- ext/iodine/iodine_mustache.c
+- ext/iodine/iodine_mustache.h
 - ext/iodine/iodine_pubsub.c
 - ext/iodine/iodine_pubsub.h
 - ext/iodine/iodine_rack_io.c
@@ -235,14 +225,10 @@ files:
 - ext/iodine/iodine_store.h
 - ext/iodine/iodine_tcp.c
 - ext/iodine/iodine_tcp.h
-- ext/iodine/pubsub.c
-- ext/iodine/pubsub.h
+- ext/iodine/mustache_parser.h
 - ext/iodine/redis_engine.c
 - ext/iodine/redis_engine.h
 - ext/iodine/resp_parser.h
-- ext/iodine/sock.c
-- ext/iodine/sock.h
-- ext/iodine/spnlock.inc
 - ext/iodine/websocket_parser.h
 - ext/iodine/websockets.c
 - ext/iodine/websockets.h
@@ -250,6 +236,7 @@ files:
 - lib/iodine.rb
 - lib/iodine/connection.rb
 - lib/iodine/json.rb
+- lib/iodine/mustache.rb
 - lib/iodine/pubsub.rb
 - lib/iodine/rack_utils.rb
 - lib/iodine/version.rb
@@ -281,7 +268,7 @@ requirements:
 - Ruby >= 2.2.2 required for Rack 2.
 - Ruby >= 2.4.0 recommended.
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: iodine - a fast HTTP / Websocket Server with Pub/Sub support, optimized for