98603 Callbacks for ZSF logging - IVC CHAMPVA forms #20015

michaelclement · 2024-12-23T22:51:51Z

Summary

This PR adds a custom callback_class per this VA Notify documentation. The main change is that calls to monitor.log_silent_failure_avoided will now feature a completed email_confirmed property so that when they are viewed in this dashboard they are categorized properly.

Related issue(s)

Add logging to capture callback from VA Notify when a user has received a ZSF email va.gov-team#98603

Testing done

New code is covered by unit tests
Describe what the old behavior was prior to the change
Describe the steps required to verify your changes are working as expected. Exclusively stating 'Specs run' is NOT acceptable as appropriate testing
If this work is behind a flipper:
- Tests need to be written for both the flipper on and flipper off scenarios. Docs.
- What is the testing plan for rolling out the feature?

Screenshots

Note: Optional

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas)

Acceptance criteria

I fixed|updated|added unit tests and integration tests for each feature (if applicable).
No error nor warning in the console.
Events are being sent to the appropriate logging solution
Documentation has been updated (link to documentation)
No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
Feature/bug has a monitor built into Datadog (if applicable)
If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
I added a screenshot of the developed feature

Requested Feedback

(OPTIONAL)What should the reviewers know in addition to the above. Is there anything specific you wish the reviewer to assist with. Do you have any concerns with this PR, why?

michaelclement · 2025-01-02T18:52:48Z

config/features.yml

+  champva_vanotify_custom_callback:
+    actor_type: user
+    description: Enables the custom callback_klass when sending IVC CHAMPVA failure emails with VA Notify


Feature flag so we can test in staging.

michaelclement · 2025-01-02T18:54:14Z

modules/ivc_champva/app/jobs/ivc_champva/missing_form_status_job.rb

+
+      if Flipper.enabled?(:champva_vanotify_custom_callback, @current_user)
+        form_data = form_data.merge(
+          {
+            callback_klass: 'IvcChampva::ZsfEmailNotificationCallback',
+            callback_metadata: {
+              statsd_tag: 'veteran-ivc-champva-forms',
+              additional_context:
+            }
+          }
+        )
+      end


Passing this callback class to VA Notify when we send the email allows us to gather the email delivery status, which is then going to the DD silent failures dashboard.

michaelclement · 2025-01-02T18:54:38Z

modules/ivc_champva/app/jobs/ivc_champva/missing_form_status_job.rb

      ActiveRecord::Base.transaction do
        if IvcChampva::Email.new(form_data).send_email
          fetch_forms_by_uuid(form[:form_uuid]).update_all(email_sent: true) # rubocop:disable Rails/SkipsModelValidations
        else
-          additional_context = { form_id: form[:form_number], form_uuid: form[:form_uuid] }


This is now being passed in to the function above rather than created here.

michaelclement · 2025-01-02T18:55:38Z

modules/ivc_champva/app/services/ivc_champva/vanotify_callback_handler.rb

This is the actual callback class that gets run via VA Notify when an email's status is determined (modified from this example).

The only side effects from this callback are more logging calls.

michaelclement · 2025-01-02T18:59:51Z

modules/ivc_champva/app/jobs/ivc_champva/missing_form_status_job.rb

-          send_failure_email(form, template_id)
          additional_context = { form_id: form[:form_number], form_uuid: form[:form_uuid] }
-          monitor.log_silent_failure_avoided(additional_context)
-          monitor.track_missing_status_email_sent(form[:form_number])
+          unless Flipper.enabled?(:champva_vanotify_custom_callback, @current_user)
+            monitor.log_silent_failure_avoided(additional_context)
+            monitor.track_missing_status_email_sent(form[:form_number])
+          end
+          send_failure_email(form, template_id, additional_context)


These calls to the monitor have been moved inside our callback class so they have access to the email delivery status. send_failure_email has been updated to pass the callback_klass to VA Notify.

When our flipper is NOT enabled, we default to logging here per existing functionality.

LindseySaari · 2025-01-03T16:16:22Z

modules/ivc_champva/app/services/ivc_champva/email.rb

@@ -23,7 +23,7 @@ def initialize(data)
      @data = data
    end

-    def send_email
+    def send_email # rubocop:disable Metrics/MethodLength


I'd like to avoid inline disabling rubocop rules. Is there a way to break this up?

I was able to streamline how I'm accessing that object (updated in this commit) - please let me know if there's anything else I can modify. Thanks! @LindseySaari

michaelclement · 2025-01-06T15:24:45Z

Good morning, @LindseySaari! When you get a chance, could I please have another review of this PR? I updated some testing related issues and fixed the request above. Thank you!

first pass, not functioning

8f0020c

michaelclement mentioned this pull request Dec 23, 2024

Add logging to capture callback from VA Notify when a user has received a ZSF email department-of-veterans-affairs/va.gov-team#98603

Closed

github-actions bot added the lint-failure label Dec 23, 2024

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main December 23, 2024 22:57 Inactive

github-actions bot added the test-failure label Dec 23, 2024

fixed rubocop issues

b57b36f

github-actions bot removed the lint-failure label Dec 30, 2024

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main December 30, 2024 16:24 Inactive

michaelclement added 2 commits January 2, 2025 11:45

adjusted monitor parameters

71838e0

moved callback class to app dir for autoloading

8c0c1e6

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 2, 2025 18:26 Inactive

added feature flag

8ae4c38

michaelclement commented Jan 2, 2025

View reviewed changes

more feature flipper coverage

2b45f0c

michaelclement commented Jan 2, 2025

View reviewed changes

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 2, 2025 19:30 Inactive

cloudmagic80 previously approved these changes Jan 3, 2025

View reviewed changes

michaelclement marked this pull request as ready for review January 3, 2025 13:54

michaelclement requested review from a team as code owners January 3, 2025 13:54

github-actions bot added the require-backend-approval label Jan 3, 2025

LindseySaari reviewed Jan 3, 2025

View reviewed changes

updated data object access to reduce line count

fa5e936

michaelclement dismissed cloudmagic80’s stale review via fa5e936 January 3, 2025 16:50

va-vfs-bot requested a deployment to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 3, 2025 16:59 Pending

cloudmagic80 previously approved these changes Jan 3, 2025

View reviewed changes

renamed file to match contained class to fixautoloader const error

5247770

michaelclement dismissed cloudmagic80’s stale review via 5247770 January 6, 2025 14:20

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 6, 2025 14:29 Inactive

cloudmagic80 previously approved these changes Jan 6, 2025

View reviewed changes

updated test

09827ff

michaelclement dismissed cloudmagic80’s stale review via 09827ff January 6, 2025 14:43

va-vfs-bot temporarily deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 6, 2025 15:02 Inactive

updated test

360b0f8

va-vfs-bot deployed to 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email/main/main January 6, 2025 15:11 View deployment

github-actions bot added test-passing and removed test-failure labels Jan 6, 2025

reiting approved these changes Jan 6, 2025

View reviewed changes

michaelclement changed the title ~~98603 Callbacks for ZSF logging - IVC CHAMPV forms~~ 98603 Callbacks for ZSF logging - IVC CHAMPVA forms Jan 6, 2025

platform-support-slack-integration bot mentioned this pull request Jan 9, 2025

Good morning! Could I please have a backend review of this P... department-of-veterans-affairs/va.gov-team#100665

Open

LindseySaari approved these changes Jan 9, 2025

View reviewed changes

michaelclement merged commit 5d4bab5 into master Jan 9, 2025
22 of 23 checks passed

michaelclement deleted the 98603-add-logging-to-capture-callback-from-va-notify-when-a-user-has-received-a-zsf-email branch January 9, 2025 15:06

michaelclement mentioned this pull request Jan 10, 2025

98603 Update monitor class method in IVC callback - IVC CHAMPVA forms #20217

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

98603 Callbacks for ZSF logging - IVC CHAMPVA forms #20015

98603 Callbacks for ZSF logging - IVC CHAMPVA forms #20015

michaelclement commented Dec 23, 2024 •

edited

Loading

michaelclement Jan 2, 2025

michaelclement Jan 2, 2025

michaelclement Jan 2, 2025

michaelclement Jan 2, 2025

michaelclement Jan 2, 2025

LindseySaari Jan 3, 2025

michaelclement Jan 3, 2025

michaelclement commented Jan 6, 2025

98603 Callbacks for ZSF logging - IVC CHAMPVA forms #20015

98603 Callbacks for ZSF logging - IVC CHAMPVA forms #20015

Conversation

michaelclement commented Dec 23, 2024 • edited Loading

Summary

Related issue(s)

Testing done

Screenshots

What areas of the site does it impact?

Acceptance criteria

Requested Feedback

michaelclement Jan 2, 2025

Choose a reason for hiding this comment

michaelclement Jan 2, 2025

Choose a reason for hiding this comment

michaelclement Jan 2, 2025

Choose a reason for hiding this comment

michaelclement Jan 2, 2025

Choose a reason for hiding this comment

michaelclement Jan 2, 2025

Choose a reason for hiding this comment

LindseySaari Jan 3, 2025

Choose a reason for hiding this comment

michaelclement Jan 3, 2025

Choose a reason for hiding this comment

michaelclement commented Jan 6, 2025

michaelclement commented Dec 23, 2024 •

edited

Loading