Repository navigation
Add Page::waitForDownload() and download events - #211
Merged
Merged
Conversation
smnandre
added a commit
to smnandre/playwright
that referenced
this pull request
Nov 12, 2026
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
force-pushed
the
feat/download-api
branch
from
November 15, 2026 00:00
a8ce3dd to
fcd5e00
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Page::waitForDownload(callable $action, $options)returns theDownloadstarted by the action. It starts waiting for the download before it runs the action, likewaitForPopup().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()andcreateReadStream(), until its browser context closes.