Document all analytics logged through sign_in_spec#10966
Merged
Conversation
This was referenced Jul 19, 2024
changelog: Internal, Analytics, Add internal documentation for analytics methods
This doesn't seem to apply in the real-world, but specs stub ab_test_args in a way that these properties would not be included Example: https://github.com/18F/identity-idp/blob/c02f05010d324b121f5ba7e33e22ea6a39af8c68/spec/controllers/idv/welcome_controller_spec.rb#L13
aduth
force-pushed
the
aduth-sign-in-spec-analytics
branch
from
61cd6ac to
e037f40
Compare
jmhooper
approved these changes
Aug 9, 2024
Contributor
jmhooper
left a comment
jmhooper
left a comment
There was a problem hiding this comment.
This looks like a lot of work. I looked over the proofing events and feel good about what you wrote up for those
kevinsmaster5
approved these changes
Aug 9, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛠 Summary of changes
Removes
allowed_extra_analyticsfromspec/features/users/sign_in_spec.rband resolves all flagged issues.Most of these come from IdV events, documented to the best of my ability.
Separately, it may be worth revisiting whether it's necessary for sign-in specs to go through the complete IdV flow, or if it would be fine to stub an already-IdV'd user instead (seeEdit: Addressed separately in #10967.sign_in.rbshared examples, specifically use ofcreate_ial2_account_go_back_to_sp_and_sign_out)📜 Testing Plan
Validate that tests pass.
In most cases, I added new method arguments as non-optional. Confidence check that these analytics will always be logged is appreciated.