This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
Add the new e2e tests that work with new_header flag on
#1918
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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,217 @@ | ||
| import { test, expect, Page } from '@playwright/test' | ||
|
|
||
| import { | ||
| assertCheckboxStatus, | ||
| openFilters, | ||
| changeContentType, | ||
| goToSearchTerm, | ||
| enableNewHeader, | ||
| closeFilters, | ||
| isPageDesktop, | ||
| } from '~~/test/playwright/utils/navigation' | ||
|
|
||
| import { mockProviderApis } from '~~/test/playwright/utils/route' | ||
|
|
||
| import breakpoints from '~~/test/playwright/utils/breakpoints' | ||
|
|
||
| import { | ||
| supportedSearchTypes, | ||
| ALL_MEDIA, | ||
| IMAGE, | ||
| AUDIO, | ||
| } from '~/constants/media' | ||
|
|
||
| test.describe.configure({ mode: 'parallel' }) | ||
|
|
||
| const assertCheckboxCount = async ( | ||
| page: Page, | ||
| checked: 'checked' | 'notChecked' | 'total', | ||
| count: number | ||
| ) => { | ||
| const checkedString = { | ||
| checked: ':checked', | ||
| notChecked: ':not(:checked)', | ||
| total: '', | ||
| }[checked] | ||
| const locatorString = `input[type="checkbox"]${checkedString}` | ||
| await expect(page.locator(locatorString)).toHaveCount(count, { timeout: 200 }) | ||
| } | ||
|
|
||
| const FILTER_COUNTS = { | ||
| [ALL_MEDIA]: 11, | ||
| [AUDIO]: 32, | ||
| [IMAGE]: 70, | ||
| } | ||
|
|
||
| breakpoints.describeMobileAndDesktop(() => { | ||
| test.beforeEach(async ({ context, page }) => { | ||
| await mockProviderApis(context) | ||
| await enableNewHeader(page) | ||
| }) | ||
| for (const searchType of supportedSearchTypes) { | ||
| test(`correct total number of filters is displayed for ${searchType}`, async ({ | ||
| page, | ||
| }) => { | ||
| await goToSearchTerm(page, 'cat', { searchType }) | ||
|
|
||
| await openFilters(page) | ||
|
|
||
| await assertCheckboxCount(page, 'total', FILTER_COUNTS[searchType]) | ||
| }) | ||
| } | ||
|
|
||
| test('initial filters are applied based on the url', async ({ page }) => { | ||
| await page.goto( | ||
| '/search/?q=cat&license_type=commercial&license=cc0&searchBy=creator' | ||
| ) | ||
| await openFilters(page) | ||
| const expectedFilters = ['cc0', 'commercial', 'creator'] | ||
|
|
||
| for (const checkbox of expectedFilters) { | ||
| await assertCheckboxStatus(page, checkbox) | ||
| } | ||
| }) | ||
|
|
||
| test('common filters are retained when media type changes from all media to single type', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto( | ||
| '/search/?q=cat&license_type=commercial&license=cc0&searchBy=creator' | ||
| ) | ||
| await openFilters(page) | ||
| const expectedFilters = ['cc0', 'commercial', 'creator'] | ||
|
|
||
| for (const checkbox of expectedFilters) { | ||
| await assertCheckboxStatus(page, checkbox) | ||
| } | ||
| await changeContentType(page, 'Images') | ||
|
|
||
| await expect(page).toHaveURL( | ||
| '/search/image?q=cat&license_type=commercial&license=cc0&searchBy=creator' | ||
| ) | ||
| await openFilters(page) | ||
| for (const checkbox of expectedFilters) { | ||
| await assertCheckboxStatus(page, checkbox) | ||
| } | ||
| }) | ||
|
|
||
| test('common filters are retained when media type changes from single type to all media', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto( | ||
| '/search/image?q=cat&license_type=commercial&license=cc0&searchBy=creator' | ||
| ) | ||
| await openFilters(page) | ||
|
|
||
| for (const checkbox of ['cc0', 'commercial', 'creator']) { | ||
| await assertCheckboxStatus(page, checkbox) | ||
| } | ||
|
|
||
| await changeContentType(page, 'All content') | ||
|
|
||
| await openFilters(page) | ||
| await expect(page.locator('input[type="checkbox"]:checked')).toHaveCount(3) | ||
|
|
||
| await expect(page).toHaveURL( | ||
| '/search/?q=cat&license_type=commercial&license=cc0&searchBy=creator' | ||
| ) | ||
| }) | ||
|
|
||
| test('selecting some filters can disable dependent filters', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto('/search/audio?q=cat&license_type=commercial') | ||
| await openFilters(page) | ||
|
|
||
| // by-nc is special because we normally test for fuzzy match, and by-nc matches 3 labels. | ||
| const byNc = page.locator('input[value="by-nc"]') | ||
| await expect(byNc).toBeDisabled() | ||
| for (const checkbox of ['by-nc-sa', 'by-nc-nd']) { | ||
| await assertCheckboxStatus(page, checkbox, '', 'disabled') | ||
| } | ||
| await assertCheckboxStatus(page, 'commercial') | ||
|
|
||
| await page.click('label:has-text("commercial")') | ||
|
|
||
| await assertCheckboxStatus(page, 'commercial', '', 'unchecked') | ||
| await expect(byNc).not.toBeDisabled() | ||
| for (const checkbox of ['commercial', 'by-nc-sa', 'by-nc-nd']) { | ||
| await assertCheckboxStatus(page, checkbox, '', 'unchecked') | ||
| } | ||
| }) | ||
|
|
||
| /** | ||
| * When the search type changes: | ||
| * - image-specific filter (aspect_ration=tall) is discarded | ||
| * - common filter (license_type=CC0) is kept | ||
| * - filter button text updates | ||
| * - URL updates | ||
| * Tests for the missing checkbox with `toHaveCount` are flaky, so we use filter button | ||
| * text and the URL instead. | ||
| */ | ||
| test('filters are updated when media type changes', async ({ page }) => { | ||
| await page.goto('/search/image?q=cat&aspect_ratio=tall&license=cc0') | ||
| await openFilters(page) | ||
|
|
||
| await assertCheckboxStatus(page, 'tall') | ||
| await assertCheckboxStatus(page, 'cc0') | ||
|
|
||
| await changeContentType(page, 'Audio') | ||
| await openFilters(page) | ||
|
|
||
| // Only CC0 checkbox is checked, and the filter button label is | ||
| // '1 Filter' on `xl` or '1' on `lg` screens | ||
| await assertCheckboxStatus(page, 'cc0') | ||
| await closeFilters(page) | ||
| if (isPageDesktop(page)) { | ||
| const filterButtonText = await page | ||
| .locator('[aria-controls="filters"] span:visible') | ||
| .textContent() | ||
| expect(filterButtonText).toContain('1') | ||
| } else { | ||
| const filtersAriaLabel = | ||
| (await page | ||
| .locator('[aria-controls="content-settings-modal"]') | ||
| .getAttribute('aria-label')) ?? '' | ||
| expect(filtersAriaLabel.trim()).toEqual('Menu. 1 filter applied') | ||
| } | ||
|
|
||
| await expect(page).toHaveURL('/search/audio?q=cat&license=cc0') | ||
| }) | ||
|
|
||
| test('new media request is sent when a filter is selected', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto('/search/image?q=cat') | ||
| await openFilters(page) | ||
|
|
||
| await assertCheckboxStatus(page, 'cc0', '', 'unchecked') | ||
|
|
||
| const [response] = await Promise.all([ | ||
| page.waitForResponse((response) => response.url().includes('cc0')), | ||
| page.click('label:has-text("CC0")'), | ||
| ]) | ||
|
|
||
| await assertCheckboxStatus(page, 'cc0') | ||
| // Remove the host url and path because when proxied, the 'http://localhost:49153' is used instead of the | ||
| // real API url | ||
| const queryString = response.url().split('/images/')[1] | ||
| expect(queryString).toEqual('?q=cat&license=cc0') | ||
| }) | ||
|
|
||
| for (const [searchType, source] of [ | ||
| ['audio', 'Freesound'], | ||
| ['image', 'Flickr'], | ||
| ]) { | ||
| test(`Provider filters are correctly initialized from the URL: ${source} - ${searchType}`, async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto( | ||
| `/search/${searchType}?q=birds&source=${source.toLowerCase()}` | ||
| ) | ||
| await openFilters(page) | ||
|
|
||
| await assertCheckboxStatus(page, source, '', 'checked') | ||
| }) | ||
| } | ||
| }) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
shouldPersistMediaalwaysfalsehere or should the type beboolean?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh dear, I totally misread this code! I thought it was the type but it was the default value 🤦 Sorry for the bad suggestion 😞