Clean up WaitForSessionFile logic and support increasing timeout with warning (#2653)

* Add better sessionfile wait logic with setting

* clean up logic

* move into process.ts to use vscode api

* use timeout seconds

Co-authored-by: Tyler Leonhardt (POWERSHELL) <tyleonha@microsoft.com>

Author: TylerLeonhardt

package-lock.json

@@ -761,6 +761,11 @@
           "default": null,
           "description": "An array of strings that enable experimental features in the PowerShell extension."
         },
+        "powershell.developer.waitForSessionFileTimeoutSeconds": {
+          "type": "number",
+          "default": 240,
+          "description": "When the PowerShell extension is starting up, it checks for a session file in order to connect to the language server. This setting determines how long until checking for the session file times out. (default is 240 seconds or 4 minutes)"
+        },
         "powershell.pester.useLegacyCodeLens": {
           "type": "boolean",
           "default": true,

package.json

@@ -17,6 +17,10 @@ export class PowerShellProcess {
         return pspath.replace(new RegExp("'", "g"), "''");
     }
 
+    // This is used to warn the user that the extension is taking longer than expected to startup.
+    // After the 15th try we've hit 30 seconds and should warn.
+    private static warnUserThreshold = 15;
+
     public onExited: vscode.Event<void>;
     private onExitedEmitter = new vscode.EventEmitter<void>();
 
@@ -174,20 +178,36 @@ export class PowerShellProcess {
         return true;
     }
 
-    private waitForSessionFile(): Promise<utils.IEditorServicesSessionDetails> {
-        return new Promise((resolve, reject) => {
-            utils.waitForSessionFile(this.sessionFilePath, (sessionDetails, error) => {
-                utils.deleteSessionFile(this.sessionFilePath);
+    private sleep(ms: number) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+    }
 
-                if (error) {
-                    this.log.write(`Error occurred retrieving session file:\n${error}`);
-                    return reject(error);
-                }
+    private async waitForSessionFile(): Promise<utils.IEditorServicesSessionDetails> {
+        // Determine how many tries by dividing by 2000 thus checking every 2 seconds.
+        const numOfTries = this.sessionSettings.developer.waitForSessionFileTimeoutSeconds / 2;
+        const warnAt = numOfTries - PowerShellProcess.warnUserThreshold;
 
+        // Check every 2 seconds
+        for (let i = numOfTries; i > 0; i--) {
+            if (utils.checkIfFileExists(this.sessionFilePath)) {
                 this.log.write("Session file found");
-                resolve(sessionDetails);
-            });
-        });
+                const sessionDetails = utils.readSessionFile(this.sessionFilePath);
+                utils.deleteSessionFile(this.sessionFilePath);
+                return sessionDetails;
+            }
+
+            if (warnAt === i) {
+                vscode.window.showWarningMessage(`Loading the PowerShell extension is taking longer than expected.
+    If you're using privilege enforcement software, this can affect start up performance.`);
+            }
+
+            // Wait a bit and try again
+            await this.sleep(2000);
+        }
+
+        const err = "Timed out waiting for session file to appear.";
+        this.log.write(err);
+        throw new Error(err);
     }
 
     private onTerminalClose(terminal: vscode.Terminal) {

src/process.ts

@@ -72,6 +72,7 @@ export interface IDeveloperSettings {
     bundledModulesPath?: string;
     editorServicesLogLevel?: string;
     editorServicesWaitForDebugger?: boolean;
+    waitForSessionFileTimeoutSeconds?: number;
 }
 
 export interface ISettings {
@@ -142,6 +143,7 @@ export function load(): ISettings {
         bundledModulesPath: "../../../PowerShellEditorServices/module",
         editorServicesLogLevel: "Normal",
         editorServicesWaitForDebugger: false,
+        waitForSessionFileTimeoutSeconds: 240,
     };
 
     const defaultCodeFoldingSettings: ICodeFoldingSettings = {

src/settings.ts

@@ -45,7 +45,6 @@ export interface IEditorServicesSessionDetails {
 }
 
 export type IReadSessionFileCallback = (details: IEditorServicesSessionDetails) => void;
-export type IWaitForSessionFileCallback = (details: IEditorServicesSessionDetails, error: string) => void;
 
 const sessionsFolder = path.resolve(__dirname, "..", "..", "sessions/");
 const sessionFilePathPrefix = path.resolve(sessionsFolder, "PSES-VSCode-" + process.env.VSCODE_PID);
@@ -69,25 +68,6 @@ export function writeSessionFile(sessionFilePath: string, sessionDetails: IEdito
     writeStream.close();
 }
 
-export function waitForSessionFile(sessionFilePath: string, callback: IWaitForSessionFileCallback) {
-
-    function innerTryFunc(remainingTries: number, delayMilliseconds: number) {
-        if (remainingTries === 0) {
-            callback(undefined, "Timed out waiting for session file to appear.");
-        } else if (!checkIfFileExists(sessionFilePath)) {
-            // Wait a bit and try again
-            setTimeout(
-                () => { innerTryFunc(remainingTries - 1, delayMilliseconds); },
-                delayMilliseconds);
-        } else {
-            // Session file was found, load and return it
-            callback(readSessionFile(sessionFilePath), undefined);
-        }
-    }
-
-    // Try once every 2 seconds, 60 times - making two full minutes
-    innerTryFunc(60, 2000);
-}
 
 export function readSessionFile(sessionFilePath: string): IEditorServicesSessionDetails {
     const fileContents = fs.readFileSync(sessionFilePath, "utf-8");