/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import './playwright.fixtures';
import { registerFixture } from './runner';
import path from 'path';
import fs from 'fs';
import os from 'os';
import {mkdtempAsync, removeFolderAsync} from './utils';
import { Browser, BrowserContext } from '..';
declare global {
interface FixtureState {
downloadsBrowser: Browser;
persistentDownloadsContext: BrowserContext;
}
}
registerFixture('downloadsBrowser', async ({server, browserType, defaultBrowserOptions, tmpDir}, test) => {
server.setRoute('/download', (req, res) => {
res.setHeader('Content-Type', 'application/octet-stream');
res.setHeader('Content-Disposition', 'attachment; filename=file.txt');
res.end(`Hello world`);
});
const browser = await browserType.launch({
...defaultBrowserOptions,
downloadsPath: tmpDir,
});
await test(browser);
await browser.close();
});
registerFixture('persistentDownloadsContext', async ({server, browserType, defaultBrowserOptions, tmpDir}, test) => {
const userDataDir = await mkdtempAsync(path.join(os.tmpdir(), 'playwright-test-'));
server.setRoute('/download', (req, res) => {
res.setHeader('Content-Type', 'application/octet-stream');
res.setHeader('Content-Disposition', 'attachment; filename=file.txt');
res.end(`Hello world`);
});
const context = await browserType.launchPersistentContext(
userDataDir,
{
...defaultBrowserOptions,
downloadsPath: tmpDir,
acceptDownloads: true
}
);
const page = context.pages()[0];
page.setContent(`download`);
await test(context);
await context.close();
await removeFolderAsync(userDataDir);
});
it('should keep downloadsPath folder', async({downloadsBrowser, tmpDir, server}) => {
const page = await downloadsBrowser.newPage();
await page.setContent(`download`);
const [ download ] = await Promise.all([
page.waitForEvent('download'),
page.click('a')
]);
expect(download.url()).toBe(`${server.PREFIX}/download`);
expect(download.suggestedFilename()).toBe(`file.txt`);
await download.path().catch(e => void 0);
await page.close();
await downloadsBrowser.close();
expect(fs.existsSync(tmpDir)).toBeTruthy();
});
it('should delete downloads when context closes', async({downloadsBrowser, server}) => {
const page = await downloadsBrowser.newPage({ acceptDownloads: true });
await page.setContent(`download`);
const [ download ] = await Promise.all([
page.waitForEvent('download'),
page.click('a')
]);
const path = await download.path();
expect(fs.existsSync(path)).toBeTruthy();
await page.close();
expect(fs.existsSync(path)).toBeFalsy();
});
it('should report downloads in downloadsPath folder', async({downloadsBrowser, tmpDir, server}) => {
const page = await downloadsBrowser.newPage({ acceptDownloads: true });
await page.setContent(`download`);
const [ download ] = await Promise.all([
page.waitForEvent('download'),
page.click('a')
]);
const path = await download.path();
expect(path.startsWith(tmpDir)).toBeTruthy();
await page.close();
});
it('should accept downloads', async({persistentDownloadsContext, tmpDir, server}) => {
const page = persistentDownloadsContext.pages()[0];
const [ download ] = await Promise.all([
page.waitForEvent('download'),
page.click('a')
]);
expect(download.url()).toBe(`${server.PREFIX}/download`);
expect(download.suggestedFilename()).toBe(`file.txt`);
const path = await download.path();
expect(path.startsWith(tmpDir)).toBeTruthy();
});
it('should not delete downloads when the context closes', async({persistentDownloadsContext}) => {
const page = persistentDownloadsContext.pages()[0];
const [ download ] = await Promise.all([
page.waitForEvent('download'),
page.click('a')
]);
const path = await download.path();
await persistentDownloadsContext.close();
expect(fs.existsSync(path)).toBeTruthy();
});