feat(nf): deprecate transient flag

Author: manfredsteyer

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

@@ -379,6 +379,18 @@ function findTransientDeps(
     const shareConfig = configuredShareObjects[packageName];
 
     if (typeof shareConfig === 'object' && shareConfig.transient) {
+      logger.warn(
+        'PLEASE NOTE: The transient flag in your federation.config.js'
+      );
+      logger.warn(
+        'is deprecated. Please remove it. Meanwhile, Native Federation'
+      );
+      logger.warn(
+        'uses the underlying bundler for splitting transient'
+      );
+      logger.warn(
+        'dependencies into separate chunks, _when_ necessary.'
+      )
       const packagePath = path.join(
         projectRoot,
         'node_modules',

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

@@ -95,9 +95,8 @@ export async function bundleShared(
       platform,
     });
 
-    const cachedFiles = bundleResult.map(br => path.basename(br.fileName));
+    const cachedFiles = bundleResult.map((br) => path.basename(br.fileName));
     copyCacheToOutput(cachedFiles, cachePath, fullOutputPath);
-
   } catch (e) {
     logger.error('Error bundling shared npm package ');
     if (e instanceof Error) {
@@ -131,31 +130,33 @@ export async function bundleShared(
   }
 
   const resultCacheFile = createCacheFileName(
-    configState, 
-    sharedBundles, 
-    fedOptions, 
-    cachePath, 
+    configState,
+    sharedBundles,
+    fedOptions,
+    cachePath,
     platform
   );
 
   if (fs.existsSync(resultCacheFile)) {
-      const cachedResult: SharedInfo[] = JSON.parse(fs.readFileSync(resultCacheFile, 'utf-8'));
-      const cachedFiles = cachedResult.map(cr => cr.outFileName);
-      copyCacheToOutput(cachedFiles, cachePath, fullOutputPath)
-      return cachedResult;
+    const cachedResult: SharedInfo[] = JSON.parse(
+      fs.readFileSync(resultCacheFile, 'utf-8')
+    );
+    const cachedFiles = cachedResult.map((cr) => cr.outFileName);
+    copyCacheToOutput(cachedFiles, cachePath, fullOutputPath);
+    return cachedResult;
   }
 
   const outFileNames = [...exptedResults];
 
   const result = buildResult(
-    packageInfos, 
-    sharedBundles, 
-    outFileNames, 
-    fedOptions);
+    packageInfos,
+    sharedBundles,
+    outFileNames,
+    fedOptions
+  );
 
   const chunks = bundleResult.filter(
-    (br) => !result.find((r) => 
-      r.outFileName === path.basename(br.fileName))
+    (br) => !result.find((r) => r.outFileName === path.basename(br.fileName))
   );
 
   addChunksToResult(chunks, result, fedOptions.dev);
@@ -169,7 +170,11 @@ export async function bundleShared(
   return result;
 }
 
-function copyCacheToOutput(cachedFiles: string[], cachePath: string, fullOutputPath: string) {
+function copyCacheToOutput(
+  cachedFiles: string[],
+  cachePath: string,
+  fullOutputPath: string
+) {
   for (const fileName of cachedFiles) {
     const cachedFile = path.join(cachePath, fileName);
     const distFileName = path.join(fullOutputPath, fileName);
@@ -178,7 +183,12 @@ function copyCacheToOutput(cachedFiles: string[], cachePath: string, fullOutputP
   }
 }
 
-function createOutName(pi: PackageInfo, configState: string, fedOptions: FederationOptions, encName: string) {
+function createOutName(
+  pi: PackageInfo,
+  configState: string,
+  fedOptions: FederationOptions,
+  encName: string
+) {
   const hashBase = pi.version + '_' + pi.entryPoint + '_' + configState;
   const hash = calcHash(hashBase);
 
@@ -188,15 +198,29 @@ function createOutName(pi: PackageInfo, configState: string, fedOptions: Federat
   return outName;
 }
 
-function createCacheFileName(configState: string, sharedBundles: Record<string, NormalizedSharedConfig>, fedOptions: FederationOptions, cachePath: string, platform: string) {
+function createCacheFileName(
+  configState: string,
+  sharedBundles: Record<string, NormalizedSharedConfig>,
+  fedOptions: FederationOptions,
+  cachePath: string,
+  platform: string
+) {
   const resultCacheState = configState + JSON.stringify(sharedBundles);
   const resultHash = calcHash(resultCacheState);
   const dev = fedOptions.dev ? '-dev' : '';
-  const resultCacheFile = path.join(cachePath, 'result-' + resultHash + '-' + platform + dev + '.json');
+  const resultCacheFile = path.join(
+    cachePath,
+    'result-' + resultHash + '-' + platform + dev + '.json'
+  );
   return resultCacheFile;
 }
 
-function buildResult(packageInfos: PackageInfo[], sharedBundles: Record<string, NormalizedSharedConfig>, outFileNames: string[], fedOptions: FederationOptions) {
+function buildResult(
+  packageInfos: PackageInfo[],
+  sharedBundles: Record<string, NormalizedSharedConfig>,
+  outFileNames: string[],
+  fedOptions: FederationOptions
+) {
   return packageInfos.map((pi) => {
     const shared = sharedBundles[pi.packageName];
     return {
@@ -209,13 +233,17 @@ function buildResult(packageInfos: PackageInfo[], sharedBundles: Record<string,
       dev: !fedOptions.dev
         ? undefined
         : {
-          entryPoint: normalize(pi.entryPoint),
-        },
+            entryPoint: normalize(pi.entryPoint),
+          },
     } as SharedInfo;
   });
 }
 
-function addChunksToResult(chunks: BuildResult[], result: SharedInfo[], dev?: boolean) {
+function addChunksToResult(
+  chunks: BuildResult[],
+  result: SharedInfo[],
+  dev?: boolean
+) {
   for (const item of chunks) {
     const fileName = path.basename(item.fileName);
     result.push({
@@ -228,8 +256,8 @@ function addChunksToResult(chunks: BuildResult[], result: SharedInfo[], dev?: bo
       dev: dev
         ? undefined
         : {
-          entryPoint: normalize(fileName),
-        },
+            entryPoint: normalize(fileName),
+          },
     });
   }
 }
@@ -246,7 +274,6 @@ function calcHash(hashBase: string) {
   return hash;
 }
 
-
 function copyFileIfExists(cachedFile: string, fullOutputPath: string) {
   fs.mkdirSync(path.dirname(fullOutputPath), { recursive: true });
 

libs/native-federation-node/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2021 Softarc Consulting GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

libs/native-federation-node/package.json

@@ -1,4 +1,5 @@
 {
   "name": "@softarc/native-federation-node",
-  "version": "3.0.0"
+  "version": "3.0.0",
+  "license": "MIT"
 }

libs/native-federation/src/builders/build/builder.ts

@@ -252,7 +252,10 @@ export async function* runBuilder(
   try {
     federationResult = await buildForFederation(config, fedOptions, externals);
   } catch (e) {
-    process.exit(1);
+    console.error(e);
+    if (!watch) {
+      process.exit(1);
+    }
   }
 
   const hasLocales = i18n?.locales && Object.keys(i18n.locales).length > 0;