feat(nf-core): add debug mode with more information in remote entry

manfredsteyer · manfredsteyer · commit b066df2fa003 · 2022-09-20T22:11:28.000+02:00
diff --git a/angular-architects-module-federation-14.3.10.tgz b/angular-architects-module-federation-14.3.10.tgz
diff --git a/angular-architects-native-federation-0.9.2.tgz b/angular-architects-native-federation-0.9.2.tgz
diff --git a/libs/mf/src/schematics/mf/files/webpack.config.js__tmpl__ b/libs/mf/src/schematics/mf/files/webpack.config.js__tmpl__
@@ -2,7 +2,7 @@ const { shareAll, withModuleFederationPlugin } = require('@angular-architects/mo
 
 module.exports = withModuleFederationPlugin({
 <% if (type === 'remote') { %>
-  name: 'mfe1',
+  name: '<%=project%>',
 
   exposes: {
     './Component': './<%=projectSourceRoot%>/app/app.component.ts',
diff --git a/libs/native-federation-core/package.json b/libs/native-federation-core/package.json
@@ -1,8 +1,9 @@
 {
   "name": "@softarc/native-federation",
-  "version": "1.0.0",
+  "version": "1.0.0-beta.1",
   "type": "commonjs",
   "dependencies": {
-    "json5": "^2.2.0"
+    "json5": "^2.2.0",
+    "npmlog": "^6.0.2"
   }
 }
diff --git a/libs/native-federation-core/src/build.ts b/libs/native-federation-core/src/build.ts
@@ -9,7 +9,7 @@ export { bundleExposed } from './lib/core/bundle-exposed';
 export { getExternals } from './lib/core/get-externals';
 export { loadFederationConfig } from './lib/core/load-federation-config';
 export { MappedPath } from './lib/utils/mapped-paths';
-export { BuildAdapter } from './lib/core/build-adapter';
+export { BuildAdapter, BuildAdapterOptions } from './lib/core/build-adapter';
 export { withNativeFederation } from './lib/config/with-native-federation';
 export { buildForFederation } from './lib/core/build-for-federation';
 export {
diff --git a/libs/native-federation-core/src/lib/config/with-native-federation.ts b/libs/native-federation-core/src/lib/config/with-native-federation.ts
@@ -82,7 +82,7 @@ function normalizeSharedMappings(
   });
 
   const result = paths.filter(
-    (p) => !isInSkipList(p.key, skip) && p.key.includes('*')
+    (p) => !isInSkipList(p.key, skip) && !p.key.includes('*')
   );
 
   if (paths.find((p) => p.key.includes('*'))) {
diff --git a/libs/native-federation-core/src/lib/core/bundle-exposed.ts b/libs/native-federation-core/src/lib/core/bundle-exposed.ts
@@ -6,6 +6,7 @@ import { ExposesInfo } from '@softarc/native-federation-runtime';
 import { hashFile } from '../utils/hash-file';
 import { FederationOptions } from './federation-options';
 import { logger } from '../utils/logger';
+import { normalize } from '../utils/normalize';
 
 export async function bundleExposed(
   config: NormalizedFederationConfig,
@@ -19,6 +20,11 @@ export async function bundleExposed(
     const outFilePath = path.join(options.outputPath, outFileName);
     const entryPoint = config.exposes[key];
 
+    const localPath = normalize(path.join(
+        options.workspaceRoot, 
+        config.exposes[key]
+    ));
+
     logger.info(`Bundling exposed module ${entryPoint}`);
 
     try {
@@ -37,9 +43,17 @@ export async function bundleExposed(
         options.outputPath,
         hashedOutFileName
       );
+
       fs.renameSync(outFilePath, hashedOutFilePath);
 
-      result.push({ key, outFileName: hashedOutFileName });
+      result.push({ 
+        key, 
+        outFileName: hashedOutFileName, 
+        debug: !options.debug ? undefined : {
+          localPath
+        }  
+      });
+      
     } catch (e) {
       logger.error('Error bundling exposed module ' + entryPoint);
       logger.error(e);
diff --git a/libs/native-federation-core/src/lib/core/bundle-shared-mappings.ts b/libs/native-federation-core/src/lib/core/bundle-shared-mappings.ts
@@ -6,6 +6,7 @@ import { SharedInfo } from '@softarc/native-federation-runtime';
 import { hashFile } from '../utils/hash-file';
 import { FederationOptions } from '../core/federation-options';
 import { logger } from '../utils/logger';
+import { normalize } from '../utils/normalize';
 
 export async function bundleSharedMappings(
   config: NormalizedFederationConfig,
@@ -46,6 +47,9 @@ export async function bundleSharedMappings(
         singleton: true,
         strictVersion: false,
         version: '',
+        debug: !fedOptions.debug ? undefined : {
+          entryPoint: normalize(m.path)
+        }
       });
     } catch (e) {
       // TODO: add logger
diff --git a/libs/native-federation-core/src/lib/core/bundle-shared.ts b/libs/native-federation-core/src/lib/core/bundle-shared.ts
@@ -8,6 +8,7 @@ import { FederationOptions } from './federation-options';
 import { copySrcMapIfExists } from '../utils/copy-src-map-if-exists';
 import { logger } from '../utils/logger';
 import { hashFile } from '../utils/hash-file';
+import { normalize } from '../utils/normalize';
 
 export async function bundleShared(
   config: NormalizedFederationConfig,
@@ -20,10 +21,10 @@ export async function bundleShared(
     .map((packageName) => getPackageInfo(packageName, fedOptions.workspaceRoot))
     .filter((pi) => !!pi) as PackageInfo[];
 
-  logger.notice('Shared packages are only bundled once as they are cached');
-  logger.notice(
-    'Make sure, you skip all unneeded packages in your federation.config.js!'
-  );
+  // logger.notice('Shared packages are only bundled once as they are cached');
+  // logger.notice(
+  //   'Make sure, you skip all unneeded packages in your federation.config.js!'
+  // );
 
   const federationConfigPath = path.join(
     fedOptions.workspaceRoot,
@@ -32,8 +33,7 @@ export async function bundleShared(
   const hash = hashFile(federationConfigPath);
 
   for (const pi of packageInfos) {
-    // TODO: add logger
-    logger.info('Bundling shared package ' + pi.packageName);
+    // logger.info('Bundling shared package ' + pi.packageName);
 
     const encName = pi.packageName.replace(/[^A-Za-z0-9]/g, '_');
     const encVersion = pi.version.replace(/[^A-Za-z0-9]/g, '_');
@@ -50,6 +50,9 @@ export async function bundleShared(
     const cachedFile = path.join(cachePath, outFileName);
 
     if (!fs.existsSync(cachedFile)) {
+
+      logger.info('Preparing shared package ' + pi.packageName);
+
       try {
         await bundle({
           entryPoint: pi.entryPoint,
@@ -84,6 +87,9 @@ export async function bundleShared(
       singleton: shared.singleton,
       strictVersion: shared.strictVersion,
       version: pi.version,
+      debug: !fedOptions.debug ? undefined : {
+        entryPoint: normalize(pi.entryPoint),
+      }
     });
 
     const fullOutputPath = path.join(
diff --git a/libs/native-federation-core/src/lib/core/federation-builder.ts b/libs/native-federation-core/src/lib/core/federation-builder.ts
@@ -1,6 +1,8 @@
+import { SharedInfo } from '@softarc/native-federation';
 import { NormalizedFederationConfig } from '../config/federation-config';
 import { BuildAdapter, setBuildAdapter } from './build-adapter';
 import { buildForFederation } from './build-for-federation';
+import { bundleShared } from './bundle-shared';
 import { FederationOptions } from './federation-options';
 import { getExternals } from './get-externals';
 import { loadFederationConfig } from './load-federation-config';
@@ -25,10 +27,18 @@ async function build(): Promise<void> {
   buildForFederation(config, fedOptions, externals);
 }
 
+async function buildShared(): Promise<SharedInfo[]> {
+  return bundleShared(config, fedOptions, externals);
+}
+
 export const federationBuilder = {
   init,
   build,
+  buildShared,
   get externals(): string[] {
     return externals;
   },
+  get config(): NormalizedFederationConfig {
+    return config;
+  }
 };
diff --git a/libs/native-federation-core/src/lib/core/federation-options.ts b/libs/native-federation-core/src/lib/core/federation-options.ts
@@ -4,4 +4,5 @@ export interface FederationOptions {
   federationConfig: string;
   tsConfig?: string;
   verbose?: boolean;
+  debug?: boolean;
 }
diff --git a/libs/native-federation-core/src/lib/utils/normalize.ts b/libs/native-federation-core/src/lib/utils/normalize.ts
@@ -0,0 +1,3 @@
+export function normalize(path: string): string {
+    return path.replace(/\\/g,'/');
+}
diff --git a/libs/native-federation-esbuild/package.json b/libs/native-federation-esbuild/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@softarc/native-federation-esbuild",
-  "version": "1.0.0",
+  "version": "1.0.0-beta.1",
   "type": "commonjs",
   "dependencies": {
     "@rollup/plugin-commonjs": "^22.0.2",
diff --git a/libs/native-federation-esbuild/src/lib/adapter.ts b/libs/native-federation-esbuild/src/lib/adapter.ts
@@ -1,4 +1,4 @@
-import { BuildAdapter } from '@softarc/native-federation/build';
+import { BuildAdapter, BuildAdapterOptions } from '@softarc/native-federation/build';
 import * as esbuild from 'esbuild';
 import { rollup } from 'rollup';
 import resolve from '@rollup/plugin-node-resolve';
@@ -10,30 +10,41 @@ const commonjs = require('@rollup/plugin-commonjs');
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const replace = require('@rollup/plugin-replace');
 
-export const esBuildAdapter: BuildAdapter = async (options) => {
-  const { entryPoint, external, outfile } = options;
+export const esBuildAdapter: BuildAdapter = createEsBuildAdapter({
+  plugins: []
+});
 
-  const isPkg = entryPoint.includes('node_modules');
-  const pkgName = isPkg ? inferePkgName(entryPoint) : '';
-  const tmpFolder = `node_modules/.tmp/${pkgName}`;
+export interface EsBuildAdapterConfig {
+  plugins: esbuild.Plugin[];
+}
 
-  if (isPkg) {
-    console.log('Preparing package ...');
-    await prepareNodePackage(entryPoint, external, tmpFolder);
-  }
+export function createEsBuildAdapter(config: EsBuildAdapterConfig) {
+  return async (options: BuildAdapterOptions) => {
+    const { entryPoint, external, outfile } = options;
 
-  await esbuild.build({
-    entryPoints: [isPkg ? tmpFolder : entryPoint],
-    external,
-    outfile,
-    bundle: true,
-    sourcemap: true,
-    minify: true,
-    format: 'esm',
-    target: ['esnext'],
-    plugins: [],
-  });
-};
+    const isPkg = entryPoint.includes('node_modules');
+    const pkgName = isPkg ? inferePkgName(entryPoint) : '';
+    const tmpFolder = `node_modules/.tmp/${pkgName}`;
+
+    if (isPkg) {
+      await prepareNodePackage(entryPoint, external, tmpFolder);
+    }
+
+    await esbuild.build({
+      entryPoints: [isPkg ? tmpFolder : entryPoint],
+      external,
+      outfile,
+      bundle: true,
+      sourcemap: true,
+      minify: true,
+      format: 'esm',
+      target: ['esnext'],
+      plugins: [
+        ...config.plugins
+      ],
+    });
+  };
+}
 
 async function prepareNodePackage(
   entryPoint: string,
@@ -67,5 +78,5 @@ async function prepareNodePackage(
 function inferePkgName(entryPoint: string) {
   return entryPoint
     .replace(/.*?node_modules/g, '')
-    .replace(/[^A-Za-z0-9\.]/g, '_');
+    .replace(/[^A-Za-z0-9.]/g, '_');
 }
diff --git a/libs/native-federation-runtime/package.json b/libs/native-federation-runtime/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@softarc/native-federation-runtime",
-  "version": "1.0.0",
+  "version": "1.0.0-beta.1",
   "peerDependencies": {},
   "dependencies": {
     "tslib": "^2.3.0"
diff --git a/libs/native-federation-runtime/src/lib/model/federation-info.ts b/libs/native-federation-runtime/src/lib/model/federation-info.ts
@@ -5,11 +5,17 @@ export type SharedInfo = {
   version?: string;
   packageName: string;
   outFileName: string;
+  debug?: {
+    entryPoint: string;
+  }
 };
 
 export interface ExposesInfo {
   key: string;
   outFileName: string;
+  debug?: {
+    localPath: string;
+  };
 }
 
 export interface FederationInfo {
diff --git a/libs/native-federation/package.json b/libs/native-federation/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@angular-architects/native-federation",
-  "version": "1.0.0-beta.1",
+  "version": "0.9.2",
   "main": "src/index.js",
   "generators": "./collection.json",
   "builders": "./builders.json",
@@ -23,10 +23,12 @@
     "rollup-plugin-node-externals": "^4.1.1",
     "esbuild": "^0.15.5",
     "@babel/core": "^7.19.0",
-    "@softarc/native-federation": "1.0.0",
-    "@softarc/native-federation-runtime": "1.0.0",
+    "@softarc/native-federation": "1.0.0-beta.1",
+    "@softarc/native-federation-runtime": "1.0.0-beta.1",
     "@rollup/plugin-json": "^4.1.0",
-    "cross-spawn": "^7.0.3"
+    "cross-spawn": "^7.0.3",
+    "rollup-plugin-terser": "^7.0.2",
+    "npmlog": "^6.0.2"
   },
   "peerDependencies": {
     "@angular/compiler-cli": "*"
diff --git a/libs/native-federation/src/utils/angular-esbuild-adapter.ts b/libs/native-federation/src/utils/angular-esbuild-adapter.ts
@@ -44,6 +44,7 @@ async function link(outfile: string) {
       compact: false,
       configFile: false,
       babelrc: false,
+      minified: true,
       browserslistConfigFile: false,
       plugins: [linker],
     });
diff --git a/libs/native-federation/src/utils/rollup.ts b/libs/native-federation/src/utils/rollup.ts
@@ -7,6 +7,7 @@ import { rollup } from 'rollup';
 import resolve from '@rollup/plugin-node-resolve';
 import { externals } from 'rollup-plugin-node-externals';
 import { logger } from '@softarc/native-federation/build';
+import { terser } from "rollup-plugin-terser";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const commonjs = require('@rollup/plugin-commonjs');
@@ -17,6 +18,9 @@ const replace = require('@rollup/plugin-replace');
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const json = require('@rollup/plugin-json');
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+
+
 export async function runRollup(
   entryPoint: string,
   external: string[],
@@ -39,6 +43,7 @@ export async function runRollup(
             'process.env.NODE_ENV': '"development"',
           },
         }),
+        terser(),
       ],
     });
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/softarc-native-federation-1.0.0-beta.1.tgz b/softarc-native-federation-1.0.0-beta.1.tgz
diff --git a/softarc-native-federation-runtime-1.0.0-beta.1.tgz b/softarc-native-federation-runtime-1.0.0-beta.1.tgz
diff --git a/softarc-native-federation-runtime-1.0.0.tgz b/softarc-native-federation-runtime-1.0.0.tgz
diff --git a/update-local.bat b/update-local.bat

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@softarc/native-federation",`
`3`		`- "version": "1.0.0",`
	`3`	`+ "version": "1.0.0-beta.1",`
`4`	`4`	`"type": "commonjs",`
`5`	`5`	`"dependencies": {`
`6`		`- "json5": "^2.2.0"`
	`6`	`+ "json5": "^2.2.0",`
	`7`	`+ "npmlog": "^6.0.2"`
`7`	`8`	`}`
`8`	`9`	`}`