CHANGELOG.md

Changelog

v7.0.1 (2022-03-02)

Full Changelog

Merged pull requests:

• Fix deprecation warnings from the redis gem #636 (sharang-d)

Unreleased

Full Changelog

v7.0.0

Full Changelog

Merged pull requests:

• Test with Ruby 3.1 #632 (aried3r)
• Resolves Rails 7 Time.now.to_s deprecation warning #630 (gregblake)
• Adds Rails 7 Support #629 (gregblake)
• Test with Rails 7.0.0.alpha2 #626 (aried3r)

Breaking:

• Drop support for Ruby 2.3 #631 (aried3r)

v6.0.1 (2021-10-08)

Full Changelog

Merged pull requests:

• Don't limit webpush registration keys #624 (treyrich)
• Add Prometheus Exporter plugin link to README #617 (maxsz)
• Reference current interface in config template #569 (benlangfeld)
• Default the Rails environment to RAILS_ENV if set #562 (benlangfeld)

v6.0.0 (2021-05-21)

Full Changelog

This release contains breaking changes, such as removing support for Rails versions older than 5.2. Please see the details in the PRs below.

Merged pull requests:

• Switch to GitHub Actions for CI #615 (aried3r)
• Prepare 6.0.0 release #613 (aried3r)
• Bump activesupport version to 5.2 or later #610 (biow0lf)
• Fixed infinite loop issue with Apnsp8 delivery #608 (diminish7)
• Eliminate deprecation warning in Ruby 3.0 #602 (rofreg)
• Make ActiveRecord validations work with Apns2 client #601 (favrik)
• Bump gemspec post_install_message #600 (fdoxyz)
• Remove references and checks for unsupported versions of Rails #599 (ericsaupe)
• Drop support for Rails 5.0 and 5.1 #597 (ericsaupe)
• Fix silent APNS notifications for Apns2 and Apnsp8 #596 (shved270189)
• Updates README to Apple's new EOL date for the APNs legacy binary protocol #595 (gregblake)

v5.4.0 (2021-02-15)

Full Changelog

Merged pull requests:

• fix typo in README.md #587 (yltsrc)
• Support Ruby 3.0 & Rails 6.1 #586 (andreaslillebo)

v5.3.0 (2021-01-07)

Full Changelog

Implemented enhancements:

• support for Webpush with VAPID #574 (jkraemer)

Merged pull requests:

• Bug fix: APNS P8 Notifications Are Marked as Invalid When the Payload Exceeds 2kb (2048 bytes) #583 (gregblake)
• Fix more Rails 6.1 deprecation warnings #582 (jas14)
• Feature/apns2 default headers #579 (jkraemer)
• Fix APNS2 documentation in README #578 (jamestjw)
• Fixed typo with misspell #575 (hsbt)

v5.2.0 (2020-10-08)

Full Changelog

Merged pull requests:

• Allow opting out of foreground stdout logging #571 (benlangfeld)
• Do not retry notifications which already have been delivered/failed #567 (AlexTatarnikov)
• Improve APNs documentation. #553 (timdiggins)

v5.1.0 (2020-09-25)

Full Changelog

Merged pull requests:

• Resume APNS2 delivery when async requests timeout #564 (benlangfeld)
• Improve DB reconnection for big tables #563 (AlexTatarnikov)
• Default the Rails environment to RAILS_ENV if set #562 (benlangfeld)
• Allow Apns2 payloads to be up to 4096 bytes #561 (benlangfeld)
• Improve test coverage #528 (jhottenstein)

v5.0.0 (2020-02-21)

Full Changelog

Merged pull requests:

• Test with Ruby 2.7 #550 (aried3r)
• Fix GCM priority when using Redis #549 (daniel-nelson)
• Drop support for Rails 4.2 #547 (aried3r)

4.2.0 (2019-12-13)

Full Changelog

Merged pull requests:

• Fix Rails 6.1 related deprecation warnings #541 (dsantosmerino)
• GCM notification incorrectly mixes data into notification hashes #535 (mkon)
• handle priority in WNS #533 (Fivell)
• Update development apns urls to match documentation #524 (jhottenstein)
• Update README to remove incorrect info #523 (sharang-d)
• Fix and improve Travis setup #520 (aried3r)
• Explicitly use Rails 6.0.0 #519 (jsantos)
• Stale bot config change #515 (aried3r)
• Add stale bot configuration. #514 (drn)
• Correctly use feedback_enabled. #511 (kirbycool)
• Update apns_http2.rb #510 (mldoscar)
• Add mutable_content support for GCM #506 (hon3st)
• Add support for critical alerts #502 (servn)

4.1.1 (2019-05-13)

Added

• Allow disabling of APNS feedback for specific Rpush apps #491 (by @drn).

Changed

• Switch from ANSI to Rainbow. (#496 by @drn)

4.1.0 (2019-04-17)

Added

• Functionality to use dry_run in FCM notifications. This is useful if you want to just validate notification sending works without actually sending a notification to the receivers, fixes #63. (#492 by @aried3r)

4.0.1 (2019-04-04)

Fixed

• Fail gracefully when a Modis notification no longer exists #486 (by @rofreg).

4.0.0 (2019-02-14)

Changed

• Stop logging all APNSp8 requests as warnings. #474 (by @jhottenstein and @rofreg)

Removed

• Support for Ruby 2.2

Fixed

• Fixed APNSp8 memory leak #475 (by @jhottenstein)
• Fixed APNS2 memory leak. #476 (by @jhottenstein)

3.3.1 (2018-11-14)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Fixed

• Remove validation of 64-characters length from device_token. #463 (by @chrisokamoto).

3.3.0 (2018-11-14)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Added

• Added support for Apple Push Notification service thread-id field #460 (by @gerard-morera).

Changes

• Remove unused class ConfigurationWithoutDefaults #461 (by @adis-io).

3.2.4 (2018-10-25)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Changes

• Relaxed JWT dependency version #447 (by @sposin).

Docs

• Better documentation for running tests when developing Rpush #458 (by @jsantos).

Fixed

• Change apn_key column type from string to text #455 (by sonxurxo).
• Retry all GCM 5xx errors #456 (by @rofreg).

3.2.3 (2018-07-12)

Changes

• Update jwt dependency from 1.x to 2.x #444 (by @jsantos).

3.2.2 (2018-07-10)

Fixed

• Migrations now work with Rails 5.2 and ActiveRecord. Redis support for Rails 5.2 is not yet working if you're using Modis, see this issue.

3.2.1 (2018-07-10)

Fixed

• A memory leak in the Rpush daemon which caused it to consume more and more memory was fixed. #441 (by @armahmoudi)

3.2.0 (2018-06-13)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Breaking Changes

• None

Added

• Added support for P8 certificate Apple push notifications #386 (by @mariannegru)

3.1.1 (2018-04-16)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Breaking Changes

• None

Added

• None

Fixed

• Database deadlock #200 (by @loadhigh in #428)

Enhancements

• Change the index on rpush_notifications to minimize number of locked records and pre-sort the records (#428 by @loadhigh)
• Minimize the locking duration by moving the row dump code outside of the transaction (#428 by @loadhigh)

3.1.0 (2018-04-11)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Breaking Changes

• None

Added

• Added sandbox URL to ApnsHttp2 dispatcher (#392 by @brianlittmann)

Features

• Added support for Pushy (#404 by @zabolotnov87)

Fixed

• @notification.app triggers loading of association :app (#410 by @loadhigh)
• APNS expiry should be number of seconds since epoch (#416 by @loadhigh)

Enhancements

• Test rpush with Ruby 2.5 on Travis CI (#407 by @Atul9)

3.0.2 (2018-01-08)

Fixes

• Fixes migrations added in 3.0.1 (#396 by @grosser)
• Actually run these migrations in the test suite (#399 by @aried3r)

3.0.1 (2017-11-30)

Enhancements

• Reduce booleans to true/false, do not allow nil (#384) by @grosser
• Better error message for error 8 in APNS (#387) by @grosser

3.0.0 (2017-09-15)

Same as 3.0.0.rc1 including:

Features

• Added support for latest modis version (#378) by @milgner

3.0.0.rc1 (2017-08-31)

When upgrading, don't forget to run bundle exec rpush init to get all the latest migrations.

Features

• Added support for APNS mutable-content (#296 by @tdtran)
• Added support for HTTP2 base APNS Api (#315 by @soulfly and @Nattfodd)

Changes

• Breaking: Dropped support for old Rubies and Rails versions. rpush 3.0 only supports Ruby versions 2.2.2 or higher and Rails 4.2 or higher. (#366 by @aried3r)

• Breaking: Dropped MongoDB support because there was no one maintaining it. But we're open to adding it back in. (#366 by @aried3r)

• Breaking: Dropped JRuby support. (#366 by @aried3r)

• Make synchronizer aware of GCM and WNS apps (#254 by @wouterh)

• Precise after init commit msg (#266 by @azranel)

• Use new GCM endpoint (#303 by @aried3r)

• Remove sound default value (#320 by @amaierhofer)

Bugfixes

• Fix net-http-persistent initializer to support version 2.x as well as 3.x. (#309 by @amirmujkic)
• Fixed Rpush::ApnsFeedback being run on every application type when using Redis. (#318 by @robertasg)

2.7.0 (February 9, 2016)

Features

• Added support for GCM priorities. (#243 by @aried3r)
• Added support for GCM notification payload (#246 by @aried3r)
• Added support for Windows Raw Notifications (in JSON form) (#238 by @mseppae)
• Added WNS badge notifications (#247 by @wouterh)
• Added the launch argument of WNS toast notifications (#247 by @wouterh)
• Added sound in WNS toast notifications (#247 by @wouterh)

Changes

• Change alert type from string to text in ActiveRecord to allow bigger alert dictionaries. (#248 by @schmidt)

Fixes

• Fixed issue where setting the mdm parameter broke to_binary for MDM APNs (#234 by @troya2)
• Fixed as_json (#231 by @aried3r)

2.6.0 (January 25, 2016)

Features

• Added support for GCM for iOS' content_available. (#221)

Fixes

• Fix typo in Oracle support. (#185)
• Remove param tag from WNS message. (#190)
• Fixed WNS response headers parser. (#192)
• GCM: fixed raise of unhandled errors. (#193)
• Fix issue with custom PID file set in Rpush.config. (#224, #225)

2.5.0 (July 19, 2015)

Features:

• Add 'rpush status' to inspect running Rpush internal status.
• ActiveRecord logging is no longer redirected to rpush.log when embedded (#138).
• Support for WNS (Windows RT) (#137).
• Indexes added to some Mongoid fields (#151).
• Added support for Oracle.

Bug fixes:

• Fix for handling APNs error when using rpush push or Rpush.push.
• Fix backwards compatibility issue with ActiveRecord (#144).

2.4.0 (Feb 18, 2015)

Features:

• Support for MongoDB (using Mongoid).
• config.feedback_poll is now deprecated, use config.apns.feedback_receiver.frequency instead.
• Add config.apns.feedback_receiver.enabled to optionally enable the APNs feedback receiver (#129).
• Passing configuration options directly to Rpush.embed and Rpush.push is now deprecated.

Bug fixes:

• Fix setting the log level when using Rails 4+ or without Rails (#124).
• Fix the possibility for excessive error logging when using APNs (#128).
• Re-use timestamp when replacing a migration with the same name (#91).
• Ensure App/Notification type is updated during 2.0 upgrade migration (#102).

2.3.2 (Jan 30, 2015)

Bug fixes:

• Internal sleep mechanism would sometimes no wait for the full duration specified.
• Rpush.push nows delivers all pending notifications before returning.
• Require thor >= 0.18.1 (#121).

2.3.1 (Jan 24, 2015)

• Fix CPU thrashing while waiting for an APNs connection be established (#119).

2.3.0 (Jan 19, 2015)

• Add 'version' CLI command.
• Rpush::Wpns::Notification now supports setting the 'data' attribute.
• ActiveRecord is now directed to the configured Rpush logger (#104).
• Logs are reopened when the HUP signal is received (#95).
• Fix setting config.redis_options (#114).
• Increase frequency of TCP keepalive probes on Linux.
• APNs notifications are no longer marked as failed when a dropped connection is detected, as it's impossible to know exactly how many actually failed (if any).
• Notifications are now retried instead of being marked as failed if a TCP/HTTP connection cannot be established.

2.2.0 (Oct 7, 2014)

• Numerous command-line fixes, sorry folks!
• Add 'rpush push' command-line command for one-off use.

2.1.0 (Oct 4, 2014)

• Bump APNs max payload size to 2048 for iOS 8.
• Add 'category' for iOS 8.
• Add url_args for Safari Push Notification Support (#77).
• Improved command-line interface.
• Rails integration is now optional.
• Added log_level config option.
• log_dir is now deprecated and has no effect, use log_file instead.

2.0.1 (Sept 13, 2014)

• Add ssl_certificate_revoked reflection (#68).
• Fix for Postgis support in 2.0.0 migration (#70).

2.0.0 (Sept 6, 2014)

• Use APNs enhanced binary format version 2.
• Support running multiple Rpush processes when using ActiveRecord and Redis.
• APNs error detection is now performed asynchronously, 'check_for_errors' is therefore deprecated.
• Deprecated attributes_for_device accessors. Use data instead.
• Fix signal handling to work with Ruby 2.x. (#40).
• You no longer need to signal HUP after creating a new app, they will be loaded automatically for you.
• APNs notifications are now delivered in batches, greatly improving throughput.
• Signaling HUP now also causes Rpush to immediately check for new notifications.
• The 'wakeup' config option has been removed.
• The 'batch_storage_updates' config option has been deprecated, storage backends will now always batch updates where appropriate.
• The rpush process title updates with number of queued notifications and number of dispatchers.
• Rpush::Apns::Feedback#app has been renamed to app_id and is now an Integer.
• An app is restarted when the HUP signal is received if its certificate or environment attribute changed.

1.0.0 (Feb 9, 2014)

• Renamed to Rpush (from Rapns). Version number reset to 1.0.0.
• Reduce default batch size to 100.
• Fix sqlite3 support (#160).
• Drop support for Ruby 1.8.
• Improve APNs certificate validation errors (#192) @mattconnolly).
• Support for Windows Phone notifications (#191) (@matiaslina).
• Support for Amazon device messaging (#173) (@darrylyip).
• Add two new GCM reflections: gcm_delivered_to_recipient, gcm_failed_to_recipient (#184) (@jakeonfire).
• Fix migration issues (#181) (@jcoleman).
• Add GCM gcm_invalid_registration_id reflection (#171) (@marcrohloff).
• Feature: wakeup feeder via UDP socket (#164) (@mattconnolly).
• Fix reflections when using batches (#161).
• Only perform APNs certificate validation for APNs apps (#133).
• The deprecated on_apns_feedback has now been removed.
• The deprecated airbrake_notify config option has been removed.
• Removed the deprecated ability to set attributes_for_device using mass-assignment.
• Fixed issue where database connections may not be released from the connection pool.

3.4.1 (Aug 30, 2013)

• Silence unintended airbrake_notify deprecation warning (#158).
• Add :dependent => :destroy to app notifications (#156).

3.4.0 (Aug 28, 2013)

• Rails 4 support.
• Add apns_certificate_will_expire reflection.
• Perform storage update in batches where possible, to increase throughput.
• airbrake_notify is now deprecated, use the Reflection API instead.
• Fix calling the notification_delivered reflection twice (#149).

3.3.2 (June 30, 2013)

• Fix Rails 3.0.x compatibility (#138) (@yoppi).
• Ensure Rails does not set a default value for text columns (#137).
• Fix error in down action for add_gcm migration (#135) (@alexperto).

3.3.1 (June 2, 2013)

• Fix compatibility with postgres_ext (#104).
• Add ability to switch the logger (@maxsz).
• Do not validate presence of alert, badge or sound - not actually required by the APNs (#129) (@wilg).
• Catch IOError from an APNs connection. (@maxsz).
• Allow nested hashes in APNs notification attributes (@perezda).

3.3.0 (April 21, 2013)

• GCM: collapse_key is no longer required to set expiry (time_to_live).
• Add reflection for GCM canonical IDs.
• Add Rpush::Daemon.store to decouple storage backend.

3.2.0 (Apr 1, 2013)

• Rpush.apns_feedback for one time feedback retrieval. Rpush.push no longer checks for feedback (#117, #105).
• Lazily connect to the APNs only when a notification is to be delivered (#111).
• Ensure all notifications are sent when using Rpush.push (#107).
• Fix issue with running Rpush.push more than once in the same process (#106).

3.1.0 (Jan 26, 2013)

• Rpush.reflect API for fine-grained introspection.
• Rpush.embed API for embedding Rpush into an existing process.
• Rpush.push API for using Rpush in scheduled jobs.
• Fix issue with integration with ActiveScaffold (#98) (@jeffarena).
• Fix content-available setter for APNs (#95) (@dup2).
• GCM validation fixes (#96) (@DianthuDia).

3.0.1 (Dec 16, 2012)

• Fix compatibility with Rails 3.0.x. Fixes #89.

3.0.0 (Dec 15, 2012)

• Add support for Google Cloud Messaging.
• Fix Heroku logging issue.

2.0.5 (Nov 4, 2012)

• Support content-available (#68).
• Append to log files.
• Fire a callback when Feedback is received.

2.0.5.rc1 (Oct 5, 2012)

• Release db connections back into the pool after use (#72).
• Continue to start daemon if a connection cannot be made during startup (#62) (@mattconnolly).

2.0.4 (Aug 6, 2012)

• Don't exit when there aren't any Rpush::App instances, just warn (#55).

2.0.3 (July 26, 2012)

• JRuby support.
• Explicitly list all attributes instead of calling column_names (#53).

2.0.2 (July 25, 2012)

• Support MultiJson < 1.3.0.
• Make all model attributes accessible.

2.0.1 (July 7, 2012)

• Fix delivery when using Ruby 1.8.
• MultiJson support.

2.0.0 (June 19, 2012)

• Support for multiple apps.
• Hot Updates - add/remove apps without restart.
• MDM support.
• Removed rpush.yml in favour of command line options.
• Started the changelog!

* This Changelog was automatically generated by github_changelog_generator