rpush 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bd7e063c214b8ab031ca63892ec39f425813c6a1dd9f54f09cfdc5b0e6291b7
-  data.tar.gz: '080a33b636882719f1bf2284035a5fe9d22d8073123808a9d1e3acee84622588'
+  metadata.gz: 6576c1456435dd596c992846892b840f204b4cf8956b13f0c06b9b336b6e0fd8
+  data.tar.gz: 57ba3957011570e259585b3528f0bd344411f22db72bf03cea01bfe049107ac2
 SHA512:
-  metadata.gz: e68cf92207ac195e120063301ae6ec23217fbaf31ea46757a9a28163dcc584763e08f26e4e1cf11978bf10a232b9eabd71ef205c4817543d8065e32fc3bf0418
-  data.tar.gz: 5bdb35aa1a78ff6f6590072581deb06e29ad51c2255b603c2ed35c985e65fdbb8b524fca80a011d0acae8038dc67579e7cb7d822f24d41ce36da81fb615b3f24
+  metadata.gz: 1fcce116cbddf64aacbf00d2b7294056f3c502b59f108783b53a1c90807cd0816a68be2c43e543625d556ad7de484786edb2baad1dbdc2652cfc1c4f582539f9
+  data.tar.gz: 0e468a1f43d8c422db967946fdc8d867bfc8bce6eaea511bff04e34108f77b75e9b0f903a3c008594482fe159ee9b820cc65be81008d60e2261b26f61c6ca274

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [v5.2.0](https://github.com/rpush/rpush/tree/v5.2.0) (2020-10-08)
+
+[Full Changelog](https://github.com/rpush/rpush/compare/v5.1.0...v5.2.0)
+
+**Merged pull requests:**
+
+- Allow opting out of foreground stdout logging [\#571](https://github.com/rpush/rpush/pull/571) ([benlangfeld](https://github.com/benlangfeld))
+- Do not retry notifications which already have been delivered/failed [\#567](https://github.com/rpush/rpush/pull/567) ([AlexTatarnikov](https://github.com/AlexTatarnikov))
+- Improve APNs documentation. [\#553](https://github.com/rpush/rpush/pull/553) ([timdiggins](https://github.com/timdiggins))
+
 ## [v5.1.0](https://github.com/rpush/rpush/tree/v5.1.0) (2020-09-25)
 
 [Full Changelog](https://github.com/rpush/rpush/compare/v5.0.0...v5.1.0)
@@ -481,6 +491,4 @@ Bug fixes:
 - Removed rpush.yml in favour of command line options.
 - 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)_
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -52,56 +52,97 @@ $ bundle exec rpush init
 
 #### Apple Push Notification Service
 
+There is a choice of two modes (and one legacy mode) using certificates or using tokens:
 
-If this is your first time using the APNs, you will need to generate SSL certificates. See [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates) for instructions.
+* `Rpush::Apns2` This requires an annually renewable certificate. see https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns
+* `Rpush::Apnsp8` This uses encrypted tokens and requires an encryption key id and encryption key (provide as a p8 file). (see https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns)
+* `Rpush::Apns` There is also the original APNS (the original version using certificates with a binary underlying protocol over TCP directly rather than over Http/2).
+  Apple have [announced](https://developer.apple.com/news/?id=11042019a) that this is not supported after November 2020.
+
+If this is your first time using the APNs, you will need to generate either SSL certificates (for Apns2 or Apns) or an Encryption Key (p8) and an Encryption Key ID (for Apnsp8). See [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates) for instructions.
+
+##### Apnsp8
+
+To use the p8 APNs Api:
 
 ```ruby
-app = Rpush::Apns::App.new
+app = Rpush::Apnsp8::App.new
 app.name = "ios_app"
-app.certificate = File.read("/path/to/sandbox.pem")
+app.apn_key = File.read("/path/to/sandbox.p8")
 app.environment = "development" # APNs environment.
-app.password = "certificate password"
+app.apn_key_id = "APN KEY ID" # This is the Encryption Key ID provided by apple
+app.team_id = "TEAM ID" # the team id - e.g. ABCDE12345
+app.bundle_id = "BUNDLE ID" # the unique bundle id of the app, like com.example.appname
 app.connections = 1
 app.save!
 ```
 
 ```ruby
 n = Rpush::Apns::Notification.new
-n.app = Rpush::Apns::App.find_by_name("ios_app")
+n.app = Rpush::Apnsp8::App.find_by_name("ios_app")
 n.device_token = "..." # hex string
 n.alert = "hi mom!"
 n.data = { foo: :bar }
 n.save!
 ```
 
-The `url_args` attribute is available for Safari Push Notifications.
+##### Apns2
 
-You should also implement the [ssl_certificate_will_expire](https://github.com/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
+(NB this uses the same protocol as Apnsp8, but authenticates with a certificate rather than tokens)
+
+```ruby
+app = Rpush::Apns2::App.new
+app.name = "ios_app"
+app.certificate = File.read("/path/to/sandbox.pem")
+app.environment = "development"
+app.password = "certificate password"
+app.connections = 1
+app.save!
+```
 
-To use the newer APNs Api replace `Rpush::Apns::App` with `Rpush::Apns2::App`.
+```ruby
+n = Rpush::Apns2::Notification.new
+n.app = Rpush::Apns2::App.find_by_name("ios_app")
+n.device_token = "..." # hex string
+n.alert = "hi mom!"
+n.data = {
+  headers: { 'apns-topic': "BUNDLE ID", # the bundle id of the app, like com.example.appname
+  foo: :bar }
+  }
+n.save!
+```
 
-To use the p8 APNs Api replace `Rpush::Apns::App` with `Rpush::Apnsp8::App`.
+You should also implement the [ssl_certificate_will_expire](https://github.com/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
+
+##### Apns (legacy protocol)
 
 ```ruby
-app = Rpush::Apnsp8::App.new
+app = Rpush::Apns::App.new
 app.name = "ios_app"
-app.apn_key = File.read("/path/to/sandbox.p8")
+app.certificate = File.read("/path/to/sandbox.pem")
 app.environment = "development" # APNs environment.
-app.apn_key_id = "APN KEY ID"
-app.team_id = "TEAM ID"
-app.bundle_id = "BUNDLE ID"
+app.password = "certificate password"
 app.connections = 1
 app.save!
 ```
 
 ```ruby
 n = Rpush::Apns::Notification.new
-n.app = Rpush::Apnsp8::App.find_by_name("ios_app")
+n.app = Rpush::Apns::App.find_by_name("ios_app")
 n.device_token = "..." # hex string
 n.alert = "hi mom!"
 n.data = { foo: :bar }
 n.save!
 ```
+
+##### Safari Push Notifications
+
+Using one of the notifications methods above, the `url_args` attribute is available for Safari Push Notifications.
+
+##### Environment
+
+The app `environment` for any Apns* option is "development" for XCode installs, and "production" for app store and TestFlight. Note that for Apns2 you can now use one (production + sandbox) certificate (you don't need a separate "sandbox" or development certificate), but if you do generate a development/sandbox certificate it can only be used for "development". With Apnsp8 tokens, you can target either "development" or "production" environments.
+
 #### Firebase Cloud Messaging
 
 FCM and GCM are – as of writing – compatible with each other. See also [this comment](https://github.com/rpush/rpush/issues/284#issuecomment-228330206) for further references.

data/lib/generators/templates/rpush.rb

@@ -26,6 +26,10 @@ Rpush.configure do |config|
   # Define a custom logger.
   # config.logger = MyLogger.new
 
+  # By default in foreground mode logs are directed both to the logger and to stdout.
+  # If the logger goes to stdout, you can disable foreground logging to avoid duplication.
+  # config.foreground_logging = false
+
   # config.apns.feedback_receiver.enabled = true
   # config.apns.feedback_receiver.frequency = 60
 

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
 

data/lib/rpush/daemon.rb

@@ -109,7 +109,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/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/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,7 +1,7 @@
 module Rpush
   module VERSION
     MAJOR = 5
-    MINOR = 1
+    MINOR = 2
     TINY = 0
     PRE = nil
 

data/spec/functional/apns2_spec.rb

@@ -177,6 +177,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 +208,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
@@ -230,8 +255,17 @@ describe 'APNs http2 adapter' do
     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
-        expect(fake_client).to receive(:join) { raise(NetHttp2::AsyncRequestTimeout) }
+        @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
@@ -263,6 +297,21 @@ describe 'APNs http2 adapter' do
           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

data/spec/unit/daemon/batch_spec.rb

@@ -1,8 +1,8 @@
 require 'unit_spec_helper'
 
 describe Rpush::Daemon::Batch do
-  let(:notification1) { double(:notification1, id: 1) }
-  let(:notification2) { double(:notification2, id: 2) }
+  let(:notification1) { double(:notification1, id: 1, delivered: false, failed: false) }
+  let(:notification2) { double(:notification2, id: 2, delivered: false, failed: false) }
   let(:batch) { Rpush::Daemon::Batch.new([notification1, notification2]) }
   let(:store) { double.as_null_object }
   let(:time) { Time.now }
@@ -50,6 +50,54 @@ describe Rpush::Daemon::Batch do
     end
   end
 
+  describe 'mark_all_retryable' do
+    let(:error) { StandardError.new('Exception') }
+
+    it 'marks all notifications as retryable without persisting' do
+      expect(store).to receive(:mark_retryable).ordered.with(notification1, time, persist: false)
+      expect(store).to receive(:mark_retryable).ordered.with(notification2, time, persist: false)
+
+      batch.mark_all_retryable(time, error)
+    end
+
+    it 'defers persisting' do
+      batch.mark_all_retryable(time, error)
+      expect(batch.retryable).to eq(time => [notification1, notification2])
+    end
+
+    context 'when one of the notifications delivered' do
+      let(:notification2) { double(:notification2, id: 2, delivered: true, failed: false) }
+
+      it 'marks all only pending notification as retryable without persisting' do
+        expect(store).to receive(:mark_retryable).ordered.with(notification1, time, persist: false)
+        expect(store).not_to receive(:mark_retryable).ordered.with(notification2, time, persist: false)
+
+        batch.mark_all_retryable(time, error)
+      end
+
+      it 'defers persisting' do
+        batch.mark_all_retryable(time, error)
+        expect(batch.retryable).to eq(time => [notification1])
+      end
+    end
+
+    context 'when one of the notifications failed' do
+      let(:notification2) { double(:notification2, id: 2, delivered: false, failed: true) }
+
+      it 'marks all only pending notification as retryable without persisting' do
+        expect(store).to receive(:mark_retryable).ordered.with(notification1, time, persist: false)
+        expect(store).not_to receive(:mark_retryable).ordered.with(notification2, time, persist: false)
+
+        batch.mark_all_retryable(time, error)
+      end
+
+      it 'defers persisting' do
+        batch.mark_all_retryable(time, error)
+        expect(batch.retryable).to eq(time => [notification1])
+      end
+    end
+  end
+
   describe 'mark_failed' do
     it 'marks the notification as failed without persisting' do
       expect(store).to receive(:mark_failed).with(notification1, 1, 'an error', time, persist: false)

data/spec/unit/daemon/delivery_spec.rb

@@ -41,6 +41,16 @@ describe Rpush::Daemon::Delivery do
     end
   end
 
+  describe 'mark_batch_retryable' do
+    let(:batch) { double(Rpush::Daemon::Batch) }
+    let(:error) { StandardError.new('Exception') }
+
+    it 'marks all notifications as retryable' do
+      expect(batch).to receive(:mark_all_retryable)
+      delivery.mark_batch_retryable(Time.now + 1.hour, error)
+    end
+  end
+
   describe 'mark_batch_failed' do
     it 'marks all notifications as delivered' do
       error = Rpush::DeliveryError.new(1, 42, 'an error')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json