rpush 4.2.0 → 7.0.1

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/active_record/apnsp8/notification.rb

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

data/lib/rpush/client/active_record/webpush/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Webpush
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Webpush::App
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Webpush
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Webpush::Notification
+        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'
@@ -31,3 +32,6 @@ require 'rpush/client/active_record/adm/app'
 
 require 'rpush/client/active_record/pushy/notification'
 require 'rpush/client/active_record/pushy/app'
+
+require 'rpush/client/active_record/webpush/notification'
+require 'rpush/client/active_record/webpush/app'

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/apnsp8/notification.rb

@@ -3,6 +3,8 @@ module Rpush
     module Redis
       module Apnsp8
         class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
           include Rpush::Client::ActiveModel::Apnsp8::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/client/redis/webpush/app.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module Redis
+      module Webpush
+        class App < Rpush::Client::Redis::App
+          include Rpush::Client::ActiveModel::Webpush::App
+
+          def vapid_keypair=(value)
+            self.certificate = value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module Redis
+      module Webpush
+        class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Webpush::Notification
+
+          def time_to_live=(value)
+            self.expiry = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/redis.rb

@@ -44,6 +44,9 @@ require 'rpush/client/redis/wns/badge_notification'
 require 'rpush/client/redis/pushy/app'
 require 'rpush/client/redis/pushy/notification'
 
+require 'rpush/client/redis/webpush/app'
+require 'rpush/client/redis/webpush/notification'
+
 Modis.configure do |config|
   config.namespace = :rpush
 end

data/lib/rpush/configuration.rb

@@ -16,7 +16,7 @@ module Rpush
     end
   end
 
-  CURRENT_ATTRS = [:push_poll, :embedded, :pid_file, :batch_size, :push, :client, :logger, :log_file, :foreground, :log_level, :plugin, :apns]
+  CURRENT_ATTRS = [:push_poll, :embedded, :pid_file, :batch_size, :push, :client, :logger, :log_file, :foreground, :foreground_logging, :log_level, :plugin, :apns]
   DEPRECATED_ATTRS = []
   CONFIG_ATTRS = CURRENT_ATTRS + DEPRECATED_ATTRS
 
@@ -53,6 +53,7 @@ module Rpush
       self.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::DEBUG
       self.plugin = OpenStruct.new
       self.foreground = false
+      self.foreground_logging = true
 
       self.apns = ApnsConfiguration.new
 
@@ -105,7 +106,7 @@ module Rpush
       client_module = Rpush::Client.const_get(client.to_s.camelize)
       Rpush.send(:include, client_module) unless Rpush.ancestors.include?(client_module)
 
-      [:Apns, :Gcm, :Wpns, :Wns, :Adm, :Pushy].each do |service|
+      [:Apns, :Gcm, :Wpns, :Wns, :Adm, :Pushy, :Webpush].each do |service|
         Rpush.const_set(service, client_module.const_get(service)) unless Rpush.const_defined?(service)
       end
 

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

@@ -37,7 +37,7 @@ module Rpush
             Rpush::Daemon.store.release_connection
           end
 
-          puts Rainbow('✔').green if Rpush.config.foreground
+          puts Rainbow('✔').green if Rpush.config.foreground && Rpush.config.foreground_logging
         end
 
         def stop

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
@@ -102,7 +107,14 @@ module Rpush
         end
 
         def prepare_headers(notification)
-          notification_data(notification)[HTTP2_HEADERS_KEY] || {}
+          headers = {}
+
+          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
 
         def notification_data(notification)

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

@@ -7,6 +7,8 @@ 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
@@ -22,7 +24,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)
@@ -80,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
@@ -133,12 +143,13 @@ module Rpush
           jwt_token = @token_provider.token
 
           headers = {}
-          
+
           headers['content-type'] = 'application/json'
           headers['apns-expiration'] = '0'
           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/app_runner.rb

@@ -29,7 +29,7 @@ module Rpush
         Rpush.logger.info("[#{app.name}] Starting #{pluralize(app.connections, 'dispatcher')}... ", true)
         runner = @runners[app.id] = new(app)
         runner.start_dispatchers
-        puts Rainbow('✔').green if Rpush.config.foreground
+        puts Rainbow('✔').green if Rpush.config.foreground && Rpush.config.foreground_logging
         runner.start_loops
       rescue StandardError => e
         @runners.delete(app.id)

data/lib/rpush/daemon/batch.rb

@@ -2,6 +2,7 @@ module Rpush
   module Daemon
     class Batch
       include Reflectable
+      include Loggable
 
       attr_reader :num_processed, :notifications, :delivered, :failed, :retryable
 
@@ -31,16 +32,21 @@ module Rpush
           @retryable[deliver_after] ||= []
           @retryable[deliver_after] << notification
         end
+
         Rpush::Daemon.store.mark_retryable(notification, deliver_after, persist: false)
       end
 
-      def mark_all_retryable(deliver_after)
-        @mutex.synchronize do
-          @retryable[deliver_after] = @notifications
-        end
+      def mark_all_retryable(deliver_after, error)
+        retryable_count = 0
+
         each_notification do |notification|
-          Rpush::Daemon.store.mark_retryable(notification, deliver_after, persist: false)
+          next if notification.delivered || notification.failed
+
+          retryable_count += 1
+          mark_retryable(notification, deliver_after)
         end
+
+        log_warn("Will retry #{retryable_count} of #{@notifications.size} notifications after #{deliver_after.strftime('%Y-%m-%d %H:%M:%S')} due to error (#{error.class.name}, #{error.message})")
       end
 
       def mark_delivered(notification)
@@ -54,6 +60,7 @@ module Rpush
         @mutex.synchronize do
           @delivered = @notifications
         end
+
         each_notification do |notification|
           Rpush::Daemon.store.mark_delivered(notification, Time.now, persist: false)
         end

data/lib/rpush/daemon/delivery.rb

@@ -20,8 +20,7 @@ module Rpush
       end
 
       def mark_batch_retryable(deliver_after, error)
-        log_warn("Will retry #{@batch.notifications.size} notifications after #{deliver_after.strftime('%Y-%m-%d %H:%M:%S')} due to error (#{error.class.name}, #{error.message})")
-        @batch.mark_all_retryable(deliver_after)
+        @batch.mark_all_retryable(deliver_after, error)
       end
 
       def mark_delivered

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/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/daemon/webpush/delivery.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "webpush"
+
+module Rpush
+  module Daemon
+    module Webpush
+
+      # Webpush::Request handles all the encryption / signing.
+      # We just override #perform to inject the http instance that is managed
+      # by Rpush.
+      #
+      class Request < ::Webpush::Request
+        def perform(http)
+          req = Net::HTTP::Post.new(uri.request_uri, headers)
+          req.body = body
+          http.request(uri, req)
+        end
+      end
+
+      class Delivery < Rpush::Daemon::Delivery
+
+        OK = [ 200, 201, 202 ].freeze
+        TEMPORARY_FAILURES = [ 429, 500, 502, 503, 504 ].freeze
+
+        def initialize(app, http, notification, batch)
+          @app = app
+          @http = http
+          @notification = notification
+          @batch = batch
+        end
+
+        def perform
+          response = send_request
+          process_response response
+        rescue SocketError, SystemCallError => error
+          mark_retryable(@notification, Time.now + 10.seconds, error)
+          raise
+        rescue StandardError => error
+          mark_failed(error)
+          raise
+        ensure
+          @batch.notification_processed
+        end
+
+        private
+
+        def send_request
+          # The initializer is inherited from Webpush::Request and looks like
+          # this:
+          #
+          # initialize(message: '', subscription:, vapid:, **options)
+          #
+          # where subscription is a hash of :endpoint and :keys, and vapid
+          # holds the vapid public and private keys and the :subject (which is
+          # an email address).
+          Request.new(
+            message: @notification.message,
+            subscription: @notification.subscription,
+            vapid: @app.vapid,
+            ttl: @notification.time_to_live,
+            urgency: @notification.urgency
+          ).perform(@http)
+        end
+
+        def process_response(response)
+          case response.code.to_i
+          when *OK
+            mark_delivered
+          when *TEMPORARY_FAILURES
+            retry_delivery(response)
+          else
+            fail_delivery(response)
+          end
+        end
+
+        def retry_delivery(response)
+          time = deliver_after_header(response)
+          if time
+            mark_retryable(@notification, time)
+          else
+            mark_retryable_exponential(@notification)
+          end
+          log_info("Webpush endpoint responded with a #{response.code} error. #{retry_message}")
+        end
+
+        def fail_delivery(response)
+          fail_message = fail_message(response)
+          log_error("#{@notification.id} failed: #{fail_message}")
+          fail Rpush::DeliveryError.new(response.code.to_i, @notification.id, fail_message)
+        end
+
+        def deliver_after_header(response)
+          Rpush::Daemon::RetryHeaderParser.parse(response.header['retry-after'])
+        end
+
+        def retry_message
+          deliver_after = @notification.deliver_after.strftime('%Y-%m-%d %H:%M:%S')
+          "Notification #{@notification.id} will be retried after #{deliver_after} (retry #{@notification.retries})."
+        end
+
+        def fail_message(response)
+          msg = Rpush::Daemon::HTTP_STATUS_CODES[response.code.to_i]
+          if explanation = response.body.to_s[0..200].presence
+            msg += ": #{explanation}"
+          end
+          msg
+        end
+
+      end
+    end
+  end
+end
+

data/lib/rpush/daemon/webpush.rb

@@ -0,0 +1,10 @@
+module Rpush
+  module Daemon
+    module Webpush
+      extend ServiceConfigMethods
+
+      dispatcher :http
+    end
+  end
+end
+