rpush 5.0.0 → 6.0.0

data/lib/rpush/daemon.rb

@@ -68,6 +68,9 @@ require 'rpush/daemon/adm'
 require 'rpush/daemon/pushy'
 require 'rpush/daemon/pushy/delivery'
 
+require 'rpush/daemon/webpush/delivery'
+require 'rpush/daemon/webpush'
+
 module Rpush
   module Daemon
     class << self
@@ -109,7 +112,7 @@ module Rpush
         Feeder.stop
         AppRunner.stop
         delete_pid_file
-        puts Rainbow('✔').red if Rpush.config.foreground
+        puts Rainbow('✔').red if Rpush.config.foreground && Rpush.config.foreground_logging
       end
     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/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.rb

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

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/logger.rb

@@ -79,6 +79,7 @@ module Rpush
     end
 
     def log_foreground(io, formatted_msg, inline)
+      return unless Rpush.config.foreground_logging
       return unless io == STDERR || Rpush.config.foreground
 
       if inline

data/lib/rpush/version.rb

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

data/spec/functional/apns2_spec.rb

@@ -42,6 +42,7 @@ describe 'APNs http2 adapter' do
     app.certificate = TEST_CERT
     app.name = 'test'
     app.environment = 'development'
+    app.bundle_id = 'com.example.app'
     app.save!
     app
   end
@@ -75,7 +76,13 @@ describe 'APNs http2 adapter' do
         :post,
         "/3/device/#{fake_device_token}",
         { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\",\"content-available\":1}}",
-          headers: {} }
+          headers: {
+            'apns-expiration' => '0',
+            'apns-priority' => '10',
+            'apns-topic' => 'com.example.app',
+            'apns-push-type' => 'background'
+          }
+        }
       )
       .and_return(fake_http2_request)
 
@@ -104,7 +111,12 @@ describe 'APNs http2 adapter' do
           "/3/device/#{fake_device_token}",
           { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\","\
                   "\"content-available\":1},\"some_field\":\"some value\"}",
-            headers: { 'apns-topic' => bundle_id }
+            headers: {
+              'apns-topic' => bundle_id,
+              'apns-expiration' => '0',
+              'apns-priority' => '10',
+              'apns-push-type' => 'background'
+            }
           }
         ).and_return(fake_http2_request)
 
@@ -177,6 +189,13 @@ describe 'APNs http2 adapter' do
     end
 
     context 'when there is SocketError' do
+      let(:fake_http_resp_headers) {
+        {
+          ":status" => "500",
+          "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+        }
+      }
+
       before(:each) do
         expect(fake_client).to receive(:call_async) { raise(SocketError) }
       end
@@ -201,6 +220,24 @@ describe 'APNs http2 adapter' do
         notification = create_notification
         Rpush.push
       end
+
+      context 'when specific notification was delivered before request failed' do
+        let(:fake_http_resp_headers) {
+          {
+            ":status" => "200",
+            "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+          }
+        }
+
+        it 'fails but will not retry this notification' do
+          notification = create_notification
+          expect do
+            Rpush.push
+            notification.reload
+          end.to change(notification, :retries).by(0)
+             .and change(notification, :delivered).to(true)
+        end
+      end
     end
 
     context 'when any StandardError occurs' do
@@ -228,5 +265,65 @@ describe 'APNs http2 adapter' do
         Rpush.push
       end
     end
+
+    context 'when waiting for requests to complete times out' do
+      let(:on_close) do
+        proc { |&block| @thread = Thread.new { sleep(0.01) } }
+      end
+
+      before(:each) do
+        @thread = nil
+
+        expect(fake_http2_request).
+          to receive(:on).with(:close), &on_close
+
+        expect(fake_client).to receive(:join) { @thread.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
+
+      context 'when specific notification was delivered before another async call failed' do
+        let(:on_close) do
+          proc { |&block| @thread = Thread.new { sleep(0.01); block.call } }
+        end
+
+        it 'fails but retries delivery several times' do
+          notification = create_notification
+          expect do
+            Rpush.push
+            notification.reload
+          end.to change(notification, :retries).by(0)
+             .and change(notification, :delivered).to(true)
+        end
+      end
+    end
   end
 end