Merge pull request #4276 from PowerShell/andschwa/lock-logger

Make `Logger.WriteLine` thread-safe and fix bug with UNC paths

Author: andyleejordan

src/features/ExternalApi.ts

@@ -169,7 +169,9 @@ export class ExternalApiFeature extends LanguageClientConsumer implements IPower
     }
 
     public getStorageUri(): vscode.Uri {
-        return this.extensionContext.globalStorageUri;
+        // We have to override the scheme because it defaults to
+        // 'vscode-userdata' which breaks UNC paths.
+        return this.extensionContext.globalStorageUri.with({ scheme: "file"});
     }
 
     public dispose() {

src/logging.ts

@@ -35,12 +35,15 @@ export class Logger implements ILogger {
     private logChannel: vscode.OutputChannel;
     private logFilePath: vscode.Uri;
     private logDirectoryCreated = false;
+    private writingLog = false;
 
     constructor(logLevelName: string, globalStorageUri: vscode.Uri) {
         this.logLevel = Logger.logLevelNameToValue(logLevelName);
         this.logChannel = vscode.window.createOutputChannel("PowerShell Extension Logs");
+        // We have to override the scheme because it defaults to
+        // 'vscode-userdata' which breaks UNC paths.
         this.logDirectoryPath = vscode.Uri.joinPath(
-            globalStorageUri,
+            globalStorageUri.with({ scheme: "file" }),
             "logs",
             `${Math.floor(Date.now() / 1000)}-${vscode.env.sessionId}`);
         this.logFilePath = this.getLogFilePath("vscode-powershell");
@@ -194,11 +197,16 @@ export class Logger implements ILogger {
         const timestampedMessage = Logger.timestampMessage(message, level);
         this.logChannel.appendLine(timestampedMessage);
         if (this.logLevel !== LogLevel.None) {
+            // A simple lock because this function isn't re-entrant.
+            while (this.writingLog) {
+                await utils.sleep(300);
+            }
             try {
+                this.writingLog = true;
                 if (!this.logDirectoryCreated) {
                     this.logChannel.appendLine(Logger.timestampMessage(`Creating log directory at: '${this.logDirectoryPath}'`, level));
                     await vscode.workspace.fs.createDirectory(this.logDirectoryPath);
-                    this.logDirectoryCreated = await utils.checkIfDirectoryExists(this.logDirectoryPath);
+                    this.logDirectoryCreated = true;
                 }
                 let log = new Uint8Array();
                 if (await utils.checkIfFileExists(this.logFilePath)) {
@@ -209,6 +217,8 @@ export class Logger implements ILogger {
                     Buffer.concat([log, Buffer.from(timestampedMessage)]));
             } catch (e) {
                 console.log(`Error writing to vscode-powershell log file: ${e}`);
+            } finally {
+                this.writingLog = false;
             }
         }
     }

src/session.ts

@@ -111,7 +111,9 @@ export class SessionManager implements Middleware {
 
         // Create the language status item
         this.languageStatusItem = this.createStatusBarItem();
-        this.sessionsFolder = vscode.Uri.joinPath(extensionContext.globalStorageUri, "sessions");
+        // We have to override the scheme because it defaults to
+        // 'vscode-userdata' which breaks UNC paths.
+        this.sessionsFolder = vscode.Uri.joinPath(extensionContext.globalStorageUri.with({ scheme: "file"}), "sessions");
         this.platformDetails = getPlatformDetails();
         this.HostName = hostName;
         this.HostVersion = hostVersion;