Skip to content

LG-10126: Standardize event messages #8890

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

Merged
tomas-nava merged 3 commits into from
Jul 28, 2023
Merged

LG-10126: Standardize event messages #8890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d91980c
standardize event messages
Jul 27, 2023
201d76f
use have_logged_event instead of receive in tests
Jul 27, 2023
75f4fcb
lint
Jul 27, 2023
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
10 changes: 5 additions & 5 deletions app/services/analytics_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1478,7 +1478,7 @@ def idv_in_person_send_proofing_notification_attempted(
**extra
)
track_event(
'IdV: in person notification SMS send attempted',
'SendProofingNotificationJob: in person notification SMS send attempted',
success: success,
enrollment_code: enrollment_code,
enrollment_id: enrollment_id,
Expand All @@ -1497,7 +1497,7 @@ def idv_in_person_send_proofing_notification_job_completed(
**extra
)
track_event(
'SendProofingNotificationAndDeletePhoneNumberJob: job completed',
'SendProofingNotificationJob: job completed',
enrollment_code: enrollment_code,
enrollment_id: enrollment_id,
**extra,
Expand All @@ -1518,7 +1518,7 @@ def idv_in_person_send_proofing_notification_job_exception(
**extra
)
track_event(
'SendProofingNotificationJob: Exception raised',
'SendProofingNotificationJob: exception raised',
enrollment_code: enrollment_code,
enrollment_id: enrollment_id,
exception_class: exception_class,
Expand All @@ -1537,7 +1537,7 @@ def idv_in_person_send_proofing_notification_job_skipped(
**extra
)
track_event(
'SendProofingNotificationAndDeletePhoneNumberJob: job skipped',
'SendProofingNotificationJob: job skipped',
enrollment_code: enrollment_code,
enrollment_id: enrollment_id,
**extra,
Expand All @@ -1554,7 +1554,7 @@ def idv_in_person_send_proofing_notification_job_started(
**extra
)
track_event(
'SendProofingNotificationAndDeletePhoneNumberJob: job started',
'SendProofingNotificationJob: job started',
enrollment_code: enrollment_code,
enrollment_id: enrollment_id,
**extra,
Expand Down
83 changes: 28 additions & 55 deletions spec/jobs/in_person/send_proofing_notification_job_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,30 +54,23 @@
let(:in_person_proofing_enabled) { false }
let(:in_person_send_proofing_notifications_enabled) { true }
it 'returns without doing anything' do
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_completed,
)
expect(job).not_to receive(:poll)
expect(job).not_to receive(:process_batch)
job.perform(passed_enrollment.id)

expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job completed')
end
end
context 'job disabled' do
let(:in_person_proofing_enabled) { true }
let(:in_person_send_proofing_notifications_enabled) { false }
it 'returns without doing anything' do
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_completed,
)
expect(job).not_to receive(:poll)
expect(job).not_to receive(:process_batch)
job.perform(passed_enrollment.id)
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job completed')
end
end
context 'ipp and job enabled' do
Expand All @@ -86,35 +79,23 @@
context 'enrollment does not exist' do
it 'returns without doing anything' do
bad_id = (InPersonEnrollment.all.pluck(:id).max || 0) + 1
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_skipped,
)
job.perform(bad_id)
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).to have_logged_event('SendProofingNotificationJob: job skipped')
end
end
context 'enrollment has an unsupported status' do
it 'returns without doing anything' do
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_skipped,
)
job.perform(expired_enrollment.id)
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).to have_logged_event('SendProofingNotificationJob: job skipped')
end
end
context 'without notification phone notification' do
it 'returns without doing anything' do
expect(analytics).not_to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_skipped,
)
job.perform(passed_enrollment_without_notification.id)
expect(analytics).not_to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).to have_logged_event('SendProofingNotificationJob: job skipped')
end
end
context 'with notification phone configuration' do
Expand All @@ -123,18 +104,14 @@

freeze_time do
now = Time.zone.now
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_completed,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_attempted,
)
expect(passed_enrollment.reload.notification_sent_at).to be_nil

job.perform(passed_enrollment.id)
expect(analytics).to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).to have_logged_event('SendProofingNotificationJob: job completed')
expect(analytics).to have_logged_event(
'SendProofingNotificationJob: in person notification SMS send attempted',
)
expect(passed_enrollment.reload.notification_sent_at).to eq(now)
expect(passed_enrollment.reload.notification_phone_configuration).to be_nil
end
Expand All @@ -144,16 +121,12 @@

freeze_time do
now = Time.zone.now
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_started,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_job_completed,
)
expect(analytics).to receive(
:idv_in_person_send_proofing_notification_attempted,
)
job.perform(failing_enrollment.id)
expect(analytics).to have_logged_event('SendProofingNotificationJob: job started')
expect(analytics).to have_logged_event('SendProofingNotificationJob: job completed')
expect(analytics).to have_logged_event(
'SendProofingNotificationJob: in person notification SMS send attempted',
)
expect(failing_enrollment.reload.notification_sent_at).to eq(now)
expect(failing_enrollment.reload.notification_phone_configuration).to be_nil
end
Expand All @@ -163,19 +136,19 @@
it 'logs sms send failure when number is opt out and enrollment not updated' do
allow(Telephony).to receive(:send_notification).and_return(sms_opt_out_response)

expect(analytics).to receive(
:idv_in_person_send_proofing_notification_attempted,
)
job.perform(passed_enrollment.id)
expect(analytics).to have_logged_event(
'SendProofingNotificationJob: in person notification SMS send attempted',
)
expect(passed_enrollment.reload.notification_sent_at).to be_nil
end
it 'logs sms send failure for delivery failure' do
allow(Telephony).to receive(:send_notification).and_return(sms_failure_response)

expect(analytics).to receive(
:idv_in_person_send_proofing_notification_attempted,
)
job.perform(passed_enrollment.id)
expect(analytics).to have_logged_event(
'SendProofingNotificationJob: in person notification SMS send attempted',
)
expect(passed_enrollment.reload.notification_sent_at).to be_nil
end
end
Expand All @@ -188,7 +161,7 @@
job.perform(passed_enrollment.id)

expect(analytics).to have_logged_event(
'SendProofingNotificationJob: Exception raised',
'SendProofingNotificationJob: exception raised',
enrollment_code: nil,
enrollment_id: passed_enrollment.id,
exception_class: 'ActiveRecord::DatabaseConnectionError',
Expand Down