@module-federation/node 0.2.1 → 0.3.0

package/README.md

@@ -1,4 +1,6 @@
-![banner image](./assets/banner.png)
+<p align="center">
+  <img src="https://github.com/module-federation/nextjs-mf/blob/main/packages/node/assets/banner.png" width="800"/>
+</p>
 <div align="center">
 	<!--  for version -->
   <img src="https://img.shields.io/npm/v/@module-federation/node" alt="version" >
@@ -101,6 +103,53 @@ const config = {
   ]
 }
 ```
+
+## Utilities
+
+This package also exposes a few utilities to help with the setup of your federated application.
+
+### revalidate
+
+Used to "hot reload" the federated application.
+- This is useful when you're developing your federated application and want to see changes without having to restart the server.
+- Also useful for production environments where you want to be able to update the federated application without having to restart the server.
+
+```js
+import {revalidate} from "@module-federation/node/utils";
+
+// we automatically reset require cache, so the reload callback is only if you need to do something else
+revalidate().then((shouldReload) => {
+  // do something extra after revalidation
+  if(shouldReload) { 
+    // reload the server
+  }
+});
+```
+
+**Hot reloading Express.js**
+
+Express has its own route stack, so reloading require cache will not be enough to reload the routes inside express.
+
+```js
+//express.js
+const app = express();
+
+global.clearRoutes = () => {
+  app._router.stack = app._router.stack.filter(
+    k => !(k && k.route && k.route.path)
+  )
+}
+
+// in some other file (within the scope of webpack build)
+// wherever you have your revalidation logic
+revalidate().then((shouldReload) => {
+  if(shouldReload) {
+    global.clearRoutes();
+  }
+});
+
+```
+
 ## 🔑 License
 - MIT @[ScriptedAlchemy](https://github.com/ScriptedAlchemy)
 
@@ -110,3 +159,4 @@ List of our amazing contributors 💥
 <a href="https://github.com/module-federation/nextjs-mf/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=module-federation/node" />
 </a>
+

package/package.json

@@ -1,9 +1,20 @@
 {
   "public": true,
   "name": "@module-federation/node",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "type": "commonjs",
   "main": "src/index.js",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.js"
+    },
+    "./package.json": "./package.json",
+    "./utils": {
+      "import": "./src/utils/index.js",
+      "require": "./src/utils/index.js"
+    }
+  },
   "types": "src/index.d.ts",
   "description": "Module Federation helper for Node",
   "repository": "https://github.com/module-federation/nextjs-mf/tree/main/packages/node",

package/src/index.d.ts

@@ -1,3 +1,4 @@
 export { default as StreamingTargetPlugin } from './plugins/StreamingTargetPlugin';
 export { default as NodeFederationPlugin } from './plugins/NodeFederationPlugin';
 export { default as UniversalFederationPlugin } from './plugins/UniversalFederationPlugin';
+export * from './utils/hot-reload';

package/src/index.js

@@ -1,13 +1,12 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UniversalFederationPlugin = exports.NodeFederationPlugin = exports.StreamingTargetPlugin = void 0;
+const tslib_1 = require("tslib");
 var StreamingTargetPlugin_1 = require("./plugins/StreamingTargetPlugin");
-Object.defineProperty(exports, "StreamingTargetPlugin", { enumerable: true, get: function () { return __importDefault(StreamingTargetPlugin_1).default; } });
+Object.defineProperty(exports, "StreamingTargetPlugin", { enumerable: true, get: function () { return tslib_1.__importDefault(StreamingTargetPlugin_1).default; } });
 var NodeFederationPlugin_1 = require("./plugins/NodeFederationPlugin");
-Object.defineProperty(exports, "NodeFederationPlugin", { enumerable: true, get: function () { return __importDefault(NodeFederationPlugin_1).default; } });
+Object.defineProperty(exports, "NodeFederationPlugin", { enumerable: true, get: function () { return tslib_1.__importDefault(NodeFederationPlugin_1).default; } });
 var UniversalFederationPlugin_1 = require("./plugins/UniversalFederationPlugin");
-Object.defineProperty(exports, "UniversalFederationPlugin", { enumerable: true, get: function () { return __importDefault(UniversalFederationPlugin_1).default; } });
+Object.defineProperty(exports, "UniversalFederationPlugin", { enumerable: true, get: function () { return tslib_1.__importDefault(UniversalFederationPlugin_1).default; } });
+tslib_1.__exportStar(require("./utils/hot-reload"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/node/src/index.ts"],"names":[],"mappings":";;;;;;AAAA,yEAAmF;AAA1E,+IAAA,OAAO,OAAyB;AACzC,uEAAiF;AAAxE,6IAAA,OAAO,OAAwB;AACxC,iFAA2F;AAAlF,uJAAA,OAAO,OAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/node/src/index.ts"],"names":[],"mappings":";;;;AAAA,yEAAmF;AAA1E,uJAAA,OAAO,OAAyB;AACzC,uEAAiF;AAAxE,qJAAA,OAAO,OAAwB;AACxC,iFAA2F;AAAlF,+JAAA,OAAO,OAA6B;AAC7C,6DAAkC"}

package/src/utils/hot-reload.d.ts

@@ -0,0 +1 @@
+export function revalidate(options: any): Promise<boolean>;

package/src/utils/hot-reload.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revalidate = void 0;
+const tslib_1 = require("tslib");
+const hashmap = {};
+const crypto_1 = tslib_1.__importDefault(require("crypto"));
+const revalidate = (options) => {
+    if (global.__remote_scope__) {
+        const remoteScope = global.__remote_scope__;
+        console.log('global.__remote_scope__', global.__remote_scope__);
+        return new Promise(async (res) => {
+            for (const property in remoteScope._config) {
+                let remote = remoteScope._config[property];
+                if (typeof remote === "function") {
+                    remote = await remote();
+                }
+                const name = property;
+                const url = remote;
+                (global.webpackChunkLoad || fetch)(url)
+                    .then((re) => {
+                    if (!re.ok) {
+                        throw new Error(`Error loading remote: status: ${re.status}, content-type: ${re.headers.get("content-type")}`);
+                    }
+                    return re.text();
+                })
+                    .then((contents) => {
+                    var hash = crypto_1.default.createHash("md5").update(contents).digest("hex");
+                    if (hashmap[name]) {
+                        if (hashmap[name] !== hash) {
+                            hashmap[name] = hash;
+                            console.log(name, "hash is different - must hot reload server");
+                            res(true);
+                        }
+                    }
+                    else {
+                        hashmap[name] = hash;
+                        res(false);
+                    }
+                })
+                    .catch((e) => {
+                    console.error("Remote", name, url, "Failed to load or is not online", e);
+                    res(false);
+                });
+            }
+        }).then((shouldReload) => {
+            if (!shouldReload) {
+                return false;
+            }
+            let req;
+            if (typeof __non_webpack_require__ === "undefined") {
+                req = require;
+            }
+            else {
+                req = __non_webpack_require__;
+            }
+            global.__remote_scope__ = {
+                _config: {},
+            };
+            Object.keys(req.cache).forEach((k) => {
+                if (k.includes("remote") ||
+                    k.includes("runtime") ||
+                    k.includes("server") ||
+                    k.includes("hot-reload") ||
+                    k.includes("react-loadable-manifest")) {
+                    delete req.cache[k];
+                }
+            });
+            return true;
+        });
+    }
+    return Promise.resolve(false);
+};
+exports.revalidate = revalidate;
+//# sourceMappingURL=hot-reload.js.map

package/src/utils/hot-reload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hot-reload.js","sourceRoot":"","sources":["../../../../../packages/node/src/utils/hot-reload.js"],"names":[],"mappings":";;;;AAAA,MAAM,OAAO,GAAG,EAAE,CAAC;AACnB,4DAA4B;AAErB,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,EAAE;IACpC,IAAI,MAAM,CAAC,gBAAgB,EAAE;QAC3B,MAAM,WAAW,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC/D,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC/B,KAAK,MAAM,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE;gBAC1C,IAAI,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE;oBAChC,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;iBACzB;gBACD,MAAM,IAAI,GAAG,QAAQ,CAAC;gBACtB,MAAM,GAAG,GAAG,MAAM,CAAC;gBACnB,CAAC,MAAM,CAAC,gBAAgB,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC;qBACpC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;oBACX,IAAG,CAAC,EAAE,CAAC,EAAE,EAAE;wBACT,MAAM,IAAI,KAAK,CAAC,iCAAiC,EAAE,CAAC,MAAM,mBAAmB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;qBAChH;oBACD,OAAO,EAAE,CAAC,IAAI,EAAE,CAAA;gBAClB,CAAC,CAAC;qBACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACjB,IAAI,IAAI,GAAG,gBAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACnE,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;wBACjB,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;4BAC1B,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;4BACrB,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,4CAA4C,CAAC,CAAC;4BAChE,GAAG,CAAC,IAAI,CAAC,CAAC;yBACX;qBACF;yBAAM;wBACL,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;wBACrB,GAAG,CAAC,KAAK,CAAC,CAAC;qBACZ;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACX,OAAO,CAAC,KAAK,CACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,iCAAiC,EACjC,CAAC,CACF,CAAC;oBACF,GAAG,CAAC,KAAK,CAAC,CAAC;gBACb,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;YACvB,IAAI,CAAC,YAAY,EAAE;gBACjB,OAAO,KAAK,CAAC;aACd;YACD,IAAI,GAAG,CAAC;YACR,IAAI,OAAO,uBAAuB,KAAK,WAAW,EAAE;gBAClD,GAAG,GAAG,OAAO,CAAC;aACf;iBAAM;gBACL,GAAG,GAAG,uBAAuB,CAAC;aAC/B;YAED,MAAM,CAAC,gBAAgB,GAAG;gBACxB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACnC,IACE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBACpB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACrB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBACpB,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACxB,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EACrC;oBACA,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBACrB;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC,CAAC;AAzEW,QAAA,UAAU,cAyErB"}

package/src/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./hot-reload";

package/src/utils/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./hot-reload"), exports);
+//# sourceMappingURL=index.js.map

package/src/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/node/src/utils/index.js"],"names":[],"mappings":";;;AAAA,uDAA4B"}