add ProcessAwareBrowser::getSocketUri #42

Author: gsouf

CHANGELOG.md

@@ -16,9 +16,10 @@
 > *20xx-xx-xx* (not released)
 
 > Make a crawl instance sharable among multiple scripts
-    
+
 * Features:
   * Added option ``keepAlive`` for browser factory.
+  * Added methods ``BrowserProcess::getSocketUri`` and ``ProcessAwareBrowser::getSocketUri``
 * Bug fixes:
   * none
 

src/Browser/BrowserProcess.php

@@ -63,6 +63,11 @@ class BrowserProcess implements LoggerAwareInterface
      */
     protected $wasStarted = false;
 
+    /**
+     * @var string
+     */
+    protected $wsUri;
+
     /**
      * BrowserProcess constructor.
      * @param LoggerInterface $logger
@@ -122,13 +127,13 @@ public function start($binaries, $options)
 
         // wait for start and retrieve ws uri
         $startupTimeout = $options['startupTimeout'] ?? 30;
-        $ws = $this->waitForStartup($process, $startupTimeout * 1000 * 1000);
+        $this->wsUri = $this->waitForStartup($process, $startupTimeout * 1000 * 1000);
 
         // log
-        $this->logger->debug('process: connecting using ' . $ws);
+        $this->logger->debug('process: connecting using ' . $this->wsUri);
 
         // connect to browser
-        $connection = new Connection($ws, $this->logger, $options['sendSyncDefaultTimeout'] ?? 3000);
+        $connection = new Connection($this->wsUri, $this->logger, $options['sendSyncDefaultTimeout'] ?? 3000);
         $connection->connect();
 
         // connection delay
@@ -154,6 +159,14 @@ public function getBrowser()
         return $this->browser;
     }
 
+    /**
+     * @return string
+     */
+    public function getSocketUri()
+    {
+        return $this->wsUri;
+    }
+
     /**
      * Kills the process and clean temporary files
      * @throws OperationTimedOut

src/Browser/ProcessAwareBrowser.php

@@ -31,4 +31,12 @@ public function close()
     {
         $this->browserProcess->kill();
     }
+
+    /**
+     * @return string
+     */
+    public function getSocketUri()
+    {
+        return $this->browserProcess->getSocketUri();
+    }
 }

src/BrowserFactory.php

@@ -7,6 +7,7 @@
 
 use Apix\Log\Logger\Stream as StreamLogger;
 use HeadlessChromium\Browser\BrowserProcess;
+use HeadlessChromium\Browser\ProcessAwareBrowser;
 use Symfony\Component\Process\Process;
 
 class BrowserFactory
@@ -50,9 +51,9 @@ public function __construct(string $chromeBinaries = null)
      * - userDataDir: chrome user data dir (default: a new empty dir is generated temporarily)
      * - windowSize: size of the window, ex: [1920, 1080] (default: none)
      *
-     * @return Browser a Browser instance to interact with the new chrome process
+     * @return ProcessAwareBrowser a Browser instance to interact with the new chrome process
      */
-    public function createBrowser(array $options = []): Browser
+    public function createBrowser(array $options = []): ProcessAwareBrowser
     {
 
         // prepare logger

test/suites/BrowserFactoryTest.php

@@ -43,4 +43,13 @@ public function testUserAgentOption()
 
         $this->assertEquals('foo bar baz', $response);
     }
+
+    public function testBrowserFactory()
+    {
+        $factory = new BrowserFactory();
+
+        $browser = $factory->createBrowser();
+
+        $this->assertRegExp('#^ws://#', $browser->getSocketUri());
+    }
 }