Move session file functions to session from utils

Author: andyleejordan

src/features/DebugSession.ts

@@ -8,9 +8,8 @@ import { NotificationType, RequestType } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { getPlatformDetails, OperatingSystem } from "../platform";
 import { PowerShellProcess} from "../process";
-import { SessionManager, SessionStatus } from "../session";
+import { IEditorServicesSessionDetails, SessionManager, SessionStatus } from "../session";
 import Settings = require("../settings");
-import utils = require("../utils");
 import { Logger } from "../logging";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
@@ -25,8 +24,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
 
     private sessionCount: number = 1;
     private tempDebugProcess: PowerShellProcess;
-    private tempDebugEventHandler: vscode.Disposable;
-    private tempSessionDetails: utils.IEditorServicesSessionDetails;
+    private tempSessionDetails: IEditorServicesSessionDetails;
 
     constructor(context: ExtensionContext, private sessionManager: SessionManager, private logger: Logger) {
         super();
@@ -314,12 +312,11 @@ export class DebugSessionFeature extends LanguageClientConsumer
         const sessionFilePath = this.sessionManager.getDebugSessionFilePath();
 
         if (config.createTemporaryIntegratedConsole) {
-            // TODO: This should be cleaned up to support multiple temporary consoles.
             this.tempDebugProcess = this.sessionManager.createDebugSessionProcess(sessionFilePath, settings);
             this.tempSessionDetails = await this.tempDebugProcess.start(`DebugSession-${this.sessionCount++}`);
-            await utils.writeSessionFile(sessionFilePath, this.tempSessionDetails);
+            await this.sessionManager.writeSessionFile(sessionFilePath, this.tempSessionDetails);
         } else {
-            await utils.writeSessionFile(sessionFilePath, this.sessionManager.getSessionDetails());
+            await this.sessionManager.writeSessionFile(sessionFilePath, this.sessionManager.getSessionDetails());
         }
 
         return config;

src/features/PesterTests.ts

@@ -131,7 +131,7 @@ export class PesterTestsFeature implements vscode.Disposable {
         vscode.commands.executeCommand("PowerShell.ShowSessionConsole", true);
 
         // Write out temporary debug session file
-        await utils.writeSessionFile(
+        await this.sessionManager.writeSessionFile(
             this.sessionManager.getDebugSessionFilePath(),
             this.sessionManager.getSessionDetails());
 

src/features/RunCode.ts

@@ -44,7 +44,7 @@ export class RunCodeFeature implements vscode.Disposable {
         await vscode.commands.executeCommand("PowerShell.ShowSessionConsole", true);
 
         // Write out temporary debug session file
-        await utils.writeSessionFile(
+        await this.sessionManager.writeSessionFile(
             this.sessionManager.getDebugSessionFilePath(),
             this.sessionManager.getSessionDetails());
 

src/process.ts

@@ -8,10 +8,11 @@ import vscode = require("vscode");
 import { Logger } from "./logging";
 import Settings = require("./settings");
 import utils = require("./utils");
+import { IEditorServicesSessionDetails, SessionManager } from "./session";
 
 export class PowerShellProcess {
-    public static escapeSingleQuotes(pspath: string): string {
-        return pspath.replace(new RegExp("'", "g"), "''");
+    public static escapeSingleQuotes(psPath: string): string {
+        return psPath.replace(new RegExp("'", "g"), "''");
     }
 
     // This is used to warn the user that the extension is taking longer than expected to startup.
@@ -36,7 +37,7 @@ export class PowerShellProcess {
         this.onExited = this.onExitedEmitter.event;
     }
 
-    public async start(logFileName: string): Promise<utils.IEditorServicesSessionDetails> {
+    public async start(logFileName: string): Promise<IEditorServicesSessionDetails> {
         const editorServicesLogPath = this.log.getLogFilePath(logFileName);
 
         const psesModulePath =
@@ -99,7 +100,7 @@ export class PowerShellProcess {
             "    PowerShell Editor Services args: " + startEditorServices);
 
         // Make sure no old session file exists
-        utils.deleteSessionFile(this.sessionFilePath);
+        SessionManager.deleteSessionFile(this.sessionFilePath);
 
         // Launch PowerShell in the integrated terminal
         const terminalOptions: vscode.TerminalOptions = {
@@ -149,7 +150,7 @@ export class PowerShellProcess {
 
     public dispose() {
         // Clean up the session file
-        utils.deleteSessionFile(this.sessionFilePath);
+        SessionManager.deleteSessionFile(this.sessionFilePath);
 
         if (this.consoleCloseSubscription) {
             this.consoleCloseSubscription.dispose();
@@ -189,7 +190,7 @@ export class PowerShellProcess {
         return true;
     }
 
-    private async waitForSessionFile(): Promise<utils.IEditorServicesSessionDetails> {
+    private async waitForSessionFile(): Promise<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;
@@ -198,8 +199,8 @@ export class PowerShellProcess {
         for (let i = numOfTries; i > 0; i--) {
             if (utils.checkIfFileExists(this.sessionFilePath)) {
                 this.log.write("Session file found");
-                const sessionDetails = utils.readSessionFile(this.sessionFilePath);
-                utils.deleteSessionFile(this.sessionFilePath);
+                const sessionDetails = SessionManager.readSessionFile(this.sessionFilePath);
+                SessionManager.deleteSessionFile(this.sessionFilePath);
                 return sessionDetails;
             }
 

src/session.ts

@@ -34,6 +34,20 @@ export enum SessionStatus {
     Failed,
 }
 
+export interface IEditorServicesSessionDetails {
+    status: string;
+    reason: string;
+    detail: string;
+    powerShellVersion: string;
+    channel: string;
+    languageServicePort: number;
+    debugServicePort: number;
+    languageServicePipeName: string;
+    debugServicePipeName: string;
+}
+
+export type IReadSessionFileCallback = (details: IEditorServicesSessionDetails) => void;
+
 export class SessionManager implements Middleware {
     public HostName: string;
     public HostVersion: string;
@@ -55,7 +69,7 @@ export class SessionManager implements Middleware {
     private registeredCommands: vscode.Disposable[] = [];
     private languageServerClient: LanguageClient = undefined;
     private sessionSettings: Settings.ISettings = undefined;
-    private sessionDetails: utils.IEditorServicesSessionDetails;
+    private sessionDetails: IEditorServicesSessionDetails;
     private sessionsFolder = path.resolve(__dirname, "../sessions");
     private sessionFilePathPrefix = path.resolve(this.sessionsFolder, "PSES-VSCode-" + process.env.VSCODE_PID);
     private bundledModulesPath: string;
@@ -249,7 +263,7 @@ export class SessionManager implements Middleware {
         await this.start(exeNameOverride);
     }
 
-    public getSessionDetails(): utils.IEditorServicesSessionDetails {
+    public getSessionDetails(): IEditorServicesSessionDetails {
         return this.sessionDetails;
     }
 
@@ -269,6 +283,29 @@ export class SessionManager implements Middleware {
         return `${this.sessionFilePathPrefix}-Debug`;
     }
 
+    public async writeSessionFile(sessionFilePath: string, sessionDetails: IEditorServicesSessionDetails) {
+        await vscode.workspace.fs.createDirectory(vscode.Uri.file(this.sessionsFolder));
+
+        const writeStream = fs.createWriteStream(sessionFilePath);
+        writeStream.write(JSON.stringify(sessionDetails));
+        writeStream.close();
+    }
+
+    public static readSessionFile(sessionFilePath: string): IEditorServicesSessionDetails {
+        // TODO: Use vscode.workspace.fs.readFile instead of fs.readFileSync.
+        const fileContents = fs.readFileSync(sessionFilePath, "utf-8");
+        return JSON.parse(fileContents);
+    }
+
+    public static async deleteSessionFile(sessionFilePath: string) {
+        try {
+            await vscode.workspace.fs.delete(vscode.Uri.file(sessionFilePath));
+            // fs.unlinkSync(sessionFilePath);
+        } catch (e) {
+            // TODO: Be more specific about what we're catching
+        }
+    }
+
     public createDebugSessionProcess(
         sessionPath: string,
         sessionSettings: Settings.ISettings): PowerShellProcess {
@@ -526,7 +563,7 @@ export class SessionManager implements Middleware {
         }
     }
 
-    private startLanguageClient(sessionDetails: utils.IEditorServicesSessionDetails) {
+    private startLanguageClient(sessionDetails: IEditorServicesSessionDetails) {
         // Log the session details object
         this.log.write(JSON.stringify(sessionDetails));
 

src/utils.ts

@@ -37,44 +37,6 @@ export function getPipePath(pipeName: string) {
     }
 }
 
-export interface IEditorServicesSessionDetails {
-    status: string;
-    reason: string;
-    detail: string;
-    powerShellVersion: string;
-    channel: string;
-    languageServicePort: number;
-    debugServicePort: number;
-    languageServicePipeName: string;
-    debugServicePipeName: string;
-}
-
-export type IReadSessionFileCallback = (details: IEditorServicesSessionDetails) => void;
-
-const sessionsFolder = path.resolve(__dirname, "../sessions");
-
-export async function writeSessionFile(sessionFilePath: string, sessionDetails: IEditorServicesSessionDetails) {
-    await vscode.workspace.fs.createDirectory(vscode.Uri.file(sessionsFolder));
-
-    const writeStream = fs.createWriteStream(sessionFilePath);
-    writeStream.write(JSON.stringify(sessionDetails));
-    writeStream.close();
-}
-
-
-export function readSessionFile(sessionFilePath: string): IEditorServicesSessionDetails {
-    const fileContents = fs.readFileSync(sessionFilePath, "utf-8");
-    return JSON.parse(fileContents);
-}
-
-export function deleteSessionFile(sessionFilePath: string) {
-    try {
-        fs.unlinkSync(sessionFilePath);
-    } catch (e) {
-        // TODO: Be more specific about what we're catching
-    }
-}
-
 export function checkIfFileExists(filePath: string): boolean {
     try {
         fs.accessSync(filePath, fs.constants.R_OK);