fix: do not allow invalid version during tns migrate

Author: DimitarTachev

lib/controllers/migrate-controller.ts

@@ -75,9 +75,9 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		{ packageName: "nativescript-cardview", verifiedVersion: "3.2.0" },
 		{
 			packageName: "nativescript-unit-test-runner", verifiedVersion: "0.6.4",
-			shouldMigrateAction: async (projectData: IProjectData) => {
+			shouldMigrateAction: async (projectData: IProjectData, allowInvalidVersions: boolean) => {
 				const dependency = { packageName: "nativescript-unit-test-runner", verifiedVersion: "0.6.4", isDev: false };
-				const result = this.hasDependency(dependency, projectData) && await this.shouldMigrateDependencyVersion(dependency, projectData);
+				const result = this.hasDependency(dependency, projectData) && await this.shouldMigrateDependencyVersion(dependency, projectData, allowInvalidVersions);
 				return result;
 			},
 			migrateAction: this.migrateUnitTestRunner.bind(this)
@@ -95,7 +95,7 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		};
 	}
 
-	public async migrate({ projectDir, platforms }: IMigrationData): Promise<void> {
+	public async migrate({ projectDir, platforms, allowInvalidVersions = false }: IMigrationData): Promise<void> {
 		const projectData = this.$projectDataService.getProjectData(projectDir);
 		const backupDir = path.join(projectDir, MigrateController.backupFolder);
 
@@ -121,7 +121,7 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 
 		try {
 			await this.cleanUpProject(projectData);
-			await this.migrateDependencies(projectData, platforms);
+			await this.migrateDependencies(projectData, platforms, allowInvalidVersions);
 		} catch (error) {
 			this.restoreBackup(MigrateController.folders, backupDir, projectData.projectDir);
 			this.$errors.failWithoutHelp(`${MigrateController.migrateFailMessage} The error is: ${error}`);
@@ -130,15 +130,15 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		this.$logger.info(MigrateController.MIGRATE_FINISH_MESSAGE);
 	}
 
-	public async shouldMigrate({ projectDir, platforms }: IMigrationData): Promise<boolean> {
+	public async shouldMigrate({ projectDir, platforms, allowInvalidVersions = false }: IMigrationData): Promise<boolean> {
 		const projectData = this.$projectDataService.getProjectData(projectDir);
 		const shouldMigrateCommonMessage = "The app is not compatible with this CLI version and it should be migrated. Reason: ";
 
 		for (let i = 0; i < this.migrationDependencies.length; i++) {
 			const dependency = this.migrationDependencies[i];
 			const hasDependency = this.hasDependency(dependency, projectData);
 
-			if (hasDependency && dependency.shouldMigrateAction && await dependency.shouldMigrateAction(projectData)) {
+			if (hasDependency && dependency.shouldMigrateAction && await dependency.shouldMigrateAction(projectData, allowInvalidVersions)) {
 				this.$logger.trace(`${shouldMigrateCommonMessage}'${dependency.packageName}' requires an update.`);
 				return true;
 			}
@@ -148,7 +148,7 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 				return true;
 			}
 
-			if (hasDependency && await this.shouldMigrateDependencyVersion(dependency, projectData)) {
+			if (hasDependency && await this.shouldMigrateDependencyVersion(dependency, projectData, allowInvalidVersions)) {
 				this.$logger.trace(`${shouldMigrateCommonMessage}'${dependency.packageName}' should be updated.`);
 				return true;
 			}
@@ -163,15 +163,15 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 			platform = platform && platform.toLowerCase();
 
 			const hasRuntimeDependency = this.hasRuntimeDependency({ platform, projectData });
-			if (hasRuntimeDependency && await this.shouldUpdateRuntimeVersion({ targetVersion: this.verifiedPlatformVersions[platform.toLowerCase()], platform, projectData })) {
+			if (hasRuntimeDependency && await this.shouldUpdateRuntimeVersion(this.verifiedPlatformVersions[platform.toLowerCase()], platform, projectData, allowInvalidVersions)) {
 				this.$logger.trace(`${shouldMigrateCommonMessage}Platform '${platform}' should be updated.`);
 				return true;
 			}
 		}
 	}
 
-	public async validate({ projectDir, platforms }: IMigrationData): Promise<void> {
-		const shouldMigrate = await this.shouldMigrate({ projectDir, platforms });
+	public async validate({ projectDir, platforms, allowInvalidVersions = true }: IMigrationData): Promise<void> {
+		const shouldMigrate = await this.shouldMigrate({ projectDir, platforms, allowInvalidVersions });
 		if (shouldMigrate) {
 			this.$errors.failWithoutHelp(MigrateController.UNABLE_TO_MIGRATE_APP_ERROR);
 		}
@@ -275,26 +275,26 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		return autoGeneratedFiles;
 	}
 
-	private async migrateDependencies(projectData: IProjectData, platforms: string[]): Promise<void> {
+	private async migrateDependencies(projectData: IProjectData, platforms: string[], allowInvalidVersions: boolean): Promise<void> {
 		this.$logger.info("Start dependencies migration.");
 		for (let i = 0; i < this.migrationDependencies.length; i++) {
 			const dependency = this.migrationDependencies[i];
 			const hasDependency = this.hasDependency(dependency, projectData);
 
-			if (hasDependency && dependency.migrateAction && await dependency.shouldMigrateAction(projectData)) {
+			if (hasDependency && dependency.migrateAction && await dependency.shouldMigrateAction(projectData, allowInvalidVersions)) {
 				const newDependencies = await dependency.migrateAction(projectData, path.join(projectData.projectDir, MigrateController.backupFolder));
 				for (const newDependency of newDependencies) {
-					await this.migrateDependency(newDependency, projectData);
+					await this.migrateDependency(newDependency, projectData, allowInvalidVersions);
 				}
 			}
 
-			await this.migrateDependency(dependency, projectData);
+			await this.migrateDependency(dependency, projectData, allowInvalidVersions);
 		}
 
 		for (const platform of platforms) {
 			const lowercasePlatform = platform.toLowerCase();
 			const hasRuntimeDependency = this.hasRuntimeDependency({ platform, projectData });
-			if (hasRuntimeDependency && await this.shouldUpdateRuntimeVersion({ targetVersion: this.verifiedPlatformVersions[lowercasePlatform], platform, projectData })) {
+			if (hasRuntimeDependency && await this.shouldUpdateRuntimeVersion(this.verifiedPlatformVersions[lowercasePlatform], platform, projectData, allowInvalidVersions)) {
 				const verifiedPlatformVersion = this.verifiedPlatformVersions[lowercasePlatform];
 				const platformData = this.$platformsDataService.getPlatformData(lowercasePlatform, projectData);
 				this.$logger.info(`Updating ${platform} platform to version '${verifiedPlatformVersion}'.`);
@@ -313,7 +313,7 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		this.$logger.info("Migration complete.");
 	}
 
-	private async migrateDependency(dependency: IMigrationDependency, projectData: IProjectData): Promise<void> {
+	private async migrateDependency(dependency: IMigrationDependency, projectData: IProjectData, allowInvalidVersions: boolean): Promise<void> {
 		const hasDependency = this.hasDependency(dependency, projectData);
 		if (hasDependency && dependency.warning) {
 			this.$logger.warn(dependency.warning);
@@ -336,7 +336,7 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		}
 
 		const dependencyVersion = await this.getDependencyVerifiedVersion(dependency, projectData);
-		if (hasDependency && await this.shouldMigrateDependencyVersion(dependency, projectData)) {
+		if (hasDependency && await this.shouldMigrateDependencyVersion(dependency, projectData, allowInvalidVersions)) {
 			this.$logger.info(`Updating '${dependency.packageName}' to compatible version '${dependencyVersion}'`);
 			this.$pluginsService.addToPackageJson(dependency.packageName, dependencyVersion, dependency.isDev, projectData.projectDir);
 			return;
@@ -356,21 +356,25 @@ Running this command will ${MigrateController.COMMON_MIGRATE_MESSAGE}`;
 		return dependency.verifiedVersion;
 	}
 
-	private async shouldMigrateDependencyVersion(dependency: IMigrationDependency, projectData: IProjectData): Promise<boolean> {
+	private async shouldMigrateDependencyVersion(dependency: IMigrationDependency, projectData: IProjectData, allowInvalidVersions: boolean): Promise<boolean> {
 		const devDependencies = projectData.devDependencies || {};
 		const dependencies = projectData.dependencies || {};
 		const packageName = dependency.packageName;
 		const referencedVersion = dependencies[packageName] || devDependencies[packageName];
 		const installedVersion = await this.getMaxDependencyVersion(dependency.packageName, referencedVersion);
 		const requiredVersion = await this.getDependencyVerifiedVersion(dependency, projectData);
 
-		return !!installedVersion && semver.lt(installedVersion, requiredVersion);
+		return this.isOutdatedVersion(installedVersion, requiredVersion, allowInvalidVersions);
 	}
 
-	protected async shouldUpdateRuntimeVersion({ targetVersion, platform, projectData }: { targetVersion: string, platform: string, projectData: IProjectData }): Promise<boolean> {
-		const maxRuntimeVersion = await this.getMaxRuntimeVersion({ platform, projectData });
+	private async shouldUpdateRuntimeVersion(targetVersion: string, platform: string, projectData: IProjectData, allowInvalidVersions: boolean): Promise<boolean> {
+		const installedVersion = await this.getMaxRuntimeVersion({ platform, projectData });
 
-		return !(maxRuntimeVersion && semver.gte(maxRuntimeVersion, targetVersion));
+		return this.isOutdatedVersion(installedVersion, targetVersion, allowInvalidVersions);
+	}
+
+	private isOutdatedVersion(version: string, targetVersion: string, allowInvalidVersions: boolean): boolean {
+		return !!version ? semver.lt(version, targetVersion) : !allowInvalidVersions;
 	}
 
 	private async migrateUnitTestRunner(projectData: IProjectData, migrationBackupDirPath: string): Promise<IMigrationDependency[]> {

lib/definitions/migrate.d.ts

@@ -6,6 +6,7 @@ interface IMigrateController {
 
 interface IMigrationData extends IProjectDir {
 	platforms: string[];
+	allowInvalidVersions?: boolean;
 }
 
 interface IDependency {
@@ -20,6 +21,6 @@ interface IMigrationDependency extends IDependency {
 	verifiedVersion?: string;
 	getVerifiedVersion?: (projectData: IProjectData) => Promise<string>;
 	shouldAddIfMissing?: boolean;
-	shouldMigrateAction?: (projectData: IProjectData) => Promise<boolean>;
+	shouldMigrateAction?: (projectData: IProjectData, allowInvalidVersions: boolean) => Promise<boolean>;
 	migrateAction?: (projectData: IProjectData, migrationBackupDirPath: string) => Promise<IMigrationDependency[]>;
 }