Skip to content

Commit 0797612

Browse files
authored
test: flush ignoreTaps debouncer after scroll (#8963)
1 parent 7e79d77 commit 0797612

16 files changed

Lines changed: 189 additions & 191 deletions

‎packages/date-picker/test/basic.test.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { click, fixtureSync, keyboardEventFor, nextRender, oneEvent, tap } from
44
import sinon from 'sinon';
55
import '../src/vaadin-date-picker.js';
66
import { parseDate } from '../src/vaadin-date-picker-helper.js';
7-
import { open, touchTap, waitForOverlayRender } from './helpers.js';
7+
import { open, touchTap, untilOverlayRendered } from './helpers.js';
88

99
describe('basic features', () => {
1010
let datePicker, input, overlay;
@@ -44,14 +44,14 @@ describe('basic features', () => {
4444
it('should keep focused attribute when focus moves to overlay', async () => {
4545
datePicker.focus();
4646
await sendKeys({ press: 'ArrowDown' });
47-
await waitForOverlayRender();
47+
await untilOverlayRendered(datePicker);
4848
expect(datePicker.hasAttribute('focused')).to.be.true;
4949
});
5050

5151
it('should have focused attribute when closed and focused', async () => {
5252
datePicker.focus();
5353
await sendKeys({ press: 'ArrowDown' });
54-
await waitForOverlayRender();
54+
await untilOverlayRendered(datePicker);
5555
await sendKeys({ press: 'Escape' });
5656
expect(datePicker.hasAttribute('focused')).to.be.true;
5757
});
@@ -470,7 +470,7 @@ describe('required', () => {
470470

471471
it('should focus on required indicator click', async () => {
472472
datePicker.shadowRoot.querySelector('[part="required-indicator"]').click();
473-
await waitForOverlayRender();
473+
await untilOverlayRendered(datePicker);
474474
expect(datePicker.hasAttribute('focused')).to.be.true;
475475
});
476476
});

‎packages/date-picker/test/custom-input.test.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { fire, fixtureSync, oneEvent, tap } from '@vaadin/testing-helpers';
33
import sinon from 'sinon';
44
import './not-animated-styles.js';
55
import '../vaadin-date-picker-light.js';
6-
import { open, setInputValue, waitForScrollToFinish } from './helpers.js';
6+
import { open, setInputValue } from './helpers.js';
77

88
describe('custom input', () => {
99
let datePicker, overlay;
@@ -67,8 +67,7 @@ describe('custom input', () => {
6767
await open(datePicker);
6868
});
6969

70-
it('should propagate theme attribute to month calendar', async () => {
71-
await waitForScrollToFinish(datePicker);
70+
it('should propagate theme attribute to month calendar', () => {
7271
const monthCalendar = datePicker._overlayContent.querySelector('vaadin-month-calendar');
7372
expect(monthCalendar.getAttribute('theme')).to.equal('foo');
7473
});

‎packages/date-picker/test/dropdown.test.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { resetMouse, sendKeys, sendMouse } from '@vaadin/test-runner-commands';
33
import { aTimeout, fire, fixtureSync, mousedown, nextRender, oneEvent, touchstart } from '@vaadin/testing-helpers';
44
import sinon from 'sinon';
55
import '../src/vaadin-date-picker.js';
6-
import { getFocusableCell, monthsEqual, open, waitForOverlayRender } from './helpers.js';
6+
import { getFocusableCell, monthsEqual, open, untilOverlayRendered } from './helpers.js';
77

88
describe('dropdown', () => {
99
let datePicker, input, overlay;
@@ -94,7 +94,7 @@ describe('dropdown', () => {
9494

9595
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
9696
await oneEvent(overlay, 'vaadin-overlay-open');
97-
await waitForOverlayRender();
97+
await untilOverlayRendered(datePicker);
9898

9999
const scrolledDate = spy.firstCall.args[0];
100100
expect(monthsEqual(scrolledDate, new Date())).to.be.true;
@@ -107,7 +107,7 @@ describe('dropdown', () => {
107107

108108
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
109109
await oneEvent(overlay, 'vaadin-overlay-open');
110-
await waitForOverlayRender();
110+
await untilOverlayRendered(datePicker);
111111

112112
const scrolledDate = spy.firstCall.args[0];
113113
expect(scrolledDate).to.be.eql(new Date(2016, 0, 1));
@@ -120,7 +120,7 @@ describe('dropdown', () => {
120120

121121
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
122122
await oneEvent(overlay, 'vaadin-overlay-open');
123-
await waitForOverlayRender();
123+
await untilOverlayRendered(datePicker);
124124

125125
const scrolledDate = spy.firstCall.args[0];
126126
expect(monthsEqual(scrolledDate, new Date(2000, 1, 1))).to.be.true;
@@ -145,7 +145,7 @@ describe('dropdown', () => {
145145
// scrollTop can be reset while the dropdown is closed.
146146
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
147147
await oneEvent(overlay, 'vaadin-overlay-open');
148-
await waitForOverlayRender();
148+
await untilOverlayRendered(datePicker);
149149
expect(spy.called).to.be.true;
150150

151151
datePicker.close();
@@ -163,7 +163,7 @@ describe('dropdown', () => {
163163

164164
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
165165
await oneEvent(overlay, 'vaadin-overlay-open');
166-
await waitForOverlayRender();
166+
await untilOverlayRendered(datePicker);
167167

168168
const scrolledDate = spy.firstCall.args[0];
169169
expect(scrolledDate).to.be.eql(new Date(2100, 0, 1));
@@ -176,7 +176,7 @@ describe('dropdown', () => {
176176

177177
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
178178
await oneEvent(overlay, 'vaadin-overlay-open');
179-
await waitForOverlayRender();
179+
await untilOverlayRendered(datePicker);
180180

181181
const scrolledDate = spy.firstCall.args[0];
182182
expect(scrolledDate).to.be.eql(new Date(2000, 0, 1));
@@ -192,7 +192,7 @@ describe('dropdown', () => {
192192

193193
const spy = sinon.spy(datePicker._overlayContent, 'scrollToDate');
194194
await oneEvent(overlay, 'vaadin-overlay-open');
195-
await waitForOverlayRender();
195+
await untilOverlayRendered(datePicker);
196196

197197
const scrolledDate = spy.firstCall.args[0];
198198
expect(scrolledDate).to.be.eql(new Date(2015, 0, 1));

‎packages/date-picker/test/events.test.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
44
import sinon from 'sinon';
55
import './not-animated-styles.js';
66
import '../src/vaadin-date-picker.js';
7-
import { open, waitForScrollToFinish } from './helpers.js';
7+
import { open, untilOverlayScrolled } from './helpers.js';
88

99
describe('events', () => {
1010
let datePicker;
@@ -29,7 +29,7 @@ describe('events', () => {
2929

3030
it('should not be fired on programmatic value change when having user input', async () => {
3131
await sendKeys({ type: '1/2/2000' });
32-
await waitForScrollToFinish(datePicker);
32+
await untilOverlayScrolled(datePicker);
3333
datePicker.value = '2000-01-01';
3434
datePicker.close();
3535
expect(changeSpy.called).to.be.false;

‎packages/date-picker/test/fullscreen.test.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { aTimeout, fixtureSync, nextRender, outsideClick, tabKeyDown, tap } from
44
import sinon from 'sinon';
55
import './not-animated-styles.js';
66
import '../src/vaadin-date-picker.js';
7-
import { getFocusableCell, open, touchTap, waitForOverlayRender } from './helpers.js';
7+
import { getFocusableCell, open, touchTap, untilOverlayRendered } from './helpers.js';
88

99
describe('fullscreen mode', () => {
1010
let datePicker, input, overlay, width, height;
@@ -43,13 +43,13 @@ describe('fullscreen mode', () => {
4343
describe('default', () => {
4444
it('should open overlay on input tap', async () => {
4545
tap(input);
46-
await waitForOverlayRender();
46+
await untilOverlayRendered(datePicker);
4747
expect(datePicker.opened).to.be.true;
4848
});
4949

5050
it('should not focus the input on touch tap', async () => {
5151
touchTap(input);
52-
await waitForOverlayRender();
52+
await untilOverlayRendered(datePicker);
5353
expect(document.activeElement).to.not.equal(input);
5454
});
5555

‎packages/date-picker/test/helpers.js‎

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,48 @@ export function getDefaultI18n() {
4444
};
4545
}
4646

47-
export async function waitForOverlayRender() {
47+
/**
48+
* Waits until the overlay content finishes scrolling.
49+
*
50+
* @param {HTMLElement} datePickerOrOverlayContent vaadin-date-picker or vaadin-date-picker-overlay-content
51+
* @return {Promise<void>}
52+
*/
53+
export async function untilOverlayScrolled(datePickerOrOverlayContent) {
54+
const overlayContent = datePickerOrOverlayContent._overlayContent ?? datePickerOrOverlayContent;
55+
56+
if (overlayContent._revealPromise) {
57+
// The overlay content is scrolling.
58+
await overlayContent._revealPromise;
59+
}
60+
61+
await nextRender(overlayContent);
62+
63+
// Flush the ignoreTaps debouncer to make sure taps are not ignored.
64+
overlayContent._debouncer?.flush();
65+
}
66+
67+
/**
68+
* Waits until the overlay is rendered.
69+
*
70+
* @param {HTMLElement} datePicker vaadin-date-picker
71+
* @return {Promise<void>}
72+
*/
73+
export async function untilOverlayRendered(datePicker) {
4874
// First, wait for vaadin-overlay-open event
49-
await nextRender();
75+
await nextRender(datePicker);
5076

5177
// Then wait for scrollers to fully render
52-
await nextRender();
78+
await nextRender(datePicker);
5379

5480
// Force dom-repeat to render table elements
5581
flush();
82+
83+
await untilOverlayScrolled(datePicker);
5684
}
5785

5886
export async function open(datePicker) {
5987
datePicker.open();
60-
await waitForOverlayRender();
88+
await untilOverlayRendered(datePicker);
6189
}
6290

6391
export function idleCallback() {
@@ -126,22 +154,6 @@ export function getFocusedCell(root) {
126154
}
127155
}
128156

129-
/**
130-
* Waits for the scroll to finish in the date-picker overlay content.
131-
*
132-
* @param {HTMLElement} root vaadin-date-picker or vaadin-date-picker-overlay-content
133-
*/
134-
export async function waitForScrollToFinish(root) {
135-
const overlayContent = root._overlayContent ?? root;
136-
137-
if (overlayContent._revealPromise) {
138-
// The overlay content is scrolling.
139-
await overlayContent._revealPromise;
140-
}
141-
142-
await nextRender(overlayContent);
143-
}
144-
145157
/**
146158
* Emulates the user filling in something in the date-picker input.
147159
*

0 commit comments

Comments
 (0)