Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add error logging for SendNotificationEmailJob #21028

Merged
merged 8 commits into from
Mar 5, 2025
Merged

Add error logging for SendNotificationEmailJob #21028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
51a49d7
Add error logging for SendNotificationEmailJob
Thrillberg Feb 28, 2025
8d1b72c
Merge branch 'master' into logging-for-benefits-intake-status-job
Thrillberg Feb 28, 2025
811122b
Merge branch 'master' into logging-for-benefits-intake-status-job
Thrillberg Feb 28, 2025
1ada9bb
don't raise
Thrillberg Mar 4, 2025
d943951
tests
Thrillberg Mar 4, 2025
e00b144
test
Thrillberg Mar 4, 2025
cb14d95
Merge branch 'master' into logging-for-benefits-intake-status-job
Thrillberg Mar 5, 2025
b8309fb
Merge branch 'master' into logging-for-benefits-intake-status-job
rjohnson2011 Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions app/sidekiq/simple_forms_api/notification/send_notification_email_job.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ def perform(notification_type:, form_submission_attempt:, form_number:, user_acc
notification_email
end
rescue => e
StatsD.increment('silent_failure', tags: statsd_tags) if notification_type == :error
raise e
handle_exception(e)
end

private
Expand Down Expand Up @@ -60,6 +59,16 @@ def time_to_send
def statsd_tags
{ 'service' => 'veteran-facing-forms', 'function' => "#{form_number} form submission to Lighthouse" }
end

def handle_exception(e)
Rails.logger.error(
'Error sending simple forms notification email',
message: e.message,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to confirm there's no possibility for PII / sensitive information being leaked in this log.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope this should be good for PII. The error message would not include PII unless it somehow accesses the form data from inside the form submission on its own.

notification_type:,
confirmation_number: config[:confirmation_number]
)
StatsD.increment('silent_failure', tags: statsd_tags) if notification_type == :error
end
end
end
end
35 changes: 16 additions & 19 deletions spec/sidekiq/simple_forms_api/notification/send_notification_email_job_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,17 @@
end

context 'SimpleFormsApi::NotificationEmail initialization fails' do
it 'raises an error and increments statsd' do
allow(SimpleFormsApi::NotificationEmail).to receive(:new).and_raise(ArgumentError)
it 'increments statsd' do
allow(SimpleFormsApi::NotificationEmail).to receive(:new)
allow(StatsD).to receive(:increment)

expect do
described_class.new.perform(
notification_type: :error,
form_submission_attempt:,
form_number:,
user_account:
)
end.to raise_error(ArgumentError)
described_class.new.perform(
notification_type: :error,
form_submission_attempt:,
form_number:,
user_account:
)

expect(StatsD).to have_received(:increment).with('silent_failure', tags: anything)
end
end
Expand All @@ -63,18 +62,16 @@
end

context 'SimpleFormsApi::FormUploadNotificationEmail initialization fails' do
it 'raises an error and increments statsd' do
it 'increments statsd' do
allow(SimpleFormsApi::FormUploadNotificationEmail).to receive(:new).and_raise(ArgumentError)
allow(StatsD).to receive(:increment)

expect do
described_class.new.perform(
notification_type: :error,
form_submission_attempt:,
form_number:,
user_account:
)
end.to raise_error(ArgumentError)
described_class.new.perform(
notification_type: :error,
form_submission_attempt:,
form_number:,
user_account:
)
expect(StatsD).to have_received(:increment).with('silent_failure', tags: anything)
end
end
Expand Down
Loading