Update tests to reflect new upstream behavior.

Author: GirlBossRush

src/common/util.ts

@@ -50,35 +50,6 @@ export const resolveBase = (base?: string): string => {
   return normalize(url.pathname)
 }
 
-/**
- * Get client-side configuration embedded in the HTML or query params.
- */
-export const getClientConfiguration = <T extends CodeServerLib.ClientConfiguration>(): T => {
-  let config: T
-  try {
-    config = JSON.parse(document.getElementById("coder-options")!.getAttribute("data-settings")!)
-  } catch (error) {
-    config = {} as T
-  }
-
-  // You can also pass options in stringified form to the options query
-  // variable. Options provided here will override the ones in the options
-  // element.
-  const params = new URLSearchParams(location.search)
-  const queryOpts = params.get("options")
-  if (queryOpts) {
-    config = {
-      ...config,
-      ...JSON.parse(queryOpts),
-    }
-  }
-
-  config.base = resolveBase(config.base)
-  config.csStaticBase = resolveBase(config.csStaticBase)
-
-  return config
-}
-
 /**
  * Wrap the value in an array if it's not already an array. If the value is
  * undefined return an empty array.

src/node/http.ts

@@ -10,6 +10,15 @@ import { version as codeServerVersion } from "./constants"
 import { Heart } from "./heart"
 import { getPasswordMethod, IsCookieValidArgs, isCookieValid, sanitizeString, escapeHtml, escapeJSON } from "./util"
 
+/**
+ * Base options included on every page.
+ */
+export interface ClientConfiguration {
+  codeServerVersion: string
+  base: string
+  csStaticBase: string
+}
+
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Express {
@@ -20,7 +29,7 @@ declare global {
   }
 }
 
-export const createClientConfiguration = (req: express.Request): CodeServerLib.ClientConfiguration => {
+export const createClientConfiguration = (req: express.Request): ClientConfiguration => {
   const base = relativeRoot(req)
 
   return {
@@ -38,7 +47,7 @@ export const replaceTemplates = <T extends object>(
   content: string,
   extraOpts?: Omit<T, "base" | "csStaticBase" | "logLevel">,
 ): string => {
-  const serverOptions: CodeServerLib.ClientConfiguration = {
+  const serverOptions: ClientConfiguration = {
     ...createClientConfiguration(req),
     ...extraOpts,
   }

test/unit/common/util.test.ts

@@ -110,71 +110,6 @@ describe("util", () => {
     })
   })
 
-  describe("getOptions", () => {
-    beforeEach(() => {
-      const location: LocationLike = {
-        pathname: "/healthz",
-        origin: "http://localhost:8080",
-        // search: "?environmentId=600e0187-0909d8a00cb0a394720d4dce",
-      }
-
-      // 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
-    })
-
-    afterEach(() => {
-      jest.restoreAllMocks()
-    })
-
-    it("should return options with base and cssStaticBase even if it doesn't exist", () => {
-      expect(util.getClientConfiguration()).toStrictEqual({
-        base: "",
-        csStaticBase: "",
-      })
-    })
-
-    it("should return options when they do exist", () => {
-      // Mock getElementById
-      const spy = jest.spyOn(document, "getElementById")
-      // Create a fake element and set the attribute
-      const mockElement = document.createElement("div")
-      mockElement.setAttribute(
-        "data-settings",
-        '{"base":".","csStaticBase":"./static/development/Users/jp/Dev/code-server","logLevel":2,"disableUpdateCheck":false}',
-      )
-      // Return mockElement from the spy
-      // this way, when we call "getElementById"
-      // it returns the element
-      spy.mockImplementation(() => mockElement)
-
-      expect(util.getClientConfiguration()).toStrictEqual({
-        base: "",
-        csStaticBase: "/static/development/Users/jp/Dev/code-server",
-        disableUpdateCheck: false,
-        logLevel: 2,
-      })
-    })
-
-    it("should include queryOpts", () => {
-      // Trying to understand how the implementation works
-      // 1. It grabs the search params from location.search (i.e. ?)
-      // 2. it then grabs the "options" param if it exists
-      // 3. then it creates a new options object
-      // spreads the original options
-      // then parses the queryOpts
-      location.search = '?options={"logLevel":2}'
-      expect(util.getClientConfiguration()).toStrictEqual({
-        base: "",
-        csStaticBase: "",
-        logLevel: 2,
-      })
-    })
-  })
-
   describe("arrayify", () => {
     it("should return value it's already an array", () => {
       expect(util.arrayify(["hello", "world"])).toStrictEqual(["hello", "world"])

test/unit/node/routes/static.test.ts

@@ -7,7 +7,7 @@ import * as integration from "../../../utils/integration"
 
 const NOT_FOUND = {
   code: 404,
-  message: "Not Found",
+  message: /not found/i,
 }
 
 describe("/_static", () => {
@@ -44,7 +44,7 @@ describe("/_static", () => {
       expect(resp.status).toBe(NOT_FOUND.code)
 
       const content = await resp.json()
-      expect(content.error).toContain(NOT_FOUND.message)
+      expect(content.error).toMatch(NOT_FOUND.message)
     })
   }