Skip to content

Ensure we do not expose internal language server methods outside of the languageServer module #18950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 19, 2022
Merged

Ensure we do not expose internal language server methods outside of the languageServer module #18950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions src/client/languageServer/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ export const ILanguageServerWatcher = Symbol('ILanguageServerWatcher');
export interface ILanguageServerWatcher {
readonly languageServerExtensionManager: ILanguageServerExtensionManager | undefined;
readonly languageServerType: LanguageServerType;
startLanguageServer(
languageServerType: LanguageServerType,
resource?: Resource,
): Promise<ILanguageServerExtensionManager>;
startLanguageServer(languageServerType: LanguageServerType, resource?: Resource): Promise<void>;
}

export interface ILanguageServerCapabilities extends ILanguageServer {
Expand All @@ -29,8 +26,6 @@ export interface ILanguageServerCapabilities extends ILanguageServer {
* `ILanguageServerExtensionManager` implementations act as wrappers for anything related to their specific language server extension.
* They are responsible for starting and stopping the language server provided by their LS extension.
* They also extend the `ILanguageServer` interface via `ILanguageServerCapabilities` to continue supporting the Jupyter integration.
*
* Note that the methods exposed in this interface shouldn't be used outside of the language server watcher (and tests).
*/
export interface ILanguageServerExtensionManager extends ILanguageServerCapabilities {
startLanguageServer(resource: Resource, interpreter?: PythonEnvironment): Promise<void>;
Expand Down
7 changes: 5 additions & 2 deletions src/client/languageServer/watcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,11 @@ export class LanguageServerWatcher
}

// ILanguageServerWatcher
public async startLanguageServer(languageServerType: LanguageServerType, resource?: Resource): Promise<void> {
await this.startAndGetLanguageServer(languageServerType, resource);
}

public async startLanguageServer(
private async startAndGetLanguageServer(
languageServerType: LanguageServerType,
resource?: Resource,
): Promise<ILanguageServerExtensionManager> {
Expand Down Expand Up @@ -165,7 +168,7 @@ export class LanguageServerWatcher
let languageServerExtensionManager = this.workspaceLanguageServers.get(lsResource.fsPath);

if (!languageServerExtensionManager) {
languageServerExtensionManager = await this.startLanguageServer(this.languageServerType, resource);
languageServerExtensionManager = await this.startAndGetLanguageServer(this.languageServerType, resource);
}

return Promise.resolve(languageServerExtensionManager.get());
Expand Down