refactor(util): pass in process.platform

Author: jsjoeio

src/node/util.ts

@@ -1,5 +1,5 @@
 import { logger } from "@coder/logger"
-import { hash as _hash, verify } from "@node-rs/argon2"
+import * as argon2 from "@node-rs/argon2"
 import * as cp from "child_process"
 import * as crypto from "crypto"
 import envPaths from "env-paths"
@@ -58,10 +58,10 @@ export const paths = getEnvPaths()
  * On MacOS this function gets the standard XDG directories instead of using the native macOS
  * ones. Most CLIs do this as in practice only GUI apps use the standard macOS directories.
  */
-export function getEnvPaths(): Paths {
+export function getEnvPaths(platform = process.platform): Paths {
   const paths = envPaths("code-server", { suffix: "" })
   const append = (p: string): string => path.join(p, "code-server")
-  switch (process.platform) {
+  switch (platform) {
     case "darwin":
       return {
         // envPaths uses native directories so force Darwin to use the XDG spec
@@ -158,7 +158,7 @@ export const generatePassword = async (length = 24): Promise<string> => {
  */
 export const hash = async (password: string): Promise<string> => {
   try {
-    return await _hash(password)
+    return await argon2.hash(password)
   } catch (error: any) {
     logger.error(error)
     return ""
@@ -173,7 +173,7 @@ export const isHashMatch = async (password: string, hash: string) => {
     return false
   }
   try {
-    return await verify(hash, password)
+    return await argon2.verify(hash, password)
   } catch (error: any) {
     logger.error(error)
     return false

test/unit/node/util.test.ts

@@ -5,18 +5,8 @@ import { generateUuid } from "../../../src/common/util"
 import { tmpdir } from "../../../src/node/constants"
 import * as util from "../../../src/node/util"
 
-describe.skip("getEnvPaths", () => {
+describe("getEnvPaths", () => {
   describe("on darwin", () => {
-    let ORIGINAL_PLATFORM = ""
-
-    beforeAll(() => {
-      ORIGINAL_PLATFORM = process.platform
-
-      Object.defineProperty(process, "platform", {
-        value: "darwin",
-      })
-    })
-
     beforeEach(() => {
       jest.resetModules()
       jest.mock("env-paths", () => {
@@ -27,23 +17,14 @@ describe.skip("getEnvPaths", () => {
         })
       })
     })
-
-    afterAll(() => {
-      // Restore old platform
-
-      Object.defineProperty(process, "platform", {
-        value: ORIGINAL_PLATFORM,
-      })
-    })
-
     it("should return the env paths using xdgBasedir", () => {
       jest.mock("xdg-basedir", () => ({
         data: "/home/usr/.local/share",
         config: "/home/usr/.config",
         runtime: "/tmp/runtime",
       }))
       const getEnvPaths = require("../../../src/node/util").getEnvPaths
-      const envPaths = getEnvPaths()
+      const envPaths = getEnvPaths("darwin")
 
       expect(envPaths.data).toEqual("/home/usr/.local/share/code-server")
       expect(envPaths.config).toEqual("/home/usr/.config/code-server")
@@ -53,24 +34,14 @@ describe.skip("getEnvPaths", () => {
     it("should return the env paths using envPaths when xdgBasedir is undefined", () => {
       jest.mock("xdg-basedir", () => ({}))
       const getEnvPaths = require("../../../src/node/util").getEnvPaths
-      const envPaths = getEnvPaths()
+      const envPaths = getEnvPaths("darwin")
 
       expect(envPaths.data).toEqual("/home/envPath/.local/share")
       expect(envPaths.config).toEqual("/home/envPath/.config")
       expect(envPaths.runtime).toEqual("/tmp/envPath/runtime")
     })
   })
   describe("on win32", () => {
-    let ORIGINAL_PLATFORM = ""
-
-    beforeAll(() => {
-      ORIGINAL_PLATFORM = process.platform
-
-      Object.defineProperty(process, "platform", {
-        value: "win32",
-      })
-    })
-
     beforeEach(() => {
       jest.resetModules()
       jest.mock("env-paths", () => {
@@ -82,34 +53,16 @@ describe.skip("getEnvPaths", () => {
       })
     })
 
-    afterAll(() => {
-      // Restore old platform
-
-      Object.defineProperty(process, "platform", {
-        value: ORIGINAL_PLATFORM,
-      })
-    })
-
     it("should return the env paths using envPaths", () => {
       const getEnvPaths = require("../../../src/node/util").getEnvPaths
-      const envPaths = getEnvPaths()
+      const envPaths = getEnvPaths("win32")
 
       expect(envPaths.data).toEqual("/windows/envPath/.local/share")
       expect(envPaths.config).toEqual("/windows/envPath/.config")
       expect(envPaths.runtime).toEqual("/tmp/envPath/runtime")
     })
   })
   describe("on other platforms", () => {
-    let ORIGINAL_PLATFORM = ""
-
-    beforeAll(() => {
-      ORIGINAL_PLATFORM = process.platform
-
-      Object.defineProperty(process, "platform", {
-        value: "linux",
-      })
-    })
-
     beforeEach(() => {
       jest.resetModules()
       jest.mock("env-paths", () => {
@@ -121,20 +74,12 @@ describe.skip("getEnvPaths", () => {
       })
     })
 
-    afterAll(() => {
-      // Restore old platform
-
-      Object.defineProperty(process, "platform", {
-        value: ORIGINAL_PLATFORM,
-      })
-    })
-
     it("should return the runtime using xdgBasedir if it exists", () => {
       jest.mock("xdg-basedir", () => ({
         runtime: "/tmp/runtime",
       }))
       const getEnvPaths = require("../../../src/node/util").getEnvPaths
-      const envPaths = getEnvPaths()
+      const envPaths = getEnvPaths("linux")
 
       expect(envPaths.data).toEqual("/linux/envPath/.local/share")
       expect(envPaths.config).toEqual("/linux/envPath/.config")
@@ -144,7 +89,7 @@ describe.skip("getEnvPaths", () => {
     it("should return the env paths using envPaths when xdgBasedir is undefined", () => {
       jest.mock("xdg-basedir", () => ({}))
       const getEnvPaths = require("../../../src/node/util").getEnvPaths
-      const envPaths = getEnvPaths()
+      const envPaths = getEnvPaths("linux")
 
       expect(envPaths.data).toEqual("/linux/envPath/.local/share")
       expect(envPaths.config).toEqual("/linux/envPath/.config")
@@ -192,10 +137,9 @@ describe("isHashMatch", () => {
     const actual = await util.isHashMatch(password, _hash)
     expect(actual).toBe(false)
   })
-  it("should return false and not throw an error if the hash doesn't start with a $", async () => {
+  it("should return false if the hash doesn't start with a $", async () => {
     const password = "hellowpasssword"
     const _hash = "n2i$v=19$m=4096,t=3,p=1$EAoczTxVki21JDfIZpTUxg$rkXgyrW4RDGoDYrxBFD4H2DlSMEhP4h+Api1hXnGnFY"
-    expect(async () => await util.isHashMatch(password, _hash)).not.toThrow()
     expect(await util.isHashMatch(password, _hash)).toBe(false)
   })
   it("should return false if the password and hash don't match", async () => {