feat: add tests for common/util

Author: jsjoeio

test/util.test.ts

@@ -1,4 +1,7 @@
-import { normalize } from "../src/common/util"
+import { logger as l } from "@coder/logger"
+import { arrayify, getFirstString, normalize, plural, resolveBase, split, trimSlashes } from "../src/common/util"
+
+type LocationLike = Pick<Location, "pathname" | "origin">
 
 describe("util", () => {
   describe("normalize", () => {
@@ -15,4 +18,106 @@ describe("util", () => {
       expect(normalize("qux", true)).toBe("qux")
     })
   })
+
+  describe("split", () => {
+    it("should split at a comma", () => {
+      expect(split("Hello,world", ",")).toStrictEqual(["Hello", "world"])
+    })
+
+    it("shouldn't split if the delimiter doesn't exist", () => {
+      expect(split("Hello world", ",")).toStrictEqual(["Hello world", ""])
+    })
+  })
+
+  describe("plural", () => {
+    it("should add an s if count is greater than 1", () => {
+      expect(plural(2, "dog")).toBe("dogs")
+    })
+    it("should NOT add an s if the count is 1", () => {
+      expect(plural(1, "dog")).toBe("dog")
+    })
+  })
+
+  describe("trimSlashes", () => {
+    it("should remove leading slashes", () => {
+      expect(trimSlashes("/hello-world")).toBe("hello-world")
+    })
+
+    it("should remove trailing slashes", () => {
+      expect(trimSlashes("hello-world/")).toBe("hello-world")
+    })
+
+    it("should remove both leading and trailing slashes", () => {
+      expect(trimSlashes("/hello-world/")).toBe("hello-world")
+    })
+
+    it("should remove multiple leading and trailing slashes", () => {
+      expect(trimSlashes("///hello-world////")).toBe("hello-world")
+    })
+  })
+
+  describe("resolveBase", () => {
+    beforeEach(() => {
+      const location: LocationLike = {
+        pathname: "/healthz",
+        origin: "http://localhost:8080",
+      }
+
+      // Because resolveBase is not a pure function
+      // and relies on the global location to be set
+      // we set it before all the tests
+      // and tell TS that our location should be looked at
+      // as Location (even though it's missing some properties)
+      global.location = location as Location
+    })
+
+    it("should resolve a base", () => {
+      expect(resolveBase("localhost:8080")).toBe("/localhost:8080")
+    })
+
+    it("should resolve a base with a forward slash at the beginning", () => {
+      expect(resolveBase("/localhost:8080")).toBe("/localhost:8080")
+    })
+
+    it("should resolve a base with query params", () => {
+      expect(resolveBase("localhost:8080?folder=hello-world")).toBe("/localhost:8080")
+    })
+
+    it("should resolve a base with a path", () => {
+      expect(resolveBase("localhost:8080/hello/world")).toBe("/localhost:8080/hello/world")
+    })
+
+    it("should resolve a base to an empty string when not provided", () => {
+      expect(resolveBase()).toBe("")
+    })
+  })
+
+  describe("arrayify", () => {
+    it("should return value it's already an array", () => {
+      expect(arrayify(["hello", "world"])).toStrictEqual(["hello", "world"])
+    })
+    it("should wrap the value in an array if not an array", () => {
+      expect(
+        arrayify({
+          name: "Coder",
+          version: "3.8",
+        }),
+      ).toStrictEqual([{ name: "Coder", version: "3.8" }])
+    })
+    it("should return an empty array if the value is undefined", () => {
+      expect(arrayify(undefined)).toStrictEqual([])
+    })
+  })
+
+  describe("getFirstString", () => {
+    it("should return the string if passed a string", () => {
+      expect(getFirstString("Hello world!")).toBe("Hello world!")
+    })
+    it("should get the first string from an array", () => {
+      expect(getFirstString(["Hello", "World"])).toBe("Hello")
+    })
+    it("should return undefined if the value isn't an array or a string", () => {
+      expect(getFirstString({ name: "Coder" })).toBe(undefined)
+    })
+  })
 })