Drop Rails 5.2 support.

SixiS · SixiS · commit b84c795be9f5 · 2024-07-25T21:26:44.000+02:00
Move to web-push gem to fix OpenSSL 3.0 error. zaru/webpush#106 Fix various failing tests.
diff --git a/Appraisals b/Appraisals
@@ -7,14 +7,6 @@
 # > the version from the appraisal takes precedence.
 # > https://github.com/thoughtbot/appraisal
 
-appraise "rails-5.2" do
-  gem "activesupport", "~> 5.2.0"
-
-  group :development do
-    gem "rails", "~> 5.2.0"
-  end
-end
-
 appraise "rails-6.0" do
   gem "activesupport", "~> 6.0.0"
   # https://gist.github.com/yahonda/2776d8d7b6ea7045359f38c10449937b#rails-60z
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -11,7 +11,7 @@ PATH
       railties
       rainbow
       thor (>= 0.18.1, < 2.0)
-      webpush (~> 1.0)
+      web-push
 
 GEM
   remote: https://rubygems.org/
@@ -46,6 +46,7 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
+    base64 (0.2.0)
     builder (3.2.4)
     byebug (11.1.3)
     codeclimate-test-reporter (1.0.7)
@@ -59,7 +60,10 @@ GEM
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
-    diff-lcs (1.5.0)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     erubi (1.12.0)
     faraday (2.9.0)
@@ -75,11 +79,15 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
-    hkdf (0.3.0)
     http-2 (0.11.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.7.1)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jwt (2.8.2)
+      base64
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -94,7 +102,7 @@ GEM
       redis (>= 3.0)
     msgpack (1.4.5)
     multi_json (1.15.0)
-    mysql2 (0.5.3)
+    mysql2 (0.5.6)
     net-http (0.4.1)
       uri
     net-http-persistent (4.0.2)
@@ -104,11 +112,14 @@ GEM
     nokogiri (1.16.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    openssl (3.2.0)
     os (1.1.4)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
     pg (1.2.3)
+    psych (5.1.2)
+      stringio
     public_suffix (5.0.4)
     racc (1.7.3)
     rack (2.2.8)
@@ -130,24 +141,28 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
     redis (4.6.0)
     regexp_parser (2.2.0)
+    reline (0.5.9)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rpush-redis (1.2.0)
       modis (>= 3.0, < 5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -168,23 +183,25 @@ GEM
       faraday (>= 0.17.5, < 3.a)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    sqlite3 (1.4.2)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (2.0.2)
+      mini_portile2 (~> 2.8.0)
     stackprof (0.2.17)
+    stringio (3.1.1)
     thor (1.2.1)
     timecop (0.9.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     uri (0.13.0)
-    webpush (1.1.0)
-      hkdf (~> 0.2)
+    web-push (3.0.1)
       jwt (~> 2.0)
+      openssl (~> 3.0)
     zeitwerk (2.6.12)
 
 PLATFORMS
@@ -195,13 +212,14 @@ DEPENDENCIES
   byebug
   codeclimate-test-reporter
   database_cleaner
+  debug
   modis (>= 2.0)
   mysql2
   pg
   rake
   rpush!
   rpush-redis (~> 1.0)
-  rspec (~> 3.4.0)
+  rspec
   rubocop (~> 1.12.0)
   rubocop-performance
   simplecov
diff --git a/README.md b/README.md
@@ -504,7 +504,7 @@ This will run RSpec against all versions of Rails.
 You need to specify a `BUNDLE_GEMFILE` pointing to the gemfile before running the normal test command:
 
 ```
-BUNDLE_GEMFILE=gemfiles/rails_5.2.gemfile rspec spec/unit/apns_feedback_spec.rb
+BUNDLE_GEMFILE=gemfiles/rails_6.0.gemfile rspec spec/unit/apns_feedback_spec.rb
 ```
 
 ##### Multiple database adapter support
diff --git a/gemfiles/rails_5.2.gemfile b/gemfiles/rails_5.2.gemfile
diff --git a/lib/rpush/client/active_model/fcm/notification.rb b/lib/rpush/client/active_model/fcm/notification.rb
@@ -84,7 +84,8 @@ def apns_config
           end
 
           def notification=(value)
-            super(value.with_indifferent_access)
+            value = value.with_indifferent_access if value.is_a?(Hash)
+            super(value)
           end
 
           def root_notification
diff --git a/lib/rpush/daemon/webpush/delivery.rb b/lib/rpush/daemon/webpush/delivery.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "webpush"
+require "web-push"
 
 module Rpush
   module Daemon
@@ -10,7 +10,7 @@ module Webpush
       # We just override #perform to inject the http instance that is managed
       # by Rpush.
       #
-      class Request < ::Webpush::Request
+      class Request < ::WebPush::Request
         def perform(http)
           req = Net::HTTP::Post.new(uri.request_uri, headers)
           req.body = body
diff --git a/rpush.gemspec b/rpush.gemspec
@@ -40,11 +40,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'thor', ['>= 0.18.1', '< 2.0']
   s.add_runtime_dependency 'railties'
   s.add_runtime_dependency 'rainbow'
-  s.add_runtime_dependency 'webpush', '~> 1.0'
+  s.add_runtime_dependency 'web-push'
   s.add_runtime_dependency 'googleauth'
 
+  s.add_development_dependency 'debug'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 3.4.0'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'database_cleaner'
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'stackprof'
diff --git a/spec/functional/fcm_priority_spec.rb b/spec/functional/fcm_priority_spec.rb
@@ -17,6 +17,7 @@
     notification.app_id = app.id
     notification.device_token = fake_device_token
     notification.data = { message: 'test' }
+    notification.notification = { title: 'title' }
     notification.priority = priority
     notification.save!
 
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -13,6 +13,7 @@ def client
   end
 end
 
+require 'debug'
 require 'timecop'
 require 'activerecord-jdbc-adapter' if defined? JRUBY_VERSION
 
@@ -46,7 +47,7 @@ def redis?
 TEST_CERT = File.read(File.join(path, 'cert_without_password.pem'))
 TEST_CERT_WITH_PASSWORD = File.read(File.join(path, 'cert_with_password.pem'))
 
-VAPID_KEYPAIR = Webpush.generate_key.to_hash.merge(subject: 'rpush-test@example.org').to_json
+VAPID_KEYPAIR = WebPush.generate_key.to_hash.merge(subject: 'rpush-test@example.org').to_json
 
 def after_example_cleanup
   Rpush.logger = nil
diff --git a/spec/unit/client/shared/fcm/notification.rb b/spec/unit/client/shared/fcm/notification.rb
@@ -49,21 +49,19 @@
 
   it 'includes content_available in the payload' do
     notification.content_available = true
-    expect(notification.as_json['message']['content_available']).to eq true
-  end
-
-  it 'fails if mutable_content is provided' do
-    expect { notification.mutable_content = true }.to raise_error(ArgumentError)
+    expect(notification.as_json["message"]["apns"]["payload"]["aps"]["content-available"]).to eq 1
   end
 
   it 'sets the priority to high when set to high' do
+    notification.notification = { title: "Title" }
     notification.priority = 'high'
     expect(notification.as_json['message']['android']['priority']).to eq 'high'
     expect(notification.as_json['message']['android']['notification']['notification_priority']).to eq 'PRIORITY_MAX'
     # TODO Add notification_priority
   end
 
   it 'sets the priority to normal when set to normal' do
+    notification.notification = { title: "Title" }
     notification.priority = 'normal'
     expect(notification.as_json['message']['android']['priority']).to eq 'normal'
     expect(notification.as_json['message']['android']['notification']['notification_priority']).to eq 'PRIORITY_DEFAULT'
diff --git a/spec/unit/daemon/service_config_methods_spec.rb b/spec/unit/daemon/service_config_methods_spec.rb
@@ -23,7 +23,7 @@ class Delivery; end
     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
 
diff --git a/spec/unit/daemon/tcp_connection_spec.rb b/spec/unit/daemon/tcp_connection_spec.rb
@@ -15,6 +15,7 @@
   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 '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
diff --git a/spec/unit/daemon/wns/delivery_spec.rb b/spec/unit/daemon/wns/delivery_spec.rb
@@ -50,7 +50,7 @@ def perform_with_rescue
     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
