Enhance Playwright integration with new response handling and file upload features (#7)

Author: smnandre

bin/playwright-server.js

@@ -153,13 +153,16 @@ class PlaywrightServer {
     this.browsers = new Map();
     this.contexts = new Map();
     this.pages = new Map();
+    this.pageContexts = new Map();
     this.responses = new Map();
     this.browserCounter = 0;
     this.contextCounter = 0;
     this.pageCounter = 0;
     this.responseCounter = 0;
     this.routes = new Map();
     this.routeCounter = 0;
+    this.contextThrottling = new Map();
+    this.dialogs = new Map();
     this.elementHandleCounter = 0;
     this.elementHandles = new Map();
   }
@@ -222,6 +225,9 @@ class PlaywrightServer {
     if (actionPrefix === 'route') {
       return await this.handleRouteCommand(command, actionMethod);
     }
+    if (actionPrefix === 'response') {
+      return await this.handleResponseCommand(command, actionMethod);
+    }
     if (actionPrefix === 'mouse') {
       return await this.handleMouseCommand(command, actionMethod);
     }
@@ -289,10 +295,22 @@ class PlaywrightServer {
       case 'stopTracing':
         await context.tracing.stop({ path: command.path });
         return {success: true};
+      case 'waitForEvent':
+        await context.waitForEvent(command.event, { timeout: command.timeout });
+        return {success: true};
+      case 'setNetworkThrottling':
+        if (command.throttling && typeof command.throttling === 'object') {
+          this.contextThrottling.set(command.contextId, {
+            latency: Number(command.throttling.latency) || 0,
+            downloadThroughput: Number(command.throttling.downloadThroughput) || 0,
+            uploadThroughput: Number(command.throttling.uploadThroughput) || 0,
+          });
+        }
+        return {success: true};
       case 'route':
         await context.route(command.url, async (route) => {
           const routeId = `route_${++this.routeCounter}`;
-          this.routes.set(routeId, route);
+          this.routes.set(routeId, { route, contextId: command.contextId });
 
           const req = route.request();
           let postData = null;
@@ -326,6 +344,62 @@ class PlaywrightServer {
         const page = await context.newPage(command.options);
         const pageId = `page_${++this.pageCounter}`;
         this.pages.set(pageId, page);
+        this.pageContexts.set(pageId, command.contextId);
+
+        // Forward important page events
+        page.on('console', (msg) => {
+          const params = {
+            type: msg.type(),
+            text: msg.text(),
+            args: [],
+            location: msg.location ? msg.location() : {},
+          };
+          sendFramedResponse({ objectId: pageId, event: 'console', params });
+        });
+
+        page.on('dialog', (dialog) => {
+          const dialogId = `dialog_${Date.now()}_${Math.floor(Math.random()*1000)}`;
+          this.dialogs.set(dialogId, dialog);
+          const params = {
+            dialogId,
+            type: dialog.type(),
+            message: dialog.message(),
+            defaultValue: dialog.defaultValue ? dialog.defaultValue() : null,
+          };
+          sendFramedResponse({ objectId: pageId, event: 'dialog', params });
+        });
+
+        page.on('request', (req) => {
+          const params = {
+            request: {
+              url: req.url(),
+              method: req.method(),
+              headers: req.headers(),
+              postData: (() => { try { return req.postData(); } catch { return null; } })(),
+              resourceType: req.resourceType ? req.resourceType() : 'document',
+            }
+          };
+          sendFramedResponse({ objectId: pageId, event: 'request', params });
+        });
+
+        page.on('response', (res) => {
+          const params = { response: this.serializeResponse(res) };
+          sendFramedResponse({ objectId: pageId, event: 'response', params });
+        });
+
+        page.on('requestfailed', (req) => {
+          const params = {
+            request: {
+              url: req.url(),
+              method: req.method(),
+              headers: req.headers(),
+              postData: (() => { try { return req.postData(); } catch { return null; } })(),
+              resourceType: req.resourceType ? req.resourceType() : 'document',
+            }
+          };
+          sendFramedResponse({ objectId: pageId, event: 'requestfailed', params });
+        });
+
         return {pageId: pageId};
       case 'cookies':
         return {cookies: await context.cookies(command.urls)};
@@ -439,10 +513,22 @@ class PlaywrightServer {
       case 'addStyleTag':
         await page.addStyleTag(command.options);
         return {success: true};
+      case 'handleDialog':
+        const dialog = this.dialogs.get(command.dialogId);
+        if (dialog) {
+          if (command.accept) {
+            await dialog.accept(command.promptText);
+          } else {
+            await dialog.dismiss();
+          }
+          this.dialogs.delete(command.dialogId);
+        }
+        return {success: true};
       case 'route':
         await page.route(command.url, async (route) => {
           const routeId = `route_${++this.routeCounter}`;
-          this.routes.set(routeId, route);
+          const contextId = this.pageContexts.get(command.pageId);
+          this.routes.set(routeId, { route, contextId });
 
           const req = route.request();
           let postData = null;
@@ -547,6 +633,9 @@ class PlaywrightServer {
       case 'screenshot':
         const buffer = await locator.screenshot(command.options);
         return {binary: buffer.toString('base64')};
+      case 'setInputFiles':
+        await locator.setInputFiles(command.files, command.options);
+        return;
       case 'evaluate':
         try {
           const count = await locator.count();
@@ -596,8 +685,9 @@ class PlaywrightServer {
   }
 
   async handleRouteCommand(command, method) {
-    const route = this.routes.get(command.routeId);
-    if (!route) throw new Error(`Route not found: ${command.routeId}`);
+    const info = this.routes.get(command.routeId);
+    if (!info) throw new Error(`Route not found: ${command.routeId}`);
+    const route = info.route || info;
 
     switch (method) {
       case 'fulfill':
@@ -610,6 +700,13 @@ class PlaywrightServer {
         break;
       case 'continue':
         debugLogger.info('ROUTE CONTINUE', { routeId: command.routeId });
+        try {
+          const ctxId = info.contextId;
+          const throttle = ctxId ? this.contextThrottling.get(ctxId) : null;
+          if (throttle && throttle.latency && throttle.latency > 0) {
+            await new Promise(r => setTimeout(r, throttle.latency));
+          }
+        } catch {}
         await route.continue(command.options || undefined);
         break;
       default:
@@ -618,6 +715,18 @@ class PlaywrightServer {
     this.routes.delete(command.routeId);
   }
 
+  async handleResponseCommand(command, method) {
+    switch (method) {
+      case 'body':
+        const res = this.responses.get(command.responseId);
+        if (!res) throw new Error(`Response not found: ${command.responseId}`);
+        const buf = await res.body();
+        return { binary: Buffer.from(buf).toString('base64') };
+      default:
+        throw new Error(`Unknown response action: ${method}`);
+    }
+  }
+
   async handleMouseCommand(command, method) {
     const page = this.pages.get(command.pageId);
     if (!page) throw new Error(`Page not found: ${command.pageId}`);

src/Browser/BrowserType.php

@@ -15,7 +15,7 @@
  */
 enum BrowserType: string
 {
-    case Chrome = 'chrome';
-    case Firefox = 'firefox';
-    case Safari = 'safari';
+    case CHROMIUM = 'chromium';
+    case FIREFOX = 'firefox';
+    case WEBKIT = 'webkit';
 }

src/Configuration/BrowserType.php

@@ -10,6 +10,7 @@
 
 namespace PlaywrightPHP\Configuration;
 
+use PlaywrightPHP\Browser\BrowserType;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -31,7 +32,7 @@ final class PlaywrightConfig
      */
     public function __construct(
         public readonly ?string $nodePath = null,
-        public readonly string $minNodeVersion = '18.0.0',
+        public readonly string $minNodeVersion = '20.0.0',
 
         public readonly BrowserType $browser = BrowserType::CHROMIUM,
         public readonly ?string $channel = null,

src/Configuration/PlaywrightConfig.php

@@ -10,6 +10,7 @@
 
 namespace PlaywrightPHP\Configuration;
 
+use PlaywrightPHP\Browser\BrowserType;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -19,14 +20,14 @@
  * - Browser: chromium
  * - Headless: true
  * - Timeout: 30s
- * - Node min version: 18.0.0
+ * - Node min version: 20.0.0
  *
  * @author Simon André <smn.andre@gmail.com>
  */
 final class PlaywrightConfigBuilder
 {
     private ?string $nodePath = null;
-    private string $minNodeVersion = '18.0.0';
+    private string $minNodeVersion = '20.0.0';
 
     private BrowserType $browser = BrowserType::CHROMIUM;
     private ?string $channel = null;

src/Configuration/PlaywrightConfigBuilder.php

@@ -23,7 +23,7 @@
  */
 final class NodeBinaryResolver implements NodeBinaryResolverInterface
 {
-    private const string DEFAULT_MIN_VERSION = '18.0.0';
+    private const string DEFAULT_MIN_VERSION = '20.0.0';
 
     private ?string $cached = null;
 

src/Node/NodeBinaryResolver.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the playwright-php/playwright package.
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace PlaywrightPHP\Tests\Integration\Input;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use PlaywrightPHP\Locator\Locator;
+use PlaywrightPHP\Page\Page;
+use PlaywrightPHP\Testing\PlaywrightTestCaseTrait;
+use PlaywrightPHP\Tests\Support\RouteServerTestTrait;
+
+#[CoversClass(Page::class)]
+#[CoversClass(Locator::class)]
+final class FileUploadIntegrationTest extends TestCase
+{
+    use PlaywrightTestCaseTrait;
+    use RouteServerTestTrait;
+
+    private string $tempFile = '';
+
+    public function setUp(): void
+    {
+        $this->setUpPlaywright();
+
+        // Create a small temporary file to upload
+        $this->tempFile = tempnam(sys_get_temp_dir(), 'pwphp_upload_') ?: sys_get_temp_dir().'/pwphp_upload.txt';
+        file_put_contents($this->tempFile, 'upload-content');
+
+        $this->installRouteServer($this->page, [
+            '/index.html' => <<<'HTML'
+                <h1>Upload Test</h1>
+                <input type="file" id="file" />
+                <script>
+                    const input = document.getElementById('file');
+                    input.addEventListener('change', (e) => {
+                        const file = e.target.files && e.target.files[0];
+                        document.body.dataset.filename = file ? file.name : '';
+                    });
+                </script>
+            HTML,
+        ]);
+        $this->page->goto($this->routeUrl('/index.html'));
+    }
+
+    public function tearDown(): void
+    {
+        if ($this->tempFile && file_exists($this->tempFile)) {
+            @unlink($this->tempFile);
+        }
+        $this->tearDownPlaywright();
+    }
+
+    #[Test]
+    public function itUploadsAFileWithPageHelper(): void
+    {
+        $this->page->setInputFiles('#file', [$this->tempFile]);
+        usleep(100000);
+
+        $name = $this->page->evaluate('() => document.body.dataset.filename');
+        $this->assertSame(basename($this->tempFile), $name);
+    }
+
+    #[Test]
+    public function itUploadsAFileWithLocator(): void
+    {
+        $this->page->locator('#file')->setInputFiles([$this->tempFile]);
+        usleep(100000);
+
+        $name = $this->page->evaluate('() => document.body.dataset.filename');
+        $this->assertSame(basename($this->tempFile), $name);
+    }
+}