iodine 0.7.36 → 0.7.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caba5a01ba9efefbadf0fd3c974e34977dc1e671ce18d17ea924d746b7936759
-  data.tar.gz: d16060974362ee9bfdedbd4d46eadbeea48c2b57379e2a27609bcaad5fde5ea9
+  metadata.gz: 03af29c680fee3cd7b70b4a9fbc0f370b42a763f83f4422cc0f1cae296b95f1c
+  data.tar.gz: b6e25d8cc33dd955989ae6c8f6bf18d45f84dad42887eff22f39c68aada56f02
 SHA512:
-  metadata.gz: 6ef0992c4f4399535d17e818b6dc557f8d2811c02207d38d8e94c53cd3105528bd494a1ff1cb0ad77228a60268d7861c0a81b08ae2c3b9688b9e13a532384f89
-  data.tar.gz: 2d03ae0c9435544580a0c943f4823c4d1103318929a3a0e44b209bd0e6c6f104d93928622c041af6358360198b6606acac80ec4f57ce46ce4650a2e62287f155
+  metadata.gz: b4eab8d5f7309dd8845d4f6c8052935dbd8145201c4820786ae000e895277883765c1dd628c1e053816b50a1d7c002180f6b4e0a5833e60d76277dab8ecf81b1
+  data.tar.gz: f90eb620cf2a9aaf7c943fe981e829f698cb1e8fc176ad8ad778df2c36c5eb026314522d428bee8058915e95f9ed3750ed078931193b81b0dec062e27eb569c2

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### System Information
+
+ - **OS**:             [e.g. macOS 10.15.4]
+ - **Ruby**:         [e.g. 2.7.0]
+ - **Version**:     [e.g. 0.7.38]
+ - **OpenSSL**:  [OpenSSL 1.1.1f 20 Mar 2020]
+
+### Description
+
+A clear and concise description of what the bug is.
+
+### Rack App to Reproduce
+
+```ruby
+APP = {|env| [200, {}, "Hello World"] }
+run APP
+```
+
+### Testing code
+
+```sh
+curl http://localhost:3000/
+```
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Actual behavior
+
+A clear and concise description of what actually happened.

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
+arch:
+  - amd64
+  - arm64
 os:
   - linux
   # - osx
@@ -6,15 +9,16 @@ before_install:
   - gem install bundler -v 1.10.6
   - bundle install
 rvm:
-  - 2.6.0
-  - 2.5.3
-  - 2.4.5
+  - 2.7.1
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
   - 2.3.8
   - 2.2.2
 notifications:
   email: false
 sudo: required
-dist: trusty
+dist: xenial
 addons:
   apt:
     sources:
@@ -24,7 +28,5 @@ addons:
 script:
   - echo CFLAGS = $CFLAGS
   - echo cflags = $cflags
-  - bundle exec rake compile && bundle exec rspec --format documentation
-  - gem uninstall -x iodine
-  - rake build
-  - find pkg/iodine-*.gem -exec gem install -V {} +
+  - bundle exec rake install
+  - env VERBOSE=1 bundle exec rspec --format documentation

data/CHANGELOG.md

@@ -6,6 +6,34 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+#### Change log v.0.7.41 (2020-07-24)
+
+**Fix**: Hot Restart failed because listening sockets were cleared away. Credit to Néstor Coppi (@Shelvak) for exposing issue #97.
+
+**Fix**: CLI argument parsing is now only active when using the iodine CLI (or if defining `IODINE_PARSE_CLI` before requiring `iodine`). Credit to Aldis Berjoza (@graudeejs) for exposing issue #96.
+
+#### Change log v.0.7.40 (2020-05-23)
+
+**Fix**: fixed TLS logging and performance issues exposed by Franck Gille (@fgi) in issue #93.
+
+#### Change log v.0.7.39 (2020-05-18)
+
+**Security**: a request smuggling attack vector and Transfer Encoding attack vector in the HTTP/1.1 parser were exposed by Sam Sanoop from [the Snyk Security team (snyk.io)](https://snyk.io). The parser was updated to deal with these potential issues.
+
+**Fix**: (`http`) fixes an issue with date calculation - exposed by Franck Gille (@fgi) in issue #92.
+
+**Fix**: (`extconf`) fixes an installation concern raised by Benoit Daloze (@eregon), in issue #91. The default compiler is now used.
+
+#### Change log v.0.7.38
+
+**Fix**: (`http`) fixes an issue and improves support for chunked encoded payloads. Credit to Ian Ker-Seymer ( @ianks ) for exposing this, writing tests and opening both the issue #87 and the PR #88.
+
+#### Change log v.0.7.37
+
+**Fix**: requests will fail when the path contains a dangling `?` (empty query). Credit to @adam12 for exposing this and opening issue #86.
+
+**Fix**: documentation improvements and corrections, credit to Caleb Albritton ( @WA9ACE ) and Don Morrison ( @elskwid ) for PRs #82 and #83. Credit to Nir ( @Roko131 ) and Aurel Branzeanu ( @texpert ) for opening and commenting on issue #84.
+
 #### Change log v.0.7.36
 
 **Fix**: avoids clobbering the namespace when attempting to set Rack's default handler. Credit to Caleb Albritton ( @WA9ACE ) for issue #80 and PR #81.

data/README.md

@@ -1,4 +1,5 @@
-# iodine - a fast HTTP / Websocket Server with native Pub/Sub support for the new web
+# 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)
 [![Gem Version](https://badge.fury.io/rb/iodine.svg)](https://badge.fury.io/rb/iodine)
@@ -7,28 +8,30 @@
 
 [![Logo](https://github.com/boazsegev/iodine/raw/master/logo.png)](https://github.com/boazsegev/iodine)
 
-I believe that network concerns should be separated from application concerns - application developers really shouldn't need to worry about the transport layer.
+Iodine is a fast concurrent web application server for real-time Ruby applications, with native support for WebSockets and Pub/Sub services - but it's also so much more.
 
-And I know that these network concerns are more than just about the web server, which is why iodine is more than just an HTTP server.
+Iodine is a Ruby wrapper for many of the [facil.io](https://facil.io) C framework, leveraging the speed of C for many common web application tasks. In addition, iodine abstracts away all network concerns, so you never need to worry about the transport layer, free to concentrate on your application logic.
 
-Iodine is a fast concurrent web server for real-time Ruby applications, but it's also so much more. Iodine includes native support for:
+Iodine includes native support for:
 
 * HTTP, WebSockets and EventSource (SSE) Services (server);
 * WebSocket connections (server / client);
 * Pub/Sub (with optional Redis Pub/Sub scaling);
-* Static file service (with automatic `gzip` support for pre-compressed versions);
-* HTTP/1.1 keep-alive and pipelining;
+* Fast(!) builtin Mustache template engine.
+* Static file service (with automatic `gzip` support for pre-compressed assets);
+* Optimized Logging to `stderr`.
 * Asynchronous event scheduling and timers;
-* Hot Restart (using the USR1 signal);
+* HTTP/1.1 keep-alive and pipelining;
+* Heap Fragmentation Protection.
 * TLS 1.2 and above (Requires OpenSSL >= 1.1.0);
 * TCP/IP server and client connectivity;
 * Unix Socket server and client connectivity;
+* Hot Restart (using the USR1 signal and without hot deployment);
 * Custom protocol authoring;
-* Optimized Logging to `stderr`.
 * [Sequel](https://github.com/jeremyevans/sequel) and ActiveRecord forking protection.
 * and more!
 
-Iodine is an **evented** framework with a simple API that ports much of the [C facil.io framework](https://github.com/boazsegev/facil.io) to Ruby. This means that:
+Since iodine wraps much of the [C facil.io framework](https://github.com/boazsegev/facil.io) to Ruby:
 
 * Iodine can handle **thousands of concurrent connections** (tested with more then 20K connections on Linux)!
 
@@ -36,9 +39,9 @@ Iodine is an **evented** framework with a simple API that ports much of the [C f
 
 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.
 
-**Note**: iodine does **not** support the streaming when using Rack. Streaming over Rack should be avoided on any server, WebSockets, SSE and `Range` requests should always be preferred. On iodine no data will be sent before the whole of the data is available.
+**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.
 
-## Iodine - a fast & powerful HTTP + Websockets server with native Pub/Sub
+## Iodine - a fast & powerful HTTP + WebSockets server with native Pub/Sub
 
 Iodine includes a light and fast HTTP and Websocket server written in C that was written according to the [Rack interface specifications](http://www.rubydoc.info/github/rack/rack/master/file/SPEC) and the [Websocket draft extension](./SPEC-Websocket-Draft.md).
 
@@ -46,6 +49,10 @@ With `Iodine.listen service: :http` it's possible to run multiple HTTP applicati
 
 Iodine also supports native process cluster Pub/Sub and a native RedisEngine to easily scale iodine's Pub/Sub horizontally.
 
+### Known Issues and Reporting Issues
+
+See the [GitHub Open Issues](https://github.com/boazsegev/iodine/issues) list for known issues and to report new issues.
+
 ### Installing and Running Iodine
 
 Install iodine on any Linux / BSD / macOS system using:
@@ -68,6 +75,8 @@ bundler exec iodine
 
 #### Installing with SSL/TLS
 
+**Note**: iodine has known issues with the TLS/SSL support. TLS/SSL should **NOT** be used in production (see issues #95 and #94).
+
 Make sure to update OpenSSL to the latest version **before installing Ruby** (`rbenv` should do this automatically).
 
 To avoid name resolution conflicts, iodine will bind to the same OpenSSL version Ruby is bound to. To use SSL/TLS this should be OpenSSL >= 1.1.0 or LibreSSL >= 2.7.4.
@@ -85,9 +94,7 @@ Confirmed OpenSSL to be version 1.1.0 or above (OpenSSL 1.1.0j  20 Nov 2018)...
 ...
 ```
 
-**KNOWN ISSUE:**
-
-The installation script tests for OpenSSL 1.1.0 and above. However, this testing approach sometimes provides false positives. If TLS isn't required, install with `NO_SSL=1`. i.e.:
+The installation script tests for OpenSSL 1.1.0 and above. However, this testing approach sometimes provides false positives. **If TLS isn't required, install with `NO_SSL=1`**. i.e.:
 
 ```bash
 NO_SSL=1 bundler exec iodine
@@ -108,17 +115,19 @@ On Rails:
     if(defined?(Iodine))
       Iodine.threads = ENV.fetch("RAILS_MAX_THREADS", 5).to_i if Iodine.threads.zero?
       Iodine.workers = ENV.fetch("WEB_CONCURRENCY", 2).to_i if Iodine.workers.zero?
-      Iodine::DEFAULT_SETTINGS[:port] = ENV.fetch("PORT") if ENV.fetch("PORT")
+      Iodine::DEFAULT_SETTINGS[:port] ||= ENV.fetch("PORT") if ENV.fetch("PORT")
     end
     ```
 
 When using native WebSockets with Rails, middle-ware is probably the best approach. A guide for this approach will, hopefully, get published in the future.
 
+**Note**: command-line instructions (CLI) should be the preferred way for configuring iodine, allowing for code-less configuration updates.
+
 ### Optimizing Iodine's Concurrency
 
 To get the most out of iodine, consider the amount of CPU cores available and the concurrency level the application requires.
 
-Iodine will calculate, when possible, a good enough default concurrency model. See if this works for your application or customize according to the application's needs.
+Iodine will calculate, when possible, a good enough default concurrency model for fast applications. See if this works for your application or customize according to the application's needs.
 
 Command line arguments allow easy access to different options, including concurrency levels. i.e., to set up 16 threads and 4 processes:
 
@@ -134,13 +143,19 @@ export WORKERS=-1 # negative values are fractions of CPU cores.
 bundler exec iodine -p $PORT
 ```
 
+Negative values are evaluated as "CPU Cores / abs(Value)". i.e., on an 8 core CPU machine, this will produce 4 worker processes with 2 threads per worker:
+
+```bash
+bundler exec iodine -p $PORT -t 2 -w -2
+```
+
 ### Heap Fragmentation Protection
 
 Iodine includes a fast, network oriented, custom memory allocator, optimizing away some of the work usually placed on the Ruby Garbage Collector (GC).
 
 This approach helps to minimize heap fragmentation for long running processes, by grouping many short-lived objects into a common memory space.
 
-It's still recommended to consider [jemalloc](http://jemalloc.net) or other allocators that also help mitigate heap fragmentation issues.
+It is still recommended to consider [jemalloc](http://jemalloc.net) or other allocators that also help mitigate heap fragmentation issues.
 
 ### Static file serving support
 
@@ -348,7 +363,7 @@ Since the master / root process doesn't handle any requests (it only handles pub
 
 ### Optimized HTTP logging
 
-By default, iodine is pretty quite. Some messages are logged to `stderr`, but not many.
+By default, iodine is pretty quiet. Some messages are logged to `stderr`, but not many.
 
 However, HTTP requests can be logged using iodine's optimized logger to `stderr`. Iodine will optimize the log output by caching the output time string which updates every second rather than every request.
 
@@ -433,11 +448,11 @@ Iodine.connect url: "wss://echo.websocket.org", handler: EchoClient.new, ping: 4
 Iodine.start
 ```
 
-### TLS 1.2 support
+### TLS >= 1.2 support
 
 >  Requires OpenSSL >= `1.1.0`. On Heroku, requires `heroku-18`.
 
-Iodine supports secure connections fore TLS version 1.2 and up (depending on the OpenSSL version).
+Iodine supports secure connections fore TLS version 1.2 **and up** (depending on the OpenSSL version).
 
 A self signed certificate is available using the `-tls` flag from the command-line.
 
@@ -478,31 +493,11 @@ run APP
 
 ### How does it compare to other servers?
 
-The honest answer is "I don't know". I recommend that you perform your own tests.
-
-In my tests, pitching Iodine against Puma, Iodine was anywhere between x1.5 and x7 faster than Puma (depending on use-case). such a big difference is suspect and I recommend that you test it yourself.
+In my tests, pitching Iodine against Puma, Iodine was anywhere between x1.5 and more than x10 faster than Puma (depending on use-case and settings).
 
-Also, performing benchmarks on a single machine isn't very reliable... but it's all I've got.
+Such a big difference is suspect and I recommend that you test it yourself - even better if you test performance using your own application and a number of possible different settings (how many threads per CPU core? how many worker processes? middleware vs. server request logging, etc').
 
-When benchmarking with `wrk`, on the same local machine with similar settings for both Puma and Iodine (4 workers, 16 threads each, 200 concurrent connections), I calculated Iodine to be x1.52 faster::
-
-* Iodine performed at 74,786.27 req/sec, consuming ~68.4Mb of memory.
-
-* Puma performed at 48,994.59 req/sec, consuming ~79.6Mb of memory.
-
-When benchmarking using a VM (crossing machine boundaries, 16 threads, 4 workers, 200 concurrent connections), I calculated Iodine to be x2.3 faster:
-
-* Iodine performed at 23,559.56 req/sec, consuming ~88.8Mb of memory.
-
-* Puma performed at 9,935.31 req/sec, consuming ~84.0Mb of memory.
-
-When benchmarking using a VM (crossing machine boundaries, single thread, single worker, 200 concurrent connections), I calculated Iodine to be x7.3 faster:
-
-* Iodine performed at 18,444.31 req/sec, consuming ~25.6Mb of memory.
-
-* Puma performed at 2,521.56 req/sec, consuming ~27.5Mb of memory.
-
-I have doubts about my own benchmarks and I recommend benchmarking the performance for yourself using `wrk` or `ab`:
+I recommend benchmarking the performance for yourself using `wrk` or `ab`:
 
 ```bash
 $ wrk -c200 -d4 -t2 http://localhost:3000/
@@ -510,7 +505,7 @@ $ wrk -c200 -d4 -t2 http://localhost:3000/
 $ ab -n 100000 -c 200 -k http://127.0.0.1:3000/
 ```
 
-Create a simple `config.ru` file with a hello world app:
+The best application to use for benchmarking is your actual application. Or, you could create a simple `config.ru` file with a __hello world__ app:
 
 ```ruby
 App = Proc.new do |env|
@@ -523,17 +518,21 @@ end
 run App
 ```
 
-Then start comparing servers. Here are the settings I used to compare iodine and Puma (4 processes, 16 threads):
+Then start comparing servers. Here are the settings I used to compare iodine and Puma (4 processes, 4 threads):
 
 ```bash
-$ RACK_ENV=production iodine -p 3000 -t 16 -w 4
+$ RACK_ENV=production iodine -p 3000 -t 4 -w 4
 # vs.
-$ RACK_ENV=production puma -p 3000 -t 16 -w 4
+$ RACK_ENV=production puma -p 3000 -t 4 -w 4
 # Review the `iodine -?` help for more command line options.
 ```
 
 It's recommended that the servers (Iodine/Puma) and the client (`wrk`/`ab`) run on separate machines.
 
+It is worth noting that iodine can also speed up logging by replacing the logging middleware with `iodine -v`. This approach uses less memory and improves performance at the expense of fuzzy timing and some string caching.
+
+On my machine, testing with the logging functionality enabled, iodine was more then 10 times faster than puma (60.9K req/sec vs. 5.3K req/sec)
+
 ### A few notes
 
 Iodine's upgrade / callback design has a number of benefits, some of them related to better IO handling, resource optimization (no need for two IO polling systems), etc. This also allows us to use middleware without interfering with connection upgrades and provides backwards compatibility.
@@ -585,7 +584,7 @@ More possible compile time options can be found in the [facil.io documentation](
 
 ## Evented oriented design with extra safety
 
-Iodine is an evened server, similar in it's architecture to `nginx` and `puma`. It's different than the simple "thread-per-client" design that is often taught when we begin to learn about network programming.
+Iodine is an evented server, similar in its architecture to `nginx` and `puma`. It's different than the simple "thread-per-client" design that is often taught when we begin to learn about network programming.
 
 By leveraging `epoll` (on Linux) and `kqueue` (on BSD), iodine can listen to multiple network events on multiple sockets using a single thread.
 
@@ -770,6 +769,14 @@ Yes, please, here are some thoughts:
 
 * If you love the project or thought the code was nice, maybe helped you in your own project, drop me a line. I'd love to know.
 
+### Running the Tests
+
+Running this task will compile the C extensions then run RSpec tests:
+
+```sh
+bundle exec rake spec
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -3,10 +3,12 @@ require "rake/extensiontask"
 
 begin
   require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
+  RSpec::Core::RakeTask.new(:rspec)
 rescue LoadError
 end
 
+task :spec => [:compile, :rspec]
+
 task :default => [:compile, :spec]
 
 Rake::ExtensionTask.new "iodine" do |ext|

data/examples/shootout.ru

@@ -22,6 +22,14 @@ module ShootoutApp
       len += out[-1].length
       request.params.each { |k,v| out << "#{k}: #{v}\n" ; len += out[-1].length }
     end
+    if(env['rack.input'])
+      env['rack.input'].rewind
+      out << "Body\n\n"
+      out << env['rack.input'].read
+      len += out[-1].length + 6
+      out << "\n\nBody Length: #{out[-1].length}\n\n"
+      len += out[-1].length
+    end
     [200, { 'Content-Length' => len.to_s, 'Content-Type' => 'text/plain; charset=UTF-8;' }, out]
   end
   # We'll base the shootout on the internal Pub/Sub service.

data/exe/iodine

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+IODINE_PARSE_CLI = true
 require 'iodine'
 
 # Load Rack if available (assume it will be used).

data/ext/iodine/extconf.rb

@@ -1,34 +1,5 @@
 require 'mkmf'
 
-if ENV['CC']
-  ENV['CPP'] ||= ENV['CC']
-  puts "detected user prefered compiler (#{ENV['CC']}):", `#{ENV['CC']} -v`
-elsif find_executable('clang') && puts('testing clang for stdatomic support...').nil? && system("printf \"\#include <stdatomic.h>\nint main(void) {}\" | clang -include stdatomic.h -xc -o /dev/null -", out: '/dev/null')
-  $CC = ENV['CC'] = 'clang'
-  $CPP = ENV['CPP'] = 'clang'
-  puts "using clang compiler v. #{`clang -dumpversion`}."
-elsif find_executable('gcc') && (`gcc -dumpversion 2>&1`.to_i >= 5)
-  $CC = ENV['CC'] = 'gcc'
-  $CPP = ENV['CPP'] = find_executable('g++') ? 'g++' : 'gcc'
-  puts "using gcc #{ `gcc -dumpversion 2>&1`.to_i }"
-elsif find_executable('gcc-6')
-  $CC = ENV['CC'] = 'gcc-6'
-  $CPP = ENV['CPP'] = find_executable('g++-6') ? 'g++-6' : 'gcc-6'
-  puts 'using gcc-6 compiler.'
-elsif find_executable('gcc-5')
-  $CC = ENV['CC'] = 'gcc-5'
-  $CPP = ENV['CPP'] = find_executable('g++-5') ? 'g++-5' : 'gcc-5'
-  puts 'using gcc-5 compiler.'
-elsif find_executable('gcc-4.9')
-  $CC = ENV['CC'] = 'gcc-4.9'
-  $CPP = ENV['CPP'] = find_executable('g++-4.9') ? 'g++-4.9' : 'gcc-4.9'
-  puts 'using gcc-4.9 compiler.'
-else
-  puts 'using an unknown (old?) compiler... who knows if this will work out... we hope.'
-end
-
-
-
 # Test polling
 def iodine_test_polling_support
   iodine_poll_test_kqueue = <<EOS
@@ -129,10 +100,5 @@ EOS
     end
   end
 end
-# $defs << "-DFIO_USE_RISKY_HASH"
-
-RbConfig::MAKEFILE_CONFIG['CFLAGS'] = $CFLAGS = "-std=c11 -DFIO_PRINT_STATE=0 #{$CFLAGS} #{$CFLAGS == ENV['CFLAGS'] ? "" : ENV['CFLAGS']}"
-RbConfig::MAKEFILE_CONFIG['CC'] = $CC = ENV['CC'] if ENV['CC']
-RbConfig::MAKEFILE_CONFIG['CPP'] = $CPP = ENV['CPP'] if ENV['CPP']
 
 create_makefile 'iodine/iodine'