rapns 1.0.1 → 1.0.2

data/README.md

@@ -123,6 +123,10 @@ It is your responsibility to avoid creating new notifications for devices that n
 
 After updating you should run `rails g rapns` to check for any new migrations or configuration changes.
 
+## Wiki
+
+* [Why open multiple connections to the APNs?](https://github.com/ileitch/rapns/wiki/Why-open-multiple-connections-to-the-APNs%3F)
+
 ## Contributing to rapns
 
 Fork as usual and go crazy!

data/lib/rapns/daemon/database_reconnectable.rb

@@ -0,0 +1,52 @@
+class PGError < StandardError; end if !defined?(PGError)
+module Mysql; class Error < StandardError; end; end if !defined?(Mysql)
+module Mysql2; class Error < StandardError; end; end if !defined?(Mysql2)
+
+module Rapns
+  module Daemon
+    module DatabaseReconnectable
+      ADAPTER_ERRORS = [ActiveRecord::StatementInvalid, PGError, Mysql::Error, Mysql2::Error]
+
+      def with_database_reconnect_and_retry
+        begin
+          yield
+        rescue *ADAPTER_ERRORS => e
+          Rapns::Daemon.logger.error(e)
+          database_connection_lost
+          retry
+        end
+      end
+
+      def database_connection_lost
+        Rapns::Daemon.logger.warn("[#{name}] Lost connection to database, reconnecting...")
+        attempts = 0
+        loop do
+          begin
+            Rapns::Daemon.logger.warn("[#{name}] Attempt #{attempts += 1}")
+            reconnect_database
+            check_database_is_connected
+            break
+          rescue *ADAPTER_ERRORS => e
+            Rapns::Daemon.logger.error(e, :airbrake_notify => false)
+            sleep_to_avoid_thrashing
+          end
+        end
+        Rapns::Daemon.logger.warn("[#{name}] Database reconnected")
+      end
+
+      def reconnect_database
+        ActiveRecord::Base.clear_all_connections!
+        ActiveRecord::Base.establish_connection
+      end
+
+      def check_database_is_connected
+        # Simply asking the adapter for the connection state is not sufficient.
+        Rapns::Notification.count
+      end
+
+      def sleep_to_avoid_thrashing
+        sleep 2
+      end
+    end
+  end
+end

data/lib/rapns/daemon/delivery_handler.rb

@@ -1,6 +1,8 @@
 module Rapns
   module Daemon
     class DeliveryHandler
+      include DatabaseReconnectable
+
       STOP = 0x666
       SELECT_TIMEOUT = 0.5
       ERROR_TUPLE_BYTES = 6
@@ -16,6 +18,8 @@ module Rapns
         255 => "None (unknown error)"
       }
 
+      attr_reader :name
+
       def initialize(i)
         @name = "DeliveryHandler #{i}"
         host = Rapns::Daemon.configuration.push.host
@@ -46,9 +50,11 @@ module Rapns
           @connection.write(notification.to_binary)
           check_for_error
 
-          notification.delivered = true
-          notification.delivered_at = Time.now
-          notification.save!(:validate => false)
+          with_database_reconnect_and_retry do
+            notification.delivered = true
+            notification.delivered_at = Time.now
+            notification.save!(:validate => false)
+          end
 
           Rapns::Daemon.logger.info("Notification #{notification.id} delivered to #{notification.device_token}")
         rescue Rapns::DeliveryError, Rapns::DisconnectionError => error
@@ -58,13 +64,15 @@ module Rapns
       end
 
       def handle_delivery_error(notification, error)
-        notification.delivered = false
-        notification.delivered_at = nil
-        notification.failed = true
-        notification.failed_at = Time.now
-        notification.error_code = error.code
-        notification.error_description = error.description
-        notification.save!(:validate => false)
+        with_database_reconnect_and_retry do
+          notification.delivered = false
+          notification.delivered_at = nil
+          notification.failed = true
+          notification.failed_at = Time.now
+          notification.error_code = error.code
+          notification.error_description = error.description
+          notification.save!(:validate => false)
+        end
       end
 
       def check_for_error

data/lib/rapns/daemon/feeder.rb

@@ -1,16 +1,15 @@
-class PGError < StandardError; end if !defined?(PGError)
-module Mysql; class Error < StandardError; end; end if !defined?(Mysql)
-module Mysql2; class Error < StandardError; end; end if !defined?(Mysql2)
-
-ADAPTER_ERRORS = [PGError, Mysql::Error, Mysql2::Error]
-
 module Rapns
   module Daemon
     class Feeder
+      extend DatabaseReconnectable
       extend InterruptibleSleep
 
+      def self.name
+        "Feeder"
+      end
+
       def self.start(foreground)
-        connect unless foreground
+        reconnect_database unless foreground
 
         loop do
           break if @stop
@@ -28,49 +27,17 @@ module Rapns
 
       def self.enqueue_notifications
         begin
-          if Rapns::Daemon.delivery_queue.notifications_processed?
-            Rapns::Notification.ready_for_delivery.each do |notification|
-              Rapns::Daemon.delivery_queue.push(notification)
+          with_database_reconnect_and_retry do
+            if Rapns::Daemon.delivery_queue.notifications_processed?
+              Rapns::Notification.ready_for_delivery.each do |notification|
+                Rapns::Daemon.delivery_queue.push(notification)
+              end
             end
           end
-        rescue ActiveRecord::StatementInvalid, *ADAPTER_ERRORS => e
-          Rapns::Daemon.logger.error(e)
-          reconnect
         rescue StandardError => e
           Rapns::Daemon.logger.error(e)
         end
       end
-
-      def self.reconnect
-        Rapns::Daemon.logger.warn('Lost connection to database, reconnecting...')
-        attempts = 0
-        loop do
-          begin
-            Rapns::Daemon.logger.warn("Attempt #{attempts += 1}")
-            connect
-            check_is_connected
-            break
-          rescue *ADAPTER_ERRORS => e
-            Rapns::Daemon.logger.error(e, :airbrake_notify => false)
-            sleep_to_avoid_thrashing
-          end
-        end
-        Rapns::Daemon.logger.warn('Database reconnected')
-      end
-
-      def self.connect
-        ActiveRecord::Base.clear_all_connections!
-        ActiveRecord::Base.establish_connection
-      end
-
-      def self.check_is_connected
-        # Simply asking the adapter for the connection state is not sufficient.
-        Rapns::Notification.count
-      end
-
-      def self.sleep_to_avoid_thrashing
-        sleep 2
-      end
     end
   end
 end

data/lib/rapns/daemon/logger.rb

@@ -39,9 +39,9 @@ module Rapns
         return unless @options[:airbrake_notify] == true
 
         if defined?(Airbrake)
-          Airbrake.notify(e)
+          Airbrake.notify_or_ignore(e)
         elsif defined?(HoptoadNotifier)
-          HoptoadNotifier.notify(e)
+          HoptoadNotifier.notify_or_ignore(e)
         end
       end
 

data/lib/rapns/daemon.rb

@@ -9,6 +9,7 @@ require 'rapns/daemon/delivery_error'
 require 'rapns/daemon/disconnection_error'
 require 'rapns/daemon/pool'
 require 'rapns/daemon/connection'
+require 'rapns/daemon/database_reconnectable'
 require 'rapns/daemon/delivery_queue'
 require 'rapns/daemon/delivery_handler'
 require 'rapns/daemon/delivery_handler_pool'
@@ -92,8 +93,12 @@ module Rapns
 
     def self.write_pid_file
       if !configuration.pid_file.blank?
-        File.open(configuration.pid_file, 'w') do |f|
-          f.puts $$
+        begin
+          File.open(configuration.pid_file, 'w') do |f|
+            f.puts $$
+          end
+        rescue SystemCallError => e
+          logger.error("Failed to write PID to '#{configuration.pid_file}': #{e.inspect}")
         end
       end
     end

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/rapns/daemon/database_reconnectable_spec.rb

@@ -0,0 +1,106 @@
+require "spec_helper"
+
+describe Rapns::Daemon::DatabaseReconnectable do
+  class TestDouble
+    include Rapns::Daemon::DatabaseReconnectable
+
+    attr_reader :name
+
+    def initialize(error, max_calls)
+      @name = 'TestDouble'
+      @error = error
+      @max_calls = max_calls
+      @calls = 0
+    end
+
+    def perform
+      with_database_reconnect_and_retry do
+        @calls += 1
+        raise @error if @calls <= @max_calls
+      end
+    end
+  end
+
+  let(:adapter_error_class) do
+    case $adapter
+    when 'postgresql'
+      PGError
+    when 'mysql'
+      Mysql::Error
+    when 'mysql2'
+      Mysql2::Error
+    else
+      raise "Please update #{__FILE__} for adapter #{$adapter}"
+    end
+  end
+  let(:error) { adapter_error_class.new("db down!") }
+  let(:test_double) { TestDouble.new(error, 1) }
+
+  before do
+    @logger = mock("Logger", :info => nil, :error => nil, :warn => nil)
+    Rapns::Daemon.stub(:logger).and_return(@logger)
+
+    ActiveRecord::Base.stub(:clear_all_connections!)
+    ActiveRecord::Base.stub(:establish_connection)
+    test_double.stub(:sleep)
+  end
+
+  it "should log the error raised" do
+    Rapns::Daemon.logger.should_receive(:error).with(error)
+    test_double.perform
+  end
+
+  it "should log that the database is being reconnected" do
+    Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Lost connection to database, reconnecting...")
+    test_double.perform
+  end
+
+  it "should log the reconnection attempt" do
+    Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Attempt 1")
+    test_double.perform
+  end
+
+  it "should clear all connections" do
+    ActiveRecord::Base.should_receive(:clear_all_connections!)
+    test_double.perform
+  end
+
+  it "should establish a new connection" do
+    ActiveRecord::Base.should_receive(:establish_connection)
+    test_double.perform
+  end
+
+  it "should test out the new connection by performing a count" do
+    Rapns::Notification.should_receive(:count)
+    test_double.perform
+  end
+
+  context "when the reconnection attempt is not successful" do
+    before do
+      class << Rapns::Notification
+        def count
+          @count_calls += 1
+          return if @count_calls == 2
+          raise @error
+        end
+      end
+      Rapns::Notification.instance_variable_set("@count_calls", 0)
+      Rapns::Notification.instance_variable_set("@error", error)
+    end
+
+    it "should log the 2nd attempt" do
+      Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Attempt 2")
+      test_double.perform
+    end
+
+    it "should log errors raised when the reconnection is not successful without notifying airbrake" do
+      Rapns::Daemon.logger.should_receive(:error).with(error, :airbrake_notify => false)
+      test_double.perform
+    end
+
+    it "should sleep to avoid thrashing when the database is down" do
+      test_double.should_receive(:sleep).with(2)
+      test_double.perform
+    end
+  end
+end

data/spec/rapns/daemon/delivery_handler_spec.rb

@@ -75,6 +75,11 @@ describe Rapns::Daemon::DeliveryHandler do
     delivery_handler.send(:handle_next_notification)
   end
 
+  it "should update notification with the ability to reconnect the database" do
+    delivery_handler.should_receive(:with_database_reconnect_and_retry)
+    delivery_handler.send(:handle_next_notification)
+  end
+
   it "should log if an error is raised when updating the notification" do
     e = StandardError.new("bork!")
     @notification.stub(:save!).and_raise(e)
@@ -92,6 +97,11 @@ describe Rapns::Daemon::DeliveryHandler do
       @connection.stub(:select => true, :read => [8, 4, 69].pack("ccN"), :reconnect => nil)
     end
 
+    it "should update notification with the ability to reconnect the database" do
+      delivery_handler.should_receive(:with_database_reconnect_and_retry)
+      delivery_handler.send(:handle_next_notification)
+    end
+
     it "should set the notification as not delivered" do
       @notification.should_receive(:delivered=).with(false)
       delivery_handler.send(:handle_next_notification)

data/spec/rapns/daemon/feeder_spec.rb

@@ -15,13 +15,18 @@ describe Rapns::Daemon::Feeder do
 
   it "should reconnect to the database when daemonized" do
     Rapns::Daemon::Feeder.stub(:loop)
-    ActiveRecord::Base.should_receive(:establish_connection)
+    Rapns::Daemon::Feeder.should_receive(:reconnect_database)
     Rapns::Daemon::Feeder.start(false)
   end
 
+  it "should check for new notifications with the ability to reconnect the database" do
+    Rapns::Daemon::Feeder.should_receive(:with_database_reconnect_and_retry)
+    Rapns::Daemon::Feeder.enqueue_notifications
+  end
+
   it "should not reconnect to the database when running in the foreground" do
     Rapns::Daemon::Feeder.stub(:loop)
-    ActiveRecord::Base.should_not_receive(:establish_connection)
+    Rapns::Daemon::Feeder.should_not_receive(:reconnect_database)
     Rapns::Daemon::Feeder.start(true)
   end
 
@@ -91,82 +96,4 @@ describe Rapns::Daemon::Feeder do
     Rapns::Daemon::Feeder.stub(:loop).and_yield
     Rapns::Daemon::Feeder.start(true)
   end
-
-  context "when the database connection is lost" do
-    let(:error) { adapter_error.new("db down!") }
-    before do
-      ActiveRecord::Base.stub(:clear_all_connections!)
-      ActiveRecord::Base.stub(:establish_connection)
-      Rapns::Notification.stub(:ready_for_delivery).and_raise(error)
-    end
-
-    def adapter_error
-      case $adapter
-      when 'postgresql'
-        PGError
-      when 'mysql'
-        Mysql::Error
-      when 'mysql2'
-        Mysql2::Error
-      else
-        raise "Please update #{__FILE__} for adapter #{$adapter}"
-      end
-    end
-
-    it "should log the error raised" do
-      Rapns::Daemon.logger.should_receive(:error).with(error)
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    it "should log that the database is being reconnected" do
-      Rapns::Daemon.logger.should_receive(:warn).with("Lost connection to database, reconnecting...")
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    it "should log the reconnection attempt" do
-      Rapns::Daemon.logger.should_receive(:warn).with("Attempt 1")
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    it "should clear all connections" do
-      ActiveRecord::Base.should_receive(:clear_all_connections!)
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    it "should establish a new connection" do
-      ActiveRecord::Base.should_receive(:establish_connection)
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    it "should test out the new connection by performing a count" do
-      Rapns::Notification.should_receive(:count)
-      Rapns::Daemon::Feeder.enqueue_notifications
-    end
-
-    context "when the reconnection attempt is not successful" do
-      let(:error) { adapter_error.new("shit got real") }
-
-      before do
-        class << Rapns::Notification
-          def count
-            @count_calls += 1
-            return if @count_calls == 2
-            raise @error
-          end
-        end
-        Rapns::Notification.instance_variable_set("@count_calls", 0)
-        Rapns::Notification.instance_variable_set("@error", error)
-      end
-
-      it "should log errors raised when the reconnection is not successful without notifying airbrake" do
-        Rapns::Daemon.logger.should_receive(:error).with(error, :airbrake_notify => false)
-        Rapns::Daemon::Feeder.enqueue_notifications
-      end
-
-      it "should sleep to avoid thrashing when the database is down" do
-        Rapns::Daemon::Feeder.should_receive(:sleep).with(2)
-        Rapns::Daemon::Feeder.enqueue_notifications
-      end
-    end
-  end
 end

data/spec/rapns/daemon/logger_spec.rb

@@ -77,7 +77,7 @@ describe Rapns::Daemon::Logger do
   it "should notify Airbrake of the exception" do
     e = RuntimeError.new("hi mom")
     logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => true)
-    Airbrake.should_receive(:notify).with(e)
+    Airbrake.should_receive(:notify_or_ignore).with(e)
     logger.error(e)
   end
 
@@ -96,7 +96,7 @@ describe Rapns::Daemon::Logger do
     it "should notify using HoptoadNotifier" do
       e = RuntimeError.new("hi mom")
       logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => true)
-      HoptoadNotifier.should_receive(:notify).with(e)
+      HoptoadNotifier.should_receive(:notify_or_ignore).with(e)
       logger.error(e)
     end
   end
@@ -104,20 +104,20 @@ describe Rapns::Daemon::Logger do
   it "should not notify Airbrake of the exception if the airbrake_notify option is false" do
     e = RuntimeError.new("hi mom")
     logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => false)
-    Airbrake.should_not_receive(:notify).with(e)
+    Airbrake.should_not_receive(:notify_or_ignore).with(e)
     logger.error(e)
   end
 
   it "should not notify Airbrake if explicitly disabled in the call to error" do
     e = RuntimeError.new("hi mom")
     logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => true)
-    Airbrake.should_not_receive(:notify).with(e)
+    Airbrake.should_not_receive(:notify_or_ignore).with(e)
     logger.error(e, :airbrake_notify => false)
   end
 
   it "should not attempt to notify Airbrake of the error is not an Exception" do
     logger = Rapns::Daemon::Logger.new(:foreground => false)
-    Airbrake.should_not_receive(:notify)
+    Airbrake.should_not_receive(:notify_or_ignore)
     logger.error("string error message")
   end
 

data/spec/rapns/daemon_spec.rb

@@ -42,8 +42,8 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon::FeedbackReceiver.stub(:start)
     Rapns::Daemon::Feeder.stub(:start)
     Rapns::Daemon.stub(:daemonize)
-    Rapns::Daemon.stub(:write_pid_file)
-    @logger = mock("Logger", :info => nil)
+    File.stub(:open)
+    @logger = mock("Logger", :info => nil, :error => nil)
     Rapns::Daemon::Logger.stub(:new).and_return(@logger)
   end
 
@@ -102,6 +102,12 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.start("development", {})
   end
 
+  it "should log an error if the PID file could not be written" do
+    File.stub(:open).and_raise(Errno::ENOENT)
+    @logger.should_receive(:error).with("Failed to write PID to '/rails_root/rapns.pid': #<Errno::ENOENT: No such file or directory>")
+    Rapns::Daemon.start("development", {})
+  end
+
   it "should start the feedback receiver" do
     Rapns::Daemon::FeedbackReceiver.should_receive(:start)
     Rapns::Daemon.start("development", true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000 Z
+date: 2011-12-23 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3
@@ -30,6 +30,7 @@ files:
 - lib/rapns/daemon/certificate.rb
 - lib/rapns/daemon/configuration.rb
 - lib/rapns/daemon/connection.rb
+- lib/rapns/daemon/database_reconnectable.rb
 - lib/rapns/daemon/delivery_error.rb
 - lib/rapns/daemon/delivery_handler.rb
 - lib/rapns/daemon/delivery_handler_pool.rb
@@ -51,6 +52,7 @@ files:
 - spec/rapns/daemon/certificate_spec.rb
 - spec/rapns/daemon/configuration_spec.rb
 - spec/rapns/daemon/connection_spec.rb
+- spec/rapns/daemon/database_reconnectable_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb
 - spec/rapns/daemon/delivery_handler_pool_spec.rb
 - spec/rapns/daemon/delivery_handler_spec.rb
@@ -92,6 +94,7 @@ test_files:
 - spec/rapns/daemon/certificate_spec.rb
 - spec/rapns/daemon/configuration_spec.rb
 - spec/rapns/daemon/connection_spec.rb
+- spec/rapns/daemon/database_reconnectable_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb
 - spec/rapns/daemon/delivery_handler_pool_spec.rb
 - spec/rapns/daemon/delivery_handler_spec.rb