From bcf82202190c9ae8d18588ea762bbac42a859f21 Mon Sep 17 00:00:00 2001
From: Zach Margolis <zachary.margolis@gsa.gov>
Date: Tue, 5 Sep 2023 14:37:46 -0700
Subject: [PATCH 1/4] Update IDV report to support multiple issuers (LG-10875)

- Expanding use so we can support a specific one-off request, but seemed
  easier to expand all reports at once
---
 .../reports/identity_verification_report.rb   |  2 +-
 lib/reporting/authentication_report.rb        | 12 +++++------
 lib/reporting/command_line_options.rb         |  8 ++++----
 lib/reporting/identity_verification_report.rb | 12 +++++------
 .../reporting/authentication_report_spec.rb   |  4 ++--
 .../reporting/command_line_options_spec.rb    | 20 +++++++++++++++++--
 .../identity_verification_report_spec.rb      |  6 +++---
 7 files changed, 40 insertions(+), 24 deletions(-)

diff --git a/app/jobs/reports/identity_verification_report.rb b/app/jobs/reports/identity_verification_report.rb
index 8943374b7c8..ed516fd2fe8 100644
--- a/app/jobs/reports/identity_verification_report.rb
+++ b/app/jobs/reports/identity_verification_report.rb
@@ -16,7 +16,7 @@ def perform(report_date)
 
     def report_maker
       Reporting::IdentityVerificationReport.new(
-        issuer: nil,
+        issuers: [],
         time_range: report_date.all_day,
         slice: 4.hours,
       )
diff --git a/lib/reporting/authentication_report.rb b/lib/reporting/authentication_report.rb
index 8924c0f9c5e..1f85345a519 100644
--- a/lib/reporting/authentication_report.rb
+++ b/lib/reporting/authentication_report.rb
@@ -14,7 +14,7 @@ module Reporting
   class AuthenticationReport
     include Reporting::CloudwatchQueryQuoting
 
-    attr_reader :issuer, :time_range
+    attr_reader :issuers, :time_range
 
     module Events
       OIDC_AUTH_REQUEST = 'OpenID Connect: authorization request'
@@ -31,14 +31,14 @@ def self.all_events
     # @param [String] isssuer
     # @param [Range<Time>] time_range
     def initialize(
-      issuer:,
+      issuers:,
       time_range:,
       verbose: false,
       progress: false,
       slice: 3.hours,
       threads: 5
     )
-      @issuer = issuer
+      @issuers = issuers
       @time_range = time_range
       @verbose = verbose
       @progress = progress
@@ -59,7 +59,7 @@ def to_csv
       CSV.generate do |csv|
         csv << ['Report Timeframe', "#{time_range.begin} to #{time_range.end}"]
         csv << ['Report Generated', Date.today.to_s] # rubocop:disable Rails/Date
-        csv << ['Issuer', issuer]
+        csv << ['Issuer', issuers.join(', ')]
         csv << []
         csv << ['Metric', 'Number of accounts', '% of total from start']
         csv << [
@@ -161,7 +161,7 @@ def fetch_results
 
     def query
       params = {
-        issuer: quote(issuer),
+        issuers: quote(issuers),
         event_names: quote(Events.all_events),
         email_confirmation: quote(Events::EMAIL_CONFIRMATION),
       }
@@ -170,7 +170,7 @@ def query
         fields
             name
           , properties.user_id AS user_id
-        | filter properties.service_provider = %{issuer}
+        | filter properties.service_provider IN %{issuers}
         | filter (name = %{email_confirmation} and properties.event_properties.success = 1)
                  or (name != %{email_confirmation})
         | filter name in %{event_names}
diff --git a/lib/reporting/command_line_options.rb b/lib/reporting/command_line_options.rb
index 9a713b08ad5..67285d84439 100644
--- a/lib/reporting/command_line_options.rb
+++ b/lib/reporting/command_line_options.rb
@@ -6,7 +6,7 @@ class CommandLineOptions
     # @return [Hash]
     def parse!(argv, out: STDOUT, require_issuer: true)
       date = nil
-      issuer = nil
+      issuers = []
       verbose = false
       progress = true
       period = nil
@@ -49,7 +49,7 @@ def parse!(argv, out: STDOUT, require_issuer: true)
         end
 
         opts.on('--issuer=ISSUER') do |issuer_v|
-          issuer = issuer_v
+          issuers << issuer_v
         end
 
         opts.on('--[no-]verbose', 'log details STDERR, default to off') do |verbose_v|
@@ -89,13 +89,13 @@ def parse!(argv, out: STDOUT, require_issuer: true)
 
       parser.parse!(argv)
 
-      if !date || (require_issuer && !issuer)
+      if !date || (require_issuer && issuers.empty?)
         out.puts parser
         exit 1
       else
         {
           time_range: time_range(date:, period:),
-          issuer: issuer,
+          issuers: issuers,
           verbose: verbose,
           progress: progress,
           slice: slice || 3.hours,
diff --git a/lib/reporting/identity_verification_report.rb b/lib/reporting/identity_verification_report.rb
index 1c42079b7c7..b6a7c549531 100644
--- a/lib/reporting/identity_verification_report.rb
+++ b/lib/reporting/identity_verification_report.rb
@@ -14,7 +14,7 @@ module Reporting
   class IdentityVerificationReport
     include Reporting::CloudwatchQueryQuoting
 
-    attr_reader :issuer, :time_range
+    attr_reader :issuers, :time_range
 
     module Events
       IDV_DOC_AUTH_WELCOME = 'IdV: doc auth welcome visited'
@@ -39,14 +39,14 @@ module Results
     # @param [String] isssuer
     # @param [Range<Time>] date
     def initialize(
-      issuer:,
+      issuers:,
       time_range:,
       verbose: false,
       progress: false,
       slice: 3.hours,
       threads: 5
     )
-      @issuer = issuer
+      @issuers = issuers
       @time_range = time_range
       @verbose = verbose
       @progress = progress
@@ -66,7 +66,7 @@ def to_csv
       CSV.generate do |csv|
         csv << ['Report Timeframe', "#{time_range.begin} to #{time_range.end}"]
         csv << ['Report Generated', Date.today.to_s] # rubocop:disable Rails/Date
-        csv << ['Issuer', issuer] if issuer.present?
+        csv << ['Issuer', issuers.join(', ')] if issuers.present?
         csv << []
         csv << ['Metric', '# of Users']
         csv << []
@@ -174,7 +174,7 @@ def fetch_results
 
     def query
       params = {
-        issuer: issuer && quote(issuer),
+        issuers: issuers.present? && quote(issuers),
         event_names: quote(Events.all_events),
         usps_enrollment_status_updated: quote(Events::USPS_ENROLLMENT_STATUS_UPDATED),
         gpo_verification_submitted: quote(Events::GPO_VERIFICATION_SUBMITTED),
@@ -185,7 +185,7 @@ def query
         fields
             name
           , properties.user_id AS user_id
-        #{issuer.present? ? '| filter properties.service_provider = %{issuer}' : ''}
+        #{issuers.present? ? '| filter properties.service_provider IN %{issuers}' : ''}
         | filter name in %{event_names}
         | filter (name = %{usps_enrollment_status_updated} and properties.event_properties.passed = 1)
                  or (name != %{usps_enrollment_status_updated})
diff --git a/spec/lib/reporting/authentication_report_spec.rb b/spec/lib/reporting/authentication_report_spec.rb
index ecbb3d9e884..ca0bdeb2988 100644
--- a/spec/lib/reporting/authentication_report_spec.rb
+++ b/spec/lib/reporting/authentication_report_spec.rb
@@ -5,7 +5,7 @@
   let(:issuer) { 'my:example:issuer' }
   let(:time_range) { Date.new(2022, 1, 1).all_day }
 
-  subject(:report) { Reporting::AuthenticationReport.new(issuer:, time_range:) }
+  subject(:report) { Reporting::AuthenticationReport.new(issuers: [issuer], time_range:) }
 
   before do
     cloudwatch_client = double(
@@ -73,7 +73,7 @@
 
   describe '#cloudwatch_client' do
     let(:opts) { {} }
-    let(:subject) { described_class.new(issuer:, time_range:, **opts) }
+    let(:subject) { described_class.new(issuers: [issuer], time_range:, **opts) }
     let(:default_args) do
       {
         num_threads: 5,
diff --git a/spec/lib/reporting/command_line_options_spec.rb b/spec/lib/reporting/command_line_options_spec.rb
index 82f2a055d32..15d7d1fd0a6 100644
--- a/spec/lib/reporting/command_line_options_spec.rb
+++ b/spec/lib/reporting/command_line_options_spec.rb
@@ -46,7 +46,23 @@
       it 'returns the parsed options' do
         expect(parse!).to match(
           time_range: Date.new(2023, 1, 1).in_time_zone('UTC').all_day,
-          issuer: issuer,
+          issuers: [issuer],
+          verbose: false,
+          progress: true,
+          slice: 3.hours,
+          threads: 5,
+        )
+      end
+    end
+
+    context 'with --date and multiple --issuer tags' do
+      let(:argv) { %W[--date 2023-1-1 --issuer #{issuer} --issuer #{issuer2}] }
+      let(:issuer2) { 'my:other:example:issuer' }
+
+      it 'returns the parsed options' do
+        expect(parse!).to match(
+          time_range: Date.new(2023, 1, 1).in_time_zone('UTC').all_day,
+          issuers: [issuer, issuer2],
           verbose: false,
           progress: true,
           slice: 3.hours,
@@ -72,7 +88,7 @@
         it 'returns the parsed options' do
           expect(parse!).to match(
             time_range: Date.new(2023, 1, 1).in_time_zone('UTC').all_day,
-            issuer: nil,
+            issuers: [],
             verbose: false,
             progress: true,
             slice: 3.hours,
diff --git a/spec/lib/reporting/identity_verification_report_spec.rb b/spec/lib/reporting/identity_verification_report_spec.rb
index b0d3849d3c2..bc3d9f14555 100644
--- a/spec/lib/reporting/identity_verification_report_spec.rb
+++ b/spec/lib/reporting/identity_verification_report_spec.rb
@@ -5,7 +5,7 @@
   let(:issuer) { 'my:example:issuer' }
   let(:time_range) { Date.new(2022, 1, 1).all_day }
 
-  subject(:report) { Reporting::IdentityVerificationReport.new(issuer:, time_range:) }
+  subject(:report) { Reporting::IdentityVerificationReport.new(issuers: Array(issuer), time_range:) }
 
   # rubocop:disable Layout/LineLength
   before do
@@ -102,7 +102,7 @@
       it 'includes an issuer filter' do
         result = subject.query
 
-        expect(result).to include('| filter properties.service_provider = "my:example:issuer"')
+        expect(result).to include('| filter properties.service_provider IN ["my:example:issuer"]')
       end
     end
 
@@ -119,7 +119,7 @@
 
   describe '#cloudwatch_client' do
     let(:opts) { {} }
-    let(:subject) { described_class.new(issuer:, time_range:, **opts) }
+    let(:subject) { described_class.new(issuers: Array(issuer), time_range:, **opts) }
     let(:default_args) do
       {
         num_threads: 5,

From 25bcfb4fc664979e493faf129cad6b8e868b563e Mon Sep 17 00:00:00 2001
From: Zach Margolis <zachary.margolis@gsa.gov>
Date: Tue, 5 Sep 2023 15:05:52 -0700
Subject: [PATCH 2/4] lintfix

---
 spec/lib/reporting/identity_verification_report_spec.rb | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/spec/lib/reporting/identity_verification_report_spec.rb b/spec/lib/reporting/identity_verification_report_spec.rb
index bc3d9f14555..825040cd9cd 100644
--- a/spec/lib/reporting/identity_verification_report_spec.rb
+++ b/spec/lib/reporting/identity_verification_report_spec.rb
@@ -5,7 +5,9 @@
   let(:issuer) { 'my:example:issuer' }
   let(:time_range) { Date.new(2022, 1, 1).all_day }
 
-  subject(:report) { Reporting::IdentityVerificationReport.new(issuers: Array(issuer), time_range:) }
+  subject(:report) do
+    Reporting::IdentityVerificationReport.new(issuers: Array(issuer), time_range:)
+  end
 
   # rubocop:disable Layout/LineLength
   before do

From d4d656c7860196429906214b85f5e2c652a8725d Mon Sep 17 00:00:00 2001
From: Zach Margolis <zachary.margolis@gsa.gov>
Date: Tue, 5 Sep 2023 15:06:07 -0700
Subject: [PATCH 3/4] Add changelog

changelog: Internal, Reporting, Update funnel reports to accept multiple issuers

From 3ca0ec83fafadc82e95a28125514db21d72b485e Mon Sep 17 00:00:00 2001
From: Zach Margolis <zachary.margolis@gsa.gov>
Date: Wed, 6 Sep 2023 09:43:53 -0700
Subject: [PATCH 4/4] Update YARD params docs

---
 lib/reporting/authentication_report.rb        | 2 +-
 lib/reporting/identity_verification_report.rb | 2 +-
 lib/reporting/monthly_proofing_report.rb      | 3 ++-
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/lib/reporting/authentication_report.rb b/lib/reporting/authentication_report.rb
index 1f85345a519..f13bfc14f0c 100644
--- a/lib/reporting/authentication_report.rb
+++ b/lib/reporting/authentication_report.rb
@@ -28,7 +28,7 @@ def self.all_events
       end
     end
 
-    # @param [String] isssuer
+    # @param [Array<String>] issuers
     # @param [Range<Time>] time_range
     def initialize(
       issuers:,
diff --git a/lib/reporting/identity_verification_report.rb b/lib/reporting/identity_verification_report.rb
index b6a7c549531..8c1deb37ea1 100644
--- a/lib/reporting/identity_verification_report.rb
+++ b/lib/reporting/identity_verification_report.rb
@@ -36,7 +36,7 @@ module Results
       IDV_FINAL_RESOLUTION_IN_PERSON = 'IdV: final resolution - In Person Proofing'
     end
 
-    # @param [String] isssuer
+    # @param [Array<String>] issuers
     # @param [Range<Time>] date
     def initialize(
       issuers:,
diff --git a/lib/reporting/monthly_proofing_report.rb b/lib/reporting/monthly_proofing_report.rb
index ec4563f6c49..6274369c101 100644
--- a/lib/reporting/monthly_proofing_report.rb
+++ b/lib/reporting/monthly_proofing_report.rb
@@ -28,6 +28,7 @@ def self.all_events
       end
     end
 
+    # @param [Array<String>] issuers
     # @param [Range<Time>] date
     def initialize(
       time_range:,
@@ -35,7 +36,7 @@ def initialize(
       progress: false,
       slice: 3.hours,
       threads: 5,
-      issuer: nil # rubocop:disable Lint/UnusedMethodArgument
+      issuers: [] # rubocop:disable Lint/UnusedMethodArgument
     )
       @time_range = time_range
       @verbose = verbose