Load owner dropdown via AJAX for inline edit on list to speed up page…

… load
bestpractical · Nov 9, 2023 · 7640deb · 7640deb
1 parent 96ca7dd
commit 7640deb
Show file tree

Hide file tree

Showing 7 changed files with 213 additions and 1 deletion.
diff --git a/share/html/Elements/RT__Ticket/ColumnMap b/share/html/Elements/RT__Ticket/ColumnMap
@@ -114,7 +114,7 @@ $COLUMN_MAP = {
         title     => 'Owner', # loc
         attribute => 'Owner',
         value     => sub { return $_[0]->OwnerObj->Name },
-        edit      => sub { return \($m->scomp('/Elements/SelectOwner', TicketObj => $_[0], Name => 'Owner', Default => $_[0]->OwnerObj->Id, DefaultValue => 0)) },
+        edit      => sub { return \($m->scomp('/Elements/SelectOwner', TicketObj => $_[0], Name => 'Owner', Default => $_[0]->OwnerObj->Id, DefaultValue => 0, Delay => 1)) },
     },
     Status => {
         title     => 'Status', # loc

diff --git a/share/html/Elements/SelectOwner b/share/html/Elements/SelectOwner
@@ -54,6 +54,7 @@ if ( !$QueueObj && !$TicketObj && RT->Config->Get('AutocompleteOwnersForSearch')
 $Widget ||= RT->Config->Get('AutocompleteOwners', $session{'CurrentUser'})
                 ? 'Autocomplete' : 'Dropdown';
 
+$Widget = 'DropdownDelay' if $Delay;
 my @objects;
 if ($TicketObj) {
     @objects = ($TicketObj);
@@ -82,4 +83,5 @@ $m->callback(
 $TicketObj  => undef
 $QueueObj   => undef
 %Queues     => ()
+$Delay      => 0
 </%ARGS>
diff --git a/share/html/Elements/SelectOwnerDropdown b/share/html/Elements/SelectOwnerDropdown
@@ -113,6 +113,7 @@ unshift @formatednames, $nobody;
 $m->callback( CallbackName => 'ModifyOwnerListSorted', ARGSRef => \%ARGS,
     NamesRef => \@formatednames, DefaultRef => \$Default, Objects => $Objects );
 
+$ValueAttribute = 'id' unless ( $ValueAttribute // '' ) =~ /^(?:id|Name)$/;
 </%INIT>
 
 <%ARGS>

diff --git a/share/html/Elements/SelectOwnerDropdownDelay b/share/html/Elements/SelectOwnerDropdownDelay
@@ -0,0 +1,62 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC
+%#                                          <[email protected]>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<div class="select-owner-dropdown-delay" data-name="<% $Name // '' %>" data-default="<% $Default // '' %>" data-default-value="<% $DefaultValue // '' %>"
+data-default-label="<% $DefaultLabel // '' %>" data-value-attribute="<% $ValueAttribute // '' %>" data-size="<% $Size // '' %>"
+data-objects="<% JSON([ map { ref($_) . '-' . $_->id } @$Objects] ) %>"
+>
+</div>
+
+<%ARGS>
+$Name => undef
+$Objects => []
+$Default => 0
+$DefaultValue => 1
+$DefaultLabel => "-"
+$ValueAttribute => ''
+$Size => 0
+</%ARGS>
diff --git a/share/html/Helpers/SelectOwnerDropdown b/share/html/Helpers/SelectOwnerDropdown
@@ -0,0 +1,79 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC
+%#                                          <[email protected]>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<& /Elements/SelectOwnerDropdown, %ARGS, Objects => \@objects &>
+% $m->abort;
+<%INIT>
+my @objects;
+for my $item ( @{ JSON::from_json($Objects) || [] } ) {
+    my ( $class, $id ) = split /-/, $item, 2;
+    if ( $class && $id && $class =~ /^RT::(?:Ticket|Queue)/ ) {
+        my $object = $class->new( $session{CurrentUser} );
+        $object->Load($id);
+        if ( $object->Id ) {
+            if ( $object->CurrentUserCanSee ) {
+                push @objects, $object;
+            }
+            else {
+                $m->abort;
+            }
+        }
+        else {
+            RT->Logger->info("Couldn't load $item");
+            $m->abort;
+        }
+    }
+    else {
+        RT->Logger->info("Invalid object: $item");
+        $m->abort;
+    }
+}
+</%INIT>
+
+<%ARGS>
+$Objects => ''
+</%ARGS>
diff --git a/share/html/SelfService/Helpers/SelectOwnerDropdown b/share/html/SelfService/Helpers/SelectOwnerDropdown
@@ -0,0 +1,48 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC
+%#                                          <[email protected]>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+% $m->comp('/Helpers/SelectOwnerDropdown', %ARGS);
diff --git a/share/static/js/util.js b/share/static/js/util.js
@@ -1323,6 +1323,26 @@ jQuery(function () {
         beginInlineEdit(cell);
     });
 
+
+    jQuery(document).on('mouseenter', 'table.inline-edit td.editable .edit-icon', function (e) {
+        const owner_dropdown_delay = jQuery(this).closest('.editable').find('div.select-owner-dropdown-delay:not(.loaded)');
+        if ( owner_dropdown_delay.length ) {
+            owner_dropdown_delay.load(RT.Config.WebHomePath + '/Helpers/SelectOwnerDropdown', {
+                Name: owner_dropdown_delay.attr('data-name'),
+                Default: owner_dropdown_delay.attr('data-default'),
+                DefaultValue: owner_dropdown_delay.attr('data-default-value'),
+                DefaultLabel: owner_dropdown_delay.attr('data-default-label'),
+                ValueAttribute: owner_dropdown_delay.attr('data-value-attribute'),
+                Size: owner_dropdown_delay.attr('data-size'),
+                Objects: owner_dropdown_delay.attr('data-objects')
+            }, function () {
+                owner_dropdown_delay.addClass('loaded');
+                refreshSelectpicker(owner_dropdown_delay.find('.selectpicker'));
+                RT.Autocomplete.bind(owner_dropdown_delay);
+            });
+        }
+    });
+
     jQuery(document).on('change', 'td.editable.editing form :input', function () {
         jQuery(this).closest('form').data('changed', true);
     });