Use base class LanguageClientConsumer

Author: Christoph Bergmeister

src/features/Console.ts

@@ -8,6 +8,7 @@ import { ICheckboxQuickPickItem, showCheckboxQuickPick } from "../controls/check
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
 import Settings = require("../settings");
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const EvaluateRequestType = new RequestType<IEvaluateRequestArguments, void, void, void>("evaluate");
 export const OutputNotificationType = new NotificationType<IOutputNotificationBody, void>("output");
@@ -197,19 +198,14 @@ function onInputEntered(responseText: string): IShowInputPromptResponseBody {
     }
 }
 
-export class ConsoleFeature implements IFeature {
+export class ConsoleFeature extends LanguageClientConsumer implements IFeature {
     private commands: vscode.Disposable[];
-    private languageClient: LanguageClient;
     private resolveStatusBarPromise: (value?: {} | PromiseLike<{}>) => void;
 
     constructor(private log: Logger) {
+        super();
         this.commands = [
             vscode.commands.registerCommand("PowerShell.RunSelection", async () => {
-                if (this.languageClient === undefined) {
-                    this.log.writeAndShowError(`<${ConsoleFeature.name}>: ` +
-                        "Unable to instantiate; language client undefined.");
-                    return;
-                }
 
                 if (vscode.window.activeTerminal &&
                     vscode.window.activeTerminal.name !== "PowerShell Integrated Console") {
@@ -257,7 +253,6 @@ export class ConsoleFeature implements IFeature {
 
     public setLanguageClient(languageClient: LanguageClient) {
         this.languageClient = languageClient;
-
         this.languageClient.onRequest(
             ShowChoicePromptRequestType,
             (promptDetails) => showChoicePrompt(promptDetails, this.languageClient));

src/features/CustomViews.ts

@@ -6,13 +6,15 @@ import * as path from "path";
 import * as vscode from "vscode";
 import { LanguageClient, RequestType } from "vscode-languageclient";
 import { IFeature } from "../feature";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
-export class CustomViewsFeature implements IFeature {
+export class CustomViewsFeature extends LanguageClientConsumer implements IFeature {
 
     private commands: vscode.Disposable[] = [];
     private contentProvider: PowerShellContentProvider;
 
     constructor() {
+        super();
         this.contentProvider = new PowerShellContentProvider();
         this.commands.push(
             vscode.workspace.registerTextDocumentContentProvider(

src/features/DebugSession.ts

@@ -14,18 +14,21 @@ import Settings = require("../settings");
 import utils = require("../utils");
 import { NamedPipeDebugAdapter } from "../debugAdapter";
 import { Logger } from "../logging";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const StartDebuggerNotificationType =
     new NotificationType<void, void>("powerShell/startDebugger");
 
-export class DebugSessionFeature implements IFeature, DebugConfigurationProvider, vscode.DebugAdapterDescriptorFactory {
+export class DebugSessionFeature extends LanguageClientConsumer
+    implements IFeature, DebugConfigurationProvider, vscode.DebugAdapterDescriptorFactory {
 
     private sessionCount: number = 1;
     private command: vscode.Disposable;
     private tempDebugProcess: PowerShellProcess;
     private tempSessionDetails: utils.IEditorServicesSessionDetails;
 
     constructor(context: ExtensionContext, private sessionManager: SessionManager, private logger: Logger) {
+        super();
         // Register a debug configuration provider
         context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider("PowerShell", this));
         context.subscriptions.push(vscode.debug.registerDebugAdapterDescriptorFactory("PowerShell", this))
@@ -386,14 +389,14 @@ interface IGetPSHostProcessesResponseBody {
     hostProcesses: IPSHostProcessInfo[];
 }
 
-export class PickPSHostProcessFeature implements IFeature {
+export class PickPSHostProcessFeature extends LanguageClientConsumer implements IFeature {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private waitingForClientToken: vscode.CancellationTokenSource;
     private getLanguageClientResolve: (value?: LanguageClient | Thenable<LanguageClient>) => void;
 
     constructor() {
+        super();
 
         this.command =
             vscode.commands.registerCommand("PowerShell.PickPSHostProcess", () => {
@@ -517,14 +520,14 @@ interface IRunspace {
 export const GetRunspaceRequestType =
     new RequestType<any, IRunspace[], string, void>("powerShell/getRunspace");
 
-export class PickRunspaceFeature implements IFeature {
+export class PickRunspaceFeature extends LanguageClientConsumer implements IFeature {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private waitingForClientToken: vscode.CancellationTokenSource;
     private getLanguageClientResolve: (value?: LanguageClient | Thenable<LanguageClient>) => void;
 
     constructor() {
+        super();
         this.command =
             vscode.commands.registerCommand("PowerShell.PickRunspace", (processId) => {
                 return this.getLanguageClient()

src/features/ExpandAlias.ts

@@ -5,22 +5,17 @@
 import vscode = require("vscode");
 import Window = vscode.window;
 import { LanguageClient, NotificationType, RequestType } from "vscode-languageclient";
-import { IFeature } from "../feature";
 import { Logger } from "../logging";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const ExpandAliasRequestType = new RequestType<any, any, void, void>("powerShell/expandAlias");
 
-export class ExpandAliasFeature implements IFeature {
+export class ExpandAliasFeature extends LanguageClientConsumer {
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
 
     constructor(private log: Logger) {
+        super();
         this.command = vscode.commands.registerCommand("PowerShell.ExpandAlias", () => {
-            if (this.languageClient === undefined) {
-                this.log.writeAndShowError(`<${ExpandAliasFeature.name}>: ` +
-                    "Unable to instantiate; language client undefined.");
-                return;
-            }
 
             const editor = Window.activeTextEditor;
             const document = editor.document;

src/features/ExtensionCommands.ts

@@ -11,6 +11,7 @@ import { LanguageClient, NotificationType, NotificationType0,
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
 import Settings = require("../settings");
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export interface IExtensionCommand {
     name: string;
@@ -173,20 +174,15 @@ interface IInvokeRegisteredEditorCommandParameter {
     commandName: string;
 }
 
-export class ExtensionCommandsFeature implements IFeature {
+export class ExtensionCommandsFeature extends LanguageClientConsumer implements IFeature {
 
     private command: vscode.Disposable;
     private command2: vscode.Disposable;
-    private languageClient: LanguageClient;
     private extensionCommands: IExtensionCommand[] = [];
 
     constructor(private log: Logger) {
+        super();
         this.command = vscode.commands.registerCommand("PowerShell.ShowAdditionalCommands", () => {
-            if (this.languageClient === undefined) {
-                this.log.writeAndShowError(`<${ExtensionCommandsFeature.name}>: ` +
-                    "Unable to instantiate; language client undefined.");
-                return;
-            }
 
             const editor = vscode.window.activeTextEditor;
             let start = editor.selection.start;

src/features/FindModule.ts

@@ -3,24 +3,24 @@
  *--------------------------------------------------------*/
 
 import vscode = require("vscode");
-import { LanguageClient, NotificationType, RequestType } from "vscode-languageclient";
-import Window = vscode.window;
+import { LanguageClient, RequestType } from "vscode-languageclient";
 import { IFeature } from "../feature";
 import QuickPickItem = vscode.QuickPickItem;
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const FindModuleRequestType =
     new RequestType<any, any, void, void>("powerShell/findModule");
 
 export const InstallModuleRequestType =
     new RequestType<string, void, void, void>("powerShell/installModule");
 
-export class FindModuleFeature implements IFeature {
+export class FindModuleFeature extends LanguageClientConsumer implements IFeature {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private cancelFindToken: vscode.CancellationTokenSource;
 
     constructor() {
+        super();
         this.command = vscode.commands.registerCommand("PowerShell.PowerShellFindModule", () => {
             // It takes a while to get the list of PowerShell modules, display some UI to let user know
             this.cancelFindToken = new vscode.CancellationTokenSource();

src/features/GetCommands.ts

@@ -5,6 +5,7 @@ import * as vscode from "vscode";
 import { LanguageClient, RequestType0 } from "vscode-languageclient";
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 interface ICommand {
     name: string;
@@ -23,13 +24,13 @@ export const GetCommandRequestType = new RequestType0<ICommand[], void, void>("p
 /**
  * A PowerShell Command listing feature. Implements a treeview control.
  */
-export class GetCommandsFeature implements IFeature {
+export class GetCommandsFeature extends LanguageClientConsumer implements IFeature {
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private commandsExplorerProvider: CommandsExplorerProvider;
     private commandsExplorerTreeView: vscode.TreeView<Command>;
 
     constructor(private log: Logger) {
+        super();
         this.command = vscode.commands.registerCommand("PowerShell.RefreshCommandsExplorer",
             () => this.CommandExplorerRefresh());
         this.commandsExplorerProvider = new CommandsExplorerProvider();

src/features/HelpCompletion.ts

@@ -8,6 +8,7 @@ import { LanguageClient, RequestType } from "vscode-languageclient";
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
 import Settings = require("../settings");
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const CommentHelpRequestType =
     new RequestType<any, any, void, void>("powerShell/getCommentHelp");
@@ -24,13 +25,13 @@ interface ICommentHelpRequestResult {
 
 enum SearchState { Searching, Locked, Found }
 
-export class HelpCompletionFeature implements IFeature {
+export class HelpCompletionFeature extends LanguageClientConsumer implements IFeature {
     private helpCompletionProvider: HelpCompletionProvider;
-    private languageClient: LanguageClient;
     private disposable: Disposable;
     private settings: Settings.ISettings;
 
     constructor(private log: Logger) {
+        super();
         this.settings = Settings.load();
 
         if (this.settings.helpCompletion !== Settings.HelpCompletion.Disabled) {

src/features/NewFileOrProject.ts

@@ -3,17 +3,18 @@
  *--------------------------------------------------------*/
 
 import vscode = require("vscode");
-import { LanguageClient, NotificationType, RequestType } from "vscode-languageclient";
+import { LanguageClient, RequestType } from "vscode-languageclient";
 import { IFeature } from "../feature";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
-export class NewFileOrProjectFeature implements IFeature {
+export class NewFileOrProjectFeature extends LanguageClientConsumer implements IFeature {
 
     private readonly loadIcon = "  $(sync)  ";
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private waitingForClientToken: vscode.CancellationTokenSource;
 
     constructor() {
+        super();
         this.command =
             vscode.commands.registerCommand("PowerShell.NewProjectFromTemplate", () => {
 

src/features/RemoteFiles.ts

@@ -5,8 +5,9 @@
 import os = require("os");
 import path = require("path");
 import vscode = require("vscode");
-import { LanguageClient, NotificationType, RequestType, TextDocumentIdentifier } from "vscode-languageclient";
+import { LanguageClient, NotificationType, TextDocumentIdentifier } from "vscode-languageclient";
 import { IFeature } from "../feature";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 // NOTE: The following two DidSaveTextDocument* types will
 // be removed when #593 gets fixed.
@@ -22,12 +23,12 @@ export const DidSaveTextDocumentNotificationType =
     new NotificationType<IDidSaveTextDocumentParams, void>(
         "textDocument/didSave");
 
-export class RemoteFilesFeature implements IFeature {
+export class RemoteFilesFeature extends LanguageClientConsumer implements IFeature {
 
     private tempSessionPathPrefix: string;
-    private languageClient: LanguageClient;
 
     constructor() {
+        super();
         // Get the common PowerShell Editor Services temporary file path
         // so that remote files from previous sessions can be closed.
         this.tempSessionPathPrefix =

src/features/ShowHelp.ts

@@ -6,22 +6,18 @@ import vscode = require("vscode");
 import { LanguageClient, NotificationType } from "vscode-languageclient";
 import { IFeature } from "../feature";
 import { Logger } from "../logging";
+import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const ShowHelpNotificationType =
     new NotificationType<any, void>("powerShell/showHelp");
 
-export class ShowHelpFeature implements IFeature {
+export class ShowHelpFeature extends LanguageClientConsumer implements IFeature {
     private command: vscode.Disposable;
     private deprecatedCommand: vscode.Disposable;
-    private languageClient: LanguageClient;
 
     constructor(private log: Logger) {
+        super();
         this.command = vscode.commands.registerCommand("PowerShell.ShowHelp", (item?) => {
-            if (this.languageClient === undefined) {
-                this.log.writeAndShowError(`<${ShowHelpFeature.name}>: ` +
-                    "Unable to instantiate; language client undefined.");
-                return;
-            }
             if (!item || !item.Name) {
 
                 const editor = vscode.window.activeTextEditor;

src/languageClientConsumer.ts

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import { LanguageClient, IFeature } from "./feature";
+import { window } from "vscode";
+
+export class LanguageClientConsumer {
+    private _languageClient: LanguageClient;
+
+    public get languageClient(): LanguageClient {
+        if (!this._languageClient) {
+            window.showInformationMessage(
+                "PowerShell extension has not finished starting up yet. Please try again in a few moments.");
+        }
+        return this._languageClient;
+    }
+
+    public set languageClient(value: LanguageClient) {
+        this._languageClient = value;
+    }
+}

src/main.ts

@@ -34,7 +34,6 @@ import { Logger, LogLevel } from "./logging";
 import { SessionManager } from "./session";
 import Settings = require("./settings");
 import { PowerShellLanguageId } from "./utils";
-import utils = require("./utils");
 
 // The most reliable way to get the name and version of the current extension.
 // tslint:disable-next-line: no-var-requires