rapns 3.2.0 → 3.3.0

data/spec/unit/daemon/{database_reconnectable_spec.rb → store/active_record/reconnectable_spec.rb}

@@ -1,8 +1,9 @@
-require "unit_spec_helper"
+require 'unit_spec_helper'
+require 'rapns/daemon/store/active_record/reconnectable'
 
-describe Rapns::Daemon::DatabaseReconnectable do
+describe Rapns::Daemon::Store::ActiveRecord::Reconnectable do
   class TestDouble
-    include Rapns::Daemon::DatabaseReconnectable
+    include Rapns::Daemon::Store::ActiveRecord::Reconnectable
 
     attr_reader :name
 

data/spec/unit/daemon/store/active_record_spec.rb

@@ -0,0 +1,181 @@
+require 'unit_spec_helper'
+require 'rapns/daemon/store/active_record'
+
+describe Rapns::Daemon::Store::ActiveRecord do
+  let(:app) { Rapns::Apns::App.create!(:name => 'my_app', :environment => 'development', :certificate => TEST_CERT) }
+  let(:notification) { Rapns::Apns::Notification.create!(:device_token => "a" * 64, :app => app) }
+  let(:store) { Rapns::Daemon::Store::ActiveRecord.new }
+  let(:now) { Time.now }
+
+  before { Time.stub(:now => now) }
+
+  describe 'deliverable_notifications' do
+    it 'checks for new notifications with the ability to reconnect the database' do
+      store.should_receive(:with_database_reconnect_and_retry)
+      store.deliverable_notifications(app)
+    end
+
+    it 'loads notifications in batches' do
+      Rapns.config.batch_size = 5000
+      Rapns.config.push = false
+      relation = stub.as_null_object
+      relation.should_receive(:limit).with(5000)
+      Rapns::Notification.stub(:ready_for_delivery => relation)
+      store.deliverable_notifications([app])
+    end
+
+    it 'does not load notification in batches if in push mode' do
+      Rapns.config.push = true
+      relation = stub.as_null_object
+      relation.should_not_receive(:limit)
+      Rapns::Notification.stub(:ready_for_delivery => relation)
+      store.deliverable_notifications([app])
+    end
+
+    it 'loads an undelivered notification without deliver_after set' do
+      notification.update_attributes!(:delivered => false, :deliver_after => nil)
+      store.deliverable_notifications([app]).should == [notification]
+    end
+
+    it 'loads an notification with a deliver_after time in the past' do
+      notification.update_attributes!(:delivered => false, :deliver_after => 1.hour.ago)
+      store.deliverable_notifications([app]).should == [notification]
+    end
+
+    it 'does not load an notification with a deliver_after time in the future' do
+      notification.update_attributes!(:delivered => false, :deliver_after => 1.hour.from_now)
+      store.deliverable_notifications([app]).should be_empty
+    end
+
+    it 'does not load a previously delivered notification' do
+      notification.update_attributes!(:delivered => true, :delivered_at => Time.now)
+      store.deliverable_notifications([app]).should be_empty
+    end
+
+    it "does not enqueue a notification that has previously failed delivery" do
+      notification.update_attributes!(:delivered => false, :failed => true)
+      store.deliverable_notifications([app]).should be_empty
+    end
+
+    it 'does not load notifications for apps that are still processing the previous batch' do
+      notification
+      store.deliverable_notifications([]).should be_empty
+    end
+  end
+
+  describe 'retry_after' do
+    it 'increments the retry count' do
+      expect do
+        store.retry_after(notification, now)
+      end.to change(notification, :retries).by(1)
+    end
+
+    it 'sets the deliver after timestamp' do
+      deliver_after = now + 10.seconds
+      expect do
+        store.retry_after(notification, deliver_after)
+      end.to change(notification, :deliver_after).to(deliver_after)
+    end
+
+    it 'saves the notification without validation' do
+      notification.should_receive(:save!).with(:validate => false)
+      store.retry_after(notification, now)
+    end
+  end
+
+  describe 'mark_delivered' do
+    it 'marks the notification as delivered' do
+      expect do
+        store.mark_delivered(notification)
+      end.to change(notification, :delivered).to(true)
+    end
+
+    it 'sets the time the notification was delivered' do
+      expect do
+        store.mark_delivered(notification)
+      end.to change(notification, :delivered_at).to(now)
+    end
+
+    it 'saves the notification without validation' do
+      notification.should_receive(:save!).with(:validate => false)
+      store.mark_delivered(notification)
+    end
+  end
+
+  describe 'mark_failed' do
+    it 'marks the notification as not delivered' do
+      store.mark_failed(notification, nil, '')
+      notification.delivered.should be_false
+    end
+
+    it 'marks the notification as failed' do
+      expect do
+        store.mark_failed(notification, nil, '')
+      end.to change(notification, :failed).to(true)
+    end
+
+    it 'sets the time the notification delivery failed' do
+      expect do
+        store.mark_failed(notification, nil, '')
+      end.to change(notification, :failed_at).to(now)
+    end
+
+    it 'sets the error code' do
+      expect do
+        store.mark_failed(notification, 42, '')
+      end.to change(notification, :error_code).to(42)
+    end
+
+    it 'sets the error description' do
+      expect do
+        store.mark_failed(notification, 42, 'Weeee')
+      end.to change(notification, :error_description).to('Weeee')
+    end
+
+    it 'saves the notification without validation' do
+      notification.should_receive(:save!).with(:validate => false)
+      store.mark_failed(notification, nil, '')
+    end
+  end
+
+  describe 'create_apns_feedback' do
+    it 'creates the Feedback record' do
+      Rapns::Apns::Feedback.should_receive(:create!).with(
+        :failed_at => now, :device_token => 'ab' * 32, :app => app)
+      store.create_apns_feedback(now, 'ab' * 32, app)
+    end
+  end
+
+  describe 'create_gcm_notification' do
+    let(:data) { { :data => true } }
+    let(:attributes) { { :device_token => 'ab' * 32 } }
+    let(:registration_ids) { ['123', '456'] }
+    let(:deliver_after) { now + 10.seconds }
+    let(:args) { [attributes, data, registration_ids, deliver_after, app] }
+
+    it 'sets the given attributes' do
+      new_notification = store.create_gcm_notification(*args)
+      new_notification.device_token.should == 'ab' * 32
+    end
+
+    it 'sets the given data' do
+      new_notification = store.create_gcm_notification(*args)
+      new_notification.data['data'].should be_true
+    end
+
+    it 'sets the given registration IDs' do
+      new_notification = store.create_gcm_notification(*args)
+      new_notification.registration_ids.should == registration_ids
+    end
+
+    it 'sets the deliver_after timestamp' do
+      new_notification = store.create_gcm_notification(*args)
+      new_notification.deliver_after.should == deliver_after
+    end
+
+    it 'saves the new notification' do
+      new_notification = store.create_gcm_notification(*args)
+      new_notification.new_record?.should be_false
+    end
+  end
+end

data/spec/unit/daemon_spec.rb

@@ -1,4 +1,5 @@
 require 'unit_spec_helper'
+require 'rapns/daemon/store/active_record'
 
 describe Rapns::Daemon, "when starting" do
   module Rails; end
@@ -6,27 +7,34 @@ describe Rapns::Daemon, "when starting" do
   let(:certificate) { stub }
   let(:password) { stub }
   let(:config) { stub(:pid_file => nil, :airbrake_notify => false,
-    :foreground => true, :embedded => false, :push => false) }
+    :foreground => true, :embedded => false, :push => false, :store => :active_record) }
   let(:logger) { stub(:logger, :info => nil, :error => nil, :warn => nil) }
 
   before do
-    Rapns.stub(:config => config)
-    Rapns::Logger.stub(:new => logger)
+    Rapns.stub(:config => config, :logger => logger)
     Rapns::Daemon::Feeder.stub(:start)
     Rapns::Daemon::AppRunner.stub(:sync => nil, :stop => nil)
-    Rapns::Daemon.stub(:daemonize => nil, :reconnect_database => nil, :exit => nil, :puts => nil)
+    Rapns::Daemon.stub(:daemonize => nil, :exit => nil, :puts => nil)
     File.stub(:open)
     Rails.stub(:root).and_return("/rails_root")
   end
 
-  unless defined?(JRUBY_VERSION)
+  unless Rapns.jruby?
     it "forks into a daemon if the foreground option is false" do
       config.stub(:foreground => false)
-      ActiveRecord::Base.stub(:establish_connection)
+      Rapns::Daemon.initialize_store
+      Rapns::Daemon.store.stub(:after_daemonize => nil)
       Rapns::Daemon.should_receive(:daemonize)
       Rapns::Daemon.start
     end
 
+    it 'notifies the store after forking' do
+      config.stub(:foreground => false)
+      Rapns::Daemon.initialize_store
+      Rapns::Daemon.store.should_receive(:after_daemonize)
+      Rapns::Daemon.start
+    end
+
     it "does not fork into a daemon if the foreground option is true" do
       config.stub(:foreground => true)
       Rapns::Daemon.should_not_receive(:daemonize)
@@ -57,6 +65,18 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.start
   end
 
+  it 'instantiates the store' do
+    config.stub(:store => :active_record)
+    Rapns::Daemon.start
+    Rapns::Daemon.store.should be_kind_of(Rapns::Daemon::Store::ActiveRecord)
+  end
+
+  it 'logs an error if the store cannot be loaded' do
+    config.stub(:store => :foo_bar)
+    Rapns.logger.should_receive(:error).with(kind_of(LoadError))
+    Rapns::Daemon.start
+  end
+
   it "writes the process ID to the PID file" do
     Rapns::Daemon.should_receive(:write_pid_file)
     Rapns::Daemon.start
@@ -91,7 +111,7 @@ describe Rapns::Daemon, "when being shutdown" do
   end
 
   # These tests do not work on JRuby.
-  unless defined? JRUBY_VERSION
+  unless Rapns.jruby?
     it "shuts down when signaled signaled SIGINT" do
       Rapns::Daemon.setup_signal_traps
       Rapns::Daemon.should_receive(:shutdown)

data/spec/unit/gcm/notification_spec.rb

@@ -27,7 +27,7 @@ describe Rapns::Gcm::Notification do
   it 'num of registration Ids limit of 1000' do
     notification.registration_ids = ['a']*(1000+1)
     notification.valid?.should be_false
-    notification.errors[:base].should == ["GCM notification num of registration_ids cannot be larger than 1000."]
+    notification.errors[:base].should == ["GCM notification number of registration_ids cannot be larger than 1000."]
   end
 
   it 'allows assignment of a single registration ID' do
@@ -45,15 +45,8 @@ describe Rapns::Gcm::Notification do
     notification.errors[:expiry].should == ['must be set when using a collapse_key']
   end
 
-  it 'does not include time_to_live in the payload if collapse_key is not set' do
+  it 'includes time_to_live in the payload' do
     notification.expiry = 100
-    notification.collapse_key = nil
-    notification.as_json.key?('time_to_live').should be_false
-  end
-
-  it 'includes time_to_live in the payload if collapse_key is set' do
-    notification.expiry = 100
-    notification.collapse_key = 'sync'
     notification.as_json['time_to_live'].should == 100
   end
 end

data/spec/unit/push_spec.rb

@@ -12,6 +12,11 @@ describe Rapns, 'push' do
     Rapns.config.push.should be_true
   end
 
+  it 'initializes the store' do
+    Rapns::Daemon.should_receive(:initialize_store)
+    Rapns.push
+  end
+
   it 'syncs the app runner' do
     Rapns::Daemon::AppRunner.should_receive(:sync)
     Rapns.push

data/spec/unit/reflection_spec.rb

@@ -12,10 +12,6 @@ describe Rapns do
   end
 end
 
-# :apns_feedback, :notification_enqueued, :notification_delivered,
-#       :notification_failed, :notification_will_retry, :apns_connection_lost,
-#       :error
-
 describe Rapns::Reflections do
   it 'dispatches the given reflection' do
     did_yield = false

data/spec/unit_spec_helper.rb

@@ -72,7 +72,10 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
   end
 
-  config.after(:each) { Rapns.logger = nil }
+  config.after(:each) do
+    Rapns.logger = nil
+    Rapns::Daemon.store = nil
+  end
 end
 
 # a test certificate that contains both an X509 certificate and

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -80,7 +80,6 @@ files:
 - lib/rapns/daemon/apns/disconnection_error.rb
 - lib/rapns/daemon/apns/feedback_receiver.rb
 - lib/rapns/daemon/app_runner.rb
-- lib/rapns/daemon/database_reconnectable.rb
 - lib/rapns/daemon/delivery.rb
 - lib/rapns/daemon/delivery_error.rb
 - lib/rapns/daemon/delivery_handler.rb
@@ -93,6 +92,8 @@ files:
 - lib/rapns/daemon/gcm/delivery_handler.rb
 - lib/rapns/daemon/interruptible_sleep.rb
 - lib/rapns/daemon/reflectable.rb
+- lib/rapns/daemon/store/active_record.rb
+- lib/rapns/daemon/store/active_record/reconnectable.rb
 - lib/rapns/deprecatable.rb
 - lib/rapns/deprecation.rb
 - lib/rapns/embed.rb
@@ -134,7 +135,6 @@ files:
 - spec/unit/daemon/apns/feedback_receiver_spec.rb
 - spec/unit/daemon/app_runner_shared.rb
 - spec/unit/daemon/app_runner_spec.rb
-- spec/unit/daemon/database_reconnectable_spec.rb
 - spec/unit/daemon/delivery_error_spec.rb
 - spec/unit/daemon/delivery_handler_shared.rb
 - spec/unit/daemon/delivery_queue_spec.rb
@@ -144,6 +144,8 @@ files:
 - spec/unit/daemon/gcm/delivery_spec.rb
 - spec/unit/daemon/interruptible_sleep_spec.rb
 - spec/unit/daemon/reflectable_spec.rb
+- spec/unit/daemon/store/active_record/reconnectable_spec.rb
+- spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon_spec.rb
 - spec/unit/deprecatable_spec.rb
 - spec/unit/deprecation_spec.rb
@@ -173,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3688702007568166292
+      hash: -3085387548794744992
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -182,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3688702007568166292
+      hash: -3085387548794744992
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -211,7 +213,6 @@ test_files:
 - spec/unit/daemon/apns/feedback_receiver_spec.rb
 - spec/unit/daemon/app_runner_shared.rb
 - spec/unit/daemon/app_runner_spec.rb
-- spec/unit/daemon/database_reconnectable_spec.rb
 - spec/unit/daemon/delivery_error_spec.rb
 - spec/unit/daemon/delivery_handler_shared.rb
 - spec/unit/daemon/delivery_queue_spec.rb
@@ -221,6 +222,8 @@ test_files:
 - spec/unit/daemon/gcm/delivery_spec.rb
 - spec/unit/daemon/interruptible_sleep_spec.rb
 - spec/unit/daemon/reflectable_spec.rb
+- spec/unit/daemon/store/active_record/reconnectable_spec.rb
+- spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon_spec.rb
 - spec/unit/deprecatable_spec.rb
 - spec/unit/deprecation_spec.rb

data/lib/rapns/daemon/database_reconnectable.rb

@@ -1,57 +0,0 @@
-class PGError < StandardError; end if !defined?(PGError)
-class Mysql; class Error < StandardError; end; end if !defined?(Mysql)
-module Mysql2; class Error < StandardError; end; end if !defined?(Mysql2)
-module ActiveRecord; end
-class ActiveRecord::JDBCError < StandardError; end if !defined?(ActiveRecord::JDBCError)
-
-module Rapns
-  module Daemon
-    module DatabaseReconnectable
-      ADAPTER_ERRORS = [ActiveRecord::StatementInvalid, PGError, Mysql::Error,
-                        Mysql2::Error, ActiveRecord::JDBCError]
-
-      def with_database_reconnect_and_retry
-        begin
-          ActiveRecord::Base.connection_pool.with_connection do
-            yield
-          end
-        rescue *ADAPTER_ERRORS => e
-          Rapns.logger.error(e)
-          database_connection_lost
-          retry
-        end
-      end
-
-      def database_connection_lost
-        Rapns.logger.warn("Lost connection to database, reconnecting...")
-        attempts = 0
-        loop do
-          begin
-            Rapns.logger.warn("Attempt #{attempts += 1}")
-            reconnect_database
-            check_database_is_connected
-            break
-          rescue *ADAPTER_ERRORS => e
-            Rapns.logger.error(e, :airbrake_notify => false)
-            sleep_to_avoid_thrashing
-          end
-        end
-        Rapns.logger.warn("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