Skip to content

LG-12160: FE Logging Changes#10156

Merged
charleyf merged 22 commits intomainfrom
charley/lg-12160-logs-add-fe
Mar 8, 2024
Merged

LG-12160: FE Logging Changes#10156
charleyf merged 22 commits intomainfrom
charley/lg-12160-logs-add-fe

Conversation

@charleyf
Copy link
Contributor

@charleyf charleyf commented Feb 26, 2024

🎫 Ticket

https://cm-jira.usa.gov/browse/LG-12160

🛠 Summary of changes

This is related to a previous PR to add logging to the BE here. This PR adds liveness_checking_required field to some FE logs, specifically:

  • Frontend: IdV: Image capture failed
  • Frontend: IdV: Acuant SDK loaded
  • Frontend: IdV: front image added
  • Frontend: IdV: back image added (same event as front image added)
  • Frontend: IdV: barcode warning continue clicked
  • Frontend: IdV: barcode warning retake photos clicked
  • Frontend: IdV: front image clicked
  • Frontend: IdV: back image clicked (same event as front image clicked)
  • Frontend: IdV: warning shown
  • Frontend: IdV: Capture troubleshooting dismissed

📜 Testing Plan

Provide a checklist of steps to confirm the changes.

  • Go through the IDV process with selfie off, then review the log entries above. They should all have a liveness_checking_required field that says false.
  • Go through the IDV process with selfie on, then review the log entries above. They should all have a liveness_checking_required field that says true.

@charleyf charleyf changed the title Note the places for addition LG-12160: FE Logging Changes Feb 26, 2024
@charleyf charleyf marked this pull request as ready for review February 29, 2024 14:50
@charleyf charleyf requested review from a team and amirbey and removed request for a team February 29, 2024 14:50
@@ -23,6 +23,7 @@ import AcuantContext, { AcuantCaptureMode } from '../context/acuant';
import AnalyticsContext from '../context/analytics';
Copy link
Contributor

Choose a reason for hiding this comment

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

I tested this locally with both selfie on and off. I saw mostly what's expected (and always the correct value), with a few caveats:

  1. I didn't see the image added events have the liveness_checking_required field (image clicked ones did have it though). I didn't see it in front, back, or selfie added events.
  2. I had trouble triggering the following events and so didn't test them:
    Frontend: IdV: barcode warning continue clicked
    Frontend: IdV: barcode warning retake photos clicked
    Frontend: IdV: Image capture failed
    
  3. I did see some additional events not listed in the PR with the field:
IdV: doc auth document_capture visited
IdV: doc auth image upload form submitted
IdV: doc auth image upload vendor submitted
IdV: doc auth image upload vendor pii validation
IdV: doc auth document_capture submitted
IdV: failed doc image resubmitted

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. I forgot to add them to the analytics 😅 fixed.
  2. 🤷 Seems reasonable to me. I'm comfortable merging with just automated tests for these.
  3. Those are coming for free since I added to the getAddAttemptAnalyticsPayload. I think it's good to have the new property more places.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for fixing #1! The rest makes sense to me.

Copy link
Contributor

@night-jellyfish night-jellyfish left a comment

Choose a reason for hiding this comment

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

Thanks for making the requested fixes. It looks good to me, pending CI passing!

Edit: CI passed just as I commented, haha.

@charleyf charleyf merged commit 704f45c into main Mar 8, 2024
@charleyf charleyf deleted the charley/lg-12160-logs-add-fe branch March 8, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants