Remove nearly all remaining uses of Node.JS fs module

The last one involves a stream.

Author: andyleejordan

src/features/ExtensionCommands.ts

@@ -3,7 +3,6 @@
 
 // TODO: This file needs some TLC to use strict mode.
 
-import * as fs from "fs";
 import * as os from "os";
 import * as path from "path";
 import * as vscode from "vscode";
@@ -530,15 +529,9 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
 
         // Write it to the new document path
         try {
-            // TODO: Change this to be asynchronous
-            await new Promise<void>((resolve, reject) => {
-                fs.writeFile(destinationAbsolutePath, oldDocument.getText(), (err) => {
-                    if (err) {
-                        return reject(err);
-                    }
-                    return resolve();
-                });
-            });
+            await vscode.workspace.fs.writeFile(
+                vscode.Uri.file(destinationAbsolutePath),
+                Buffer.from(oldDocument.getText()));
         } catch (e) {
             this.log.writeAndShowWarning(`<${ExtensionCommandsFeature.name}>: ` +
                 `Unable to save file to path '${destinationAbsolutePath}': ${e}`);

src/features/UpdatePowerShell.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { spawn } from "child_process";
-import * as fs from "fs";
+import * as fs from "fs"; // TODO: Remove, but it's for a stream.
 import fetch, { RequestInit } from "node-fetch";
 import * as os from "os";
 import * as path from "path";

src/logging.ts

@@ -3,7 +3,7 @@
 
 "use strict";
 
-import fs = require("fs");
+import utils = require("./utils");
 import os = require("os");
 import vscode = require("vscode");
 
@@ -62,7 +62,7 @@ export class Logger implements ILogger {
         return vscode.Uri.joinPath(this.logSessionPath, `${baseName}.log`);
     }
 
-    public writeAtLevel(logLevel: LogLevel, message: string, ...additionalMessages: string[]): void {
+    private writeAtLevel(logLevel: LogLevel, message: string, ...additionalMessages: string[]): void {
         if (logLevel >= this.MinimumLogLevel) {
             this.writeLine(message, logLevel);
 
@@ -170,22 +170,26 @@ export class Logger implements ILogger {
         }
     }
 
-    private writeLine(message: string, level: LogLevel = LogLevel.Normal): void {
+    // TODO: Should we await this function above?
+    private async writeLine(message: string, level: LogLevel = LogLevel.Normal): Promise<void> {
         const now = new Date();
         const timestampedMessage =
-            `${now.toLocaleDateString()} ${now.toLocaleTimeString()} [${LogLevel[level].toUpperCase()}] - ${message}`;
+            `${now.toLocaleDateString()} ${now.toLocaleTimeString()} [${LogLevel[level].toUpperCase()}] - ${message}${os.EOL}`;
 
         this.logChannel.appendLine(timestampedMessage);
         if (this.logFilePath && this.MinimumLogLevel !== LogLevel.None) {
-            fs.appendFile(
-                this.logFilePath.fsPath,
-                timestampedMessage + os.EOL,
-                (err) => {
-                    if (err) {
-                        // tslint:disable-next-line:no-console
-                        console.log(`Error writing to vscode-powershell log file: ${err}`);
-                    }
-                });
+            try {
+                let log = new Uint8Array();
+                if (await utils.checkIfFileExists(this.logFilePath)) {
+                    log = await vscode.workspace.fs.readFile(this.logFilePath);
+                }
+                await vscode.workspace.fs.writeFile(
+                    this.logFilePath,
+                    Buffer.concat([log, Buffer.from(timestampedMessage)]));
+            } catch (e) {
+                // tslint:disable-next-line:no-console
+                console.log(`Error writing to vscode-powershell log file: ${e}`)
+            }
         }
     }
 }

src/platform.ts

@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import * as fs from "fs";
 import * as os from "os";
 import * as path from "path";
 import * as process from "process";
 import { IPowerShellAdditionalExePathSettings } from "./settings";
+
 // This uses require so we can rewire it in unit tests!
 // tslint:disable-next-line:no-var-requires
 const utils = require("./utils")
@@ -290,11 +290,10 @@ export class PowerShellExeFinder {
             : { pwshMsixDirRegex: PowerShellExeFinder.PwshMsixRegex, pwshMsixName: "PowerShell (Store)" };
 
         // We should find only one such application, so return on the first one
-        // TODO: Use VS Code async fs API for this.
-        for (const subdir of fs.readdirSync(msixAppDir)) {
-            if (pwshMsixDirRegex.test(subdir)) {
-                const pwshMsixPath = path.join(msixAppDir, subdir, "pwsh.exe");
-                return new PossiblePowerShellExe(pwshMsixPath, pwshMsixName);
+        for (const name of await utils.readDirectory(msixAppDir)) {
+            // tslint:disable-next-line:no-bitwise
+            if (pwshMsixDirRegex.test(name)) {
+                return new PossiblePowerShellExe(path.join(msixAppDir, name, "pwsh.exe"), pwshMsixName);
             }
         }
 
@@ -329,8 +328,7 @@ export class PowerShellExeFinder {
 
         let highestSeenVersion: number = -1;
         let pwshExePath: string = null;
-        for (const item of fs.readdirSync(powerShellInstallBaseDir)) {
-
+        for (const item of await utils.readDirectory(powerShellInstallBaseDir)) {
             let currentVersion: number = -1;
             if (findPreview) {
                 // We are looking for something like "7-preview"

src/process.ts

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import fs = require("fs");
 import cp = require("child_process");
 import * as semver from "semver";
 import path = require("path");
@@ -189,10 +188,9 @@ export class PowerShellProcess {
         return true;
     }
 
-    private static readSessionFile(sessionFilePath: vscode.Uri): IEditorServicesSessionDetails {
-        // TODO: Use vscode.workspace.fs.readFile instead of fs.readFileSync.
-        const fileContents = fs.readFileSync(sessionFilePath.fsPath, "utf-8");
-        return JSON.parse(fileContents);
+    private static async readSessionFile(sessionFilePath: vscode.Uri): Promise<IEditorServicesSessionDetails> {
+        const fileContents = await vscode.workspace.fs.readFile(sessionFilePath);
+        return JSON.parse(fileContents.toString());
     }
 
     private static async deleteSessionFile(sessionFilePath: vscode.Uri) {
@@ -213,7 +211,7 @@ export class PowerShellProcess {
         for (let i = numOfTries; i > 0; i--) {
             if (await utils.checkIfFileExists(this.sessionFilePath)) {
                 this.log.write("Session file found!");
-                const sessionDetails = PowerShellProcess.readSessionFile(this.sessionFilePath);
+                const sessionDetails = await PowerShellProcess.readSessionFile(this.sessionFilePath);
                 PowerShellProcess.deleteSessionFile(this.sessionFilePath);
                 return sessionDetails;
             }

src/utils.ts

@@ -43,6 +43,14 @@ export async function checkIfDirectoryExists(directoryPath: string | vscode.Uri)
     return await checkIfFileOrDirectoryExists(directoryPath, vscode.FileType.Directory);
 }
 
+export async function readDirectory(directoryPath: string | vscode.Uri): Promise<string[]> {
+    const items = await vscode.workspace.fs.readDirectory(
+        directoryPath instanceof vscode.Uri
+            ? directoryPath
+            : vscode.Uri.file(directoryPath));
+    return items.map(([name, _type]) => name);
+}
+
 export function getTimestampString() {
     const time = new Date();
     return `[${time.getHours()}:${time.getMinutes()}:${time.getSeconds()}]`;

test/core/paths.test.ts

@@ -2,10 +2,10 @@
 // Licensed under the MIT License.
 
 import * as assert from "assert";
-import * as fs from "fs";
 import * as vscode from "vscode";
 import { IPowerShellExtensionClient } from "../../src/features/ExternalApi";
 import utils = require("../utils");
+import { checkIfDirectoryExists } from "../../src/utils"
 
 describe("Path assumptions", function () {
     let globalStorageUri: vscode.Uri;
@@ -21,11 +21,11 @@ describe("Path assumptions", function () {
         assert(await vscode.commands.executeCommand("PowerShell.OpenExamplesFolder"));
     });
 
-    it("Creates the session folder at the correct path", function () {
-        assert(fs.existsSync(vscode.Uri.joinPath(globalStorageUri, "sessions").fsPath));
+    it("Creates the session folder at the correct path", async function () {
+        assert(await checkIfDirectoryExists(vscode.Uri.joinPath(globalStorageUri, "sessions")));
     });
 
-    it("Creates the log folder at the correct path", function () {
-        assert(fs.existsSync(vscode.Uri.joinPath(globalStorageUri, "logs").fsPath));
+    it("Creates the log folder at the correct path", async function () {
+        assert(await checkIfDirectoryExists(vscode.Uri.joinPath(globalStorageUri, "logs")));
     });
 });

test/core/platform.test.ts

@@ -8,7 +8,7 @@ import * as path from "path";
 import rewire = require("rewire");
 import * as sinon from "sinon";
 import * as platform from "../../src/platform";
-import * as fs from "fs";
+import * as fs from "fs"; // NOTE: Necessary for mock-fs.
 import * as vscode from "vscode";
 
 // We have to rewire the platform module so that mock-fs can be used, as it
@@ -23,10 +23,17 @@ async function fakeCheckIfFileOrDirectoryExists(targetPath: string | vscode.Uri)
         return false;
     }
 }
+
+async function fakeReadDirectory(targetPath: string | vscode.Uri): Promise<string[]> {
+    return fs.readdirSync(targetPath instanceof vscode.Uri ? targetPath.fsPath : targetPath);
+}
+
 const utilsMock = {
     checkIfFileExists: fakeCheckIfFileOrDirectoryExists,
-    checkIfDirectoryExists: fakeCheckIfFileOrDirectoryExists
+    checkIfDirectoryExists: fakeCheckIfFileOrDirectoryExists,
+    readDirectory: fakeReadDirectory
 }
+
 platformMock.__set__("utils", utilsMock);
 
 /**

test/features/RunCode.test.ts

@@ -2,11 +2,11 @@
 // Licensed under the MIT License.
 
 import * as assert from "assert";
-import * as fs from "fs";
 import * as path from "path";
 import rewire = require("rewire");
 import vscode = require("vscode");
 import utils = require("../utils");
+import { checkIfFileExists } from "../../src/utils"
 
 // Setup function that is not exported.
 const customViews = rewire("../../src/features/RunCode");
@@ -43,7 +43,7 @@ describe("RunCode feature", function () {
 
     it("Runs Pester tests from a file", async function () {
         const pesterTests = path.resolve(__dirname, "../../../examples/Tests/SampleModule.Tests.ps1");
-        assert(fs.existsSync(pesterTests));
+        assert(checkIfFileExists(pesterTests));
 
         // Open the PowerShell file with Pester tests and then wait a while for
         // the extension to finish connecting to the server.