-
Notifications
You must be signed in to change notification settings - Fork 13.3k
fix(refresher): validate slot after frameworks assign it #31377
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
+106
−2
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
core/src/components/refresher/test/slot-validation/refresher.e2e.ts
|
brandyscarney marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| import { expect } from '@playwright/test'; | ||
| import type { Page } from '@playwright/test'; | ||
| import { configs, dragElementByYAxis, test } from '@utils/test/playwright'; | ||
|
|
||
| const collectConsoleErrors = (page: Page) => { | ||
| const logs: string[] = []; | ||
|
|
||
| page.on('console', (msg) => { | ||
| if (msg.type() === 'error') { | ||
| logs.push(msg.text()); | ||
| } | ||
| }); | ||
|
|
||
| return logs; | ||
| }; | ||
|
|
||
| const SLOT_ERROR = '[Ionic Error]: [ion-refresher] - Make sure you use: <ion-refresher slot="fixed">'; | ||
|
|
||
| /** | ||
| * Rendering puts `slot="fixed"` on the host, so a refresher whose markup omits the | ||
| * slot still ends up in the right place and has to work. Frameworks that assign the | ||
| * slot after inserting the element start out the same way. | ||
| * | ||
| * This behavior does not vary across directions. | ||
| */ | ||
| configs({ directions: ['ltr'] }).forEach(({ title, config }) => { | ||
| test.describe(title('refresher: slot validation'), () => { | ||
| test('should still set up the pull-to-refresh gesture when the slot is missing', async ({ page }, testInfo) => { | ||
| testInfo.annotations.push({ | ||
| type: 'issue', | ||
| description: 'https://github.com/ionic-team/ionic-framework/issues/31376', | ||
| }); | ||
|
|
||
| await page.setContent( | ||
| ` | ||
| <ion-content> | ||
| <ion-refresher> | ||
| <ion-refresher-content></ion-refresher-content> | ||
| </ion-refresher> | ||
|
|
||
| <div style="height: 200vh"></div> | ||
| </ion-content> | ||
| `, | ||
| config | ||
| ); | ||
| /** | ||
| * Gesture setup runs behind a dynamic import, so dragging straight after | ||
| * setContent can land before the refresher is listening. | ||
| */ | ||
| await page.locator('ion-refresher.hydrated').waitFor({ state: 'attached' }); | ||
|
|
||
| const ionRefresh = await page.spyOnEvent('ionRefresh'); | ||
|
|
||
| await dragElementByYAxis(page.locator('body'), page, 320); | ||
|
|
||
| await expect.poll(() => ionRefresh.events.length).toBe(1); | ||
| }); | ||
|
|
||
| test('should report an error telling the developer to add the slot', async ({ page }) => { | ||
| const logs = collectConsoleErrors(page); | ||
|
|
||
| await page.setContent( | ||
| ` | ||
| <ion-content> | ||
| <ion-refresher> | ||
| <ion-refresher-content></ion-refresher-content> | ||
| </ion-refresher> | ||
| </ion-content> | ||
| `, | ||
| config | ||
| ); | ||
| await page.locator('ion-refresher.hydrated').waitFor({ state: 'attached' }); | ||
|
|
||
| expect(logs.length).toBe(1); | ||
| expect(logs[0]).toContain(SLOT_ERROR); | ||
| }); | ||
|
|
||
| test('should not report an error when the slot is set', async ({ page }) => { | ||
| const logs = collectConsoleErrors(page); | ||
|
|
||
| await page.setContent( | ||
| ` | ||
| <ion-content> | ||
| <ion-refresher slot="fixed"> | ||
| <ion-refresher-content></ion-refresher-content> | ||
| </ion-refresher> | ||
| </ion-content> | ||
| `, | ||
| config | ||
| ); | ||
| await page.locator('ion-refresher.hydrated').waitFor({ state: 'attached' }); | ||
|
|
||
| expect(logs).toEqual([]); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.