[DT-2854] add an integration test to make sure dark mode toggling works through localstorage #2752
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
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 |
|---|---|---|
|
|
@@ -33,4 +33,5 @@ | |
| tooltip={buttonText} | ||
| label={buttonText} | ||
| icon={buttonIcon} | ||
| data-testid="dark-mode-navigation-button" | ||
| /> | ||
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
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,48 @@ | ||
| import { expect, test } from '@playwright/test'; | ||
|
|
||
| import { mockWorkflowsApis } from '~/test-utilities/mock-apis'; | ||
|
|
||
| test.describe('Dark Mode Toggle', () => { | ||
| test.beforeEach(async ({ page }) => { | ||
| await mockWorkflowsApis(page); | ||
| await page.goto('/'); | ||
| }); | ||
|
|
||
| test('user can toggle dark mode between on, off, and system default', async ({ | ||
| page, | ||
| }) => { | ||
| const nightLabel = 'Night'; | ||
| const systemDefaultLabel = 'System Default'; | ||
| const dayLabel = 'Day'; | ||
|
|
||
| // starts on day mode | ||
| const button = page.getByTestId('dark-mode-icon-button'); | ||
|
|
||
| await expect(button).toBeVisible(); | ||
|
|
||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| null, // nothing in local storage yet | ||
| ); | ||
|
|
||
| // after day is system mode | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(systemDefaultLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify('system'), | ||
| ); | ||
|
|
||
| // after system is dark mode | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(nightLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify(true), | ||
| ); | ||
|
|
||
| // cycle back to day | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(dayLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify(false), | ||
| ); | ||
| }); | ||
| }); |
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,51 @@ | ||
| import { expect, test } from '@playwright/test'; | ||
|
|
||
| import { mockWorkflowsApis } from '~/test-utilities/mock-apis'; | ||
|
|
||
| test.describe('Dark Mode Toggle', () => { | ||
| test.beforeEach(async ({ page }) => { | ||
| await mockWorkflowsApis(page); | ||
| await page.goto('/'); | ||
| }); | ||
|
|
||
| test('user can toggle dark mode between on, off, and system default', async ({ | ||
| page, | ||
| }) => { | ||
| const nightLabel = 'Night'; | ||
| const systemDefaultLabel = 'System Default'; | ||
| const dayLabel = 'Day'; | ||
|
|
||
| // on mobile, the dark mode button is in the profile menu | ||
| await page.getByTestId('nav-profile-button').click(); | ||
|
|
||
| // starts on day mode | ||
| const button = page.getByTestId('dark-mode-navigation-button'); | ||
|
|
||
| await expect(button).toBeVisible(); | ||
|
|
||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| null, // nothing in local storage yet | ||
| ); | ||
|
|
||
| // after day is system mode | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(systemDefaultLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify('system'), | ||
| ); | ||
|
|
||
| // after system is dark mode | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(nightLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify(true), | ||
| ); | ||
|
|
||
| // cycle back to day | ||
| await button.click(); | ||
| await expect(button).toHaveAccessibleName(dayLabel); | ||
| expect(await page.evaluate(() => localStorage.getItem('dark mode'))).toBe( | ||
| JSON.stringify(false), | ||
| ); | ||
| }); | ||
| }); |
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.
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.
Annotation: Since the aria-label changes when you press the button, getByRole doesn't work well without re-selecting over and over. By using testid, I can get the element once and use it throughout the test.