fix(nf-core): use nearest tsconfig.json when building a shared mapping + make build more robust in general

manfredsteyer · manfredsteyer · commit 5ad2a09dec5a · 2022-09-06T03:34:46.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/libs/native-federation-core/src/build.ts b/libs/native-federation-core/src/build.ts
@@ -12,7 +12,7 @@ export { MappedPath } from './lib/utils/mapped-paths';
 export { BuildAdapter } from './lib/core/build-adapter';
 export { withNativeFederation } from './lib/config/with-native-federation';
 export { buildForFederation } from './lib/core/build-for-federation';
-export { share, shareAll } from './lib/config/share-utils';
+export { share, shareAll, findRootTsConfigJson } from './lib/config/share-utils';
 export {
   federationBuilder,
   BuildHelperParams,
diff --git a/libs/native-federation-core/src/lib/config/federation-config.ts b/libs/native-federation-core/src/lib/config/federation-config.ts
@@ -1,3 +1,4 @@
+import { SkipList } from '../core/default-skip-list';
 import { MappedPath } from '../utils/mapped-paths';
 
 export interface SharedConfig {
@@ -13,7 +14,7 @@ export interface FederationConfig {
   exposes?: Record<string, string>;
   shared?: Record<string, SharedConfig>;
   sharedMappings?: Array<string>;
-  skip?: Array<string>;
+  skip?: SkipList;
 }
 
 export interface NormalizedSharedConfig {
diff --git a/libs/native-federation-core/src/lib/config/share-utils.ts b/libs/native-federation-core/src/lib/config/share-utils.ts
@@ -2,7 +2,7 @@ import path = require('path');
 import fs = require('fs');
 import { cwd } from 'process';
 import { SharedConfig } from './federation-config';
-import { DEFAULT_SKIP_LIST } from '../core/default-skip-list';
+import { DEFAULT_SKIP_LIST, isInSkipList, PREPARED_DEFAULT_SKIP_LIST, prepareSkipList, SkipList } from '../core/default-skip-list';
 
 let inferVersion = false;
 
@@ -104,6 +104,11 @@ function _findSecondaries(
     if (excludes.includes(secondaryLibName)) {
       continue;
     }
+
+    if (isInSkipList(secondaryLibName, PREPARED_DEFAULT_SKIP_LIST)) {
+      continue;
+    }
+
     acc[secondaryLibName] = { ...shareObject };
     _findSecondaries(s, excludes, shareObject, acc);
   }
@@ -196,6 +201,10 @@ function readConfiguredSecondaries(
       continue;
     }
 
+    if (isInSkipList(secondaryName, PREPARED_DEFAULT_SKIP_LIST)) {
+      continue;
+    }
+
     result[secondaryName] = {
       ...shareObject,
       // import: path.join(libPath, relPath)
@@ -207,7 +216,7 @@ function readConfiguredSecondaries(
 
 export function shareAll(
   config: CustomSharedConfig = {},
-  skip: string[] = [...DEFAULT_SKIP_LIST],
+  skip: SkipList = DEFAULT_SKIP_LIST,
   packageJsonPath = ''
 ): Config | null {
   if (!packageJsonPath) {
@@ -219,8 +228,10 @@ export function shareAll(
   const versions = readVersionMap(packagePath);
   const share: any = {};
 
+  const preparedSkipList = prepareSkipList(skip);
+
   for (const key in versions) {
-    if (skip.includes(key)) {
+    if (isInSkipList(key, preparedSkipList)) {
       continue;
     }
 
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
@@ -5,11 +5,13 @@ import {
   NormalizedFederationConfig,
   NormalizedSharedConfig,
 } from './federation-config';
+import { isInSkipList, PreparedSkipList, prepareSkipList } from '../core/default-skip-list';
 
 export function withNativeFederation(
   config: FederationConfig
 ): NormalizedFederationConfig {
-  const skip = new Set(config.skip) ?? new Set<string>();
+
+  const skip = prepareSkipList(config.skip ?? []);
 
   return {
     name: config.name ?? '',
@@ -21,7 +23,7 @@ export function withNativeFederation(
 
 function normalizeShared(
   config: FederationConfig,
-  skip: Set<string>
+  skip: PreparedSkipList
 ): Record<string, NormalizedSharedConfig> {
   let result: Record<string, NormalizedSharedConfig> = {};
 
@@ -52,7 +54,7 @@ function normalizeShared(
   }
 
   result = Object.keys(result)
-    .filter((key) => !skip.has(key))
+    .filter((key) => !isInSkipList(key, skip))
     .reduce(
       (acc, cur) => ({
         ...acc,
@@ -66,7 +68,7 @@ function normalizeShared(
 
 function normalizeSharedMappings(
   config: FederationConfig,
-  skip: Set<string>
+  skip: PreparedSkipList
 ): Array<MappedPath> {
   const rootTsConfigPath = findRootTsConfigJson();
 
@@ -75,7 +77,7 @@ function normalizeSharedMappings(
     sharedMappings: config.sharedMappings,
   });
 
-  const result = paths.filter((p) => !skip.has(p.key));
+  const result = paths.filter((p) => !isInSkipList(p.key, skip));
 
   return result;
 }
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
@@ -23,7 +23,7 @@ export async function bundleSharedMappings(
     try {
       await bundle({
         entryPoint: m.path,
-        tsConfigPath: fedOptions.tsConfig,
+        tsConfigPath: findTsConfig(m.path) ?? fedOptions.tsConfig,
         external: externals,
         outfile: outFilePath,
         mappedPaths: [],
@@ -60,3 +60,31 @@ export async function bundleSharedMappings(
 
   return result;
 }
+
+function findTsConfig(folder: string): string | null {
+  while (
+    !fs.existsSync(path.join(folder, 'tsconfig.lib.json')) &&
+    !fs.existsSync(path.join(folder, 'tsconfig.json')) &&
+    !fs.existsSync(path.join(folder, 'tsconfig.base.json')) &&
+    path.dirname(folder) !== folder
+  ) {
+    folder = path.dirname(folder);
+  }
+
+  const filePathOption0 = path.join(folder, 'tsconfig.lib.json');
+  if (fs.existsSync(filePathOption0)) {
+    return filePathOption0;
+  }
+
+  const filePathOption1 = path.join(folder, 'tsconfig.json');
+  if (fs.existsSync(filePathOption1)) {
+    return filePathOption1;
+  }
+
+  const filePathOption2 = path.join(folder, 'tsconfig.base.json');
+  if (fs.existsSync(filePathOption2)) {
+    return filePathOption2;
+  }
+
+  return null;
+}
diff --git a/libs/native-federation-core/src/lib/core/bundle-shared.ts b/libs/native-federation-core/src/lib/core/bundle-shared.ts
@@ -5,7 +5,6 @@ import { bundle } from '../utils/build-utils';
 import { getPackageInfo, PackageInfo } from '../utils/package-info';
 import { SharedInfo } from '@softarc/native-federation-runtime';
 import { FederationOptions } from './federation-options';
-import { DEFAULT_SKIP_LIST } from './default-skip-list';
 import { copySrcMapIfExists } from '../utils/copy-src-map-if-exists';
 
 export async function bundleShared(
@@ -14,9 +13,8 @@ export async function bundleShared(
   externals: string[]
 ): Promise<Array<SharedInfo>> {
   const result: Array<SharedInfo> = [];
-
   const packageInfos = Object.keys(config.shared)
-    .filter((packageName) => !DEFAULT_SKIP_LIST.has(packageName))
+    // .filter((packageName) => !isInSkipList(packageName, PREPARED_DEFAULT_SKIP_LIST))
     .map((packageName) => getPackageInfo(packageName, fedOptions.workspaceRoot))
     .filter((pi) => !!pi) as PackageInfo[];
 
@@ -39,14 +37,21 @@ export async function bundleShared(
     const cachedFile = path.join(cachePath, outFileName);
 
     if (!fs.existsSync(cachedFile)) {
-      await bundle({
-        entryPoint: pi.entryPoint,
-        tsConfigPath: fedOptions.tsConfig,
-        external: externals,
-        outfile: cachedFile,
-        mappedPaths: config.sharedMappings,
-        packageName: pi.packageName,
-      });
+      try {
+        await bundle({
+          entryPoint: pi.entryPoint,
+          tsConfigPath: fedOptions.tsConfig,
+          external: externals,
+          outfile: cachedFile,
+          mappedPaths: config.sharedMappings,
+          packageName: pi.packageName,
+        });
+      }
+      catch(e) {
+        console.error('Error bundling', pi.packageName);
+        console.info(`If you don't need this package, skip it in your federation.config.js!`);
+        continue;
+      }
     }
 
     const shared = config.shared[pi.packageName];
diff --git a/libs/native-federation-core/src/lib/core/default-skip-list.ts b/libs/native-federation-core/src/lib/core/default-skip-list.ts
@@ -1,8 +1,51 @@
-export const DEFAULT_SKIP_LIST = new Set([
-  '@softarc/module-federation-runtime',
-  '@softarc/module-federation-core',
-  '@softarc/module-federation',
+export type SkipFn = (name: string) => boolean;
+export type SkipListEntry = (string | RegExp | SkipFn);
+export type SkipList = SkipListEntry[];
+
+export const DEFAULT_SKIP_LIST: SkipList = [
+  '@softarc/native-federation-runtime',
+  '@softarc/native-federation',
+  '@softarc/native-federation-core',
+  '@softarc/native-federation-esbuild',
   '@angular-architects/native-federation',
   '@angular-architects/native-federation-runtime',
   'es-module-shims',
-]);
+  'zone.js',
+  'tslib',
+  /\/schematics(\/|$)/,
+  (pkg) => pkg.startsWith('@angular/') && !!pkg.match(/\/testing(\/|$)/)
+];
+
+export const PREPARED_DEFAULT_SKIP_LIST = prepareSkipList(DEFAULT_SKIP_LIST);
+
+export type PreparedSkipList = {
+  strings: Set<string>,
+  functions: SkipFn[],
+  regexps: RegExp[]
+}
+
+export function prepareSkipList(skipList: SkipList): PreparedSkipList {
+  return {
+    strings: new Set<string>(skipList.filter(e => typeof e === 'string') as string[]),
+    functions: skipList.filter(e => typeof e === 'function') as SkipFn[],
+    regexps: skipList.filter(e => typeof e === 'object') as RegExp[],
+  }
+}
+
+export function isInSkipList(entry: string, skipList: PreparedSkipList): boolean {
+
+  if (skipList.strings.has(entry)) {
+    return true;
+  }
+
+  if (skipList.functions.find(f => f(entry))) {
+    return true;
+  }
+
+  if (skipList.regexps.find(r => r.test(entry))) {
+    return true;
+  }
+
+  return false;
+
+}
diff --git a/libs/native-federation-core/src/lib/core/get-externals.ts b/libs/native-federation-core/src/lib/core/get-externals.ts
@@ -1,11 +1,12 @@
 import { NormalizedFederationConfig } from '../config/federation-config';
-import { DEFAULT_SKIP_LIST } from './default-skip-list';
+import { isInSkipList, PREPARED_DEFAULT_SKIP_LIST } from './default-skip-list';
 
 export function getExternals(config: NormalizedFederationConfig) {
   const shared = Object.keys(config.shared);
   const sharedMappings = config.sharedMappings.map((m) => m.key);
 
   const externals = [...shared, ...sharedMappings];
 
-  return externals.filter((p) => !DEFAULT_SKIP_LIST.has(p));
+  return externals;
+  // return externals.filter((p) => !isInSkipList(p, PREPARED_DEFAULT_SKIP_LIST));
 }
diff --git a/libs/native-federation-core/src/lib/utils/package-info.ts b/libs/native-federation-core/src/lib/utils/package-info.ts
@@ -9,6 +9,7 @@ export interface PackageInfo {
 
 export interface PartialPackageJson {
   module: string;
+  main: string;
 }
 
 export function getPackageInfo(
@@ -45,7 +46,7 @@ export function getPackageInfo(
   if (!relSecondaryPath) {
     relSecondaryPath = '.';
   } else {
-    relSecondaryPath = './' + relSecondaryPath;
+    relSecondaryPath = './' + relSecondaryPath.replace(/\\/g, '/');
   }
 
   let cand = mainPkgJson?.exports?.[relSecondaryPath]?.default;
@@ -91,6 +92,14 @@ export function getPackageInfo(
     };
   }
 
+  if (secondaryPgkJson && secondaryPgkJson.main) {
+    return {
+      entryPoint: path.join(secondaryPgkPath, secondaryPgkJson.main),
+      packageName,
+      version,
+    };
+  }
+
   cand = path.join(secondaryPgkPath, 'index.js');
   if (fs.existsSync(cand)) {
     return {
diff --git a/libs/native-federation-esbuild/src/lib/adapter.ts b/libs/native-federation-esbuild/src/lib/adapter.ts
@@ -19,7 +19,6 @@ export const esBuildAdapter: BuildAdapter = async (options) => {
 
   if (isPkg) {
     console.log('Preparing package ...');
-
     await prepareNodePackage(entryPoint, external, tmpFolder);
   }
 
@@ -34,6 +33,7 @@ export const esBuildAdapter: BuildAdapter = async (options) => {
     target: ["esnext"],
     plugins: [],
   });
+
 };
 
 async function prepareNodePackage(entryPoint: string, external: string[], tmpFolder: string) {
diff --git a/libs/native-federation/package.json b/libs/native-federation/package.json
@@ -15,7 +15,12 @@
     "url": "https://github.com/angular-architects/module-federation-plugin"
   },
   "dependencies": {
-    "@angular-architects/build-angular": "^14.2.0-next.0"
-
+    "@angular-architects/build-angular": "^14.2.0-next.0",
+    "@rollup/plugin-commonjs": "^22.0.2",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-replace": "^4.0.0",
+    "rollup": "^2.79.0",
+    "rollup-plugin-node-externals": "^4.1.1",
+    "esbuild": "^0.15.5"
   }
 }
diff --git a/libs/native-federation/src/config.ts b/libs/native-federation/src/config.ts
@@ -3,4 +3,4 @@ export {
   findRootTsConfigJson,
   share,
   shareAll,
-} from '@angular-architects/module-federation/webpack';
+} from '@softarc/native-federation/build';
diff --git a/libs/native-federation/src/utils/angular-esbuild-adapter.ts b/libs/native-federation/src/utils/angular-esbuild-adapter.ts
@@ -4,15 +4,15 @@ import { createCompilerPlugin } from '@angular-devkit/build-angular/src/builders
 import { createSharedMappingsPlugin } from './shared-mappings-plugin';
 import { prepareNodePackage } from './prepare-node-package';
 
-const SKIP_PACKAGE_PREPARATION = ['@angular', '@ngrx', 'rxjs'];
+const SKIP_PACKAGE_PREPARATION = ['@angular', '@ngrx', 'rxjs', 'zone.js'];
 
 export const AngularEsBuildAdapter: BuildAdapter = async (options) => {
   const { entryPoint, tsConfigPath, external, outfile, mappedPaths, packageName } = options;
 
   const pNameOrEmpty = packageName ?? '';
 
   const preparePackage = entryPoint.includes("node_modules")
-    &&  !SKIP_PACKAGE_PREPARATION.find(p => pNameOrEmpty === p);
+    &&  !SKIP_PACKAGE_PREPARATION.find(p => pNameOrEmpty?.split('/')[0] === p);
 
   const pkgName = preparePackage ? inferePkgName(entryPoint) : "";
   const tmpFolder = `node_modules/.tmp/native-federation/${pkgName}`;
@@ -28,6 +28,7 @@ export const AngularEsBuildAdapter: BuildAdapter = async (options) => {
     bundle: true,
     sourcemap: true,
     minify: true,
+    platform: 'node',
     format: 'esm',
     target: ['esnext'],
     plugins: [
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.tgz b/softarc-native-federation-1.0.0.tgz
diff --git a/update-local.bat b/update-local.bat
