visual-testing/packages/image-comparison-core/src/clientSideScripts/getScreenDimensions.test.ts at f3b871656fbbe30b1cb749e194baf98f7ca46469 · n2-freevas/visual-testing · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// @vitest-environment jsdom

import { describe, it, expect, vi } from 'vitest'
import { CONFIGURABLE } from '../mocks/mocks.js'
import getScreenDimensions from './getScreenDimensions.js'

describe('getScreenDimensions', () => {
    it('should get the needed screen dimensions for a real device', () => {
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: true,
            })),
            ...CONFIGURABLE,
        })
        expect(getScreenDimensions(true)).toMatchSnapshot()
    })

    it('should get the needed screen dimensions', () => {
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: true,
            })),
            ...CONFIGURABLE,
        })
        expect(getScreenDimensions(false)).toMatchSnapshot()
    })

    it('should get the needed screen dimensions if the outerHeight and outerWidth are set to 0', () => {
        Object.defineProperty(window, 'outerHeight', { value: 0 })
        Object.defineProperty(window, 'outerWidth', { value: 0 })
        Object.defineProperty(document.documentElement, 'clientHeight', { value: 1234 })
        Object.defineProperty(document.documentElement, 'clientWidth', { value: 4321 })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: false,
            })),
            ...CONFIGURABLE,
        })

        expect(getScreenDimensions(false)).toMatchSnapshot()
    })

    it('should return zeroed dimensions if the document attributes are null', () => {
        Object.defineProperty(document, 'body', { value: null })
        Object.defineProperty(document, 'documentElement', { value: null })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: false,
            })),
            ...CONFIGURABLE,
        })

        expect(getScreenDimensions(false)).toMatchSnapshot()
    })

    it('should detect mobile emulation and return emulated dimensions', () => {
        const mockScreen = {
            width: 375,
            height: 667
        }
        const originalScreen = window.screen

        Object.defineProperty(window, 'screen', {
            value: mockScreen,
            configurable: true,
            writable: true
        })
        Object.defineProperty(window, 'devicePixelRatio', { value: 3, configurable: true })
        Object.defineProperty(window, 'innerWidth', { value: 375, configurable: true })
        Object.defineProperty(window, 'innerHeight', { value: 667, configurable: true })
        Object.defineProperty(window, 'outerWidth', { value: 375, configurable: true })
        Object.defineProperty(window, 'outerHeight', { value: 667, configurable: true })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: false,
            })),
            ...CONFIGURABLE,
        })

        const dimensions = getScreenDimensions(false)

        Object.defineProperty(window, 'screen', {
            value: originalScreen,
            configurable: true,
            writable: true
        })

        expect(dimensions.dimensions.window.screenWidth).toBe(375)
        expect(dimensions.dimensions.window.screenHeight).toBe(667)
        expect(dimensions.dimensions.window.outerWidth).toBe(375)
        expect(dimensions.dimensions.window.outerHeight).toBe(667)
        expect(dimensions.dimensions.window.devicePixelRatio).toBe(3)
    })

    it('should handle desktop (non-emulated) dimensions correctly', () => {
        const mockScreen = {
            width: 1920,
            height: 1080
        }
        const originalScreen = window.screen

        Object.defineProperty(window, 'screen', {
            value: mockScreen,
            configurable: true,
            writable: true
        })
        Object.defineProperty(window, 'devicePixelRatio', { value: 1, configurable: true })
        Object.defineProperty(window, 'innerWidth', { value: 1440, configurable: true })
        Object.defineProperty(window, 'innerHeight', { value: 900, configurable: true })
        Object.defineProperty(window, 'outerWidth', { value: 1440, configurable: true })
        Object.defineProperty(window, 'outerHeight', { value: 900, configurable: true })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: true,
            })),
            ...CONFIGURABLE,
        })

        const dimensions = getScreenDimensions(false)

        Object.defineProperty(window, 'screen', {
            value: originalScreen,
            configurable: true,
            writable: true
        })

        expect(dimensions.dimensions.window.screenWidth).toBe(1920)
        expect(dimensions.dimensions.window.screenHeight).toBe(1080)
        expect(dimensions.dimensions.window.outerWidth).toBe(1440)
        expect(dimensions.dimensions.window.outerHeight).toBe(900)
        expect(dimensions.dimensions.window.devicePixelRatio).toBe(1)
    })

    it('should handle high DPI desktop displays', () => {
        const mockScreen = {
            width: 2880,
            height: 1800
        }
        const originalScreen = window.screen

        Object.defineProperty(window, 'screen', {
            value: mockScreen,
            configurable: true,
            writable: true
        })
        Object.defineProperty(window, 'devicePixelRatio', { value: 2, configurable: true })
        Object.defineProperty(window, 'innerWidth', { value: 1440, configurable: true })
        Object.defineProperty(window, 'innerHeight', { value: 900, configurable: true })
        Object.defineProperty(window, 'outerWidth', { value: 1440, configurable: true })
        Object.defineProperty(window, 'outerHeight', { value: 900, configurable: true })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: true,
            })),
            ...CONFIGURABLE,
        })

        const dimensions = getScreenDimensions(false)

        Object.defineProperty(window, 'screen', {
            value: originalScreen,
            configurable: true,
            writable: true
        })

        expect(dimensions.dimensions.window.devicePixelRatio).toBe(2)
        expect(dimensions.dimensions.window.screenWidth).toBe(2880)
        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 })
        Object.defineProperty(window, 'innerHeight', { value: 1080, configurable: true })
        Object.defineProperty(window, 'matchMedia', {
            value: vi.fn().mockImplementation(() => ({
                matches: true,
            })),
            ...CONFIGURABLE,
        })

        const dimensions = getScreenDimensions(false)
        expect(dimensions.dimensions.window.devicePixelRatio).toBe(1)
    })
})