refactor: tmpdir and add to test utils

Author: jsjoeio

test/e2e/terminal.test.ts

@@ -1,10 +1,10 @@
 import { test, expect } from "@playwright/test"
 import * as fs from "fs"
-import { tmpdir } from "os"
+// import { tmpdir } from "os"
 import * as path from "path"
 import util from "util"
 import * as cp from "child_process"
-import { STORAGE } from "../utils/constants"
+import { STORAGE, tmpdir } from "../utils/constants"
 import { CodeServer } from "./models/CodeServer"
 
 test.describe("Integrated Terminal", () => {
@@ -33,7 +33,7 @@ test.describe("Integrated Terminal", () => {
     // We're not using tmpdir from src/node/constants
     // because Playwright doesn't fully support ES modules from
     // the erorrs I'm seeing
-    tmpFolderPath = fs.mkdtempSync(path.join(tmpdir(), "code-server-test"))
+    tmpFolderPath = await tmpdir("integrated-terminal")
     tmpFile = path.join(tmpFolderPath, testFileName)
   })
 

test/unit/constants.test.ts

@@ -1,4 +1,6 @@
+import * as fs from "fs"
 import { commit, getPackageJson, version } from "../../src/node/constants"
+import { tmpdir } from "../../test/utils/constants"
 import { loggerModule } from "../utils/helpers"
 
 // jest.mock is hoisted above the imports so we must use `require` here.
@@ -51,3 +53,16 @@ describe("constants", () => {
     })
   })
 })
+
+describe("test constants", () => {
+  describe("tmpdir", () => {
+    it("should return a temp directory", async () => {
+      const testName = "temp-dir"
+      const pathToTempDir = await tmpdir(testName)
+
+      expect(pathToTempDir).toContain(testName)
+
+      await fs.rmdir(pathToTempDir, () => {})
+    })
+  })
+})

test/utils/constants.ts

@@ -1,3 +1,14 @@
+import * as os from "os"
+import * as path from "path"
+import * as fs from "fs"
+
 export const CODE_SERVER_ADDRESS = process.env.CODE_SERVER_ADDRESS || "http://localhost:8080"
 export const PASSWORD = process.env.PASSWORD || "e45432jklfdsab"
 export const STORAGE = process.env.STORAGE || ""
+
+export async function tmpdir(testName: string): Promise<string> {
+  const dir = path.join(os.tmpdir(), "code-server")
+  await fs.mkdir(dir, { recursive: true }, () => {})
+
+  return await fs.promises.mkdtemp(path.join(dir, `test-${testName}-`), { encoding: "utf8" })
+}