Skip to content

Remove support for wildcard allowed_extra_analytics #11643

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 1 commit into from
Dec 16, 2024
Merged

Remove support for wildcard allowed_extra_analytics #11643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 1 addition & 26 deletions spec/support/fake_analytics.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def track_event(event, original_attributes = {})

extra_keywords -= Array(allowed_extra_analytics)

if extra_keywords.present? && !allowed_extra_analytics.include?(:*)
if extra_keywords.present?
raise UndocumentedParams, <<~ERROR
event :#{method_name} called with undocumented params #{extra_keywords.inspect}
(if these params are for specs only, use :allowed_extra_analytics metadata)
Expand Down Expand Up @@ -194,29 +194,4 @@ def reset!
FakeAnalytics::UndocumentedParamsChecker.allowed_extra_analytics = []
FakeAnalytics::UndocumentedParamsChecker.checked_extra_analytics = []
end

c.after(:all) do |_ex|
next if c.world.all_examples.count != c.world.example_count

groups.group_by(&:first).each do |group, pairs|
allowed_extra_analytics = group.metadata[:allowed_extra_analytics]
next if allowed_extra_analytics.blank?
all_checked_extra_analytics = pairs.map(&:last).flatten.uniq
if allowed_extra_analytics.include?(:*)
expect(all_checked_extra_analytics).to(
be_present,
"Unnecessary allowed_extra_analytics on example group #{group} (in #{group.id})",
)
else
unchecked_extra_analytics = allowed_extra_analytics - all_checked_extra_analytics
expect(unchecked_extra_analytics).to(
be_blank,
"Unnecessary allowed_extra_analytics keywords on example group #{group}: " \
"#{unchecked_extra_analytics} (in #{group.id})",
)
end
end
ensure
groups = []
end
end
19 changes: 0 additions & 19 deletions spec/support/fake_analytics_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,25 +605,6 @@
)
end

it 'does not error when undocumented params are allowed via *', allowed_extra_analytics: [:*] do
analytics.idv_phone_confirmation_otp_submitted(
success: true,
errors: true,
code_expired: true,
code_matches: true,
otp_delivery_preference: :sms,
second_factor_attempts_count: true,
second_factor_locked_at: true,
proofing_components: true,
fun_level: 1000,
)

expect(analytics).to have_logged_event(
'IdV: phone confirmation otp submitted',
hash_including(:fun_level),
)
end

it 'does not error when string tags are documented as options' do
analytics.idv_doc_auth_submitted_image_upload_vendor(
success: nil,
Expand Down