@mashroom/mashroom

Mashroom Server

Mashroom Server is a Node.js based Microfrontend Integration Platform.

This package contains the core of Mashroom Server. It contains core services for managing plugins and default plugin loaders for Express middleware, Express webapps and shared code as services. It also provides a common logging infrastructure.

From a technical point of view this is s a plugin loader that scans npm packages (package.json) for plugin definitions and loads them at runtime. Such a plugin could be an Express webapp or a SPA or more generally all kind of code it knows how to load, which is determined by the available plugin loaders. Plugin loaders itself are also just plugins, so it is possible to extend the list of known plugin types.

Usage

The easiest way to start is to clone one of the quickstart repositories:

• mashroom-quickstart
• mashroom-portal-quickstart

You can find a full documentation with a setup and configuration guide here: https://www.mashroom-server.com/documentation

Changelog

2.1.0 (June 13, 2022)

• Portal: Re-check authentication expiration at least every 60sec, so, if the session for some reason expires (or gets revoked) the user will get notified faster.

• Core: Dropped Node.js 12.x support

• Portal: Prevent a loop if error messages can not be sent to the server

• MongoDB Session Provider: BREAKING CHANGE: Changed config structure to be able to pass parameters to connect-mongo, such as ttl and autoRemove.

  Before:

  {
    "uri": "mongodb://username:password@localhost:27017/mashroom_session_db?connectTimeoutMS=1000&socketTimeoutMS=2500",
    "collection": "sessions",
    "connectionOptions": {
      "poolSize": 5
    }
  }
  

  After:

  {
    "client": {
      "uri": "mongodb://username:password@localhost:27017/mashroom_session_db?connectTimeoutMS=1000&socketTimeoutMS=2500",
      "connectionOptions": {
         "poolSize": 5
      }
    },
    "collectionName": "sessions",
    "ttl": 86400
  }
  

• Redis Session Provider: BREAKING CHANGE: Changed config structure to be able to pass parameters to connect-redis, such as prefix and ttl. Setting prefix on this level instead of the Redis client level fixed the session count metric, which was broken.

  Before:

  {
    "redisOptions": {
      "host": "localhost",
      "port": "6379",
      "keyPrefix": "mashroom:sess:"
    },
    "cluster": false
  }
  

  After:

  {
    "client": {
      "redisOptions": {
        "host": "localhost",
        "port": "6379",
      },
      "cluster": false
    },
    "prefix": "mashroom:sess:",
    "ttl": 86400
  }
  

• Admin Toolbar: Only allow valid characters (according to RFC 3986) in Routes

• Admin Toolbar: Added checkbox for client-side routing and renamed friendlyUrl to Route because that's more what it is.

• Portal: Added support for client-side routing. If you enable it everything appended to the page URL is ignored.

• Portal: Added new property portalAppHost to the log context of Remote Portal Apps