fixup!: refactor isWsl and tests

Author: jsjoeio

src/node/util.ts

@@ -381,13 +381,27 @@ export const getMediaMime = (filePath?: string): string => {
  * A helper function that checks if the platform is Windows Subsystem for Linux
  * (WSL)
  *
+ * @see https://github.com/sindresorhus/is-wsl/blob/main/index.js
  * @returns {Boolean} boolean if it is WSL
  */
-export const isWsl = async (platform: NodeJS.Platform, procVersionFilePath: string): Promise<boolean> => {
-  return (
-    (platform === "linux" && os.release().toLowerCase().indexOf("microsoft") !== -1) ||
-    (await fs.readFile(procVersionFilePath, "utf8")).toLowerCase().indexOf("microsoft") !== -1
-  )
+export const isWsl = async (
+  platform: NodeJS.Platform,
+  osRelease: string,
+  procVersionFilePath: string,
+): Promise<boolean> => {
+  if (platform !== "linux") {
+    return false
+  }
+
+  if (osRelease.toLowerCase().includes("microsoft")) {
+    return true
+  }
+
+  try {
+    return (await fs.readFile(procVersionFilePath, "utf8")).toLowerCase().includes("microsoft")
+  } catch (_) {
+    return false
+  }
 }
 
 /**
@@ -404,7 +418,7 @@ export const open = async (address: URL | string): Promise<void> => {
   }
   const args = [] as string[]
   const options = {} as cp.SpawnOptions
-  const platform = (await isWsl(process.platform, "/proc/version")) ? "wsl" : process.platform
+  const platform = (await isWsl(process.platform, os.release(), "/proc/version")) ? "wsl" : process.platform
   let command = platform === "darwin" ? "open" : "xdg-open"
   if (platform === "win32" || platform === "wsl") {
     command = platform === "wsl" ? "cmd.exe" : "cmd"

test/unit/node/util.test.ts

@@ -4,6 +4,7 @@ import * as path from "path"
 import { generateUuid } from "../../../src/common/util"
 import { tmpdir } from "../../../src/node/constants"
 import * as util from "../../../src/node/util"
+import { clean, tmpdir as tempDirHelper } from "../../utils/helpers"
 
 describe("getEnvPaths", () => {
   describe("on darwin", () => {
@@ -484,72 +485,46 @@ describe("humanPath", () => {
 })
 
 describe("isWsl", () => {
-  describe("on Linux (microsoft)", () => {
-    const testDir = path.join(tmpdir, "tests", "isWsl-linux-microsoft")
-    let pathToFile = ""
+  const testName = "wsl"
 
-    beforeEach(async () => {
-      pathToFile = path.join(testDir, "/proc-version")
-      await fs.mkdir(testDir, { recursive: true })
-      await fs.writeFile(pathToFile, "microsoft")
-    })
-    afterEach(async () => {
-      await fs.rm(testDir, { recursive: true, force: true })
-    })
+  beforeAll(async () => {
+    await clean(testName)
+  })
 
+  describe("on Linux (microsoft)", () => {
     it("should return true", async () => {
-      expect(await util.isWsl("linux", pathToFile)).toBe(true)
+      const fileName = "proc-version"
+      const osRelease = "Linux"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      await fs.writeFile(pathToFile, "microsoft")
+      expect(await util.isWsl("linux", osRelease, pathToFile)).toBe(true)
     })
   })
   describe("on Linux (non-microsoft)", () => {
-    const testDir = path.join(tmpdir, "tests", "isWsl-linux-non-microsoft")
-    let pathToFile = ""
-
-    beforeEach(async () => {
-      pathToFile = path.join(testDir, "/proc-version")
-      await fs.mkdir(testDir, { recursive: true })
-      await fs.writeFile(pathToFile, "linux")
-    })
-    afterEach(async () => {
-      await fs.rm(testDir, { recursive: true, force: true })
-    })
-
     it("should return false", async () => {
-      expect(await util.isWsl("linux", pathToFile)).toBe(false)
+      const fileName = "proc-version2"
+      const osRelease = "Linux"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      await fs.writeFile(pathToFile, "linux")
+      expect(await util.isWsl("linux", osRelease, pathToFile)).toBe(false)
     })
   })
   describe("on Win32 with microsoft in /proc/version", () => {
-    const testDir = path.join(tmpdir, "tests", "isWsl-win32-microsoft")
-    let pathToFile = ""
-
-    beforeEach(async () => {
-      pathToFile = path.join(testDir, "/proc-version")
-      await fs.mkdir(testDir, { recursive: true })
+    it("should return false", async () => {
+      const fileName = "proc-version3"
+      const osRelease = "Microsoft"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
       await fs.writeFile(pathToFile, "microsoft")
-    })
-    afterEach(async () => {
-      await fs.rm(testDir, { recursive: true, force: true })
-    })
-
-    it("should return true", async () => {
-      expect(await util.isWsl("win32", pathToFile)).toBe(true)
+      expect(await util.isWsl("win32", osRelease, pathToFile)).toBe(false)
     })
   })
   describe("on Darwin", () => {
-    const testDir = path.join(tmpdir, "tests", "isWsl-darwin")
-    let pathToFile = ""
-
-    beforeEach(async () => {
-      pathToFile = path.join(testDir, "/proc-version")
-      await fs.mkdir(testDir, { recursive: true })
-      await fs.writeFile(pathToFile, "darwin")
-    })
-    afterEach(async () => {
-      await fs.rm(testDir, { recursive: true, force: true })
-    })
-
     it("should return false", async () => {
-      expect(await util.isWsl("darwin", pathToFile)).toBe(false)
+      const fileName = "proc-version4"
+      const osRelease =
+        "Darwin Roadrunner.local 10.3.0 Darwin Kernel Version 10.3.0: Fri Feb 26 11:58:09 PST 2010; root:xnu-1504.3.12~1/RELEASE_I386 i386"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      expect(await util.isWsl("darwin", osRelease, pathToFile)).toBe(false)
     })
   })
 })