Skip to content

Commit

Permalink
Document analytics methods properties in primary IdV flow (#11099)
Browse files Browse the repository at this point in the history
* Document analytics methods in critical IdV flow

* Remove unnecessary allowed_extra_analytics

* Update FakeAnalytics spec to pass required properties

* Add changelog

changelog: Internal, Documentation, Document analytics methods properties
  • Loading branch information
aduth authored Aug 16, 2024
1 parent 12da96c commit b5b9e5f
Show file tree
Hide file tree
Showing 16 changed files with 18 additions and 14 deletions.
3 changes: 3 additions & 0 deletions app/services/analytics_events.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1478,6 +1478,7 @@ def idv_doc_auth_submitted_image_upload_form(
# @param [Boolean] selfie_quality_good Selfie quality result
# @param [String] workflow LexisNexis TrueID workflow
# @param [String] birth_year Birth year from document
# @param [Integer] issue_year Year document was issued
# @option extra [String] 'DocumentName'
# @option extra [String] 'DocAuthResult'
# @option extra [String] 'DocIssuerCode'
Expand Down Expand Up @@ -1505,6 +1506,7 @@ def idv_doc_auth_submitted_image_upload_vendor(
client_image_metrics:,
flow_path:,
liveness_checking_required:,
issue_year:,
billed: nil,
doc_auth_result: nil,
vendor_request_time_in_ms: nil,
Expand Down Expand Up @@ -1578,6 +1580,7 @@ def idv_doc_auth_submitted_image_upload_vendor(
selfie_quality_good:,
workflow:,
birth_year:,
issue_year:,
**extra,
)
end
Expand Down
2 changes: 1 addition & 1 deletion spec/controllers/idv/image_uploads_controller_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.describe Idv::ImageUploadsController, allowed_extra_analytics: [:*] do
RSpec.describe Idv::ImageUploadsController do
include DocPiiHelper

let(:document_filename_regex) { /^[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}\.[a-z]+$/ }
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/account_creation_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.describe 'IAL2 account creation', allowed_extra_analytics: [:*] do
RSpec.describe 'IAL2 account creation' do
include IdvHelper
include DocAuthHelper
include SamlAuthHelper
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/cancel_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.describe 'cancel IdV', allowed_extra_analytics: [:*] do
RSpec.describe 'cancel IdV' do
include IdvStepHelper
include DocAuthHelper
include InteractionHelper
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/doc_auth/ssn_step_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'ssn step mock proofer', :js, allowed_extra_analytics: [:*] do
RSpec.feature 'ssn step mock proofer', :js do
include IdvStepHelper
include DocAuthHelper

Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/gpo_disabled_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'disabling GPO address verification', allowed_extra_analytics: [:*] do
RSpec.feature 'disabling GPO address verification' do
include IdvStepHelper

context 'with GPO address verification disabled' do
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/phone_input_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'IdV phone number input', :js, allowed_extra_analytics: [:*] do
RSpec.feature 'IdV phone number input', :js do
include IdvStepHelper

before do
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/proofing_components_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.describe 'proofing components', allowed_extra_analytics: [:*] do
RSpec.describe 'proofing components' do
include DocAuthHelper
include IdvHelper
include SamlAuthHelper
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/sp_requested_attributes_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'sp requested IdV attributes', :email, allowed_extra_analytics: [:*] do
RSpec.feature 'sp requested IdV attributes', :email do
context 'oidc' do
it_behaves_like 'sp requesting attributes', :oidc
end
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/step_up_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.describe 'IdV step up flow', allowed_extra_analytics: [:*] do
RSpec.describe 'IdV step up flow' do
include IdvStepHelper
include InPersonHelper

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'phone otp verification step spec', :js, allowed_extra_analytics: [:*] do
RSpec.feature 'phone otp verification step spec', :js do
include IdvStepHelper

it 'requires the user to enter the correct otp before continuing' do
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/threat_metrix_pending_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'Users pending ThreatMetrix review', :js, allowed_extra_analytics: [:*] do
RSpec.feature 'Users pending ThreatMetrix review', :js do
include IdvStepHelper
include OidcAuthHelper
include DocAuthHelper
Expand Down
2 changes: 1 addition & 1 deletion spec/features/idv/uak_password_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'A user with a UAK passwords attempts IdV', allowed_extra_analytics: [:*] do
RSpec.feature 'A user with a UAK passwords attempts IdV' do
include IdvStepHelper

it 'allows the user to continue to the SP', js: true do
Expand Down
2 changes: 1 addition & 1 deletion spec/features/sp_cost_tracking_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'SP Costing', :email, allowed_extra_analytics: [:*] do
RSpec.feature 'SP Costing', :email do
include SpAuthHelper
include SamlAuthHelper
include IdvHelper
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
require 'rails_helper'

RSpec.feature 'Password recovery via personal key', allowed_extra_analytics: [:*] do
RSpec.feature 'Password recovery via personal key' do
include PersonalKeyHelper
include IdvStepHelper
include SamlAuthHelper
Expand Down
1 change: 1 addition & 0 deletions spec/support/fake_analytics_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,7 @@
client_image_metrics: nil,
flow_path: nil,
liveness_checking_required: nil,
issue_year: nil,
'DocumentName' => 'some_name',
)

Expand Down

0 comments on commit b5b9e5f

Please sign in to comment.