From 0c8ef9f896751f219c3e18654062ecf1fc88423f Mon Sep 17 00:00:00 2001
From: sunnavy <sunnavy@bestpractical.com>
Date: Wed, 27 Mar 2024 20:16:23 -0400
Subject: [PATCH] Support to sort/limit axis labels in search charts

Previously charts were always sorted by labels in ascending order, this
commit enhances it to support descending order too, as well as sorting by
values(i.e. asset/ticket/transaction count).

Limiting the number of results is also implemented in this commit, with
which users can easily get a more friendly chart that contains significant
data only.
---
 lib/RT/Interface/Web.pm          |  2 +-
 lib/RT/Report.pm                 | 23 ++++++++++++++++----
 share/html/Search/Chart          |  2 +-
 share/html/Search/Chart.html     | 36 +++++++++++++++++++++++++++++++-
 share/html/Search/Elements/Chart |  2 +-
 share/html/Search/JSChart        |  2 +-
 6 files changed, 58 insertions(+), 9 deletions(-)

diff --git a/lib/RT/Interface/Web.pm b/lib/RT/Interface/Web.pm
index 6fe866f97f8..dc90a312944 100644
--- a/lib/RT/Interface/Web.pm
+++ b/lib/RT/Interface/Web.pm
@@ -84,7 +84,7 @@ use RT::Interface::Web::ReportsRegistry;
 
 our @SHORTENER_SEARCH_FIELDS
     = qw/Class ObjectType BaseQuery Query Format RowsPerPage Order OrderBy ExtraQueryParams ResultPage/;
-our @SHORTENER_CHART_FIELDS = qw/Width Height ChartStyle GroupBy ChartFunction StackedGroupBy/;
+our @SHORTENER_CHART_FIELDS = qw/Width Height ChartStyle GroupBy ChartFunction StackedGroupBy ChartOrderBy ChartOrder ChartLimit/;
 
 =head2 SquishedCSS $style
 
diff --git a/lib/RT/Report.pm b/lib/RT/Report.pm
index 5e76fa29edf..6cea047123b 100644
--- a/lib/RT/Report.pm
+++ b/lib/RT/Report.pm
@@ -759,6 +759,12 @@ sub _FieldToFunction {
 
 sub SortEntries {
     my $self = shift;
+    my %args = (
+        ChartOrderBy => 'label',
+        ChartOrder   => 'ASC',
+        ChartLimit   => undef,
+        @_,
+    );
 
     $self->_DoSearch if $self->{'must_redo_search'};
     return unless $self->{'items'} && @{ $self->{'items'} };
@@ -772,16 +778,21 @@ sub SortEntries {
     my @SORT_OPS;
     my $by_multiple = sub ($$) {
         for my $f ( @SORT_OPS ) {
-            my $r = $f->($_[0], $_[1]);
+            my $r = uc $f->($args{ChartOrder} eq 'ASC' ? ( $_[0], $_[1] ) : ( $_[1], $_[0] ) );
             return $r if $r;
         }
     };
+
     my @data = map [$_], @{ $self->{'items'} };
 
-    for ( my $i = 0; $i < @groups; $i++ ) {
-        my $group_by = $groups[$i];
-        my $idx = $i+1;
+    if ( $args{ChartOrderBy} eq 'value' && grep { $_ eq 'id' } $self->ColumnsList ) {
+        $_->[1] = $_->[0]->RawValue('id') for @data;
+        push @SORT_OPS, sub { $_[0][1] <=> $_[1][1] };
+    }
 
+    # Even if charts are sorted by value, it's still good to sort by labels next, to sort items with the same value.
+    for my $group_by ( @groups ) {
+        my $idx = @SORT_OPS + 1;
         my $order = $group_by->{'META'}{Sort} || 'label';
         my $method = $order =~ /label$/ ? 'LabelValue' : 'RawValue';
 
@@ -834,6 +845,10 @@ sub SortEntries {
         map $_->[0],
         sort $by_multiple @data
     ];
+
+    if ( $args{ChartLimit} ) {
+        $self->{'items'} = [ splice @{ $self->{'items'} }, 0, $args{ChartLimit} ];
+    }
 }
 
 sub PostProcessRecords {
diff --git a/share/html/Search/Chart b/share/html/Search/Chart
index 5b3a19afcca..516eb2b232d 100644
--- a/share/html/Search/Chart
+++ b/share/html/Search/Chart
@@ -119,7 +119,7 @@ if ( $Cache and my $data = delete $session{'charts_cache'}{ $Cache } ) {
         Function => \@ChartFunction,
     );
 
-    $report->SortEntries;
+    $report->SortEntries( map { $_ => $ARGS{$_} } grep { $ARGS{$_} } qw(ChartOrderBy ChartOrder ChartLimit) );
 }
 
 my @data = ([],[]);
diff --git a/share/html/Search/Chart.html b/share/html/Search/Chart.html
index 14774cdb375..667d5d1344f 100644
--- a/share/html/Search/Chart.html
+++ b/share/html/Search/Chart.html
@@ -56,13 +56,16 @@
     GroupBy => [ $report->DefaultGroupBy ],
     ChartStyle => 'bar+table+sql',
     ChartFunction => ['COUNT'],
+    ChartOrderBy  => 'label',
+    ChartOrder    => 'ASC',
+    ChartLimit    => '',
 };
     
 $m->callback( ARGSRef => \%ARGS, CallbackName => 'Initial' );
 
 my $title = loc( "Grouped search results");
 
-my @search_fields = ( qw(Query GroupBy StackedGroupBy ChartStyle ChartFunction Width Height Class ExtraQueryParams), grep $_, @ExtraQueryParams );
+my @search_fields = ( qw(Query GroupBy StackedGroupBy ChartStyle ChartFunction Width Height Class ExtraQueryParams ChartOrderBy ChartOrder ChartLimit), grep $_, @ExtraQueryParams );
 my $saved_search = $m->comp( '/Widgets/SavedSearch:new',
     SearchType   => 'Chart',
     SearchFields => [@search_fields],
@@ -273,6 +276,37 @@
         <input type="checkbox" id="ChartStyleIncludeSQL" name="ChartStyleIncludeSQL" class="custom-control-input" <% $query{ChartStyle} =~ /\bsql\b/ ? 'checked="checked"' : '' |n %>>
         <label class="custom-control-label" for="ChartStyleIncludeSQL"><&|/l&>Include TicketSQL query</&></label>
       </div>
+
+      <div class="form-row sorting">
+        <div class="label col-auto">
+          <span class="far fa-question-circle icon-helper" data-toggle="tooltip" data-placement="top" data-original-title="<&|/l&>Value only works for count calculations</&>"></span>
+          <&|/l&>Order by</&>:
+        </div>
+        <div class="value col-auto">
+          <select name="ChartOrderBy" class="form-control selectpicker">
+            <option value="label" <% $query{ChartOrderBy} eq 'label' ? 'selected="selected"' : '' |n %>><&|/l&>Label</&></option>
+            <option value="value" <% $query{ChartOrderBy} eq 'value' ? 'selected="selected"' : '' |n %>><&|/l&>Value</&></option>
+          </select>
+        </div>
+        <div class="value col-auto">
+          <select name="ChartOrder" class="form-control selectpicker">
+            <option value="ASC" <% $query{ChartOrder} eq 'ASC' ? 'selected="selected"' : '' |n %>><&|/l&>ASC</&></option>
+            <option value="DESC" <% $query{ChartOrder} eq 'DESC' ? 'selected="selected"' : '' |n %>><&|/l&>DESC</&></option>
+          </select>
+        </div>
+        <div class="label col-auto"><&|/l&>Limit</&>:</div>
+        <div class="value col-auto">
+          <div class="input-group">
+            <div class="input-group-prepend">
+              <span class="input-group-text"><&|/l&>top</&></span>
+            </div>
+            <input name="ChartLimit" size="3" class="form-control" value="<% $query{ChartLimit} // '' %>" />
+            <div class="input-group-append">
+              <span class="input-group-text"><&|/l&>items</&></span>
+            </div>
+          </div>
+        </div>
+      </div>
     </&>
 
 <script type="text/javascript">
diff --git a/share/html/Search/Elements/Chart b/share/html/Search/Elements/Chart
index 7079551846a..1c260788f85 100644
--- a/share/html/Search/Elements/Chart
+++ b/share/html/Search/Elements/Chart
@@ -65,7 +65,7 @@ my %columns = $report->SetupGroupings(
     Function => \@ChartFunction,
 );
 
-$report->SortEntries;
+$report->SortEntries(map { $_ => $ARGS{$_} } grep { $ARGS{$_} } qw(ChartOrderBy ChartOrder ChartLimit));
 
 my $query_string = $m->comp('/Elements/QueryString', %ARGS, GroupBy => \@GroupBy );
 
diff --git a/share/html/Search/JSChart b/share/html/Search/JSChart
index dc72c4cddf6..14e3024a49f 100644
--- a/share/html/Search/JSChart
+++ b/share/html/Search/JSChart
@@ -208,7 +208,7 @@ if ( $Cache and my $data = delete $session{'charts_cache'}{ $Cache } ) {
         Function => \@ChartFunction,
     );
 
-    $report->SortEntries;
+    $report->SortEntries( map { $_ => $ARGS{$_} } grep { $ARGS{$_} } qw(ChartOrderBy ChartOrder ChartLimit) );
 }
 
 my @data = ([],[]);