-
Notifications
You must be signed in to change notification settings - Fork 114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add error to specs for undocumented analytics event params (LG-5969) #9946
Merged
zachmargolis
merged 53 commits into
main
from
margolis-lg-5969-undocumented-analytics-params
Jan 29, 2024
Merged
Add error to specs for undocumented analytics event params (LG-5969) #9946
zachmargolis
merged 53 commits into
main
from
margolis-lg-5969-undocumented-analytics-params
Jan 29, 2024
Conversation
This file contains 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
changelog: Internal, Documentation, Add error for undocumented analytics event params
olatifflexion
approved these changes
Jan 19, 2024
…cumented-analytics-params
Sgtpluck
approved these changes
Jan 22, 2024
aduth
reviewed
Jan 22, 2024
…cumented-analytics-params
…cumented-analytics-params
…cumented-analytics-params
…cumented-analytics-params
Ok update! The new plan here is that I added the infra needed to error on unknown params (and even document string keys), but plumbing those through was a lot of work and very tedious so I added an escape valve: allowed_extra_analytics: [:*] and am annotating failing specs with those so we can address documentation in a more piecemeal fashion |
zachmargolis
deleted the
margolis-lg-5969-undocumented-analytics-params
branch
January 29, 2024 21:25
This was referenced Jan 30, 2024
This was referenced Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🎫 Ticket
LG-5969
🛠 Summary of changes
Adds code to the test suite that will error when undocumented params are sent to the
track_event
method.Spec changes
There are two kinds of exceptions right now:
identity-idp/app/services/analytics_events.rb
Lines 948 to 953 in 84dcd52
So to get around that, we have some new spec metadata that can be used to annotate: