socky-server 0.5.0.beta1 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0 / 2012-02-16
+
+- Performance fixes - sending messages should be now 3-5 times faster(thanks to @piotrmarat)
+
 ## 0.5.0.beta1 / 2011-08-01
 
 Socky was rewritten from scratch. From this version it's Rack application and is based on
@@ -105,4 +109,4 @@ And many more - please check [Socky website](http://socky.org) for more or check
 
 ## 0.0.6 / 2010-05-24
 
-- initial release
+- initial release

data/README.md

@@ -2,21 +2,25 @@
 
 ## Installation
 
-    $ gem install socky-server --pre
+``` bash
+$ gem install socky-server --pre
+```
 
 ## Usage
 
 Socky server provides two Rack middlewares - WebSocket and HTTP. Each one of them can be used separately, but they can be also used in one process. Example Rackup file could look like that:
 
-    require 'socky/server'
-    
-    map '/websocket' do
-      run Socky::Server::WebSocket.new
-    end
-    
-    map '/http' do
-      run Socky::Server::HTTP.new
-    end
+``` ruby
+require 'socky/server'
+
+map '/websocket' do
+  run Socky::Server::WebSocket.new
+end
+
+map '/http' do
+  run Socky::Server::HTTP.new
+end
+```
 
 ## Configuration
 
@@ -26,7 +30,9 @@ Both middlewares accept options as hash. Currently available options are:
 
 Hash of supported applications. Each key is application name, each value is application secret. You can use as much applications as you want - each of them will have separate application address created by mixing hostname, middleware address and applicatio name. So i.e. for app "my_app" WebSocket application uri will be:
 
-    http://example.org/websocket/my_app
+```
+http://example.org/websocket/my_app
+```
 
 ### :debug [Boolean]
 
@@ -40,28 +46,32 @@ Path to YAML config file. Config file should contain hash with exactly the same
 
 Create file 'config.ru':
 
-    require 'socky/server'
+``` ruby
+require 'socky/server'
 
-    options = {
-      :debug => true,
-      :applications => {
-        :my_app => 'my_secret',
-        :other_app => 'other_secret'
-      }
-    }
+options = {
+  :debug => true,
+  :applications => {
+    :my_app => 'my_secret',
+    :other_app => 'other_secret'
+  }
+}
 
-    map '/websocket' do
-      run Socky::Server::WebSocket.new options
-    end
+map '/websocket' do
+  run Socky::Server::WebSocket.new options
+end
 
-    map '/http' do
-      use Rack::CommonLogger
-      run Socky::Server::HTTP.new options
-    end
+map '/http' do
+  use Rack::CommonLogger
+  run Socky::Server::HTTP.new options
+end
+```
 
 Run file using Thin:
 
-    $ thin -R config.ru -p3001 start
+``` bash
+$ thin -R config.ru -p3001 start
+```
 
 ## Setting other options
 

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
+require File.expand_path(File.join(File.dirname(__FILE__), 'tasks/performance'))
 
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = ["-c", "-f progress"]

data/lib/socky/server.rb

@@ -10,14 +10,15 @@ module Socky
   module Server
     ROOT = File.expand_path(File.dirname(__FILE__))
   
-    autoload :Application, "#{ROOT}/server/application"
-    autoload :Channel,     "#{ROOT}/server/channel"
-    autoload :Config,      "#{ROOT}/server/config"
-    autoload :Connection,  "#{ROOT}/server/connection"
-    autoload :HTTP,        "#{ROOT}/server/http"
-    autoload :Logger,      "#{ROOT}/server/logger"
-    autoload :Message,     "#{ROOT}/server/message"
-    autoload :Misc,        "#{ROOT}/server/misc"
-    autoload :WebSocket,   "#{ROOT}/server/websocket"
+    autoload :Application,     "#{ROOT}/server/application"
+    autoload :Channel,         "#{ROOT}/server/channel"
+    autoload :Config,          "#{ROOT}/server/config"
+    autoload :Connection,      "#{ROOT}/server/connection"
+    autoload :HTTP,            "#{ROOT}/server/http"
+    autoload :Logger,          "#{ROOT}/server/logger"
+    autoload :Message,         "#{ROOT}/server/message"
+    autoload :Misc,            "#{ROOT}/server/misc"
+    autoload :WebSocket,       "#{ROOT}/server/websocket"
+    autoload :CachedJsonHash,  "#{ROOT}/server/cached_json_hash"
   end
-end
+end

data/lib/socky/server/cached_json_hash.rb

@@ -0,0 +1,16 @@
+module Socky
+  module Server
+    class CachedJsonHash < Hash
+
+      def to_json
+        @json ||= super
+      end
+
+      def remove_cache
+        @json = nil
+      end
+
+    end
+  end
+end
+

data/lib/socky/server/channel/base.rb

@@ -34,8 +34,9 @@ module Socky
         end
         
         def send_data(data, except = nil)
+          cached_json_data = CachedJsonHash[data]
           self.subscribers.each do |subscriber_id, subscriber|
-            subscriber['connection'].send_data(data) unless subscriber_id == except || !subscriber['read']
+            subscriber['connection'].send_data(cached_json_data) unless subscriber_id == except || !subscriber['read']
           end
         end
         
@@ -51,7 +52,7 @@ module Socky
         
         def deliver(connection, message)
           return unless connection.nil? || (subscribers[connection.id] && subscribers[connection.id]['write'])
-          send_data({ 'event' => message.event, 'channel' => self.name, 'data' => message.user_data })
+          send_data('event' => message.event, 'channel' => self.name, 'data' => message.user_data)
         end
         
         protected

data/lib/socky/server/version.rb

@@ -1,5 +1,5 @@
 module Socky
   module Server
-    VERSION = '0.5.0.beta1'
+    VERSION = '0.5.0'
   end
 end

data/socky-server.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |s|
   s.homepage    = "http://socky.org"
   s.summary     = %q{Socky is a WebSocket server and client for Ruby}
   s.description = %q{Socky is a WebSocket server and client for Ruby}
-  
-  s.add_dependency 'websocket-rack', ">= 0.2.1"
-  s.add_dependency 'socky-authenticator', '~> 0.5.0.beta5'
+
+  s.add_dependency 'websocket-rack', ">= 0.3.2"
+  s.add_dependency 'socky-authenticator', '~> 0.5.0'
   s.add_dependency 'json'
   s.add_development_dependency 'rspec', '~> 2.0'
 

data/spec/performance/connectin_performance.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'performance_helper'
+require 'benchmark'
+
+describe 'Connecting Performance' do
+
+  it "For x listeners" do
+    [1, 10, 100].each do |count|
+      results = []
+      5.times do
+        @application = Socky::Server::Application.new('test_application', 'test_secret')
+        @channel = "presence"
+        results << Benchmark.realtime {count.times { add_listener }}
+        clean_application
+      end
+      print_result count, results
+    end
+  end
+
+end
+
+
+
+
+
+

data/spec/performance/send_many_messages_performance.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'performance_helper'
+require 'benchmark'
+
+describe 'Sending Many Messages Performance' do
+
+  it "For 1 listener and x messages" do
+    [1, 10, 100].each do |count|
+      results = []
+      5.times do
+        @channel = "private"
+        @application = application_with_listeners(1)
+        results << Benchmark.realtime {send_messages(count)}
+        clean_application
+      end
+      print_result count, results
+    end
+  end
+
+end
+
+
+
+
+

data/spec/performance/send_message_to_many_listeners_performance.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'performance_helper'
+require 'benchmark'
+
+describe 'Sending Message To Many Listeners Performance' do
+
+  it "For x listeners and 1 message" do
+    [1, 10, 100].each do |count|
+      results = []
+      5.times do 
+        @channel = "private"
+        @application = application_with_listeners(count)
+        results << Benchmark.realtime {send_messages(1)}
+        clean_application
+      end
+      print_result count, results
+    end
+  end
+end
+
+
+
+
+
+

data/spec/performance_helper.rb

@@ -0,0 +1,55 @@
+Socky::Server::Channel::Private.class_eval do
+  protected
+
+  def check_auth(connection, message)
+    true
+  end
+
+end
+
+
+def application_with_listeners count
+  @application = Socky::Server::Application.new('test_application', 'test_secret')
+  count.times { add_listener }
+  add_writer
+  @application
+end
+
+def add_listener
+  websocket = mock_websocket(@application.name)
+  env = { 'PATH_INFO' => '/websocket/' + @application.name }
+  websocket.on_open(env)
+  data = {'event' => 'socky:subscribe', 'channel' => "#{@channel}-channel", 'auth' => 'test_auth'}
+  websocket.on_message(env, data)
+  websocket
+end
+
+def add_writer
+  @writer_ws = mock_websocket(@application.name)
+  env = { 'PATH_INFO' => '/websocket/' + @application.name }
+  @writer_ws.on_open(env)
+  data = {'event' => 'socky:subscribe', 'channel' => "#{@channel}-channel", 'write' => 'true', 'auth' => 'test_auth'}
+  @writer_ws.on_message(env, data)
+  @writer_ws
+end
+
+def send_messages count
+  env = { 'PATH_INFO' => '/websocket/' + @application.name }
+  data = {'event' => 'send', 'channel' => "#{@channel}-channel", 'user_data' => "test_message"}
+  count.times { @writer_ws.on_message(env, data) }
+end
+
+def clean_application
+  @application.connections.values.each {|c| c.destroy}
+  Socky::Server::Channel::Private.list['test_application'] = Hash.new
+  Socky::Server::Channel::Private.list['test_application'] = Hash.new
+  Socky::Server::Application.list.delete('test_application') 
+end
+
+
+def print_result label, results
+  avg = results.inject(0.0) { |sum, el| sum + el } / results.size
+  puts ["#{label}:".ljust(15), avg].join
+end
+
+

data/spec/spec_helper.rb

@@ -8,13 +8,16 @@ def mock_websocket(application)
   env = {}
   env['PATH_INFO'] = '/websocket/' + application
   connection = Socky::Server::WebSocket.new.call(env)
-  connection.stub!(:send_data)
+  send_data_method = connection.method(:send_data)
+  connection.stub!(:send_data).and_return do |*args|
+    a = send_data_method.call(*args)
+  end
   connection
 end
 
 def mock_connection(application)
   websocket = mock_websocket(application)
-  
+
   env = { 'PATH_INFO' => '/websocket/' + application }
   websocket.on_open(env)
 end
@@ -24,4 +27,4 @@ def auth_token(socket, channel_name, remains = {})
     'connection_id' => socket.connection.id,
     'channel' => channel_name
   }.merge(remains), :allow_changing_rights => true, :secret => 'test_secret')['auth']
-end
+end

data/tasks/performance.rb

@@ -0,0 +1,11 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  desc "Run the performance tests"
+  RSpec::Core::RakeTask.new("performance") do |t|
+    t.pattern = "./spec/**/*_performance.rb"
+    t.rspec_opts = ["-c", "-f documentation"]
+  end
+end
+

metadata

@@ -1,42 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: socky-server
 version: !ruby/object:Gem::Version
-  version: 0.5.0.beta1
-  prerelease: 6
+  version: 0.5.0
+  prerelease: 
 platform: ruby
 authors:
 - Bernard Potocki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-01 00:00:00.000000000 +02:00
-default_executable: 
+date: 2012-02-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70321806627380 !ruby/object:Gem::Requirement
+  requirement: &70158364026200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70321806627380
+  version_requirements: *70158364026200
 - !ruby/object:Gem::Dependency
   name: socky-authenticator
-  requirement: &70321806626880 !ruby/object:Gem::Requirement
+  requirement: &70158364024620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0.beta5
+        version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70321806626880
+  version_requirements: *70158364024620
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70321806626500 !ruby/object:Gem::Requirement
+  requirement: &70158364024140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70321806626500
+  version_requirements: *70158364024140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70321806625940 !ruby/object:Gem::Requirement
+  requirement: &70158364022880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +54,7 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70321806625940
+  version_requirements: *70158364022880
 description: Socky is a WebSocket server and client for Ruby
 email:
 - bernard.potocki@imanel.org
@@ -73,6 +72,7 @@ files:
 - example/config.yml
 - lib/socky/server.rb
 - lib/socky/server/application.rb
+- lib/socky/server/cached_json_hash.rb
 - lib/socky/server/channel.rb
 - lib/socky/server/channel/base.rb
 - lib/socky/server/channel/presence.rb
@@ -93,13 +93,17 @@ files:
 - spec/integration/ws_connection_spec.rb
 - spec/integration/ws_presence_spec.rb
 - spec/integration/ws_rights_spec.rb
+- spec/performance/connectin_performance.rb
+- spec/performance/send_many_messages_performance.rb
+- spec/performance/send_message_to_many_listeners_performance.rb
+- spec/performance_helper.rb
 - spec/spec_helper.rb
 - spec/support/websocket_application.rb
 - spec/unit/socky/server/application_spec.rb
 - spec/unit/socky/server/config_spec.rb
 - spec/unit/socky/server/connection_spec.rb
 - spec/unit/socky/server/message_spec.rb
-has_rdoc: true
+- tasks/performance.rb
 homepage: http://socky.org
 licenses: []
 post_install_message: 
@@ -115,12 +119,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Socky is a WebSocket server and client for Ruby
@@ -130,6 +134,10 @@ test_files:
 - spec/integration/ws_connection_spec.rb
 - spec/integration/ws_presence_spec.rb
 - spec/integration/ws_rights_spec.rb
+- spec/performance/connectin_performance.rb
+- spec/performance/send_many_messages_performance.rb
+- spec/performance/send_message_to_many_listeners_performance.rb
+- spec/performance_helper.rb
 - spec/spec_helper.rb
 - spec/support/websocket_application.rb
 - spec/unit/socky/server/application_spec.rb