@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.3.1 (February 8, 2020)

• Remote App Registry Kubernetes: Show all Kubernetes services matching the pattern and a proper error message if no portal apps could be found. Remove portal apps after some time if the Kubernetes services disappeared.
• Remote App Registry: Added plugin config property to hide the Add a new Remote Portal App Endpoint form from the Admin UI
• Remote App Registry: Moved config properties from the Mashroom Portal Remote App Registry Webapp plugin to the Mashroom Portal Remote App Registry plugin where it belongs (BREAKING CHANGE)