Skip to content
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

Fix Playwright VR test failures #5135

Merged
merged 2 commits into from
Nov 4, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ const clearFilters = () => {
@click="close"
/>
</template>
<VTabPanel id="content-settings">
<VTabPanel id="content-settings" class="border-overlay">
<VSearchTypes
size="medium"
:use-links="useLinks"
@select="$emit('select', $event)"
/>
</VTabPanel>
<!-- Horizontal padding removed to display divider. -->
<VTabPanel v-if="showFilters" id="filters" class="px-0">
<VTabPanel v-if="showFilters" id="filters" class="border-overlay px-0">
<VSearchGridFilter
class="px-6"
:show-filter-header="false"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ const width = computed(() => diameter * 3 + spacing * 2)

<!-- To preserve the button width when state changes, this element is not
removed from the DOM, only hidden and muted. -->
<span :class="{ 'opacity-0': isFetching }" :aria-hidden="isFetching">
<span
:class="{ 'opacity-0': isFetching }"
:aria-hidden="isFetching || undefined"
>
{{ $t("header.seeResults") }}
</span>
</VButton>
Expand Down
6 changes: 5 additions & 1 deletion frontend/src/components/VThemeSelect/VThemeSelect.vue
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ const darkMode = useDarkMode()
* The icon always reflects the actual theme applied to the site.
* Therefore, it must be based on the value of `effectiveColorMode`.
*/
const currentThemeIcon: Ref<"sun" | "moon" | undefined> = ref(undefined)
const currentThemeIcon: Ref<"sun" | "moon" | undefined> = ref(
darkMode.effectiveColorMode.value
? THEME_ICON_NAME[darkMode.effectiveColorMode.value]
: undefined
)

/**
* The choices are computed because the text for the color mode choice
Expand Down
1 change: 1 addition & 0 deletions frontend/src/styles/tailwind.css
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@
--color-border-secondary-hover: var(--color-gray-1);
--color-border-tertiary: var(--color-gray-1);
--color-border-transparent-hover: var(--color-gray-11);
--color-border-overlay: var(--color-gray-10);
--color-border-focus: var(--color-yellow-4);
--color-border-bg-ring: var(--color-gray-13);
--color-border-disabled: var(--color-gray-8);
Expand Down
6 changes: 6 additions & 0 deletions frontend/test/playwright/utils/components.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,9 @@ export const getHeaderSearchbar = (
page: Page,
dir: LanguageDirection = "ltr"
) => page.getByRole("combobox", { name: t("search.searchBarLabel", dir) })

const themeSelectLabel = (dir: LanguageDirection) => t("theme.theme", dir)
// In Storybook, the footer story has two theme switchers (one in the footer, and one
// is from the story decorator), so we need to select a single one.
export const getThemeSwitcher = (page: Page, dir: LanguageDirection) =>
page.getByLabel(themeSelectLabel(dir)).first()
12 changes: 4 additions & 8 deletions frontend/test/playwright/utils/expect-snapshot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { type LanguageDirection, t } from "~~/test/playwright/utils/i18n"

import { sleep } from "~~/test/playwright/utils/navigation"

import { getThemeSwitcher } from "~~/test/playwright/utils/components"

import type { Breakpoint } from "~/constants/screens"

import type {
Expand Down Expand Up @@ -35,17 +37,11 @@ export type ExpectScreenshotAreaSnapshot = (
) => Promise<void>

type EffectiveColorMode = "dark" | "light"
const themeSelectLabel = (dir: LanguageDirection) => t("theme.theme", dir)
const themeOption = (colorMode: EffectiveColorMode, dir: LanguageDirection) =>
t(`theme.choices.${colorMode}`, dir)

export const turnOnDarkMode = async (page: Page, dir: LanguageDirection) => {
// In Storybook, the footer story has two theme switchers (one in the footer, and one
// is from the story decorator), so we need to select a single one.
await page
.getByLabel(themeSelectLabel(dir))
.nth(0)
.selectOption(themeOption("dark", dir))
await getThemeSwitcher(page, dir).selectOption(themeOption("dark", dir))
}

type SnapshotNameOptions = {
Expand Down Expand Up @@ -96,7 +92,7 @@ export const expectSnapshot: ExpectSnapshot = async (
await turnOnDarkMode(page, dir ?? "ltr")

// Wait for the theme to change.
await sleep(200)
await sleep(100)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was the original value. I thought we needed to increase it to fix the modal rendering, but turns out that switching the theme was done incorrectly before. When the modal is open, the theme switcher is covered by it. We need to close the modal, switch the theme, and then re-open the modal before taking the snapshot.


expect(await screenshotAble.screenshot(screenshotOptions)).toMatchSnapshot(
getSnapshotName(name, "dark"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,47 +34,46 @@ const checkModalRendered = async (
name: t("header.seeResults", dir),
})
await expect(seeResultsButton).toBeEnabled()
await expect(page.getByText(t("header.loading", dir))).toBeHidden()
}

const snapshotOptions = { maxDiffPixels: 2, maxDiffPixelRatio: undefined }

for (const dir of languageDirections) {
breakpoints.describeEachBreakpoint(["xs", "sm", "md", "lg"])(
({ breakpoint, expectSnapshot }) => {
const isDesktop = breakpoint === "lg"
const filterLocator = isDesktop ? "complementary" : "dialog"
test.beforeEach(async ({ page }) => {
await preparePageForTests(page, breakpoint)
await goToSearchTerm(page, "birds", { dir })
await filters.open(page, dir)
})
test(`filters none selected - ${dir}`, async ({ page }) => {
await goToSearchTerm(page, "birds", { dir })
await filters.open(page, dir)
await checkModalRendered(page, isDesktop, dir)

await expectSnapshot(
page,
getFiltersName(breakpoint),
isDesktop ? page.locator(".sidebar") : page,
{
dir,
snapshotOptions: { maxDiffPixels: 2, maxDiffPixelRatio: undefined },
}
page.getByRole(filterLocator),
{ dir, snapshotOptions }
)
})

test(`filters 1 filter selected - ${dir}`, async ({ page }) => {
const firstFilter = page.getByRole("checkbox").first()
await firstFilter.check()
await checkModalRendered(page, isDesktop, dir)
await goToSearchTerm(page, "birds", {
dir,
query: "license_type=commercial",
})
await filters.open(page, dir)

const snapshotName = `${getFiltersName(breakpoint)}-checked`
await checkModalRendered(page, isDesktop, dir)

await firstFilter.hover()
await expectSnapshot(
page,
snapshotName,
isDesktop ? page.locator(".sidebar") : page,
{
dir,
snapshotOptions: { maxDiffPixels: 2, maxDiffPixelRatio: undefined },
}
`${getFiltersName(breakpoint)}-checked`,
page.getByRole(filterLocator),
{ dir, snapshotOptions }
)
})
}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading