270 Dashboard Filters. (#381)

* 270 Dashboard Filters.

Refactor multiple queries used to generate KPIs, allowing for more flexible date range scopes. Update the system admin dashboard UI to add simple links to filter KPIs based on predefined date ranges aligned with the application windows.

Additionally to help with local ssl testing, add cert.pem, key.pem to .gitignore.

.bundler-audit.yml

@@ -1,3 +1,5 @@
 ---
 ignore:
   - CVE-2023-26141
+  - CVE-2024-21636
+  - GHSA-xc9x-jj77-9p9j

.gitignore

@@ -44,3 +44,6 @@ bin/fetch_config.rb
 
 /app/assets/builds/*
 !/app/assets/builds/.keep
+
+./nginx/key.pem
+./nginx/cert.pem

Gemfile

@@ -10,7 +10,7 @@ gem "foreman"
 gem "jbuilder"
 gem "okcomputer"
 gem "pg", "~> 1.5"
-gem "puma", "~> 6.4"
+gem "puma", ">= 6.4.2", "< 7"
 gem "rails", "~> 7.1"
 gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]
 

Gemfile.lock

@@ -319,7 +319,7 @@ GEM
     psych (5.1.1.1)
       stringio
     public_suffix (5.0.1)
-    puma (6.4.0)
+    puma (6.4.2)
       nio4r (~> 2.0)
     raabro (1.4.0)
     racc (1.7.3)
@@ -536,7 +536,7 @@ DEPENDENCIES
   phonelib
   propshaft (~> 0.8.0)
   pry-byebug
-  puma (~> 6.4)
+  puma (>= 6.4.2, < 7)
   rails (~> 7.1)
   rolify
   rspec-rails

app/controllers/system_admin/dashboard_controller.rb

@@ -1,7 +1,7 @@
 module SystemAdmin
   class DashboardController < AdminController
     def show
-      @kpis = Kpis.new(**kpi_params)
+      @kpis = Kpis.new(**kpi_params.merge(window_params))
     rescue ArgumentError => e
       flash[:alert] = e.message
       redirect_to(dashboard_path)
@@ -16,5 +16,9 @@ def kpi_params
         .to_hash
         .symbolize_keys
     end
+
+    def window_params
+      { window: params[:window] }
+    end
   end
 end

app/helpers/application_helper.rb

@@ -34,4 +34,13 @@ def application_statuses_options(selected: nil, all_statuses: false)
 
     options_for_select(statuses, selected:)
   end
+
+  def dashboard_link(window_param, label)
+    current_window = params[:window] || "all"
+    if current_window == window_param
+      content_tag(:strong, label)
+    else
+      link_to(label, dashboard_path(window: window_param))
+    end
+  end
 end

app/helpers/inflection_helper.rb

@@ -0,0 +1,15 @@
+# Initially created to help display the correct form of day or days in the dashboard.
+module InflectionHelper
+  def pluralize_word(count, word)
+    "#{count} #{word.pluralize(count)}"
+  end
+
+  def calculate_day_stats(durations)
+    min_days         = pluralize_word(durations.min.abs, "day") if durations.min
+    max_days         = pluralize_word(durations.max.abs, "day") if durations.max
+    average_duration = durations.size.positive? ? (durations.sum / durations.size.to_f).round.abs : 0
+    average_days     = pluralize_word(average_duration, "day")
+
+    { min: min_days, max: max_days, average: average_days }
+  end
+end

app/models/kpis.rb

@@ -1,73 +1,74 @@
 class Kpis
-  def initialize(unit: "hours", range_start: "24", range_end: "0")
+  def initialize(unit: "hours", range_start: "24", range_end: "0", window: "all")
     @date_range_params = parse_date_range(unit:, range_start:, range_end:)
     @date_range = to_date_range(**@date_range_params)
+    @window = window
   end
 
-  attr_reader :date_range, :date_range_params
+  attr_reader :date_range, :date_range_params, :window
 
   def total_applications
-    Application.count
+    filtered_applications_by_date.count
   end
 
   def total_rejections
-    ApplicationProgress.where.not(rejection_completed_at: nil).count
+    filter_by_date_range(ApplicationProgress.where.not(rejection_completed_at: nil)).count
   end
 
   def average_age
-    AverageAgeQuery.new.call
+    AverageAgeQuery.new(filtered_applications_by_date).call
   end
 
   def total_paid
-    ApplicationProgress.where.not(banking_approval_completed_at: nil).count
+    filter_by_date_range(ApplicationProgress.where.not(banking_approval_completed_at: nil)).count
   end
 
   def route_breakdown
-    RouteBreakdownQuery.new.call
+    RouteBreakdownQuery.new(filtered_applications_by_date).call
   end
 
   def subject_breakdown
-    SubjectBreakdownQuery.new.call
+    SubjectBreakdownQuery.new(filtered_applications_by_date).call
   end
 
   def visa_breakdown
-    VisaBreakdownQuery.new.call.first(3)
+    VisaBreakdownQuery.new(filtered_applications_by_date).call.first(3)
   end
 
   def nationality_breakdown
-    NationalityBreakdownQuery.new.call.first(5)
+    NationalityBreakdownQuery.new(filtered_applications_by_date).call.first(5)
   end
 
   def gender_breakdown
-    GenderBreakdownQuery.new.call
+    GenderBreakdownQuery.new(filtered_applications_by_date).call
   end
 
   def rejection_reason_breakdown
-    RejectionReasonBreakdownQuery.new.call
+    RejectionReasonBreakdownQuery.new(filtered_applications_by_date).call
   end
 
   def time_to_initial_checks
-    TimeToInitialChecksQuery.new.call
+    TimeToInitialChecksQuery.new(filtered_progress_by_date).call
   end
 
   def time_to_home_office_checks
-    TimeToHomeOfficeChecksQuery.new.call
+    TimeToHomeOfficeChecksQuery.new(filtered_progress_by_date).call
   end
 
   def time_to_school_checks
-    TimeToSchoolChecksQuery.new.call
+    TimeToSchoolChecksQuery.new(filtered_progress_by_date).call
   end
 
   def time_to_banking_approval
-    TimeToBankingApprovalQuery.new.call
+    TimeToBankingApprovalQuery.new(filtered_progress_by_date).call
   end
 
   def time_to_payment_confirmation
-    TimeToPaymentConfirmationQuery.new.call
+    TimeToPaymentConfirmationQuery.new(filtered_progress_by_date).call
   end
 
   def status_breakdown
-    StatusBreakdownQuery.call
+    StatusBreakdownQuery.call(filtered_progress_by_date)
   end
 
   def forms_funnel
@@ -119,4 +120,27 @@ def to_date_range(unit:, range_start:, range_end:)
   def forms_funnel_query
     @forms_funnel_query ||= FormsFunnelQuery.call(date_range:)
   end
+
+  def date_ranges
+    {
+      "sept_oct" => Date.new(2023, 9, 1).beginning_of_day..Date.new(2023, 10, 31).end_of_day,
+      "jan_feb" => Date.new(2024, 1, 1).beginning_of_day..Date.new(2024, 3, 1).end_of_day,
+    }
+  end
+
+  def filter_by_date_range(scope)
+    if date_ranges.key?(window)
+      scope.where(created_at: date_ranges[window])
+    else
+      scope
+    end
+  end
+
+  def filtered_applications_by_date
+    filter_by_date_range(Application.all)
+  end
+
+  def filtered_progress_by_date
+    filter_by_date_range(ApplicationProgress.all)
+  end
 end

app/queries/average_age_query.rb

@@ -1,6 +1,6 @@
 class AverageAgeQuery
-  def initialize(relation = Applicant.all)
-    @relation = relation.joins(:application).merge(Application.all)
+  def initialize(applications = Application.all)
+    @relation = Applicant.joins(:application).merge(applications)
   end
 
   def call

app/queries/gender_breakdown_query.rb

@@ -1,6 +1,6 @@
 class GenderBreakdownQuery
-  def initialize(relation = Applicant.all)
-    @relation = relation.joins(:application).merge(Application.all)
+  def initialize(applications = Application.all)
+    @relation = Applicant.joins(:application).merge(applications)
   end
 
   def call

app/queries/nationality_breakdown_query.rb

@@ -1,6 +1,6 @@
 class NationalityBreakdownQuery
-  def initialize(relation = Applicant.all)
-    @relation = relation.joins(:application).merge(Application.all)
+  def initialize(applications = Application.all)
+    @relation = Applicant.joins(:application).merge(applications)
   end
 
   def call

app/queries/rejection_reason_breakdown_query.rb

@@ -1,6 +1,6 @@
 class RejectionReasonBreakdownQuery
-  def initialize(relation = ApplicationProgress.all)
-    @relation = relation.joins(:application).merge(Application.all).where.not(rejection_reason: nil)
+  def initialize(applications = Application.all)
+    @relation = ApplicationProgress.joins(:application).merge(applications).where.not(rejection_reason: nil)
   end
 
   def call

app/queries/status_breakdown_query.rb

@@ -1,6 +1,10 @@
 class StatusBreakdownQuery
-  def self.call
-    new.execute
+  def self.call(scope = ApplicationProgress.all)
+    new(scope).execute
+  end
+
+  def initialize(scope)
+    @scope = scope
   end
 
   def execute
@@ -10,7 +14,7 @@ def execute
 private
 
   def status_breakdown
-    ApplicationProgress.group(:status).count
+    @scope.group(:status).count
   end
 
   def ordered_with_defaults(breakdown)

app/queries/time_to_banking_approval_query.rb

@@ -1,17 +1,12 @@
 class TimeToBankingApprovalQuery
+  include InflectionHelper
   def initialize(relation = ApplicationProgress.all)
     @relation = relation
   end
 
   def call
     applications_list = @relation.where.not(school_checks_completed_at: nil).where.not(banking_approval_completed_at: nil)
-
     durations = applications_list.map { |app| (app.banking_approval_completed_at.to_date - app.school_checks_completed_at.to_date).to_i }
-
-    min_days = "#{durations.min.abs} days" if durations.min
-    max_days = "#{durations.max.abs} days" if durations.max
-    average_days = durations.size.positive? ? "#{(durations.sum / durations.size.to_f).round.abs} days" : "0 days"
-
-    { min: min_days, max: max_days, average: average_days }
+    calculate_day_stats(durations)
   end
 end

app/queries/time_to_home_office_checks_query.rb

@@ -1,17 +1,13 @@
 class TimeToHomeOfficeChecksQuery
+  include InflectionHelper
+
   def initialize(relation = ApplicationProgress.all)
     @relation = relation
   end
 
   def call
     applications_list = @relation.where.not(initial_checks_completed_at: nil).where.not(home_office_checks_completed_at: nil)
-
     durations = applications_list.map { |app| (app.home_office_checks_completed_at.to_date - app.initial_checks_completed_at.to_date).to_i }
-
-    min_days = "#{durations.min.abs} days" if durations.min
-    max_days = "#{durations.max.abs} days" if durations.max
-    average_days = durations.size.positive? ? "#{(durations.sum / durations.size.to_f).round.abs} days" : "0 days"
-
-    { min: min_days, max: max_days, average: average_days }
+    calculate_day_stats(durations)
   end
 end

app/queries/time_to_initial_checks_query.rb

@@ -1,17 +1,13 @@
 class TimeToInitialChecksQuery
+  include InflectionHelper
+
   def initialize(relation = ApplicationProgress.all)
     @relation = relation
   end
 
   def call
     applications_list = @relation.where.not(created_at: nil).where.not(initial_checks_completed_at: nil)
-
     durations = applications_list.map { |app| (app.initial_checks_completed_at.to_date - app.created_at.to_date).to_i }
-
-    min_days = "#{durations.min.abs} days" if durations.min
-    max_days = "#{durations.max.abs} days" if durations.max
-    average_days = durations.size.positive? ? "#{(durations.sum / durations.size.to_f).round.abs} days" : "0 days"
-
-    { min: min_days, max: max_days, average: average_days }
+    calculate_day_stats(durations)
   end
 end

app/queries/time_to_payment_confirmation_query.rb

@@ -1,17 +1,12 @@
 class TimeToPaymentConfirmationQuery
+  include InflectionHelper
   def initialize(relation = ApplicationProgress.all)
     @relation = relation
   end
 
   def call
     applications_list = @relation.where.not(payment_confirmation_completed_at: nil).where.not(banking_approval_completed_at: nil)
-
     durations = applications_list.map { |app| (app.payment_confirmation_completed_at.to_date - app.banking_approval_completed_at.to_date).to_i }
-
-    min_days = "#{durations.min.abs} days" if durations.min
-    max_days = "#{durations.max.abs} days" if durations.max
-    average_days = durations.size.positive? ? "#{(durations.sum / durations.size.to_f).round.abs} days" : "0 days"
-
-    { min: min_days, max: max_days, average: average_days }
+    calculate_day_stats(durations)
   end
 end

app/queries/time_to_school_checks_query.rb

@@ -1,17 +1,12 @@
 class TimeToSchoolChecksQuery
+  include InflectionHelper
   def initialize(relation = ApplicationProgress.all)
     @relation = relation
   end
 
   def call
     applications_list = @relation.where.not(home_office_checks_completed_at: nil).where.not(school_checks_completed_at: nil)
-
     durations = applications_list.map { |app| (app.school_checks_completed_at.to_date - app.home_office_checks_completed_at.to_date).to_i }
-
-    min_days = "#{durations.min.abs} days" if durations.min
-    max_days = "#{durations.max.abs} days" if durations.max
-    average_days = durations.size.positive? ? "#{(durations.sum / durations.size.to_f).round.abs} days" : "0 days"
-
-    { min: min_days, max: max_days, average: average_days }
+    calculate_day_stats(durations)
   end
 end

app/views/system_admin/dashboard/show.html.erb

@@ -1,3 +1,11 @@
+<div class="govuk-body date-range">
+  <%= dashboard_link('all', 'All') %>
+  |
+  <%= dashboard_link('sept_oct', 'Sept/Oct 2023') %>
+  |
+  <%= dashboard_link('jan_feb', 'Jan/Feb 2024') %>
+</div>
+
 <div class="dashboard govuk-body">
   <div class="kpi-widget applications">
     <h3 class="title">Applications</h3>

config/environments/development.rb

@@ -61,4 +61,6 @@
 
   # Uncomment if you wish to allow Action Cable access from any origin.
   # config.action_cable.disable_request_forgery_protection = true
+
+  config.hosts << "itrp.local"
 end

config/environments/test.rb

@@ -54,4 +54,6 @@
 
   # config/initializers/dartsass.rb
   config.dartsass.build_options << " --quiet-deps"
+
+  config.hosts << "www.example.com"
 end