feat: sync log level settings with lsp

Author: Hweinstock

packages/amazonq/src/lsp/chat/activation.ts

@@ -8,14 +8,15 @@ import { LanguageClient } from 'vscode-languageclient'
 import { AmazonQChatViewProvider } from './webviewProvider'
 import { registerCommands } from './commands'
 import { registerLanguageServerEventListener, registerMessageListeners } from './messages'
-import { Commands, getLogger, globals, undefinedIfEmpty } from 'aws-core-vscode/shared'
+import { Commands, getLogger, globals, Settings, undefinedIfEmpty } from 'aws-core-vscode/shared'
 import { activate as registerLegacyChatListeners } from '../../app/chat/activation'
 import { DefaultAmazonQAppInitContext } from 'aws-core-vscode/amazonq'
 import { AuthUtil, getSelectedCustomization } from 'aws-core-vscode/codewhisperer'
 import {
     DidChangeConfigurationNotification,
     updateConfigurationRequestType,
 } from '@aws/language-server-runtimes/protocol'
+import { getLspLogSettings, lspSettingsSection } from '../config'
 
 export async function activate(languageClient: LanguageClient, encryptionKey: Buffer, mynahUIPath: string) {
     const disposables = globals.context.subscriptions
@@ -85,6 +86,10 @@ export async function activate(languageClient: LanguageClient, encryptionKey: Bu
                 type: 'customization',
                 customization: undefinedIfEmpty(getSelectedCustomization().arn),
             })
+        }),
+        Settings.instance.onDidChangeSection(lspSettingsSection, () => {
+            void pushConfigUpdate(languageClient, { type: 'logging', ...getLspLogSettings() })
+            getLogger().info('LSP settings changed, sending to lsp')
         })
     )
 }
@@ -108,6 +113,10 @@ async function pushConfigUpdate(client: LanguageClient, config: QConfigs) {
             section: 'aws.q',
             settings: { customization: config.customization },
         })
+    } else if (config.type === 'logging') {
+        client.sendNotification(DidChangeConfigurationNotification.type.method, {
+            section: 'aws.logLevel',
+        })
     }
 }
 type ProfileConfig = {
@@ -118,4 +127,8 @@ type CustomizationConfig = {
     type: 'customization'
     customization: string | undefined
 }
-type QConfigs = ProfileConfig | CustomizationConfig
+interface LoggingConfig extends ReturnType<typeof getLspLogSettings> {
+    type: 'logging'
+}
+
+type QConfigs = ProfileConfig | CustomizationConfig | LoggingConfig

packages/amazonq/src/lsp/client.ts

@@ -65,8 +65,6 @@ export async function startLanguageServer(
     const documentSelector = [{ scheme: 'file', language: '*' }]
     const lspLogSettings = getLspLogSettings()
 
-    getLogger('amazonqLsp').info(`Sending log settings to lsp: %O`, lspLogSettings)
-
     await validateNodeExe(resourcePaths.node, resourcePaths.lsp, argv, logger)
 
     // Options to control the language client
@@ -114,6 +112,9 @@ export async function startLanguageServer(
                             },
                         ]
                     }
+                    if (params.items[0].section === 'aws.logLevel') {
+                        return [getLspLogSettings().lspLogLevel]
+                    }
                     return config
                 },
             },

packages/amazonq/src/lsp/config.ts

@@ -6,9 +6,6 @@
 import { DevSettings, getLogger, getServiceEnvVarConfig, Settings } from 'aws-core-vscode/shared'
 import { LspConfig } from 'aws-core-vscode/amazonq'
 
-// Taken from language server runtimes since they are not exported:
-// https://github.com/aws/language-server-runtimes/blob/eae85672c345d8adaf4c8cbd741260b8a59750c4/runtimes/runtimes/util/loggingUtil.ts#L4-L10
-const validLspLogLevels = ['error', 'warn', 'info', 'log', 'debug']
 export interface ExtendedAmazonQLSPConfig extends LspConfig {
     ui?: string
 }
@@ -30,9 +27,14 @@ export function getAmazonQLspConfig(): ExtendedAmazonQLSPConfig {
     }
 }
 
-// TODO: expose lsp logging settings to users and re-send on update.
-export function getLspLogSettings() {
-    const lspSettings = Settings.instance.getSection('lsp')
+// Taken from language server runtimes since they are not exported:
+// https://github.com/aws/language-server-runtimes/blob/eae85672c345d8adaf4c8cbd741260b8a59750c4/runtimes/runtimes/util/loggingUtil.ts#L4-L10
+const validLspLogLevels = ['error', 'warn', 'info', 'log', 'debug'] as const
+export type LspLogLevel = (typeof validLspLogLevels)[number]
+export const lspSettingsSection = 'amazonQ.lsp'
+
+export function getLspLogSettings(): { traceChannelEnabled: boolean; lspLogLevel: LspLogLevel } {
+    const lspSettings = Settings.instance.getSection(lspSettingsSection)
     const lspLogLevel = lspSettings.get('logLevel', 'info')
     const traceChannelEnabled = lspSettings.get('trace', false)
 
@@ -42,12 +44,16 @@ export function getLspLogSettings() {
     }
 }
 
-export function sanitizeLogLevel(lspLogLevel: string) {
-    if (!validLspLogLevels.includes(lspLogLevel)) {
+export function sanitizeLogLevel(lspLogLevel: string): LspLogLevel {
+    if (!isValidLspLogLevel(lspLogLevel)) {
         getLogger('amazonqLsp').warn(
             `Invalid log level for amazonq.lsp.logLevel: ${lspLogLevel}. Defaulting to 'info'.`
         )
         return 'info'
     }
     return lspLogLevel
 }
+
+function isValidLspLogLevel(value: unknown): value is LspLogLevel {
+    return typeof value === 'string' && validLspLogLevels.includes(value as LspLogLevel)
+}