feat: add new lsp extension to send dependency information from clien…

…t to servers (#338) * feat: add new lsp extension to send dependency information from client to servers * chore: add docstrings to notifyDependencyPathsParams * chore: rename notifyDependencyPaths to didChangeDependencyPaths --------- Co-authored-by: Ege Ozcan <[email protected]>
aws · Feb 27, 2025 · cbaf65f · cbaf65f
1 parent e2d7267
commit cbaf65f
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
         "precompile": "npm run generate-types --workspaces --if-present",
         "compile": "tsc --build && npm run compile --workspaces --if-present",
         "check:formatting": "prettier --check .",
-        "fix:prettier": "prettier . --write",
+        "format": "prettier . --write",
         "format-staged": "npx pretty-quick --staged",
         "prepare": "husky .husky",
         "test": "npm run test --workspaces --if-present",

diff --git a/runtimes/protocol/didChangeDependencyPaths.ts b/runtimes/protocol/didChangeDependencyPaths.ts
@@ -0,0 +1,10 @@
+import {
+    DID_CHANGE_DEPENDENCY_PATHS_NOTIFICATION_METHOD,
+    DidChangeDependencyPathsParams,
+    ProtocolNotificationType,
+} from './lsp'
+
+export const didChangeDependencyPathsNotificationType = new ProtocolNotificationType<
+    DidChangeDependencyPathsParams,
+    void
+>(DID_CHANGE_DEPENDENCY_PATHS_NOTIFICATION_METHOD)
diff --git a/runtimes/protocol/index.ts b/runtimes/protocol/index.ts
@@ -1,7 +1,8 @@
-export * from './lsp'
 export * from './auth'
 export * from './chat'
-export * from './telemetry'
+export * from './didChangeDependencyPaths'
 export * from './getConfigurationFromServer'
 export * from './identity-management'
+export * from './lsp'
 export * from './notification'
+export * from './telemetry'
diff --git a/runtimes/runtimes/base-runtime.ts b/runtimes/runtimes/base-runtime.ts
@@ -10,7 +10,7 @@ import {
     TextDocument,
     telemetryNotificationType,
     SemanticTokensRequest,
-
+    didChangeDependencyPathsNotificationType,
     // Chat
     chatRequestType,
     endChatRequestType,
@@ -37,7 +37,6 @@ import {
     Runtime,
     Telemetry,
     Workspace,
-    Notification,
     SDKClientConstructorV2,
     SDKClientConstructorV3,
     SDKInitializator,
@@ -59,7 +58,7 @@ import {
     updateProfileRequestType,
 } from '../protocol/identity-management'
 import { IdentityManagement } from '../server-interface/identity-management'
-import { Encoding, WebBase64Encoding } from './encoding'
+import { WebBase64Encoding } from './encoding'
 import { LoggingServer } from './lsp/router/loggingServer'
 import { Service } from 'aws-sdk'
 import { ServiceConfigurationOptions } from 'aws-sdk/lib/service'
@@ -205,6 +204,9 @@ export const baseRuntime = (connections: { reader: MessageReader; writer: Messag
                 onLogInlineCompletionSessionResults: handler => {
                     lspConnection.onNotification(logInlineCompletionSessionResultsNotificationType, handler)
                 },
+                onDidChangeDependencyPaths(handler) {
+                    lspConnection.onNotification(didChangeDependencyPathsNotificationType, handler)
+                },
             },
         }
 

diff --git a/runtimes/runtimes/standalone.ts b/runtimes/runtimes/standalone.ts
@@ -15,6 +15,7 @@ import {
     ShowDocumentRequest,
     CancellationToken,
     GetSsoTokenParams,
+    didChangeDependencyPathsNotificationType,
 } from '../protocol'
 import { ProposedFeatures, createConnection } from 'vscode-languageserver/node'
 import {
@@ -328,6 +329,9 @@ export const standalone = (props: RuntimeProps) => {
                     onLogInlineCompletionSessionResults: handler => {
                         lspConnection.onNotification(logInlineCompletionSessionResultsNotificationType, handler)
                     },
+                    onDidChangeDependencyPaths(handler) {
+                        lspConnection.onNotification(didChangeDependencyPathsNotificationType, handler)
+                    },
                 },
             }
 

diff --git a/runtimes/server-interface/lsp.ts b/runtimes/server-interface/lsp.ts
@@ -46,6 +46,7 @@ import {
     DeleteFilesParams,
     CreateFilesParams,
     RenameFilesParams,
+    DidChangeDependencyPathsParams,
 } from '../protocol'
 
 // Re-export whole surface of LSP protocol used in Runtimes.
@@ -144,5 +145,6 @@ export type Lsp = {
             handler: NotificationHandler<LogInlineCompletionSessionResultsParams>
         ) => void
         onGetConfigurationFromServer: (handler: RequestHandler<GetConfigurationFromServerParams, LSPAny, void>) => void
+        onDidChangeDependencyPaths: (handler: NotificationHandler<DidChangeDependencyPathsParams>) => void
     }
 }
diff --git a/types/didChangeDependencyPaths.ts b/types/didChangeDependencyPaths.ts
@@ -0,0 +1,25 @@
+export const DID_CHANGE_DEPENDENCY_PATHS_NOTIFICATION_METHOD = 'aws/didChangeDependencyPaths'
+
+/**
+ * Parameters for notifying AWS language server about dependency paths
+ */
+export interface DidChangeDependencyPathsParams {
+    /** Name of the module being processed */
+    moduleName: string
+    /** Programming language runtime (e.g., 'javascript', 'python', 'java') */
+    runtimeLanguage: string
+    /** Absolute paths to dependency files and directories*/
+    paths: string[]
+    /**
+     * Glob patterns to include specific files/directories
+     * Patterns should conform to https://github.com/isaacs/node-glob
+     * @optional
+     */
+    includePatterns?: string[]
+    /**
+     * Glob patterns to exclude specific files/directories
+     * Patterns should conform to https://github.com/isaacs/node-glob
+     * @optional
+     */
+    excludePatterns?: string[]
+}
diff --git a/types/index.ts b/types/index.ts
@@ -1,4 +1,5 @@
-export * from './chat'
 export * from './auth'
-export * from './lsp'
+export * from './chat'
+export * from './didChangeDependencyPaths'
 export * from './inlineCompletionWithReferences'
+export * from './lsp'