rpush 7.0.0 → 8.0.0

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

@@ -0,0 +1,127 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::Fcm::Delivery do
+  let(:app) { Rpush::Fcm::App.create!(name: 'MyApp', firebase_project_id: 'abc123', json_key:'{}') }
+  let(:notification) { Rpush::Fcm::Notification.create!(app: app, device_token: 'xyz', deliver_after: Time.now) }
+  let(:logger) { double(error: nil, info: nil, warn: nil) }
+  let(:response) { double(code: 200, header: {}) }
+  let(:http) { double(shutdown: nil, request: response) }
+  let(:now) { Time.parse('2012-10-14 00:00:00') }
+  let(:batch) { double(mark_failed: nil, mark_delivered: nil, mark_retryable: nil, notification_processed: nil) }
+  let(:delivery) { Rpush::Daemon::Fcm::Delivery.new(app, http, notification, batch) }
+  let(:store) { double(create_fcm_notification: double(id: 2)) }
+
+  def perform
+    delivery.perform
+  end
+
+  def perform_with_rescue
+    expect { perform }.to raise_error(StandardError)
+  end
+
+  before do
+    allow(delivery).to receive_messages(reflect: nil)
+    allow(Rpush::Daemon).to receive_messages(store: store)
+    allow(Time).to receive_messages(now: now)
+    allow(Rpush).to receive_messages(logger: logger)
+    allow_any_instance_of(Rpush::Daemon::Fcm::Delivery).to receive_messages(obtain_access_token: "access_token")
+  end
+
+  describe 'a 200 response' do
+    before do
+      allow(response).to receive_messages(code: 200)
+      allow(response).to receive_messages(body: nil)
+      allow(notification).to receive_messages(device_token: '1')
+    end
+
+    it 'reflects on ID which successfully received the notification' do
+      expect(delivery).to receive(:reflect).with(:fcm_delivered_to_recipient, notification)
+      perform
+    end
+
+    it 'marks the notification as delivered' do
+      expect(delivery).to receive(:mark_delivered)
+      perform
+    end
+
+    it 'logs that the notification was delivered' do
+      expect(logger).to receive(:info).with("[MyApp] #{notification.id} sent to 1")
+      perform
+    end
+  end
+
+  describe 'all deliveries failed with Unavailable or InternalServerError 503' do
+    before do
+      allow(notification).to receive_messages(device_token: '1')
+      allow(response).to receive_messages(code: 503, body: nil)
+    end
+
+    it 'reflects on any IDs which failed to receive the notification' do
+      pending("Determine the correct cases where FCM should send fcm_failed_to_recipient")
+      expect(delivery).to receive(:reflect).with(:fcm_failed_to_recipient, notification)
+      perform
+    end
+
+    it 'retries the notification respecting the Retry-After header' do
+      allow(response).to receive_messages(header: { 'retry-after' => 10 })
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 10.seconds)
+      perform
+    end
+
+    it 'retries the notification using exponential back-off if the Retry-After header is not present' do
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 2)
+      perform
+    end
+
+    it 'does not mark the notification as failed' do
+      expect(delivery).not_to receive(:mark_failed)
+      perform
+    end
+
+    it 'logs that the notification will be retried' do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(Rpush.logger).to receive(:warn).with("[MyApp] FCM responded with an Service Unavailable Error. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+  end
+
+  describe 'all deliveries failed with Unavailable or InternalServerError 500' do
+    before do
+      allow(notification).to receive_messages(device_token: '1')
+      allow(response).to receive_messages(code: 500, body: nil)
+    end
+
+    it 'logs a warning that the notification has been re-queued.' do
+      notification.retries = 3
+      notification.deliver_after = now + 2**3
+      expect(Rpush.logger).to receive(:warn).with("[MyApp] FCM responded with an Internal Error. Notification #{notification.id} will be retried after #{(now + 2**3).strftime('%Y-%m-%d %H:%M:%S')} (retry 3).")
+      perform
+    end
+
+    it 'retries the notification in accordance with the exponential back-off strategy.' do
+      notification.update_attribute(:retries, 2)
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 2**3)
+      perform
+    end
+  end
+
+  describe 'all deliveries failed with invalid token' do
+    before do
+      allow(notification).to receive_messages(device_token: '1')
+      allow(response).to receive_messages(code: 404, body: { error: { status: 'NOT_FOUND', message: 'Requested entity was not found.' } }.to_json)
+    end
+
+    it 'reflects on invalid IDs' do
+      expect(delivery).to receive(:reflect).with(:fcm_invalid_device_token, app, "NOT_FOUND: Requested entity was not found.", '1')
+      perform_with_rescue
+    end
+
+    it 'marks a notification as failed if any ids are invalid' do
+      expect(delivery).to receive(:mark_failed)
+      expect(delivery).not_to receive(:mark_retryable)
+      expect(store).not_to receive(:create_fcm_notification)
+      perform_with_rescue
+    end
+  end
+end

data/spec/unit/daemon/service_config_methods_spec.rb

@@ -23,7 +23,7 @@ describe Rpush::Daemon::ServiceConfigMethods do
     ServiceConfigMethodsSpec.dispatcher :http, an: :option
     app = double
     dispatcher = double
-    expect(Rpush::Daemon::Dispatcher::Http).to receive(:new).with(app, ServiceConfigMethodsSpec::Delivery, an: :option).and_return(dispatcher)
+    expect(Rpush::Daemon::Dispatcher::Http).to receive(:new).with(app, ServiceConfigMethodsSpec::Delivery, {an: :option}).and_return(dispatcher)
     expect(ServiceConfigMethodsSpec.new_dispatcher(app)).to eq dispatcher
   end
 

data/spec/unit/daemon/tcp_connection_spec.rb

@@ -15,6 +15,7 @@ describe Rpush::Daemon::TcpConnection do
   let(:connection) { Rpush::Daemon::TcpConnection.new(app, host, port) }
 
   before do
+    allow(x509_certificate).to receive(:not_after).and_return(Time.now + 1.year)
     allow(OpenSSL::SSL::SSLContext).to receive_messages(new: ssl_context)
     allow(OpenSSL::PKey::RSA).to receive_messages(new: rsa_key)
     allow(OpenSSL::X509::Certificate).to receive_messages(new: x509_certificate)
@@ -83,31 +84,31 @@ describe Rpush::Daemon::TcpConnection do
 
     describe 'certificate expiry' do
       it 'reflects if the certificate will expire soon' do
-        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        cert = x509_certificate
         expect(connection).to receive(:reflect).with(:ssl_certificate_will_expire, app, cert.not_after)
         Timecop.freeze(cert.not_after - 3.days) { connection.connect }
       end
 
       it 'logs that the certificate will expire soon' do
-        cert = OpenSSL::X509::Certificate.new(app.certificate)
-        expect(logger).to receive(:warn).with("[#{app.name}] Certificate will expire at 2022-09-07 03:18:32 UTC.")
+        cert = x509_certificate
+        expect(logger).to receive(:warn).with("[#{app.name}] Certificate will expire at #{cert.not_after.utc}.")
         Timecop.freeze(cert.not_after - 3.days) { connection.connect }
       end
 
       it 'does not reflect if the certificate will not expire soon' do
-        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        cert = x509_certificate
         expect(connection).not_to receive(:reflect).with(:ssl_certificate_will_expire, app, kind_of(Time))
         Timecop.freeze(cert.not_after - 2.months) { connection.connect }
       end
 
       it 'logs that the certificate has expired' do
-        cert = OpenSSL::X509::Certificate.new(app.certificate)
-        expect(logger).to receive(:error).with("[#{app.name}] Certificate expired at 2022-09-07 03:18:32 UTC.")
+        cert = x509_certificate
+        expect(logger).to receive(:error).with("[#{app.name}] Certificate expired at #{cert.not_after.utc}.")
         Timecop.freeze(cert.not_after + 1.day) { connection.connect rescue Rpush::CertificateExpiredError }
       end
 
       it 'raises an error if the certificate has expired' do
-        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        cert = x509_certificate
         Timecop.freeze(cert.not_after + 1.day) do
           expect { connection.connect }.to raise_error(Rpush::CertificateExpiredError)
         end

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

@@ -50,7 +50,7 @@ describe Rpush::Daemon::Wns::Delivery do
     end
 
     it 'set the access token for the app' do
-      expect(delivery).to receive(:update_access_token).with("access_token" => "dummy_access_token", "expires_in" => 60)
+      expect(delivery).to receive(:update_access_token).with({"access_token" => "dummy_access_token", "expires_in" => 60})
       expect(store).to receive(:update_app).with app
       perform
     end

data/spec/unit/logger_spec.rb

@@ -92,7 +92,7 @@ describe Rpush::Logger do
     now = Time.now
     allow(Time).to receive(:now).and_return(now)
     logger = Rpush::Logger.new
-    expect(@logger).to receive(:info).with(/#{Regexp.escape("[#{now.to_s(:db)}]")}/)
+    expect(@logger).to receive(:info).with(/#{Regexp.escape("[#{now.to_formatted_s(:db)}]")}/)
     logger.info("blah")
   end
 

data/spec/unit_spec_helper.rb

@@ -12,7 +12,7 @@ RSpec.configure do |config|
   config.before(:each) do
     Modis.with_connection do |redis|
       redis.keys('rpush:*').each { |key| redis.del(key) }
-    end if redis?
+    end if redis? && unit_example?(self.class.metadata)
 
     if active_record? && unit_example?(self.class.metadata)
       connection = ActiveRecord::Base.connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -79,6 +79,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -86,6 +89,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -135,19 +141,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webpush
+  name: web-push
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -166,16 +200,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -264,16 +298,16 @@ dependencies:
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -413,6 +447,7 @@ files:
 - lib/generators/templates/rpush_4_1_0_updates.rb
 - lib/generators/templates/rpush_4_1_1_updates.rb
 - lib/generators/templates/rpush_4_2_0_updates.rb
+- lib/generators/templates/rpush_7_1_0_updates.rb
 - lib/rpush.rb
 - lib/rpush/apns_feedback.rb
 - lib/rpush/cli.rb
@@ -429,6 +464,10 @@ files:
 - 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/fcm/app.rb
+- lib/rpush/client/active_model/fcm/expiry_collapse_key_mutual_inclusion_validator.rb
+- lib/rpush/client/active_model/fcm/notification.rb
+- lib/rpush/client/active_model/fcm/notification_keys_in_allowed_list_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
@@ -456,6 +495,8 @@ files:
 - lib/rpush/client/active_record/apnsp8/app.rb
 - lib/rpush/client/active_record/apnsp8/notification.rb
 - lib/rpush/client/active_record/app.rb
+- lib/rpush/client/active_record/fcm/app.rb
+- lib/rpush/client/active_record/fcm/notification.rb
 - lib/rpush/client/active_record/gcm/app.rb
 - lib/rpush/client/active_record/gcm/notification.rb
 - lib/rpush/client/active_record/notification.rb
@@ -480,6 +521,8 @@ files:
 - lib/rpush/client/redis/apnsp8/app.rb
 - lib/rpush/client/redis/apnsp8/notification.rb
 - lib/rpush/client/redis/app.rb
+- lib/rpush/client/redis/fcm/app.rb
+- lib/rpush/client/redis/fcm/notification.rb
 - lib/rpush/client/redis/gcm/app.rb
 - lib/rpush/client/redis/gcm/notification.rb
 - lib/rpush/client/redis/notification.rb
@@ -517,9 +560,12 @@ files:
 - lib/rpush/daemon/dispatcher/tcp.rb
 - lib/rpush/daemon/dispatcher_loop.rb
 - lib/rpush/daemon/errors.rb
+- lib/rpush/daemon/fcm.rb
+- lib/rpush/daemon/fcm/delivery.rb
 - lib/rpush/daemon/feeder.rb
 - lib/rpush/daemon/gcm.rb
 - lib/rpush/daemon/gcm/delivery.rb
+- lib/rpush/daemon/google_credential_cache.rb
 - lib/rpush/daemon/interruptible_sleep.rb
 - lib/rpush/daemon/loggable.rb
 - lib/rpush/daemon/proc_title.rb
@@ -569,6 +615,8 @@ files:
 - spec/functional/apns_spec.rb
 - spec/functional/cli_spec.rb
 - spec/functional/embed_spec.rb
+- spec/functional/fcm_priority_spec.rb
+- spec/functional/fcm_spec.rb
 - spec/functional/gcm_priority_spec.rb
 - spec/functional/gcm_spec.rb
 - spec/functional/new_app_spec.rb
@@ -596,6 +644,8 @@ files:
 - 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/fcm/app_spec.rb
+- spec/unit/client/active_record/fcm/notification_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
@@ -618,6 +668,8 @@ files:
 - 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/fcm/app_spec.rb
+- spec/unit/client/redis/fcm/notification_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
@@ -635,6 +687,8 @@ files:
 - spec/unit/client/shared/apns/feedback.rb
 - spec/unit/client/shared/apns/notification.rb
 - spec/unit/client/shared/app.rb
+- spec/unit/client/shared/fcm/app.rb
+- spec/unit/client/shared/fcm/notification.rb
 - spec/unit/client/shared/gcm/app.rb
 - spec/unit/client/shared/gcm/notification.rb
 - spec/unit/client/shared/notification.rb
@@ -659,6 +713,7 @@ files:
 - spec/unit/daemon/dispatcher/http_spec.rb
 - spec/unit/daemon/dispatcher/tcp_spec.rb
 - spec/unit/daemon/dispatcher_loop_spec.rb
+- spec/unit/daemon/fcm/delivery_spec.rb
 - spec/unit/daemon/feeder_spec.rb
 - spec/unit/daemon/gcm/delivery_spec.rb
 - spec/unit/daemon/proc_title_spec.rb
@@ -706,14 +761,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: The push notification service for Ruby.
@@ -724,6 +779,8 @@ test_files:
 - spec/functional/apns_spec.rb
 - spec/functional/cli_spec.rb
 - spec/functional/embed_spec.rb
+- spec/functional/fcm_priority_spec.rb
+- spec/functional/fcm_spec.rb
 - spec/functional/gcm_priority_spec.rb
 - spec/functional/gcm_spec.rb
 - spec/functional/new_app_spec.rb
@@ -751,6 +808,8 @@ test_files:
 - 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/fcm/app_spec.rb
+- spec/unit/client/active_record/fcm/notification_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
@@ -773,6 +832,8 @@ test_files:
 - 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/fcm/app_spec.rb
+- spec/unit/client/redis/fcm/notification_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
@@ -790,6 +851,8 @@ test_files:
 - spec/unit/client/shared/apns/feedback.rb
 - spec/unit/client/shared/apns/notification.rb
 - spec/unit/client/shared/app.rb
+- spec/unit/client/shared/fcm/app.rb
+- spec/unit/client/shared/fcm/notification.rb
 - spec/unit/client/shared/gcm/app.rb
 - spec/unit/client/shared/gcm/notification.rb
 - spec/unit/client/shared/notification.rb
@@ -814,6 +877,7 @@ test_files:
 - spec/unit/daemon/dispatcher/http_spec.rb
 - spec/unit/daemon/dispatcher/tcp_spec.rb
 - spec/unit/daemon/dispatcher_loop_spec.rb
+- spec/unit/daemon/fcm/delivery_spec.rb
 - spec/unit/daemon/feeder_spec.rb
 - spec/unit/daemon/gcm/delivery_spec.rb
 - spec/unit/daemon/proc_title_spec.rb