Skip to content

Add Page::waitForDownload() and download events - #211

Merged
smnandre merged 3 commits into
playwright-php:mainfrom
smnandre:feat/download-api
Nov 15, 2026
Merged

smnandre merged 3 commits into
playwright-php:mainfrom
smnandre:feat/download-api

Conversation

@smnandre

Copy link
Copy Markdown
Member

Page::waitForDownload(callable $action, $options) returns the Download started by the action. It starts waiting for the download before it runs the action, like waitForPopup(). events()->onDownload() receives every download a page starts. A download seen by both APIs keeps the same id.

Each download can be used through path(), saveAs(), failure(), cancel(), delete() and createReadStream(), until its browser context closes.

smnandre added a commit to smnandre/playwright that referenced this pull request Nov 12, 2026
@codecov

codecov Bot commented Nov 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Download had no producer: no wait API, no bridge handler for
page.waitForDownload and no download.* commands, so a PHP caller could
not learn that a download happened.

waitForDownload() arms page.waitForEvent('download') before running the
action, through the same callback coordination as waitForPopup(). The
bridge keeps each download until its context closes and serves path,
saveAs, failure, cancel, delete and readStream. failure() now reads its
own key, since the transport treats "error" as a failed command.
The bridge now forwards the page download event with the id, suggested
filename and url of the download, so events()->onDownload() receives a
Download for each one. A download seen by both the event and
waitForDownload() keeps a single id.

Depends on Page::waitForDownload(), which adds the download commands.
@smnandre
smnandre merged commit 7c82440 into playwright-php:main Nov 15, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant