Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-25385

Review all Web UI dynamic and static resources http caching strategy

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 9.10
    • Fix Version/s: 10.3
    • Component/s: Web Common, Web UI
    • Release Notes Summary:
      Improved caching strategy
    • Epic Link:
    • Tags:
    • Browser:
    • Upgrade notes:
      Hide

      Note that filterConfig <pattern> contributions now match the full path and query parameter of the URI (previously the query parameter was not included).

      Thumbnails, blobs and nxfile resources can have the doc changeToken appended as a query params for optimized http caching.

          <filterConfig name="cachedBPR" cached="true" private="true" cacheTime="31536000" transactional="true">
      <!-- if url contains doc changeToken: approximately one year -->
      <pattern>${org.nuxeo.ecm.contextPath}/.*/@(blob|preview|rendition).*\\?.*changeToken=.+</pattern>
    </filterConfig>
   
    <filterConfig name="cachednxfile" transactional="false" synchonize="false" cached="true" private="true" cacheTime="31536000">
      <!-- if url contains doc changeToken: approximately one year -->
      <!-- transaction is manually handled in DownloadServlet -->
      <pattern>${org.nuxeo.ecm.contextPath}/nxfile/.*\\?.*changeToken=.+</pattern>
    </filterConfig>

      Otherwise, we let eTag play.

      Show
      Note that filterConfig <pattern> contributions now match the full path and query parameter of the URI (previously the query parameter was not included). Thumbnails, blobs and nxfile resources can have the doc changeToken appended as a query params for optimized http caching. <filterConfig name= "cachedBPR" cached= " true " private = " true " cacheTime= "31536000" transactional= " true " > <!-- if url contains doc changeToken: approximately one year --> <pattern>${org.nuxeo.ecm.contextPath}/.*/@(blob|preview|rendition).*\\?.*changeToken=.+</pattern> </filterConfig> <filterConfig name= "cachednxfile" transactional= " false " synchonize= " false " cached= " true " private = " true " cacheTime= "31536000" > <!-- if url contains doc changeToken: approximately one year --> <!-- transaction is manually handled in DownloadServlet --> <pattern>${org.nuxeo.ecm.contextPath}/nxfile/.*\\?.*changeToken=.+</pattern> </filterConfig> Otherwise, we let eTag play.
    • Sprint:
      nxGang Sprint 10.3.1, nxGang Sprint 10.3.2, nxGang Sprint 10.3.3, nxGang Sprint 10.3.4
    • Story Points:
      2

      Description

      Since NXP-23026 and https://github.com/nuxeo/nuxeo/commit/d13bb493d6f17f4cb4abc4d9fb61c7ff08b7fbe6, the server sends in all response the no-store http header which prevents the browser from leveraging the eTag.

      As a direct results, Web UI is fetching and refetching far too many resources such as thumbnails, previews, and blob throuhg nxfile servlet path (for pdf viewer for instance).

      I understand we don't want to display obsolete resources when for instance we edit a document to change its main blob, we want the change to be reflected asap in the preview (and do not display the old preview).

      However, since the tomcat sends the eTag of the resource, we should make the browser leverage the If-None-Match http header to check if its locally cached resource is up to date and only download it again if obsolete.

      Setting cache to true but cacheTime to 0 will make the browser send the If-None-Match: xxxxx where xxxx is the previously received eTag.

      Useful reading BTW: https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching

        Attachments

          Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. NXP-23439 Preview is not updated after using direct edit

          • Blocker - Blocks development and/or testing work, production could not run.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXP-25100 Fix JSF performance issue due to lack of cache on browser side

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. NXP-25700 Add service worker to allow for more agressive cache

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXBT-2398 Fix nightly Apache front cache config

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXP-26411 Thumbnail redirect is cached for a longer period of time than the S3 link validity

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXDOC-1588 Add a Web UI doc about performance tweaks to promote scalability

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXP-25595 Cache invalidation of lazy loaded elements is inconsistent

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXS-4978 Automated document type label translation failed on 10.2

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. ELEMENTS-726 Fix nuxeo-document-preview performances

          • Major - Major loss of function.
          • Resolved

          Task - A task that needs to be done. NXP-25139 Update cache headers for Web UI static resources

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is required by

          Bug - A problem which impairs or prevents the functions of the product. NXP-28815 Fix ThumbnailJsonEnricherTest on MongoDB

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. NBM-915 Upgrade to 10.3

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. NBM-789 Cloud front improvments : caching, alerts, etc

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 2 days, 1 minute Original Estimate - 2 days, 1 minute
                  2d 1m
                  Remaining:
                  Time Spent - 2 days Remaining Estimate - 1 day, 1 minute
                  1d 1m
                  Logged:
                  Time Spent - 2 days Remaining Estimate - 1 day, 1 minute
                  2d