identity-idp icon indicating copy to clipboard operation
identity-idp copied to clipboard

Document sign-in helper analytics events to unexempt extra analytics

Open aduth opened this issue 1 year ago • 1 comments

🛠 Summary of changes

Updates a few analytics methods to specify and document the full set of expected arguments.

Specifically, this addresses issues stemming from shared helpers, where failing to document these may require additional new allowed_extra_analytics exceptions where ideally we'd want only the current set of exempted specs (i.e. exemptions only shrinking, never growing).

Follow-up to discussion at https://github.com/18F/identity-idp/pull/10405#discussion_r1586246355

Temporarily merges to #10405, but will rebase to main after #10405 is merged.

📜 Testing Plan

Verify that the build passes.

aduth avatar May 02 '24 17:05 aduth

LGTM! So glad that this small number analytics events could allow removing this exception from a those tests!

It could have been that there have been other changes on main that allowed the removal of the exceptions. I took the rather extreme route of removing all of the exceptions in spec/features, and then re-exempting where there were failures.

It might be interesting to see if we can find a way to fail tests if allowed_extra_analytics is added unnecessarily to a spec group.

aduth avatar May 02 '24 21:05 aduth