Merge branch '1.12' into fix/dom-node-id-refresh

.github/workflows/tests.yml

@@ -27,6 +27,10 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v4
 
+      - uses: browser-actions/setup-chrome@v1
+        with:
+          chrome-version: 122
+
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -81,4 +85,4 @@ jobs:
       - name: Execute PHPUnit
         run: vendor/bin/phpunit
         env:
-          CHROME_PATH: google-chrome-stable
+          CHROME_PATH: /opt/hostedtoolcache/setup-chrome/chromium/122.0.6261.128/x64/chrome

src/Browser.php

@@ -98,7 +98,7 @@ public function getConnection(): Connection
      *
      * @param string|null $script
      */
-    public function setPagePreScript(string $script = null): void
+    public function setPagePreScript(?string $script = null): void
     {
         $this->pagePreScript = $script;
     }

src/Browser/BrowserProcess.php

@@ -78,7 +78,7 @@ class BrowserProcess implements LoggerAwareInterface
      *
      * @param LoggerInterface|null $logger
      */
-    public function __construct(LoggerInterface $logger = null)
+    public function __construct(?LoggerInterface $logger = null)
     {
         // set or create logger
         $this->setLogger($logger ?? new NullLogger());

src/BrowserFactory.php

@@ -50,7 +50,7 @@ class BrowserFactory
      */
     protected $options = [];
 
-    public function __construct(string $chromeBinary = null)
+    public function __construct(?string $chromeBinary = null)
     {
         $this->chromeBinary = $chromeBinary ?? (new AutoDiscover())->guessChromeBinaryPath();
     }

src/Clip.php

@@ -13,20 +13,23 @@
 
 class Clip
 {
+    /** @var int|float */
     protected $x;
+    /** @var int|float */
     protected $y;
+    /** @var int|float */
     protected $height;
+    /** @var int|float */
     protected $width;
+    /** @var float */
     protected $scale;
 
     /**
-     * Clip constructor.
-     *
-     * @param int   $x
-     * @param int   $y
-     * @param int   $height
-     * @param int   $width
-     * @param float $scale
+     * @param int|float $x
+     * @param int|float $y
+     * @param int|float $height
+     * @param int|float $width
+     * @param float     $scale
      */
     public function __construct($x, $y, $width, $height, $scale = 1.0)
     {
@@ -38,79 +41,79 @@ public function __construct($x, $y, $width, $height, $scale = 1.0)
     }
 
     /**
-     * @return mixed
+     * @return int|float
      */
     public function getX()
     {
         return $this->x;
     }
 
     /**
-     * @return mixed
+     * @return int|float
      */
     public function getY()
     {
         return $this->y;
     }
 
     /**
-     * @return mixed
+     * @return int|float
      */
     public function getHeight()
     {
         return $this->height;
     }
 
     /**
-     * @return mixed
+     * @return int|float
      */
     public function getWidth()
     {
         return $this->width;
     }
 
     /**
-     * @return mixed
+     * @return float
      */
     public function getScale()
     {
         return $this->scale;
     }
 
     /**
-     * @param mixed $x
+     * @param int|float $x
      */
     public function setX($x): void
     {
         $this->x = $x;
     }
 
     /**
-     * @param mixed $y
+     * @param int|float $y
      */
     public function setY($y): void
     {
         $this->y = $y;
     }
 
     /**
-     * @param mixed $height
+     * @param int $height
      */
     public function setHeight($height): void
     {
         $this->height = $height;
     }
 
     /**
-     * @param mixed $width
+     * @param int $width
      */
     public function setWidth($width): void
     {
         $this->width = $width;
     }
 
     /**
-     * @param mixed $scale
+     * @param float $scale
      */
     public function setScale($scale): void
     {

src/Communication/Connection.php

@@ -98,7 +98,7 @@ class Connection extends EventEmitter implements LoggerAwareInterface
      * @param SocketInterface|string $socketClient
      * @param int|null               $sendSyncDefaultTimeout
      */
-    public function __construct($socketClient, LoggerInterface $logger = null, int $sendSyncDefaultTimeout = null)
+    public function __construct($socketClient, ?LoggerInterface $logger = null, ?int $sendSyncDefaultTimeout = null)
     {
         // set or create logger
         $this->setLogger($logger ?? new NullLogger());
@@ -266,7 +266,7 @@ public function sendMessage(Message $message): ResponseReader
      *
      * @return Response
      */
-    public function sendMessageSync(Message $message, int $timeout = null): Response
+    public function sendMessageSync(Message $message, ?int $timeout = null): Response
     {
         $responseReader = $this->sendMessage($message);
         $response = $responseReader->waitForResponse($timeout);
@@ -370,7 +370,7 @@ public function processAllEvents(): void
      *
      * @internal
      */
-    private function dispatchMessage(string $message, Session $session = null)
+    private function dispatchMessage(string $message, ?Session $session = null)
     {
         // responses come as json string
         $response = \json_decode($message, true);

src/Communication/ResponseReader.php

@@ -103,7 +103,7 @@ public function getResponse(): Response
      *
      * @return Response
      */
-    public function waitForResponse(int $timeout = null): Response
+    public function waitForResponse(?int $timeout = null): Response
     {
         if ($this->hasResponse()) {
             return $this->getResponse();

src/Communication/Session.php

@@ -82,7 +82,7 @@ public function sendMessage(Message $message): ResponseReader
      *
      * @return Response
      */
-    public function sendMessageSync(Message $message, int $timeout = null): Response
+    public function sendMessageSync(Message $message, ?int $timeout = null): Response
     {
         $responseReader = $this->sendMessage($message);
 

src/Communication/Socket/Wrench.php

@@ -44,7 +44,7 @@ class Wrench implements SocketInterface, LoggerAwareInterface, WaitForDataInterf
     /**
      * @param WrenchClient $client
      */
-    public function __construct(WrenchClient $client, LoggerInterface $logger = null)
+    public function __construct(WrenchClient $client, ?LoggerInterface $logger = null)
     {
         $this->client = $client;
 

src/Cookies/CookiesCollection.php

@@ -21,7 +21,7 @@ class CookiesCollection implements \IteratorAggregate, \Countable
     /**
      * CookiesCollection constructor.
      */
-    public function __construct(array $cookies = null)
+    public function __construct(?array $cookies = null)
     {
         if ($cookies) {
             foreach ($cookies as $cookie) {

src/Dom/Node.php

@@ -4,6 +4,7 @@
 
 namespace HeadlessChromium\Dom;
 
+use HeadlessChromium\Clip;
 use HeadlessChromium\Communication\Message;
 use HeadlessChromium\Communication\Response;
 use HeadlessChromium\Exception\DomException;
@@ -199,7 +200,7 @@ public function click(): void
         $this->scrollIntoView();
         $position = $this->getPosition();
         $this->page->mouse()
-            ->move($position->getCenterX(), $position->getCenterY())
+            ->move((int) $position->getCenterX(), (int) $position->getCenterY())
             ->click();
     }
 
@@ -237,6 +238,22 @@ public function assertNotError(Response $response): void
         }
     }
 
+    public function getClip(): ?Clip
+    {
+        $position = $this->getPosition();
+
+        if (!$position) {
+            return null;
+        }
+
+        return new Clip(
+            $position->getX(),
+            $position->getY(),
+            $position->getWidth(),
+            $position->getHeight(),
+        );
+    }
+
     protected function prepareForRequest(): void
     {
         $this->page->assertNotClosed();

src/Dom/NodePosition.php

@@ -37,40 +37,40 @@ public function __construct(array $points)
         $leftBottomX = $points[6];
         $leftBottomY = $points[7];
 
-        $this->x = $leftTopX;
-        $this->y = $leftTopY;
+        $this->x = (float) $leftTopX;
+        $this->y = (float) $leftTopY;
 
-        $this->height = $leftBottomY - $leftTopY;
-        $this->width = $rightBottomX - $leftBottomX;
+        $this->height = (float) ($leftBottomY - $leftTopY);
+        $this->width = (float) ($rightBottomX - $leftBottomX);
     }
 
-    public function getX(): int
+    public function getX(): float
     {
-        return (int) $this->x;
+        return $this->x;
     }
 
-    public function getY(): int
+    public function getY(): float
     {
-        return (int) $this->y;
+        return $this->y;
     }
 
-    public function getWidth(): int
+    public function getWidth(): float
     {
-        return (int) $this->width;
+        return $this->width;
     }
 
-    public function getHeight(): int
+    public function getHeight(): float
     {
-        return (int) $this->height;
+        return $this->height;
     }
 
-    public function getCenterX(): int
+    public function getCenterX(): float
     {
-        return (int) ($this->x + ($this->width / 2));
+        return $this->x + ($this->width / 2);
     }
 
-    public function getCenterY(): int
+    public function getCenterY(): float
     {
-        return (int) ($this->y + ($this->height / 2));
+        return $this->y + ($this->height / 2);
     }
 }

src/Input/Keyboard.php

@@ -180,7 +180,7 @@ public function press(string $key): self
      *
      * @return $this
      */
-    public function release(string $key = null): self
+    public function release(?string $key = null): self
     {
         $this->page->assertNotClosed();
 

src/Input/Mouse.php

@@ -54,7 +54,7 @@ public function __construct(Page $page)
      *
      * @return $this
      */
-    public function move(int $x, int $y, array $options = null)
+    public function move(int $x, int $y, ?array $options = null)
     {
         $this->page->assertNotClosed();
 
@@ -88,7 +88,7 @@ public function move(int $x, int $y, array $options = null)
      * @throws \HeadlessChromium\Exception\CommunicationException
      * @throws \HeadlessChromium\Exception\NoResponseAvailable
      */
-    public function press(array $options = null)
+    public function press(?array $options = null)
     {
         $this->page->assertNotClosed();
         $this->page->getSession()->sendMessageSync(new Message('Input.dispatchMouseEvent', [
@@ -106,7 +106,7 @@ public function press(array $options = null)
      * @throws \HeadlessChromium\Exception\CommunicationException
      * @throws \HeadlessChromium\Exception\NoResponseAvailable
      */
-    public function release(array $options = null)
+    public function release(?array $options = null)
     {
         $this->page->assertNotClosed();
         $this->page->getSession()->sendMessageSync(new Message('Input.dispatchMouseEvent', [
@@ -126,7 +126,7 @@ public function release(array $options = null)
      * @throws \HeadlessChromium\Exception\CommunicationException
      * @throws \HeadlessChromium\Exception\NoResponseAvailable
      */
-    public function click(array $options = null)
+    public function click(?array $options = null)
     {
         $this->press($options);
         $this->release($options);