Version class refactoring

Author: ivanbuhov

src/common/Version.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import * as child from 'child_process';
 import * as ns from './services/NsCliService';
-import {ExtensionVersionInfo} from './services/ExtensionVersionInfo';
+import {ExtensionVersionService} from './services/ExtensionVersionService';
 import {AnalyticsService} from './services/analytics/AnalyticsService';
 import {ExtensionServer} from './services/ipc/ExtensionServer';
 
@@ -13,20 +13,20 @@ function performVersionsCheck(context: vscode.ExtensionContext) {
     }
     else {
         // Checks whether a new version of the extension is available
-        let extensionVersionPromise: Promise<ExtensionVersionInfo> = null;
+        let extensionVersionPromise: Promise<ExtensionVersionService> = null;
 
         // Check the cache for extension version information
         let extensionVersion: any = context.globalState.get<any>('ExtensionVersionInfo');
         if (extensionVersion) {
-            let extensionVersionInfo = new ExtensionVersionInfo(extensionVersion.latestVersionMetadata, extensionVersion.timestamp);
+            let extensionVersionInfo = new ExtensionVersionService(extensionVersion.latestVersionMetadata, extensionVersion.timestamp);
             if (extensionVersionInfo.getTimestamp() > Date.now() - 24 * 60 * 60 * 1000 /* Cache the version for a day */) {
                 extensionVersionPromise = Promise.resolve(extensionVersionInfo);
             }
         }
 
         if (!extensionVersionPromise) {
             // Takes the slow path and checks for newer version in the VS Code Marketplace
-            extensionVersionPromise = ExtensionVersionInfo.createFromMarketplace();
+            extensionVersionPromise = ExtensionVersionService.createFromMarketplace();
         }
         extensionVersionPromise.then(extensionInfo => {
             if (extensionInfo) {

src/main.ts

@@ -3,9 +3,9 @@ import * as fs from 'fs';
 import {EventEmitter} from 'events';
 import * as path from 'path';
 import * as https from 'https';
-import {Version} from '../common/Version';
+import {Version} from './version';
 import {Logger, Handlers, Tags} from '../services/Logger';
-import {ExtensionVersionInfo} from './ExtensionVersionInfo';
+import {ExtensionVersionService} from './ExtensionVersionService';
 import {DebugProtocol} from 'vscode-debugprotocol';
 
 export enum CliVersionState {
@@ -15,11 +15,11 @@ export enum CliVersionState {
 }
 
 export class CliVersionInfo {
-    private static installedCliVersion: number[] = null;
+    private static installedCliVersion: Version = null;
 
     private _state: CliVersionState;
 
-    public static getInstalledCliVersion(): number[] {
+    public static getInstalledCliVersion(): Version {
         if (this.installedCliVersion === null) {
             // get the currently installed CLI version
             let getVersionCommand: string = new CommandBuilder().appendParam('--version').buildAsString(); // tns --version
@@ -35,13 +35,13 @@ export class CliVersionInfo {
     }
 
     constructor() {
-        let installedCliVersion: number[] = CliVersionInfo.getInstalledCliVersion();
+        let installedCliVersion: Version = CliVersionInfo.getInstalledCliVersion();
         if (installedCliVersion === null) {
             this._state = CliVersionState.NotExisting;
         }
         else {
-            let minSupportedCliVersion = ExtensionVersionInfo.getMinSupportedNativeScriptVersion();
-            this._state = Version.compareBySubminor(installedCliVersion, minSupportedCliVersion) < 0 ? CliVersionState.OlderThanSupported : CliVersionState.Compatible;
+            let minSupportedCliVersion = ExtensionVersionService.getMinSupportedNativeScriptVersion();
+            this._state = installedCliVersion.compareBySubminorTo(minSupportedCliVersion) < 0 ? CliVersionState.OlderThanSupported : CliVersionState.Compatible;
         }
     }
 
@@ -58,7 +58,7 @@ export class CliVersionInfo {
             case CliVersionState.NotExisting:
                 return `NativeScript CLI not found, please run 'npm -g install nativescript' to install it.`;
             case CliVersionState.OlderThanSupported:
-                return `The existing NativeScript extension is compatible with NativeScript CLI v${Version.stringify(ExtensionVersionInfo.getMinSupportedNativeScriptVersion())} or greater. The currently installed NativeScript CLI is v${Version.stringify(CliVersionInfo.getInstalledCliVersion())}. You can update the NativeScript CLI by executing 'npm install -g nativescript'.`;
+                return `The existing NativeScript extension is compatible with NativeScript CLI v${ExtensionVersionService.getMinSupportedNativeScriptVersion()} or greater. The currently installed NativeScript CLI is v${CliVersionInfo.getInstalledCliVersion()}. You can update the NativeScript CLI by executing 'npm install -g nativescript'.`;
             default:
                 return null;
         }

src/services/NsCliService.ts

@@ -1,10 +1,10 @@
 import * as os from 'os';
 import * as vscode from 'vscode';
-import { Version } from '../../common/Version';
+import { Version } from '../version';
 import { GUAService } from './GUAService';
 import { TelerikAnalyticsService } from './TelerikAnalyticsService';
 import { AnalyticsBaseInfo, OperatingSystem } from './AnalyticsBaseInfo';
-import { ExtensionVersionInfo } from '../ExtensionVersionInfo';
+import { ExtensionVersionService } from '../ExtensionVersionService';
 import * as ns from '../NsCliService';
 
 export class AnalyticsService {
@@ -48,8 +48,8 @@ export class AnalyticsService {
         };
 
         this._baseInfo = {
-            cliVersion: Version.stringify(ns.CliVersionInfo.getInstalledCliVersion()),
-            extensionVersion: Version.stringify(ExtensionVersionInfo.getExtensionVersion()),
+            cliVersion: ns.CliVersionInfo.getInstalledCliVersion().toString(),
+            extensionVersion: ExtensionVersionService.getExtensionVersion().toString(),
             operatingSystem: operatingSystem,
             userId: AnalyticsService.generateMachineId()
         };

src/services/analytics/AnalyticsService.ts

@@ -1,9 +1,9 @@
-import {Version} from '../common/Version';
 import * as https from 'https';
+import {Version} from './version';
 
-export class ExtensionVersionInfo {
-    private static extensionVersion: number[] = null;
-    private static minNativescriptCliVersion: number[] = null;
+export class ExtensionVersionService {
+    private static extensionVersion: Version = null;
+    private static minNativescriptCliVersion: Version = null;
     private static extensionId: string = '8d837914-d8fa-45b5-965d-f76ebd6dbf5c';
     private static marketplaceQueryResult: Promise<any> = null;
 
@@ -16,14 +16,14 @@ export class ExtensionVersionInfo {
         this.minNativescriptCliVersion = Version.parse(packageJson.minNativescriptCliVersion);
     }
 
-    public static getExtensionVersion(): number[] {
+    public static getExtensionVersion(): Version {
         if (this.extensionVersion === null) {
             this.initVersionsFromPackageJson();
         }
         return this.extensionVersion;
     }
 
-    public static getMinSupportedNativeScriptVersion(): number[] {
+    public static getMinSupportedNativeScriptVersion(): Version {
         if (this.minNativescriptCliVersion === null) {
             this.initVersionsFromPackageJson();
         }
@@ -33,7 +33,7 @@ export class ExtensionVersionInfo {
     public static getMarketplaceExtensionData(): Promise<any> {
         if (this.marketplaceQueryResult == null) {
             this.marketplaceQueryResult = new Promise<any>((resolve, reject) => {
-                let postData: string = `{ filters: [{ criteria: [{ filterType: 4, value: "${ExtensionVersionInfo.extensionId}" }] }], flags: 262 }`;
+                let postData: string = `{ filters: [{ criteria: [{ filterType: 4, value: "${ExtensionVersionService.extensionId}" }] }], flags: 262 }`;
 
                 let request = https.request({
                     hostname: 'marketplace.visualstudio.com',
@@ -69,16 +69,16 @@ export class ExtensionVersionInfo {
         return this.marketplaceQueryResult;
     }
 
-    public static createFromMarketplace(): Promise<ExtensionVersionInfo> {
+    public static createFromMarketplace(): Promise<ExtensionVersionService> {
         return this.getMarketplaceExtensionData()
         .then(marketplaceData => {
             let latestVersion = null;
             try {
-                if (marketplaceData.results[0].extensions[0].extensionId == ExtensionVersionInfo.extensionId) {
+                if (marketplaceData.results[0].extensions[0].extensionId == ExtensionVersionService.extensionId) {
                     latestVersion = marketplaceData.results[0].extensions[0].versions[0];
                 }
             } catch (e) { }
-            return new ExtensionVersionInfo(latestVersion);
+            return new ExtensionVersionService(latestVersion);
         });
     }
 
@@ -95,7 +95,7 @@ export class ExtensionVersionInfo {
         if (!this.getLatestVersionMeta()) {
             return true;
         }
-        return Version.compareBySubminor(ExtensionVersionInfo.getExtensionVersion(), Version.parse(this.getLatestVersionMeta().version)) >= 0;
+        return ExtensionVersionService.getExtensionVersion().compareBySubminorTo(Version.parse(this.getLatestVersionMeta().version)) >= 0;
     }
 
     public getTimestamp(): number {

src/services/ExtensionVersionInfo.ts renamed to src/services/extensionVersionService.ts

@@ -0,0 +1,28 @@
+export class Version {
+    private _version: number[];
+
+    public static parse(versionStr: string): Version {
+        if (versionStr === null) {
+            return null;
+        }
+        let version: number[] = versionStr.split('.').map<number>((str, index, array) => parseInt(str));
+        for(let i = version.length; i < 3; i++) {
+            version.push(0);
+        }
+        return new Version(version);
+    }
+
+    constructor(version: number[]) {
+        this._version = version;
+    }
+
+    public toString(): string {
+        return `${this._version[0]}.${this._version[1]}.${this._version[2]}`;
+    }
+
+    public compareBySubminorTo(other: Version): number {
+        let v1 = this._version;
+        let v2 = other._version;
+        return (v1[0] - v2[0] != 0) ? (v1[0] - v2[0]) : (v1[1] - v2[1] != 0) ? v1[1] - v2[1] : v1[2] - v2[2];
+    }
+}