rpush 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf8831c7c441107a793e39486aeb6012a321ba26804a64ebd19f48de9043ec8
-  data.tar.gz: 243005ebaf4ccc03e0b7b6a3ca74e7d20dfb703fbe51255c828ce8f780aca18c
+  metadata.gz: 1bd7e063c214b8ab031ca63892ec39f425813c6a1dd9f54f09cfdc5b0e6291b7
+  data.tar.gz: '080a33b636882719f1bf2284035a5fe9d22d8073123808a9d1e3acee84622588'
 SHA512:
-  metadata.gz: 864f79ac67d9907c87fe9a1d9fa5f34fe7f99c9e1df8b03452791f7ee054d3eba7386f65824780b6c7e7985ae704d74778bb1c18c8bd026bb2edd01875fb327b
-  data.tar.gz: 2abbf6ed3e8dbe81537dd2107ff77c60d89c3f84879ee391a7eae887b70c1687d58f4ceb0494a2fde5ccf57cde491516de34be553fac0f53c88da49396d7a273
+  metadata.gz: e68cf92207ac195e120063301ae6ec23217fbaf31ea46757a9a28163dcc584763e08f26e4e1cf11978bf10a232b9eabd71ef205c4817543d8065e32fc3bf0418
+  data.tar.gz: 5bdb35aa1a78ff6f6590072581deb06e29ad51c2255b603c2ed35c985e65fdbb8b524fca80a011d0acae8038dc67579e7cb7d822f24d41ce36da81fb615b3f24

data/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
-## [Unreleased](https://github.com/rpush/rpush/tree/HEAD)
+## [v5.1.0](https://github.com/rpush/rpush/tree/v5.1.0) (2020-09-25)
 
-[Full Changelog](https://github.com/rpush/rpush/compare/v4.2.0...HEAD)
+[Full Changelog](https://github.com/rpush/rpush/compare/v5.0.0...v5.1.0)
+
+**Merged pull requests:**
+
+- Resume APNS2 delivery when async requests timeout [\#564](https://github.com/rpush/rpush/pull/564) ([benlangfeld](https://github.com/benlangfeld))
+- Improve DB reconnection for big tables [\#563](https://github.com/rpush/rpush/pull/563) ([AlexTatarnikov](https://github.com/AlexTatarnikov))
+- Default the Rails environment to RAILS_ENV if set [\#562](https://github.com/rpush/rpush/pull/562) ([benlangfeld](https://github.com/benlangfeld))
+- Allow Apns2 payloads to be up to 4096 bytes [\#561](https://github.com/rpush/rpush/pull/561) ([benlangfeld](https://github.com/benlangfeld))
+- Improve test coverage [\#528](https://github.com/rpush/rpush/pull/528) ([jhottenstein](https://github.com/jhottenstein))
+
+## [v5.0.0](https://github.com/rpush/rpush/tree/v5.0.0) (2020-02-21)
+
+[Full Changelog](https://github.com/rpush/rpush/compare/v4.2.0...v5.0.0)
 
 **Merged pull requests:**
 
@@ -470,3 +482,5 @@ Bug fixes:
 - Started the changelog!
 
 \* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_
+
+\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_

data/lib/rpush/cli.rb

@@ -14,7 +14,7 @@ module Rpush
     end
 
     class_option :config, type: :string, aliases: '-c', default: default_config_path
-    class_option 'rails-env', type: :string, aliases: '-e', default: 'development'
+    class_option 'rails-env', type: :string, aliases: '-e', default: ENV.fetch('RAILS_ENV', 'development')
 
     option :foreground, type: :boolean, aliases: '-f', default: false
     option 'pid-file', type: :string, aliases: '-p'

data/lib/rpush/client/active_model.rb

@@ -4,10 +4,10 @@ require 'rpush/client/active_model/notification'
 require 'rpush/client/active_model/payload_data_size_validator'
 require 'rpush/client/active_model/registration_ids_count_validator'
 
-require 'rpush/client/active_model/apns/binary_notification_validator'
 require 'rpush/client/active_model/apns/device_token_format_validator'
 require 'rpush/client/active_model/apns/app'
 require 'rpush/client/active_model/apns/notification'
+require 'rpush/client/active_model/apns/notification_payload_size_validator'
 
 require 'rpush/client/active_model/apns2/app'
 require 'rpush/client/active_model/apns2/notification'

data/lib/rpush/client/active_model/apns/notification.rb

@@ -7,15 +7,23 @@ module Rpush
           APNS_PRIORITY_IMMEDIATE = 10
           APNS_PRIORITY_CONSERVE_POWER = 5
           APNS_PRIORITIES = [APNS_PRIORITY_IMMEDIATE, APNS_PRIORITY_CONSERVE_POWER]
+          MAX_PAYLOAD_BYTESIZE = 2048
+
+          module ClassMethods
+            def max_payload_bytesize
+              MAX_PAYLOAD_BYTESIZE
+            end
+          end
 
           def self.included(base)
+            base.extend ClassMethods
             base.instance_eval do
               validates :device_token, presence: true
               validates :badge, numericality: true, allow_nil: true
               validates :priority, inclusion: { in: APNS_PRIORITIES }, allow_nil: true
 
               validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
-              validates_with Rpush::Client::ActiveModel::Apns::BinaryNotificationValidator
+              validates_with Rpush::Client::ActiveModel::Apns::NotificationPayloadSizeValidator
 
               base.const_set('APNS_DEFAULT_EXPIRY', APNS_DEFAULT_EXPIRY) unless base.const_defined?('APNS_DEFAULT_EXPIRY')
               base.const_set('APNS_PRIORITY_IMMEDIATE', APNS_PRIORITY_IMMEDIATE) unless base.const_defined?('APNS_PRIORITY_IMMEDIATE')

data/lib/rpush/client/active_model/apns/notification_payload_size_validator.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns
+        class NotificationPayloadSizeValidator < ::ActiveModel::Validator
+          def validate(record)
+            limit = record.class.max_payload_bytesize
+            return unless record.payload.bytesize > limit
+            record.errors[:base] << "APN notification cannot be larger than #{limit} bytes. Try condensing your alert and device attributes."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/apns2/notification.rb

@@ -3,6 +3,20 @@ module Rpush
     module ActiveModel
       module Apns2
         include Rpush::Client::ActiveModel::Apns
+
+        module Notification
+          MAX_PAYLOAD_BYTESIZE = 4096
+
+          module ClassMethods
+            def max_payload_bytesize
+              MAX_PAYLOAD_BYTESIZE
+            end
+          end
+
+          def self.included(base)
+            base.extend ClassMethods
+          end
+        end
       end
     end
   end

data/lib/rpush/client/active_record.rb

@@ -5,6 +5,7 @@ require 'rpush/client/active_model'
 require 'rpush/client/active_record/notification'
 require 'rpush/client/active_record/app'
 
+require 'rpush/client/active_record/apns/active_record_serializable_notification'
 require 'rpush/client/active_record/apns/notification'
 require 'rpush/client/active_record/apns/feedback'
 require 'rpush/client/active_record/apns/app'

data/lib/rpush/client/active_record/apns/active_record_serializable_notification.rb

@@ -0,0 +1,65 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns
+        module ActiveRecordSerializableNotification
+          def alert=(alert)
+            if alert.is_a?(Hash)
+              write_attribute(:alert, multi_json_dump(alert))
+              self.alert_is_json = true if has_attribute?(:alert_is_json)
+            else
+              write_attribute(:alert, alert)
+              self.alert_is_json = false if has_attribute?(:alert_is_json)
+            end
+          end
+
+          def alert
+            string_or_json = read_attribute(:alert)
+
+            if has_attribute?(:alert_is_json)
+              if alert_is_json?
+                multi_json_load(string_or_json)
+              else
+                string_or_json
+              end
+            else
+              begin
+                multi_json_load(string_or_json)
+              rescue StandardError
+                string_or_json
+              end
+            end
+          end
+
+          def sound=(sound)
+            if sound.is_a?(Hash)
+              write_attribute(:sound, multi_json_dump(sound))
+              self.sound_is_json = true if has_attribute?(:sound_is_json)
+            else
+              write_attribute(:sound, sound)
+              self.sound_is_json = false if has_attribute?(:sound_is_json)
+            end
+          end
+
+          def sound
+            string_or_json = read_attribute(:sound)
+
+            if has_attribute?(:sound_is_json)
+              if sound_is_json?
+                multi_json_load(string_or_json)
+              else
+                string_or_json
+              end
+            else
+              begin
+                multi_json_load(string_or_json)
+              rescue StandardError
+                string_or_json
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record/apns/notification.rb

@@ -3,64 +3,8 @@ module Rpush
     module ActiveRecord
       module Apns
         class Notification < Rpush::Client::ActiveRecord::Notification
-          include Deprecatable
           include Rpush::Client::ActiveModel::Apns::Notification
-
-          def alert=(alert)
-            if alert.is_a?(Hash)
-              write_attribute(:alert, multi_json_dump(alert))
-              self.alert_is_json = true if has_attribute?(:alert_is_json)
-            else
-              write_attribute(:alert, alert)
-              self.alert_is_json = false if has_attribute?(:alert_is_json)
-            end
-          end
-
-          def alert
-            string_or_json = read_attribute(:alert)
-
-            if has_attribute?(:alert_is_json)
-              if alert_is_json?
-                multi_json_load(string_or_json)
-              else
-                string_or_json
-              end
-            else
-              begin
-                multi_json_load(string_or_json)
-              rescue StandardError
-                string_or_json
-              end
-            end
-          end
-
-          def sound=(sound)
-            if sound.is_a?(Hash)
-              write_attribute(:sound, multi_json_dump(sound))
-              self.sound_is_json = true if has_attribute?(:sound_is_json)
-            else
-              write_attribute(:sound, sound)
-              self.sound_is_json = false if has_attribute?(:sound_is_json)
-            end
-          end
-
-          def sound
-            string_or_json = read_attribute(:sound)
-
-            if has_attribute?(:sound_is_json)
-              if sound_is_json?
-                multi_json_load(string_or_json)
-              else
-                string_or_json
-              end
-            else
-              begin
-                multi_json_load(string_or_json)
-              rescue StandardError
-                string_or_json
-              end
-            end
-          end
+          include ActiveRecordSerializableNotification
         end
       end
     end

data/lib/rpush/client/active_record/apns2/notification.rb

@@ -2,7 +2,10 @@ module Rpush
   module Client
     module ActiveRecord
       module Apns2
-        class Notification < Rpush::Client::ActiveRecord::Apns::Notification
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
+          include Rpush::Client::ActiveRecord::Apns::ActiveRecordSerializableNotification
         end
       end
     end

data/lib/rpush/client/redis/apns2/notification.rb

@@ -3,6 +3,7 @@ module Rpush
     module Redis
       module Apns2
         class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
           include Rpush::Client::ActiveModel::Apns2::Notification
         end
       end

data/lib/rpush/client/redis/pushy/notification.rb

@@ -9,7 +9,6 @@ module Rpush
 
           def time_to_live=(value)
             self.expiry = value
-            super
           end
         end
       end

data/lib/rpush/daemon/apns2/delivery.rb

@@ -7,6 +7,7 @@ module Rpush
 
       class Delivery < Rpush::Daemon::Delivery
         RETRYABLE_CODES = [ 429, 500, 503 ]
+        CLIENT_JOIN_TIMEOUT = 60
 
         def initialize(app, http2_client, batch)
           @app = app
@@ -20,7 +21,11 @@ module Rpush
           end
 
           # Send all preprocessed requests at once
-          @client.join
+          @client.join(timeout: CLIENT_JOIN_TIMEOUT)
+        rescue NetHttp2::AsyncRequestTimeout => error
+          mark_batch_retryable(Time.now + 10.seconds, error)
+          @client.close
+          raise
         rescue Errno::ECONNREFUSED, SocketError => error
           mark_batch_retryable(Time.now + 10.seconds, error)
           raise

data/lib/rpush/daemon/apnsp8/delivery.rb

@@ -7,6 +7,7 @@ module Rpush
 
       class Delivery < Rpush::Daemon::Delivery
         RETRYABLE_CODES = [ 429, 500, 503 ]
+        CLIENT_JOIN_TIMEOUT = 60
 
         def initialize(app, http2_client, token_provider, batch)
           @app = app
@@ -22,7 +23,11 @@ module Rpush
           end
 
           # Send all preprocessed requests at once
-          @client.join
+          @client.join(timeout: CLIENT_JOIN_TIMEOUT)
+        rescue NetHttp2::AsyncRequestTimeout => error
+          mark_batch_retryable(Time.now + 10.seconds, error)
+          @client.close
+          raise
         rescue Errno::ECONNREFUSED, SocketError, HTTP2::Error::StreamLimitExceeded => error
           # TODO restart connection when StreamLimitExceeded
           mark_batch_retryable(Time.now + 10.seconds, error)
@@ -133,7 +138,7 @@ module Rpush
           jwt_token = @token_provider.token
 
           headers = {}
-          
+
           headers['content-type'] = 'application/json'
           headers['apns-expiration'] = '0'
           headers['apns-priority'] = '10'

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

@@ -67,7 +67,7 @@ module Rpush
 
           def check_database_is_connected
             # Simply asking the adapter for the connection state is not sufficient.
-            Rpush::Client::ActiveRecord::Notification.count
+            Rpush::Client::ActiveRecord::Notification.exists?
           end
 
           def sleep_to_avoid_thrashing

data/lib/rpush/version.rb

@@ -1,7 +1,7 @@
 module Rpush
   module VERSION
     MAJOR = 5
-    MINOR = 0
+    MINOR = 1
     TINY = 0
     PRE = nil
 

data/spec/functional/apns2_spec.rb

@@ -228,5 +228,41 @@ describe 'APNs http2 adapter' do
         Rpush.push
       end
     end
+
+    context 'when waiting for requests to complete times out' do
+      before(:each) do
+        expect(fake_client).to receive(:join) { raise(NetHttp2::AsyncRequestTimeout) }
+      end
+
+      it 'closes the client' do
+        create_notification
+        expect(fake_client).to receive(:close)
+        Rpush.push
+      end
+
+      it 'reflects :error' do
+        reflected_error = false
+        Rpush.reflect do |on|
+          on.error do |error|
+            reflected_error = true
+            expect(error).to be_kind_of(StandardError)
+            reflector.accept
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+
+        expect(reflected_error).to be true
+      end
+
+      it 'fails but retries delivery several times' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :retries)
+      end
+    end
   end
 end

data/spec/support/simplecov_helper.rb

@@ -18,7 +18,7 @@ module SimpleCovHelper
         end
       end
 
-      formatter SimpleCov::Formatter::MultiFormatter[*formatters]
+      formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
     end
   end
 end

data/spec/unit/client/active_record/adm/app_spec.rb

@@ -1,58 +1,6 @@
 require 'unit_spec_helper'
 
 describe Rpush::Client::ActiveRecord::Adm::App do
-  subject { Rpush::Client::ActiveRecord::Adm::App.new(name: 'test', environment: 'development', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
-  let(:existing_app) { Rpush::Client::ActiveRecord::Adm::App.create!(name: 'existing', environment: 'development', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
-
-  it 'should be valid if properly instantiated' do
-    expect(subject).to be_valid
-  end
-
-  it 'should be invalid if name' do
-    subject.name = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:name]).to eq ["can't be blank"]
-  end
-
-  it 'should be invalid if name is not unique within scope' do
-    subject.name = existing_app.name
-    expect(subject).not_to be_valid
-    expect(subject.errors[:name]).to eq ["has already been taken"]
-  end
-
-  it 'should be invalid if missing client_id' do
-    subject.client_id = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:client_id]).to eq ["can't be blank"]
-  end
-
-  it 'should be invalid if missing client_secret' do
-    subject.client_secret = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:client_secret]).to eq ["can't be blank"]
-  end
-
-  describe '#access_token_expired?' do
-    before(:each) do
-      Timecop.freeze(Time.now)
-    end
-
-    after do
-      Timecop.return
-    end
-
-    it 'should return true if access_token_expiration is nil' do
-      expect(subject.access_token_expired?).to eq(true)
-    end
-
-    it 'should return true if expired' do
-      subject.access_token_expiration = Time.now - 5.minutes
-      expect(subject.access_token_expired?).to eq(true)
-    end
-
-    it 'should return false if not expired' do
-      subject.access_token_expiration = Time.now + 5.minutes
-      expect(subject.access_token_expired?).to eq(false)
-    end
-  end
+  it_behaves_like 'Rpush::Client::Adm::App'
+  it_behaves_like 'Rpush::Client::ActiveRecord::App'
 end if active_record?