fix potential performance issue caused by language server settings be…

…ing re-loaded on every keystroke when doing inlay hints
DetachHead · Dec 3, 2024 · 8279ae3 · 8279ae3
1 parent 6fda585
commit 8279ae3
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/packages/pyright-internal/src/analyzer/typeInlayHintsWalker.ts b/packages/pyright-internal/src/analyzer/typeInlayHintsWalker.ts
@@ -31,8 +31,8 @@ import { TextRange } from '../common/textRange';
 import { convertRangeToTextRange } from '../common/positionUtils';
 import { Uri } from '../common/uri/uri';
 import { ParseFileResults } from '../parser/parser';
-import { InlayHintSettings } from '../common/languageServerInterface';
 import { transformTypeForEnumMember } from './enums';
+import { InlayHintSettings } from '../workspaceFactory';
 
 export type TypeInlayHintsItemType = {
     inlayHintType: 'variable' | 'functionReturn' | 'parameter' | 'generic';

diff --git a/packages/pyright-internal/src/common/languageServerInterface.ts b/packages/pyright-internal/src/common/languageServerInterface.ts
@@ -9,7 +9,7 @@
 import { MarkupKind } from 'vscode-languageserver';
 import { MaxAnalysisTime } from '../analyzer/program';
 import { BackgroundAnalysisBase } from '../backgroundAnalysisBase';
-import { Workspace } from '../workspaceFactory';
+import { InlayHintSettings, Workspace } from '../workspaceFactory';
 import { CancellationProvider } from './cancellationUtils';
 import { DiagnosticBooleanOverridesMap, DiagnosticSeverityOverridesMap } from './commandLineOptions';
 import { SignatureDisplayType } from './configOptions';
@@ -21,17 +21,6 @@ import { ServiceProvider } from './serviceProvider';
 import { Uri } from './uri/uri';
 import { FileDiagnostics } from './diagnosticSink';
 
-export interface InlayHintSettings {
-    /**
-     * pylance's version of this option supports 3 settings: `"all" | "partial" | "off"`. `"all"` shows inlay hints
-     * for positional only arguments which i think is dumb so we don't support it
-     */
-    callArgumentNames: boolean;
-    functionReturnTypes: boolean;
-    variableTypes: boolean;
-    genericTypes: boolean;
-}
-
 export interface ServerSettings {
     venvPath?: Uri | undefined;
     pythonPath?: Uri | undefined;

diff --git a/packages/pyright-internal/src/languageServerBase.ts b/packages/pyright-internal/src/languageServerBase.ts
@@ -363,6 +363,7 @@ export abstract class LanguageServerBase implements LanguageServerInterface, Dis
             workspace.disableLanguageServices = !!serverSettings.disableLanguageServices;
             workspace.disableTaggedHints = !!serverSettings.disableTaggedHints;
             workspace.disableOrganizeImports = !!serverSettings.disableOrganizeImports;
+            workspace.inlayHints = serverSettings.inlayHints;
         } finally {
             // Don't use workspace.isInitialized directly since it might have been
             // reset due to pending config change event.
@@ -1005,21 +1006,19 @@ export abstract class LanguageServerBase implements LanguageServerInterface, Dis
     protected async onInlayHints(params: InlayHintParams, token: CancellationToken): Promise<InlayHint[] | null> {
         const uri = Uri.parse(params.textDocument.uri, this.serviceProvider);
         const workspace = await this.getWorkspaceForFile(uri);
-
-        const inlayHintSettings = (await this.getSettings(workspace)).inlayHints;
         if (
             workspace.disableLanguageServices ||
             // don't bother creating the inlay hint provider if all the inlay hint settings are off
-            (inlayHintSettings && !Object.values(inlayHintSettings).some((value) => value))
+            (workspace.inlayHints && !Object.values(workspace.inlayHints).some((value) => value))
         ) {
             return null;
         }
         return workspace.service.run((program) => {
             return new InlayHintsProvider(program, uri, params.range, {
-                callArgumentNames: inlayHintSettings?.callArgumentNames ?? true,
-                functionReturnTypes: inlayHintSettings?.functionReturnTypes ?? true,
-                variableTypes: inlayHintSettings?.variableTypes ?? true,
-                genericTypes: inlayHintSettings?.genericTypes ?? false,
+                callArgumentNames: workspace.inlayHints?.callArgumentNames ?? true,
+                functionReturnTypes: workspace.inlayHints?.functionReturnTypes ?? true,
+                variableTypes: workspace.inlayHints?.variableTypes ?? true,
+                genericTypes: workspace.inlayHints?.genericTypes ?? false,
             }).onInlayHints();
         }, token);
     }

diff --git a/packages/pyright-internal/src/languageService/inlayHintsProvider.ts b/packages/pyright-internal/src/languageService/inlayHintsProvider.ts
@@ -5,7 +5,7 @@ import { convertOffsetToPosition } from '../common/positionUtils';
 import { TypeInlayHintsWalker } from '../analyzer/typeInlayHintsWalker';
 import { Uri } from '../common/uri/uri';
 import { Range } from 'vscode-languageserver-types';
-import { InlayHintSettings } from '../common/languageServerInterface';
+import { InlayHintSettings } from '../workspaceFactory';
 
 export class InlayHintsProvider {
     private readonly _walker: TypeInlayHintsWalker;

diff --git a/packages/pyright-internal/src/tests/testUtils.ts b/packages/pyright-internal/src/tests/testUtils.ts
@@ -32,7 +32,7 @@ import { SemanticTokenItem, SemanticTokensWalker } from '../analyzer/semanticTok
 import { TypeInlayHintsItemType, TypeInlayHintsWalker } from '../analyzer/typeInlayHintsWalker';
 import { Range } from 'vscode-languageserver-types';
 import { ServiceProvider } from '../common/serviceProvider';
-import { InlayHintSettings } from '../common/languageServerInterface';
+import { InlayHintSettings } from '../workspaceFactory';
 
 // This is a bit gross, but it's necessary to allow the fallback typeshed
 // directory to be located when running within the jest environment. This

diff --git a/packages/pyright-internal/src/workspaceFactory.ts b/packages/pyright-internal/src/workspaceFactory.ts
@@ -16,6 +16,17 @@ import { createDeferred } from './common/deferred';
 import { ServiceProvider } from './common/serviceProvider';
 import { Uri } from './common/uri/uri';
 
+export interface InlayHintSettings {
+    /**
+     * pylance's version of this option supports 3 settings: `"all" | "partial" | "off"`. `"all"` shows inlay hints
+     * for positional only arguments which i think is dumb so we don't support it
+     */
+    callArgumentNames: boolean;
+    functionReturnTypes: boolean;
+    variableTypes: boolean;
+    genericTypes: boolean;
+}
+
 let WorkspaceFactoryIdCounter = 0;
 
 export enum WellKnownWorkspaceKinds {
@@ -87,6 +98,7 @@ export interface Workspace extends WorkspaceFolder {
     disableWorkspaceSymbol: boolean;
     isInitialized: InitStatus;
     searchPathsToWatch: Uri[];
+    inlayHints?: InlayHintSettings | undefined;
 }
 
 export interface NormalWorkspace extends Workspace {