IdV enrollment complete event by Sgtpluck · Pull Request #12132 · 18F/identity-idp

Sgtpluck · 2025-05-02T12:57:38Z

🎫 Ticket

Link to the relevant ticket:
163

🛠 Summary of changes

This change adds the idv-enrollment-complete event.

This is a new event that was added to fulfill the Enrollment complete milestone requirement.
It is a little tricky since there are several different pathways for users to finish their identity proofing journey, two of which are not part of the user flow.

The places where we activate a profile (thereby indicating that a profile's enrollment is "complete") is:

EnterPasswordController- where a user encrypts their data with their password
GpoVerifyForm - where a user submits their mail code
GetUSPSProofingResultsJob - where a user's IPP job is processed
ActionAccount::ReviewPass - where a user is cleared as valid after a fraud review

I would love to know if I am missing or misinterpreting any of these steps, or if other work should. (I wish I could just put this event on the Profile model's #active method, but there isn't a way really to inject the tracker into the Profile like that.)

…ete event

Sgtpluck · 2025-05-05T13:34:06Z

I added a reproof attribute to handle a milestone of identifying when a user had previously proofed completed idv enrollment.

eileen-nava

I left some comments.

I have an overall question about the AttemptsApi's events. When I'm working locally, I frequently run make watch_events in terminal to see what events are being logged. Is there a similar process I could run to see what events are being logged for the AttemptsApi?

app/controllers/idv/enter_password_controller.rb

eileen-nava · 2025-05-05T15:46:18Z

app/jobs/get_usps_proofing_results_job.rb

+      reproof = enrollment.user&.has_proofed_before?
      enrollment.profile&.activate_after_passing_in_person

+      if enrollment.profile&.active?


Since L494 activates the profile associated with the enrollment, I'm not clear why the conditional on L496 is necessary. Is there a scenario where the profile associated with the enrollment wouldn't be active? Are you concerned about the transaction in activate_after_passing_in_person failing?

both if it fails, or if an enrollment profile doesn't exist. i don't know what circumstances exist that a profile wouldn't exist on an enrollment, but i am taking my cues from the other code that adds the nil checker (such as enrollment.profile&.activate_after_passing_in_person, above)

eileen-nava · 2025-05-05T15:57:40Z

lib/action_account.rb

          success = true

          if profile.active?
+            attempts_api_tracker(profile:).idv_enrollment_complete(reproof:)


This looks good from an IPP perspective.

gina-yamada · 2025-05-05T18:00:00Z

For IPP, above your wrote where a user's IPP job is processed. Should this log when the user passes? Or should it log when then enrollment is processed (ie: user may have failed or the enrollment with USPS may have expired)?

Sgtpluck · 2025-05-05T18:06:19Z

@gina-yamada it should log when the profile has been activated.

@eileen-nava interesting suggestion! there is not a way to do that currently from the idp, but i can consider building that in when i have some free time again. meanwhile, the sample sinatra oidc application does have an attempt-api endpoint now that shows tracked events, if you are using the sample oidc application locally.

mitchellhenke

Couple small questions, but otherwise looks good to me

mitchellhenke · 2025-05-05T18:11:19Z

app/controllers/idv/enter_password_controller.rb

    end

    def init_profile
+      reproof = current_user.has_proofed_before?


I was going to ask if this could be moved into the conditional, but that wouldn't work because if we ran this check after creating a profile, it would always be true?

yeah, exactly. i thought about checking to see if there was more than one profile that had the activated_at attribute, but i don't think what was happening was as clear

mitchellhenke · 2025-05-05T18:15:37Z

app/controllers/idv/enter_password_controller.rb

      end

      if profile.active?
+        attempts_api_tracker.idv_enrollment_complete(reproof:)


Could this be moved below UserAlerts::AlertUserAboutAccountVerified.call? I think it might be preferable to run the other things first (in terms of importance).

sure, added in a39cefb

gina-yamada · 2025-05-05T20:38:11Z

@gina-yamada it should log when the profile has been activated.

@eileen-nava interesting suggestion! there is not a way to do that currently from the idp, but i can consider building that in when i have some free time again. meanwhile, the sample sinatra oidc application does have an attempt-api endpoint now that shows tracked events, if you are using the sample oidc application locally.

I didn't check but the only edge case you may need to look into- if a user is flagged for fraud. They can be activated after the investigation concludes. It is not in the usps job but there is a script to activate users-I bet you already handled it.

app/services/attempts_api/tracker_events.rb

Sgtpluck · 2025-05-05T20:56:43Z

@gina-yamada thanks for the heads-up about that edge case! i believe it is handled in the ActionAccount::ReviewPass class, but appreciate you bringing it to my attention in case I had overlooked it!

gina-yamada · 2025-05-05T21:00:47Z

@gina-yamada thanks for the heads-up about that edge case! i believe it is handled in the ActionAccount::ReviewPass class, but appreciate you bringing it to my attention in case I had overlooked it!

That looks accurate! I should have looked at the code and posted if it was not there. I was replying to comments and then jumped back in. I agree - handled in ReviewPass class. I think you are set. Nice work.

Sgtpluck requested a review from mitchellhenke May 2, 2025 12:57

amirbey requested review from a team, eileen-nava, solipet and theabrad and removed request for a team, eileen-nava and solipet May 2, 2025 17:01

Sgtpluck added 4 commits May 5, 2025 08:31

changelog: Upcoming Features, Attempts API, Adds idv-enrollment-compl…

fdfbe27

…ete event

Add event in ActionAccount profile activation

69f7996

Add enrollment complete event for IPP job

81914b6

Fix broken tests

e3bedaf

Sgtpluck force-pushed the dmm/idv-enrollment-complete branch from 8fc57bb to f2adb19 Compare May 5, 2025 13:29

Add reproof attribute to idv-enrollment-complete

825248e

Sgtpluck force-pushed the dmm/idv-enrollment-complete branch from f2adb19 to 825248e Compare May 5, 2025 13:50

Fix typo in documentation

15ab96a

eileen-nava reviewed May 5, 2025

View reviewed changes

Add spec based on PR feedback

5562ae1

mitchellhenke approved these changes May 5, 2025

View reviewed changes

Reorder code per PR feedback

a39cefb

gina-yamada reviewed May 5, 2025

View reviewed changes

app/services/attempts_api/tracker_events.rb Show resolved Hide resolved

Fix typo

9e7b826

Sgtpluck merged commit 8a75c74 into main May 6, 2025
1 check passed

Sgtpluck deleted the dmm/idv-enrollment-complete branch May 6, 2025 12:27

mdiarra3 mentioned this pull request May 8, 2025

Deploy RC 477 to Production #12154

Merged

Conversation

Sgtpluck commented May 2, 2025

🎫 Ticket

🛠 Summary of changes

Uh oh!

Sgtpluck commented May 5, 2025

Uh oh!

eileen-nava left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eileen-nava May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Sgtpluck May 5, 2025

Choose a reason for hiding this comment

Uh oh!

eileen-nava May 5, 2025

Choose a reason for hiding this comment

Uh oh!

gina-yamada commented May 5, 2025

Uh oh!

Sgtpluck commented May 5, 2025

Uh oh!

mitchellhenke left a comment

Choose a reason for hiding this comment

Uh oh!

mitchellhenke May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Sgtpluck May 5, 2025

Choose a reason for hiding this comment

Uh oh!

mitchellhenke May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Sgtpluck May 5, 2025

Choose a reason for hiding this comment

Uh oh!

gina-yamada commented May 5, 2025

Uh oh!

Uh oh!

Sgtpluck commented May 5, 2025

Uh oh!

gina-yamada commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gina-yamada commented May 5, 2025 •

edited

Loading