feat: implement device pixel ratio changes (#1422)

GoogleChromeLabs · Oct 12, 2023 · 49f6dee · 49f6dee
1 parent 19fe3cc
commit 49f6dee
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 8 deletions.
diff --git a/src/bidiMapper/domains/context/BrowsingContextImpl.ts b/src/bidiMapper/domains/context/BrowsingContextImpl.ts
@@ -678,8 +678,11 @@ export class BrowsingContextImpl {
     };
   }
 
-  async setViewport(viewport: BrowsingContext.Viewport | null) {
-    if (viewport === null) {
+  async setViewport(
+    viewport: BrowsingContext.Viewport | null,
+    devicePixelRatio?: number | null
+  ) {
+    if (viewport === null && devicePixelRatio === null) {
       await this.#cdpTarget.cdpClient.sendCommand(
         'Emulation.clearDeviceMetricsOverride'
       );
@@ -688,9 +691,9 @@ export class BrowsingContextImpl {
         await this.#cdpTarget.cdpClient.sendCommand(
           'Emulation.setDeviceMetricsOverride',
           {
-            width: viewport.width,
-            height: viewport.height,
-            deviceScaleFactor: 0,
+            width: viewport ? viewport.width : 0,
+            height: viewport ? viewport.height : 0,
+            deviceScaleFactor: devicePixelRatio ? devicePixelRatio : 0,
             mobile: false,
             dontSetVisibleSize: true,
           }

diff --git a/src/bidiMapper/domains/context/BrowsingContextProcessor.ts b/src/bidiMapper/domains/context/BrowsingContextProcessor.ts
@@ -185,7 +185,7 @@ export class BrowsingContextProcessor {
         'Emulating viewport is only supported on the top-level context'
       );
     }
-    await context.setViewport(params.viewport);
+    await context.setViewport(params.viewport, params.devicePixelRatio);
     return {};
   }
 

diff --git a/src/protocol-parser/webdriver-bidi.ts b/src/protocol-parser/webdriver-bidi.ts
@@ -616,6 +616,7 @@ export namespace BrowsingContext {
     z.object({
       context: BrowsingContext.BrowsingContextSchema,
       viewport: z.union([BrowsingContext.ViewportSchema, z.null()]),
+      devicePixelRatio: z.union([z.number().gt(0), z.null()]).optional(),
     })
   );
 }

diff --git a/src/protocol/webdriver-bidi.ts b/src/protocol/webdriver-bidi.ts
@@ -516,6 +516,7 @@ export namespace BrowsingContext {
   export type SetViewportParameters = {
     context: BrowsingContext.BrowsingContext;
     viewport: BrowsingContext.Viewport | null;
+    devicePixelRatio?: number | null;
   };
 }
 export namespace BrowsingContext {

diff --git a/tests/browsing_context/test_set_viewport.py b/tests/browsing_context/test_set_viewport.py
@@ -29,7 +29,8 @@ async def test_set_viewport(websocket, context_id, html):
                 "viewport": {
                     "width": 300,
                     "height": 300,
-                }
+                },
+                "devicePixelRatio": None
             }
         })
 
@@ -55,6 +56,39 @@ async def test_set_viewport(websocket, context_id, html):
     }]] == result["result"]["value"]
 
 
+@pytest.mark.asyncio
+async def test_set_viewport_dpr(websocket, context_id, html):
+    await goto_url(websocket, context_id, html())
+
+    await execute_command(
+        websocket, {
+            "method": "browsingContext.setViewport",
+            "params": {
+                "context": context_id,
+                "viewport": None,
+                "devicePixelRatio": 4,
+            }
+        })
+
+    result = await execute_command(
+        websocket, {
+            "method": "script.evaluate",
+            "params": {
+                "expression": "({'devicePixelRatio': window.devicePixelRatio})",
+                "target": {
+                    "context": context_id
+                },
+                "resultOwnership": "none",
+                "awaitPromise": True
+            }
+        })
+
+    assert [["devicePixelRatio", {
+        "type": "number",
+        "value": 4
+    }]] == result["result"]["value"]
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("width,height", [
     (300, 10000001),
@@ -85,6 +119,7 @@ async def test_set_viewport_unsupported(websocket, context_id, html, width,
                     "viewport": {
                         "width": width,
                         "height": height,
-                    }
+                    },
+                    "devicePixelRatio": None
                 }
             })