Use GitCommitId to avoid pointless update checks

And remove an unused `IRunspaceDetails` interface.

Author: andyleejordan

src/features/UpdatePowerShell.ts

@@ -53,7 +53,11 @@ export class UpdatePowerShell {
         private sessionSettings: Settings,
         private logger: ILogger,
         versionDetails: IPowerShellVersionDetails) {
-        this.localVersion = new SemVer(versionDetails.version);
+        // We use the commit field as it's like
+        // '7.3.0-preview.3-508-g07175ae0ff8eb7306fe0b0fc7d...' which translates
+        // to SemVer. The version handler in PSES handles Windows PowerShell and
+        // just returns the first three fields like '5.1.22621'.
+        this.localVersion = new SemVer(versionDetails.commit);
         this.architecture = versionDetails.architecture.toLowerCase();
     }
 
@@ -77,8 +81,22 @@ export class UpdatePowerShell {
             return false;
         }
 
-        // TODO: Check if PowerShell is self-built, i.e. PSVersionInfo.GitCommitId.Length > 40.
-        // TODO: Check if preview is a daily build.
+        if (this.localVersion.prerelease.length > 1) {
+            const prerelease = this.localVersion.prerelease[1].toString();
+
+            // Skip if PowerShell is self-built, that is, this contains a commit hash.
+            if (prerelease.length >= 40) {
+                this.logger.writeDiagnostic("Not offering to update development build.");
+                return false;
+            }
+
+            // Skip if preview is a daily build.
+            if (prerelease.toLowerCase().match("daily")) {
+                this.logger.writeDiagnostic("Not offering to update daily build.");
+                return false;
+            }
+        }
+
         // TODO: Check if network is available?
         // TODO: Only check once a week.
         this.logger.writeDiagnostic("Should check for PowerShell update.");

src/session.ts

@@ -24,6 +24,7 @@ import {
     OperatingSystem, PowerShellExeFinder
 } from "./platform";
 import { LanguageClientConsumer } from "./languageClientConsumer";
+import { SemVer } from "semver";
 
 export enum SessionStatus {
     NeverStarted,
@@ -54,17 +55,11 @@ export interface IEditorServicesSessionDetails {
 
 export interface IPowerShellVersionDetails {
     version: string;
-    displayVersion: string;
     edition: string;
+    commit: string;
     architecture: string;
 }
 
-export interface IRunspaceDetails {
-    powerShellVersion: IPowerShellVersionDetails;
-    runspaceType: RunspaceType;
-    connectionString: string;
-}
-
 export type IReadSessionFileCallback = (details: IEditorServicesSessionDetails) => void;
 
 export const SendKeyPressNotificationType =
@@ -734,12 +729,9 @@ Type 'help' to get help.
         this.languageStatusItem.detail = "PowerShell";
 
         if (this.versionDetails !== undefined) {
-            const version = this.versionDetails.architecture.toLowerCase() !== "x64"
-                ? `${this.versionDetails.displayVersion} (${this.versionDetails.architecture.toLowerCase()})`
-                : this.versionDetails.displayVersion;
-
-            this.languageStatusItem.text = "$(terminal-powershell) " + version;
-            this.languageStatusItem.detail += " " + version;
+            const semver = new SemVer(this.versionDetails.version);
+            this.languageStatusItem.text = `$(terminal-powershell) ${semver.major}.${semver.minor}`;
+            this.languageStatusItem.detail += ` ${this.versionDetails.commit} (${this.versionDetails.architecture.toLowerCase()})`;
         }
 
         if (statusText) {
@@ -835,7 +827,7 @@ Type 'help' to get help.
                 const powerShellSessionName =
                         currentPowerShellExe ?
                             currentPowerShellExe.displayName :
-                            `PowerShell ${this.versionDetails.displayVersion} ` +
+                            `PowerShell ${this.versionDetails.version} ` +
                             `(${this.versionDetails.architecture.toLowerCase()}) ${this.versionDetails.edition} Edition ` +
                             `[${this.versionDetails.version}]`;
 

test/features/UpdatePowerShell.test.ts

@@ -27,8 +27,8 @@ describe("UpdatePowerShell feature", function () {
             process.env.POWERSHELL_UPDATECHECK = "Default";
             const version: IPowerShellVersionDetails = {
                 "version": "7.3.0",
-                "displayVersion": "7.3",
                 "edition": "Core",
+                "commit": "7.3.0",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.
@@ -39,10 +39,9 @@ describe("UpdatePowerShell feature", function () {
 
         it("Won't check for Windows PowerShell", function () {
             const version: IPowerShellVersionDetails = {
-                // TODO: This should handle e.g. 5.1.22621.436
-                "version": "5.1.0",
-                "displayVersion": "5.1",
+                "version": "5.1.22621",
                 "edition": "Desktop",
+                "commit": "5.1.22621",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.
@@ -51,12 +50,25 @@ describe("UpdatePowerShell feature", function () {
             assert(!updater.shouldCheckForUpdate());
         });
 
+        it("Won't check for a development build of PowerShell", function () {
+            const version: IPowerShellVersionDetails = {
+                "version": "7.3.0-preview.3",
+                "edition": "Core",
+                "commit": "7.3.0-preview.3-508-g07175ae0ff8eb7306fe0b0fc7d19bdef4fbf2d67",
+                "architecture": "Arm64"
+            };
+            // @ts-expect-error testing doesn't require all arguments.
+            const updater = new UpdatePowerShell(undefined, settings, testLogger, version);
+            // @ts-expect-error method is private.
+            assert(!updater.shouldCheckForUpdate());
+        });
+
         it("Won't check if POWERSHELL_UPDATECHECK is 'Off'", function () {
             process.env.POWERSHELL_UPDATECHECK = "Off";
             const version: IPowerShellVersionDetails = {
                 "version": "7.3.0",
-                "displayVersion": "7.3",
                 "edition": "Core",
+                "commit": "7.3.0",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.
@@ -69,8 +81,8 @@ describe("UpdatePowerShell feature", function () {
             process.env.POWERSHELL_UPDATECHECK = "Default";
             const version: IPowerShellVersionDetails = {
                 "version": "7.3.0",
-                "displayVersion": "7.3",
                 "edition": "Core",
+                "commit": "7.3.0",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.
@@ -85,8 +97,8 @@ describe("UpdatePowerShell feature", function () {
             process.env.POWERSHELL_UPDATECHECK = "LTS";
             const version: IPowerShellVersionDetails = {
                 "version": "7.0.0",
-                "displayVersion": "7.0",
                 "edition": "Core",
+                "commit": "7.0.0",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.
@@ -100,8 +112,8 @@ describe("UpdatePowerShell feature", function () {
         it("Would update to stable", async function() {
             const version: IPowerShellVersionDetails = {
                 "version": "7.0.0",
-                "displayVersion": "7.0",
                 "edition": "Core",
+                "commit": "7.0.0",
                 "architecture": "X64"
             };
             // @ts-expect-error testing doesn't require all arguments.