Add user image signature to URL and inform browsers to cache it

As URL contains image signature now, it's quite safe to cache it for a long time, here we cache it for 1 month.
bestpractical · Dec 30, 2024 · 5b49505 · 5b49505
1 parent 92c5801
commit 5b49505
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/lib/RT/User.pm b/lib/RT/User.pm
@@ -2448,6 +2448,11 @@ sub Image {
     return;
 }
 
+sub ImageSignature {
+    my $self = shift;
+    return Digest::SHA::sha1_hex($self->_Value('Image'));
+}
+
 =head2 Create PARAMHASH
 
 Create takes a hash of values and creates a row in the database:
@@ -2966,6 +2971,12 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 
 =cut
 
+=head2 ImageSignature
+
+Returns the user's image SHA-1 signature.
+
+=cut
+
 =head2 Creator
 
 Returns the current value of Creator. 

diff --git a/share/html/Elements/ShowUserImage b/share/html/Elements/ShowUserImage
@@ -53,4 +53,4 @@ $Class => 'rt-user-image'
 </%args>
 <%init>
 </%init>
-<img class="<%$Class%> img-fluid rounded" alt="Image for user <%$Tooltip%>" title="<%$Tooltip%>" src="<% $session{CurrentUser}->Privileged ? '' : '/SelfService' %>/Helpers/UserImage/<%$User->Id%>" loading="lazy" />
+<img class="<%$Class%> img-fluid rounded" alt="Image for user <%$Tooltip%>" title="<%$Tooltip%>" src="<% $session{CurrentUser}->Privileged ? '' : '/SelfService' %>/Helpers/UserImage/<%$User->Id%>-<% $User->ImageSignature %>" loading="lazy" />
diff --git a/share/html/Helpers/UserImage/dhandler b/share/html/Helpers/UserImage/dhandler
@@ -46,6 +46,7 @@
 %#
 %# END BPS TAGGED BLOCK }}}
 <%perl>
+$m->comp('/Elements/HttpResponseHeaders', MaxAgeSeconds => 24 * 3600 * 30);
 my $user_id;
 my $arg = $m->dhandler_arg;    # get rest of path
 if ( $arg =~ m{^(\d+)} ) {

diff --git a/t/web/helpers-http-cache-headers.t b/t/web/helpers-http-cache-headers.t
@@ -116,6 +116,10 @@ diag "set up expected date headers";
       'Cache-Control' => 'max-age=2592000, public',
       'Expires'       => 'Sun, 05 May 2013 15:28:19 GMT',
     },
+    UserImage   => {
+      'Cache-Control' => 'max-age=2592000, private',
+      'Expires'       => 'Sun, 05 May 2013 15:28:19 GMT',
+    },
     default      => {
       'Cache-Control' => 'no-cache, max-age=0',
       'Expires'       => 'Fri, 05 Apr 2013 15:27:49 GMT',
@@ -143,6 +147,8 @@ foreach my $endpoint ( @endpoints ) {
     $header_key =  'Autocomplete';
   } elsif ( $endpoint =~ m/NoAuth|static/ ) {
     $header_key =  'NoAuth';
+  } elsif ( $endpoint =~ m/UserImage/ ) {
+    $header_key =  'UserImage';
   }
   my $headers = $expected->{$header_key};