Skip to content

fix: prevent false emulation detection inside iframe context #1155

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

Open
n2-freevas wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −0
Open

fix: prevent false emulation detection inside iframe context #1155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/fix-iframe-emulation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@wdio/image-comparison-core": patch
---

fix: prevent false emulation detection when checkElement is called inside an iframe after switchFrame
27 changes: 27 additions & 0 deletions packages/image-comparison-core/src/clientSideScripts/getScreenDimensions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,33 @@ describe('getScreenDimensions', () => {
expect(dimensions.dimensions.window.screenHeight).toBe(1800)
})

it('should not detect emulation when running inside an iframe', () => {
const originalSelf = window.self
Object.defineProperty(window, 'self', {
value: {} as Window,
configurable: true,
writable: true,
})

Object.defineProperty(window, 'devicePixelRatio', { value: 3, configurable: true })
Object.defineProperty(window, 'innerWidth', { value: 50, configurable: true })
Object.defineProperty(window, 'innerHeight', { value: 100, configurable: true })
Object.defineProperty(window, 'matchMedia', {
value: vi.fn().mockImplementation(() => ({ matches: false })),
...CONFIGURABLE,
})

const dimensions = getScreenDimensions(false)

Object.defineProperty(window, 'self', {
value: originalSelf,
configurable: true,
writable: true,
})

expect(dimensions.dimensions.window.isEmulated).toBe(false)
})

it('should handle zero devicePixelRatio', () => {
Object.defineProperty(window, 'devicePixelRatio', { value: 0, configurable: true })
Object.defineProperty(window, 'innerWidth', { value: 1920, configurable: true })
Expand Down
2 changes: 2 additions & 0 deletions packages/image-comparison-core/src/clientSideScripts/getScreenDimensions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ export default function getScreenDimensions(isMobile: boolean): ScreenDimensions
const dpr = window.devicePixelRatio || 1
const minEdge = Math.min(width, height)
const maxEdge = Math.max(width, height)
const isInIframe = window.self !== window.top
const isLikelyEmulated =
!isMobile && // Only check for emulated on desktop
!isInIframe && // Skip emulation detection inside iframes
dpr >= 2 && // High-DPI signal
minEdge <= 800 && // Catch phones/tablets in portrait/landscape
maxEdge <= 1280 && // Conservative max for emulated tablet sizes
Expand Down