Look for "CHROME_PATH" env variable to find binaries [ci skip]

Author: gsouf

CHANGELOG.md

@@ -19,6 +19,7 @@
     
 * Features:
   * Added option ``windowSize`` in BrowserFactory
+  * Added methods ``Page::setViewportSize`` and ``Page::setDeviceMetricsOverride``
 
 ## 0.2.0
 

README.md

@@ -135,7 +135,7 @@ Here are the options available for the browser factory:
 | headless           | true                  | Enable or disable headless mode                                                 |
 | userDataDir        | none                  | chrome user data dir (default: a new empty dir is generated temporarily)        |
 | startupTimeout     | 30                    | Maximum time in seconds to wait for chrome to start                             |
-| windowSize         | -                     | Size of the window. Must be an array of 2 number ``[$width, $height]``          |
+| windowSize         | -                     | Size of the window. usage: ``[$width, $height]`` - see also Page::setViewportSize |
 
 ### Browser API
 
@@ -223,6 +223,17 @@ You can achieve this by using ``$page->evaluate('some js that will reload the pa
 An example is available in [form-submit.php](./examples/form-submit.php)
 
 
+#### Set viewport size
+
+This features allows to change the size of the viewport (emulation) for the current page without affecting the size of 
+all the browser's pages (see also option ``"windowSize"`` of [BrowserFactory::createBrowser](#options)).
+
+```php
+    $width = 600;
+    $height = 300;
+    $page->setViewportSize($width, $height)
+        ->await(); // wait for operation to complete
+```
 
 #### Make a screenshot
 

src/Page.php

@@ -16,6 +16,7 @@
 use HeadlessChromium\PageUtils\PageEvaluation;
 use HeadlessChromium\PageUtils\PageNavigation;
 use HeadlessChromium\PageUtils\PageScreenshot;
+use HeadlessChromium\PageUtils\ResponseWaiter;
 
 class Page
 {
@@ -278,6 +279,60 @@ public function screenshot(array $options = []): PageScreenshot
         return new PageScreenshot($responseReader);
     }
 
+    /**
+     * Allows to change viewport size, enabling mobile mode, or changing the scale factor
+     *
+     * usage:
+     *
+     * ```
+     * $page->setDeviceMetricsOverride
+     * ```
+     * @param $overrides
+     * @throws CommunicationException
+     * @throws NoResponseAvailable
+     *
+     * @return ResponseWaiter
+     *
+     */
+    public function setDeviceMetricsOverride(array $overrides)
+    {
+        if (!array_key_exists('width', $overrides)) {
+            $overrides['width'] = 0;
+        }
+        if (!array_key_exists('height', $overrides)) {
+            $overrides['height'] = 0;
+        }
+        if (!array_key_exists('deviceScaleFactor', $overrides)) {
+            $overrides['deviceScaleFactor'] = 0;
+        }
+        if (!array_key_exists('mobile', $overrides)) {
+            $overrides['mobile'] = false;
+        }
+
+        $this->assertNotClosed();
+        return new ResponseWaiter($this->getSession()->sendMessage(
+            new Message('Emulation.setDeviceMetricsOverride', $overrides)
+        ));
+    }
+
+    /**
+     * Set viewport size
+     *
+     * @param int $width
+     * @param int $height
+     * @throws CommunicationException
+     * @throws NoResponseAvailable
+     *
+     * @return ResponseWaiter
+     */
+    public function setViewport(int $width, int $height)
+    {
+        return $this->setDeviceMetricsOverride([
+            'width' => $width,
+            'height' => $height
+        ]);
+    }
+
     /**
      * Request to close the page
      * @throws CommunicationException

src/PageUtils/ResponseWaiter.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * @license see LICENSE
+ */
+
+namespace HeadlessChromium\PageUtils;
+
+use HeadlessChromium\Communication\ResponseReader;
+
+class ResponseWaiter
+{
+
+    /**
+     * @var ResponseReader
+     */
+    protected $responseReader;
+
+    /**
+     * @param ResponseReader $responseReader
+     */
+    public function __construct(ResponseReader $responseReader)
+    {
+        $this->responseReader = $responseReader;
+    }
+
+    /**
+     * @param $time
+     * @throws \HeadlessChromium\Exception\NoResponseAvailable
+     * @throws \HeadlessChromium\Exception\OperationTimedOut
+     */
+    public function await(int $time = null)
+    {
+        $this->responseReader->waitForResponse($time);
+    }
+
+    /**
+     * @return ResponseReader
+     */
+    public function getResponseReader(): ResponseReader
+    {
+        return $this->responseReader;
+    }
+}

test/suites/PageTest.php

@@ -5,6 +5,7 @@
 
 namespace HeadlessChromium\Test;
 
+use HeadlessChromium\BrowserFactory;
 use HeadlessChromium\Communication\Connection;
 use HeadlessChromium\Communication\Session;
 use HeadlessChromium\Communication\Socket\MockSocket;
@@ -26,4 +27,21 @@ public function testPage()
 
         $this->assertSame($session, $page->getSession());
     }
+
+    public function testSetViewport()
+    {
+        $factory = new BrowserFactory();
+
+        $browser = $factory->createBrowser([
+            'windowSize' => [500, 500]
+        ]);
+
+        $page = $browser->createPage();
+
+        $page->setViewport(100, 300)->await();
+
+        $response = $page->evaluate('[window.innerWidth, window.innerHeight]')->getReturnValue();
+
+        $this->assertEquals([100, 300], $response);
+    }
 }