Merge pull request #3310 from nkomonen-amazon/minimumVersion

fix(codecatalyst): Notify ssh extension min version required

Author: nkomonen-amazon

src/codecatalyst/tools.ts

@@ -24,7 +24,7 @@ import { getLogger } from '../shared/logger'
 import { getIdeProperties } from '../shared/extensionUtilities'
 import { showConfirmationMessage } from '../shared/utilities/messages'
 import { getSshConfigPath } from '../shared/extensions/ssh'
-import { VSCODE_EXTENSION_ID } from '../shared/extensions'
+import { VSCODE_EXTENSION_ID, vscodeExtensionMinVersion } from '../shared/extensions'
 
 interface DependencyPaths {
     readonly vsc: string
@@ -40,8 +40,13 @@ interface MissingTool {
 export const hostNamePrefix = 'aws-devenv-'
 
 export async function ensureDependencies(): Promise<Result<DependencyPaths, CancellationError | Error>> {
-    if (!isExtensionInstalled(VSCODE_EXTENSION_ID.remotessh)) {
-        showInstallExtensionMsg(VSCODE_EXTENSION_ID.remotessh, 'Remote SSH', 'Connecting to Dev Environment')
+    if (!isExtensionInstalled(VSCODE_EXTENSION_ID.remotessh, vscodeExtensionMinVersion.remotessh)) {
+        showInstallExtensionMsg(
+            VSCODE_EXTENSION_ID.remotessh,
+            'Remote SSH',
+            'Connecting to Dev Environment',
+            vscodeExtensionMinVersion.remotessh
+        )
 
         return Result.err(
             new ToolkitError('Remote SSH extension not installed', {

src/shared/extensions.ts

@@ -25,6 +25,10 @@ export const VSCODE_EXTENSION_ID = {
     remotessh: 'ms-vscode-remote.remote-ssh',
 }
 
+export const vscodeExtensionMinVersion = {
+    remotessh: '0.98.0',
+}
+
 /**
  * Long-lived, extension-scoped, shared globals.
  */

src/shared/utilities/vsCodeUtils.ts

@@ -10,6 +10,8 @@ import * as pathutils from './pathUtils'
 import { getLogger } from '../logger/logger'
 import { CancellationError, Timeout, waitTimeout, waitUntil } from './timeoutUtils'
 import { telemetry } from '../telemetry/telemetry'
+import * as semver from 'semver'
+import { isNonNullable } from './tsUtils'
 
 // TODO: Consider NLS initialization/configuration here & have packages to import localize from here
 export const localize = nls.loadMessageBundle()
@@ -53,8 +55,31 @@ export function isExtensionActive(extId: string): boolean {
     return !!extension && extension.isActive
 }
 
-export function isExtensionInstalled(extId: string): boolean {
-    return !!vscode.extensions.getExtension(extId)
+/**
+ * Checks if an extension is installed and meets the version requirement
+ * @param minVersion The minimum semver required for the extension
+ */
+export function isExtensionInstalled(
+    extId: string,
+    minVersion?: string,
+    getExtension = vscode.extensions.getExtension
+): boolean {
+    const ext = getExtension(extId)
+    if (ext === undefined) {
+        return false
+    }
+
+    if (minVersion === undefined) {
+        return true
+    }
+
+    // check ext has valid version
+    const extSemver = semver.coerce(ext.packageJSON.version)
+    const minSemver = semver.coerce(minVersion)
+    if (!isNonNullable(extSemver) || !isNonNullable(minSemver)) {
+        return false
+    }
+    return semver.gte(extSemver, minSemver)
 }
 
 /**
@@ -63,19 +88,14 @@ export function isExtensionInstalled(extId: string): boolean {
 export function showInstallExtensionMsg(
     extId: string,
     extName: string,
-    feat = `${getIdeProperties().company} Toolkit`
+    feat = `${getIdeProperties().company} Toolkit`,
+    minVersion?: string
 ): boolean {
-    if (vscode.extensions.getExtension(extId)) {
+    if (isExtensionInstalled(extId, minVersion)) {
         return true
     }
 
-    const msg = localize(
-        'AWS.missingExtension',
-        '{0} requires the {1} extension ({2}) to be installed and enabled.',
-        feat,
-        extName,
-        extId
-    )
+    const msg = buildMissingExtensionMessage(extId, extName, minVersion, feat)
 
     const installBtn = localize('AWS.missingExtension.install', 'Install...')
     const items = [installBtn]
@@ -90,6 +110,25 @@ export function showInstallExtensionMsg(
     return false
 }
 
+export function buildMissingExtensionMessage(
+    extId: string,
+    extName: string,
+    minVersion?: string,
+    feat = `${getIdeProperties().company} Toolkit`
+): string {
+    const minV = semver.coerce(minVersion)
+    const expectedVersionMsg = isNonNullable(minV) ? ` of version >=${minV}` : ''
+
+    return localize(
+        'AWS.missingExtension',
+        "{0} requires the {1} extension ('{2}'{3}) to be installed and enabled.",
+        feat,
+        extName,
+        extId,
+        expectedVersionMsg
+    )
+}
+
 /**
  * Activates an extension and returns it, or does nothing if the extension is
  * not installed.

src/test/shared/utilities/vscodeUtils.test.ts

@@ -6,6 +6,7 @@
 import * as assert from 'assert'
 import { VSCODE_EXTENSION_ID } from '../../../shared/extensions'
 import * as vscodeUtil from '../../../shared/utilities/vsCodeUtils'
+import * as vscode from 'vscode'
 
 describe('vscodeUtils', async function () {
     it('activateExtension(), isExtensionActive()', async function () {
@@ -20,3 +21,81 @@ describe('vscodeUtils', async function () {
         assert.deepStrictEqual(vscodeUtil.isExtensionActive(VSCODE_EXTENSION_ID.awstoolkit), true)
     })
 })
+
+describe('isExtensionInstalled()', function () {
+    const smallerVersion = '0.9.0'
+    const extVersion = '1.0.0'
+    const largerVersion = '2.0.0'
+    const extId = 'my.ext.id'
+    let ext: vscode.Extension<any>
+    let getExtension: (extId: string) => vscode.Extension<any>
+
+    beforeEach(function () {
+        ext = {
+            packageJSON: {
+                version: extVersion,
+            },
+        } as vscode.Extension<any>
+        getExtension = _ => ext
+    })
+
+    it('fails if extension could not be found', function () {
+        const noExtFunc = (extId: string) => undefined
+        assert.ok(!vscodeUtil.isExtensionInstalled(extId, undefined, noExtFunc))
+    })
+
+    it('succeeds on same min version', function () {
+        assert.ok(vscodeUtil.isExtensionInstalled(extId, extVersion, getExtension))
+    })
+
+    it('succeeds on smaller min version', function () {
+        assert.ok(vscodeUtil.isExtensionInstalled(extId, smallerVersion, getExtension))
+    })
+
+    it('fails on larger min version', function () {
+        assert.ok(!vscodeUtil.isExtensionInstalled(extId, largerVersion, getExtension))
+    })
+
+    it('can handle labels on a version', function () {
+        ext.packageJSON.version = `${extVersion}-SNAPSHOT`
+        assert.ok(vscodeUtil.isExtensionInstalled(extId, `${smallerVersion}-ALPHA`, getExtension))
+    })
+
+    it('is valid when no min version is provided', function () {
+        assert.ok(vscodeUtil.isExtensionInstalled(extId, undefined, getExtension))
+    })
+
+    it('fails on malformed version', function () {
+        // malformed min version
+        assert.ok(!vscodeUtil.isExtensionInstalled(extId, 'malformed.version', getExtension))
+
+        // malformed ext version
+        ext.packageJSON.version = 'malformed.version'
+        assert.ok(!vscodeUtil.isExtensionInstalled(extId, extVersion, getExtension))
+    })
+})
+
+describe('buildMissingExtensionMessage()', function () {
+    const extId = 'MY.EXT.ID'
+    const extName = 'MY EXTENSION'
+    const minVer = '1.0.0'
+    const feat = 'FEATURE'
+
+    // Test when a minVer is given
+    it('minVer', function () {
+        const message = vscodeUtil.buildMissingExtensionMessage(extId, extName, minVer, feat)
+        assert.strictEqual(
+            message,
+            `${feat} requires the ${extName} extension (\'${extId}\' of version >=${minVer}) to be installed and enabled.`
+        )
+    })
+
+    // Test when a minVer is not given
+    it('no minVer', function () {
+        const message = vscodeUtil.buildMissingExtensionMessage(extId, extName, undefined, feat)
+        assert.strictEqual(
+            message,
+            `${feat} requires the ${extName} extension (\'${extId}\') to be installed and enabled.`
+        )
+    })
+})

src/testE2E/codecatalyst/client.test.ts

@@ -24,7 +24,7 @@ import { GetDevEnvironmentRequest } from 'aws-sdk/clients/codecatalyst'
 import { getTestWindow } from '../../test/shared/vscode/window'
 import { patchObject, registerAuthHook, using } from '../../test/setupUtil'
 import { isExtensionInstalled } from '../../shared/utilities/vsCodeUtils'
-import { VSCODE_EXTENSION_ID } from '../../shared/extensions'
+import { VSCODE_EXTENSION_ID, vscodeExtensionMinVersion } from '../../shared/extensions'
 import { captureEventOnce } from '../../test/testUtil'
 import { toStream } from '../../shared/utilities/collectionUtils'
 import { toCollection } from '../../shared/utilities/asyncCollection'
@@ -167,7 +167,7 @@ describe('Test how this codebase uses the CodeCatalyst API', function () {
         })
 
         it('prompts to install the ssh extension if not available', async function () {
-            if (isExtensionInstalled(VSCODE_EXTENSION_ID.remotessh)) {
+            if (isExtensionInstalled(VSCODE_EXTENSION_ID.remotessh, vscodeExtensionMinVersion.remotessh)) {
                 this.skip()
             }