Skip to content

Commit 9768517

Browse files
sheremet-vasheremet-va
authored
fix(browser): make sure userEvent actions support ensureAwaited (#9732)
1 parent 149d98f commit 9768517

4 files changed

Lines changed: 42 additions & 14 deletions

File tree

‎packages/browser/src/client/tester/context.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ export function createUserEvent(__tl_user_event_base__?: TestingLibraryUserEvent
5151
setup() {
5252
return createUserEvent()
5353
},
54-
async cleanup() {
54+
cleanup() {
5555
// avoid cleanup rpc call if there is nothing to cleanup
5656
if (!keyboard.unreleased.length) {
57-
return
57+
return Promise.resolve()
5858
}
5959
return ensureAwaited(async (error) => {
6060
await triggerCommand('__vitest_cleanup', [keyboard], error)
@@ -100,7 +100,7 @@ export function createUserEvent(__tl_user_event_base__?: TestingLibraryUserEvent
100100
},
101101

102102
// testing-library user-event
103-
async type(element, text, options) {
103+
type(element, text, options) {
104104
return ensureAwaited(async (error) => {
105105
const selector = await convertToSelector(element, options)
106106
const { unreleased } = await triggerCommand<{ unreleased: string[] }>(
@@ -118,7 +118,7 @@ export function createUserEvent(__tl_user_event_base__?: TestingLibraryUserEvent
118118
tab(options = {}) {
119119
return ensureAwaited(error => triggerCommand('__vitest_tab', [options], error))
120120
},
121-
async keyboard(text) {
121+
keyboard(text) {
122122
return ensureAwaited(async (error) => {
123123
const { unreleased } = await triggerCommand<{ unreleased: string[] }>(
124124
'__vitest_keyboard',
@@ -128,14 +128,14 @@ export function createUserEvent(__tl_user_event_base__?: TestingLibraryUserEvent
128128
keyboard.unreleased = unreleased
129129
})
130130
},
131-
async copy() {
132-
await userEvent.keyboard(`{${modifier}>}{c}{/${modifier}}`)
131+
copy() {
132+
return userEvent.keyboard(`{${modifier}>}{c}{/${modifier}}`)
133133
},
134-
async cut() {
135-
await userEvent.keyboard(`{${modifier}>}{x}{/${modifier}}`)
134+
cut() {
135+
return userEvent.keyboard(`{${modifier}>}{x}{/${modifier}}`)
136136
},
137-
async paste() {
138-
await userEvent.keyboard(`{${modifier}>}{v}{/${modifier}}`)
137+
paste() {
138+
return userEvent.keyboard(`{${modifier}>}{v}{/${modifier}}`)
139139
},
140140
}
141141
return userEvent

‎packages/browser/src/client/tester/locators/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export abstract class Locator {
135135
return this.triggerCommand<void>('__vitest_fill', this.selector, text, options)
136136
}
137137

138-
public async upload(files: string | string[] | File | File[], options?: UserEventUploadOptions): Promise<void> {
138+
public upload(files: string | string[] | File | File[], options?: UserEventUploadOptions): Promise<void> {
139139
return ensureAwaited(async (error) => {
140140
const filesPromise = (Array.isArray(files) ? files : [files]).map(async (file) => {
141141
if (typeof file === 'string') {

‎test/browser/fixtures/failing/failing.test.ts‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { page } from 'vitest/browser'
1+
import { page, userEvent } from 'vitest/browser'
22
import { index } from '@vitest/bundled-lib'
33
import { expect, it } from 'vitest'
44
import { throwError } from './src/error'
@@ -19,6 +19,20 @@ it('several locator methods are not awaited', () => {
1919
page.getByRole('button').dblClick()
2020
page.getByRole('button').click()
2121
page.getByRole('button').tripleClick()
22+
userEvent.type(page.getByRole('textbox'), '123')
23+
userEvent.keyboard('123')
24+
userEvent.copy()
25+
userEvent.cut()
26+
userEvent.paste()
27+
userEvent.tab()
28+
userEvent.dragAndDrop(page.getByRole('button'), page.getByRole('button'))
29+
userEvent.fill(page.getByRole('textbox'), '123')
30+
userEvent.upload(page.getByRole('textbox'), './file.js')
31+
userEvent.unhover(page.getByRole('button'))
32+
userEvent.hover(page.getByRole('button'))
33+
userEvent.clear(page.getByRole('button'))
34+
userEvent.selectOptions(page.getByRole('button'), '123')
35+
userEvent.wheel(page.getByRole('button'), { direction: 'down' })
2236
})
2337

2438
it('correctly prints error from a bundled file', () => {

‎test/browser/specs/runner.test.ts‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ error with a stack
208208
})
209209

210210
test(`stack trace points to correct file in every browser when failed`, async () => {
211-
expect.assertions(15)
211+
expect.assertions(29)
212212
const { stderr } = await runBrowserTests({
213213
root: './fixtures/failing',
214214
reporters: [
@@ -252,12 +252,26 @@ test(`stack trace points to correct file in every browser when failed`, async ()
252252
expect(stderr).toMatch(/failing.test.ts:19:(27|36)/)
253253
expect(stderr).toMatch(/failing.test.ts:20:(27|33)/)
254254
expect(stderr).toMatch(/failing.test.ts:21:(27|39)/)
255+
expect(stderr).toMatch(/failing.test.ts:22:(12|17)/)
256+
expect(stderr).toMatch(/failing.test.ts:23:(12|21)/)
257+
expect(stderr).toMatch(/failing.test.ts:24:(12|17)/)
258+
expect(stderr).toMatch(/failing.test.ts:25:(12|16)/)
259+
expect(stderr).toMatch(/failing.test.ts:26:(12|18)/)
260+
expect(stderr).toMatch(/failing.test.ts:27:(12|16)/)
261+
expect(stderr).toMatch(/failing.test.ts:28:(12|24)/)
262+
expect(stderr).toMatch(/failing.test.ts:29:(12|17)/)
263+
expect(stderr).toMatch(/failing.test.ts:30:(12|19)/)
264+
expect(stderr).toMatch(/failing.test.ts:31:(12|20)/)
265+
expect(stderr).toMatch(/failing.test.ts:32:(12|18)/)
266+
expect(stderr).toMatch(/failing.test.ts:33:(12|18)/)
267+
expect(stderr).toMatch(/failing.test.ts:34:(12|26)/)
268+
expect(stderr).toMatch(/failing.test.ts:35:(12|18)/)
255269

256270
expect(stderr).toMatch(/bundled-lib\/src\/b.js:2:(9|19)/)
257271
expect(stderr).toMatch(/bundled-lib\/src\/index.js:5:(16|18)/)
258272

259273
// index() is called from a bundled file
260-
expect(stderr).toMatch(/failing.test.ts:25:(2|8)/)
274+
expect(stderr).toMatch(/failing.test.ts:39:(2|8)/)
261275
})
262276

263277
test('user-event', async () => {

0 commit comments

Comments
 (0)