Skip to content
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

Proof of Concept: Document analytics events via YARD (LG-5590) #6014

Merged
merged 23 commits into from
Mar 4, 2022
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
77c4e9c
Proof of Concept: Document analytics events via YARD (LG-5590)
zachmargolis Mar 2, 2022
78a13b0
optional
zachmargolis Mar 2, 2022
1085051
Migrate ACCOUNT_DELETE_SUBMITTED
zachmargolis Mar 2, 2022
cbe37c2
Use Makefile to generate the JSON
zachmargolis Mar 2, 2022
dd75757
Migrate ACCOUNT_DELETE_VISITED
zachmargolis Mar 2, 2022
a28fc64
fixup ACCOUNT_DELETE_SUBMITTED
zachmargolis Mar 2, 2022
0b54508
Makefile help line
zachmargolis Mar 2, 2022
2d4f2c6
Add separate lint and output commands, factor into a class
zachmargolis Mar 2, 2022
b9b5740
rubocops
zachmargolis Mar 2, 2022
778eeaa
Update analytics lint command and fix analytics lint errors
zachmargolis Mar 2, 2022
5cfb746
Bundle exec stuff
zachmargolis Mar 3, 2022
75dd072
Add changelog
zachmargolis Mar 3, 2022
d562814
Add additional code coverage
zachmargolis Mar 3, 2022
cdeca15
Switch to dasherized /api/analytics-events endpoint, add to CORS allo…
zachmargolis Mar 3, 2022
7cb3951
Merge remote-tracking branch 'origin/main' into margolis-analytics-ev…
zachmargolis Mar 3, 2022
13da56d
gitignore
zachmargolis Mar 3, 2022
531b95d
eslint ignore doc dir
zachmargolis Mar 3, 2022
24ba2bc
build analytics_events as part of artifact compilation
zachmargolis Mar 3, 2022
1c8a239
Move JSON building to build-post-config
zachmargolis Mar 3, 2022
7377ed0
Serve the analytics events data from Rails so that the CORS middlewar…
zachmargolis Mar 3, 2022
e872498
Clean up documentation
zachmargolis Mar 4, 2022
fb3a914
Clean up documentation
zachmargolis Mar 4, 2022
698e2c7
Migrate ACCOUNT_DELETION event
zachmargolis Mar 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Clean up documentation
  • Loading branch information
zachmargolis committed Mar 4, 2022
commit e872498932399e2cac4cbe5b10ab80019077d953
6 changes: 3 additions & 3 deletions app/services/analytics_events.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ module AnalyticsEvents
# @identity.idp.event_name Account Reset
Copy link
Contributor Author

@zachmargolis zachmargolis Mar 2, 2022

Choose a reason for hiding this comment

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

👀 custom tag! we can make a form of the script that errors when this is absent as a lint, maybe even try to make sure that the string is present in the method body

# @param [Boolean] success
# @param ["cancel", "delete", "cancel token validation", "granted token validation",
# :notifications] event
# @param [String] message_id Request ID from AWS Pinpoint API
# @param [String] request_id Request ID from AWS Pinpoint API
# "notifications"] event
# @param [String] message_id from AWS Pinpoint API
# @param [String] request_id from AWS Pinpoint API
# @param [Boolean] sms_phone
# @param [Boolean] totp does the user have an authentication app as a 2FA option?
# @param [Boolean] piv_cac does the user have PIV/CAC as a 2FA option?
Expand Down