feat(nf): run ngcc for older libs if needed

Author: manfredsteyer

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

@@ -22,3 +22,4 @@ export {
   BuildHelperParams,
 } from './lib/core/federation-builder';
 export { logger, setLogLevel } from './lib/utils/logger';
+export { hashFile } from './lib/utils/hash-file';

libs/native-federation-core/src/lib/utils/logger.ts

@@ -23,7 +23,7 @@ log.addLevel(
   'verbose',
   levels.verbose,
   { fg: 'brightWhite', bg: 'brightBlue' },
-  ' MORE '
+  ' VRB! '
 );
 log.addLevel('silly', levels.silly, { fg: 'black', bg: 'white' }, ' DBG! ');
 

libs/native-federation/package.json

@@ -25,7 +25,8 @@
     "@babel/core": "^7.19.0",
     "@softarc/native-federation": "1.0.0",
     "@softarc/native-federation-runtime": "1.0.0",
-    "@rollup/plugin-json": "^4.1.0"
+    "@rollup/plugin-json": "^4.1.0",
+    "cross-spawn": "^7.0.3"
   },
   "peerDependencies": {
     "@angular/compiler-cli": "*"

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

@@ -10,6 +10,8 @@ import { ExecutionTransformer } from '@angular-architects/build-angular';
 import * as path from 'path';
 import * as fs from 'fs';
 import {
+  hashFile,
+  logger,
   NormalizedFederationConfig,
   setLogLevel,
 } from '@softarc/native-federation/build';
@@ -23,6 +25,8 @@ import { getExternals } from '@softarc/native-federation/build';
 import { loadFederationConfig } from '@softarc/native-federation/build';
 import { buildForFederation } from '@softarc/native-federation/build';
 
+import * as crossSpawn from 'cross-spawn';
+
 export async function runBuilder(
   options: Schema,
   context: BuilderContext
@@ -41,6 +45,8 @@ export async function runBuilder(
   const config = await loadFederationConfig(fedOptions);
   const externals = getExternals(config);
 
+  runNgccIfNeeded(fedOptions, fedOptions.workspaceRoot);
+
   options.externalDependencies = externals.filter((e) => e !== 'tslib');
   const output = await build(config, options, context);
 
@@ -53,6 +59,83 @@ export async function runBuilder(
 
 export default createBuilder(runBuilder);
 
+function runNgccIfNeeded(fedOptions: FederationOptions, workspaceRoot: string) {
+  const hash = getLockFileHash(fedOptions);
+  const skip = skipNgcc(hash, workspaceRoot);
+
+  if (!skip) {
+    runNgcc(workspaceRoot);
+    writeNgccLock(hash, workspaceRoot);
+  }
+}
+
+function runNgcc(workspaceRoot: string) {
+  logger.verbose('Running ngcc');
+  const command = getNpxCommand(workspaceRoot);
+  const result = crossSpawn.sync(command, [
+    'ngcc',
+    '--async',
+    '--create-ivy-entry-points',
+    '--first-only'
+  ], { stdio: 'inherit' });
+
+  if (result.status !== 0) {
+    const error = result.error || '';
+    logger.error('Error running ngcc: ' + error);
+  }
+}
+
+function getLockFileHash(fedOptions: FederationOptions) {
+  const lockFileName = getLockFileName(fedOptions.workspaceRoot);
+  const hash = hashFile(lockFileName);
+  return hash;
+}
+
+const NGCC_LOCK_DIR = 'node_modules/.cache/native-federation/ngcc';
+
+function skipNgcc(hash: string, workspaceRoot: string) {
+  
+  const ngccLockFileDir = path.join(workspaceRoot, NGCC_LOCK_DIR);
+  const ngccLockFileName = path.join(ngccLockFileDir, hash + '.lock');
+
+  let exists = false;
+  if (fs.existsSync(ngccLockFileName)) {
+    exists = true;
+  }
+  return exists;
+}
+
+function writeNgccLock(hash: string, workspaceRoot: string) {
+  const ngccLockFileDir = path.join(workspaceRoot, NGCC_LOCK_DIR);
+  const ngccLockFileName = path.join(ngccLockFileDir, hash + '.lock');
+
+  if (!fs.existsSync(ngccLockFileDir)) {
+    fs.mkdirSync(ngccLockFileDir, { recursive: true });
+  }
+
+  fs.writeFileSync(ngccLockFileName, '');
+}
+
+function getLockFileName(workspaceRoot: string) {
+  let candPath = '';
+  for (const candLock of ['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml']) {
+    candPath = path.join(workspaceRoot, candLock);
+    if (fs.existsSync(candPath)) {
+      break;
+    }
+  }
+  return candPath;
+}
+
+function getNpxCommand(workspaceRoot: string): string {
+  switch (getLockFileName(workspaceRoot)) {
+    case 'package-lock.json': return 'npx';
+    case 'yarn.lock': return 'yarn';
+    case 'pnpm-lock.yaml': return 'pnpx';
+    default: return 'npx';
+  }
+}
+
 function updateIndexHtml(fedOptions: FederationOptions) {
   const outputPath = path.join(fedOptions.workspaceRoot, fedOptions.outputPath);
   const indexPath = path.join(outputPath, 'index.html');

package-lock.json

@@ -43,6 +43,7 @@
     "@rollup/plugin-json": "^4.1.0",
     "@softarc/native-federation": "file:softarc-native-federation-0.9.2-beta.3.tgz",
     "@types/browser-sync": "^2.26.3",
+    "@types/cross-spawn": "^6.0.2",
     "es-module-shims": "^1.5.12",
     "npmlog": "^6.0.2",
     "rxjs": "~6.6.3",