Merge pull request #4 from clemblanco/click-poc

feat: PoC for clicking a link + asserting new URL

Author: nunomaduro

.gitignore

@@ -16,3 +16,4 @@ node_modules/
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+.temp/e2e

src/Compiler.php

@@ -33,7 +33,7 @@ public function compile(): void
         $content = implode(
             "\n",
             array_map(
-                static fn (Operation $operation): string => $operation->compile(),
+                static fn (Operation $operation): string => "\t{$operation->compile()}",
                 $this->operations,
             ),
         );
@@ -42,7 +42,17 @@ public function compile(): void
             import { test, expect } from '@playwright/test';
 
             test('runtime', async ({ page }) => {
-                $content
+            $content
+
+                const response = await page.reload();
+                test.info().annotations.push({
+                    type: '_response',
+                    description: JSON.stringify({
+                        headers: response.headers(),
+                        status: response.status(),
+                        url: response.url(),
+                    })
+                });
             });
             JS,
         );

src/Operations/AssertUrlIs.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Browser\Operations;
+
+use Pest\Browser\Contracts\Operation;
+
+/**
+ * @internal
+ */
+final readonly class AssertUrlIs implements Operation
+{
+    /**
+     * Creates an operation instance.
+     */
+    public function __construct(
+        private string $url,
+    ) {
+        //
+    }
+
+    public function compile(): string
+    {
+        return sprintf("await expect(page.url()).toBe('%s');", $this->url);
+    }
+}

src/Operations/ClickLink.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Browser\Operations;
+
+use Pest\Browser\Contracts\Operation;
+
+/**
+ * @internal
+ */
+final readonly class ClickLink implements Operation
+{
+    /**
+     * Creates an operation instance.
+     */
+    public function __construct(
+        private string $text,
+    ) {
+        //
+    }
+
+    public function compile(): string
+    {
+        return sprintf("await page.locator('a').filter({ hasText: /%s/i }).click();", $this->text);
+    }
+}

src/PendingTest.php

@@ -4,6 +4,8 @@
 
 namespace Pest\Browser;
 
+use Pest\Browser\ValueObjects\TestResult;
+use Pest\Browser\ValueObjects\TestResultResponse;
 use Pest\Browser\Contracts\Operation;
 
 /**
@@ -46,10 +48,38 @@ public function toHaveTitle(string $title): self
         return $this;
     }
 
+    /**
+     * Clicks some text on the page.
+     */
+    public function clickLink(string $text): self
+    {
+        $this->operations[] = new Operations\ClickLink($text);
+
+        return $this;
+    }
+
+    /**
+     * Checks if the page url is matching.
+     */
+    public function assertUrlIs(string $url): self
+    {
+        $this->operations[] = new Operations\AssertUrlIs($url);
+
+        return $this;
+    }
+
+    /**
+     * Build and return the final response the test received.
+     */
+    public function response(): TestResultResponse
+    {
+        return $this->build()->response();
+    }
+
     /**
      * Compile the JavaScript test file.
      */
-    public function compile(): void
+    public function build(): void
     {
         $compiler = new Compiler($this->operations);
 
@@ -60,5 +90,7 @@ public function compile(): void
         $result = $worker->run();
 
         expect($result->ok())->toBeTrue();
+
+        return $result;
     }
 }

src/ValueObjects/TestResult.php

@@ -14,6 +14,7 @@
      */
     public function __construct(
         private bool $ok,
+        private TestResultResponse $response,
     ) {
         //
     }
@@ -25,4 +26,12 @@ public function ok(): bool
     {
         return $this->ok;
     }
+
+    /**
+     * Get the final response from the test result.
+     */
+    public function response(): TestResultResponse
+    {
+        return $this->response;
+    }
 }

src/ValueObjects/TestResultResponse.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Browser\ValueObjects;
+
+use Pest\Support\Arr;
+
+/**
+ * @internal
+ */
+final readonly class TestResultResponse
+{
+    private array $headers;
+
+    private int $status;
+
+    private string $url;
+
+    /**
+     * The test result response.
+     */
+    public function __construct(array $annotations)
+    {
+        /** @todo would be cleaner with collect() and Str facade */
+        $annotation = Arr::last(array_filter($annotations, function ($annotation) {
+            return Arr::get($annotation, 'type') === '_response';
+        }));
+
+        [
+            'headers' => $this->headers,
+            'status' => $this->status,
+            'url' => $this->url
+        ] = json_decode(Arr::get($annotation, 'description'), true);
+    }
+
+    /**
+     * Get the test result response headers.
+     */
+    public function headers(): array
+    {
+        return $this->headers;
+    }
+
+    /**
+     * Get the test result response status.
+     */
+    public function status(): int
+    {
+        return $this->status;
+    }
+
+    /**
+     * Get the test result response url.
+     */
+    public function url(): string
+    {
+        return $this->url;
+    }
+}

src/Worker.php

@@ -5,6 +5,8 @@
 namespace Pest\Browser;
 
 use Pest\Browser\ValueObjects\TestResult;
+use Pest\Browser\ValueObjects\TestResultResponse;
+use Pest\Support\Arr;
 use Symfony\Component\Process\Process;
 
 /**
@@ -26,6 +28,9 @@ public function run(): TestResult
         // @phpstan-ignore-next-line
         $outputAsArray = json_decode($output, true);
 
-        return new TestResult($outputAsArray['suites'][0]['specs'][0]['ok']);
+        $ok = Arr::get($outputAsArray, 'suites.0.specs.0.ok');
+        $annotations = Arr::get($outputAsArray, 'suites.0.specs.0.tests.0.annotations');
+
+        return new TestResult($ok, new TestResultResponse($annotations));
     }
 }

tests/Example.php

@@ -17,3 +17,16 @@
         ->toHaveTitle('/Framework/')
         ->toHaveTitle('/.*Artisans$/');
 });
+
+it('may click the "get started" button at laravel', function () {
+    visit('https://laravel.com')
+        ->clickLink('Get Started')
+        ->assertUrlIs('https://laravel.com/docs/11.x');
+
+    // -- or --
+
+    $browser = visit('https://laravel.com')
+        ->clickLink('Get Started');
+
+    expect($browser->response()->url())->toBe('https://laravel.com/docs/11.x');
+});