@module-federation/native-federation-tests 0.1.0

package/README.md

@@ -0,0 +1,157 @@
+# native-federation-tests
+
+Bundler agnostic plugins to share federated components for testing purposes.
+
+It aims to work for both [`vitest`](https://vitest.dev/) and [`jest`](https://jestjs.io/).
+
+## Install
+
+```bash
+npm i -D @module-federation/native-federation-tests
+```
+
+This module provides two plugins:
+
+### NativeFederationTestsRemote
+This plugin is used to concat the components that will be used in tests.
+
+#### Configuration
+```typescript
+{
+    moduleFederationConfig: any; // the same configuration provided to the module federation plugin, it is MANDATORY
+    additionalBundlerConfig?: TsupOptions; // additional `tsup` build options that will be merged with the one generated by the plugin, default is {}
+    distFolder?: string; // folder used to store the dist, default is './dist'
+    testsFolder?: string; // folder where all the files will be stored, default is '@mf-tests'
+    deleteTestsFolder?: boolean; // indicate if the concatenated components folder will be deleted when the job completes, default is 'true'
+}
+```
+
+#### Additional configuration
+Note that, for Webpack, the plugin automatically inject the `devServer.static.directory` configuration.  
+For the other bundlers, you should configure it by yourself.
+
+### NativeFederationTestsHost
+This plugin is used to download the concatenated components mock that will be used for tests.
+
+### Configuration
+
+```typescript
+{
+    moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
+    testsFolder?: string; // folder where all the files have been stored, default is '@mf-tests',
+    mocksFolder?: string; // folder where the concatenated files will be stored, default is './__mocks__',
+    deleteTestsFolder?: boolean; // indicate if the tests mock folder will be deleted before the job starts, default is 'true'
+}
+```
+
+## Bundler configuration
+
+<details>
+<summary>Vite</summary><br>
+
+```ts
+// vite.config.ts
+import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/vite'
+
+export default defineConfig({
+  plugins: [
+    NativeFederationTestsRemote({ /* options */ }),
+    NativeFederationTestsHost({ /* options */ }),
+  ],
+  /* ... */
+  server: { // This is needed to emulate the devServer.static.directory of WebPack and correctly serve the zip file
+    /* ... */
+    proxy: {
+      '/@mf-types.zip': {
+          target: 'http://localhost:3000',
+          changeOrigin: true,
+          rewrite: () => `/@fs/${process.cwd()}/dist/@mf-types.zip`
+      }
+    },
+    fs: {
+      /* ... */
+      allow: ['./dist']
+      /* ... */
+    }
+  }
+})
+```
+
+<br>
+</details>
+<details>
+<summary>Rollup</summary><br>
+
+```ts
+// rollup.config.js
+import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/rollup'
+
+export default {
+  plugins: [
+    NativeFederationTestsRemote({ /* options */ }),
+    NativeFederationTestsHost({ /* options */ }),
+  ],
+}
+```
+
+<br>
+</details>
+<details>
+<summary>Webpack</summary><br>
+
+```ts
+// webpack.config.js
+const {NativeFederationTestsHost, NativeFederationTestsRemote} = require('@module-federation/native-federation-tests/webpack')
+module.exports = {
+  /* ... */
+  plugins: [
+    NativeFederationTestsRemote({ /* options */ }),
+    NativeFederationTestsHost({ /* options */ })
+  ]
+}
+```
+
+<br>
+</details>
+<details>
+<summary>esbuild</summary><br>
+
+```ts
+// esbuild.config.js
+import { build } from 'esbuild'
+import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/esbuild'
+
+build({
+  plugins: [
+    NativeFederationTestsRemote({ /* options */ }),
+    NativeFederationTestsHost({ /* options */ })
+  ],
+})
+```
+
+<br>
+</details>
+
+<details>
+<summary>Rspack</summary><br>
+
+```ts
+// rspack.config.js
+const {NativeFederationTestsHost, NativeFederationTestsRemote} = require('@module-federation/native-federation-tests/rspack')
+
+module.exports = {
+  /* ... */
+  plugins: [
+    NativeFederationTestsRemote({ /* options */ }),
+    NativeFederationTestsHost({ /* options */ })
+  ]
+}
+```
+
+<br>
+</details>
+
+## Examples
+
+To use it in a `host` module, refer to [this example](https://github.com/ilteoood/module-federation-typescript/tree/host).  
+To use it in a `remote` module, refer to [this example](https://github.com/ilteoood/module-federation-typescript/tree/remote).

package/dist/RemoteOptions-ae724cfa.d.ts

@@ -0,0 +1,18 @@
+import { Options } from 'tsup';
+
+interface HostOptions {
+    moduleFederationConfig: any;
+    testsFolder?: string;
+    mocksFolder?: string;
+    deleteTestsFolder?: boolean;
+}
+
+interface RemoteOptions {
+    moduleFederationConfig: any;
+    additionalBundlerConfig?: Options;
+    distFolder?: string;
+    testsFolder?: string;
+    deleteTestsFolder?: boolean;
+}
+
+export { HostOptions as H, RemoteOptions as R };

package/dist/chunk-NLBUZNVY.mjs

@@ -0,0 +1 @@
+import m from"ansi-colors";import{rm as q}from"fs/promises";import{resolve as S}from"path";import{mergeDeepRight as $,mergeRight as D}from"rambda";import{build as U}from"tsup";import{createUnplugin as O}from"unplugin";var R={testsFolder:"@mf-tests",mocksFolder:"./__mocks__",deleteTestsFolder:!0},w=(o,e)=>{let t=e.split("@").at(-1),r=new URL(t);return r.pathname=`${o.testsFolder}.zip`,r.href},x=o=>Object.entries(o.moduleFederationConfig.remotes).reduce((e,[t,r])=>(e[t]=w(o,r),e),{}),c=o=>{if(!o.moduleFederationConfig)throw new Error("moduleFederationConfig is required");let e={...R,...o},t=x(e);return{hostOptions:e,mapRemotesToDownload:t}};import{existsSync as v}from"fs";import{join as d}from"path";var y={testsFolder:"@mf-tests",distFolder:"./dist",deleteTestsFolder:!0,additionalBundlerConfig:{}},h=["ts","tsx","js","jsx","mjs"],p=o=>{let e=process.cwd();for(let t of h){let r=d(e,`${o}.${t}`);if(v(r))return r}},C=o=>Object.entries(o.moduleFederationConfig.exposes).reduce((e,[t,r])=>(e[t]=p(r)||p(d(r,"index"))||r,e),{}),a=o=>{if(!o.moduleFederationConfig)throw new Error("moduleFederationConfig is required");let e={...y,...o},t=C(e),r=Object.keys(o.moduleFederationConfig.shared||{}).concat(Object.keys(o.moduleFederationConfig.remotes||{})),s=d(e.distFolder,e.testsFolder);return{remoteOptions:e,externalDeps:r,compiledFilesFolder:s,mapComponentsToExpose:t}};import l from"adm-zip";import T from"ansi-colors";import b from"axios";import{join as f}from"path";var k=o=>f(o.distFolder,`${o.testsFolder}.zip`),u=async(o,e)=>{let t=new l;return t.addLocalFolder(e),t.writeZipPromise(k(o))},H=(o,e)=>t=>{throw console.error(T.red(`Unable to download federated mocks for '${o}' from '${e}' because '${t.message}', skipping...`)),t},g=o=>async([e,t])=>{let r=await b.get(t,{responseType:"arraybuffer"}).catch(H(e,t)),s=f(o.mocksFolder,e);new l(Buffer.from(r.data)).extractAllTo(s,!0)};import{rm as j}from"fs/promises";import{join as E}from"path";var F=async(o,e)=>{let t=e.map(r=>{let s=E(o.mocksFolder,r);return j(s,{recursive:!0,force:!0})});return Promise.allSettled(t)};var se=O(o=>{let{remoteOptions:e,compiledFilesFolder:t,externalDeps:r,mapComponentsToExpose:s}=a(o);return{name:"native-federation-tests/remote",async writeBundle(){let n=D(e.additionalBundlerConfig,{external:r.map(i=>new RegExp(i)),entry:s,outDir:t,silent:!0});try{await U(n),await u(e,t),e.deleteTestsFolder&&await q(t,{recursive:!0,force:!0}),console.log(m.green("Federated mocks created correctly"))}catch(i){console.error(m.red(`Unable to build federated mocks: ${i}`))}},webpack:n=>{n.options.devServer=$(n.options.devServer||{},{static:{directory:S(e.distFolder)}})}}}),ne=O(o=>{let{hostOptions:e,mapRemotesToDownload:t}=c(o);return{name:"native-federation-tests/host",async writeBundle(){e.deleteTestsFolder&&await F(e,Object.keys(t));let r=g(e),s=Object.entries(t).map(r);await Promise.allSettled(s),console.log(m.green("Federated mocks extraction completed"))}}});export{se as a,ne as b};

package/dist/chunk-Z276SNUU.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _ansicolors = require('ansi-colors'); var _ansicolors2 = _interopRequireDefault(_ansicolors);var _promises = require('fs/promises');var _path = require('path');var _rambda = require('rambda');var _tsup = require('tsup');var _unplugin = require('unplugin');var R={testsFolder:"@mf-tests",mocksFolder:"./__mocks__",deleteTestsFolder:!0},w=(o,e)=>{let t=e.split("@").at(-1),r=new URL(t);return r.pathname=`${o.testsFolder}.zip`,r.href},x=o=>Object.entries(o.moduleFederationConfig.remotes).reduce((e,[t,r])=>(e[t]=w(o,r),e),{}),c=o=>{if(!o.moduleFederationConfig)throw new Error("moduleFederationConfig is required");let e={...R,...o},t=x(e);return{hostOptions:e,mapRemotesToDownload:t}};var _fs = require('fs');var y={testsFolder:"@mf-tests",distFolder:"./dist",deleteTestsFolder:!0,additionalBundlerConfig:{}},h=["ts","tsx","js","jsx","mjs"],p=o=>{let e=process.cwd();for(let t of h){let r=_path.join.call(void 0, e,`${o}.${t}`);if(_fs.existsSync.call(void 0, r))return r}},C=o=>Object.entries(o.moduleFederationConfig.exposes).reduce((e,[t,r])=>(e[t]=p(r)||p(_path.join.call(void 0, r,"index"))||r,e),{}),a=o=>{if(!o.moduleFederationConfig)throw new Error("moduleFederationConfig is required");let e={...y,...o},t=C(e),r=Object.keys(o.moduleFederationConfig.shared||{}).concat(Object.keys(o.moduleFederationConfig.remotes||{})),s=_path.join.call(void 0, e.distFolder,e.testsFolder);return{remoteOptions:e,externalDeps:r,compiledFilesFolder:s,mapComponentsToExpose:t}};var _admzip = require('adm-zip'); var _admzip2 = _interopRequireDefault(_admzip);var _axios = require('axios'); var _axios2 = _interopRequireDefault(_axios);var k=o=>_path.join.call(void 0, o.distFolder,`${o.testsFolder}.zip`),u=async(o,e)=>{let t=new _admzip2.default;return t.addLocalFolder(e),t.writeZipPromise(k(o))},H=(o,e)=>t=>{throw console.error(_ansicolors2.default.red(`Unable to download federated mocks for '${o}' from '${e}' because '${t.message}', skipping...`)),t},g=o=>async([e,t])=>{let r=await _axios2.default.get(t,{responseType:"arraybuffer"}).catch(H(e,t)),s=_path.join.call(void 0, o.mocksFolder,e);new (0, _admzip2.default)(Buffer.from(r.data)).extractAllTo(s,!0)};var F=async(o,e)=>{let t=e.map(r=>{let s=_path.join.call(void 0, o.mocksFolder,r);return _promises.rm.call(void 0, s,{recursive:!0,force:!0})});return Promise.allSettled(t)};var se=_unplugin.createUnplugin.call(void 0, o=>{let{remoteOptions:e,compiledFilesFolder:t,externalDeps:r,mapComponentsToExpose:s}=a(o);return{name:"native-federation-tests/remote",async writeBundle(){let n=_rambda.mergeRight.call(void 0, e.additionalBundlerConfig,{external:r.map(i=>new RegExp(i)),entry:s,outDir:t,silent:!0});try{await _tsup.build.call(void 0, n),await u(e,t),e.deleteTestsFolder&&await _promises.rm.call(void 0, t,{recursive:!0,force:!0}),console.log(_ansicolors2.default.green("Federated mocks created correctly"))}catch(i){console.error(_ansicolors2.default.red(`Unable to build federated mocks: ${i}`))}},webpack:n=>{n.options.devServer=_rambda.mergeDeepRight.call(void 0, n.options.devServer||{},{static:{directory:_path.resolve.call(void 0, e.distFolder)}})}}}),ne= exports.b =_unplugin.createUnplugin.call(void 0, o=>{let{hostOptions:e,mapRemotesToDownload:t}=c(o);return{name:"native-federation-tests/host",async writeBundle(){e.deleteTestsFolder&&await F(e,Object.keys(t));let r=g(e),s=Object.entries(t).map(r);await Promise.allSettled(s),console.log(_ansicolors2.default.green("Federated mocks extraction completed"))}}});exports.a = se; exports.b = ne;

package/dist/esbuild.d.ts

@@ -0,0 +1,7 @@
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: (options: RemoteOptions) => undefined;
+declare const NativeFederationTestsHost: (options: HostOptions) => undefined;
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/esbuild.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');var o=_chunkZ276SNUUjs.a.esbuild,a= exports.NativeFederationTestsHost =_chunkZ276SNUUjs.b.esbuild;exports.NativeFederationTestsHost = a; exports.NativeFederationTestsRemote = o;

package/dist/esbuild.mjs

@@ -0,0 +1 @@
+import{a as e,b as t}from"./chunk-NLBUZNVY.mjs";var o=e.esbuild,a=t.esbuild;export{a as NativeFederationTestsHost,o as NativeFederationTestsRemote};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import * as unplugin from 'unplugin';
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: unplugin.UnpluginInstance<RemoteOptions, boolean>;
+declare const NativeFederationTestsHost: unplugin.UnpluginInstance<HostOptions, boolean>;
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');exports.NativeFederationTestsHost = _chunkZ276SNUUjs.b; exports.NativeFederationTestsRemote = _chunkZ276SNUUjs.a;

package/dist/index.mjs

@@ -0,0 +1 @@
+import{a,b}from"./chunk-NLBUZNVY.mjs";export{b as NativeFederationTestsHost,a as NativeFederationTestsRemote};

package/dist/rollup.d.ts

@@ -0,0 +1,7 @@
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: (options: RemoteOptions) => undefined | undefined[];
+declare const NativeFederationTestsHost: (options: HostOptions) => undefined | undefined[];
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/rollup.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');var s=_chunkZ276SNUUjs.a.rollup,a= exports.NativeFederationTestsHost =_chunkZ276SNUUjs.b.rollup;exports.NativeFederationTestsHost = a; exports.NativeFederationTestsRemote = s;

package/dist/rollup.mjs

@@ -0,0 +1 @@
+import{a as e,b as t}from"./chunk-NLBUZNVY.mjs";var s=e.rollup,a=t.rollup;export{a as NativeFederationTestsHost,s as NativeFederationTestsRemote};

package/dist/rspack.d.ts

@@ -0,0 +1,7 @@
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: (options: RemoteOptions) => RspackPluginInstance;
+declare const NativeFederationTestsHost: (options: HostOptions) => RspackPluginInstance;
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/rspack.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');var o=_chunkZ276SNUUjs.a.rspack,a= exports.NativeFederationTestsHost =_chunkZ276SNUUjs.b.rspack;exports.NativeFederationTestsHost = a; exports.NativeFederationTestsRemote = o;

package/dist/rspack.mjs

@@ -0,0 +1 @@
+import{a as e,b as t}from"./chunk-NLBUZNVY.mjs";var o=e.rspack,a=t.rspack;export{a as NativeFederationTestsHost,o as NativeFederationTestsRemote};

package/dist/vite.d.ts

@@ -0,0 +1,7 @@
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: (options: RemoteOptions) => any;
+declare const NativeFederationTestsHost: (options: HostOptions) => any;
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/vite.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');var s=_chunkZ276SNUUjs.a.vite,i= exports.NativeFederationTestsHost =_chunkZ276SNUUjs.b.vite;exports.NativeFederationTestsHost = i; exports.NativeFederationTestsRemote = s;

package/dist/vite.mjs

@@ -0,0 +1 @@
+import{a as t,b as e}from"./chunk-NLBUZNVY.mjs";var s=t.vite,i=e.vite;export{i as NativeFederationTestsHost,s as NativeFederationTestsRemote};

package/dist/webpack.d.ts

@@ -0,0 +1,7 @@
+import { R as RemoteOptions, H as HostOptions } from './RemoteOptions-ae724cfa.js';
+import 'tsup';
+
+declare const NativeFederationTestsRemote: (options: RemoteOptions) => undefined;
+declare const NativeFederationTestsHost: (options: HostOptions) => undefined;
+
+export { NativeFederationTestsHost, NativeFederationTestsRemote };

package/dist/webpack.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZ276SNUUjs = require('./chunk-Z276SNUU.js');var s=_chunkZ276SNUUjs.a.webpack,a= exports.NativeFederationTestsHost =_chunkZ276SNUUjs.b.webpack;exports.NativeFederationTestsHost = a; exports.NativeFederationTestsRemote = s;

package/dist/webpack.mjs

@@ -0,0 +1 @@
+import{a as e,b as t}from"./chunk-NLBUZNVY.mjs";var s=e.webpack,a=t.webpack;export{a as NativeFederationTestsHost,s as NativeFederationTestsRemote};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@module-federation/native-federation-tests",
+  "version": "0.1.0",
+  "description": "Bundler agnostic unplugin to share federated tests",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./rollup": {
+      "types": "./dist/rollup.d.ts",
+      "require": "./dist/rollup.js",
+      "import": "./dist/rollup.mjs"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "require": "./dist/vite.js",
+      "import": "./dist/vite.mjs"
+    },
+    "./webpack": {
+      "types": "./dist/webpack.d.ts",
+      "require": "./dist/webpack.js",
+      "import": "./dist/webpack.mjs"
+    },
+    "./esbuild": {
+      "types": "./dist/esbuild.d.ts",
+      "require": "./dist/esbuild.js",
+      "import": "./dist/esbuild.mjs"
+    },
+    "./rspack": {
+      "types": "./dist/rspack.d.ts",
+      "require": "./dist/rspack.js",
+      "import": "./dist/rspack.mjs"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "keywords": [
+    "module federation",
+    "tests",
+    "remote tests",
+    "federated tests"
+  ],
+  "author": "Matteo Pietro Dazzi <matteopietro.dazzi@gmail.com> (https://github.com/ilteoood)",
+  "license": "MIT",
+  "dependencies": {
+    "adm-zip": "^0.5.10",
+    "ansi-colors": "^4.1.3",
+    "axios": "^1.3.4",
+    "rambda": "^7.5.0",
+    "tsup": "^6.7.0",
+    "unplugin": "^1.3.1"
+  }
+}