Use semver to compare versions

Author: ivanovit

package.json

@@ -26,6 +26,7 @@
   "license": "SEE LICENSE IN LICENSE.txt",
   "dependencies": {
     "lodash": "^4.17.10",
+    "semver": "^5.5.0",
     "universal-analytics": "0.4.13",
     "uuid": "^3.2.1",
     "vscode-chrome-debug-core": "^3.23.11",

src/analytics/analyticsService.ts

@@ -1,5 +1,4 @@
 import * as os from 'os';
-import { Version } from '../common/version';
 import { GUAService } from './guaService';
 import { AnalyticsBaseInfo, OperatingSystem } from './analyticsBaseInfo';
 import { Services } from '../services/extensionHostServices';
@@ -22,14 +21,14 @@ export class AnalyticsService {
     private _gua: GUAService;
     private _analyticsEnabled: boolean;
 
-    constructor(globalState: vscode.Memento) {
+    constructor(globalState: vscode.Memento, cliVersion: string, extensionVersion: string) {
         this._globalState = globalState;
 
         vscode.workspace.onDidChangeConfiguration(() => this.updateAnalyticsEnabled());
 
         this._baseInfo = {
-            cliVersion: Services.cli().version.toString(),
-            extensionVersion: utils.getInstalledExtensionVersion().toString(),
+            cliVersion,
+            extensionVersion,
             operatingSystem: AnalyticsService.getOperatingSystem(),
             clientId: this.getOrGenerateClientId()
         };

src/common/utilities.ts

@@ -1,16 +1,6 @@
-import {Version} from './version';
 import {ChildProcess, exec} from 'child_process';
 import * as os from 'os';
 
-
-export function getInstalledExtensionVersion(): Version {
-    return Version.parse(require('../../package.json').version);
-}
-
-export function getMinSupportedCliVersion(): Version {
-    return Version.parse(require('../../package.json').minNativescriptCliVersion);
-}
-
 export function killProcess(childProcess: ChildProcess) : void {
     switch (process.platform) {
         case "win32":

src/common/version.ts

@@ -63,7 +63,8 @@ export class NativeScriptDebugAdapter extends ChromeDebugAdapter {
         this.callRemoteMethod('analyticsService', 'launchDebugger', args.request, args.platform);
 
         // Run CLI Command
-        this.log(`[NSDebugAdapter] Using tns CLI v${project.cli.version.version} on path '${project.cli.path}'\n`);
+        const version = project.cli.executeGetVersion();
+        this.log(`[NSDebugAdapter] Using tns CLI v${version} on path '${project.cli.path}'\n`);
         this.log('[NSDebugAdapter] Running tns command...\n');
         let cliCommand: DebugResult;
 

src/debug-adapter/nativeScriptDebugAdapter.ts

@@ -1,5 +1,4 @@
 import * as vscode from 'vscode';
-import {CliVersion} from './project/nativeScriptCli';
 import {Services} from './services/extensionHostServices';
 import {Project} from './project/project';
 import {IosProject} from './project/iosProject';
@@ -8,23 +7,36 @@ import * as utils from './common/utilities';
 import * as extProtocol from './common/extensionProtocol';
 import { ChannelLogger } from './services/channelLogger';
 import { ILogger } from './common/logger';
+import * as semver from "semver";
 
 // this method is called when the extension is activated
 export function activate(context: vscode.ExtensionContext) {
     Services.globalState = context.globalState;
     Services.cliPath = Services.workspaceConfigService.tnsPath || Services.cliPath;
 
     const channel = vscode.window.createOutputChannel("NativeScript Extension");
-    const logger = new ChannelLogger(channel);
-    Services.logger = logger;
+    Services.logger = new ChannelLogger(channel);
 
-    // Check if NativeScript CLI is installed globally and if it is compatible with the extension version
-    let cliVersion = Services.cli().version;
-    if (!cliVersion.isCompatible) {
-        vscode.window.showErrorMessage(cliVersion.errorMessage);
+    const packageJSON = vscode.extensions.getExtension("Telerik.nativescript").packageJSON;
+    const cliVersion = Services.cli().executeGetVersion();
+
+    if(!cliVersion) {
+        vscode.window.showErrorMessage("NativeScript CLI not found. Use 'nativescript.tnsPath' workspace setting to explicitly set the absolute path to the NativeScript CLI.");
+
+        return;
     }
 
-    logExtensionInfo(logger, cliVersion.version.toString());
+    if(!semver.gte(cliVersion, packageJSON.minNativescriptCliVersion)) {
+        vscode.window.showErrorMessage( `The existing NativeScript extension is compatible with NativeScript CLI v${packageJSON.minNativescriptCliVersion} or greater.
+            The currently installed NativeScript CLI is v${cliVersion}.You can update the NativeScript CLI by executing 'npm install -g nativescript'.`);
+
+        return;
+    }
+
+    Services.cliVersion = cliVersion;
+    Services.extensionVersion = packageJSON.version;
+
+    logExtensionInfo(cliVersion, packageJSON);
 
     Services.analyticsService.initialize();
 
@@ -106,11 +118,9 @@ export function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(showOutputChannelCommand);
 }
 
-function logExtensionInfo(logger: ILogger, cliVersion: string): void {
-    const packageJSON = vscode.extensions.getExtension("Telerik.nativescript").packageJSON;
-
-    packageJSON.version && logger.log(`Version: ${packageJSON.version}`);
-    packageJSON.buildVersion && logger.log(`Build version: ${packageJSON.buildVersion}`);
-    packageJSON.commitId && logger.log(`Commit id: ${packageJSON.commitId}`);
-    logger.log(`NativeScript CLI: ${cliVersion}`);
+function logExtensionInfo(cliVersion: string, packageJSON: any): void {
+    packageJSON.version && Services.logger.log(`Version: ${packageJSON.version}`);
+    packageJSON.buildVersion && Services.logger.log(`Build version: ${packageJSON.buildVersion}`);
+    packageJSON.commitId && Services.logger.log(`Commit id: ${packageJSON.commitId}`);
+    Services.logger.log(`NativeScript CLI: ${cliVersion}`);
 }

src/main.ts

@@ -3,7 +3,6 @@ import * as stream from 'stream';
 import {EventEmitter} from 'events';
 import {Project, DebugResult} from './project';
 import * as scanner from './streamScanner';
-import {Version} from '../common/version';
 import {NativeScriptCli} from './nativeScriptCli';
 
 export type GetDebugPortResult = { tnsProcess: ChildProcess, debugPort: Promise<number> };

src/project/androidProject.ts

@@ -3,7 +3,6 @@ import * as stream from 'stream';
 import {EventEmitter} from 'events';
 import {Project, DebugResult} from './project';
 import * as scanner from './streamScanner';
-import {Version} from '../common/version';
 import {NativeScriptCli} from './nativeScriptCli';
 
 export class IosProject extends Project {

src/project/iosProject.ts

@@ -1,52 +1,11 @@
 import {spawn, execSync, ChildProcess} from 'child_process';
-import {Version} from '../common/version';
 import { ILogger } from '../common/logger';
 import * as utils from '../common/utilities';
 import * as os from 'os';
 
-export enum CliVersionState {
-    NotExisting,
-    OlderThanSupported,
-    Compatible
-}
-
-export class CliVersion {
-    private _cliVersion: Version = undefined;
-    private _minExpectedCliVersion: Version = undefined;
-    private _cliVersionState: CliVersionState;
-    private _cliVersionErrorMessage: string;
-
-    constructor(cliVersion: Version, minExpectedCliVersion: Version) {
-        this._cliVersion = cliVersion;
-        this._minExpectedCliVersion = minExpectedCliVersion;
-
-        // Calculate CLI version state and CLI version error message
-        this._cliVersionState = CliVersionState.Compatible;
-        if (minExpectedCliVersion) {
-            if (this._cliVersion === null) {
-                this._cliVersionState = CliVersionState.NotExisting;
-                this._cliVersionErrorMessage = "NativeScript CLI not found, please run 'npm -g install nativescript' to install it.";
-            }
-            else if (this._cliVersion.compareBySubminorTo(minExpectedCliVersion) < 0) {
-                this._cliVersionState = CliVersionState.OlderThanSupported;
-                this._cliVersionErrorMessage = `The existing NativeScript extension is compatible with NativeScript CLI v${this._minExpectedCliVersion} or greater. The currently installed NativeScript CLI is v${this._cliVersion}. You can update the NativeScript CLI by executing 'npm install -g nativescript'.`;
-            }
-        }
-    }
-
-    public get version() { return this._cliVersion; }
-
-    public get state() { return this._cliVersionState; }
-
-    public get isCompatible() { return this._cliVersionState == CliVersionState.Compatible; }
-
-    public get errorMessage() { return this._cliVersionErrorMessage; }
-}
-
 export class NativeScriptCli {
     private _path: string;
     private _shellPath: string;
-    private _cliVersion: CliVersion;
     private _logger: ILogger;
 
     constructor(cliPath: string, logger: ILogger) {
@@ -60,26 +19,18 @@ export class NativeScriptCli {
         if (utils.getPlatform() === utils.Platform.Windows) {
             this._shellPath = "cmd.exe";
         }
+    }
+
+    public get path(): string { return this._path; }
 
-        let versionStr = null;
+    public executeGetVersion(): string {
         try {
-            versionStr = this.executeSync(["--version"], undefined);
+            return this.executeSync(["--version"], undefined);
         }
         catch(e) {
             this._logger.log(e);
             throw new Error("NativeScript CLI not found. Use 'nativescript.tnsPath' workspace setting to explicitly set the absolute path to the NativeScript CLI.");
         }
-        let cliVersion: Version = versionStr ? Version.parse(versionStr) : null;
-        this._cliVersion = new CliVersion(cliVersion, utils.getMinSupportedCliVersion());
-        if (!this._cliVersion.isCompatible) {
-            throw new Error(this._cliVersion.errorMessage);
-        }
-    }
-
-    public get path(): string { return this._path; }
-
-    public get version(): CliVersion {
-        return this._cliVersion;
     }
 
     public executeSync(args: string[], cwd: string): string {

src/project/nativeScriptCli.ts

@@ -1,6 +1,5 @@
 import {ChildProcess} from 'child_process';
 import {EventEmitter} from 'events';
-import {Version} from '../common/version';
 import {NativeScriptCli} from './nativeScriptCli';
 import * as stream from 'stream';
 import * as scanner from './streamScanner';

src/project/project.ts

@@ -11,6 +11,9 @@ export class ExtensionHostServices extends BaseServices {
     private _iOSTeamService: iOSTeamService;
     private _analyticsService: AnalyticsService;
 
+    public cliVersion: string;
+    public extensionVersion: string;
+
     public get globalState(): vscode.Memento { return this._globalState; }
 
     public set globalState(globalState: vscode.Memento) { this._globalState = globalState; }
@@ -26,7 +29,7 @@ export class ExtensionHostServices extends BaseServices {
     }
 
     public get analyticsService(): AnalyticsService {
-        this._analyticsService = this._analyticsService || new AnalyticsService(this.globalState);
+        this._analyticsService = this._analyticsService || new AnalyticsService(this.globalState, this.cliVersion, this.extensionVersion);
         return this._analyticsService;
     }
 }