jigsaw-mf v1.0.0

A micro-frontend solution.

Introduction

jigsaw is a micro-frontend solution for assembling mutiple micro applications into the master application to make the site perform like a Single-Page application! Or by leveraging jigsaw, you can split your huge application into small parts to improve maintablity!

• support any JavaScript user interface librarys. such as React, vue etc... as long as you can control when to mount/unmout your application!
• support comunications between micro-applications.

Terminology

micro-application a small application that can be assembled into a large application.

master-application the main application that host one or many micro-application

Installations

npm install jigsaw --save

How to use

Adapt existing application to a micro-application

1. add a config or update your application config file.

// src/config/application.json
{
    // applicaion must be built as a library, and this is the library name. [used by webpack]
    "library": "reactfather",
    // assets must be linked by absolute path. [used by webpack]
    "publicPath": "http://localhost:8082"
}

2. add a new entry file

// src/index-app.js
import React from "react";
import ReactDOM from "react-dom";
import App from "./App";
// adding line 1,2,3 if your application serve both as master-application and micro-application!
// otherwise omit them.
import { appPool } from "./global"; // line 1

export default {
  // triggered when your code is executed but before mount
  bootstrap() {
    console.log("react app bootstraped");
  },
  mount(contain, baseUrl) {
    appPool.baseUrl = baseUrl; // line 2. current application MUST inherit its parent's baseUrl
    ReactDOM.render(<App baseUrl={baseUrl} />, contain);
  },
  unmount(contain) {
    appPool.unregisterAllApps(); // line 3
    ReactDOM.unmountComponentAtNode(contain);
  }
};

3. update webapck config

{
    /**  omit the other config  **/
    entry: {
      /** your other entry **/
      app: './src/index-app.js'
    },
    output: {
      /** your other config **/
      publicPath: config.publicPath,
      libraryTarget: 'umd',
      library: config.library
    }
    /**  omited  **/
    new HtmlWebpackPlugin({
        inject: true,
        chunks: ["app"],
        filename: 'app.html'
    })

    // postcss-selector-namespace
}

NOTE: The css and js assets will be accessed by master-application via ajax, so those assets need to support CORS request

Adapt existing application to a master-application

1. add a config or update your application config file

// src/config/application.json
{
    // the url base path your site serves  e.g. /your/path.
    "baseUrl": "/"
}

2. create jigsaw instance. It's a good convention to put your global variables into one single module instead of assigning it to window

// src/global.js
import Jigsaw from "jigsaw";
import appConfig from "../config/application.json"; // created by step 1

export const appPool = new Jigsaw(appConfig);
export const other_global_var = "your data";

3. resgister micro-application

// add this code to any position as long as `container1` exists. usually after `componentDidMount` if your are using react.

import { appPool } from "./global";

const appinfo = [
  {
    // the unique name amount the micro-applications. [required]
    name: "a49",
    // the library name of the micro-application. eg. config.library. [required]
    applicationName: "reactfather",
    routerMode: 'history', // hash | history. default: 'history'. [optional]
    // webpack.entry.app. [required]
    entry: "http://localhost:8082/app.html",
    contain: document.getElementById("container1"), // or use refs to gain dom reference. [required]
    // the base path allocated to this micro-application, relative to `appPool.baseUrl`. [required]
    baseUrl: "/reactchild",
    // to determine if to mount this micro-application. [optional]
    canActive = (baseUrl, basePath) => {
      return window.location.pathname.startsWith(basePath) && window.location.hash.startsWith("#" + baseUrl)
    }; // default for `hash` mode
    canActive = (baseUrl, basePath) => window.location.pathname.startsWith(baseUrl); // default for `history` mode
  }
];

appPool.registerApps(appinfo);

Now, run both your master-application and micro-application, and you will see it works.

Comunication

event based comunication via eventemitter2

// application internal comunication
import { appPool } from "./global";
appPool.on("event", function(data) {
  console.log(data); // output: internal message
});
appPool.emit("event", "internal message");

// cross micro-application comunication
// application 1
import { globalEvent } from "east-mfs";
globalEvent.on("event", function(data) {
  console.log(data); // output: global message
});

// application 2
import { globalEvent } from "east-mfs";
globalEvent.emit("event", "global message");

About css isolation

try postcss-selector-namespace

Run Example

git clone this repertory
cd jigsaw
npm install
npm run init
npm run run:fragment
// open http://localhost:9100

Html Entry

By default, jigsaw will use the last js file as the execution entry. but you can change this behavior by adding attribute entry.

<script src='http://localhost:3000/a.js' entry>

And by adding attribute ignore, you can tell jigsaw to ignore this file.

<script src='http://localhost:3000/a.js' ignore>

Tips

An application can be adapted to serve both as master-application and micro-application!

1. DO NOT adding exact prop to route when the corresponding component will register some micro-applications, it might prevent your micro-application from showing!
2. All the JS and CSS resources linked by your micro-application must use absolute path. e.g. http://localhost:9001/your/resource/path
3. Micro-application MUST be packed through umd mode with unique library name.
4. Micro-application must support CORS request for the JS/CSS files.

Known Issues

1. Registering micro-application that under development mode with hot reload enabled will cause white screen.
2. When the master application is using hash router mode, the micro-application beneath can NOT be history mode.

License

MIT