rapns 3.2.0 → 3.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.3.0 (April 21, 2013)
+  * GCM: collapse_key is no longer required to set expiry (time_to_live).
+  * Add reflection for GCM canonical IDs.
+  * Add Rapns::Daemon.store to decouple storage backend.
+
 ## 3.2.0 (Apr 1, 2013)
   * Rapns.apns_feedback for one time feedback retrieval. Rapns.push no longer checks for feedback (#117, #105).
   * Lazily connect to the APNs only when a notification is to be delivered (#111).

data/README.md

@@ -34,26 +34,12 @@ Generate the migrations, rapns.yml and migrate:
     rails g rapns
     rake db:migrate
 
-## Generating Certificates (APNs only)
-
-1. Open up Keychain Access and select the `Certificates` category in the sidebar.
-2. Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
-3. Select both the certificate and private key.
-4. Right click and select `Export 2 items...`.
-5. Save the file as `cert.p12`, make sure the File Format is `Personal Information Exchange (p12)`.
-6. Convert the certificate to a .pem, where `<environment>` should be `sandbox` or `production`, depending on the certificate you exported.
-
-Without a password:
-
-    `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
-
-With a password:
-
-    `openssl pkcs12 -clcerts -in cert.p12 -out <environment>.pem`
-
 ## Create an App
 
 #### APNs
+
+If this is your first time using the APNs, you will need to generate SSL certificates. See [Generating Certificates](https://github.com/ileitch/rapns/wiki/Generating-Certificates) for instructions.
+
 ```ruby
 app = Rapns::Apns::App.new
 app.name = "ios_app"
@@ -107,9 +93,10 @@ Inside an existing process (see [Embedding API](https://github.com/ileitch/rapns
 
 *Please note that only ever a single instance of Rapns should be running.*
 
-In a scheduler:
+In a scheduler (see [Push API](https://github.com/ileitch/rapns/wiki/Push-API)):
 
     Rapns.push
+    Rapns.apns_feedback
 
 See [Configuration](https://github.com/ileitch/rapns/wiki/Configuration) for a list of options, or run `rapns --help`.
 
@@ -130,12 +117,16 @@ After updating you should run `rails g rapns` to check for any new migrations.
 * [Embedding API](https://github.com/ileitch/rapns/wiki/Embedding-API)
 
 ### APNs
+* [Generating Certificates](https://github.com/ileitch/rapns/wiki/Generating-Certificates)
 * [Advanced APNs Features](https://github.com/ileitch/rapns/wiki/Advanced-APNs-Features)
 * [APNs Delivery Failure Handling](https://github.com/ileitch/rapns/wiki/APNs-Delivery-Failure-Handling)
 * [Why open multiple connections to the APNs?](https://github.com/ileitch/rapns/wiki/Why-open-multiple-connections-to-the-APNs%3F)
 * [Silent failures might be dropped connections](https://github.com/ileitch/rapns/wiki/Dropped-connections)
 
 ### GCM
+* [Notification Options](https://github.com/ileitch/rapns/wiki//GCM-Notification-Options)
+* [Canonical IDs](https://github.com/ileitch/rapns/wiki/Canonical-IDs)
+* [Delivery Failures & Retries](https://github.com/ileitch/rapns/wiki/Delivery-Failures-&-Retries)
 
 ## Contributing
 

data/lib/generators/templates/rapns.rb

@@ -63,6 +63,11 @@ Rapns.reflect do |on|
   # on.apns_connection_lost do |app, error|
   # end
 
+  # Called when the GCM returns a canonical registration ID.
+  # You will need to replace old_id with canonical_id in your records.
+  # on.gcm_canonical_id do |old_id, canonical_id|
+  # end
+
   # Called when an exception is raised.
   # on.error do |error|
   # end

data/lib/rapns.rb

@@ -29,6 +29,10 @@ require 'rapns/gcm/notification'
 require 'rapns/gcm/app'
 
 module Rapns
+  def self.jruby?
+    defined? JRUBY_VERSION
+  end
+
   def self.require_for_daemon
     require 'rapns/daemon'
     require 'rapns/patches'

data/lib/rapns/apns_feedback.rb

@@ -1,6 +1,7 @@
 module Rapns
   def self.apns_feedback
     Rapns.require_for_daemon
+    Rapns::Daemon.initialize_store
 
     Rapns::Apns::App.all.each do |app|
       receiver = Rapns::Daemon::Apns::FeedbackReceiver.new(app, 0)

data/lib/rapns/configuration.rb

@@ -9,7 +9,7 @@ module Rapns
 
   CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll, :embedded,
     :airbrake_notify, :check_for_errors, :pid_file, :batch_size,
-    :push]
+    :push, :store]
 
   class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
   end
@@ -40,7 +40,7 @@ module Rapns
     end
 
     def foreground=(bool)
-      if defined? JRUBY_VERSION
+      if Rapns.jruby?
         # The JVM does not support fork().
         super(true)
       else
@@ -56,7 +56,7 @@ module Rapns
     private
 
     def set_defaults
-      if defined? JRUBY_VERSION
+      if Rapns.jruby?
         # The JVM does not support fork().
         self.foreground = true
       else
@@ -70,6 +70,7 @@ module Rapns
       self.batch_size = 5000
       self.pid_file = nil
       self.apns_feedback_callback = nil
+      self.store = :active_record
 
       # Internal options.
       self.embedded = false

data/lib/rapns/daemon.rb

@@ -8,7 +8,6 @@ require 'net/http/persistent'
 require 'rapns/daemon/reflectable'
 require 'rapns/daemon/interruptible_sleep'
 require 'rapns/daemon/delivery_error'
-require 'rapns/daemon/database_reconnectable'
 require 'rapns/daemon/delivery'
 require 'rapns/daemon/delivery_queue'
 require 'rapns/daemon/feeder'
@@ -28,14 +27,19 @@ require 'rapns/daemon/gcm/delivery_handler'
 
 module Rapns
   module Daemon
-    extend DatabaseReconnectable
+    class << self
+      attr_accessor :store
+    end
 
     def self.start
       setup_signal_traps if trap_signals?
 
+      initialize_store
+      return unless store
+
       if daemonize?
         daemonize
-        reconnect_database
+        store.after_daemonize
       end
 
       write_pid_file
@@ -51,10 +55,22 @@ module Rapns
       delete_pid_file
     end
 
+    def self.initialize_store
+      return if store
+      begin
+        require "rapns/daemon/store/#{Rapns.config.store}"
+        klass = "Rapns::Daemon::Store::#{Rapns.config.store.to_s.camelcase}".constantize
+        self.store = klass.new
+      rescue StandardError, LoadError => e
+        Rapns.logger.error("Failed to load '#{Rapns.config.store}' storage backend.")
+        Rapns.logger.error(e)
+      end
+    end
+
     protected
 
     def self.daemonize?
-      !(Rapns.config.foreground || Rapns.config.embedded || defined?(JRUBY_VERSION))
+      !(Rapns.config.foreground || Rapns.config.embedded || Rapns.jruby?)
     end
 
     def self.trap_signals?

data/lib/rapns/daemon/apns/feedback_receiver.rb

@@ -4,7 +4,6 @@ module Rapns
       class FeedbackReceiver
         include Reflectable
         include InterruptibleSleep
-        include DatabaseReconnectable
 
         FEEDBACK_TUPLE_BYTES = 38
         HOSTS = {
@@ -63,17 +62,16 @@ module Rapns
 
         def create_feedback(failed_at, device_token)
           formatted_failed_at = failed_at.strftime("%Y-%m-%d %H:%M:%S UTC")
-          with_database_reconnect_and_retry do
-            Rapns.logger.info("[#{@app.name}] [FeedbackReceiver] Delivery failed at #{formatted_failed_at} for #{device_token}.")
-            feedback = Rapns::Apns::Feedback.create!(:failed_at => failed_at, :device_token => device_token, :app => @app)
-            reflect(:apns_feedback, feedback)
+          Rapns.logger.info("[#{@app.name}] [FeedbackReceiver] Delivery failed at #{formatted_failed_at} for #{device_token}.")
 
-            # Deprecated.
-            begin
-              Rapns.config.apns_feedback_callback.call(feedback) if Rapns.config.apns_feedback_callback
-            rescue StandardError => e
-              Rapns.logger.error(e)
-            end
+          feedback = Rapns::Daemon.store.create_apns_feedback(failed_at, device_token, @app)
+          reflect(:apns_feedback, feedback)
+
+          # Deprecated.
+          begin
+            Rapns.config.apns_feedback_callback.call(feedback) if Rapns.config.apns_feedback_callback
+          rescue StandardError => e
+            Rapns.logger.error(e)
           end
         end
       end

data/lib/rapns/daemon/delivery.rb

@@ -1,7 +1,6 @@
 module Rapns
   module Daemon
     class Delivery
-      include DatabaseReconnectable
       include Reflectable
 
       def self.perform(*args)
@@ -9,11 +8,7 @@ module Rapns
       end
 
       def retry_after(notification, deliver_after)
-        with_database_reconnect_and_retry do
-          notification.retries += 1
-          notification.deliver_after = deliver_after
-          notification.save!(:validate => false)
-        end
+        Rapns::Daemon.store.retry_after(notification, deliver_after)
         reflect(:notification_will_retry, notification)
       end
 
@@ -22,24 +17,12 @@ module Rapns
       end
 
       def mark_delivered
-        with_database_reconnect_and_retry do
-          @notification.delivered = true
-          @notification.delivered_at = Time.now
-          @notification.save!(:validate => false)
-        end
+        Rapns::Daemon.store.mark_delivered(@notification)
         reflect(:notification_delivered, @notification)
       end
 
       def mark_failed(code, description)
-        with_database_reconnect_and_retry do
-          @notification.delivered = false
-          @notification.delivered_at = nil
-          @notification.failed = true
-          @notification.failed_at = Time.now
-          @notification.error_code = code
-          @notification.error_description = description
-          @notification.save!(:validate => false)
-        end
+        Rapns::Daemon.store.mark_failed(@notification, code, description)
         reflect(:notification_failed, @notification)
       end
     end

data/lib/rapns/daemon/delivery_queue.rb

@@ -35,8 +35,8 @@ module Rapns
       end
 
       def notifications_processed?
-        synchronize { @num_notifications == 0 }
+        synchronize { @num_notifications <= 0 }
       end
     end
   end
-end
+end

data/lib/rapns/daemon/feeder.rb

@@ -2,7 +2,6 @@ module Rapns
   module Daemon
     class Feeder
       extend InterruptibleSleep
-      extend DatabaseReconnectable
       extend Reflectable
 
       def self.start
@@ -38,15 +37,11 @@ module Rapns
 
       def self.enqueue_notifications
         begin
-          with_database_reconnect_and_retry do
-            batch_size = Rapns.config.batch_size
-            idle = Rapns::Daemon::AppRunner.idle.map(&:app)
-            relation = Rapns::Notification.ready_for_delivery.for_apps(idle)
-            relation = relation.limit(batch_size) unless Rapns.config.push
-            relation.each do |notification|
-              Rapns::Daemon::AppRunner.enqueue(notification)
-              reflect(:notification_enqueued, notification)
-            end
+          idle = Rapns::Daemon::AppRunner.idle.map(&:app)
+
+          Rapns::Daemon.store.deliverable_notifications(idle).each do |notification|
+            Rapns::Daemon::AppRunner.enqueue(notification)
+            reflect(:notification_enqueued, notification)
           end
         rescue StandardError => e
           Rapns.logger.error(e)

data/lib/rapns/daemon/gcm/delivery.rb

@@ -51,6 +51,8 @@ module Rapns
           else
             handle_errors(response, body)
           end
+
+          handle_canonical_ids(response, body)
         end
 
         def handle_errors(response, body)
@@ -69,6 +71,17 @@ module Rapns
           end
         end
 
+        def handle_canonical_ids(response, body)
+          if body['canonical_ids'] && body['canonical_ids'].to_i > 0
+            body['results'].each_with_index do |result, i|
+              if result['message_id'] && result['registration_id']
+                old_id = @notification.registration_ids[i]
+                reflect(:gcm_canonical_id, old_id, result['registration_id'])
+              end
+            end
+          end
+        end
+
         def bad_request(response)
           raise Rapns::DeliveryError.new(400, @notification.id, 'GCM failed to parse the JSON request. Possibly an rapns bug, please open an issue.')
         end
@@ -94,19 +107,16 @@ module Rapns
 
         def some_devices_unavailable(response, errors)
           unavailable_idxs = errors.find_all { |i, error| error.in?(UNAVAILABLE_STATES) }.map(&:first)
-          new_notification = build_new_notification(response, unavailable_idxs)
-          with_database_reconnect_and_retry { new_notification.save! }
+          new_notification = create_new_notification(response, unavailable_idxs)
           raise Rapns::DeliveryError.new(nil, @notification.id,
             describe_errors(errors) + " #{unavailable_idxs.join(', ')} will be retried as notification #{new_notification.id}.")
         end
 
-        def build_new_notification(response, idxs)
-          notification = Rapns::Gcm::Notification.new
-          notification.assign_attributes(@notification.attributes.slice('app_id', 'collapse_key', 'delay_while_idle'))
-          notification.data = @notification.data
-          notification.registration_ids = idxs.map { |i| @notification.registration_ids[i] }
-          notification.deliver_after = deliver_after_header(response)
-          notification
+        def create_new_notification(response, unavailable_idxs)
+          attrs = @notification.attributes.slice('app_id', 'collapse_key', 'delay_while_idle')
+          registration_ids = unavailable_idxs.map { |i| @notification.registration_ids[i] }
+          Rapns::Daemon.store.create_gcm_notification(attrs, @notification.data,
+            registration_ids, deliver_after_header(response), @notification.app)
         end
 
         def deliver_after_header(response)

data/lib/rapns/daemon/store/active_record.rb

@@ -0,0 +1,74 @@
+require 'active_record'
+
+require 'rapns/daemon/store/active_record/reconnectable'
+
+module Rapns
+  module Daemon
+    module Store
+      class ActiveRecord
+        include Reconnectable
+
+        def deliverable_notifications(apps)
+          with_database_reconnect_and_retry do
+            batch_size = Rapns.config.batch_size
+            relation = Rapns::Notification.ready_for_delivery.for_apps(apps)
+            relation = relation.limit(batch_size) unless Rapns.config.push
+            relation.all
+          end
+        end
+
+        def retry_after(notification, deliver_after)
+          with_database_reconnect_and_retry do
+            notification.retries += 1
+            notification.deliver_after = deliver_after
+            notification.save!(:validate => false)
+          end
+        end
+
+        def mark_delivered(notification)
+          with_database_reconnect_and_retry do
+            notification.delivered = true
+            notification.delivered_at = Time.now
+            notification.save!(:validate => false)
+          end
+        end
+
+        def mark_failed(notification, code, description)
+          with_database_reconnect_and_retry do
+            notification.delivered = false
+            notification.delivered_at = nil
+            notification.failed = true
+            notification.failed_at = Time.now
+            notification.error_code = code
+            notification.error_description = description
+            notification.save!(:validate => false)
+          end
+        end
+
+        def create_apns_feedback(failed_at, device_token, app)
+          with_database_reconnect_and_retry do
+            Rapns::Apns::Feedback.create!(:failed_at => failed_at,
+              :device_token => device_token, :app => app)
+          end
+        end
+
+        def create_gcm_notification(attrs, data, registration_ids, deliver_after, app)
+          with_database_reconnect_and_retry do
+            notification = Rapns::Gcm::Notification.new
+            notification.assign_attributes(attrs)
+            notification.data = data
+            notification.registration_ids = registration_ids
+            notification.deliver_after = deliver_after
+            notification.app = app
+            notification.save!
+            notification
+          end
+        end
+
+        def after_daemonize
+          reconnect_database
+        end
+      end
+    end
+  end
+end

data/lib/rapns/daemon/store/active_record/reconnectable.rb

@@ -0,0 +1,61 @@
+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 Store
+      class ActiveRecord
+        module Reconnectable
+          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
+  end
+end