Skip to content

Document analytics properties exempted in controller specs#11220

Merged
aduth merged 2 commits intomainfrom
aduth-analytics-events-controller
Sep 10, 2024
Merged

Document analytics properties exempted in controller specs#11220
aduth merged 2 commits intomainfrom
aduth-analytics-events-controller

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Sep 10, 2024

🛠 Summary of changes

Updates controller specs to remove blanket exemptions for allowed_extra_analytics, and adds documentation where existing errors occur in doing so.

Most of these are in IdV/IPP.

Why?

  • So that analytics properties are documented in Analytics Events handbook article, and we have a clear understanding of what analytics properties exist
  • Incremental step toward removing allowed_extra_analytics

📜 Testing Plan

Verify build passes.

Double-check that required keyword arguments are always passed.

changelog: Internal, Analytics, Document analytics properties
@aduth aduth requested review from a team, eileen-nava and solipet and removed request for a team September 10, 2024 13:11

def idv_in_person_proofing_residential_address_submitted(**extra)
track_event('IdV: in person proofing residential address submitted', **extra)
# @param [Boolean] success Whether form validation was successful
Copy link
Contributor

@gina-yamada gina-yamada Sep 10, 2024

Choose a reason for hiding this comment

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

NIt- I did not look at all events but it would be nice if the order matched ie: 3 arg in notes is error_details but is flow_path in args below. Update- maybe lots of additional work and not caused by your changes so ignore if you'd like

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried to add some consistency here while balancing diff size. I think we'll want to make a pass at standardizing order & descriptions once we've got everything fully documented

Copy link
Contributor

Choose a reason for hiding this comment

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

Make sense to me- resolving

Copy link
Contributor

@matthinz matthinz left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for your service

@aduth aduth merged commit b37767d into main Sep 10, 2024
@aduth aduth deleted the aduth-analytics-events-controller branch September 10, 2024 19:08
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.

3 participants