faye-reconnect 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 141bb41cd03d805fec292ba3559e58d7d2ff0d03
+  data.tar.gz: 9c0f5a9ebb91b27c3fbf48bbca74e840170df810
+SHA512:
+  metadata.gz: 64f766e8cb14afbded68ce643671f1a6c67a3c3fc02661abc0b20210c0e53d6fe918007bd84dd178893d564c7f5352f07f2482bacd2f74a06191421d369b3c35
+  data.tar.gz: 4897f0a8ab174023926e5c356c88aab45976e559554182b69bb664c1bd61e3d8c0f2eefa174a93f796979e1b678a00b78dac0f6083f80fd115f6a89358147ac7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faye-reconnect.gemspec
+group :development do
+  gem 'faye', github: 'faye/faye'
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adrien Siami
+
+MIT License
+
+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/README.md

@@ -0,0 +1,91 @@
+# Faye::Reconnect
+
+This extension allows a faye client to retrieve its client id when restarting, after a crash, etc; thus retrieving all the messages addresses to it sent during the disconnection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faye-reconnect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faye-reconnect
+
+## Usage
+
+To require it in your application :
+
+```ruby
+require 'faye/reconnect'
+```
+
+``Faye::Reconnect`` is actually two faye extensions, one for the Faye server and one for the clients.
+
+### Server Side
+
+You just need to add the extension and pass your faye server to it :
+
+```ruby
+server = Faye::RackAdapter.new(:mount => '/faye', :timeout => 15)
+server.add_extension Faye::Reconnect::ServerExtension.new(server)
+```
+
+### Client Side
+
+The client extension has a dependency on redis. 
+It uses redis to persist the client id after each successful handshake so it can re-use it when trying to reconnect.
+
+Add the extension to your faye client :
+
+```ruby
+client = Faye::Client.new('http://localhost:9292/faye')
+client.add_extension Faye::Reconnect::ClientExtension.new({
+        name: 'your_client_name',
+        redis: {
+            host: 'localhost',
+            port: 6379,
+            password: '',
+            database: 0
+        }
+    })
+```
+
+``:name`` is mandatory, it is used to distinct clients.
+
+If you don't specify redis options, the ones provided in the above example will be used.
+
+### Shutting down and catching signals
+
+You may already have something along the lines of :
+
+```ruby
+trap('TERM') do 
+    client.disconnect
+end
+```
+
+If you plan on reconnecting with the same client id and get missing messages, you have to use the ``stop!`` method provided by this gem :
+
+```ruby
+trap('TERM') do 
+    client.stop!
+end
+```
+
+Instead of sending a ``/meta/disconnect`` message to the server, it will cleanly stop the Event Machine reactor, so the faye server is not aware you are disconnected and it will keep incoming messages until you handshake again.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/dimelo/faye-reconnect/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/faye-reconnect.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faye/reconnect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faye-reconnect"
+  spec.version       = Faye::Reconnect::VERSION
+  spec.authors       = ["Adrien Siami"]
+  spec.email         = ["adrien.siami@dimelo.com"]
+  spec.summary       = "Allow a long running faye client to reconnect to a faye server with the same client ID"
+  spec.description   = "Allow a long running faye client to reconnect to a faye server with the same client ID"
+  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_runtime_dependency 'em-hiredis', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'rspec-eventmachine', '~> 0.2.0'
+  spec.add_development_dependency 'thin'
+  spec.add_development_dependency 'pry-byebug'
+
+end

data/lib/faye/patches/client.rb

@@ -0,0 +1,22 @@
+module Faye
+  module Patches
+
+    def stop!
+      @state = Faye::Client::DISCONNECTED
+
+      info('Disconnecting ?', @dispatcher.client_id)
+      @dispatcher.close
+      info('Clearing channel listeners for ?', @dispatcher.client_id)
+      @channels = Channel::Set.new
+      true
+    end
+
+    def reconnect(&block)
+      @reconnect_callback = block
+      connect
+    end
+
+  end
+end
+
+Faye::Client.send(:include, Faye::Patches)

data/lib/faye/reconnect/client_extension.rb

@@ -0,0 +1,80 @@
+require 'em-hiredis'
+
+module Faye
+  module Reconnect
+    class ClientExtension
+
+      def initialize redis: nil, name:
+        @name = name
+        @clientIdFetched = false
+        redis ||= {}
+        redis[:host] ||= 'localhost'
+        redis[:port] ||= 6379
+        redis[:password] ||= ''
+
+        @redis = EventMachine::Hiredis::Client.new(redis[:host], redis[:port], redis[:password], redis[:database])
+        EM.schedule do
+          @redis.connect
+          @redis.errback do |reason|
+            raise "Connection to redis failed : #{reason}"
+          end
+        end
+      end
+
+      def clientIdKey
+        "#{@name}/client_id"
+      end
+
+      def fetch_client_id(&callback)
+        if @clientIdFetched == false
+          @clientIdFetched = true
+          @redis.get(clientIdKey, &callback)
+        else
+          callback.call(nil)
+        end
+      end
+
+      def set_client_id(value, &callback)
+        @redis.set(clientIdKey, value, &callback).errback(&callback)
+      end
+
+      def del_client_id(&callback)
+        @redis.del(clientIdKey, &callback).errback(&callback)
+      end
+
+      def outgoing(message, callback)
+        if message['channel'] == '/meta/disconnect'
+          del_client_id { callback.call(message) }
+        elsif message['channel'] == '/meta/handshake'
+          fetch_client_id do |clientId|
+            message['previousClientId'] = clientId if !clientId.nil?
+            callback.call(message)
+          end
+        else
+          callback.call(message)
+        end
+      end
+
+      def incoming(message, callback)
+        if message['channel'] == '/meta/handshake'
+          if message['error'] == 'Already connected' && message.key?('clientId')
+            message.delete('error')
+            message['successful'] = true
+            callback.call(message)
+          else
+            fetch_client_id do |clientId|
+              if clientId.nil?
+                set_client_id(message['clientId']) { callback.call(message) }
+              else
+                callback.call(message)
+              end
+            end
+          end
+        else
+          callback.call(message)
+        end
+      end
+
+    end
+  end
+end

data/lib/faye/reconnect/server_extension.rb

@@ -0,0 +1,27 @@
+module Faye
+  module Reconnect
+    class ServerExtension
+
+      def initialize(app)
+        @server = app.instance_variable_get(:@server)
+      end
+
+      def incoming(message, callback)
+        if message.key?('previousClientId')
+          client_id = message['previousClientId']
+          @server.engine.client_exists(client_id) do |exists|
+            if exists
+              @server.engine.ping(client_id)
+              message['clientId'] = client_id
+              message['error'] = 'Already connected'
+            end
+            callback.call(message)
+          end
+        else
+          callback.call(message)
+        end
+      end
+
+    end
+  end
+end

data/lib/faye/reconnect/version.rb

@@ -0,0 +1,5 @@
+module Faye
+  module Reconnect
+    VERSION = "0.0.2"
+  end
+end

data/lib/faye/reconnect.rb

@@ -0,0 +1,9 @@
+require "faye/reconnect/version"
+require "faye/reconnect/client_extension"
+require "faye/reconnect/server_extension"
+require "faye/patches/client"
+
+module Faye
+  module Reconnect
+  end
+end

data/spec/client_extension_spec.rb

@@ -0,0 +1,16 @@
+require 'faye'
+require 'faye/reconnect'
+require 'spec_helper'
+
+describe Faye::Reconnect::ClientExtension do
+
+  it 'requires a name option' do
+    expect {
+      Faye::Reconnect::ClientExtension.new
+    }.to raise_error(ArgumentError, "missing keyword: name")
+    expect {
+      Faye::Reconnect::ClientExtension.new(name: 'foobar')
+    }.to_not raise_error
+  end
+
+end

data/spec/reconnect_spec.rb

@@ -0,0 +1,135 @@
+require 'faye'
+require 'faye/reconnect'
+require 'rspec/em'
+require 'spec_helper'
+
+ReconnectSteps = RSpec::EM.async_steps do
+
+  def client(name, channels, &callback)
+    @clients ||= {}
+    @inboxes ||= {}
+    @clients[name] = Faye::Client.new('http://localhost:9876/faye')
+    @clients[name].add_extension(Faye::Reconnect::ClientExtension.new(name: name, redis: {database: 9}))
+    @inboxes[name] = {}
+
+    n = channels.size
+    return @clients[name].connect(&callback) if n.zero?
+
+    channels.each do |channel|
+      subscription = @clients[name].subscribe(channel) do |message|
+        @inboxes[name][channel] ||= []
+        @inboxes[name][channel] << message
+      end
+      subscription.callback do
+        n -= 1
+        callback.call if n.zero?
+      end
+      subscription.errback do |e|
+        raise e.to_s
+      end
+    end
+  end
+
+  def publish(name, channel, message, &callback)
+    @clients[name].publish(channel, message)
+    EM.add_timer(0.1, &callback)
+  end
+
+  def check_inbox(name, channel, messages, &callback)
+    inbox = @inboxes[name][channel] || []
+    expect(inbox).to eq(messages)
+    callback.call
+  end
+
+  def kill_client(name, &callback)
+    client = @clients[name]
+    @clients.delete(name)
+    @inboxes.delete(name)
+    client.stop!
+    EM.add_timer(0.1, &callback)
+  end
+
+  def disconnect_client(name, &callback)
+    client = @clients[name]
+    @clients.delete(name)
+    @inboxes.delete(name)
+    client.disconnect
+    EM.add_timer(0.1, &callback)
+  end
+
+  def flushdb(&callback)
+    @clients = {}
+    @inboxes = {}
+    @redis = EventMachine::Hiredis::Client.new('localhost', 6379, '', 9)
+    @redis.connect
+    @redis.errback do |reason|
+      raise "Connection to redis failed : #{reason}"
+    end
+    @redis.flushdb(&callback)
+  end
+
+  def launch_server(&callback)
+    Faye::WebSocket.load_adapter('thin')
+    app = Faye::RackAdapter.new(:mount => '/faye', :timeout => 25)
+    app.add_extension(Faye::Reconnect::ServerExtension.new(app))
+    Thin::Logging.silent = true
+    @server = Thin::Server.new('127.0.0.1', 9876, app)
+    @server.start
+    callback.call
+  end
+
+  def stop_server(&callback)
+    @server.stop
+    # Hack EM to stop the timers
+    EM.instance_variable_get(:@timers).each { |t,_| EM.cancel_timer(t) }
+    EM.add_timer(0.1, &callback)
+  end
+
+  def wait(time, &callback)
+    EM.add_timer(time, &callback)
+  end
+
+end
+
+describe Faye::Reconnect do
+  include ReconnectSteps
+
+  before { launch_server }
+  before { flushdb }
+
+  it 'fetches messages sent while disconnected' do
+    client 'foo', ['/foo']
+    client 'bar', ['/bar']
+    kill_client 'foo'
+    publish 'bar', '/foo', {'hello' => 'world'}
+    client 'foo', ['/foo']
+    wait 0.2
+    check_inbox 'foo', '/foo', [{'hello' => 'world'}]
+  end
+
+  it 'does not re-use clientId when issuing a legal disconnect' do
+    client 'foo', ['/foo']
+    client 'bar', ['/bar']
+    disconnect_client 'foo'
+    publish 'bar', '/foo', {'hello' => 'world'}
+    client 'foo', ['/foo']
+    wait 0.2
+    check_inbox 'foo', '/foo', []
+  end
+
+  it 'is scoped by name' do
+    client 'foo', ['/foo']
+    client 'baz', ['/baz']
+    client 'bar', ['/bar']
+    kill_client 'foo'
+    kill_client 'baz'
+    publish 'bar', '/foo', {'hello' => 'foo'}
+    publish 'bar', '/baz', {'hello' => 'baz'}
+    client 'foo', ['/foo']
+    client 'baz', ['/baz']
+    wait 0.2
+    check_inbox 'foo', '/foo', [{'hello' => 'foo'}]
+    check_inbox 'baz', '/baz', [{'hello' => 'baz'}]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: faye-reconnect
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adrien Siami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allow a long running faye client to reconnect to a faye server with the
+  same client ID
+email:
+- adrien.siami@dimelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faye-reconnect.gemspec
+- lib/faye/patches/client.rb
+- lib/faye/reconnect.rb
+- lib/faye/reconnect/client_extension.rb
+- lib/faye/reconnect/server_extension.rb
+- lib/faye/reconnect/version.rb
+- spec/client_extension_spec.rb
+- spec/reconnect_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Allow a long running faye client to reconnect to a faye server with the same
+  client ID
+test_files:
+- spec/client_extension_spec.rb
+- spec/reconnect_spec.rb
+- spec/spec_helper.rb