faye-redis 0.1.0 → 0.1.1

data/CHANGELOG.txt

@@ -0,0 +1,9 @@
+=== 0.1.1 / 2013-04-28
+
+* Improve garbage collection to avoid leaking Redis memory
+
+
+=== 0.1.0 / 2012-02-26
+
+* Initial release: Redis backend for Faye 0.8
+

data/README.rdoc

@@ -1,4 +1,4 @@
-= Faye::Redis {<img src="https://secure.travis-ci.org/faye/faye-redis-ruby.png?branch=master" alt="Build Status" />}[http://travis-ci.org/faye/faye-redis-ruby]
+= Faye::Redis {<img src="https://secure.travis-ci.org/faye/faye-redis-ruby.png" alt="Build Status" />}[http://travis-ci.org/faye/faye-redis-ruby]
 
 This plugin provides a Redis-based backend for the {Faye}[http://faye.jcoglan.com]
 messaging server. It allows a single Faye service to be distributed across many
@@ -12,7 +12,7 @@ Pass in the engine and any settings you need when setting up your Faye server.
 
     require 'faye'
     require 'faye/redis'
-    
+
     bayeux = Faye::RackAdapter.new(
       :mount   => '/',
       :timeout => 25,
@@ -25,6 +25,7 @@ Pass in the engine and any settings you need when setting up your Faye server.
 
 The full list of settings is as follows.
 
+* <b><tt>:uri</tt></b> - redis URL (example: redis://:secretpassword@example.com:9000/4)
 * <b><tt>:host</tt></b> - hostname of your Redis instance
 * <b><tt>:port</tt></b> - port number, default is +6379+
 * <b><tt>:password</tt></b> - password, if +requirepass+ is set

data/lib/faye/redis.rb

@@ -3,60 +3,57 @@ require 'yajl'
 
 module Faye
   class Redis
-    
+
     DEFAULT_HOST     = 'localhost'
     DEFAULT_PORT     = 6379
     DEFAULT_DATABASE = 0
     DEFAULT_GC       = 60
     LOCK_TIMEOUT     = 120
-    
+
     def self.create(server, options)
       new(server, options)
     end
-    
+
     def initialize(server, options)
       @server  = server
       @options = options
     end
-    
+
     def init
       return if @redis
-      
+
+      uri    = @options[:uri]       || nil
       host   = @options[:host]      || DEFAULT_HOST
       port   = @options[:port]      || DEFAULT_PORT
       db     = @options[:database]  || DEFAULT_DATABASE
-      auth   = @options[:password]
+      auth   = @options[:password]  || nil
       gc     = @options[:gc]        || DEFAULT_GC
       @ns    = @options[:namespace] || ''
-      socket = @options[:socket]
-      
-      if socket
-        @redis      = EventMachine::Hiredis::Client.connect(socket, nil)
-        @subscriber = EventMachine::Hiredis::Client.connect(socket, nil)
+      socket = @options[:socket]    || nil
+
+      if uri
+        @redis = EventMachine::Hiredis.connect(uri)
+      elsif socket
+        @redis = EventMachine::Hiredis::Client.new(socket, nil, auth, db).connect
       else
-        @redis      = EventMachine::Hiredis::Client.connect(host, port)
-        @subscriber = EventMachine::Hiredis::Client.connect(host, port)
-      end
-      if auth
-        @redis.auth(auth)
-        @subscriber.auth(auth)
+        @redis = EventMachine::Hiredis::Client.new(host, port, auth, db).connect
       end
-      @redis.select(db)
-      @subscriber.select(db)
-      
+      @subscriber = @redis.pubsub
+
       @subscriber.subscribe(@ns + '/notifications')
       @subscriber.on(:message) do |topic, message|
         empty_queue(message) if topic == @ns + '/notifications'
       end
-      
+
       @gc = EventMachine.add_periodic_timer(gc, &method(:gc))
     end
-    
+
     def disconnect
+      return unless @redis
       @subscriber.unsubscribe(@ns + '/notifications')
       EventMachine.cancel_timer(@gc)
     end
-    
+
     def create_client(&callback)
       init
       client_id = @server.generate_id
@@ -68,48 +65,53 @@ module Faye
         callback.call(client_id)
       end
     end
-    
+
+    def client_exists(client_id, &callback)
+      init
+      cutoff = get_current_time - (1000 * 1.6 * @server.timeout)
+
+      @redis.zscore(@ns + '/clients', client_id) do |score|
+        callback.call(score.to_i > cutoff)
+      end
+    end
+
     def destroy_client(client_id, &callback)
       init
-      @redis.zrem(@ns + '/clients', client_id)
-      @redis.del(@ns + "/clients/#{client_id}/messages")
-      
-      @redis.smembers(@ns + "/clients/#{client_id}/channels") do |channels|
-        i, n = 0, channels.size
-        next after_destroy(client_id, &callback) if i == n
-        
-        channels.each do |channel|
-          unsubscribe(client_id, channel) do
-            i += 1
-            after_destroy(client_id, &callback) if i == n
+      @redis.zadd(@ns + '/clients', 0, client_id) do
+        @redis.smembers(@ns + "/clients/#{client_id}/channels") do |channels|
+          i, n = 0, channels.size
+          next after_subscriptions_removed(client_id, &callback) if i == n
+
+          channels.each do |channel|
+            unsubscribe(client_id, channel) do
+              i += 1
+              after_subscriptions_removed(client_id, &callback) if i == n
+            end
           end
         end
       end
     end
-    
-    def after_destroy(client_id, &callback)
-      @server.debug 'Destroyed client ?', client_id
-      @server.trigger(:disconnect, client_id)
-      callback.call if callback
-    end
-    
-    def client_exists(client_id, &callback)
-      init
-      @redis.zscore(@ns + '/clients', client_id) do |score|
-        callback.call(score != nil)
+
+    def after_subscriptions_removed(client_id, &callback)
+      @redis.del(@ns + "/clients/#{client_id}/messages") do
+        @redis.zrem(@ns + '/clients', client_id) do
+          @server.debug 'Destroyed client ?', client_id
+          @server.trigger(:disconnect, client_id)
+          callback.call if callback
+        end
       end
     end
-    
+
     def ping(client_id)
       init
       timeout = @server.timeout
       return unless Numeric === timeout
-      
+
       time = get_current_time
       @server.debug 'Ping ?, ?', client_id, time
       @redis.zadd(@ns + '/clients', time, client_id)
     end
-    
+
     def subscribe(client_id, channel, &callback)
       init
       @redis.sadd(@ns + "/clients/#{client_id}/channels", channel) do |added|
@@ -120,7 +122,7 @@ module Faye
         callback.call if callback
       end
     end
-    
+
     def unsubscribe(client_id, channel, &callback)
       init
       @redis.srem(@ns + "/clients/#{client_id}/channels", channel) do |removed|
@@ -131,57 +133,64 @@ module Faye
         callback.call if callback
       end
     end
-    
+
     def publish(message, channels)
       init
       @server.debug 'Publishing message ?', message
-      
+
       json_message = Yajl::Encoder.encode(message)
       channels     = Channel.expand(message['channel'])
       keys         = channels.map { |c| @ns + "/channels#{c}" }
-      
+
       @redis.sunion(*keys) do |clients|
         clients.each do |client_id|
+          queue = @ns + "/clients/#{client_id}/messages"
+
           @server.debug 'Queueing for client ?: ?', client_id, message
-          @redis.rpush(@ns + "/clients/#{client_id}/messages", json_message)
+          @redis.rpush(queue, json_message)
           @redis.publish(@ns + '/notifications', client_id)
+
+          client_exists(client_id) do |exists|
+            @redis.del(queue) unless exists
+          end
         end
       end
-      
+
       @server.trigger(:publish, message['clientId'], message['channel'], message['data'])
     end
-    
+
     def empty_queue(client_id)
       return unless @server.has_connection?(client_id)
       init
-      
+
       key = @ns + "/clients/#{client_id}/messages"
-      
+
       @redis.multi
       @redis.lrange(key, 0, -1)
       @redis.del(key)
       @redis.exec.callback  do |json_messages, deleted|
+        next unless json_messages
         messages = json_messages.map { |json| Yajl::Parser.parse(json) }
         @server.deliver(client_id, messages)
       end
     end
-    
+
   private
-    
+
     def get_current_time
       (Time.now.to_f * 1000).to_i
     end
-    
+
     def gc
       timeout = @server.timeout
       return unless Numeric === timeout
-      
+
       with_lock 'gc' do |release_lock|
         cutoff = get_current_time - 1000 * 2 * timeout
         @redis.zrangebyscore(@ns + '/clients', 0, cutoff) do |clients|
           i, n = 0, clients.size
           next release_lock.call if i == n
-          
+
           clients.each do |client_id|
             destroy_client(client_id) do
               i += 1
@@ -191,32 +200,32 @@ module Faye
         end
       end
     end
-    
+
     def with_lock(lock_name, &block)
       lock_key     = @ns + '/locks/' + lock_name
       current_time = get_current_time
       expiry       = current_time + LOCK_TIMEOUT * 1000 + 1
-      
+
       release_lock = lambda do
         @redis.del(lock_key) if get_current_time < expiry
       end
-      
+
       @redis.setnx(lock_key, expiry) do |set|
         next block.call(release_lock) if set == 1
-        
+
         @redis.get(lock_key) do |timeout|
           next unless timeout
-          
+
           lock_timeout = timeout.to_i(10)
           next if current_time < lock_timeout
-          
+
           @redis.getset(lock_key, expiry) do |old_value|
             block.call(release_lock) if old_value == timeout
           end
         end
       end
     end
-    
+
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &10557300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,31 @@ dependencies:
         version: 0.12.0
   type: :runtime
   prerelease: false
-  version_requirements: *10557300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &10556820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *10556820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &10556360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,18 +53,28 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *10556360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10555900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10555900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: jcoglan@gmail.com
 executables: []
@@ -63,9 +83,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - README.rdoc
-- spec/redis.conf
-- spec/faye_redis_spec.rb
-- spec/spec_helper.rb
+- CHANGELOG.txt
 - lib/faye/redis.rb
 homepage: http://github.com/faye/faye-redis-ruby
 licenses: []
@@ -89,8 +107,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Redis backend engine for Faye
 test_files: []
+has_rdoc: 

data/spec/faye_redis_spec.rb

@@ -1,26 +0,0 @@
-require "spec_helper"
-
-describe Faye::Redis do
-  let(:engine_opts)  do
-    pw = ENV["TRAVIS"] ? nil : "foobared"
-    {:type => Faye::Redis, :password => pw, :namespace => Time.now.to_i.to_s}
-  end
-  
-  after do
-    engine.disconnect
-    redis = EM::Hiredis::Client.connect('localhost', 6379)
-    redis.auth(engine_opts[:password])
-    redis.flushall
-  end
-  
-  it_should_behave_like "faye engine"
-  it_should_behave_like "distributed engine"
-  
-  next if ENV["TRAVIS"]
-  
-  describe "using a Unix socket" do
-    before { engine_opts[:socket] = "/tmp/redis.sock" }
-    it_should_behave_like "faye engine"
-  end
-end
-

data/spec/redis.conf

@@ -1,42 +0,0 @@
-daemonize no
-pidfile /tmp/redis.pid
-port 6379
-unixsocket /tmp/redis.sock
-timeout 300
-loglevel verbose
-logfile stdout
-databases 16
-
-save 900 1
-save 300 10
-save 60 10000
-
-rdbcompression yes
-dbfilename dump.rdb
-dir ./
-
-slave-serve-stale-data yes
-
-requirepass foobared
-
-appendonly no
-appendfsync everysec
-no-appendfsync-on-rewrite no
-
-vm-enabled no
-vm-swap-file /tmp/redis.swap
-vm-max-memory 0
-vm-page-size 32
-vm-pages 134217728
-vm-max-threads 4
-
-hash-max-zipmap-entries 512
-hash-max-zipmap-value 64
-
-list-max-ziplist-entries 512
-list-max-ziplist-value 64
-
-set-max-intset-entries 512
-
-activerehashing yes
-

data/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-require File.expand_path('../../lib/faye/redis', __FILE__)
-require File.expand_path('../../vendor/faye/spec/ruby/engine_examples', __FILE__)
-