@softarc/native-federation 4.0.0-RC2 → 4.0.0-RC4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softarc/native-federation",
-  "version": "4.0.0-RC2",
+  "version": "4.0.0-RC4",
   "type": "module",
   "license": "MIT",
   "dependencies": {

package/src/internal.d.ts

@@ -5,7 +5,7 @@ export { logger, setLogLevel } from './lib/utils/logger.js';
 export type { MappedPath } from './lib/domain/utils/mapped-path.contract.js';
 export { RebuildQueue } from './lib/utils/rebuild-queue.js';
 export { AbortedError } from './lib/utils/errors.js';
-export { createBuildResultMap, lookupInResultMap } from './lib/utils/build-result-map.js';
+export { createBuildResultMap, lookupInResultMap, popFromResultMap, } from './lib/utils/build-result-map.js';
 export { writeImportMap } from './lib/core/write-import-map.js';
 export type { NormalizedExternalConfig, NormalizedSharedExternalsConfig, } from './lib/domain/config/external-config.contract.js';
 export type { NormalizedFederationConfig } from './lib/domain/config/federation-config.contract.js';

package/src/internal.js

@@ -4,5 +4,5 @@ export * from './lib/utils/errors.js';
 export { logger, setLogLevel } from './lib/utils/logger.js';
 export { RebuildQueue } from './lib/utils/rebuild-queue.js';
 export { AbortedError } from './lib/utils/errors.js';
-export { createBuildResultMap, lookupInResultMap } from './lib/utils/build-result-map.js';
+export { createBuildResultMap, lookupInResultMap, popFromResultMap, } from './lib/utils/build-result-map.js';
 export { writeImportMap } from './lib/core/write-import-map.js';

package/src/lib/core/build-for-federation.js

@@ -6,6 +6,7 @@ import { logger } from '../utils/logger.js';
 import { getCachePath } from './../utils/bundle-caching.js';
 import { normalizePackageName } from '../utils/normalize.js';
 import { AbortedError } from '../utils/errors.js';
+import { resolveProjectName } from '../utils/config-utils.js';
 export const defaultBuildParams = {
     skipMappingsAndExposed: false,
     skipShared: false,
@@ -22,11 +23,7 @@ export async function buildForFederation(config, fedOptions, externals, buildPar
             throw new AbortedError('[buildForFederation] After exposed-and-mappings bundle');
     }
     const exposedInfo = !artifactInfo ? describeExposed(config, fedOptions) : artifactInfo.exposes;
-    const normalizedCacheFolder = normalizePackageName(config.name);
-    if (normalizedCacheFolder.length < 1) {
-        logger.warn("Project name in 'federation.config.js' is empty, defaulting to 'shell' cache folder (could collide with other projects in the workspace).");
-    }
-    const cacheProjectFolder = normalizedCacheFolder.length < 1 ? 'shell' : normalizedCacheFolder;
+    const cacheProjectFolder = resolveProjectName(config);
     const pathToCache = getCachePath(fedOptions.workspaceRoot, cacheProjectFolder);
     if (!buildParams.skipShared && sharedCache.externals.length > 0) {
         logger.info('Checksum matched, re-using cached externals.');
@@ -92,6 +89,9 @@ export async function buildForFederation(config, fedOptions, externals, buildPar
     if (sharedCache.chunks) {
         federationInfo.chunks = sharedCache.chunks;
     }
+    if (artifactInfo?.chunks) {
+        federationInfo.chunks = { ...(federationInfo.chunks ?? {}), ...artifactInfo?.chunks };
+    }
     writeFederationInfo(federationInfo, fedOptions);
     writeImportMap(sharedCache, fedOptions);
     return federationInfo;

package/src/lib/core/bundle-exposed-and-mappings.js

@@ -1,10 +1,11 @@
 import fs from 'fs';
 import path from 'path';
-import { createBuildResultMap, lookupInResultMap } from '../utils/build-result-map.js';
+import { createBuildResultMap, popFromResultMap } from '../utils/build-result-map.js';
 import { bundle } from '../utils/build-utils.js';
 import { logger } from '../utils/logger.js';
 import { normalize } from '../utils/normalize.js';
 import { AbortedError } from '../utils/errors.js';
+import { rewriteChunkImports } from '../utils/rewrite-chunk-imports.js';
 export async function bundleExposedAndMappings(config, fedOptions, externals, signal) {
     if (signal?.aborted) {
         throw new AbortedError('[bundle-exposed-and-mappings] Aborted before bundling');
@@ -33,6 +34,8 @@ export async function bundleExposedAndMappings(config, fedOptions, externals, si
             watch: fedOptions.watch,
             mappedPaths: config.sharedMappings,
             kind: 'mapping-or-exposed',
+            chunks: (typeof fedOptions.chunks === 'boolean' && fedOptions.chunks) ||
+                (typeof fedOptions.chunks === 'object' && !!fedOptions.chunks.enable),
             hash,
             optimizedMappings: config.features.ignoreUnusedDeps,
             signal,
@@ -49,10 +52,13 @@ export async function bundleExposedAndMappings(config, fedOptions, externals, si
     }
     const resultMap = createBuildResultMap(result, hash);
     const sharedResult = [];
+    const entryFiles = [];
+    // Pick shared-mappings
     for (const item of shared) {
+        const distEntryFile = popFromResultMap(resultMap, item.outName);
         sharedResult.push({
             packageName: item.key,
-            outFileName: lookupInResultMap(resultMap, item.outName),
+            outFileName: path.basename(distEntryFile),
             requiredVersion: '',
             singleton: true,
             strictVersion: false,
@@ -63,20 +69,37 @@ export async function bundleExposedAndMappings(config, fedOptions, externals, si
                     entryPoint: normalize(path.normalize(item.fileName)),
                 },
         });
+        entryFiles.push(distEntryFile);
     }
     const exposedResult = [];
+    // Pick exposed-modules
     for (const item of exposes) {
+        const distEntryFile = popFromResultMap(resultMap, item.outName);
         exposedResult.push({
             key: item.key,
-            outFileName: lookupInResultMap(resultMap, item.outName),
+            outFileName: path.basename(distEntryFile),
             dev: !fedOptions.dev
                 ? undefined
                 : {
                     entryPoint: normalize(path.join(fedOptions.workspaceRoot, item.fileName)),
                 },
         });
+        entryFiles.push(distEntryFile);
     }
-    return { mappings: sharedResult, exposes: exposedResult };
+    // Remove .map files
+    Object.keys(resultMap)
+        .filter(f => f.endsWith('.map'))
+        .forEach(f => popFromResultMap(resultMap, f));
+    // Process remaining chunks and lazy loaded internal modules
+    let exportedChunks = undefined;
+    if (typeof fedOptions.chunks === 'object' && fedOptions.chunks.dense === true) {
+        for (const entryFile of entryFiles)
+            rewriteChunkImports(entryFile);
+        exportedChunks = {
+            ['mapping-or-exposed']: Object.values(resultMap).map(chunk => path.basename(chunk)),
+        };
+    }
+    return { mappings: sharedResult, exposes: exposedResult, chunks: exportedChunks };
 }
 export function describeExposed(config, options) {
     const result = [];

package/src/lib/core/bundle-shared.js

@@ -92,7 +92,6 @@ export async function bundleShared(sharedBundles, config, fedOptions, externals,
     }
     const outFileNames = [...expectedResults];
     const result = buildResult(packageInfos, sharedBundles, outFileNames);
-    // TODO: Decide whether/when to add .map files
     const chunks = bundleResult.filter(br => !br.fileName.endsWith('.map') &&
         !result.find(r => r.outFileName === path.basename(br.fileName)));
     /**

package/src/lib/core/remove-unused-deps.js

@@ -5,6 +5,7 @@ import { cwd } from 'process';
 import { getPackageInfo } from '../utils/package-info.js';
 import { getExternalImports as extractExternalImports } from '../utils/get-external-imports.js';
 import { normalizePackageName } from '../utils/normalize.js';
+import { resolveProjectName } from '../utils/config-utils.js';
 export function removeUnusedDeps(config, main, workspaceRoot) {
     const fileInfos = getProjectData(main, cwd(), {
         includeExternalLibraries: true,
@@ -12,7 +13,8 @@ export function removeUnusedDeps(config, main, workspaceRoot) {
     const usedDeps = findUsedDeps(fileInfos, workspaceRoot, config);
     const usedPackageNames = usedDeps.usedPackageNames;
     const usedMappings = usedDeps.usedMappings;
-    const usedPackageNamesWithTransient = addTransientDeps(usedPackageNames, workspaceRoot);
+    const projectName = resolveProjectName(config);
+    const usedPackageNamesWithTransient = addTransientDeps(usedPackageNames, workspaceRoot, projectName);
     const filteredShared = filterShared(config, usedPackageNamesWithTransient);
     return {
         ...config,
@@ -45,7 +47,7 @@ function findUsedDeps(fileInfos, workspaceRoot, config) {
     }
     return { usedPackageNames, usedMappings };
 }
-function addTransientDeps(packages, workspaceRoot) {
+function addTransientDeps(packages, workspaceRoot, projectName) {
     const packagesAndPeers = new Set([...packages]);
     const discovered = new Set(packagesAndPeers);
     const stack = [...packagesAndPeers];
@@ -58,7 +60,7 @@ function addTransientDeps(packages, workspaceRoot) {
         if (!pInfo) {
             continue;
         }
-        const peerDeps = getExternalImports(pInfo, workspaceRoot);
+        const peerDeps = getExternalImports(pInfo, workspaceRoot, projectName);
         for (const peerDep of peerDeps) {
             if (!discovered.has(peerDep)) {
                 discovered.add(peerDep);
@@ -69,10 +71,10 @@ function addTransientDeps(packages, workspaceRoot) {
     }
     return packagesAndPeers;
 }
-function getExternalImports(pInfo, workspaceRoot) {
+function getExternalImports(pInfo, workspaceRoot, projectName) {
     const encodedPackageName = normalizePackageName(pInfo.packageName);
     const cacheFileName = `${encodedPackageName}-${pInfo.version}.deps.json`;
-    const cachePath = path.join(workspaceRoot, 'node_modules/.cache/native-federation/_externals-metadata');
+    const cachePath = path.join(workspaceRoot, 'node_modules/.cache/native-federation/_externals-metadata', projectName);
     const cacheFilePath = path.join(cachePath, cacheFileName);
     const cacheHit = fs.existsSync(cacheFilePath);
     let peerDeps;

package/src/lib/domain/core/federation-info.contract.d.ts

@@ -29,4 +29,5 @@ export interface ExposesInfo {
 export interface ArtifactInfo {
     mappings: SharedInfo[];
     exposes: ExposesInfo[];
+    chunks?: ChunkInfo;
 }

package/src/lib/utils/build-result-map.d.ts

@@ -1,3 +1,4 @@
 import type { NFBuildAdapterResult } from '../domain/core/build-adapter.contract.js';
 export declare function createBuildResultMap(buildResult: NFBuildAdapterResult[], isHashed: boolean): Record<string, string>;
 export declare function lookupInResultMap(map: Record<string, string>, requestName: string): string;
+export declare function popFromResultMap(map: Record<string, string>, requestName: string): string;

package/src/lib/utils/build-result-map.js

@@ -11,11 +11,18 @@ export function createBuildResultMap(buildResult, isHashed) {
             const part2 = resultName.substring(end);
             requestName = part1 + part2;
         }
-        map[requestName] = resultName;
+        map[requestName] = item.fileName;
     }
     return map;
 }
 export function lookupInResultMap(map, requestName) {
     const key = path.basename(requestName);
-    return map[key];
+    // path.basename is to maintain backwards compatible
+    return path.basename(map[key]);
+}
+export function popFromResultMap(map, requestName) {
+    const key = path.basename(requestName);
+    const out = map[key];
+    delete map[key];
+    return out;
 }

package/src/lib/utils/config-utils.d.ts

@@ -0,0 +1,2 @@
+import { NormalizedFederationConfig } from '../domain/config/federation-config.contract.js';
+export declare function resolveProjectName(config: NormalizedFederationConfig): string;

package/src/lib/utils/config-utils.js

@@ -0,0 +1,9 @@
+import { logger } from './logger.js';
+import { normalizePackageName } from './normalize.js';
+export function resolveProjectName(config) {
+    const normalizedProjectName = normalizePackageName(config.name);
+    if (normalizedProjectName.length < 1) {
+        logger.warn("Project name in 'federation.config.js' is empty, defaulting to 'shell' cache folder (could collide with other projects in the workspace).");
+    }
+    return normalizedProjectName.length < 1 ? 'shell' : normalizedProjectName;
+}