Community Wiki
Page tree
Skip to end of metadata
  • Created on 2020-02-11, last edited by Richard Gange on 2021-02-04
Go to start of metadata
Magnolia Compatibility


6.2(tick)
6.1(tick)
5.7(tick)

The HTML Compressor module helps to keep the size of a responses to a minimum. By reducing the response size we will increase transfer speed while decreasing the bandwidth.  

Installation

Maven is the easiest way to install the module. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.html</groupId>
  <artifactId>magnolia-html-compressor</artifactId>
  <version>5.7</version> <!-- Magnolia 5 & 6 -->
</dependency>

Source

The source for this module can be found here: https://git.magnolia-cms.com/users/rgange/repos/html-compressor/browse

Issues, Bugs and Improvements

Please comment at the bottom of this page.

Usage

The module uses a filter to compress html responses to a minimum size.

Configuration

The filter is highly configureable. Using bypasses and mappings just about any file could be compressed. 

The module provides an additional filter extending from OncePerRequestAbstractMgnlFilter with two additional configurations: 

Class: info.magnolia.html.compressor.filter.HtmlCompressorFilter

compressCss

optional, false

Should the filter compress style blocks within HTML files.

compressJavaScript

optional, false

Should the filter compress script blocks within HTML files.

Bypasses

There are four bypass configurations bootstrapped with the filter. These bypasses help control which files should be minimized and which files should not be minimized.

  • extensions: This configuration controls which types of files should be minimized. By default only requests for HTML. Here you can add additional extensions as necessary.

    This configuration has a not property reversing the logic and essentially turning the bypass into a mapping. In other words, do not bypass these allowed extensions. This is how to map requests using extension found in the AggregationState.

  • admincentral: Requests to /.magnolia/admincentral are not minimized.
  • vaadin-resources: Requests to resources in a VAADIN folder are not minimized. 
  • minimized: Requests to resources which contain .min. are not minimized. It's assumed that this is a flag in the filename indicating the file is already in a minimized state. Further processing is not needed.

Mappings

By default there are not any mappings configured but you can map specific URIs to the filter. For example, rather than use an entire extension to map you can target specific files or folders by using a mapping configuration. 

Example

Here is an example using the contact page from the demo site.

With compression:

Without compression:

Warnings

  • Compression will add more time to the initial request of the page. However, it will reduce the size of the file in the cache.
  • Careful when changing mappings. While it's possible to compress any file type in some cases, such as admincentral, minimizing supporting files can break the application. 
  • Using compressJavaScript can lead to exceptions. If you do embed JavaScript it's a good idea to check the compression in UAT.  MGNLDEMO-332 - Getting issue details... STATUS  

Changelog

2 Comments

  1. Training Participants - FullStack Developer

    Hi,


    It will be very helpfull to see an example for Mappings configuration. Right now using the extensions configuration it's working only if we don't have user friendly url. For example if we have the url /home.html it's working, but if we use it /home it's not working anymore since it's not recognizing the extension html.


    Thank you. 

    1. Richard Gange

      Hello-

      Please create your own account for commenting. You can signup here: https://jira.magnolia-cms.com/secure/Signup!default.jspa

      You can see an example of the mapping here: server/filters/servlets/RestDispatcherServlet/mappings

      Create the mapping first then delete the bypasses node. 

      HTH