fix(@schematics/update): allow beta versions to be valid peer

hansl · filipesilva · commit 1a6754603f28 · 2018-06-13T22:40:11.000+01:00
Before this fix, the beta would not satisfy the updated range. Since Angular
released a beta today it uncovered this issue.
diff --git a/packages/schematics/update/update/index.ts b/packages/schematics/update/update/index.ts
@@ -25,29 +25,39 @@ import { UpdateSchema } from './schema';
 type VersionRange = string & { __VERSION_RANGE: void; };
 type PeerVersionTransform = string | ((range: string) => string);
 
-// This is a map of packageGroupName to range extending function. If it isn't found, the range is
-// kept the same.
+
 // Angular guarantees that a major is compatible with its following major (so packages that depend
 // on Angular 5 are also compatible with Angular 6). This is, in code, represented by verifying
 // that all other packages that have a peer dependency of `"@angular/core": "^5.0.0"` actually
 // supports 6.0, by adding that compatibility to the range, so it is `^5.0.0 || ^6.0.0`.
-const peerCompatibleWhitelist: { [name: string]: PeerVersionTransform } = {
-  '@angular/core': (range: string) => {
-    range = semver.validRange(range);
-    let major = 1;
-    while (!semver.gtr(major + '.0.0', range)) {
-      major++;
-      if (major >= 99) {
-        // Use original range if it supports a major this high
-        // Range is most likely unbounded (e.g., >=5.0.0)
-        return range;
-      }
+// We export it to allow for testing.
+export function angularMajorCompatGuarantee(range: string) {
+  range = semver.validRange(range);
+  let major = 1;
+  while (!semver.gtr(major + '.0.0', range)) {
+    major++;
+    if (major >= 99) {
+      // Use original range if it supports a major this high
+      // Range is most likely unbounded (e.g., >=5.0.0)
+      return range;
     }
+  }
+
+  // Add the major version as compatible with the angular compatible, with all minors. This is
+  // already one major above the greatest supported, because we increment `major` before checking.
+  let newRange = range;
+  for (let minor = 0; minor < 20; minor++) {
+    newRange += ` || ^${major}.${minor}.0-alpha.0`;
+  }
+
+  return semver.validRange(newRange) || range;
+}
+
 
-    // Add the major version as compatible with the angular compatible. This is already one
-    // major above the greatest supported, because we increment `major` before checking.
-    return semver.validRange(`^${major}.0.0-rc.0 || ${range}`) || range;
-  },
+// This is a map of packageGroupName to range extending function. If it isn't found, the range is
+// kept the same.
+const peerCompatibleWhitelist: { [name: string]: PeerVersionTransform } = {
+  '@angular/core': angularMajorCompatGuarantee,
 };
 
 interface PackageVersionInfo {
@@ -143,20 +153,21 @@ function _validateReversePeerDependencies(
     installedLogger.debug(`${installed}...`);
     const peers = (installedInfo.target || installedInfo.installed).packageJson.peerDependencies;
 
-    for (let [peer, range] of Object.entries(peers || {})) {
+    for (const [peer, range] of Object.entries(peers || {})) {
       if (peer != name) {
         // Only check peers to the packages we're updating. We don't care about peers
         // that are unmet but we have no effect on.
         continue;
       }
 
       // Override the peer version range if it's whitelisted.
-      range = _updatePeerVersion(infoMap, peer, range);
+      const extendedRange = _updatePeerVersion(infoMap, peer, range);
 
-      if (!semver.satisfies(version, range)) {
+      if (!semver.satisfies(version, extendedRange)) {
         logger.error([
           `Package ${JSON.stringify(installed)} has an incompatible peer dependency to`,
-          `${JSON.stringify(name)} (requires ${JSON.stringify(range)},`,
+          `${JSON.stringify(name)} (requires`,
+          `${JSON.stringify(range)}${extendedRange == range ? '' : ' (extended)'},`,
           `would install ${JSON.stringify(version)}).`,
         ].join(' '));
 
diff --git a/packages/schematics/update/update/index_spec.ts b/packages/schematics/update/update/index_spec.ts
@@ -9,8 +9,28 @@ import { normalize, virtualFs } from '@angular-devkit/core';
 import { HostTree, VirtualTree } from '@angular-devkit/schematics';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
 import { map } from 'rxjs/operators';
+import * as semver from 'semver';
+import { angularMajorCompatGuarantee } from './index';
 
 
+describe('angularMajorCompatGuarantee', () => {
+  [
+    '5.0.0',
+    '5.1.0',
+    '5.20.0',
+    '6.0.0',
+    '6.0.0-rc.0',
+    '6.0.0-beta.0',
+    '6.1.0-beta.0',
+    '6.1.0-rc.0',
+    '6.10.11',
+  ].forEach(golden => {
+    it('works with ' + JSON.stringify(golden), () => {
+      expect(semver.satisfies(golden, angularMajorCompatGuarantee('^5.0.0'))).toBeTruthy();
+    });
+  });
+});
+
 describe('@schematics/update', () => {
   const schematicRunner = new SchematicTestRunner(
     '@schematics/update', __dirname + '/../collection.json',
@@ -180,7 +200,7 @@ describe('@schematics/update', () => {
         expect(packageJson['dependencies']['@angular/core'][0]).toBe('6');
         expect(packageJson['dependencies']['rxjs'][0]).toBe('6');
         expect(packageJson['dependencies']['typescript'][0]).toBe('2');
-        expect(packageJson['dependencies']['typescript'][2]).toBe('7');
+        expect(packageJson['dependencies']['typescript'][2]).not.toBe('4');
 
         // Check install task.
         expect(schematicRunner.tasks).toEqual([
