chore(nf): Made #981 opt-in instead of default

Author: Aukevanoost

libs/native-federation-core/src/lib/config/federation-config.ts

@@ -27,6 +27,7 @@ export interface FederationConfig {
   features?: {
     mappingVersion?: boolean;
     ignoreUnusedDeps?: boolean;
+    cacheExternalArtifacts: boolean;
   };
 }
 
@@ -55,5 +56,6 @@ export interface NormalizedFederationConfig {
   features: {
     mappingVersion: boolean;
     ignoreUnusedDeps: boolean;
+    cacheExternalArtifacts: boolean;
   };
 }

libs/native-federation-core/src/lib/config/with-native-federation.ts

@@ -18,7 +18,7 @@ export function withNativeFederation(
 ): NormalizedFederationConfig {
   const skip = prepareSkipList(config.skip ?? []);
 
-  const normalized = {
+  const normalized: NormalizedFederationConfig = {
     name: config.name ?? '',
     exposes: config.exposes ?? {},
     shared: normalizeShared(config, skip),
@@ -28,6 +28,7 @@ export function withNativeFederation(
     features: {
       mappingVersion: config.features?.mappingVersion ?? false,
       ignoreUnusedDeps: config.features?.ignoreUnusedDeps ?? false,
+      cacheExternalArtifacts: config.features?.cacheExternalArtifacts ?? false,
     },
   };
 

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

@@ -64,12 +64,14 @@ export async function buildForFederation(
     ? describeExposed(config, fedOptions)
     : artefactInfo.exposes;
 
-  const cacheProjectFolder = normalizePackageName(config.name);
-  if (cacheProjectFolder.length < 1) {
+  const normalizedCacheFolder = normalizePackageName(config.name);
+  if (normalizedCacheFolder.length < 1) {
     logger.warn(
-      "Project name in 'federation.config.js' is empty, defaulting to root cache folder (could collide with other projects in the workspace).",
+      "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 pathToCache = getCachePath(
     fedOptions.workspaceRoot,

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

@@ -37,18 +37,19 @@ export async function bundleShared(
     getFilename(cacheOptions.bundleName),
   );
 
-  const cacheMetadata = bundleCache.getMetadata(checksum);
-  if (cacheMetadata) {
-    logger.debug(
-      `Checksum of ${cacheOptions.bundleName} matched, Skipped artifact bundling`,
-    );
-    bundleCache.copyFiles(
-      path.join(fedOptions.workspaceRoot, fedOptions.outputPath),
-    );
-    return cacheMetadata.externals;
+  if (config?.features?.cacheExternalArtifacts) {
+    const cacheMetadata = bundleCache.getMetadata(checksum);
+    if (cacheMetadata) {
+      logger.debug(
+        `Checksum of ${cacheOptions.bundleName} matched, Skipped artifact bundling`,
+      );
+      bundleCache.copyFiles(
+        path.join(fedOptions.workspaceRoot, fedOptions.outputPath),
+      );
+      return cacheMetadata.externals;
+    }
   }
 
-  // Delete older packages if checksum didnt match
   bundleCache.clear();
 
   const inferredPackageInfos = Object.keys(sharedBundles)

libs/native-federation-core/src/lib/core/federation-options.ts

@@ -4,6 +4,7 @@ export interface FederationOptions {
   workspaceRoot: string;
   outputPath: string;
   federationConfig: string;
+  cacheExternals: boolean;
   tsConfig?: string;
   verbose?: boolean;
   dev?: boolean;

libs/native-federation/src/schematics/init/files/federation.config.js__tmpl__

@@ -28,7 +28,11 @@ module.exports = withNativeFederation({
     // New feature for more performance and avoiding
     // issues with node libs. Comment this out to
     // get the traditional behavior:
-    ignoreUnusedDeps: true
+    ignoreUnusedDeps: true,
+
+    // Will use a checksum to verify if compiled (external) 
+    // artifacts were unchanged since last build (based on 
+    // name and version). If so it will reuse the compiled ones.
+    cacheExternalArtifacts: true
   }
-  
 });