cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
angular/packages/compiler-cli/ngcc/test/packages/configuration_spec.ts
George Kalpakas 326240eb91 fix(ngcc): allow ngcc configuration to match pre-release versions of packages (#36370) 
Ngcc supports providing a project-level configuration to affect how
certain dependencies are processed and also has a built-in fallback
configuration for some unmaintained packages. Each entry in these
configurations could be scoped to specific versions of a package by
providing a version range. If no version range is provided for a
package, it defaults to `*` (with the intention of matching any
version).

Previously, the installed version of a package was tested against the
version range using the [semver][1] package's `satisfies()` function
with the default options. By default, `satisfies()` does not match
pre-releases (see [here][2] for more details on reasoning). While this
makes sense when determining what version of a dependency to install
(trying to avoid unexpected breaking changes), it is not desired in the
case of ngcc.

This commit fixes it by explicitly specifying that pre-release versions
should be matched normally.

[1]: https://www.npmjs.com/package/semver
[2]: https://github.com/npm/node-semver#prerelease-tags

PR Close #36370
2020-04-01 13:32:32 -07:00

588 lines
23 KiB
TypeScript
Raw Blame History

/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import {createHash} from 'crypto';
import {FileSystem, absoluteFrom, getFileSystem} from '../../../src/ngtsc/file_system';
import {runInEachFileSystem} from '../../../src/ngtsc/file_system/testing';
import {loadTestFiles} from '../../../test/helpers';
import {DEFAULT_NGCC_CONFIG, NgccConfiguration} from '../../src/packages/configuration';
runInEachFileSystem(() => {
let _Abs: typeof absoluteFrom;
let fs: FileSystem;
beforeEach(() => {
_Abs = absoluteFrom;
fs = getFileSystem();
});
describe('NgccConfiguration', () => {
describe('constructor', () => {
it('should error if a project level config file is badly formatted', () => {
loadTestFiles([{name: _Abs('/project-1/ngcc.config.js'), contents: `bad js code`}]);
expect(() => new NgccConfiguration(fs, _Abs('/project-1')))
.toThrowError(
`Invalid project configuration file at "${_Abs('/project-1/ngcc.config.js')}": Unexpected identifier`);
});
});
describe('hash', () => {
it('should compute a hash from the loaded and processed project configuration', () => {
const project1 = _Abs('/project-1');
const project1Config = fs.resolve(project1, 'ngcc.config.js');
const project1NodeModules = fs.resolve(project1, 'node_modules');
const project1Package1 = fs.resolve(project1NodeModules, 'package-1');
const project1Package1EntryPoint1 = fs.resolve(project1Package1, 'entry-point-1');
loadTestFiles([{
name: project1Config,
contents: `
module.exports = {
packages: {
'package-1': {entryPoints: {'./entry-point-1': {}}},
},
};`
}]);
const project1Conf = new NgccConfiguration(fs, project1);
const expectedProject1Config =
`{"packages":{"${project1Package1}":[{"entryPoints":{"${project1Package1EntryPoint1}":{}},"versionRange":"*"}]}}`;
expect(project1Conf.hash)
.toEqual(createHash('md5').update(expectedProject1Config).digest('hex'));
const project2 = _Abs('/project-2');
const project2Config = fs.resolve(project2, 'ngcc.config.js');
const project2NodeModules = fs.resolve(project2, 'node_modules');
const project2Package1 = fs.resolve(project2NodeModules, 'package-1');
const project2Package1EntryPoint1 = fs.resolve(project2Package1, 'entry-point-1');
loadTestFiles([{
name: project2Config,
contents: `
module.exports = {
packages: {
'package-1': {entryPoints: {'./entry-point-1': {ignore: true}}},
},
};`
}]);
const project2Conf = new NgccConfiguration(fs, project2);
const expectedProject2Config =
`{"packages":{"${project2Package1}":[{"entryPoints":{"${project2Package1EntryPoint1}":{"ignore":true}},"versionRange":"*"}]}}`;
expect(project2Conf.hash)
.toEqual(createHash('md5').update(expectedProject2Config).digest('hex'));
});
it('should compute a hash even if there is no project configuration', () => {
loadTestFiles([{name: _Abs('/project-1/empty.js'), contents: ``}]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(configuration.hash).toEqual('87c535c3ce0eac2a54c246892e0e21a1');
});
});
describe('getConfig()', () => {
describe('at the package level', () => {
it('should return configuration for a package found in a package level file, with a matching version',
() => {
loadTestFiles(packageWithConfigFiles('package-1', 'entry-point-1', '1.0.0'));
const readFileSpy = spyOn(fs, 'readFile').and.callThrough();
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(config).toEqual({
versionRange: '1.0.0',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}}
});
expect(readFileSpy)
.toHaveBeenCalledWith(_Abs('/project-1/node_modules/package-1/ngcc.config.js'));
});
it('should used cached configuration for a package if available', () => {
loadTestFiles(packageWithConfigFiles('package-1', 'entry-point-1', '1.0.0'));
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
// Populate the cache
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
const readFileSpy = spyOn(fs, 'readFile').and.callThrough();
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(config).toEqual({
versionRange: '1.0.0',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}}
});
expect(readFileSpy).not.toHaveBeenCalled();
});
it('should return an empty configuration object if there is no matching configuration for the package',
() => {
loadTestFiles(packageWithConfigFiles('package-2', 'entry-point-1', '1.0.0'));
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(config).toEqual({versionRange: '*', entryPoints: {}});
});
it('should error if a package level config file is badly formatted', () => {
loadTestFiles([{
name: _Abs('/project-1/node_modules/package-1/ngcc.config.js'),
contents: `bad js code`
}]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(() => configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0'))
.toThrowError(
`Invalid package configuration file at "${_Abs('/project-1/node_modules/package-1/ngcc.config.js')}": Unexpected identifier`);
});
});
describe('at the project level', () => {
it('should return configuration for a package found in a project level file', () => {
loadTestFiles([{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'package-1': {
entryPoints: {
'./entry-point-1': {}
},
},
},
};`
}]);
const readFileSpy = spyOn(fs, 'readFile').and.callThrough();
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(readFileSpy).toHaveBeenCalledWith(_Abs('/project-1/ngcc.config.js'));
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(config).toEqual({
versionRange: '*',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}}
});
});
it('should return configuration for the correct version of a package found in a project level file',
() => {
loadTestFiles([{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'package-1@1.0.0': {
entryPoints: {
'./entry-point-1': {}
},
},
'package-1@2.*': {
entryPoints: {
'./entry-point-2': {}
},
},
'package-1@^3.2.0': {
entryPoints: {
'./entry-point-3': {}
},
},
},
};`
}]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0'))
.toEqual({
versionRange: '1.0.0',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}}
});
expect(configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '2.5.0'))
.toEqual({
versionRange: '2.*',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-2')]: {}}
});
expect(configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '3.2.5'))
.toEqual({
versionRange: '^3.2.0',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-3')]: {}}
});
expect(configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '4.0.0'))
.toEqual({versionRange: '*', entryPoints: {}});
});
it('should correctly handle pre-release versions and version ranges', () => {
loadTestFiles([
{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'package-1': {
entryPoints: {
'./entry-point-1': {},
},
},
'package-2@1.0.0-beta.2': {
entryPoints: {
'./entry-point-2': {},
},
},
'package-3@>=1.0.0-beta.2': {
entryPoints: {
'./entry-point-3': {},
},
},
},
};
`,
},
]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const getConfig = (packageName: string, version: string | null) =>
configuration.getConfig(_Abs(`/project-1/node_modules/${packageName}`), version);
// Default version range: *
expect(getConfig('package-1', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '*',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}},
},
'Config for package-1@1.0.0-beta.2');
// Version range: 1.0.0-beta.2
expect(getConfig('package-2', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-2/entry-point-2')]: {}},
},
'Config for package-2@1.0.0-beta.2');
expect(getConfig('package-2', '1.0.0'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-2@1.0.0');
expect(getConfig('package-2', null))
.toEqual(
{
versionRange: '1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-2/entry-point-2')]: {}},
},
'Config for package-2@null');
// Version range: >=1.0.0-beta.2
expect(getConfig('package-3', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@1.0.0-beta.2');
expect(getConfig('package-3', '1.0.0'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@1.0.0');
expect(getConfig('package-3', '2.0.0'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@2.0.0');
expect(getConfig('package-3', '1.0.0-beta.1'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-3@1.0.0-beta.1');
expect(getConfig('package-3', '0.9.99'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-3@0.9.99');
});
it('should not get confused by the @ in namespaced packages', () => {
loadTestFiles([{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'@angular/common': {
entryPoints: {
'.': {}
},
},
},
};`
}]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(configuration.getConfig(_Abs('/project-1/node_modules/@angular/common'), '1.0.0'))
.toEqual({
versionRange: '*',
entryPoints: {[_Abs('/project-1/node_modules/@angular/common')]: {}}
});
});
it('should override package level config with project level config per package', () => {
loadTestFiles([{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'package-2': {
entryPoints: {
'./project-setting-entry-point': {}
},
},
},
};`,
}]);
loadTestFiles(
packageWithConfigFiles('package-1', 'package-setting-entry-point', '1.0.0'));
loadTestFiles(
packageWithConfigFiles('package-2', 'package-setting-entry-point', '1.0.0'));
const readFileSpy = spyOn(fs, 'readFile').and.callThrough();
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(readFileSpy).toHaveBeenCalledWith(_Abs('/project-1/ngcc.config.js'));
const package1Config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(package1Config).toEqual({
versionRange: '1.0.0',
entryPoints:
{[_Abs('/project-1/node_modules/package-1/package-setting-entry-point')]: {}}
});
expect(readFileSpy)
.toHaveBeenCalledWith(_Abs('/project-1/node_modules/package-1/ngcc.config.js'));
// Note that for `package-2` only the project level entry-point is left.
// This is because overriding happens for packages as a whole and there is no attempt to
// merge entry-points.
const package2Config =
configuration.getConfig(_Abs('/project-1/node_modules/package-2'), '1.0.0');
expect(package2Config).toEqual({
versionRange: '*',
entryPoints:
{[_Abs('/project-1/node_modules/package-2/project-setting-entry-point')]: {}}
});
expect(readFileSpy)
.not.toHaveBeenCalledWith(_Abs('/project-1/node_modules/package-2/ngcc.config.js'));
});
});
describe('at the default level', () => {
const originalDefaultConfig = JSON.stringify(DEFAULT_NGCC_CONFIG.packages);
beforeEach(() => {
DEFAULT_NGCC_CONFIG.packages['package-1'] = {
entryPoints: {'./default-level-entry-point': {}},
};
});
afterEach(() => DEFAULT_NGCC_CONFIG.packages = JSON.parse(originalDefaultConfig));
it('should return configuration for a package found in the default config', () => {
const readFileSpy = spyOn(fs, 'readFile').and.callThrough();
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
expect(readFileSpy).not.toHaveBeenCalled();
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
expect(config).toEqual({
versionRange: '*',
entryPoints:
{[_Abs('/project-1/node_modules/package-1/default-level-entry-point')]: {}}
});
});
it('should override default level config with package level config, if provided', () => {
loadTestFiles(packageWithConfigFiles('package-1', 'package-level-entry-point', '1.0.0'));
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
// Note that only the package-level-entry-point is left.
// This is because overriding happens for packages as a whole and there is no attempt to
// merge entry-points.
expect(config).toEqual({
versionRange: '1.0.0',
entryPoints:
{[_Abs('/project-1/node_modules/package-1/package-level-entry-point')]: {}}
});
});
it('should override default level config with project level config, if provided', () => {
loadTestFiles(packageWithConfigFiles('package-1', 'package-level-entry-point', '1.0.0'));
loadTestFiles([
{
name: _Abs('/project-1/node_modules/package-1/ngcc.config.js'),
contents: `
module.exports = {
entryPoints: {'./package-level-entry-point': {}},
};`,
},
{
name: _Abs('/project-1/ngcc.config.js'),
contents: `
module.exports = {
packages: {
'package-1': {
entryPoints: {
'./project-level-entry-point': {}
},
},
},
};`,
},
]);
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const config =
configuration.getConfig(_Abs('/project-1/node_modules/package-1'), '1.0.0');
// Note that only the project-level-entry-point is left.
// This is because overriding happens for packages as a whole and there is no attempt to
// merge entry-points.
expect(config).toEqual({
versionRange: '*',
entryPoints:
{[_Abs('/project-1/node_modules/package-1/project-level-entry-point')]: {}}
});
});
it('should correctly handle pre-release versions and version ranges', () => {
Object.assign(DEFAULT_NGCC_CONFIG.packages, {
'package-1': {
entryPoints: {
'./entry-point-1': {},
},
},
'package-2@1.0.0-beta.2': {
entryPoints: {
'./entry-point-2': {},
},
},
'package-3@>=1.0.0-beta.2': {
entryPoints: {
'./entry-point-3': {},
},
},
});
const configuration = new NgccConfiguration(fs, _Abs('/project-1'));
const getConfig = (packageName: string, version: string | null) =>
configuration.getConfig(_Abs(`/project-1/node_modules/${packageName}`), version);
// Default version range: *
expect(getConfig('package-1', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '*',
entryPoints: {[_Abs('/project-1/node_modules/package-1/entry-point-1')]: {}},
},
'Config for package-1@1.0.0-beta.2');
// Version range: 1.0.0-beta.2
expect(getConfig('package-2', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-2/entry-point-2')]: {}},
},
'Config for package-2@1.0.0-beta.2');
expect(getConfig('package-2', '1.0.0'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-2@1.0.0');
expect(getConfig('package-2', null))
.toEqual(
{
versionRange: '1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-2/entry-point-2')]: {}},
},
'Config for package-2@null');
// Version range: >=1.0.0-beta.2
expect(getConfig('package-3', '1.0.0-beta.2'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@1.0.0-beta.2');
expect(getConfig('package-3', '1.0.0'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@1.0.0');
expect(getConfig('package-3', '2.0.0'))
.toEqual(
{
versionRange: '>=1.0.0-beta.2',
entryPoints: {[_Abs('/project-1/node_modules/package-3/entry-point-3')]: {}},
},
'Config for package-3@2.0.0');
expect(getConfig('package-3', '1.0.0-beta.1'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-3@1.0.0-beta.1');
expect(getConfig('package-3', '0.9.99'))
.toEqual(
{
versionRange: '*',
entryPoints: {},
},
'Config for package-3@0.9.99');
});
});
});
});
function packageWithConfigFiles(packageName: string, entryPointName: string, version: string) {
return [
{
name: _Abs(`/project-1/node_modules/${packageName}/ngcc.config.js`),
contents: `module.exports = {entryPoints: { './${entryPointName}': {}}}`
},
{
name: _Abs(`/project-1/node_modules/${packageName}/package.json`),
contents: `{ "version": "${version}" }`
}
];
}
});
Reference in New Issue View Git Blame Copy Permalink