@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 this package as dependency.

After that you can use the service like this:

// @flow

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

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.0.93 (August 27, 2019)

• Portal: Added configuration property to automatically extend the authentication (so it stays valid as long as the browser page is opened)
• Portal: Removed the "auto-logout" feature, instead the Portal warns now when the authentication is about to expire.
• Decoupled authentication from session, in particular the authentication expiration. This simplifies the implementation for providers like OAuth2. BREAKING CHANGE: The MashroomSecurityProvider interface has been extended.