save

Author: jpinkney-aws

CONTRIBUTING.md

@@ -427,7 +427,7 @@ Example:
 }
 ```
 
-<a name="amazonqLsp-settings">Overrides specifically for the Amazon Q language server can be set using the `aws.dev.amazonqLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `locationOverride`.</a>
+<a name="amazonqLsp-settings">Overrides specifically for the Amazon Q language server</a> can be set using the `aws.dev.amazonqLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `path`.
 
 Example:
 
@@ -436,11 +436,11 @@ Example:
     "manifestUrl": "https://custom.url/manifest.json",
     "supportedVersions": "4.0.0",
     "id": "AmazonQ",
-    "locationOverride": "/custom/path/to/local/lsp/folder",
+    "path": "/custom/path/to/local/lsp/folder",
 }
 ```
 
-<a name="amazonqWorkspaceLsp-settings">Overrides specifically for the Amazon Q Workspace Context language server can be set using the `aws.dev.amazonqWorkspaceLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `locationOverride`.</a>
+<a name="amazonqWorkspaceLsp-settings">Overrides specifically for the Amazon Q Workspace Context language server</a> can be set using the `aws.dev.amazonqWorkspaceLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `path`.
 
 Example:
 
@@ -449,7 +449,7 @@ Example:
     "manifestUrl": "https://custom.url/manifest.json",
     "supportedVersions": "4.0.0",
     "id": "AmazonQ",
-    "locationOverride": "/custom/path/to/local/lsp/folder",
+    "path": "/custom/path/to/local/lsp/folder",
 }
 ```
 
@@ -501,11 +501,11 @@ Unlike the user setting overrides, not all of these environment variables have t
 -   `__AMAZONQLSP_MANIFEST_URL`: for aws.dev.amazonqLsp.manifestUrl
 -   `__AMAZONQLSP_SUPPORTED_VERSIONS`: for aws.dev.amazonqLsp.supportedVersions
 -   `__AMAZONQLSP_ID`: for aws.dev.amazonqLsp.id
--   `__AMAZONQLSP_LOCATION_OVERRIDE`: for aws.dev.amazonqWorkspaceLsp.locationOverride
+-   `__AMAZONQLSP_PATH`: for aws.dev.amazonqWorkspaceLsp.locationOverride
 -   `__AMAZONQWORKSPACELSP_MANIFEST_URL`: for aws.dev.amazonqWorkspaceLsp.manifestUrl
 -   `__AMAZONQWORKSPACELSP_SUPPORTED_VERSIONS`: for aws.dev.amazonqWorkspaceLsp.supportedVersions
 -   `__AMAZONQWORKSPACELSP_ID`: for aws.dev.amazonqWorkspaceLsp.id
--   `__AMAZONQWORKSPACELSP_LOCATION_OVERRIDE`: for aws.dev.amazonqWorkspaceLsp.locationOverride
+-   `__AMAZONQWORKSPACELSP_PATH`: for aws.dev.amazonqWorkspaceLsp.locationOverride
 
 #### Lambda
 

packages/amazonq/src/lsp/activation.ts

@@ -5,13 +5,13 @@
 
 import vscode from 'vscode'
 import { startLanguageServer } from './client'
-import { AmazonQLSPInstaller } from './lspInstaller'
+import { AmazonQLspInstaller } from './lspInstaller'
 import { Commands, lspSetupStage, ToolkitError } from 'aws-core-vscode/shared'
 
 export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
     try {
         await lspSetupStage('all', async () => {
-            const installResult = await new AmazonQLSPInstaller().resolve()
+            const installResult = await new AmazonQLspInstaller().resolve()
             await lspSetupStage('launch', async () => await startLanguageServer(ctx, installResult.resourcePaths))
         })
         ctx.subscriptions.push(

packages/amazonq/src/lsp/lspInstaller.ts

@@ -7,7 +7,7 @@ import { fs, getNodeExecutableName, BaseLspInstaller, ResourcePaths } from 'aws-
 import path from 'path'
 import { getAmazonQLspConfig } from './config'
 
-export class AmazonQLSPInstaller extends BaseLspInstaller {
+export class AmazonQLspInstaller extends BaseLspInstaller {
     constructor() {
         super(getAmazonQLspConfig())
     }

packages/amazonq/test/e2e/lsp/lspInstaller.test.ts

@@ -5,7 +5,7 @@
 
 import assert from 'assert'
 import sinon from 'sinon'
-import { AmazonQLSPInstaller } from '../../../src/lsp/lspInstaller'
+import { AmazonQLspInstaller } from '../../../src/lsp/lspInstaller'
 import {
     DevSettings,
     fs,
@@ -44,7 +44,7 @@ function createVersion(version: string) {
 }
 
 describe('AmazonQLSPInstaller', () => {
-    let resolver: AmazonQLSPInstaller
+    let resolver: AmazonQLspInstaller
     let sandbox: sinon.SinonSandbox
     let tempDir: string
     // If globalState contains an ETag that is up to date with remote, we won't fetch it resulting in inconsistent behavior.
@@ -59,7 +59,7 @@ describe('AmazonQLSPInstaller', () => {
 
     beforeEach(async () => {
         sandbox = sinon.createSandbox()
-        resolver = new AmazonQLSPInstaller()
+        resolver = new AmazonQLspInstaller()
         tempDir = await makeTemporaryToolkitFolder()
         sandbox.stub(LanguageServerResolver.prototype, 'defaultDownloadFolder').returns(tempDir)
         // Called on extension activation and can contaminate telemetry.

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

@@ -10,14 +10,14 @@ export interface LspConfig {
     manifestUrl: string
     supportedVersions: string
     id: string
-    locationOverride?: string
+    path?: string
 }
 
 export const defaultAmazonQWorkspaceLspConfig: LspConfig = {
     manifestUrl: 'https://aws-toolkit-language-servers.amazonaws.com/q-context/manifest.json',
     supportedVersions: '0.1.35',
     id: 'AmazonQ-Workspace', // used for identification in global storage/local disk location. Do not change.
-    locationOverride: undefined,
+    path: undefined,
 }
 
 export function getAmazonQWorkspaceLspConfig(): LspConfig {

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

@@ -7,7 +7,7 @@ import path from 'path'
 import { ResourcePaths } from '../../shared/lsp/types'
 import { getNodeExecutableName } from '../../shared/lsp/utils/platform'
 import { fs } from '../../shared/fs/fs'
-import { BaseLspInstaller } from '../../shared/lsp/lspInstaller'
+import { BaseLspInstaller } from '../../shared/lsp/baseLspInstaller'
 import { getAmazonQWorkspaceLspConfig } from './config'
 
 export class WorkspaceLSPInstaller extends BaseLspInstaller {

packages/core/src/shared/index.ts

@@ -70,4 +70,4 @@ export * from './lsp/utils/cleanup'
 export { default as request } from './request'
 export * from './lsp/utils/platform'
 export * as processUtils from './utilities/processUtils'
-export * from './lsp/lspInstaller'
+export * as BaseLspInstaller from './lsp/baseLspInstaller'

packages/core/src/shared/lsp/lspInstaller.ts renamed to packages/core/src/shared/lsp/baseLspInstaller.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import path from 'path'
+import * as nodePath from 'path'
 import vscode from 'vscode'
 import { LspConfig } from '../../amazonq/lsp/config'
 import { LanguageServerResolver } from './lspResolver'
@@ -12,18 +12,26 @@ import { LspResolution, ResourcePaths } from './types'
 import { cleanLspDownloads } from './utils/cleanup'
 import { Range } from 'semver'
 import { getLogger } from '../logger/logger'
-
-const logger = getLogger('lsp')
+import type { Logger, LogTopic } from '../logger/logger'
 
 export abstract class BaseLspInstaller {
-    constructor(protected config: LspConfig) {}
+    private logger: Logger
+
+    constructor(
+        protected config: LspConfig,
+        loggerName: Extract<LogTopic, 'amazonqLsp' | 'amazonqWorkplaceLsp'>
+    ) {
+        this.logger = getLogger(loggerName)
+    }
 
     async resolve(): Promise<LspResolution> {
-        const { id, manifestUrl, supportedVersions, locationOverride } = this.config
-        if (locationOverride) {
-            void vscode.window.showInformationMessage(`Using language server override location: ${locationOverride}`)
+        const { id, manifestUrl, supportedVersions, path } = this.config
+        if (path) {
+            const overrideMsg = `Using language server override location: ${path}`
+            this.logger.info(overrideMsg)
+            void vscode.window.showInformationMessage(overrideMsg)
             return {
-                assetDirectory: locationOverride,
+                assetDirectory: path,
                 location: 'override',
                 version: '0.0.0',
                 resourcePaths: this.resourcePaths(),
@@ -43,8 +51,8 @@ export abstract class BaseLspInstaller {
 
         await this.postInstall(assetDirectory)
 
-        const deletedVersions = await cleanLspDownloads(manifest.versions, path.dirname(assetDirectory))
-        logger.debug(`cleaning old LSP versions deleted ${deletedVersions.length} versions`)
+        const deletedVersions = await cleanLspDownloads(manifest.versions, nodePath.dirname(assetDirectory))
+        this.logger.debug(`cleaning old LSP versions deleted ${deletedVersions.length} versions`)
 
         return {
             ...installationResult,