async-websocket 0.14.0 → 0.19.0

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-Gemfile.lock
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-script: bundle exec rspec
-
-matrix:
-  include:
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: truffleruby
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-	gem 'rack-test'
-end

data/README.md

@@ -1,143 +0,0 @@
-# Async::WebSocket
-
-A simple asynchronous websocket client/server implementation for [HTTP/1](https://tools.ietf.org/html/rfc6455) and [HTTP/2](https://tools.ietf.org/html/rfc8441).
-
-[![Build Status](https://secure.travis-ci.org/socketry/async-websocket.svg)](http://travis-ci.org/socketry/async-websocket)
-[![Code Climate](https://codeclimate.com/github/socketry/async-websocket.svg)](https://codeclimate.com/github/socketry/async-websocket)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-websocket/badge.svg)](https://coveralls.io/r/socketry/async-websocket)
-
-[![WebSocket Client & Server for Ruby](https://img.youtube.com/vi/aHop4Yyjs_o/0.jpg)](https://www.youtube.com/watch?v=aHop4Yyjs_o)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-	gem 'async-websocket'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-websocket
-
-## Usage
-
-There are [examples](examples/) which include:
-
-- [A command line chat client/server](examples/chat) which can read input from `stdin` and send messages to the server.
-- [A small MUD client/server](examples/mud) which uses JSON for communation between client/server.
-- [A utopia-based web application](examples/utopia) which uses a JavaScript client to connect to a web application server.
-
-### Client Side with Async
-
-```ruby
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/io/stream'
-require 'async/http/endpoint'
-require 'async/websocket/client'
-
-USER = ARGV.pop || "anonymous"
-URL = ARGV.pop || "http://localhost:7070"
-
-Async do |task|
-	stdin = Async::IO::Stream.new(
-		Async::IO::Generic.new($stdin)
-	)
-	
-	endpoint = Async::HTTP::Endpoint.parse(URL)
-	
-	Async::WebSocket::Client.connect(endpoint) do |connection|
-		input_task = task.async do
-			while line = stdin.read_until("\n")
-				connection.write({user: USER, text: line})
-				connection.flush
-			end
-		end
-		
-		connection.write({
-			user: USER,
-			status: "connected",
-		})
-		
-		while message = connection.read
-			puts message.inspect
-		end
-	ensure
-		input_task&.stop
-	end
-end
-```
-
-### Server Side with Rack & Falcon
-
-```ruby
-#!/usr/bin/env -S falcon serve --bind http://localhost:7070 --count 1 -c
-
-require 'async/websocket/adapters/rack'
-require 'set'
-
-$connections = Set.new
-
-run lambda {|env|
-	Async::WebSocket::Adapters::Rack.open(env, protocols: ['ws']) do |connection|
-		$connections << connection
-		
-		while message = connection.read
-			$connections.each do |connection|
-				connection.write(message)
-				connection.flush
-			end
-		end
-	ensure
-		$connections.delete(connection)
-	end or [200, {}, ["Hello World"]]
-}
-```
-
-### Force HTTP/1 Connection
-
-This forces the endpoint to connect using `HTTP/1.1`.
-
-```ruby
-endpoint = Async::HTTP::Endpoint.parse("https://remote-server.com", alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
-
-Async::WebSocket::Client.connect(endpoint) do ...
-```
-
-You may want to use this if the server advertises `HTTP/2` but doesn't support `HTTP/2` for WebSocket connections.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/async-websocket.gemspec

@@ -1,29 +0,0 @@
-
-require_relative 'lib/async/websocket/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-websocket"
-	spec.version       = Async::WebSocket::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	spec.summary       = %q{An async websocket library on top of websocket-driver.}
-	spec.homepage      = ""
-	spec.license       = "MIT"
-	
-	spec.files         = `git ls-files -z`.split("\x0")
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "async-io", "~> 1.23"
-	spec.add_dependency "async-http", "~> 0.51"
-	spec.add_dependency "protocol-websocket", "~> 0.7.0"
-	
-	spec.add_development_dependency "async-rspec"
-	spec.add_development_dependency "falcon", "~> 0.34"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "bake-bundler"
-end

data/examples/chat/.env

@@ -1,3 +0,0 @@
-export RUBY_FIBER_VM_STACK_SIZE=0
-export RUBY_FIBER_MACHINE_STACK_SIZE=0
-export RUBY_SHARED_FIBER_POOL_FREE_STACKS=0

data/examples/chat/README.md

@@ -1,147 +0,0 @@
-# The Journey to One Million
-
-## Allocations per Connection
-
-```
-Array: 188498 allocations
-Hash: 137041 allocations
-String: 91387 allocations
-Proc: 81242 allocations
-Fiber: 30169 allocations
-Async::Task: 30168 allocations
-Async::IO::Buffer: 20904 allocations
-Protocol::HTTP2::Window: 20162 allocations
-Set: 20091 allocations
-Async::Queue: 20082 allocations
-Method: 20006 allocations
-Protocol::HTTP::Headers::Merged: 10100 allocations
-Protocol::HTTP::Headers: 10100 allocations
-Async::Condition: 10002 allocations
-Protocol::WebSocket::Framer: 10001 allocations
-Async::HTTP::Body::Stream: 10001 allocations
-Async::HTTP::Body::Hijack: 10001 allocations
-Async::WebSocket::ConnectResponse: 10001 allocations
-Async::WebSocket::Connection: 10001 allocations
-Async::HTTP::Body::Writable: 10001 allocations
-Async::HTTP::Protocol::HTTP2::Request::Stream: 10001 allocations
-Async::HTTP::Protocol::HTTP2::Request: 10001 allocations
-Falcon::Adapters::Input: 10001 allocations
-Protocol::HTTP::Headers::Split: 10001 allocations
-Async::HTTP::Protocol::HTTP2::Stream::Input: 10001 allocations
-Async::HTTP::Protocol::HTTP2::Stream::Output: 10001 allocations
-** 80.98830116988302 objects per connection.
-```
-
-## System Limits
-
-### Fiber Performance
-
-To improve fiber performance:
-
-	export RUBY_FIBER_VM_STACK_SIZE=0
-	export RUBY_FIBER_MACHINE_STACK_SIZE=0
-	export RUBY_SHARED_FIBER_POOL_FREE_STACKS=0
-
-`RUBY_SHARED_FIBER_POOL_FREE_STACKS` is an experimental feature on `ruby-head`.
-
-### FiberError: can't set a guard page: Cannot allocate memory
-
-This error occurs because the operating system has limited resources for allocating fiber stacks.
-
-You can find the current limit:
-
-	% sysctl vm.max_map_count
-	vm.max_map_count = 65530
-
-You can increase it:
-
-	% sysctl -w vm.max_map_count=2500000
-
-## Logs
-
-### 2020
-
-```
-koyoko% ./multi-client.rb -c 100000
- 0.15s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:39 +1300]
-               | Made 1 connections: 202.88 connections/second...
- 0.15s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:39 +1300]
-               | GC.start duration=0.0s GC.count=27
- 8.82s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:47 +1300]
-               | Made 10001 connections: 1152.85 connections/second...
- 8.89s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:47 +1300]
-               | GC.start duration=0.06s GC.count=28
- 17.7s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:56 +1300]
-               | Made 20001 connections: 1139.39 connections/second...
-17.84s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:11:56 +1300]
-               | GC.start duration=0.14s GC.count=29
-26.71s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:05 +1300]
-               | Made 30001 connections: 1129.44 connections/second...
- 26.9s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:05 +1300]
-               | GC.start duration=0.19s GC.count=30
-35.97s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:14 +1300]
-               | Made 40001 connections: 1116.59 connections/second...
-36.22s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:15 +1300]
-               | GC.start duration=0.25s GC.count=31
-45.41s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:24 +1300]
-               | Made 50001 connections: 1104.74 connections/second...
-45.65s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:24 +1300]
-               | GC.start duration=0.24s GC.count=32
-54.94s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:33 +1300]
-               | Made 60001 connections: 1095.18 connections/second...
- 55.3s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:34 +1300]
-               | GC.start duration=0.37s GC.count=33
-  1m4s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:43 +1300]
-               | Made 70001 connections: 1085.98 connections/second...
-  1m5s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:43 +1300]
-               | GC.start duration=0.44s GC.count=34
- 1m14s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:53 +1300]
-               | Made 80001 connections: 1074.6 connections/second...
- 1m14s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:12:53 +1300]
-               | GC.start duration=0.36s GC.count=35
- 1m24s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:13:03 +1300]
-               | Made 90001 connections: 1066.37 connections/second...
- 1m24s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:13:03 +1300]
-               | GC.start duration=0.35s GC.count=36
- 1m34s     info: Command [oid=0x2f8] [pid=820099] [2020-02-04 23:13:13 +1300]
-               | Finished top level connection loop...
-```
-
-### 2019
-
-This report is affected by `tty-progressbar` bugs.
-
-```
-koyoko% bundle exec ./multi-client.rb --count 100000
-145.94 connection/s [                                                                                                         ] 1/100000 ( 6s/ 0s)
- 0.11s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:29:58 +1200]
-               | GC.start -> 0.01s
-591.10 connection/s [==========                                                                                        ] 10001/100000 ( 1m52s/12s)
-12.92s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:30:11 +1200]
-               | GC.start -> 0.3s
-455.06 connection/s [====================                                                                              ] 20001/100000 ( 1m42s/25s)
-26.17s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:30:24 +1200]
-               | GC.start -> 0.45s
-294.11 connection/s [=============================                                                                     ] 30001/100000 ( 1m31s/39s)
-39.95s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:30:38 +1200]
-               | GC.start -> 0.68s
-153.08 connection/s [=======================================                                                           ] 40001/100000 ( 1m19s/53s)
- 53.9s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:30:52 +1200]
-               | GC.start -> 0.8s
-23.03 connection/s [================================================                                                ] 50001/100000 ( 1m 7s/ 1m 7s)
-  1m8s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:31:07 +1200]
-               | GC.start -> 0.95s
-0.87552 connection/s [==========================================================                                       ] 60001/100000 (55s/ 1m23s)
- 1m24s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:31:23 +1200]
-               | GC.start -> 1.04s
-0.74375 connection/s [====================================================================                             ] 70001/100000 (43s/ 1m42s)
- 1m43s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:31:42 +1200]
-               | GC.start -> 1.17s
-0.64832 connection/s [==============================================================================                   ] 80001/100000 (30s/ 2m 2s)
-  2m4s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:32:02 +1200]
-               | GC.start -> 1.29s
-0.57842 connection/s [=======================================================================================          ] 90001/100000 (16s/ 2m26s)
- 2m27s     info: #<Command:0x000055de596579e8> [pid=14815] [2019-07-08 00:32:26 +1200]
-               | GC.start -> 1.55s
-435.05 connection/s [=================================================================================================] 100000/100000 ( 0s/ 2m50s)
-```

data/examples/chat/client.rb

@@ -1,32 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/io/stream'
-require 'async/http/endpoint'
-require_relative '../../lib/async/websocket/client'
-
-USER = ARGV.pop || "anonymous"
-URL = ARGV.pop || "https://localhost:8080"
-ENDPOINT = Async::HTTP::Endpoint.parse(URL)
-
-Async do |task|
-	stdin = Async::IO::Stream.new(
-		Async::IO::Generic.new($stdin)
-	)
-	
-	Async::WebSocket::Client.connect(ENDPOINT) do |connection|
-		input_task = task.async do
-			while line = stdin.read_until("\n")
-				connection.write({text: line})
-				connection.flush
-			end
-		end
-		
-		puts "Connected..."
-		while message = connection.read
-			puts "> #{message.inspect}"
-		end
-	ensure
-		input_task&.stop
-	end
-end

data/examples/chat/config.ru

@@ -1,150 +0,0 @@
-#!/usr/bin/env -S falcon serve --bind https://localhost:8080 --count 1 -c
-
-require_relative '../../lib/async/websocket/adapters/rack'
-require 'async/clock'
-require 'async/semaphore'
-require 'async/logger'
-
-require 'set'
-
-GC.disable
-
-class Room
-	def initialize
-		@connections = Set.new
-		@semaphore = Async::Semaphore.new(512)
-		
-		@count = 0
-		@profile = nil
-	end
-	
-	def connect connection
-		@connections << connection
-		
-		@count += 1
-		
-		if (@count % 10000).zero?
-			# (full_mark: false, immediate_sweep: false)
-			duration = Async::Clock.measure{GC.start}
-			Async.logger.info(self) {"GC.start duration=#{duration.round(2)}s GC.count=#{GC.count} @connections.count=#{@connections.count}"}
-		end
-	end
-	
-	def disconnect connection
-		@connections.delete(connection)
-	end
-	
-	def each(&block)
-		@connections.each(&block)
-	end
-	
-	def allocations
-		counts = Hash.new{|h,k| h[k] = 0}
-		
-		ObjectSpace.each_object do |object|
-			counts[object.class] += 1
-		end
-		
-		return counts
-	end
-	
-	def show_allocations(key, limit = 1000)
-		Async.logger.info(self) do |buffer|
-			ObjectSpace.each_object(key).each do |object|
-				buffer.puts object
-			end
-		end
-	end
-	
-	def print_allocations(minimum = @connections.count)
-		count = 0
-		
-		Async.logger.info(self) do |buffer|
-			allocations.select{|k,v| v >= minimum}.sort_by{|k,v| -v}.each do |key, value|
-				count += value
-				buffer.puts "#{key}: #{value} allocations"
-			end
-			
-			buffer.puts "** #{count.to_f / @connections.count} objects per connection."
-		end
-	end
-	
-	def start_profile
-		require 'ruby-prof' unless defined?(RubyProf)
-		
-		return false if @profile
-		
-		@profile = RubyProf::Profile.new(merge_fibers: true)
-		@profile.start
-	end
-	
-	def stop_profile
-		return false unless @profile
-		
-		result = @profile.stop
-		printer = RubyProf::FlatPrinter.new(result)
-		printer.print(STDOUT, min_percent: 0.5)
-	
-		# printer = RubyProf::GraphPrinter.new(result)
-		# printer.print(STDOUT, min_percent: 0.5)
-		
-		@profile = nil
-	end
-	
-	def command(code)
-		Async.logger.warn self, "eval(#{code})"
-		
-		eval(code)
-	end
-	
-	def broadcast(message)
-		Async.logger.info "Broadcast: #{message.inspect}"
-		start_time = Async::Clock.now
-		
-		@connections.each do |connection|
-			@semaphore.async do
-				connection.write(message)
-				connection.flush
-			end
-		end
-		
-		end_time = Async::Clock.now
-		Async.logger.info "Duration: #{(end_time - start_time).round(3)}s for #{@connections.count} connected clients."
-	end
-	
-	def open(connection)
-		self.connect(connection)
-		
-		if @connections.size == 1_000_000
-			connection.write("Congratulations, you have completed the journey to one million! 🥳 👏👏👏🏼")
-		end
-		
-		while message = connection.read
-			if message[:text] =~ /^\/(.*?)$/
-				begin
-					result = self.command($1)
-					
-					if result.is_a? Hash
-						connection.write(result)
-					else
-						connection.write({result: result.inspect})
-					end
-				rescue
-					connection.write({error: $!.inspect})
-				end
-			else
-				self.broadcast(message)
-			end
-		end
-		
-		connection.close
-	ensure
-		self.disconnect(connection)
-	end
-	
-	def call(env)
-		Async::WebSocket::Adapters::Rack.open(env, &self.method(:open))
-	end
-end
-
-run Room.new