Merged
Conversation
zachmargolis
reviewed
Apr 5, 2022
app/services/analytics_events.rb
Outdated
| # @identity.idp.event_name Return to SP: Failed to proof | ||
| # Tracks when a service provide fails to proof. | ||
| # @param [String] redirect_url the url of the service provider | ||
| def return_to_sp_failure_to_proof(url, **location_params) |
Contributor
There was a problem hiding this comment.
- can we make
urlkeyword argument to match? - looks like we can rely on
location_paramsto have fairly consistent keys, let's use those?
Suggested change
| def return_to_sp_failure_to_proof(url, **location_params) | |
| def return_to_sp_failure_to_proof(url:, flow: nil, step: nil, location: nil, **extra) |
app/services/analytics_events.rb
Outdated
Comment on lines
271
to
277
| # @param [Hash] result_hash hash containing the result of accepting the rules of use | ||
| def rules_of_use_submitted(result_hash, **extra) | ||
| track_event( | ||
| 'Rules of Use Submitted', | ||
| result_hash, | ||
| **extra, | ||
| ) |
Contributor
There was a problem hiding this comment.
can can we document what's inside result_hash? Usually there are sucess: errors: and some other extra attributes
app/services/analytics_events.rb
Outdated
Comment on lines
283
to
286
| def security_event_received(result_hash, **extra) | ||
| track_event( | ||
| 'RISC: Security event received', | ||
| result_hash, |
zachmargolis
approved these changes
Apr 6, 2022
Contributor
zachmargolis
left a comment
zachmargolis
left a comment
There was a problem hiding this comment.
LGTM! some small wording suggestions
| Analytics::RETURN_TO_SP_FAILURE_TO_PROOF, | ||
| redirect_url: 'https://sp.gov/failure_to_proof', | ||
| 'Return to SP: Failed to proof', | ||
| hash_including(redirect_url: 'https://sp.gov/failure_to_proof'), |
Contributor
There was a problem hiding this comment.
this would still work without hash_including, right?
Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>
Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>
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
2 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.
Why?: Documenting More Analytics Events