@mashroom/mashroom-browser-cache

Mashroom Browser Cache

Plugin for Mashroom Server, a Integration Platform for Microfrontends.

This plugin adds a Service to manage cache control headers. It allows to disable the cache globally.

Usage

If node_modules/@mashroom is configured as plugin path just add @mashroom/mashroom-browser-cache as dependency.

After that you can use the service like this:

// @flow

import type {MashroomCacheControlService} from '@mashroom/mashroom-browser-cache/type-definitions';

export default async (req: ExpressRequest, res: ExpressResponse) => {

    const cacheControlService: MashroomCacheControlService = req.pluginContext.services.browserCache.cacheControl;
    await cacheControlService.addCacheControlHeader(req, res);

    // ..
};

You can override the default config in your Mashroom config file like this:

{
  "plugins": {
        "Mashroom Cache Control Services": {
            "disabled": false,
            "disabledWhenAuthenticated": false,
            "maxAgeSec": 1800
        }
    }
}

• disabled: Disable browser caching (default: false)
• disabledWhenAuthenticated: Disable browser caching when the user is authenticated (default: false)
• maxAgeSec: Max age in seconds (default: 1800)

Services

MashroomCacheControlService

The Cache Control service is accessible through pluginContext.services.browserCache.cacheControl

Interface:

export interface MashroomCacheControlService {

     /**
      * Add the Cache-Control header based on the settings and authentication status
      */
     addCacheControlHeader(request: ExpressRequest, response: ExpressResponse): Promise<void>;

     /**
      * Remove a previously set Cache-Control header
      */
     removeCacheControlHeader(response: ExpressResponse): void;

}

Changelog

1.4.2 (April 25, 2020)

• Security Provider: Added new method getApiSecurityHeaders(req, targetUri) that allows it to add security headers to backend/API calls. Useful to add extra user context or access tokens to backend requests.
• Portal: Removed the REST proxy property sendRoles because the concept of permissions should be used in backends as well.
• Portal: If the REST proxy property sendUserHeaders is true the following headers will be sent additionally with each REST request:
  • X-USER-DISPLAY-NAME
  • X-USER-EMAIL
• Portal: Fixed mapping Sites to virtual hosts when the frontend base path is /
• Virtual host path mapper: Added a config property to explicitly set the http headers that should be considered (default is x-forwarded-host) to determine the actual host