Skip to content

feat(testing): add unit tests for register #2719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Feb 26, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
4f1f2c7
fix: clean up comment in util.test.ts
jsjoeio Feb 11, 2021
28b440a
feat: add cssStub to jest
jsjoeio Feb 11, 2021
72b05ca
refactor: create registerServiceWorker fn
jsjoeio Feb 11, 2021
06aeca0
feat(testing): add register test
jsjoeio Feb 11, 2021
a9f88af
refactor: use logger in serviceworker
jsjoeio Feb 11, 2021
44b9874
feat: test failure to register service worker
jsjoeio Feb 11, 2021
21f577d
refactor: add handleRegisterServiceWorker fn
jsjoeio Feb 11, 2021
38891de
feat(test): add test handleRegisterServiceWorker
jsjoeio Feb 11, 2021
7ef630f
refactor(register): use logError instead of logger
jsjoeio Feb 22, 2021
a44a514
refactor: use same syntax as logger spy
jsjoeio Feb 22, 2021
027e8e5
refactor: use LogModule from Asher in tests
jsjoeio Feb 23, 2021
711abd8
refactor: move loggerModule into helpers
jsjoeio Feb 23, 2021
1470ff2
refactor: dont use actual logger in helper
jsjoeio Feb 23, 2021
1c737f1
refactor: hoist jest.mock in constants
jsjoeio Feb 23, 2021
cb4185b
refactor: use loggerModule in util
jsjoeio Feb 23, 2021
e6a324b
refactor: update mocking logger in register test
jsjoeio Feb 23, 2021
b232dcb
feat(register): add test when navigator undefined
jsjoeio Feb 23, 2021
80a1800
feat: add test for catching errors in Emitter
jsjoeio Feb 10, 2021
46226ea
chore(testing): add service-worker-mock
jsjoeio Feb 18, 2021
ee0973c
feat: add logs to serviceWorker
jsjoeio Feb 18, 2021
6b56e65
feat(testing): add serviceWorker tests
jsjoeio Feb 18, 2021
8c14799
refactor: add custom mock for serviceWorker test
jsjoeio Feb 24, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: use LogModule from Asher in tests
  • Loading branch information
jsjoeio committed Feb 26, 2021
commit 027e8e5adfa973b1986df50b8aaef07b0b45b99d
3 changes: 0 additions & 3 deletions src/common/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,9 @@ export const getFirstString = (value: string | string[] | object | undefined): s
}

export function logError(prefix: string, err: any): void {
console.log("hey joe log error was called")
if (err instanceof Error) {
console.log("it was an instance of error")
logger.error(`${prefix}: ${err.message} ${err.stack}`)
} else {
console.log("not an isntance errro")
logger.error(`${prefix}: ${err}`)
}
}
37 changes: 19 additions & 18 deletions test/register.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { field, Level } from "@coder/logger"
import { JSDOM } from "jsdom"
// 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"

describe("register", () => {
const { window } = new JSDOM()
Expand All @@ -10,9 +8,18 @@ describe("register", () => {
global.navigator = window.navigator
global.location = window.location

let spy: jest.SpyInstance
let loggerSpy: jest.SpyInstance
const mockRegisterFn = jest.fn(() => console.log("Mock register fn called"))
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", {
Expand All @@ -23,10 +30,11 @@ describe("register", () => {
})

beforeEach(() => {
spy = jest.spyOn(global.navigator.serviceWorker, "register")
jest.mock("@coder/logger", () => loggerModule)
})

afterEach(() => {
mockRegisterFn.mockClear()
jest.resetModules()
})

Expand All @@ -35,18 +43,14 @@ describe("register", () => {
})

it("should register a ServiceWorker", () => {
spy = jest.spyOn(global.navigator.serviceWorker, "register")
// Load service worker like you would in the browser
require("../src/browser/register")
// Load service worker like you would in the browser
// expect spy to have been called
expect(spy).toHaveBeenCalled()
expect(spy).toHaveBeenCalledTimes(1)
spy.mockClear()
expect(mockRegisterFn).toHaveBeenCalled()
expect(mockRegisterFn).toHaveBeenCalledTimes(1)
})

it("should log an error if something doesn't work", () => {
loggerSpy = jest.spyOn(logger, "error")
const message = "Can't find browser"
const error = new Error(message)

Expand All @@ -57,10 +61,7 @@ describe("register", () => {
// Load service worker like you would in the browser
require("../src/browser/register")

expect(spy).toHaveBeenCalled()
expect(loggerSpy).toHaveBeenCalled()
// expect(loggerSpy).toHaveBeenCalledTimes(1)
// Because we use logError, it will log the prefix along with the error message
// expect(loggerSpy).toHaveBeenCalledWith(`[Service Worker] registration: ${error.message} ${error.stack}`)
expect(mockRegisterFn).toHaveBeenCalled()
expect(loggerModule.logger.error).toHaveBeenCalled()
})
})