Skip to content

Include "personal_key" as alertable key in analytics PiiDetector #6241

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.

Sign up for GitHub

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

Merged
aduth merged 2 commits into from
Apr 22, 2022
Merged

Include "personal_key" as alertable key in analytics PiiDetector #6241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd770ea
Include "personal_key" as alertable key in analytics PiiDetector
aduth Apr 22, 2022
eb5270d
Add changelog
aduth Apr 22, 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
6 changes: 5 additions & 1 deletion app/controllers/users/verify_personal_key_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ def create
else
result = personal_key_form.submit

analytics.track_event(Analytics::PERSONAL_KEY_REACTIVATION_SUBMITTED, result.to_h)
analytics.track_event(
Analytics::PERSONAL_KEY_REACTIVATION_SUBMITTED,
**result.to_h,
pii_like_keypaths: [[:errors, :personal_key], [:error_details, :personal_key]],
)
if result.success?
handle_success(decrypted_pii: personal_key_form.decrypted_pii)
else
Expand Down
6 changes: 5 additions & 1 deletion app/services/analytics.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@ def register_doc_auth_step_from_analytics_event(event, attributes)
end

def track_mfa_submit_event(attributes)
track_event(MULTI_FACTOR_AUTH, attributes)
track_event(
MULTI_FACTOR_AUTH,
**attributes,
pii_like_keypaths: [[:errors, :personal_key], [:error_details, :personal_key]],
)
attributes[:success] ? 'success' : 'fail'
end

Expand Down
5 changes: 4 additions & 1 deletion spec/controllers/users/verify_personal_key_controller_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,9 @@
stub_analytics
expect(@analytics).to receive(:track_event).with(
Analytics::PERSONAL_KEY_REACTIVATION_SUBMITTED,
{ errors: {}, success: true },
errors: {},
success: true,
pii_like_keypaths: [[:errors, :personal_key], [:error_details, :personal_key]],
).once

expect(@analytics).to receive(:track_event).with(
Expand Down Expand Up @@ -134,6 +136,7 @@
errors: { personal_key: ['Please fill in this field.', 'Incorrect personal key'] },
error_details: { personal_key: [:blank, :personal_key_incorrect] },
success: false,
pii_like_keypaths: [[:errors, :personal_key], [:error_details, :personal_key]],
).once
expect(@analytics).to receive(:track_event).with(
Analytics::THROTTLER_RATE_LIMIT_TRIGGERED,
Expand Down
2 changes: 1 addition & 1 deletion spec/support/fake_analytics.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def track_event(event, original_attributes = {})
end
end

pii_attr_names = Pii::Attributes.members - [
pii_attr_names = Pii::Attributes.members + [:personal_key] - [
:state, # state on its own is not enough to be a pii leak
]

Expand Down