rpush 5.4.0 → 7.0.1

data/lib/generators/templates/rpush_3_0_0_updates.rb

@@ -1,4 +1,4 @@
-class Rpush300Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush300Updates < ActiveRecord::Migration[5.0]
   def self.up
     add_column :rpush_notifications, :mutable_content, :boolean, default: false
     change_column :rpush_notifications, :sound, :string, default: nil

data/lib/generators/templates/rpush_3_0_1_updates.rb

@@ -1,4 +1,4 @@
-class Rpush301Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush301Updates < ActiveRecord::Migration[5.0]
   def self.up
     change_column_null :rpush_notifications, :mutable_content, false
     change_column_null :rpush_notifications, :content_available, false

data/lib/generators/templates/rpush_3_1_0_add_pushy.rb

@@ -1,4 +1,4 @@
-class Rpush310AddPushy < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush310AddPushy < ActiveRecord::Migration[5.0]
   def self.up
     add_column :rpush_notifications, :external_device_id, :string, null: true
   end

data/lib/generators/templates/rpush_3_1_1_updates.rb

@@ -1,4 +1,4 @@
-class Rpush311Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush311Updates < ActiveRecord::Migration[5.0]
   def self.up
     change_table :rpush_notifications do |t|
       t.remove_index name: 'index_rpush_notifications_multi'

data/lib/generators/templates/rpush_3_2_0_add_apns_p8.rb

@@ -1,4 +1,4 @@
-class Rpush320AddApnsP8 < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush320AddApnsP8 < ActiveRecord::Migration[5.0]
   def self.up
     add_column :rpush_apps, :apn_key, :string, null: true
     add_column :rpush_apps, :apn_key_id, :string, null: true

data/lib/generators/templates/rpush_3_2_4_updates.rb

@@ -1,4 +1,4 @@
-class Rpush324Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush324Updates < ActiveRecord::Migration[5.0]
   def self.up
     change_column :rpush_apps, :apn_key, :text, null: true
   end

data/lib/generators/templates/rpush_3_3_0_updates.rb

@@ -1,4 +1,4 @@
-class Rpush330Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush330Updates < ActiveRecord::Migration[5.0]
   def self.up
     add_column :rpush_notifications, :thread_id, :string, null: true
   end

data/lib/generators/templates/rpush_3_3_1_updates.rb

@@ -1,4 +1,4 @@
-class Rpush331Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+class Rpush331Updates < ActiveRecord::Migration[5.0]
   def self.up
     change_column :rpush_notifications, :device_token, :string, null: true
     change_column :rpush_feedback, :device_token, :string, null: true

data/lib/generators/templates/rpush_4_1_0_updates.rb

@@ -1,4 +1,4 @@
-class Rpush410Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"] : ActiveRecord::Migration
+class Rpush410Updates < ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
   def self.up
     add_column :rpush_notifications, :dry_run, :boolean, null: false, default: false
   end

data/lib/generators/templates/rpush_4_1_1_updates.rb

@@ -1,4 +1,4 @@
-class Rpush411Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"] : ActiveRecord::Migration
+class Rpush411Updates < ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
   def self.up
     add_column :rpush_apps, :feedback_enabled, :boolean, default: true
   end

data/lib/generators/templates/rpush_4_2_0_updates.rb

@@ -1,4 +1,4 @@
-class Rpush420Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"] : ActiveRecord::Migration
+class Rpush420Updates < ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
   def self.up
     add_column :rpush_notifications, :sound_is_json, :boolean, null: true, default: false
   end

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

@@ -7,29 +7,13 @@ module Rpush
             base.instance_eval do
               validates :environment, presence: true, inclusion: { in: %w(development production sandbox) }
               validates :certificate, presence: true
-              validate :certificate_has_matching_private_key
+              validates_with Rpush::Client::ActiveModel::CertificatePrivateKeyValidator
             end
           end
 
           def service_name
             'apns'
           end
-
-          private
-
-          def certificate_has_matching_private_key
-            result = false
-            if certificate.present?
-              begin
-                x509 = OpenSSL::X509::Certificate.new(certificate)
-                pkey = OpenSSL::PKey::RSA.new(certificate, password)
-                result = x509 && pkey
-              rescue OpenSSL::OpenSSLError
-                errors.add :certificate, 'value must contain a certificate and a private key.'
-              end
-            end
-            result
-          end
         end
       end
     end

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

@@ -52,6 +52,10 @@ module Rpush
             self.data = (data || {}).merge(CONTENT_AVAILABLE_KEY => true)
           end
 
+          def content_available?
+            (self.data || {})[CONTENT_AVAILABLE_KEY]
+          end
+
           def as_json(options = nil) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
             json = ActiveSupport::OrderedHash.new
 

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

@@ -3,7 +3,13 @@ module Rpush
     module ActiveModel
       module Apns2
         module App
-          extend Rpush::Client::ActiveModel::Apns::App
+          def self.included(base)
+            base.instance_eval do
+              validates :environment, presence: true, inclusion: { in: %w(development production sandbox) }
+              validates :certificate, presence: true
+              validates_with Rpush::Client::ActiveModel::CertificatePrivateKeyValidator
+            end
+          end
 
           def service_name
             'apns2'

data/lib/rpush/client/active_model/certificate_private_key_validator.rb

@@ -0,0 +1,19 @@
+module Rpush
+  module Client
+    module ActiveModel
+      class CertificatePrivateKeyValidator < ::ActiveModel::Validator
+        def validate(record)
+          if record.certificate.present?
+            begin
+              x509 = OpenSSL::X509::Certificate.new(record.certificate)
+              pkey = OpenSSL::PKey::RSA.new(record.certificate, record.password)
+              x509 && pkey
+            rescue OpenSSL::OpenSSLError
+              record.errors.add :certificate, 'value must contain a certificate and a private key.'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Rpush
               return if record.registration_ids.size > 1
               reg = record.registration_ids.first
               unless reg.is_a?(Hash) &&
-                  reg.keys.sort == KEYS &&
+                  (KEYS-reg.keys).empty? &&
                   reg[:endpoint].is_a?(String) &&
                   reg[:keys].is_a?(Hash)
                 record.errors.add(:base, 'Registration must have :endpoint (String) and :keys (Hash) keys')

data/lib/rpush/client/active_model.rb

@@ -3,6 +3,7 @@ require 'active_model'
 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/certificate_private_key_validator'
 
 require 'rpush/client/active_model/apns/device_token_format_validator'
 require 'rpush/client/active_model/apns/app'

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

@@ -112,6 +112,7 @@ module Rpush
           headers['apns-expiration'] = '0'
           headers['apns-priority'] = '10'
           headers['apns-topic'] = @app.bundle_id
+          headers['apns-push-type'] = 'background' if notification.content_available?
 
           headers.merge notification_data(notification)[HTTP2_HEADERS_KEY] || {}
         end

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

@@ -8,6 +8,7 @@ module Rpush
       class Delivery < Rpush::Daemon::Delivery
         RETRYABLE_CODES = [ 429, 500, 503 ]
         CLIENT_JOIN_TIMEOUT = 60
+        DEFAULT_MAX_CONCURRENT_STREAMS = 100
 
         def initialize(app, http2_client, token_provider, batch)
           @app = app
@@ -85,7 +86,11 @@ module Rpush
         def remote_max_concurrent_streams
           # 0x7fffffff is the default value from http-2 gem (2^31)
           if @client.remote_settings[:settings_max_concurrent_streams] == 0x7fffffff
-            0
+            # Ideally we'd fall back to `#local_settings` here, but `NetHttp2::Client`
+            # doesn't expose that attr from the `HTTP2::Client` it wraps. Instead, we
+            # chose a hard-coded value matching the default local setting from the
+            # `HTTP2::Client` class
+            DEFAULT_MAX_CONCURRENT_STREAMS
           else
             @client.remote_settings[:settings_max_concurrent_streams]
           end
@@ -144,6 +149,7 @@ module Rpush
           headers['apns-priority'] = '10'
           headers['apns-topic'] = @app.bundle_id
           headers['authorization'] = "bearer #{jwt_token}"
+          headers['apns-push-type'] = 'background' if notification.content_available?
 
           headers.merge notification_data(notification)[HTTP2_HEADERS_KEY] || {}
         end

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

@@ -181,6 +181,17 @@ module Rpush
           id
         end
 
+        def adapter_name
+          env = (defined?(Rails) && Rails.env) ? Rails.env : 'development'
+          if ::ActiveRecord::VERSION::MAJOR > 6
+            ::ActiveRecord::Base.configurations.configs_for(env_name: env).first.configuration_hash[:adapter]
+          else
+            config = ::ActiveRecord::Base.configurations[env]
+            return '' unless config
+            Hash[config.map { |k, v| [k.to_sym, v] }][:adapter]
+          end
+        end
+
         private
 
         def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable Metrics/ParameterLists
@@ -199,13 +210,6 @@ module Rpush
           relation = Rpush::Client::ActiveRecord::Notification.where('processing = ? AND delivered = ? AND failed = ? AND (deliver_after IS NULL OR deliver_after < ?)', false, false, false, Time.now)
           relation.order('deliver_after ASC, created_at ASC')
         end
-
-        def adapter_name
-          env = (defined?(Rails) && Rails.env) ? Rails.env : 'development'
-          config = ::ActiveRecord::Base.configurations[env]
-          return '' unless config
-          Hash[config.map { |k, v| [k.to_sym, v] }][:adapter]
-        end
       end
     end
   end

data/lib/rpush/daemon/store/redis.rb

@@ -152,10 +152,10 @@ module Rpush
           retryable_ns = Rpush::Client::Redis::Notification.absolute_retryable_namespace
 
           Modis.with_connection do |redis|
-            retryable_results = redis.multi do
+            retryable_results = redis.multi do |transaction|
               now = Time.now.to_i
-              redis.zrangebyscore(retryable_ns, 0, now)
-              redis.zremrangebyscore(retryable_ns, 0, now)
+              transaction.zrangebyscore(retryable_ns, 0, now)
+              transaction.zremrangebyscore(retryable_ns, 0, now)
             end
 
             retryable_results.first
@@ -167,9 +167,9 @@ module Rpush
           pending_ns = Rpush::Client::Redis::Notification.absolute_pending_namespace
 
           Modis.with_connection do |redis|
-            pending_results = redis.multi do
-              redis.zrange(pending_ns, 0, limit)
-              redis.zremrangebyrank(pending_ns, 0, limit)
+            pending_results = redis.multi do |transaction|
+              transaction.zrange(pending_ns, 0, limit)
+              transaction.zremrangebyrank(pending_ns, 0, limit)
             end
 
             pending_results.first

data/lib/rpush/daemon/string_helpers.rb

@@ -2,7 +2,7 @@ module Rpush
   module Daemon
     module StringHelpers
       def pluralize(count, singular, plural = nil)
-        if count == 1 || count =~ /^1(\.0+)?$/
+        if count == 1
           word = singular
         else
           word = plural || singular.pluralize

data/lib/rpush/logger.rb

@@ -69,7 +69,7 @@ module Rpush
         msg = "#{msg.class.name}, #{msg.message}\n#{formatted_backtrace}"
       end
 
-      formatted_msg = "[#{Time.now.to_s(:db)}] "
+      formatted_msg = "[#{Time.now.to_formatted_s(:db)}]"
       formatted_msg << '[rpush] ' if Rpush.config.embedded
       formatted_msg << "[#{prefix}] " if prefix
       formatted_msg << msg

data/lib/rpush/version.rb

@@ -1,8 +1,8 @@
 module Rpush
   module VERSION
-    MAJOR = 5
-    MINOR = 4
-    TINY = 0
+    MAJOR = 7
+    MINOR = 0
+    TINY = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/spec/functional/apns2_spec.rb

@@ -79,7 +79,8 @@ describe 'APNs http2 adapter' do
           headers: {
             'apns-expiration' => '0',
             'apns-priority' => '10',
-            'apns-topic' => 'com.example.app'
+            'apns-topic' => 'com.example.app',
+            'apns-push-type' => 'background'
           }
         }
       )
@@ -113,7 +114,8 @@ describe 'APNs http2 adapter' do
             headers: {
               'apns-topic' => bundle_id,
               'apns-expiration' => '0',
-              'apns-priority' => '10'
+              'apns-priority' => '10',
+              'apns-push-type' => 'background'
             }
           }
         ).and_return(fake_http2_request)

data/spec/functional/retry_spec.rb

@@ -39,4 +39,4 @@ describe 'Retries' do
     notification.reload
     expect(notification.delivered).to eq(false)
   end
-end
+end if redis?

data/spec/functional/webpush_spec.rb

@@ -8,6 +8,7 @@ describe 'Webpush' do
 
   let(:device_reg) {
     { endpoint: 'https://webpush-provider.example.org/push/some-id',
+      expirationTime: nil,
       keys: {'auth' => 'DgN9EBia1o057BdhCOGURA', 'p256dh' => 'BAtxJ--7vHq9IVm8utUB3peJ4lpxRqk1rukCIkVJOomS83QkCnrQ4EyYQsSaCRgy_c8XPytgXxuyAvRJdnTPK4A'} }
   }
   let(:notification) { Rpush::Webpush::Notification.create!(app: app, registration_ids: [device_reg], data: { message: 'test' }) }

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ def client
   (ENV['CLIENT'] || :active_record).to_sym
 end
 
-if !ENV['TRAVIS'] || (ENV['TRAVIS'] && ENV['QUALITY'] == 'true')
+if !ENV['CI'] || (ENV['CI'] && ENV['QUALITY'] == 'true')
   begin
     require './spec/support/simplecov_helper'
     include SimpleCovHelper

data/spec/support/active_record_setup.rb

@@ -6,14 +6,15 @@ SPEC_ADAPTER = ENV['ADAPTER'] || 'postgresql'
 SPEC_ADAPTER = 'jdbc' + SPEC_ADAPTER if jruby
 
 require 'yaml'
-db_config = YAML.load_file(File.expand_path("config/database.yml", File.dirname(__FILE__)))
+db_config_path = File.expand_path("config/database.yml", File.dirname(__FILE__))
+db_config = YAML.load(ERB.new(File.read(db_config_path)).result)
 
 if db_config[SPEC_ADAPTER].nil?
   puts "No such adapter '#{SPEC_ADAPTER}'. Valid adapters are #{db_config.keys.join(', ')}."
   exit 1
 end
 
-if ENV['TRAVIS']
+if ENV['CI']
   db_config[SPEC_ADAPTER]['username'] = 'postgres'
 else
   require 'etc'
@@ -62,7 +63,7 @@ migrations = [
   Rpush420Updates
 ]
 
-unless ENV['TRAVIS']
+unless ENV['CI']
   migrations.reverse_each do |m|
     begin
       m.down

data/spec/support/config/database.yml

@@ -2,10 +2,10 @@
 
 postgresql:
   adapter: postgresql
-  database: rpush_test
-  host: localhost
-  username: postgres
-  password: ""
+  database: <%= ENV.fetch('POSTGRES_DB', 'rpush_test') %>
+  host: <%= ENV.fetch('POSTGRES_HOST', 'localhost') %>
+  username: <%= ENV.fetch('POSTGRES_USER', 'postgres') %>
+  password: <%= ENV.fetch('PGPASSWORD', '') %>
 
 jdbcpostgresql:
   adapter: jdbcpostgresql

data/spec/support/simplecov_helper.rb

@@ -10,7 +10,7 @@ module SimpleCovHelper
 
       formatters = [SimpleCov::Formatter::QualityFormatter]
 
-      if ENV['TRAVIS']
+      if ENV['CI']
         require 'codeclimate-test-reporter'
 
         if CodeClimate::TestReporter.run?

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

@@ -8,7 +8,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification do
 
   it "should validate the length of the binary conversion of the notification" do
     notification = described_class.new
-    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development', certificate: TEST_CERT)
     notification.device_token = "a" * 108
     notification.alert = ""
 

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

@@ -1,4 +1,5 @@
 require 'unit_spec_helper'
 
 describe Rpush::Client::ActiveRecord::Apns2::App do
+  it_behaves_like 'Rpush::Client::Apns::App'
 end if active_record?

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

@@ -8,7 +8,7 @@ describe Rpush::Client::ActiveRecord::Apns2::Notification do
 
   it "should validate the length of the binary conversion of the notification" do
     notification = described_class.new
-    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development', certificate: TEST_CERT)
     notification.device_token = "a" * 108
     notification.alert = ""
 

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

@@ -7,7 +7,7 @@ describe Rpush::Client::Redis::Apns::Notification do
 
   it "should validate the length of the binary conversion of the notification" do
     notification = described_class.new
-    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development', certificate: TEST_CERT)
     notification.device_token = "a" * 108
     notification.alert = ""
 

data/spec/unit/client/redis/apns2/notification_spec.rb

@@ -7,7 +7,7 @@ describe Rpush::Client::Redis::Apns2::Notification do
 
   it "should validate the length of the binary conversion of the notification" do
     notification = described_class.new
-    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development', certificate: TEST_CERT)
     notification.device_token = "a" * 108
     notification.alert = ""
 

data/spec/unit/client/shared/apns/notification.rb

@@ -165,6 +165,21 @@ shared_examples 'Rpush::Client::Apns::Notification' do
     end
   end
 
+  describe 'content_available?' do
+    context 'if not set' do
+      it 'should be false' do
+        expect(notification.content_available?).to be_falsey
+      end
+    end
+
+    context 'if set' do
+      it 'should be true' do
+        notification.content_available = true
+        expect(notification.content_available?).to be_truthy
+      end
+    end
+  end
+
   describe 'url-args' do
     it 'includes url-args in the payload' do
       notification.url_args = ['url-arg-1']

data/spec/unit/daemon/apnsp8/delivery_spec.rb

@@ -0,0 +1,53 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::Apnsp8::Delivery do
+  subject(:delivery) { described_class.new(app, http2_client, token_provider, batch) }
+
+  let(:app) { double(bundle_id: 'MY BUNDLE ID') }
+  let(:notification1) { double('Notification 1', data: {}, as_json: {}).as_null_object }
+  let(:notification2) { double('Notification 2', data: {}, as_json: {}).as_null_object }
+
+  let(:token_provider) { double(token: 'MY JWT TOKEN') }
+  let(:max_concurrent_streams) { 100 }
+  let(:remote_settings) { { settings_max_concurrent_streams: max_concurrent_streams } }
+  let(:http_request) { double(on: nil) }
+  let(:http2_client) do
+    double(
+      stream_count: 0,
+      call_async: nil,
+      join: nil,
+      prepare_request: http_request,
+      remote_settings: remote_settings
+    )
+  end
+
+  let(:batch) { double(mark_delivered: nil, all_processed: nil) }
+  let(:logger) { double(info: nil) }
+
+  before do
+    allow(batch).to receive(:each_notification) do |&blk|
+      [notification1, notification2].each(&blk)
+    end
+    allow(Rpush).to receive_messages(logger: logger)
+  end
+
+  describe '#perform' do
+    context 'with an HTTP2 client where max concurrent streams is not set' do
+      let(:max_concurrent_streams) { 0x7fffffff }
+
+      it 'does not fall into an infinite loop on notifications after the first' do
+        start = Time.now
+        thread = Thread.new { delivery.perform }
+
+        loop do
+          break unless thread.alive?
+
+          if Time.now - start > 0.5
+            thread.kill
+            fail 'Stuck in an infinite loop'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -66,4 +66,11 @@ describe Rpush::Daemon::Store::ActiveRecord do
       expect(store.deliverable_notifications(Rpush.config.batch_size)).to be_empty
     end
   end
+
+  describe "#adapter_name" do
+    it "should return the adapter name" do
+      adapter = ENV["ADAPTER"] || "postgresql"
+      expect(store.adapter_name).to eq(adapter)
+    end
+  end
 end if active_record?