fix: generalize cleanup to apply to other installer

Author: Hweinstock

packages/amazonq/src/lsp/lspInstaller.ts

@@ -14,6 +14,7 @@ import {
     getNodeExecutableName,
 } from 'aws-core-vscode/shared'
 import path from 'path'
+import { cleanUpLSPDownloads } from 'aws-core-vscode/amazonq'
 
 const manifestURL = 'https://aws-toolkit-language-servers.amazonaws.com/codewhisperer/0/manifest.json'
 export const supportedLspServerVersions = '^2.3.0'
@@ -46,7 +47,7 @@ export class AmazonQLSPResolver implements LspResolver {
         const nodePath = path.join(installationResult.assetDirectory, `servers/${getNodeExecutableName()}`)
         await fs.chmod(nodePath, 0o755)
 
-        // TODO Cleanup old versions of language servers
+        await cleanUpLSPDownloads(manifest.versions, path.dirname(installationResult.assetDirectory))
         return {
             ...installationResult,
             resourcePaths: {

packages/core/src/amazonq/index.ts

@@ -17,6 +17,7 @@ export {
 } from './onboardingPage/walkthrough'
 export { LspController } from './lsp/lspController'
 export { LspClient } from './lsp/lspClient'
+export { cleanUpLSPDownloads } from './lsp/util'
 export { api } from './extApi'
 export { AmazonQChatViewProvider } from './webview/webView'
 export { init as cwChatAppInit } from '../codewhispererChat/app'

packages/core/src/amazonq/lsp/util.ts

@@ -3,8 +3,39 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import path from 'path'
+import { LspVersion } from '../../shared'
 import { fs } from '../../shared/fs/fs'
+import { partition } from '../../shared/utilities/tsUtils'
+import { sort } from 'semver'
 
 export async function getDownloadedVersions(installLocation: string) {
     return (await fs.readdir(installLocation)).map(([f, _], __) => f)
 }
+
+function isDelisted(manifestVersions: LspVersion[], targetVersion: string): boolean {
+    return manifestVersions.find((v) => v.serverVersion === targetVersion)?.isDelisted ?? false
+}
+
+/**
+ * Delete all delisted versions and keep the two newest versions that remain
+ * @param manifest
+ * @param downloadDirectory
+ */
+export async function cleanUpLSPDownloads(manifestVersions: LspVersion[], downloadDirectory: string): Promise<void> {
+    const downloadedVersions = await getDownloadedVersions(downloadDirectory)
+    const [delistedVersions, remainingVersions] = partition(downloadedVersions, (v: string) =>
+        isDelisted(manifestVersions, v)
+    )
+    for (const v of delistedVersions) {
+        await fs.delete(path.join(downloadDirectory, v), { force: true, recursive: true })
+    }
+
+    if (remainingVersions.length <= 2) {
+        return
+    }
+
+    for (const v of sort(remainingVersions).slice(0, -2)) {
+        await fs.delete(path.join(downloadDirectory, v), { force: true, recursive: true })
+    }
+}

packages/core/src/amazonq/lsp/workspaceInstaller.ts

@@ -4,14 +4,13 @@
  */
 
 import path from 'path'
-import { LspResolution, LspResolver, LspVersion } from '../../shared/lsp/types'
+import { LspResolution, LspResolver } from '../../shared/lsp/types'
 import { ManifestResolver } from '../../shared/lsp/manifestResolver'
 import { LanguageServerResolver } from '../../shared/lsp/lspResolver'
-import { Range, sort } from 'semver'
+import { Range } from 'semver'
 import { getNodeExecutableName } from '../../shared/lsp/utils/platform'
 import { fs } from '../../shared/fs/fs'
-import { partition } from '../../shared/utilities/tsUtils'
-import { getDownloadedVersions } from './util'
+import { cleanUpLSPDownloads } from './util'
 
 export const lspManifestUrl = 'https://aws-toolkit-language-servers.amazonaws.com/q-context/manifest.json'
 // this LSP client in Q extension is only going to work with these LSP server versions
@@ -32,7 +31,7 @@ export class WorkspaceLSPResolver implements LspResolver {
         const nodePath = path.join(installationResult.assetDirectory, nodeName)
         await fs.chmod(nodePath, 0o755)
 
-        await this.cleanUp(manifest.versions, path.dirname(installationResult.assetDirectory))
+        await cleanUpLSPDownloads(manifest.versions, path.dirname(installationResult.assetDirectory))
         return {
             ...installationResult,
             resourcePaths: {
@@ -44,31 +43,4 @@ export class WorkspaceLSPResolver implements LspResolver {
             },
         }
     }
-
-    private isDelisted(manifestVersions: LspVersion[], targetVersion: string): boolean {
-        return manifestVersions.find((v) => v.serverVersion === targetVersion)?.isDelisted ?? false
-    }
-
-    /**
-     * Delete all delisted versions and keep the two newest versions that remain
-     * @param manifest
-     * @param downloadDirectory
-     */
-    async cleanUp(manifestVersions: LspVersion[], downloadDirectory: string): Promise<void> {
-        const downloadedVersions = await getDownloadedVersions(downloadDirectory)
-        const [delistedVersions, remainingVersions] = partition(downloadedVersions, (v: string) =>
-            this.isDelisted(manifestVersions, v)
-        )
-        for (const v of delistedVersions) {
-            await fs.delete(path.join(downloadDirectory, v), { force: true, recursive: true })
-        }
-
-        if (remainingVersions.length <= 2) {
-            return
-        }
-
-        for (const v of sort(remainingVersions).slice(0, -2)) {
-            await fs.delete(path.join(downloadDirectory, v), { force: true, recursive: true })
-        }
-    }
 }

packages/core/src/test/amazonq/lsp/util.test.ts

@@ -0,0 +1,94 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Uri } from 'vscode'
+import { fs } from '../../../shared'
+import { createTestWorkspaceFolder } from '../../testUtil'
+import path from 'path'
+import assert from 'assert'
+import { cleanUpLSPDownloads } from '../../../amazonq/lsp/util'
+
+async function fakeInstallVersion(version: string, installationDir: string): Promise<void> {
+    const versionDir = path.join(installationDir, version)
+    await fs.mkdir(versionDir)
+    await fs.writeFile(path.join(versionDir, 'file.txt'), 'content')
+}
+
+async function fakeInstallVersions(versions: string[], installationDir: string): Promise<void> {
+    for (const v of versions) {
+        await fakeInstallVersion(v, installationDir)
+    }
+}
+
+describe('cleanUpLSPDownloads', function () {
+    let installationDir: Uri
+
+    before(async function () {
+        installationDir = (await createTestWorkspaceFolder()).uri
+    })
+
+    afterEach(async function () {
+        const files = await fs.readdir(installationDir.fsPath)
+        for (const [name, _type] of files) {
+            await fs.delete(path.join(installationDir.fsPath, name), { force: true, recursive: true })
+        }
+    })
+
+    after(async function () {
+        await fs.delete(installationDir, { force: true, recursive: true })
+    })
+
+    it('keeps two newest versions', async function () {
+        await fakeInstallVersions(['1.0.0', '1.0.1', '1.1.1', '2.1.1'], installationDir.fsPath)
+        await cleanUpLSPDownloads([], installationDir.fsPath)
+
+        const result = (await fs.readdir(installationDir.fsPath)).map(([filename, _filetype], _index) => filename)
+        assert.strictEqual(result.length, 2)
+        assert.ok(result.includes('2.1.1'))
+        assert.ok(result.includes('1.1.1'))
+    })
+
+    it('deletes delisted versions', async function () {
+        await fakeInstallVersions(['1.0.0', '1.0.1', '1.1.1', '2.1.1'], installationDir.fsPath)
+        await cleanUpLSPDownloads([{ serverVersion: '1.1.1', isDelisted: true, targets: [] }], installationDir.fsPath)
+
+        const result = (await fs.readdir(installationDir.fsPath)).map(([filename, _filetype], _index) => filename)
+        assert.strictEqual(result.length, 2)
+        assert.ok(result.includes('2.1.1'))
+        assert.ok(result.includes('1.0.1'))
+    })
+
+    it('handles case where less than 2 versions are not delisted', async function () {
+        await fakeInstallVersions(['1.0.0', '1.0.1', '1.1.1', '2.1.1'], installationDir.fsPath)
+        await cleanUpLSPDownloads(
+            [
+                { serverVersion: '1.1.1', isDelisted: true, targets: [] },
+                { serverVersion: '2.1.1', isDelisted: true, targets: [] },
+                { serverVersion: '1.0.0', isDelisted: true, targets: [] },
+            ],
+            installationDir.fsPath
+        )
+
+        const result = (await fs.readdir(installationDir.fsPath)).map(([filename, _filetype], _index) => filename)
+        assert.strictEqual(result.length, 1)
+        assert.ok(result.includes('1.0.1'))
+    })
+
+    it('handles case where less than 2 versions exist', async function () {
+        await fakeInstallVersions(['1.0.0'], installationDir.fsPath)
+        await cleanUpLSPDownloads([], installationDir.fsPath)
+
+        const result = (await fs.readdir(installationDir.fsPath)).map(([filename, _filetype], _index) => filename)
+        assert.strictEqual(result.length, 1)
+    })
+
+    it('does not install delisted version when no other option exists', async function () {
+        await fakeInstallVersions(['1.0.0'], installationDir.fsPath)
+        await cleanUpLSPDownloads([{ serverVersion: '1.0.0', isDelisted: true, targets: [] }], installationDir.fsPath)
+
+        const result = (await fs.readdir(installationDir.fsPath)).map(([filename, _filetype], _index) => filename)
+        assert.strictEqual(result.length, 0)
+    })
+})