Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

fix(@schematics/update): respect caret and tilde ranges #884

Merged
filipesilva merged 1 commit into from
May 10, 2018
Merged

fix(@schematics/update): respect caret and tilde ranges #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix(@schematics/update): respect caret and tilde ranges 
Fix angular/angular-cli#10356
  • Loading branch information
@filipesilva
filipesilva committed May 10, 2018
commit 1a981e9d458f5c6d7ffb0daad4185012ff504fc7
15 changes: 11 additions & 4 deletions packages/schematics/update/update/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { map, mergeMap, reduce, switchMap } from 'rxjs/operators';
import * as semver from 'semver';
import { getNpmPackageJson } from './npm';
import { NpmRepositoryPackageJson } from './npm-package-json';
import { JsonSchemaForNpmPackageJsonFiles } from './package-json';
import { Dependency, JsonSchemaForNpmPackageJsonFiles } from './package-json';
import { UpdateSchema } from './schema';

type VersionRange = string & { __VERSION_RANGE: void; };
Expand Down Expand Up @@ -220,6 +220,13 @@ function _performUpdate(
throw new SchematicsException('package.json could not be parsed: ' + e.message);
}

const updateDependency = (deps: Dependency, name: string, newVersion: string) => {
const oldVersion = deps[name];
// We only respect caret and tilde ranges on update.
const execResult = /^[\^~]/.exec(oldVersion);
deps[name] = `${execResult ? execResult[0] : ''}${newVersion}`;
};

const toInstall = [...infoMap.values()]
.map(x => [x.name, x.target, x.installed])
// tslint:disable-next-line:non-null-operator
Expand All @@ -234,7 +241,7 @@ function _performUpdate(
);

if (packageJson.dependencies && packageJson.dependencies[name]) {
packageJson.dependencies[name] = target.version;
updateDependency(packageJson.dependencies, name, target.version);

if (packageJson.devDependencies && packageJson.devDependencies[name]) {
delete packageJson.devDependencies[name];
Expand All @@ -243,13 +250,13 @@ function _performUpdate(
delete packageJson.peerDependencies[name];
}
} else if (packageJson.devDependencies && packageJson.devDependencies[name]) {
packageJson.devDependencies[name] = target.version;
updateDependency(packageJson.devDependencies, name, target.version);

if (packageJson.peerDependencies && packageJson.peerDependencies[name]) {
delete packageJson.peerDependencies[name];
}
} else if (packageJson.peerDependencies && packageJson.peerDependencies[name]) {
packageJson.peerDependencies[name] = target.version;
updateDependency(packageJson.peerDependencies, name, target.version);
} else {
logger.warn(`Package ${name} was not found in dependencies.`);
}
Expand Down
22 changes: 22 additions & 0 deletions packages/schematics/update/update/index_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,28 @@ describe('@schematics/update', () => {
).subscribe(undefined, done.fail, done);
}, 45000);

it('respects existing tilde and caret ranges', done => {
// Add ranges.
const content = virtualFs.fileBufferToString(host.sync.read(normalize('/package.json')));
const packageJson = JSON.parse(content);
packageJson['dependencies']['@angular-devkit-tests/update-base'] = '^1.0.0';
packageJson['dependencies']['@angular-devkit-tests/update-migrations'] = '~1.0.0';
host.sync.write(
normalize('/package.json'),
virtualFs.stringToFileBuffer(JSON.stringify(packageJson)),
);

schematicRunner.runSchematicAsync('update', { all: true }, appTree).pipe(
map(tree => {
const packageJson = JSON.parse(tree.readContent('/package.json'));
// This one should not change because 1.1.0 was already satisfied by ^1.0.0.
expect(packageJson['dependencies']['@angular-devkit-tests/update-base']).toBe('^1.0.0');

@clydin clydin May 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't this cause 1.1.0 to not be used due to an existing lock file?

@filipesilva filipesilva May 10, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can tell, that behaviour is intentional:

devkit/packages/schematics/update/update/index.ts

Lines 535 to 538 in e6379b1

if (targetVersion && semver.lte(targetVersion, installedVersion)) {
logger.debug(`Package ${name} already satisfied by package.json (${packageJsonRange}).`);
targetVersion = undefined;
}

At this point, the new version is already installed though, and presumably the lockfile is updated.

@clydin clydin May 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Could envision some issue reports in the future regarding the behavior though.

expect(packageJson['dependencies']['@angular-devkit-tests/update-migrations'])
.toBe('~1.6.0');
}),
).subscribe(undefined, done.fail, done);
}, 45000);

it('calls migration tasks', done => {
// Add the basic migration package.
const content = virtualFs.fileBufferToString(host.sync.read(normalize('/package.json')));
Expand Down