Refactor chart code to avoid hard coded class and group by

This is the preparation work to support transaction charts.
bestpractical · bestpractical-mirror · Dec 15, 2023 · Mar 29, 2022 · Mar 29, 2022 · Mar 29, 2022
commit 7ac429de584d5fa8def554c576f9505e3727eb4a
diff --git a/lib/RT/Report/Tickets.pm b/lib/RT/Report/Tickets.pm
@@ -720,7 +720,7 @@ sub SetupGroupings {
 
     my @group_by = grep defined && length,
         ref( $args{'GroupBy'} )? @{ $args{'GroupBy'} } : ($args{'GroupBy'});
-    @group_by = ('Status') unless @group_by;
+    @group_by = $self->DefaultGroupBy unless @group_by;
 
     my $distinct_results = 1;
     foreach my $e ( splice @group_by ) {
@@ -1838,6 +1838,10 @@ sub _GroupingType {
     return $GROUPINGS{$key};
 }
 
+sub DefaultGroupBy {
+    return 'Status';
+}
+
 RT::Base->_ImportOverlays();
 
 1;
diff --git a/lib/RT/SearchBuilder.pm b/lib/RT/SearchBuilder.pm
@@ -267,6 +267,22 @@ sub RecordClass {
     $_[0]->_SingularClass
 }
 
+=head2 ReportClass
+
+Returns report class name of this collection. E.g. report class of RT::Tickets
+is RT::Report::Tickets
+
+=cut
+
+sub ReportClass {
+    my $self = shift;
+    my $class = ref($self) || $self;
+    if ( $class =~ s/(?<=^RT::)/Report::/ ) {
+        return $class;
+    }
+    return undef;
+}
+
 =head2 RegisterCustomFieldJoin
 
 Takes a pair of arguments, the first a class name and the second a callback

diff --git a/share/html/Elements/ShowSearch b/share/html/Elements/ShowSearch
@@ -119,6 +119,7 @@ if ($SavedSearch) {
 
         if ( $SearchArg->{'SearchType'} eq 'Chart' ) {
             $SearchArg->{'SavedChartSearchId'} ||= $SavedSearch;
+            $class = $SearchArg->{Class} if $SearchArg->{Class};
         }
 
         # XXX: dispatch to different handler here

diff --git a/share/html/Search/Chart b/share/html/Search/Chart
@@ -54,6 +54,7 @@ $ChartStyle => 'bar+table+sql'
 @ChartFunction => 'COUNT'
 $Width  => undef
 $Height => undef
+$Class => 'RT::Tickets'
 </%args>
 <%init>
 use GD;
@@ -101,8 +102,10 @@ my $plot_error = sub {
     $m->comp( 'SELF:Plot', plot => $plot, %ARGS );
 };
 
-use RT::Report::Tickets;
-my $report = RT::Report::Tickets->new( $session{'CurrentUser'} );
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my $report = $report_class->new( $session{'CurrentUser'} );
 
 my %columns;
 if ( $Cache and my $data = delete $session{'charts_cache'}{ $Cache } ) {

diff --git a/share/html/Search/Chart.html b/share/html/Search/Chart.html
@@ -46,9 +46,14 @@
 %#
 %# END BPS TAGGED BLOCK }}}
 <%init>
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my $report = $report_class->new( $session{'CurrentUser'} );
+
 my $default_value = {
     Query => 'id > 0',
-    GroupBy => ['Status'],
+    GroupBy => [ $report->DefaultGroupBy ],
     ChartStyle => 'bar+table+sql',
     ChartFunction => ['COUNT'],
 };
@@ -57,7 +62,7 @@
 
 my $title = loc( "Grouped search results");
 
-my @search_fields = ( qw(Query GroupBy StackedGroupBy ChartStyle ChartFunction Width Height ExtraQueryParams), grep $_, @ExtraQueryParams );
+my @search_fields = ( qw(Query GroupBy StackedGroupBy ChartStyle ChartFunction Width Height Class ExtraQueryParams), grep $_, @ExtraQueryParams );
 my $saved_search = $m->comp( '/Widgets/SavedSearch:new',
     SearchType   => 'Chart',
     SearchFields => [@search_fields],
@@ -147,6 +152,7 @@
 <form method="POST" action="<% RT->Config->Get('WebPath') %>/Search/Chart.html">
 <input type="hidden" class="hidden" name="Query" value="<% $query{Query} %>" />
 <input type="hidden" class="hidden" name="SavedChartSearchId" value="<% $saved_search->{SearchId} || 'new' %>" />
+<input type="hidden" class="hidden" name="Class" value="<% $Class %>" />
 
 % if ( $query{ExtraQueryParams} ) {
 %   for my $input ( ref $query{ExtraQueryParams} eq 'ARRAY' ?  @{$query{ExtraQueryParams}} : $query{ExtraQueryParams} ) {
@@ -165,6 +171,7 @@
           Default => $query{'GroupBy'}[0],
           Stacked => $query{'GroupBy'}[0] eq ($query{StackedGroupBy} // '') ? 1 : 0,
           StackedId => 'StackedGroupBy-1',
+          Class => $Class,
         &>
         </fieldset>
         <fieldset><legend><% loc('and then') %></legend>
@@ -175,6 +182,7 @@
           ShowEmpty => 1,
           Stacked => $query{'GroupBy'}[1] && ($query{'GroupBy'}[1] eq ($query{StackedGroupBy} // '')) ? 1 : 0,
           StackedId => 'StackedGroupBy-2',
+          Class => $Class,
         &>
       </fieldset>
       <fieldset><legend><% loc('and then') %></legend>
@@ -185,19 +193,20 @@
           ShowEmpty => 1,
           Stacked => $query{'GroupBy'}[2] && ($query{'GroupBy'}[2] eq ($query{StackedGroupBy} // '')) ? 1 : 0,
           StackedId => 'StackedGroupBy-3',
+          Class => $Class,
         &>
       </fieldset>
     </&>
 
     <&| /Widgets/TitleBox, title => loc("Calculate"), class => "chart-calculate" &>
       <fieldset><legend><% loc('Calculate values of') %></legend>
-        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[0] &>
+        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[0], Class => $Class, &>
       </fieldset>
       <fieldset><legend><% loc('and then') %></legend>
-        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[1] // q{}, ShowEmpty => 1 &>
+        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[1] // q{}, ShowEmpty => 1, Class => $Class, &>
       </fieldset>
       <fieldset><legend><% loc('and then') %></legend>
-        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[2] // q{}, ShowEmpty => 1 &>
+        <& Elements/SelectChartFunction, Default => $query{'ChartFunction'}[2] // q{}, ShowEmpty => 1, Class => $Class, &>
       </fieldset>
     </&>
 
@@ -330,7 +339,7 @@
 
   <div class="col-xl-6">
     <div class="saved-search">
-      <& /Widgets/SavedSearch:show, %ARGS, Action => 'Chart.html', self => $saved_search, Title => loc('Saved charts'), AllowCopy => 1 &>
+      <& /Widgets/SavedSearch:show, Class => $Class, %ARGS, Action => 'Chart.html', self => $saved_search, Title => loc('Saved charts'), AllowCopy => 1 &>
     </div>
   </div>
 </div>
@@ -340,4 +349,5 @@
 
 <%ARGS>
 @ExtraQueryParams => ()
+$Class => 'RT::Tickets'
 </%ARGS>
diff --git a/share/html/Search/Elements/Chart b/share/html/Search/Elements/Chart
@@ -50,11 +50,14 @@ $Query => "id > 0"
 @GroupBy => ()
 $ChartStyle => 'bar+table+sql'
 @ChartFunction => 'COUNT'
+$Class => 'RT::Tickets'
 </%args>
 <%init>
-use RT::Report::Tickets;
 
-my $report = RT::Report::Tickets->new( $session{'CurrentUser'} );
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my $report = $report_class->new( $session{'CurrentUser'} );
 
 my %columns = $report->SetupGroupings(
     Query => $Query,

diff --git a/share/html/Search/Elements/ChartTable b/share/html/Search/Elements/ChartTable
@@ -48,6 +48,7 @@
 <%ARGS>
 %Table => ()
 $Query => 'id > 0'
+$Class => 'RT::Tickets'
 </%ARGS>
 <%INIT>
 

diff --git a/share/html/Search/Elements/EditSearches b/share/html/Search/Elements/EditSearches
@@ -123,7 +123,7 @@
   <div class="form-row">
     <div class="label col-4"><&|/l&>Load saved search</&>:</div>
     <div class="col-8 input-group">
-<& SelectSearchesForObjects, Name => 'SavedSearchLoad', Objects => \@LoadObjects, SearchType => $Type &>
+<& SelectSearchesForObjects, Name => 'SavedSearchLoad', Objects => \@LoadObjects, SearchType => $Type, Class => $Class &>
 <input type="submit" class="button btn btn-primary" value="<% loc('Load') %>" id="SavedSearchLoadSubmit" name="SavedSearchLoadSubmit" />
     </div>
   </div>

diff --git a/share/html/Search/Elements/SelectChartFunction b/share/html/Search/Elements/SelectChartFunction
@@ -72,8 +72,11 @@ while ( my ($value, $display) = splice @functions, 0, 2 ) {
 $Name => 'ChartFunction'
 $Default => 'COUNT'
 $ShowEmpty => 0
+$Class => $Class
 </%ARGS>
 <%INIT>
-my @functions = RT::Report::Tickets->Statistics;
-$Default = '' unless defined $Default;
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my @functions = $report_class->Statistics;
 </%INIT>
diff --git a/share/html/Search/Elements/SelectGroupBy b/share/html/Search/Elements/SelectGroupBy
@@ -47,11 +47,12 @@
 %# END BPS TAGGED BLOCK }}}
 <%args>
 $Name => 'GroupBy'
-$Default => 'Status'
+$Default => ''
 $Query   => ''
 $ShowEmpty => 0
 $Stacked => 0
 $StackedId => "Stacked$Name"
+$Class => 'RT::Tickets'
 </%args>
 <select name="<% $Name %>" class="cascade-by-optgroup">
 % if ( $ShowEmpty ) {
@@ -85,7 +86,9 @@ while ( my ($label, $value) = splice @options, 0, 2 ) {
 </span>
 
 <%init>
-use RT::Report::Tickets;
-my $report = RT::Report::Tickets->new( $session{'CurrentUser'} );
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my $report = $report_class->new( $session{'CurrentUser'} );
 my @options = $report->Groupings( Query => $Query );
 </%init>
diff --git a/share/html/Search/Elements/SelectSearchesForObjects b/share/html/Search/Elements/SelectSearchesForObjects
@@ -65,6 +65,7 @@ $SearchType => $Class eq 'RT::Transactions' ? 'Transaction' : $Class eq 'RT::Ass
 %     next if ($search->SubValue('SearchType')
 %              && $search->SubValue('SearchType') ne $SearchType);
 %     next if ($search->SubValue('SearchType') // '') eq 'RT::Transactions' && ($search->SubValue('ObjectType') // '') ne $ObjectType;
+%     next if $SearchType eq 'Chart' && ( $search->SubValue('Class') || 'RT::Tickets' ) ne ( $Class || 'RT::Tickets' );
 <option value="<%ref($object)%>-<%$object->id%>-SavedSearch-<%$search->Id%>"><%$search->Description||loc('Unnamed search')%></option>
 % }
 </optgroup>

diff --git a/share/html/Search/JSChart b/share/html/Search/JSChart
@@ -55,6 +55,7 @@ $Width  => undef
 $Height => undef
 $SavedSearchId => ''
 $StackedGroupBy => undef
+$Class => 'RT::Tickets'
 </%args>
 
 % my $id = join '-', 'search-chart', $SavedSearchId || ();
@@ -188,12 +189,12 @@ $Width  ||= ($ChartStyle =~ /\bpie\b/ ? 400 : 600);
 $Height ||= ($ChartStyle =~ /\bpie\b/ ? $Width : 400);
 $Height = $Width if $ChartStyle =~ /\bpie\b/;
 
-use RT::Report::Tickets;
-my $report = RT::Report::Tickets->new( $session{'CurrentUser'} );
+my $report_class = ( $Class || 'RT::Tickets' )->ReportClass
+    or Abort( loc( "Couldn't find ReportClass for [_1]", $Class || 'RT::Tickets' ) );
+RT::StaticUtil::RequireModule($report_class) or Abort( loc("Couldn't load [_1]", $report_class) );
+my $report = $report_class->new( $session{'CurrentUser'} );
 
-# Default GroupBy we use in RT::Report::Tickets, we also need it here to
-# generate sub queries.
-@GroupBy = 'Status' unless @GroupBy;
+@GroupBy = $report_class->DefaultGroupBy unless @GroupBy;
 
 my %columns;
 if ( $Cache and my $data = delete $session{'charts_cache'}{ $Cache } ) {

diff --git a/share/html/Widgets/SavedSearch b/share/html/Widgets/SavedSearch
@@ -178,6 +178,7 @@ $defaults => {}
     $self->{CurrentSearch}{Object} ? 
     ( Object        => $self->{CurrentSearch}{Object},
     Description   => $self->{CurrentSearch}{Object}->Description, ) : (),
+    Class         => $Class,
 &><br />
 <%PERL>
 foreach my $field ( @{$self->{SearchFields}} ) {
@@ -197,6 +198,7 @@ $self   => undef
 $Action => ''
 $Title  => loc('Saved searches')
 $AllowCopy => 0
+$Class => 'RT::Tickets'
 </%ARGS>
 <%init>
 </%init>