[BUG?] Download promises don't resolve when using Chromium instead of Firefox in headful mode

[klhex]

Context:

• Playwright Version: 1.10.0
• Operating System: Mac
• Node.js version: v15.11.0
• Browser: Chromium, Firefox

Note
This may be related to #3139 (or may even be the same issue, not sure).

Code Snippet

Attempt to download file linked by the following HTML code (href URL shortened):

<div class="o-button-container o-button-container--center u-mb">
  <div class="u-mb-small u-mr-small u-pr-xsmall">
    <a
      href="https://[host].s3.eu-central-1.amazonaws.com/frontend/d8c86afb-091c-4f14-ab33-afd3b7e1a9e1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&[...];X-Amz-SignedHeaders=host"
      target="_blank"
      class="c-btn c-btn--link c-btn--small">
      <i class="c-btn__icon c-icon c-icon--[semantic-forward]"></i>
      <span class="c-btn__text">PDF anzeigen / herunterladen</span></a
    >
  </div>
</div>

This is the Playwright code that seeks to download the above linked file:

const {chromium, webkit, firefox} = require('playwright');

(async () => {
  const browser = await chromium.launch();
  // ...
  const [download] = await Promise.all([
     page.waitForEvent('download'),
     await page.click('text=PDF ANZEIGEN'),
   ]);
   await download.saveAs(
     path.join(__dirname, 'downloads', download.suggestedFilename())
   );
})();

Describe the bug

Expected behavior (works fine when using Firefox):

• File gets downloaded into indicated folder with suggested file name.
• download.saveAs resolves.

Actual behavior (when using Chromium):

• File gets downloaded somewhere (tmp folder?) with GUID as file name.
• download.saveAs does not resolve.

Logs

*** PW API log extract when using Chromium ***

  pw:api => page.waitForEvent started +1ms
  pw:api => page.click started +1ms
  pw:api waiting for event "download" +0ms
  pw:api waiting for selector "text=PDF ANZEIGEN" +1ms
  pw:api   selector resolved to visible <span class="c-btn__text">PDF anzeigen / herunterladen</span> +5s
  pw:api attempting click action +19ms
  pw:api   waiting for element to be visible, enabled and stable +0ms
  pw:api   element is visible, enabled and stable +33ms
  pw:api   scrolling into view if needed +0ms
  pw:api   done scrolling +1ms
  pw:api   checking that element receives pointer events at (606.47,781.53) +0ms
  pw:api   element does receive pointer events +2ms
  pw:api   performing click action +1ms
  pw:api   click action done +109ms
  pw:api   waiting for scheduled navigations to finish +0ms
  pw:api   navigations have finished +123ms
  pw:api <= page.click succeeded +1ms
  pw:api <= page.waitForEvent succeeded +257ms
  pw:api => download.saveAs started +1ms
[then it just keeps waiting for the promise to resolve/reject which doesn't happen...]

*** PW API log extract when using Firefox (URL shortened) ***

  pw:api => page.waitForEvent started +0ms
  pw:api => page.click started +1ms
  pw:api waiting for event "download" +1ms
  pw:api waiting for selector "text=PDF ANZEIGEN" +0ms
  pw:api   selector resolved to visible <span class="c-btn__text">PDF anzeigen / herunterladen</span> +6s
  pw:api attempting click action +20ms
  pw:api   waiting for element to be visible, enabled and stable +1ms
  pw:api   element is visible, enabled and stable +31ms
  pw:api   scrolling into view if needed +0ms
  pw:api   done scrolling +1ms
  pw:api   checking that element receives pointer events at (606.47,780.73) +1ms
  pw:api   element does receive pointer events +2ms
  pw:api   performing click action +1ms
  pw:api   click action done +26ms
  pw:api   waiting for scheduled navigations to finish +0ms
  pw:api   navigations have finished +90ms
  pw:api <= page.click succeeded +1ms
  pw:api   navigated to "about:blank" +111ms
  pw:api <= page.waitForEvent succeeded +136ms
  pw:api => download.saveAs started +1ms
  pw:api   navigated to "https://[host].s3.eu-central-1.amazonaws.com/frontend/d8c86afb-091c-4f14-ab33-afd3b7e1a9e1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&[...];X-Amz-SignedHeaders=host" +2ms
  pw:api   "load" event fired +1ms
  pw:api <= download.saveAs succeeded +160ms

[aslushnikov]

@klhex I unfortunately cannot reproduce this behavior. Since your download link is not real, here's what I tried:

a.html

<div class="o-button-container o-button-container--center u-mb">
  <div class="u-mb-small u-mr-small u-pr-xsmall">
    <a
      href="https://demo.borland.com/testsite/downloads/downloadfile.php?file=downloaded-html.html&cd=attachment"
      target="_blank"
      class="c-btn c-btn--link c-btn--small">
      <i class="c-btn__icon c-icon c-icon--[semantic-forward]"></i>
      <span class="c-btn__text">PDF anzeigen / herunterladen</span></a
    >
  </div>
</div>

a.js

const {chromium, webkit, firefox} = require('.');
const path = require('path');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage({
    acceptDownloads: true,
  });
  await page.goto('http://localhost:1234/a.html');
  const [download] = await Promise.all([
    page.waitForEvent('download'),
    await page.click('text=PDF ANZEIGEN'),
  ]);
  await download.saveAs(
    path.join(__dirname, 'downloads', download.suggestedFilename())
  );
  await browser.close();
})();

... and everything worked for me correctly. Could you please try running this on your machine and see if it works?

[klhex]

@aslushnikov Thanks for looking into this. I replicated your example and at first everything went fine. But then I noticed that your test -- contrary to my original one -- is running in headless mode while mine is running headful. Sorry for not having mentioned this from the outset. 😞 When I ran your test in headful mode the same issue as described initially came up: works w/ Firefox, doesn't work w/ Chromium (in both cases the ones provided along w/ Playwright). (When running my test in headless mode everything works fine as in your test.)

That means: if you re-run your test in headful mode you should be able to replicate the described issue.

PS. Maybe the described issue is related to this?

playwright/test/download.spec.ts

Lines 280 to 284 in 8df1fe4

	it('should report new window downloads', test => {
	test.fixme(options.CHROMIUM && !options.HEADLESS);
	}, async ({browser, server}) => {
	// TODO: - the test fails in headful Chromium as the popup page gets closed along
	// with the session before download completed event arrives.

[gilles-yvetot]

Hello there.
I can confirm I have the same issue: Chromium with playwright 1.10 in headful. It looks like there is a "finish download" event that is not triggered.
In my case, the download.delete() does not resolve. It then prevents me from closing the context because it looks like we are awaiting unfinished download.

[NexZhu]

Same situation, latest Playwright with Chromium, file download is completed (UUID as the file name), but download.path() won't resolve.

[klhex]

@NexZhu I guess the upstream fix in Chromium has not yet been released / tested. Probably this issue should receive a version label for the PW target version in which it is planned to get fixed. A similar issue which seems to wait for the same upstream fix (#5947) has received the v1.12 label recently.