fix: doc sync & signature help

Author: Jonas(Jiajie) Jing

server/src/python/PyrightLanguageProvider.ts

@@ -58,7 +58,6 @@ import { CodeZoneManager } from "../sas/CodeZoneManager";
 import { LanguageServiceProvider } from "../sas/LanguageServiceProvider";
 
 export class PyrightLanguageProvider extends PyrightServer {
-  protected docChangeRecords: Record<string, TextDocument>;
   protected sasLspProvider: (uri: string) => LanguageServiceProvider;
 
   constructor(
@@ -70,30 +69,12 @@ export class PyrightLanguageProvider extends PyrightServer {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     super({ ...connection, listen() {} } as LSPAny, maxWorkers, realFileSystem);
     this.sasLspProvider = sasLspProvider;
-    this.docChangeRecords = {};
-    this.startDocSynchronizer();
   }
 
   public getClientCapabilities(): ClientCapabilities {
     return this.client;
   }
 
-  protected startDocSynchronizer() {
-    setInterval(() => {
-      const changes = this.docChangeRecords;
-      this.docChangeRecords = {};
-      for (const uri in changes) {
-        const doc = changes[uri];
-        const pythonDoc = this.extractPythonCodes(doc);
-
-        this.onDidChangeTextDocument({
-          textDocument: doc,
-          contentChanges: [{ text: pythonDoc }],
-        });
-      }
-    }, 1000);
-  }
-
   protected extractPythonCodes(doc: TextDocument): string {
     const uri = doc.uri;
     const languageService = this.sasLspProvider(uri);
@@ -218,7 +199,12 @@ export class PyrightLanguageProvider extends PyrightServer {
   }
 
   public addContentChange(doc: TextDocument): void {
-    this.docChangeRecords[doc.uri] = doc;
+    const pythonDoc = this.extractPythonCodes(doc);
+
+    this.onDidChangeTextDocument({
+      textDocument: doc,
+      contentChanges: [{ text: pythonDoc }],
+    });
   }
 
   public async onHover(params: HoverParams, token: CancellationToken) {
@@ -244,7 +230,6 @@ export class PyrightLanguageProvider extends PyrightServer {
   }
 
   public async onDidCloseTextDocument(params: DidCloseTextDocumentParams) {
-    delete this.docChangeRecords[params.textDocument.uri];
     await super.onDidCloseTextDocument(params);
   }
 

server/src/server.ts

@@ -17,7 +17,6 @@ import {
   RenameParams,
   ResultProgressReporter,
   SemanticTokensRequest,
-  SignatureHelpParams,
   TextDocumentPositionParams,
   TextDocumentSyncKind,
   WorkDoneProgressReporter,
@@ -37,8 +36,13 @@ import { CompletionProvider } from "./sas/CompletionProvider";
 import { LanguageServiceProvider, legend } from "./sas/LanguageServiceProvider";
 import type { LibCompleteItem } from "./sas/SyntaxDataProvider";
 
-const servicePool: Record<string, LanguageServiceProvider> = {};
-const documentPool: Record<string, TextDocument> = {};
+interface DocumentInfo {
+  document: TextDocument;
+  changed: boolean;
+  service?: LanguageServiceProvider;
+}
+
+const documentPool: Record<string, DocumentInfo> = {};
 
 let completionProvider: CompletionProvider;
 let connection: Connection;
@@ -116,6 +120,7 @@ export const init = (conn: Connection): void => {
   connection.onInitialized(() => _pyrightLanguageProvider.onInitialized());
 
   connection.onRequest(SemanticTokensRequest.type, (params) => {
+    syncIfDocChange(params.textDocument.uri);
     const languageService = getLanguageService(params.textDocument.uri);
 
     return { data: languageService.getTokens() };
@@ -188,6 +193,7 @@ export const init = (conn: Connection): void => {
   });
 
   connection.onDocumentSymbol(async (params, token) => {
+    syncIfDocChange(params.textDocument.uri);
     const languageService = getLanguageService(params.textDocument.uri);
     const sasSymbols = languageService.getDocumentSymbols();
     const pythonSymbols =
@@ -209,6 +215,7 @@ export const init = (conn: Connection): void => {
 
   // todo
   connection.onFoldingRanges((params) => {
+    syncIfDocChange(params.textDocument.uri);
     const languageService = getLanguageService(params.textDocument.uri);
     return languageService.getFoldingRanges();
   });
@@ -267,6 +274,7 @@ export const init = (conn: Connection): void => {
   });
 
   connection.onDocumentFormatting((params) => {
+    syncIfDocChange(params.textDocument.uri);
     const languageService = getLanguageService(params.textDocument.uri);
     return languageService.formatter.format({
       tabWidth: params.options.tabSize,
@@ -281,27 +289,25 @@ export const init = (conn: Connection): void => {
       params.textDocument.version,
       params.textDocument.text,
     );
-    documentPool[doc.uri] = doc;
+    documentPool[doc.uri] = { document: doc, changed: false };
     await _pyrightLanguageProvider.onDidOpenTextDocument(params);
   });
 
   connection.onDidCloseTextDocument(async (params) => {
     const uri = params.textDocument.uri;
     delete documentPool[uri];
-    delete servicePool[uri];
     await _pyrightLanguageProvider.onDidCloseTextDocument(params);
   });
 
   connection.onDidChangeTextDocument((params) => {
     const uri = params.textDocument.uri;
-    const doc = documentPool[uri];
+    const docInfo = documentPool[uri];
     TextDocument.update(
-      doc,
+      docInfo.document,
       params.contentChanges,
       params.textDocument.version,
     );
-    delete servicePool[uri];
-    _pyrightLanguageProvider.addContentChange(doc);
+    docInfo.changed = true;
   });
 
   connection.onDidChangeConfiguration(
@@ -378,6 +384,7 @@ export const init = (conn: Connection): void => {
       workDoneProgress,
       resultProgress,
     ) => {
+      syncAllChangedDoc();
       return await _pyrightLanguageProvider.onWorkspaceSymbol(
         params,
         token,
@@ -399,21 +406,6 @@ export const init = (conn: Connection): void => {
     },
   );
 
-  connection.onSignatureHelp(
-    async (params: SignatureHelpParams, token: CancellationToken) => {
-      return await dispatch(params, {
-        async python(pyrightLanguageService) {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          return (await pyrightLanguageService.onSignatureHelp(
-            params,
-            token,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          )) as any;
-        },
-      });
-    },
-  );
-
   connection.onPrepareRename(
     async (params: PrepareRenameParams, token: CancellationToken) => {
       return await dispatch(params, {
@@ -444,6 +436,9 @@ export const init = (conn: Connection): void => {
 
   connection.onDidChangeWatchedFiles(
     async (params: DidChangeWatchedFilesParams) => {
+      params.changes.forEach((item) => {
+        syncIfDocChange(item.uri);
+      });
       _pyrightLanguageProvider.onDidChangeWatchedFiles(params);
     },
   );
@@ -454,6 +449,7 @@ export const init = (conn: Connection): void => {
       token: CancellationToken,
       reporter: WorkDoneProgressReporter,
     ) => {
+      syncAllChangedDoc();
       return await _pyrightLanguageProvider.onExecuteCommand(
         params,
         token,
@@ -500,19 +496,20 @@ export const init = (conn: Connection): void => {
 };
 
 function getLanguageService(uri: string) {
-  if (!servicePool[uri]) {
-    // re-create LanguageServer if document changed
-    servicePool[uri] = new LanguageServiceProvider(documentPool[uri]);
+  const docInfo = documentPool[uri];
+  // re-create LanguageServer if document changed
+  if (!docInfo.service || docInfo.changed) {
+    docInfo.service = new LanguageServiceProvider(docInfo.document);
 
     if (supportSASGetLibList) {
-      servicePool[uri].setLibService((libId, resolve) =>
+      docInfo.service.setLibService((libId, resolve) =>
         connection
           .sendRequest<LibCompleteItem[]>("sas/getLibList", { libId: libId })
           .then(resolve),
       );
     }
   }
-  return servicePool[uri];
+  return docInfo.service!;
 }
 
 const dispatch = async <Ret>(
@@ -522,6 +519,7 @@ const dispatch = async <Ret>(
     python?: (pyrightLanguageService: PyrightLanguageProvider) => Promise<Ret>;
   },
 ) => {
+  syncIfDocChange(params.textDocument.uri);
   const languageService = getLanguageService(params.textDocument.uri);
   const codeZoneManager = languageService.getCodeZoneManager();
   const pos = params.position;
@@ -567,3 +565,18 @@ const isRangeIncluded = (a: Range, b: Range) => {
   }
   return false;
 };
+
+const syncIfDocChange = (uri: string) => {
+  const docInfo = documentPool[uri];
+  if (!docInfo.changed) {
+    return;
+  }
+  docInfo.changed = false;
+  _pyrightLanguageProvider.addContentChange(docInfo.document);
+};
+
+const syncAllChangedDoc = () => {
+  for (const uri in documentPool) {
+    syncIfDocChange(uri);
+  }
+};