refactor: move loggerModule into helpers

Author: jsjoeio

test/constants.test.ts

@@ -1,14 +1,16 @@
 // Note: we need to import logger from the root
 // because this is the logger used in logError in ../src/common/util
-import { logger } from "../node_modules/@coder/logger"
+// import { logger } from "../node_modules/@coder/logger"
 import { commit, getPackageJson, version } from "../src/node/constants"
+import { loggerModule } from "./helpers"
 
 describe("constants", () => {
   describe("getPackageJson", () => {
-    let spy: jest.SpyInstance
+    // let spy: jest.SpyInstance
 
     beforeEach(() => {
-      spy = jest.spyOn(logger, "warn")
+      // spy = jest.spyOn(logger, "warn")
+      jest.mock("@coder/logger", () => loggerModule)
     })
 
     afterEach(() => {
@@ -24,8 +26,10 @@ describe("constants", () => {
 
       getPackageJson("./package.json")
 
-      expect(spy).toHaveBeenCalled()
-      expect(spy).toHaveBeenCalledWith(expectedErrorMessage)
+      // expect(spy).toHaveBeenCalled()
+      // expect(spy).toHaveBeenCalledWith(expectedErrorMessage)
+      expect(loggerModule.logger.warn).toHaveBeenCalled()
+      expect(loggerModule.logger.warn).toHaveBeenCalledWith(expectedErrorMessage)
     })
 
     it("should find the package.json", () => {

test/helpers.ts

@@ -0,0 +1,49 @@
+import { field, Level } from "@coder/logger"
+
+// Borrowed from playwright
+export interface Cookie {
+  name: string
+  value: string
+  domain: string
+  path: string
+  /**
+   * Unix time in seconds.
+   */
+  expires: number
+  httpOnly: boolean
+  secure: boolean
+  sameSite: "Strict" | "Lax" | "None"
+}
+
+/**
+ * Checks if a cookie exists in array of cookies
+ */
+export function checkForCookie(cookies: Array<Cookie>, key: string): boolean {
+  // Check for a cookie where the name is equal to key
+  return Boolean(cookies.find((cookie) => cookie.name === key))
+}
+
+/**
+ * Creates a login cookie if one doesn't already exist
+ */
+export function createCookieIfDoesntExist(cookies: Array<Cookie>, cookieToStore: Cookie): Array<Cookie> {
+  const cookieName = cookieToStore.name
+  const doesCookieExist = checkForCookie(cookies, cookieName)
+  if (!doesCookieExist) {
+    const updatedCookies = [...cookies, cookieToStore]
+    return updatedCookies
+  }
+  return cookies
+}
+
+export const loggerModule = {
+  field,
+  level: Level.Info,
+  logger: {
+    debug: jest.fn(),
+    error: jest.fn(),
+    info: jest.fn(),
+    trace: jest.fn(),
+    warn: jest.fn(),
+  },
+}

test/register.test.ts

@@ -1,5 +1,5 @@
-import { field, Level } from "@coder/logger"
 import { JSDOM } from "jsdom"
+import { loggerModule } from "./helpers"
 
 describe("register", () => {
   const { window } = new JSDOM()
@@ -9,17 +9,6 @@ describe("register", () => {
   global.location = window.location
 
   const mockRegisterFn = jest.fn()
-  const loggerModule = {
-    field,
-    level: Level.Info,
-    logger: {
-      debug: jest.fn(),
-      error: jest.fn(),
-      info: jest.fn(),
-      trace: jest.fn(),
-      warn: jest.fn(),
-    },
-  }
 
   beforeAll(() => {
     Object.defineProperty(global.navigator, "serviceWorker", {
@@ -63,5 +52,9 @@ describe("register", () => {
 
     expect(mockRegisterFn).toHaveBeenCalled()
     expect(loggerModule.logger.error).toHaveBeenCalled()
+    expect(loggerModule.logger.error).toHaveBeenCalledTimes(1)
+    expect(loggerModule.logger.error).toHaveBeenCalledWith(
+      `[Service Worker] registration: ${error.message} ${error.stack}`,
+    )
   })
 })