feat: add test for catching errors in Emitter
This commit is contained in:
parent
e0acb08d94
commit
325a1d8181
|
@ -1,52 +1,85 @@
|
||||||
|
// 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 { Emitter } from "../src/common/emitter"
|
import { Emitter } from "../src/common/emitter"
|
||||||
|
|
||||||
describe("emitter", () => {
|
describe("Emitter", () => {
|
||||||
describe("Emitter", () => {
|
let spy: jest.SpyInstance
|
||||||
it("should return an Emitter", async () => {
|
|
||||||
const HELLO_WORLD = "HELLO_WORLD"
|
|
||||||
const GOODBYE_WORLD = "GOODBYE_WORLD"
|
|
||||||
const mockCallback = jest.fn(() => "Mock function called")
|
|
||||||
const mockSecondCallback = jest.fn(() => undefined)
|
|
||||||
|
|
||||||
const emitter = new Emitter<{ event: string; callback: () => void }>()
|
beforeEach(() => {
|
||||||
|
spy = jest.spyOn(logger, "error")
|
||||||
|
})
|
||||||
|
|
||||||
const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => {
|
afterEach(() => {
|
||||||
if (event === HELLO_WORLD) {
|
jest.clearAllMocks()
|
||||||
callback()
|
})
|
||||||
}
|
|
||||||
|
afterAll(() => {
|
||||||
|
jest.restoreAllMocks()
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should run the correct callbacks", async () => {
|
||||||
|
const HELLO_WORLD = "HELLO_WORLD"
|
||||||
|
const GOODBYE_WORLD = "GOODBYE_WORLD"
|
||||||
|
const mockCallback = jest.fn(() => "Mock function called")
|
||||||
|
const mockSecondCallback = jest.fn(() => undefined)
|
||||||
|
|
||||||
|
const emitter = new Emitter<{ event: string; callback: () => void }>()
|
||||||
|
|
||||||
|
const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => {
|
||||||
|
if (event === HELLO_WORLD) {
|
||||||
|
callback()
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const onGoodbyeWorld = ({ event, callback }: { event: string; callback: () => void }): void => {
|
const onGoodbyeWorld = ({ event, callback }: { event: string; callback: () => void }): void => {
|
||||||
if (event === GOODBYE_WORLD) {
|
if (event === GOODBYE_WORLD) {
|
||||||
callback()
|
callback()
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Register the onHelloWorld listener
|
// Register the onHelloWorld listener
|
||||||
// and the onGoodbyeWorld
|
// and the onGoodbyeWorld
|
||||||
emitter.event(onHelloWorld)
|
emitter.event(onHelloWorld)
|
||||||
emitter.event(onGoodbyeWorld)
|
emitter.event(onGoodbyeWorld)
|
||||||
|
|
||||||
await emitter.emit({ event: HELLO_WORLD, callback: mockCallback })
|
await emitter.emit({ event: HELLO_WORLD, callback: mockCallback })
|
||||||
|
|
||||||
// Double-check that our callback is called only once
|
// Double-check that our callback is called only once
|
||||||
expect(mockCallback).toHaveBeenCalled()
|
expect(mockCallback).toHaveBeenCalled()
|
||||||
expect(mockCallback).toHaveBeenCalledTimes(1)
|
expect(mockCallback).toHaveBeenCalledTimes(1)
|
||||||
|
|
||||||
await emitter.emit({ event: GOODBYE_WORLD, callback: mockSecondCallback })
|
await emitter.emit({ event: GOODBYE_WORLD, callback: mockSecondCallback })
|
||||||
|
|
||||||
// Check that it works with multiple listeners
|
// Check that it works with multiple listeners
|
||||||
expect(mockSecondCallback).toHaveBeenCalled()
|
expect(mockSecondCallback).toHaveBeenCalled()
|
||||||
expect(mockSecondCallback).toHaveBeenCalledTimes(1)
|
expect(mockSecondCallback).toHaveBeenCalledTimes(1)
|
||||||
|
|
||||||
// Dispose of all the listeners
|
// Dispose of all the listeners
|
||||||
emitter.dispose()
|
emitter.dispose()
|
||||||
})
|
})
|
||||||
|
|
||||||
it.skip("should log an error if something goes wrong", () => {
|
it("should log an error if something goes wrong", async () => {
|
||||||
// not sure how we're going to test this
|
const HELLO_WORLD = "HELLO_WORLD"
|
||||||
// need to mock logger
|
const mockCallback = jest.fn(() => "Mock function called")
|
||||||
// and then somehow throw or something in the callback
|
const message = "You don't have access to that folder."
|
||||||
})
|
|
||||||
|
const emitter = new Emitter<{ event: string; callback: () => void }>()
|
||||||
|
|
||||||
|
const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => {
|
||||||
|
if (event === HELLO_WORLD) {
|
||||||
|
callback()
|
||||||
|
throw new Error(message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
emitter.event(onHelloWorld)
|
||||||
|
|
||||||
|
await emitter.emit({ event: HELLO_WORLD, callback: mockCallback })
|
||||||
|
|
||||||
|
// Check that error was called
|
||||||
|
expect(spy).toHaveBeenCalled()
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(spy).toHaveBeenCalledWith(message)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
Loading…
Reference in New Issue