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.

Sign up for GitHub

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

[dev-overlay]: hiding devtools shouldn't hide errors #76399

Merged
merged 2 commits into from
Feb 23, 2025
Merged

[dev-overlay]: hiding devtools shouldn't hide errors #76399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77d3d43
[dev-overlay]: hiding devtools shouldn't hide errors
ztanner Feb 23, 2025
9e1660f
fix test
ztanner Feb 23, 2025
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
31 changes: 15 additions & 16 deletions ...onents/react-dev-overlay/ui/components/errors/dev-tools-indicator/dev-tools-indicator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,23 @@ export function DevToolsIndicator({
// Technically this prop isn't needed, but useful for testing.
position?: DevToolsIndicatorPosition
}) {
const [isDevToolsIndicatorOpen, setIsDevToolsIndicatorOpen] = useState(true)
const [isDevToolsIndicatorVisible, setIsDevToolsIndicatorVisible] =
useState(true)

return (
isDevToolsIndicatorOpen && (
<DevToolsPopover
semver={state.versionInfo.installed}
issueCount={errorCount}
isStaticRoute={state.staticIndicator}
hide={() => {
setIsDevToolsIndicatorOpen(false)
}}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
isTurbopack={!!process.env.TURBOPACK}
position={position}
disabled={state.disableDevIndicator}
isBuildError={isBuildError}
/>
)
<DevToolsPopover
semver={state.versionInfo.installed}
issueCount={errorCount}
isStaticRoute={state.staticIndicator}
hide={() => {
setIsDevToolsIndicatorVisible(false)
}}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
isTurbopack={!!process.env.TURBOPACK}
position={position}
disabled={state.disableDevIndicator || !isDevToolsIndicatorVisible}
Copy link
Member Author

Choose a reason for hiding this comment

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

this is the change

isBuildError={isBuildError}
/>
)
}

Expand Down
59 changes: 41 additions & 18 deletions test/development/client-dev-overlay/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { createNext, FileRef } from 'e2e-utils'
import webdriver, { BrowserInterface } from 'next-webdriver'
import { NextInstance } from 'e2e-utils'
import { join } from 'path'
import { check } from 'next-test-utils'
import { retry } from 'next-test-utils'

describe('client-dev-overlay', () => {
let next: NextInstance
Expand Down Expand Up @@ -30,6 +30,7 @@ describe('client-dev-overlay', () => {
fullScreenDialog: '[data-nextjs-dialog]',
toast: '[data-nextjs-toast]',
popover: '[data-nextjs-dev-tools-button]',
indicator: '[data-next-badge-root]',
minimizeButton: 'body',
hideButton: '[data-hide-dev-tools]',
}
Expand All @@ -50,13 +51,11 @@ describe('client-dev-overlay', () => {
await getMinimizeButton().click()
await getToast().click()

await check(async () => {
return (await elementExistsInNextJSPortalShadowDOM(
selectors.fullScreenDialog
))
? 'success'
: 'missing'
}, 'success')
await retry(async () => {
expect(
await elementExistsInNextJSPortalShadowDOM(selectors.fullScreenDialog)
).toBe(true)
})
})

it('should be able to minimize the fullscreen overlay', async () => {
Expand All @@ -66,22 +65,46 @@ describe('client-dev-overlay', () => {
)
})

it('should be able to hide the minimized overlay', async () => {
it('should keep the error indicator visible when there are errors', async () => {
await getMinimizeButton().click()
await getPopover().click()
await getHideButton().click()

await check(async () => {
const exists = await elementExistsInNextJSPortalShadowDOM(selectors.toast)
return exists ? 'found' : 'success'
}, 'success')
await retry(async () => {
const display = await browser.eval(
`getComputedStyle(document.querySelector('nextjs-portal').shadowRoot.querySelector('${selectors.indicator}')).display`
)
expect(display).toBe('block')
})
})

it('should be possible to hide the minimized overlay when there are no errors', async () => {
const originalContent = await next.readFile('pages/index.js')
try {
await next.patchFile('pages/index.js', (content) => {
return content.replace(`throw Error('example runtime error')`, '')
})

await getMinimizeButton().click()
await getPopover().click()
await getHideButton().click()

await retry(async () => {
const display = await browser.eval(
`getComputedStyle(document.querySelector('nextjs-portal').shadowRoot.querySelector('${selectors.indicator}')).display`
)
expect(display).toBe('none')
})
} finally {
await next.patchFile('pages/index.js', originalContent)
}
})

it('should have a role of "dialog" if the page is focused', async () => {
await check(async () => {
return (await elementExistsInNextJSPortalShadowDOM('[role="dialog"]'))
? 'exists'
: 'missing'
}, 'exists')
await retry(async () => {
expect(
await elementExistsInNextJSPortalShadowDOM('[role="dialog"]')
).toBe(true)
})
})
})
Loading