rpush 2.7.0 → 3.0.0.rc1

data/lib/rpush/daemon/service_config_methods.rb

@@ -2,9 +2,10 @@ module Rpush
   module Daemon
     module ServiceConfigMethods
       DISPATCHERS = {
-        http: Rpush::Daemon::Dispatcher::Http,
-        tcp: Rpush::Daemon::Dispatcher::Tcp,
-        apns_tcp: Rpush::Daemon::Dispatcher::ApnsTcp
+        http:       Rpush::Daemon::Dispatcher::Http,
+        tcp:        Rpush::Daemon::Dispatcher::Tcp,
+        apns_tcp:   Rpush::Daemon::Dispatcher::ApnsTcp,
+        apns_http2: Rpush::Daemon::Dispatcher::ApnsHttp2
       }
 
       def batch_deliveries(value = nil)

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

@@ -20,9 +20,17 @@ module Rpush
     module Store
       class ActiveRecord
         module Reconnectable
-          ADAPTER_ERRORS = [::ActiveRecord::StatementInvalid, PGError, PG::Error,
-                            Mysql::Error, Mysql2::Error, ::ActiveRecord::JDBCError,
-                            SQLite3::Exception, ::ActiveRecord::ConnectionTimeoutError]
+          ADAPTER_ERRORS = [
+              ::ActiveRecord::ConnectionNotEstablished,
+              ::ActiveRecord::ConnectionTimeoutError,
+              ::ActiveRecord::JDBCError,
+              ::ActiveRecord::StatementInvalid,
+              Mysql::Error,
+              Mysql2::Error,
+              PG::Error,
+              PGError,
+              SQLite3::Exception
+          ]
 
           def with_database_reconnect_and_retry
             ::ActiveRecord::Base.connection_pool.with_connection do

data/lib/rpush/daemon/synchronizer.rb

@@ -4,6 +4,8 @@ module Rpush
       extend Loggable
       extend StringHelpers
 
+      APP_ATTRIBUTES_TO_CHECK = [:certificate, :environment, :auth_key, :client_id, :client_secret].freeze
+
       def self.sync
         apps = Rpush::Daemon.store.all_apps
         apps.each { |app| sync_app(app) }
@@ -16,12 +18,9 @@ module Rpush
       def self.sync_app(app)
         if !AppRunner.app_running?(app)
           AppRunner.start_app(app)
-        elsif certificate_changed?(app)
-          log_info("[#{app.name}] Certificate changed, restarting...")
-          AppRunner.stop_app(app.id)
-          AppRunner.start_app(app)
-        elsif environment_changed?(app)
-          log_info("[#{app.name}] Environment changed, restarting...")
+        elsif (changed_attrs = changed_attributes(app)).count > 0
+          changed_attrs_str = changed_attrs.map(&:to_s).join(", ")
+          log_info("[#{app.name}] #{changed_attrs_str} changed, restarting...")
           AppRunner.stop_app(app.id)
           AppRunner.start_app(app)
         else
@@ -46,14 +45,17 @@ module Rpush
         log_info("[#{app.name}] #{start_stop_str} #{pluralize(diff.abs, 'dispatcher')}. #{num_dispatchers} running.")
       end
 
-      def self.certificate_changed?(app)
-        old_app = AppRunner.app_with_id(app.id)
-        app.certificate != old_app.certificate
+      def self.changed_attributes(app)
+        APP_ATTRIBUTES_TO_CHECK.select { |attr| attribute_changed?(app, attr) }
       end
 
-      def self.environment_changed?(app)
-        old_app = AppRunner.app_with_id(app.id)
-        app.environment != old_app.environment
+      def self.attribute_changed?(app, attr)
+        if app.respond_to?(attr)
+          old_app = AppRunner.app_with_id(app.id)
+          app.send(attr) != old_app.send(attr)
+        else
+          false
+        end
       end
     end
   end

data/lib/rpush/version.rb

@@ -1,3 +1,14 @@
 module Rpush
-  VERSION = '2.7.0'
+  module VERSION
+    MAJOR = 3
+    MINOR = 0
+    TINY = 0
+    PRE = 'rc1'.freeze
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze
+
+    def self.to_s
+      STRING
+    end
+  end
 end

data/spec/functional/apns2_spec.rb

@@ -0,0 +1,232 @@
+require 'functional_spec_helper'
+
+describe 'APNs http2 adapter' do
+  let(:fake_client) {
+    double(
+      prepare_request: fake_http2_request,
+      close:           'ok',
+      call_async:      'ok',
+      join:            'ok',
+      on:              'ok'
+    )
+  }
+  let(:app) { create_app }
+  let(:fake_device_token) { 'a' * 64 }
+  let(:fake_http2_request) { double }
+  let(:fake_http_resp_headers) {
+    {
+      ":status" => "200",
+      "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+    }
+  }
+  let(:fake_http_resp_body) { '' }
+  let(:notification_data) { nil }
+
+  before do
+    Rpush.config.push_poll = 0.5
+    allow(NetHttp2::Client).
+      to receive(:new).and_return(fake_client)
+    allow(fake_http2_request).
+      to receive(:on).with(:headers).
+      and_yield(fake_http_resp_headers)
+    allow(fake_http2_request).
+      to receive(:on).with(:body_chunk).
+      and_yield(fake_http_resp_body)
+    allow(fake_http2_request).
+      to receive(:on).with(:close).
+      and_yield
+  end
+
+  def create_app
+    app = Rpush::Apns2::App.new
+    app.certificate = TEST_CERT
+    app.name = 'test'
+    app.environment = 'development'
+    app.save!
+    app
+  end
+
+  def create_notification
+    notification = Rpush::Apns2::Notification.new
+    notification.app = app
+    notification.sound = 'default'
+    notification.alert = 'test'
+    notification.device_token = fake_device_token
+    notification.data = notification_data
+    notification.content_available = 1
+    notification.save!
+    notification
+  end
+
+  it 'delivers a notification successfully' do
+    notification = create_notification
+
+    thread = nil
+    expect(fake_http2_request).
+      to receive(:on).with(:close) { |&block|
+        # imitate HTTP2 delay
+        thread = Thread.new { sleep(0.01); block.call }
+      }
+    expect(fake_client).to receive(:join) { thread.join }
+
+    expect(fake_client)
+      .to receive(:prepare_request)
+      .with(
+        :post,
+        "/3/device/#{fake_device_token}",
+        { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\",\"content-available\":1}}",
+          headers: {} }
+      )
+      .and_return(fake_http2_request)
+
+    expect do
+      Rpush.push
+      notification.reload
+    end.to change(notification, :delivered).to(true)
+  end
+
+  context 'when there is "headers" field in a data' do
+    let(:bundle_id) { 'some.example.com' }
+    let(:notification_data) {
+      {
+        'headers' => { 'apns-topic' => bundle_id },
+        'some_field' =>  'some value'
+      }
+    }
+
+    it 'delivers notification with custom headers' do
+      notification = create_notification
+
+      expect(fake_client)
+        .to receive(:prepare_request)
+        .with(
+          :post,
+          "/3/device/#{fake_device_token}",
+          { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\","\
+                  "\"content-available\":1},\"some_field\":\"some value\"}",
+            headers: { 'apns-topic' => bundle_id }
+          }
+        ).and_return(fake_http2_request)
+
+      expect do
+        Rpush.push
+        notification.reload
+      end.to change(notification, :delivered).to(true)
+    end
+  end
+
+  describe 'delivery failures' do
+    context 'when response is about incorrect request' do
+      let(:fake_http_resp_headers) {
+        {
+          ":status" => "404",
+          "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+        }
+      }
+
+      it 'fails to deliver a notification' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :failed).to(true)
+      end
+
+      it 'reflects :notification_id_failed' do
+        Rpush.reflect do |on|
+          on.notification_id_failed do |app, id, code, descr|
+            expect(app).to be_kind_of(Rpush::Client::Apns2::App)
+            expect(id).to eq 1
+            expect(code).to eq 404
+            expect(descr).to be_nil
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+      end
+    end
+
+    context 'when response returns 500 error for APNs maintenance' do
+      let(:fake_http_resp_headers) {
+        {
+          ":status" => "500",
+          "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+        }
+      }
+
+      it 'fails but retries delivery several times' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :retries)
+      end
+
+      it 'reflects :notification_id_will_retry' do
+        Rpush.reflect do |on|
+          on.notification_id_will_retry do |app, id, timer|
+            expect(app).to be_kind_of(Rpush::Client::Apns2::App)
+            expect(id).to eq 1
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+      end
+    end
+
+    context 'when there is SocketError' do
+      before(:each) do
+        expect(fake_client).to receive(:call_async) { raise(SocketError) }
+      end
+
+      it 'fails but retries delivery several times' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :retries)
+      end
+
+      it 'reflects :notification_id_will_retry' do
+        Rpush.reflect do |on|
+          on.notification_id_will_retry do |app, id, timer|
+            expect(app).to be_kind_of(Rpush::Client::Apns2::App)
+            expect(id).to eq 1
+            expect(timer).to be_kind_of(Time)
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+      end
+    end
+
+    context 'when any StandardError occurs' do
+      before(:each) do
+        expect(fake_client).to receive(:call_async) { raise(StandardError) }
+      end
+
+      it 'marks notification failed' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :failed).to(true)
+      end
+
+      it 'reflects :error' do
+        Rpush.reflect do |on|
+          on.error do |error|
+            expect(error).to be_kind_of(StandardError)
+           reflector.accept
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+      end
+    end
+  end
+end

data/spec/functional/apns_spec.rb

@@ -49,8 +49,7 @@ describe 'APNs' do
   end
 
   def fail_notification(notification)
-    id = (defined?(Mongoid) && notification.is_a?(Mongoid::Document)) ? notification.integer_id : notification.id
-    allow(ssl_socket).to receive_messages(read: [8, 4, id].pack('ccN'))
+    allow(ssl_socket).to receive_messages(read: [8, 4, notification.id].pack('ccN'))
     enable_io_select
   end
 

data/spec/functional/synchronization_spec.rb

@@ -15,6 +15,8 @@ describe 'Synchronization' do
   before do
     app.name = 'test'
     app.auth_key = 'abc123'
+    app.client_id = 'client'
+    app.client_secret = 'secret'
     app.connections = 2
     app.certificate = TEST_CERT_WITH_PASSWORD
     app.password = 'fubar'
@@ -65,4 +67,31 @@ describe 'Synchronization' do
     running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
     expect(running_app.environment).to eql('production')
   end
+
+  it 'restarts an app when the auth_key is changed' do
+    app.auth_key = '321cba'
+    app.save!
+    Rpush.sync
+
+    running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
+    expect(running_app.auth_key).to eql('321cba')
+  end
+
+  it 'restarts an app when the client_id is changed' do
+    app.client_id = 'another_client'
+    app.save!
+    Rpush.sync
+
+    running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
+    expect(running_app.client_id).to eql('another_client')
+  end
+
+  it 'restarts an app when the client_secret is changed' do
+    app.client_secret = 'another_secret'
+    app.save!
+    Rpush.sync
+
+    running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
+    expect(running_app.client_secret).to eql('another_secret')
+  end
 end

data/spec/spec_helper.rb

@@ -31,11 +31,6 @@ def redis?
   client == :redis
 end
 
-def mongoid?
-  client == :mongoid
-end
-
-require 'support/mongoid_setup' if mongoid?
 require 'support/active_record_setup' if active_record?
 
 RPUSH_ROOT = '/tmp/rails_root'

data/spec/support/active_record_setup.rb

@@ -31,8 +31,9 @@ require 'generators/templates/rpush_2_0_0_updates'
 require 'generators/templates/rpush_2_1_0_updates'
 require 'generators/templates/rpush_2_6_0_updates'
 require 'generators/templates/rpush_2_7_0_updates'
+require 'generators/templates/rpush_3_0_0_updates'
 
-migrations = [AddRpush, Rpush200Updates, Rpush210Updates, Rpush260Updates, Rpush270Updates]
+migrations = [AddRpush, Rpush200Updates, Rpush210Updates, Rpush260Updates, Rpush270Updates, Rpush300Updates]
 
 unless ENV['TRAVIS']
   migrations.reverse_each do |m|

data/spec/unit/apns_feedback_spec.rb

@@ -1,7 +1,14 @@
 require 'unit_spec_helper'
 
 describe Rpush, 'apns_feedback' do
-  let!(:app) { Rpush::Apns::App.create!(name: 'test', environment: 'production', certificate: TEST_CERT) }
+  let!(:apns_app) do
+    Rpush::Apns::App.create!(name: 'test', environment: 'production', certificate: TEST_CERT)
+  end
+
+  let!(:gcm_app) do
+    Rpush::Gcm::App.create!(name: 'MyApp', auth_key: 'abc123')
+  end
+
   let(:receiver) { double(check_for_feedback: nil) }
 
   before do
@@ -14,7 +21,7 @@ describe Rpush, 'apns_feedback' do
   end
 
   it 'checks feedback for each app' do
-    expect(Rpush::Daemon::Apns::FeedbackReceiver).to receive(:new).with(app).and_return(receiver)
+    expect(Rpush::Daemon::Apns::FeedbackReceiver).to receive(:new).with(apns_app).and_return(receiver)
     expect(receiver).to receive(:check_for_feedback)
     Rpush.apns_feedback
   end

data/spec/unit/client/active_record/apns/notification_spec.rb

@@ -34,8 +34,8 @@ describe Rpush::Client::ActiveRecord::Apns::Notification do
     expect(notification.alert).to eq("*" * 300)
   end
 
-  it "should default the sound to 'default'" do
-    expect(notification.sound).to eq('default')
+  it "should default the sound to nil" do
+    expect(notification.sound).to be_nil
   end
 
   it "should default the expiry to 1 day" do
@@ -131,6 +131,38 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'MDM' do
   end
 end if active_record?
 
+describe Rpush::Client::ActiveRecord::Apns::Notification, 'mutable-content' do
+  let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }
+
+  it 'includes mutable-content in the payload' do
+    notification.mutable_content = true
+    expect(notification.as_json['aps']['mutable-content']).to eq 1
+  end
+
+  it 'does not include content-available in the payload if not set' do
+    expect(notification.as_json['aps'].key?('mutable-content')).to be_falsey
+  end
+
+  it 'does not include mutable-content as a non-aps attribute' do
+    notification.mutable_content = true
+    expect(notification.as_json.key?('mutable-content')).to be_falsey
+  end
+
+  it 'does not overwrite existing attributes for the device' do
+    notification.data = { hi: :mom }
+    notification.mutable_content = true
+    expect(notification.as_json['aps']['mutable-content']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+
+  it 'does not overwrite the mutable-content flag when setting attributes for the device' do
+    notification.mutable_content = true
+    notification.data = { hi: :mom }
+    expect(notification.as_json['aps']['mutable-content']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+end if active_record?
+
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'content-available' do
   let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }