rpush 5.0.0 → 6.0.0

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

@@ -0,0 +1,144 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::Webpush::Delivery do
+  let(:app) { Rpush::Webpush::App.create!(name: 'MyApp', vapid_keypair: VAPID_KEYPAIR) }
+
+  # Push subscription information as received from a client browser when the
+  # user subscribed to push notifications.
+  let(:device_reg) {
+    { endpoint: 'https://webpush-provider.example.org/push/some-id',
+      keys: {'auth' => 'DgN9EBia1o057BdhCOGURA', 'p256dh' => 'BAtxJ--7vHq9IVm8utUB3peJ4lpxRqk1rukCIkVJOomS83QkCnrQ4EyYQsSaCRgy_c8XPytgXxuyAvRJdnTPK4A'} }
+  }
+
+  let(:data) { { message: 'some message' } }
+  let(:notification) { Rpush::Webpush::Notification.create!(app: app, registration_ids: [device_reg], data: data) }
+  let(:batch) { instance_double('Rpush::Daemon::Batch', notification_processed: nil) }
+  let(:response) { instance_double('Net::HTTPResponse', code: response_code, header: response_header, body: response_body) }
+  let(:response_code) { 201 }
+  let(:response_header) { {} }
+  let(:response_body) { nil }
+  let(:http) { instance_double('Net::HTTP::Persistent', request: response) }
+  let(:logger) { instance_double('Rpush::Logger', error: nil, info: nil, warn: nil, internal_logger: nil) }
+  let(:now) { Time.parse('2020-10-13 00:00:00 UTC') }
+
+  before do
+    allow(Rpush).to receive_messages(logger: logger)
+    allow(Time).to receive_messages(now: now)
+  end
+
+  subject(:delivery) { described_class.new(app, http, notification, batch) }
+
+  describe '#perform' do
+    shared_examples 'process notification' do
+      it 'invoke batch.notification_processed' do
+        subject.perform rescue nil
+        expect(batch).to have_received(:notification_processed)
+      end
+    end
+
+    context 'when response code is 201' do
+      before do
+        allow(batch).to receive(:mark_delivered)
+        Rpush::Daemon.store = Rpush::Daemon::Store.const_get(Rpush.config.client.to_s.camelcase).new
+      end
+
+      it 'marks the notification as delivered' do
+        delivery.perform
+        expect(batch).to have_received(:mark_delivered).with(notification)
+      end
+
+      it_behaves_like 'process notification'
+    end
+
+    shared_examples 'retry delivery' do |options|
+      let(:response_code) { options[:response_code] }
+
+      shared_examples 'logs' do |log_options|
+        let(:deliver_after) { log_options[:deliver_after] }
+
+        let(:expected_log_message) do
+          "[MyApp] Webpush endpoint responded with a #{response_code} error. Notification #{notification.id} will be retried after #{deliver_after} (retry 1)."
+        end
+
+        it 'logs that the notification will be retried' do
+          delivery.perform
+          expect(logger).to have_received(:info).with(expected_log_message)
+        end
+      end
+
+      context 'when Retry-After header is present' do
+        let(:response_header) { { 'retry-after' => 10 } }
+
+        before do
+          allow(delivery).to receive(:mark_retryable) do
+            notification.deliver_after = now + 10.seconds
+            notification.retries += 1
+          end
+        end
+
+        it 'retry the notification' do
+          delivery.perform
+          expect(delivery).to have_received(:mark_retryable).with(notification, now + 10.seconds)
+        end
+
+        it_behaves_like 'logs', deliver_after: '2020-10-13 00:00:10'
+        it_behaves_like 'process notification'
+      end
+
+      context 'when Retry-After header is not present' do
+        before do
+          allow(delivery).to receive(:mark_retryable_exponential) do
+            notification.deliver_after = now + 2.seconds
+            notification.retries = 1
+          end
+        end
+
+        it 'retry the notification' do
+          delivery.perform
+          expect(delivery).to have_received(:mark_retryable_exponential).with(notification)
+        end
+
+        it_behaves_like 'logs', deliver_after: '2020-10-13 00:00:02'
+        it_behaves_like 'process notification'
+      end
+    end
+
+    it_behaves_like 'retry delivery', response_code: 429
+    it_behaves_like 'retry delivery', response_code: 500
+    it_behaves_like 'retry delivery', response_code: 502
+    it_behaves_like 'retry delivery', response_code: 503
+    it_behaves_like 'retry delivery', response_code: 504
+
+    context 'when delivery failed' do
+      let(:response_code) { 400 }
+      let(:fail_message) { 'that was a bad request' }
+      before do
+        allow(response).to receive(:body) { fail_message }
+        allow(batch).to receive(:mark_failed)
+      end
+
+      it 'marks the notification as failed' do
+        expect { delivery.perform }.to raise_error(Rpush::DeliveryError)
+        expected_message = "Unable to deliver notification #{notification.id}, " \
+                           "received error 400 (Bad Request: #{fail_message})"
+        expect(batch).to have_received(:mark_failed).with(notification, 400, expected_message)
+      end
+
+      it_behaves_like 'process notification'
+    end
+
+    context 'when SocketError raised' do
+      before do
+        allow(http).to receive(:request) { raise SocketError }
+        allow(delivery).to receive(:mark_retryable)
+      end
+
+      it 'retry delivery after 10 seconds' do
+        expect { delivery.perform }.to raise_error(SocketError)
+        expect(delivery).to have_received(:mark_retryable).with(notification, now + 10.seconds, SocketError)
+      end
+
+      it_behaves_like 'process notification'
+    end
+  end
+end

data/spec/unit_spec_helper.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 require 'rails'
 
+# load all shared example files
+Dir["./spec/unit/**/shared/**/*.rb"].sort.each { |f| require f }
+
 def unit_example?(metadata)
   metadata[:file_path] =~ %r{spec/unit}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ian Leitch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -44,14 +44,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.3
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +78,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +134,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webpush
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -401,13 +421,14 @@ files:
 - lib/rpush/client/active_model/adm/data_validator.rb
 - lib/rpush/client/active_model/adm/notification.rb
 - lib/rpush/client/active_model/apns/app.rb
-- lib/rpush/client/active_model/apns/binary_notification_validator.rb
 - lib/rpush/client/active_model/apns/device_token_format_validator.rb
 - lib/rpush/client/active_model/apns/notification.rb
+- lib/rpush/client/active_model/apns/notification_payload_size_validator.rb
 - lib/rpush/client/active_model/apns2/app.rb
 - lib/rpush/client/active_model/apns2/notification.rb
 - lib/rpush/client/active_model/apnsp8/app.rb
 - lib/rpush/client/active_model/apnsp8/notification.rb
+- lib/rpush/client/active_model/certificate_private_key_validator.rb
 - lib/rpush/client/active_model/gcm/app.rb
 - lib/rpush/client/active_model/gcm/expiry_collapse_key_mutual_inclusion_validator.rb
 - lib/rpush/client/active_model/gcm/notification.rb
@@ -417,6 +438,8 @@ files:
 - lib/rpush/client/active_model/pushy/notification.rb
 - lib/rpush/client/active_model/pushy/time_to_live_validator.rb
 - lib/rpush/client/active_model/registration_ids_count_validator.rb
+- lib/rpush/client/active_model/webpush/app.rb
+- lib/rpush/client/active_model/webpush/notification.rb
 - lib/rpush/client/active_model/wns/app.rb
 - lib/rpush/client/active_model/wns/notification.rb
 - lib/rpush/client/active_model/wpns/app.rb
@@ -424,6 +447,7 @@ files:
 - lib/rpush/client/active_record.rb
 - lib/rpush/client/active_record/adm/app.rb
 - lib/rpush/client/active_record/adm/notification.rb
+- lib/rpush/client/active_record/apns/active_record_serializable_notification.rb
 - lib/rpush/client/active_record/apns/app.rb
 - lib/rpush/client/active_record/apns/feedback.rb
 - lib/rpush/client/active_record/apns/notification.rb
@@ -437,6 +461,8 @@ files:
 - lib/rpush/client/active_record/notification.rb
 - lib/rpush/client/active_record/pushy/app.rb
 - lib/rpush/client/active_record/pushy/notification.rb
+- lib/rpush/client/active_record/webpush/app.rb
+- lib/rpush/client/active_record/webpush/notification.rb
 - lib/rpush/client/active_record/wns/app.rb
 - lib/rpush/client/active_record/wns/badge_notification.rb
 - lib/rpush/client/active_record/wns/notification.rb
@@ -459,6 +485,8 @@ files:
 - lib/rpush/client/redis/notification.rb
 - lib/rpush/client/redis/pushy/app.rb
 - lib/rpush/client/redis/pushy/notification.rb
+- lib/rpush/client/redis/webpush/app.rb
+- lib/rpush/client/redis/webpush/notification.rb
 - lib/rpush/client/redis/wns/app.rb
 - lib/rpush/client/redis/wns/badge_notification.rb
 - lib/rpush/client/redis/wns/notification.rb
@@ -513,6 +541,8 @@ files:
 - lib/rpush/daemon/string_helpers.rb
 - lib/rpush/daemon/synchronizer.rb
 - lib/rpush/daemon/tcp_connection.rb
+- lib/rpush/daemon/webpush.rb
+- lib/rpush/daemon/webpush/delivery.rb
 - lib/rpush/daemon/wns.rb
 - lib/rpush/daemon/wns/badge_request.rb
 - lib/rpush/daemon/wns/delivery.rb
@@ -545,6 +575,7 @@ files:
 - spec/functional/pushy_spec.rb
 - spec/functional/retry_spec.rb
 - spec/functional/synchronization_spec.rb
+- spec/functional/webpush_spec.rb
 - spec/functional/wpns_spec.rb
 - spec/functional_spec_helper.rb
 - spec/spec_helper.rb
@@ -561,21 +592,66 @@ files:
 - spec/unit/client/active_record/apns/app_spec.rb
 - spec/unit/client/active_record/apns/feedback_spec.rb
 - spec/unit/client/active_record/apns/notification_spec.rb
+- spec/unit/client/active_record/apns2/app_spec.rb
+- spec/unit/client/active_record/apns2/notification_spec.rb
+- spec/unit/client/active_record/apnsp8/notification_spec.rb
 - spec/unit/client/active_record/app_spec.rb
 - spec/unit/client/active_record/gcm/app_spec.rb
 - spec/unit/client/active_record/gcm/notification_spec.rb
 - spec/unit/client/active_record/notification_spec.rb
 - spec/unit/client/active_record/pushy/app_spec.rb
 - spec/unit/client/active_record/pushy/notification_spec.rb
+- spec/unit/client/active_record/shared/app.rb
+- spec/unit/client/active_record/shared/notification.rb
+- spec/unit/client/active_record/webpush/app_spec.rb
+- spec/unit/client/active_record/webpush/notification_spec.rb
 - spec/unit/client/active_record/wns/badge_notification_spec.rb
 - spec/unit/client/active_record/wns/raw_notification_spec.rb
 - spec/unit/client/active_record/wpns/app_spec.rb
 - spec/unit/client/active_record/wpns/notification_spec.rb
+- spec/unit/client/redis/adm/app_spec.rb
+- spec/unit/client/redis/adm/notification_spec.rb
+- spec/unit/client/redis/apns/app_spec.rb
+- spec/unit/client/redis/apns/feedback_spec.rb
+- spec/unit/client/redis/apns/notification_spec.rb
+- spec/unit/client/redis/apns2/app_spec.rb
+- spec/unit/client/redis/apns2/notification_spec.rb
+- spec/unit/client/redis/apnsp8/notification_spec.rb
+- spec/unit/client/redis/app_spec.rb
+- spec/unit/client/redis/gcm/app_spec.rb
+- spec/unit/client/redis/gcm/notification_spec.rb
+- spec/unit/client/redis/notification_spec.rb
+- spec/unit/client/redis/pushy/app_spec.rb
+- spec/unit/client/redis/pushy/notification_spec.rb
+- spec/unit/client/redis/webpush/app_spec.rb
+- spec/unit/client/redis/webpush/notification_spec.rb
+- spec/unit/client/redis/wns/badge_notification_spec.rb
+- spec/unit/client/redis/wns/raw_notification_spec.rb
+- spec/unit/client/redis/wpns/app_spec.rb
+- spec/unit/client/redis/wpns/notification_spec.rb
+- spec/unit/client/shared/adm/app.rb
+- spec/unit/client/shared/adm/notification.rb
+- spec/unit/client/shared/apns/app.rb
+- spec/unit/client/shared/apns/feedback.rb
+- spec/unit/client/shared/apns/notification.rb
+- spec/unit/client/shared/app.rb
+- spec/unit/client/shared/gcm/app.rb
+- spec/unit/client/shared/gcm/notification.rb
+- spec/unit/client/shared/notification.rb
+- spec/unit/client/shared/pushy/app.rb
+- spec/unit/client/shared/pushy/notification.rb
+- spec/unit/client/shared/webpush/app.rb
+- spec/unit/client/shared/webpush/notification.rb
+- spec/unit/client/shared/wns/badge_notification.rb
+- spec/unit/client/shared/wns/raw_notification.rb
+- spec/unit/client/shared/wpns/app.rb
+- spec/unit/client/shared/wpns/notification.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/daemon/adm/delivery_spec.rb
 - spec/unit/daemon/apns/certificate_expired_error_spec.rb
 - spec/unit/daemon/apns/delivery_spec.rb
 - spec/unit/daemon/apns/feedback_receiver_spec.rb
+- spec/unit/daemon/apnsp8/delivery_spec.rb
 - spec/unit/daemon/app_runner_spec.rb
 - spec/unit/daemon/batch_spec.rb
 - spec/unit/daemon/delivery_error_spec.rb
@@ -589,11 +665,13 @@ files:
 - spec/unit/daemon/pushy/delivery_spec.rb
 - spec/unit/daemon/retryable_error_spec.rb
 - spec/unit/daemon/service_config_methods_spec.rb
+- spec/unit/daemon/shared/store.rb
 - spec/unit/daemon/signal_handler_spec.rb
 - spec/unit/daemon/store/active_record/reconnectable_spec.rb
 - spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon/store/redis_spec.rb
 - spec/unit/daemon/tcp_connection_spec.rb
+- spec/unit/daemon/webpush/delivery_spec.rb
 - spec/unit/daemon/wns/delivery_spec.rb
 - spec/unit/daemon/wns/post_request_spec.rb
 - spec/unit/daemon/wpns/delivery_spec.rb
@@ -602,7 +680,6 @@ files:
 - spec/unit/deprecation_spec.rb
 - spec/unit/embed_spec.rb
 - spec/unit/logger_spec.rb
-- spec/unit/notification_shared.rb
 - spec/unit/plugin_spec.rb
 - spec/unit/push_spec.rb
 - spec/unit/reflectable_spec.rb
@@ -617,7 +694,7 @@ metadata:
   changelog_uri: https://github.com/rpush/rpush/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rpush/rpush
 post_install_message: |
-  When upgrading, don't forget to run `bundle exec rpush init` to get all the latest migrations.
+  When upgrading Rpush, don't forget to run `bundle exec rpush init` to get all the latest migrations.
 
   For details on this specific release, refer to the CHANGELOG.md file.
   https://github.com/rpush/rpush/blob/master/CHANGELOG.md
@@ -635,8 +712,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The push notification service for Ruby.
 test_files:
@@ -652,6 +729,7 @@ test_files:
 - spec/functional/pushy_spec.rb
 - spec/functional/retry_spec.rb
 - spec/functional/synchronization_spec.rb
+- spec/functional/webpush_spec.rb
 - spec/functional/wpns_spec.rb
 - spec/functional_spec_helper.rb
 - spec/spec_helper.rb
@@ -668,21 +746,66 @@ test_files:
 - spec/unit/client/active_record/apns/app_spec.rb
 - spec/unit/client/active_record/apns/feedback_spec.rb
 - spec/unit/client/active_record/apns/notification_spec.rb
+- spec/unit/client/active_record/apns2/app_spec.rb
+- spec/unit/client/active_record/apns2/notification_spec.rb
+- spec/unit/client/active_record/apnsp8/notification_spec.rb
 - spec/unit/client/active_record/app_spec.rb
 - spec/unit/client/active_record/gcm/app_spec.rb
 - spec/unit/client/active_record/gcm/notification_spec.rb
 - spec/unit/client/active_record/notification_spec.rb
 - spec/unit/client/active_record/pushy/app_spec.rb
 - spec/unit/client/active_record/pushy/notification_spec.rb
+- spec/unit/client/active_record/shared/app.rb
+- spec/unit/client/active_record/shared/notification.rb
+- spec/unit/client/active_record/webpush/app_spec.rb
+- spec/unit/client/active_record/webpush/notification_spec.rb
 - spec/unit/client/active_record/wns/badge_notification_spec.rb
 - spec/unit/client/active_record/wns/raw_notification_spec.rb
 - spec/unit/client/active_record/wpns/app_spec.rb
 - spec/unit/client/active_record/wpns/notification_spec.rb
+- spec/unit/client/redis/adm/app_spec.rb
+- spec/unit/client/redis/adm/notification_spec.rb
+- spec/unit/client/redis/apns/app_spec.rb
+- spec/unit/client/redis/apns/feedback_spec.rb
+- spec/unit/client/redis/apns/notification_spec.rb
+- spec/unit/client/redis/apns2/app_spec.rb
+- spec/unit/client/redis/apns2/notification_spec.rb
+- spec/unit/client/redis/apnsp8/notification_spec.rb
+- spec/unit/client/redis/app_spec.rb
+- spec/unit/client/redis/gcm/app_spec.rb
+- spec/unit/client/redis/gcm/notification_spec.rb
+- spec/unit/client/redis/notification_spec.rb
+- spec/unit/client/redis/pushy/app_spec.rb
+- spec/unit/client/redis/pushy/notification_spec.rb
+- spec/unit/client/redis/webpush/app_spec.rb
+- spec/unit/client/redis/webpush/notification_spec.rb
+- spec/unit/client/redis/wns/badge_notification_spec.rb
+- spec/unit/client/redis/wns/raw_notification_spec.rb
+- spec/unit/client/redis/wpns/app_spec.rb
+- spec/unit/client/redis/wpns/notification_spec.rb
+- spec/unit/client/shared/adm/app.rb
+- spec/unit/client/shared/adm/notification.rb
+- spec/unit/client/shared/apns/app.rb
+- spec/unit/client/shared/apns/feedback.rb
+- spec/unit/client/shared/apns/notification.rb
+- spec/unit/client/shared/app.rb
+- spec/unit/client/shared/gcm/app.rb
+- spec/unit/client/shared/gcm/notification.rb
+- spec/unit/client/shared/notification.rb
+- spec/unit/client/shared/pushy/app.rb
+- spec/unit/client/shared/pushy/notification.rb
+- spec/unit/client/shared/webpush/app.rb
+- spec/unit/client/shared/webpush/notification.rb
+- spec/unit/client/shared/wns/badge_notification.rb
+- spec/unit/client/shared/wns/raw_notification.rb
+- spec/unit/client/shared/wpns/app.rb
+- spec/unit/client/shared/wpns/notification.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/daemon/adm/delivery_spec.rb
 - spec/unit/daemon/apns/certificate_expired_error_spec.rb
 - spec/unit/daemon/apns/delivery_spec.rb
 - spec/unit/daemon/apns/feedback_receiver_spec.rb
+- spec/unit/daemon/apnsp8/delivery_spec.rb
 - spec/unit/daemon/app_runner_spec.rb
 - spec/unit/daemon/batch_spec.rb
 - spec/unit/daemon/delivery_error_spec.rb
@@ -696,11 +819,13 @@ test_files:
 - spec/unit/daemon/pushy/delivery_spec.rb
 - spec/unit/daemon/retryable_error_spec.rb
 - spec/unit/daemon/service_config_methods_spec.rb
+- spec/unit/daemon/shared/store.rb
 - spec/unit/daemon/signal_handler_spec.rb
 - spec/unit/daemon/store/active_record/reconnectable_spec.rb
 - spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon/store/redis_spec.rb
 - spec/unit/daemon/tcp_connection_spec.rb
+- spec/unit/daemon/webpush/delivery_spec.rb
 - spec/unit/daemon/wns/delivery_spec.rb
 - spec/unit/daemon/wns/post_request_spec.rb
 - spec/unit/daemon/wpns/delivery_spec.rb
@@ -709,7 +834,6 @@ test_files:
 - spec/unit/deprecation_spec.rb
 - spec/unit/embed_spec.rb
 - spec/unit/logger_spec.rb
-- spec/unit/notification_shared.rb
 - spec/unit/plugin_spec.rb
 - spec/unit/push_spec.rb
 - spec/unit/reflectable_spec.rb