Skip to content

feat(config): add new eventWrapper config for wrapping fireEvent #600

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 1 commit into from
Jun 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions src/__tests__/event-wrapper.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import {configure, fireEvent} from '..'

let originalConfig

beforeEach(() => {
configure(oldConfig => {
originalConfig = oldConfig
return null
})
})

afterEach(() => {
jest.clearAllMocks()
configure(originalConfig)
})

test('fireEvent calls the eventWrapper', () => {
const mockEventWrapper = jest.fn()
configure(() => {
return {eventWrapper: mockEventWrapper}
})
const el = document.createElement('div')
fireEvent.click(el)
expect(mockEventWrapper).toHaveBeenCalledWith(expect.any(Function))
expect(mockEventWrapper).toHaveBeenCalledTimes(1)
})

test('fireEvent has a default eventWrapper', () => {
const el = document.createElement('div')
expect(() => fireEvent.click(el)).not.toThrow()
})
1 change: 1 addition & 0 deletions src/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ let config = {
// react-testing-library to use. For that reason, this feature will remain
// undocumented.
asyncWrapper: cb => cb(),
eventWrapper: cb => cb(),
// default value for the `hidden` option in `ByRole` queries
defaultHidden: false,
// showOriginalStackTrace flag to show the full error stack traces for async errors
Expand Down
27 changes: 16 additions & 11 deletions src/events.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
import {getConfig} from './config'
import {getWindowFromNode} from './helpers'
import {eventMap, eventAliasMap} from './event-map'

function fireEvent(element, event) {
if (!event) {
throw new Error(`Unable to fire an event - please provide an event object.`)
}
if (!element) {
throw new Error(
`Unable to fire a "${event.type}" event - please provide a DOM element.`,
)
}
return element.dispatchEvent(event)
return getConfig().eventWrapper(() => {
if (!event) {
throw new Error(
`Unable to fire an event - please provide an event object.`,
)
}
if (!element) {
throw new Error(
`Unable to fire a "${event.type}" event - please provide a DOM element.`,
)
}
return element.dispatchEvent(event)
})
}

const createEvent = {}
Expand Down Expand Up @@ -64,11 +69,11 @@ Object.keys(eventMap).forEach(key => {
/* istanbul ignore if */
if (typeof window.DataTransfer === 'function') {
Object.defineProperty(event, 'dataTransfer', {
value: Object.assign(new window.DataTransfer(), dataTransfer)
value: Object.assign(new window.DataTransfer(), dataTransfer),
})
} else {
Object.defineProperty(event, 'dataTransfer', {
value: dataTransfer
value: dataTransfer,
})
}
}
Expand Down
1 change: 1 addition & 0 deletions types/config.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export interface Config {
testIdAttribute: string;
asyncWrapper(cb: (...args: any[]) => any): Promise<any>;
eventWrapper(cb: (...args: any[]) => any): void;
asyncUtilTimeout: number;
defaultHidden: boolean;
throwSuggestions: boolean;
Expand Down