summaryrefslogtreecommitdiffstats
path: root/remote/cdp/test/browser/emulation/browser_setDeviceMetricsOverride.js
blob: 07aa7ec10f1401d111a4a70960acce9e48ed1b04 (plain)
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const DOC_SMALL = toDataURL("<div>Hello world");
const DOC_LARGE = toDataURL("<div style='margin: 150vh 0 0 150vw'>Hello world");

const MAX_WINDOW_SIZE = 10000000;

function getContentDPR() {
  info(`Retrieve device pixel ratio in content`);
  return SpecialPowers.spawn(
    gBrowser.selectedBrowser,
    [],
    _ => content.browsingContext.overrideDPPX || content.devicePixelRatio
  );
}

add_task(async function dimensionsSmallerThanWindow({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: Math.floor(layoutViewport.clientWidth / 2),
    height: Math.floor(layoutViewport.clientHeight / 3),
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  const updatedLayoutMetrics = await Page.getLayoutMetrics();
  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    overrideSettings.width,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    overrideSettings.height,
    "Expected layout viewport height set"
  );
  is(
    updatedLayoutMetrics.contentSize.width,
    overrideSettings.width,
    "Expected content size width set"
  );
  is(
    updatedLayoutMetrics.contentSize.height,
    overrideSettings.height,
    "Expected content size height set"
  );
});

add_task(async function dimensionsLargerThanWindow({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_LARGE);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: layoutViewport.clientWidth * 2,
    height: layoutViewport.clientHeight * 2,
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_LARGE);

  const scrollbarSize = await getScrollbarSize();
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    overrideSettings.width - scrollbarSize.width,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    overrideSettings.height - scrollbarSize.height,
    "Expected layout viewport height set"
  );
});

add_task(async function noSizeChangeForSameWidthAndHeight({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: layoutViewport.clientWidth,
    height: layoutViewport.clientHeight,
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  const updatedLayoutMetrics = await Page.getLayoutMetrics();
  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Expected layout viewport height set"
  );
});

add_task(async function noWidthChangeWithZeroWidth({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: 0,
    height: Math.floor(layoutViewport.clientHeight / 3),
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  const updatedLayoutMetrics = await Page.getLayoutMetrics();
  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    overrideSettings.height,
    "Expected layout viewport height set"
  );
});

add_task(async function noHeightChangeWithZeroHeight({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: Math.floor(layoutViewport.clientWidth / 2),
    height: 0,
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  const updatedLayoutMetrics = await Page.getLayoutMetrics();
  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    overrideSettings.width,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Expected layout viewport height set"
  );
});

add_task(async function nosizeChangeWithZeroWidthAndHeight({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();

  const overrideSettings = {
    width: 0,
    height: 0,
    deviceScaleFactor: 1.0,
  };

  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  const updatedLayoutMetrics = await Page.getLayoutMetrics();
  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Expected layout viewport width set"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Expected layout viewport height set"
  );
});

add_task(async function failsWithNegativeWidth({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio = await getContentDPR();

  const overrideSettings = {
    width: -1,
    height: Math.floor(layoutViewport.clientHeight / 3),
    deviceScaleFactor: 1.0,
  };

  let errorThrown = false;
  try {
    await Emulation.setDeviceMetricsOverride(overrideSettings);
  } catch (e) {
    errorThrown = true;
  }
  ok(errorThrown, "Negative width raised error");

  await loadURL(DOC_SMALL);
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Visible layout width hasn't been changed"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Visible layout height hasn't been changed"
  );
  is(await getContentDPR(), ratio, "Device pixel ratio hasn't been changed");
});

add_task(async function failsWithTooLargeWidth({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio = await getContentDPR();

  const overrideSettings = {
    width: MAX_WINDOW_SIZE + 1,
    height: Math.floor(layoutViewport.clientHeight / 3),
    deviceScaleFactor: 1.0,
  };

  let errorThrown = false;
  try {
    await Emulation.setDeviceMetricsOverride(overrideSettings);
  } catch (e) {
    errorThrown = true;
  }
  ok(errorThrown, "Too large width raised error");

  await loadURL(DOC_SMALL);
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Visible layout width hasn't been changed"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Visible layout height hasn't been changed"
  );
  is(await getContentDPR(), ratio, "Device pixel ratio hasn't been changed");
});

add_task(async function failsWithNegativeHeight({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio = await getContentDPR();

  const overrideSettings = {
    width: Math.floor(layoutViewport.clientWidth / 2),
    height: -1,
    deviceScaleFactor: 1.0,
  };

  let errorThrown = false;
  try {
    await Emulation.setDeviceMetricsOverride(overrideSettings);
  } catch (e) {
    errorThrown = true;
  }
  ok(errorThrown, "Negative height raised error");

  await loadURL(DOC_SMALL);
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Visible layout width hasn't been changed"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Visible layout height hasn't been changed"
  );
  is(await getContentDPR(), ratio, "Device pixel ratio hasn't been changed");
});

add_task(async function failsWithTooLargeHeight({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio = await getContentDPR();

  const overrideSettings = {
    width: Math.floor(layoutViewport.clientWidth / 2),
    height: MAX_WINDOW_SIZE + 1,
    deviceScaleFactor: 1.0,
  };

  let errorThrown = false;
  try {
    await Emulation.setDeviceMetricsOverride(overrideSettings);
  } catch (e) {
    errorThrown = true;
  }
  ok(errorThrown, "Too large height raised error");

  await loadURL(DOC_SMALL);
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Visible layout width hasn't been changed"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Visible layout height hasn't been changed"
  );
  is(await getContentDPR(), ratio, "Device pixel ratio hasn't been changed");
});

add_task(async function setDevicePixelRatio({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio_orig = await getContentDPR();

  const overrideSettings = {
    width: layoutViewport.clientWidth,
    height: layoutViewport.clientHeight,
    deviceScaleFactor: ratio_orig * 2,
  };

  // Set a custom pixel ratio
  await Emulation.setDeviceMetricsOverride(overrideSettings);
  await loadURL(DOC_SMALL);

  is(await getContentDPR(), ratio_orig * 2, "Expected device pixel ratio set");
});

add_task(async function failsWithNegativeRatio({ client }) {
  const { Emulation, Page } = client;

  await loadURL(DOC_SMALL);
  const { layoutViewport } = await Page.getLayoutMetrics();
  const ratio = await getContentDPR();

  const overrideSettings = {
    width: Math.floor(layoutViewport.clientHeight / 2),
    height: Math.floor(layoutViewport.clientHeight / 3),
    deviceScaleFactor: -1,
  };

  let errorThrown = false;
  try {
    await Emulation.setDeviceMetricsOverride(overrideSettings);
  } catch (e) {
    errorThrown = true;
  }
  ok(errorThrown, "Negative device scale factor raised error");

  await loadURL(DOC_SMALL);
  const updatedLayoutMetrics = await Page.getLayoutMetrics();

  is(
    updatedLayoutMetrics.layoutViewport.clientWidth,
    layoutViewport.clientWidth,
    "Visible layout width hasn't been changed"
  );
  is(
    updatedLayoutMetrics.layoutViewport.clientHeight,
    layoutViewport.clientHeight,
    "Visible layout height hasn't been changed"
  );
  is(await getContentDPR(), ratio, "Device pixel ratio hasn't been changed");
});