Bump noticed from 1.6.3 to 2.3.2 #6889

dependabot · 2024-06-03T07:29:06Z

Bumps noticed from 1.6.3 to 2.3.2.

Release notes

v2.3.2

What's Changed

Add sqlserver support by @excid3 in excid3/noticed#451

Full Changelog: excid3/noticed@v2.3.1...v2.3.2

v2.3.1

Full Changelog: excid3/noticed@v2.3.0...v2.3.1

v2.3.0

What's Changed

Fix example command in READMe by @johnjoubert in excid3/noticed#435

Update README.md example typo by @hkdahal in excid3/noticed#436

Fix noticed:notifier generator in README by @marcoroth in excid3/noticed#438

Remove recipient argument by @lachances in excid3/noticed#441

Fix evaluate_option example by @javierav in excid3/noticed#447

Update fcm.md by @Moathal in excid3/noticed#449

Don't remove record from params with ephemeral notifications by @excid3 in excid3/noticed#448

Twilio delivery method allows Notifier to handle errors by @bibstha in excid3/noticed#444

New Contributors

@johnjoubert made their first contribution in excid3/noticed#435

@hkdahal made their first contribution in excid3/noticed#436

@marcoroth made their first contribution in excid3/noticed#438

@lachances made their first contribution in excid3/noticed#441

@javierav made their first contribution in excid3/noticed#447

@Moathal made their first contribution in excid3/noticed#449

@bibstha made their first contribution in excid3/noticed#444

Full Changelog: excid3/noticed@v2.2.2...v2.3.0

v2.2.2

Full Changelog: excid3/noticed@v2.2.1...v2.2.2

v2.2.1

What's Changed

Support procs and symbol method calls with fetch_constant helpers

Use 'attributes[:params]' instead of 'params' in the example about migrating associated records in UPGRADE.md by @drjole in excid3/noticed#427

New Contributors

@drjole made their first contribution in excid3/noticed#427

Full Changelog: excid3/noticed@v2.2.0...v2.2.1

v2.2.0

What's Changed

Example in generator should have the correct name by @emilkarl in excid3/noticed#398

Make the ApiClient use application/x-www-form-urlencoded as content type by @supherman in excid3/noticed#399

Honor PK settings by @rromanchuk in excid3/noticed#402

... (truncated)

Changelog

Sourced from noticed's changelog.

2.3.2

Set :json type on :params column with default to better integrate with ActiveRecord. This fixes sqlserver (and probably other databases). #451

2.3.1

Skip ApplicationNotifier in generator if it already exists

2.3.0

Add error_handler to Twilio delivery method #444

Fix record being removed for Ephemeral notifications #448

2.2.2

fetch_constant will now constantize Strings returned from procs or method calls

2.2.1

fetch_constant used by Email and ActionCable delivery methods now support procs and method calls with symbols like other options

2.2.0

Add config.before_enqueue callback This callback can be used to skip enqueuing delivery methods:
class CommentNotifier < Noticed::Event
  deliver_by :email do |config|
    config.before_enqueue = ->{ throw(:abort) unless recipient.email_notifications? }
  end
end
Fix iOS format option with Symbols. This now passes the notification and apn objects instead of just the apn.
config.format = :ios_format
...
def ios_format(notification, apn)
end
Re-add deserialize_error? to Noticed::Event

2.1.3

Stringify keys for Twilio Messaging json

... (truncated)

Upgrade guide

Sourced from noticed's upgrade guide.

Noticed Upgrade Guide

Follow this guide to upgrade your Noticed implementation to the next version

Noticed 2.1

We've added a counter cache to Noticed::Event to keep track of the associated notifications.

Run the following command to copy over the migrations:
rails noticed:install:migrations
Noticed 2.0

We've made some major changes to Noticed to simplify and support more delivery methods.

Models

Instead of having models live in your application, Noticed v2 adds models managed by the gem.

Delete the Notification model at app/models/notification.rb.

Then run the new migrations:
rails noticed:install:migrations
rails db:migrate
To migrate your data to the new tables, loop through your existing notifications and create new records for each one. You can do this in a Rake task or in the Rails console:
# Temporarily define the Notification model to access the old table
class Notification < ActiveRecord::Base
  self.inheritance_column = nil
end
Migrate each record to the new tables
Notification.find_each do |notification|
attributes = notification.attributes.slice("type", "created_at", "updated_at").with_indifferent_access
attributes[:type] = attributes[:type].sub("Notification", "Notifier")
attributes[:params] = Noticed::Coder.load(notification.params)
attributes[:params] = {} if attributes[:params].try(:has_key?, "noticed_error") # Skip invalid records
Extract related record to belongs_to :record association
This allows ActiveRecord associations instead of querying the JSON data
attributes[:record] = attributes[:params].delete(:user) || attributes[:params].delete(:account)
attributes[:notifications_attributes] = [{
type: "#{attributes[:type]}::Notification",
</tr></table>

... (truncated)

Commits

0430be6 Version bump
6dfb7d9 Add sqlserver support (#451)
f52e870 Version bump
bc93b64 Skip application notifier if it already exists
5a1fb91 Use matching sqlite3 versions for Rails versions
8e2dc61 Merge branch 'main' of github.com:excid3/noticed
68c406f Version bump
7cb10d1 Update twilio_messaging.md
2ef3c18 Twilio delivery method allows Notifier to handle errors (#444)
2a3dbb0 Don't remove record from params with ephemeral notifications (#448)
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependabot · 2024-06-11T15:08:27Z

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

Bumps [noticed](https://github.com/excid3/noticed) from 1.6.3 to 2.3.2. - [Release notes](https://github.com/excid3/noticed/releases) - [Changelog](https://github.com/excid3/noticed/blob/main/CHANGELOG.md) - [Upgrade guide](https://github.com/excid3/noticed/blob/main/UPGRADE.md) - [Commits](excid3/noticed@v1.6.3...v2.3.2) --- updated-dependencies: - dependency-name: noticed dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

…e in their upgrade docs

…rade guide

…del anymore so cannot use the previous syntax

…throughout

Due to the changes in the gem upgrade the time travel blocks do not work for out purpose in these tests. I believe this is because the noticed event is created inside the time travel block, but that creates noticed notifications in the background outside of the time travel block, so i have stubbed the created_at on the notifications to recreate these tests as best I can.

These specs only test the timestamp method, and are very flaky due to the way the upgrade to the noticed gem works. Now the event is created when the deliver method is run and in turn this created notifications in the background, making these tests are flaky. I think this in combination with how little value these tests add make removing them a sensible idea.

KyleMacPherson · 2024-06-19T09:33:07Z

app/controllers/publishers/notifications_controller.rb

@@ -12,11 +12,11 @@ def index

  def notifications
    @notifications ||= current_publisher.notifications
-                                        .created_within_data_access_period


This scope is on the old notifications model, which will be deleted. It is only referenced here.

KyleMacPherson · 2024-06-19T09:34:23Z

app/controllers/publishers/notifications_controller.rb

                                        .order(created_at: :desc)
  end

  def mark_notifications_as_read
-    notifications.mark_as_read!
+    notifications.mark_as_read


This change is because in the new version of noticed mark_as_read! has been renamed to mark_as_read

KyleMacPherson · 2024-06-19T09:35:43Z

app/jobs/send_job_application_data_expiry_notifier_job.rb

@@ -1,4 +1,4 @@
-class SendJobApplicationDataExpiryNotificationJob < ApplicationJob
+class SendJobApplicationDataExpiryNotifierJob < ApplicationJob


In noticed v2 notifiers are the class that delivers notifications Notification - the database record of the notification. They recommend changing the classes to match this.

KyleMacPherson · 2024-06-19T09:36:43Z

app/models/application_record.rb

@@ -3,8 +3,6 @@ class ApplicationRecord < ActiveRecord::Base

  before_save :strip_attributes

-  DATA_ACCESS_PERIOD_FOR_PUBLISHERS = 1.year.freeze


DATA_ACCESS_PERIOD_FOR_PUBLISHERS needs to be available in both controllers and models now so I have added it to a data_access_period initializer.

KyleMacPherson · 2024-06-19T09:36:47Z

config/initializers/data_access_period.rb

@@ -0,0 +1 @@
+DATA_ACCESS_PERIOD_FOR_PUBLISHERS = 1.year.freeze


DATA_ACCESS_PERIOD_FOR_PUBLISHERS needs to be available in both controllers and models now so I have added it to a data_access_period initializer.

KyleMacPherson · 2024-06-19T09:38:14Z

app/models/notification.rb

@@ -1,8 +1,7 @@
 class Notification < ApplicationRecord


This class needs to remain for now so that we can run the migration to migrate our previous notifications over to the new noticed_notifications table. I have had to leave some validations in this for now for our database consistency checks. Once the migration is complete we can delete the notifications table and this model.

KyleMacPherson · 2024-06-19T09:39:22Z

app/views/publishers/notifications/index.html.slim

@@ -15,7 +15,7 @@
            .govuk-body.float-right
              = pagy_stats(@pagy, type: "notification")

-        = render @notifications
+        = render partial: "notification", collection: @notifications, as: :notification


Due to notifications now being called noticed_notifications we need to explicitly set this collection partial.

KyleMacPherson · 2024-06-19T09:41:37Z

spec/support/matchers/have_delivered_notification.rb

+    event = Noticed::Event.find(notification.event_id)
+
+    expect(notification).to have_attributes(expected_notification_attributes)
+    expect(event).to have_attributes(expected_event_attributes)


We now have two models/tables rather than just one and they store different attributes

KyleMacPherson · 2024-06-19T12:53:22Z

app/notifiers/publishers/job_application_data_expiry_notifier.rb

+  delegate :created_at, to: :record
+  param :vacancy, :publisher
+
+  notification_methods do


As of v2 we need to wrap these methods in the notifications_method block to make them available on the notification, rather than the event of the same name

KyleMacPherson · 2024-06-19T12:53:28Z

app/notifiers/publishers/job_application_received_notifier.rb

+  delegate :created_at, to: :record
+  param :vacancy, :job_application
+
+  notification_methods do


As of v2 we need to wrap these methods in the notifications_method block to make them available on the notification, rather than the event of the same name

github-actions · 2024-06-19T13:00:21Z

Review app https://teaching-vacancies-review-pr-6889.test.teacherservices.cloud was successfully deleted

scruti

LGTM!
Thanks for the very helpful annotations to review the PR 👏

dependabot bot added dependencies ruby Pull requests that update Ruby code labels Jun 3, 2024

dependabot bot mentioned this pull request Jun 3, 2024

Bump noticed from 1.6.3 to 2.3.1 #6877

Closed

scruti added the do not merge label Jun 3, 2024

dependabot bot force-pushed the dependabot/bundler/noticed-2.3.2 branch from 505261d to 86d0619 Compare June 10, 2024 09:22

KyleMacPherson force-pushed the dependabot/bundler/noticed-2.3.2 branch from ee6b78d to 1a14633 Compare June 11, 2024 15:00

KyleMacPherson closed this Jun 11, 2024

KyleMacPherson reopened this Jun 11, 2024

KyleMacPherson force-pushed the dependabot/bundler/noticed-2.3.2 branch from 1a14633 to 86d0619 Compare June 11, 2024 15:08

dependabot bot and others added 11 commits June 17, 2024 11:33

Create new notificed tables necessary for upgrading noticed gem

86914b9

Change notification to notifier for notice classes as per the guidanc…

f5701fa

…e in their upgrade docs

Add rake task to migrate notifications

c0f1a13

More name changes

5cb5b57

Add new tables to analytics.yml

c0aa113

Change notifier classes to inherit from Noticed::Event as per the upg…

6afdfcd

…rade guide

Use new Noticed::Notifications instead of old notification table

ff1351a

Change deprecated method

4c808a7

Move notifier methods into the new notification_methods block

9625ee3

Fix test failing due to still using old notification model

8072293

KyleMacPherson force-pushed the dependabot/bundler/noticed-2.3.2 branch from 5a379c2 to 8072293 Compare June 17, 2024 10:33

KyleMacPherson added 3 commits June 17, 2024 14:28

Use explicit notification partial as we don't use the notification mo…

d17c78a

…del anymore so cannot use the previous syntax

Typo

4b017e0

Fix time travel issues

05930d5

KyleMacPherson force-pushed the dependabot/bundler/noticed-2.3.2 branch from 3f5cb6f to 05930d5 Compare June 17, 2024 13:29

KyleMacPherson added 4 commits June 17, 2024 15:17

Add DATA_ACCESS_PERIOD_FOR_PUBLISHERS to config to make it available …

b43e47e

…throughout

Fix failing tests

5fc3900

Fix more failing tests

63d7645

KyleMacPherson added 4 commits June 18, 2024 15:47

rubocop linting

020f857

Slim linting

5dab646

Re-add notification validation for database consistency linting

0f9c548

KyleMacPherson reviewed Jun 19, 2024

View reviewed changes

KyleMacPherson added 4 commits June 19, 2024 10:57

Re-instate message spec for job application data expiry notifications

aa816cd

Add missing new line at end of file

dddeb7f

Fix tests

0bccca2

Add final new line

47b3ba4

KyleMacPherson reviewed Jun 19, 2024

View reviewed changes

KyleMacPherson added the deploy label Jun 19, 2024

KyleMacPherson temporarily deployed to review June 19, 2024 12:57 — with GitHub Actions Inactive

scruti approved these changes Jun 19, 2024

View reviewed changes

KyleMacPherson merged commit 556dab6 into main Jun 20, 2024
17 checks passed

KyleMacPherson deleted the dependabot/bundler/noticed-2.3.2 branch June 20, 2024 10:42

KyleMacPherson temporarily deployed to review June 20, 2024 10:43 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump noticed from 1.6.3 to 2.3.2 #6889

Bump noticed from 1.6.3 to 2.3.2 #6889

dependabot bot commented on behalf of github Jun 3, 2024 •

edited

Loading

dependabot bot commented on behalf of github Jun 11, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

KyleMacPherson Jun 19, 2024

github-actions bot commented Jun 19, 2024 •

edited

Loading

scruti left a comment

		@@ -1,4 +1,4 @@
		class SendJobApplicationDataExpiryNotificationJob < ApplicationJob
		class SendJobApplicationDataExpiryNotifierJob < ApplicationJob

		@@ -3,8 +3,6 @@ class ApplicationRecord < ActiveRecord::Base

		before_save :strip_attributes

		DATA_ACCESS_PERIOD_FOR_PUBLISHERS = 1.year.freeze

		@@ -0,0 +1 @@
		DATA_ACCESS_PERIOD_FOR_PUBLISHERS = 1.year.freeze

Bump noticed from 1.6.3 to 2.3.2 #6889

Bump noticed from 1.6.3 to 2.3.2 #6889

Conversation

dependabot bot commented on behalf of github Jun 3, 2024 • edited Loading

v2.3.2

What's Changed

v2.3.1

v2.3.0

What's Changed

New Contributors

v2.2.2

v2.2.1

What's Changed

New Contributors

v2.2.0

What's Changed

2.3.2

2.3.1

2.3.0

2.2.2

2.2.1

2.2.0

2.1.3

Noticed Upgrade Guide

Noticed 2.1

Noticed 2.0

Models

dependabot bot commented on behalf of github Jun 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 19, 2024 • edited Loading

scruti left a comment

Choose a reason for hiding this comment

dependabot bot commented on behalf of github Jun 3, 2024 •

edited

Loading

github-actions bot commented Jun 19, 2024 •

edited

Loading