fix(nf): Removed checksum from cache to allow consistent removal if checksum doesnt match

Author: Aukevanoost

libs/native-federation-core/src/lib/core/build-for-federation.ts

@@ -35,7 +35,7 @@ export async function buildForFederation(
   config: NormalizedFederationConfig,
   fedOptions: FederationOptions,
   externals: string[],
-  buildParams = defaultBuildParams,
+  buildParams = defaultBuildParams
 ): Promise<FederationInfo> {
   const signal = buildParams.signal;
 
@@ -47,16 +47,16 @@ export async function buildForFederation(
       config,
       fedOptions,
       externals,
-      signal,
+      signal
     );
     logger.measure(
       start,
-      '[build artifacts] - To bundle all mappings and exposed.',
+      '[build artifacts] - To bundle all mappings and exposed.'
     );
 
     if (signal?.aborted)
       throw new AbortedError(
-        '[buildForFederation] After exposed-and-mappings bundle',
+        '[buildForFederation] After exposed-and-mappings bundle'
       );
   }
 
@@ -67,13 +67,13 @@ export async function buildForFederation(
   const cacheProjectFolder = normalizePackageName(config.name);
   if (cacheProjectFolder.length < 1) {
     logger.warn(
-      "Project name in 'federation.config.js' is empty, defaulting to root cache folder.",
+      "Project name in 'federation.config.js' is empty, defaulting to root cache folder (could collide with other projects in the workspace)."
     );
   }
 
   const pathToCache = getCachePath(
     fedOptions.workspaceRoot,
-    normalizePackageName(config.name),
+    cacheProjectFolder
   );
 
   if (!buildParams.skipShared && sharedPackageInfoCache.length > 0) {
@@ -92,19 +92,19 @@ export async function buildForFederation(
         fedOptions,
         externals,
         'browser',
-        { pathToCache, bundleName: 'browser-shared' },
+        { pathToCache, bundleName: 'browser-shared' }
       );
 
       logger.measure(
         start,
-        '[build artifacts] - To bundle all shared browser externals',
+        '[build artifacts] - To bundle all shared browser externals'
       );
 
       sharedPackageInfoCache.push(...sharedPackageInfoBrowser);
 
       if (signal?.aborted)
         throw new AbortedError(
-          '[buildForFederation] After shared-browser bundle',
+          '[buildForFederation] After shared-browser bundle'
         );
     }
 
@@ -116,11 +116,11 @@ export async function buildForFederation(
         fedOptions,
         externals,
         'node',
-        { pathToCache, bundleName: 'node-shared' },
+        { pathToCache, bundleName: 'node-shared' }
       );
       logger.measure(
         start,
-        '[build artifacts] - To bundle all shared node externals',
+        '[build artifacts] - To bundle all shared node externals'
       );
       sharedPackageInfoCache.push(...sharedPackageInfoServer);
 
@@ -136,17 +136,17 @@ export async function buildForFederation(
         config,
         fedOptions,
         'browser',
-        pathToCache,
+        pathToCache
       );
       logger.measure(
         start,
-        '[build artifacts] - To bundle all separate browser externals',
+        '[build artifacts] - To bundle all separate browser externals'
       );
       sharedPackageInfoCache.push(...separatePackageInfoBrowser);
 
       if (signal?.aborted)
         throw new AbortedError(
-          '[buildForFederation] After separate-browser bundle',
+          '[buildForFederation] After separate-browser bundle'
         );
     }
 
@@ -158,11 +158,11 @@ export async function buildForFederation(
         config,
         fedOptions,
         'node',
-        pathToCache,
+        pathToCache
       );
       logger.measure(
         start,
-        '[build artifacts] - To bundle all separate node externals',
+        '[build artifacts] - To bundle all separate node externals'
       );
       sharedPackageInfoCache.push(...separatePackageInfoServer);
     }
@@ -214,13 +214,13 @@ async function bundleSeparate(
   config: NormalizedFederationConfig,
   fedOptions: FederationOptions,
   platform: 'node' | 'browser',
-  pathToCache: string,
+  pathToCache: string
 ) {
   const bundlePromises = Object.entries(separateBrowser).map(
     async ([key, shared]) => {
       const packageName = inferPackageFromSecondary(key);
       const filteredExternals = externals.filter(
-        (e) => !e.startsWith(packageName),
+        (e) => !e.startsWith(packageName)
       );
       return bundleShared(
         { [key]: shared },
@@ -231,17 +231,17 @@ async function bundleSeparate(
         {
           pathToCache,
           bundleName: `${platform}-${normalizePackageName(key)}`,
-        },
+        }
       );
-    },
+    }
   );
 
   const buildResults = await Promise.all(bundlePromises);
   return buildResults.flat();
 }
 
 function splitShared(
-  shared: Record<string, NormalizedSharedConfig>,
+  shared: Record<string, NormalizedSharedConfig>
 ): SplitSharedResult {
   const sharedServer: Record<string, NormalizedSharedConfig> = {};
   const sharedBrowser: Record<string, NormalizedSharedConfig> = {};

libs/native-federation-core/src/lib/core/bundle-caching.ts

@@ -8,8 +8,8 @@ import { logger } from '../utils/logger';
 export const getCachePath = (workspaceRoot: string, project: string) =>
   path.join(workspaceRoot, 'node_modules/.cache/native-federation', project);
 
-export const getFilename = (checksum: string, title: string) => {
-  return `${title}-meta-${checksum.substring(0, 10)}.json`;
+export const getFilename = (title: string) => {
+  return `${title}.meta.json`;
 };
 
 export const getChecksum = (
@@ -89,11 +89,12 @@ export const cacheEntry = (pathToCache: string, fileName: string) => ({
     const metadataFile = path.join(pathToCache, fileName);
     if (!fs.existsSync(pathToCache)) {
       fs.mkdirSync(pathToCache, { recursive: true });
+      logger.debug(`Creating cache folder '${pathToCache}' for '${fileName}'.`);
       return;
     }
     if (!fs.existsSync(metadataFile)) {
-      logger.warn(
-        `Could not purge cache, metadata file '${fileName}' could not be found.`,
+      logger.debug(
+        `Could not purge cached bundle, metadata file '${metadataFile}' does not exist.`,
       );
       return;
     }
@@ -108,5 +109,7 @@ export const cacheEntry = (pathToCache: string, fileName: string) => ({
       const cachedFile = path.join(pathToCache, file);
       if (fs.existsSync(cachedFile)) fs.unlinkSync(cachedFile);
     });
+
+    fs.unlinkSync(metadataFile);
   },
 });

libs/native-federation-core/src/lib/core/bundle-shared.ts

@@ -34,12 +34,12 @@ export async function bundleShared(
 
   const bundleCache = cacheEntry(
     cacheOptions.pathToCache,
-    getFilename(checksum, cacheOptions.bundleName),
+    getFilename(cacheOptions.bundleName),
   );
 
   const cacheMetadata = bundleCache.getMetadata(checksum);
   if (cacheMetadata) {
-    logger.info(
+    logger.debug(
       `Checksum of ${cacheOptions.bundleName} matched, Skipped artifact bundling`,
     );
     bundleCache.copyFiles(
@@ -48,6 +48,7 @@ export async function bundleShared(
     return cacheMetadata.externals;
   }
 
+  // Delete older packages if checksum didnt match
   bundleCache.clear();
 
   const inferredPackageInfos = Object.keys(sharedBundles)