link-packages-test.mjs

/**
 * Test that collects all partially built NPM packages and links their Angular
 * declarations to the corresponding definitions.
 */

import{createEs2015LinkerPlugin}from'@angular/compiler-cli/linker/babel';
import{NodeJSFileSystem,ConsoleLogger,LogLevel}from'@angular/compiler-cli';
importfsfrom'fs';
importpathfrom'path';
importbabelfrom'@babel/core';
importglobfrom'glob';
importchalkfrom'chalk';

/** File system used by the Angular linker plugin. */
constfileSystem=newNodeJSFileSystem();
/** Logger used by the Angular linker plugin. */
constlogger=newConsoleLogger(LogLevel.info);
/** List of NPM packages available in the Bazel runfiles. */
constnpmPackages=[
{name: 'cdk',pkgPath: '../../src/cdk/npm_package'},
{name: 'cdk-experimental',pkgPath: '../../src/cdk-experimental/npm_package'},
{name: 'google-maps',pkgPath: '../../src/google-maps/npm_package'},
{name: 'material',pkgPath: '../../src/material/npm_package'},
{name: 'material-experimental',pkgPath: '../../src/material-experimental/npm_package'},
{name: 'youtube-player',pkgPath: '../../src/youtube-player/npm_package'},
];
/** Whether any package could not be linked successfully. */
letfailedPackages=false;

// Iterate through all determined NPM packages and ensure that entry point
// files can be processed successfully by the Angular linker.
for(constpkgofnpmPackages){
const{failures, passedFiles}=testPackage(pkg);

console.info(chalk.cyan(`------- Package: @angular/${pkg.name} -------`));
console.info(`Passed files: ${passedFiles.length}`);
console.info(`Failed files: ${failures.length}`);

if(failures.length>0){
failures.forEach(({debugFileName, error})=>{
console.error(` • ${chalk.yellow(debugFileName)}: ${error}`);
});
failedPackages=true;
}

console.info('-------------------------------------');
console.info();
}

if(failedPackages){
console.error(chalk.red(`✘ Not all packages could be linked successfully. See errors above.`));
// If there are failures, exit the process with a non-zero exit code. Bazel
// uses exit code `3` to indicate non-fatal test failures.
process.exitCode=3;
}else{
console.info(chalk.green(`✓ All packages have been successfully linked: ${npmPackages.length}`));
}

/**
 * Tests the specified package against the Angular linker plugin.
 * @param pkg Package being tested.
 * @returns An object containing linker failures and passed files.
 */
functiontestPackage(pkg){
constentryPointFesmFiles=glob.sync(`fesm2022/**/*.mjs`,{cwd: pkg.pkgPath});
constpassedFiles=[];
constfailures=[];

// Iterate through each entry point and confirm that all partial declarations can be linked
// to their corresponding Angular definitions without errors.
for(constfesmFileNameofentryPointFesmFiles){
constdiskFilePath=path.join(pkg.pkgPath,fesmFileName);
constdebugFileName=path.join(pkg.name,fesmFileName);
constfileContent=fs.readFileSync(diskFilePath,'utf8');
constlinkerPlugin=createEs2015LinkerPlugin({fileSystem, logger});

// Babel throws errors if the transformation fails. We catch these so that we
// can print incompatible entry points with their errors at the end.
try{
const{ast}=babel.transformSync(fileContent,{
ast: true,
filename: diskFilePath,
filenameRelative: debugFileName,
plugins: [linkerPlugin],
});

// Naively check if there are any Angular declarations left that haven't been linked.
babel.traverse(ast,{
Identifier: astPath=>{
if(astPath.node.name.startsWith('ɵɵngDeclare')){
throwastPath.buildCodeFrameError(
'Found Angular declaration that has not been linked.',
Error,
);
}
},
});

passedFiles.push(debugFileName);
}catch(error){
failures.push({debugFileName, error});
}
}

return{passedFiles, failures};
}