Patch #37600

Cache attachments and thumbnails in web browsers

Added by Go MAEDA about 1 month ago. Updated about 1 month ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Performance
Target version:Candidate for next major release

Description

The attached patch adds "max-age" value to "Cache-Control" filed in response headers of AttachmentController#download and AttachmentController#thumbnail in order to reduce the number of requests to a Redmine server and speed up page loading especially when an issue or a Wiki page has dozens of inline images and thumbnails.

Before:

Cache-Control: private

After:

Cache-Control: max-age=86400, private

In my observation, some users attach about 100 or more images to an issue. Even if they access the issue again shortly after it was accessed, their browser sends many GET requests to AttachmentController#download and AttachmentController#thumbnail to revalidate their local cache. Each of those requests that receive "304 Not Modified" consumes a few tens of milliseconds of server time.

By adding "max-age: 86400" to "Cache-Control" header field, web browsers will cache images and thumbnails and will not make revalidate requests for 24 hours, which improves page loading speed and reduces server load.

In Redmine, the content of attachments and thumbnails with the same URL is immutable. So there is no need to frequently revalidate the local cache and it is safe to keep the cache for some time.

It is safe to keep caches of attachments and thumbnails for some time because the content of attachments and thumbnails with the same URL is immutable in Redmine. And there is no need to frequently revalidate the local cache.

cache-attachments-and-thumbnails.patch Magnifier (3.05 KB) Go MAEDA, 2022-08-24 05:13

History

#1 Updated by Go MAEDA about 1 month ago

  • Target version set to Candidate for next major release

#2 Updated by Holger Just about 1 month ago

Iirc we generally avoid to allow explicit caching for anything because different user may have different access permissions and those could change quickly.

Thus, when allowing caching, we should make sure that the contents of the cache is not leaked to different users which may potentially happen at different places:

  • public / centralized caches (such as enterprise proxy servers or CDNs) - if we allow caching here, the cache key must be tied to the user id in the session. As far as I'm aware, this is not possible right now with "public" information just from the single request. As such, we can not allow those caches at all.
  • local browser-based caches - Here, we may potentially allow some kind of caching. If I understand the Cache-Control rules correctly, this is what you aim to enable here.

We should still investigate if this change allows for leaking the cache contents to different users e.g. after a logout or when multiple users are using a single browser. I'm not entirely sure, if this scenario is something we have to protect against, but I'd like to discuss the potential ramifications of this for an informed decision.

Another different (and possibly more common) scenario might be when users first access a Redmine as Anonymous and later login in, which would cause them to see different attachments.

Generally, if we decide that it is possible to allow private caches for some data, I think it would indeed improve performance for attachments as they are in fact immutable after creation.

Also available in: Atom PDF