program.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
  1. "use strict";
  2. var __create = Object.create;
  3. var __defProp = Object.defineProperty;
  4. var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
  5. var __getOwnPropNames = Object.getOwnPropertyNames;
  6. var __getProtoOf = Object.getPrototypeOf;
  7. var __hasOwnProp = Object.prototype.hasOwnProperty;
  8. var __export = (target, all) => {
  9. for (var name in all)
  10. __defProp(target, name, { get: all[name], enumerable: true });
  11. };
  12. var __copyProps = (to, from, except, desc) => {
  13. if (from && typeof from === "object" || typeof from === "function") {
  14. for (let key of __getOwnPropNames(from))
  15. if (!__hasOwnProp.call(to, key) && key !== except)
  16. __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  17. }
  18. return to;
  19. };
  20. var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  21. // If the importer is in node compatibility mode or this is not an ESM
  22. // file that has been converted to a CommonJS file using a Babel-
  23. // compatible transform (i.e. "__esModule" has not been set), then set
  24. // "default" to the CommonJS "module.exports" for node compatibility.
  25. isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  26. mod
  27. ));
  28. var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
  29. var program_exports = {};
  30. __export(program_exports, {
  31. program: () => import_utilsBundle2.program
  32. });
  33. module.exports = __toCommonJS(program_exports);
  34. var import_fs = __toESM(require("fs"));
  35. var import_os = __toESM(require("os"));
  36. var import_path = __toESM(require("path"));
  37. var playwright = __toESM(require("../.."));
  38. var import_driver = require("./driver");
  39. var import_server = require("../server");
  40. var import_utils = require("../utils");
  41. var import_traceViewer = require("../server/trace/viewer/traceViewer");
  42. var import_utils2 = require("../utils");
  43. var import_ascii = require("../server/utils/ascii");
  44. var import_utilsBundle = require("../utilsBundle");
  45. var import_utilsBundle2 = require("../utilsBundle");
  46. const packageJSON = require("../../package.json");
  47. import_utilsBundle.program.version("Version " + (process.env.PW_CLI_DISPLAY_VERSION || packageJSON.version)).name(buildBasePlaywrightCLICommand(process.env.PW_LANG_NAME));
  48. import_utilsBundle.program.command("mark-docker-image [dockerImageNameTemplate]", { hidden: true }).description("mark docker image").allowUnknownOption(true).action(function(dockerImageNameTemplate) {
  49. (0, import_utils2.assert)(dockerImageNameTemplate, "dockerImageNameTemplate is required");
  50. (0, import_server.writeDockerVersion)(dockerImageNameTemplate).catch(logErrorAndExit);
  51. });
  52. commandWithOpenOptions("open [url]", "open page in browser specified via -b, --browser", []).action(function(url, options) {
  53. open(options, url).catch(logErrorAndExit);
  54. }).addHelpText("afterAll", `
  55. Examples:
  56. $ open
  57. $ open -b webkit https://example.com`);
  58. commandWithOpenOptions(
  59. "codegen [url]",
  60. "open page and generate code for user actions",
  61. [
  62. ["-o, --output <file name>", "saves the generated script to a file"],
  63. ["--target <language>", `language to generate, one of javascript, playwright-test, python, python-async, python-pytest, csharp, csharp-mstest, csharp-nunit, java, java-junit`, codegenId()],
  64. ["--test-id-attribute <attributeName>", "use the specified attribute to generate data test ID selectors"]
  65. ]
  66. ).action(async function(url, options) {
  67. await codegen(options, url);
  68. }).addHelpText("afterAll", `
  69. Examples:
  70. $ codegen
  71. $ codegen --target=python
  72. $ codegen -b webkit https://example.com`);
  73. function printInstalledBrowsers(browsers2) {
  74. const browserPaths = /* @__PURE__ */ new Set();
  75. for (const browser of browsers2)
  76. browserPaths.add(browser.browserPath);
  77. console.log(` Browsers:`);
  78. for (const browserPath of [...browserPaths].sort())
  79. console.log(` ${browserPath}`);
  80. console.log(` References:`);
  81. const references = /* @__PURE__ */ new Set();
  82. for (const browser of browsers2)
  83. references.add(browser.referenceDir);
  84. for (const reference of [...references].sort())
  85. console.log(` ${reference}`);
  86. }
  87. function printGroupedByPlaywrightVersion(browsers2) {
  88. const dirToVersion = /* @__PURE__ */ new Map();
  89. for (const browser of browsers2) {
  90. if (dirToVersion.has(browser.referenceDir))
  91. continue;
  92. const packageJSON2 = require(import_path.default.join(browser.referenceDir, "package.json"));
  93. const version = packageJSON2.version;
  94. dirToVersion.set(browser.referenceDir, version);
  95. }
  96. const groupedByPlaywrightMinorVersion = /* @__PURE__ */ new Map();
  97. for (const browser of browsers2) {
  98. const version = dirToVersion.get(browser.referenceDir);
  99. let entries = groupedByPlaywrightMinorVersion.get(version);
  100. if (!entries) {
  101. entries = [];
  102. groupedByPlaywrightMinorVersion.set(version, entries);
  103. }
  104. entries.push(browser);
  105. }
  106. const sortedVersions = [...groupedByPlaywrightMinorVersion.keys()].sort((a, b) => {
  107. const aComponents = a.split(".");
  108. const bComponents = b.split(".");
  109. const aMajor = parseInt(aComponents[0], 10);
  110. const bMajor = parseInt(bComponents[0], 10);
  111. if (aMajor !== bMajor)
  112. return aMajor - bMajor;
  113. const aMinor = parseInt(aComponents[1], 10);
  114. const bMinor = parseInt(bComponents[1], 10);
  115. if (aMinor !== bMinor)
  116. return aMinor - bMinor;
  117. return aComponents.slice(2).join(".").localeCompare(bComponents.slice(2).join("."));
  118. });
  119. for (const version of sortedVersions) {
  120. console.log(`
  121. Playwright version: ${version}`);
  122. printInstalledBrowsers(groupedByPlaywrightMinorVersion.get(version));
  123. }
  124. }
  125. import_utilsBundle.program.command("install [browser...]").description("ensure browsers necessary for this version of Playwright are installed").option("--with-deps", "install system dependencies for browsers").option("--dry-run", "do not execute installation, only print information").option("--list", "prints list of browsers from all playwright installations").option("--force", "force reinstall of stable browser channels").option("--only-shell", "only install headless shell when installing chromium").option("--no-shell", "do not install chromium headless shell").action(async function(args, options) {
  126. if ((0, import_utils.isLikelyNpxGlobal)()) {
  127. console.error((0, import_ascii.wrapInASCIIBox)([
  128. `WARNING: It looks like you are running 'npx playwright install' without first`,
  129. `installing your project's dependencies.`,
  130. ``,
  131. `To avoid unexpected behavior, please install your dependencies first, and`,
  132. `then run Playwright's install command:`,
  133. ``,
  134. ` npm install`,
  135. ` npx playwright install`,
  136. ``,
  137. `If your project does not yet depend on Playwright, first install the`,
  138. `applicable npm package (most commonly @playwright/test), and`,
  139. `then run Playwright's install command to download the browsers:`,
  140. ``,
  141. ` npm install @playwright/test`,
  142. ` npx playwright install`,
  143. ``
  144. ].join("\n"), 1));
  145. }
  146. try {
  147. if (options.shell === false && options.onlyShell)
  148. throw new Error(`Only one of --no-shell and --only-shell can be specified`);
  149. const shell = options.shell === false ? "no" : options.onlyShell ? "only" : void 0;
  150. const executables = import_server.registry.resolveBrowsers(args, { shell });
  151. if (options.withDeps)
  152. await import_server.registry.installDeps(executables, !!options.dryRun);
  153. if (options.dryRun && options.list)
  154. throw new Error(`Only one of --dry-run and --list can be specified`);
  155. if (options.dryRun) {
  156. for (const executable of executables) {
  157. const version = executable.browserVersion ? `version ` + executable.browserVersion : "";
  158. console.log(`browser: ${executable.name}${version ? " " + version : ""}`);
  159. console.log(` Install location: ${executable.directory ?? "<system>"}`);
  160. if (executable.downloadURLs?.length) {
  161. const [url, ...fallbacks] = executable.downloadURLs;
  162. console.log(` Download url: ${url}`);
  163. for (let i = 0; i < fallbacks.length; ++i)
  164. console.log(` Download fallback ${i + 1}: ${fallbacks[i]}`);
  165. }
  166. console.log(``);
  167. }
  168. } else if (options.list) {
  169. const browsers2 = await import_server.registry.listInstalledBrowsers();
  170. printGroupedByPlaywrightVersion(browsers2);
  171. } else {
  172. const force = args.length === 0 ? false : !!options.force;
  173. await import_server.registry.install(executables, { force });
  174. await import_server.registry.validateHostRequirementsForExecutablesIfNeeded(executables, process.env.PW_LANG_NAME || "javascript").catch((e) => {
  175. e.name = "Playwright Host validation warning";
  176. console.error(e);
  177. });
  178. }
  179. } catch (e) {
  180. console.log(`Failed to install browsers
  181. ${e}`);
  182. (0, import_utils.gracefullyProcessExitDoNotHang)(1);
  183. }
  184. }).addHelpText("afterAll", `
  185. Examples:
  186. - $ install
  187. Install default browsers.
  188. - $ install chrome firefox
  189. Install custom browsers, supports ${import_server.registry.suggestedBrowsersToInstall()}.`);
  190. import_utilsBundle.program.command("uninstall").description("Removes browsers used by this installation of Playwright from the system (chromium, firefox, webkit, ffmpeg). This does not include branded channels.").option("--all", "Removes all browsers used by any Playwright installation from the system.").action(async (options) => {
  191. delete process.env.PLAYWRIGHT_SKIP_BROWSER_GC;
  192. await import_server.registry.uninstall(!!options.all).then(({ numberOfBrowsersLeft }) => {
  193. if (!options.all && numberOfBrowsersLeft > 0) {
  194. console.log("Successfully uninstalled Playwright browsers for the current Playwright installation.");
  195. console.log(`There are still ${numberOfBrowsersLeft} browsers left, used by other Playwright installations.
  196. To uninstall Playwright browsers for all installations, re-run with --all flag.`);
  197. }
  198. }).catch(logErrorAndExit);
  199. });
  200. import_utilsBundle.program.command("install-deps [browser...]").description("install dependencies necessary to run browsers (will ask for sudo permissions)").option("--dry-run", "Do not execute installation commands, only print them").action(async function(args, options) {
  201. try {
  202. await import_server.registry.installDeps(import_server.registry.resolveBrowsers(args, {}), !!options.dryRun);
  203. } catch (e) {
  204. console.log(`Failed to install browser dependencies
  205. ${e}`);
  206. (0, import_utils.gracefullyProcessExitDoNotHang)(1);
  207. }
  208. }).addHelpText("afterAll", `
  209. Examples:
  210. - $ install-deps
  211. Install dependencies for default browsers.
  212. - $ install-deps chrome firefox
  213. Install dependencies for specific browsers, supports ${import_server.registry.suggestedBrowsersToInstall()}.`);
  214. const browsers = [
  215. { alias: "cr", name: "Chromium", type: "chromium" },
  216. { alias: "ff", name: "Firefox", type: "firefox" },
  217. { alias: "wk", name: "WebKit", type: "webkit" }
  218. ];
  219. for (const { alias, name, type } of browsers) {
  220. commandWithOpenOptions(`${alias} [url]`, `open page in ${name}`, []).action(function(url, options) {
  221. open({ ...options, browser: type }, url).catch(logErrorAndExit);
  222. }).addHelpText("afterAll", `
  223. Examples:
  224. $ ${alias} https://example.com`);
  225. }
  226. commandWithOpenOptions(
  227. "screenshot <url> <filename>",
  228. "capture a page screenshot",
  229. [
  230. ["--wait-for-selector <selector>", "wait for selector before taking a screenshot"],
  231. ["--wait-for-timeout <timeout>", "wait for timeout in milliseconds before taking a screenshot"],
  232. ["--full-page", "whether to take a full page screenshot (entire scrollable area)"]
  233. ]
  234. ).action(function(url, filename, command) {
  235. screenshot(command, command, url, filename).catch(logErrorAndExit);
  236. }).addHelpText("afterAll", `
  237. Examples:
  238. $ screenshot -b webkit https://example.com example.png`);
  239. commandWithOpenOptions(
  240. "pdf <url> <filename>",
  241. "save page as pdf",
  242. [
  243. ["--paper-format <format>", "paper format: Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6"],
  244. ["--wait-for-selector <selector>", "wait for given selector before saving as pdf"],
  245. ["--wait-for-timeout <timeout>", "wait for given timeout in milliseconds before saving as pdf"]
  246. ]
  247. ).action(function(url, filename, options) {
  248. pdf(options, options, url, filename).catch(logErrorAndExit);
  249. }).addHelpText("afterAll", `
  250. Examples:
  251. $ pdf https://example.com example.pdf`);
  252. import_utilsBundle.program.command("run-driver", { hidden: true }).action(function(options) {
  253. (0, import_driver.runDriver)();
  254. });
  255. import_utilsBundle.program.command("run-server", { hidden: true }).option("--port <port>", "Server port").option("--host <host>", "Server host").option("--path <path>", "Endpoint Path", "/").option("--max-clients <maxClients>", "Maximum clients").option("--mode <mode>", 'Server mode, either "default" or "extension"').action(function(options) {
  256. (0, import_driver.runServer)({
  257. port: options.port ? +options.port : void 0,
  258. host: options.host,
  259. path: options.path,
  260. maxConnections: options.maxClients ? +options.maxClients : Infinity,
  261. extension: options.mode === "extension" || !!process.env.PW_EXTENSION_MODE
  262. }).catch(logErrorAndExit);
  263. });
  264. import_utilsBundle.program.command("print-api-json", { hidden: true }).action(function(options) {
  265. (0, import_driver.printApiJson)();
  266. });
  267. import_utilsBundle.program.command("launch-server", { hidden: true }).requiredOption("--browser <browserName>", 'Browser name, one of "chromium", "firefox" or "webkit"').option("--config <path-to-config-file>", "JSON file with launchServer options").action(function(options) {
  268. (0, import_driver.launchBrowserServer)(options.browser, options.config);
  269. });
  270. import_utilsBundle.program.command("show-trace [trace]").option("-b, --browser <browserType>", "browser to use, one of cr, chromium, ff, firefox, wk, webkit", "chromium").option("-h, --host <host>", "Host to serve trace on; specifying this option opens trace in a browser tab").option("-p, --port <port>", "Port to serve trace on, 0 for any free port; specifying this option opens trace in a browser tab").option("--stdin", "Accept trace URLs over stdin to update the viewer").description("show trace viewer").action(function(trace, options) {
  271. if (options.browser === "cr")
  272. options.browser = "chromium";
  273. if (options.browser === "ff")
  274. options.browser = "firefox";
  275. if (options.browser === "wk")
  276. options.browser = "webkit";
  277. const openOptions = {
  278. host: options.host,
  279. port: +options.port,
  280. isServer: !!options.stdin
  281. };
  282. if (options.port !== void 0 || options.host !== void 0)
  283. (0, import_traceViewer.runTraceInBrowser)(trace, openOptions).catch(logErrorAndExit);
  284. else
  285. (0, import_traceViewer.runTraceViewerApp)(trace, options.browser, openOptions, true).catch(logErrorAndExit);
  286. }).addHelpText("afterAll", `
  287. Examples:
  288. $ show-trace
  289. $ show-trace https://example.com/trace.zip`);
  290. async function launchContext(options, extraOptions) {
  291. validateOptions(options);
  292. const browserType = lookupBrowserType(options);
  293. const launchOptions = extraOptions;
  294. if (options.channel)
  295. launchOptions.channel = options.channel;
  296. launchOptions.handleSIGINT = false;
  297. const contextOptions = (
  298. // Copy the device descriptor since we have to compare and modify the options.
  299. options.device ? { ...playwright.devices[options.device] } : {}
  300. );
  301. if (!extraOptions.headless)
  302. contextOptions.deviceScaleFactor = import_os.default.platform() === "darwin" ? 2 : 1;
  303. if (browserType.name() === "webkit" && process.platform === "linux") {
  304. delete contextOptions.hasTouch;
  305. delete contextOptions.isMobile;
  306. }
  307. if (contextOptions.isMobile && browserType.name() === "firefox")
  308. contextOptions.isMobile = void 0;
  309. if (options.blockServiceWorkers)
  310. contextOptions.serviceWorkers = "block";
  311. if (options.proxyServer) {
  312. launchOptions.proxy = {
  313. server: options.proxyServer
  314. };
  315. if (options.proxyBypass)
  316. launchOptions.proxy.bypass = options.proxyBypass;
  317. }
  318. if (options.viewportSize) {
  319. try {
  320. const [width, height] = options.viewportSize.split(",").map((n) => +n);
  321. if (isNaN(width) || isNaN(height))
  322. throw new Error("bad values");
  323. contextOptions.viewport = { width, height };
  324. } catch (e) {
  325. throw new Error('Invalid viewport size format: use "width,height", for example --viewport-size="800,600"');
  326. }
  327. }
  328. if (options.geolocation) {
  329. try {
  330. const [latitude, longitude] = options.geolocation.split(",").map((n) => parseFloat(n.trim()));
  331. contextOptions.geolocation = {
  332. latitude,
  333. longitude
  334. };
  335. } catch (e) {
  336. throw new Error('Invalid geolocation format, should be "lat,long". For example --geolocation="37.819722,-122.478611"');
  337. }
  338. contextOptions.permissions = ["geolocation"];
  339. }
  340. if (options.userAgent)
  341. contextOptions.userAgent = options.userAgent;
  342. if (options.lang)
  343. contextOptions.locale = options.lang;
  344. if (options.colorScheme)
  345. contextOptions.colorScheme = options.colorScheme;
  346. if (options.timezone)
  347. contextOptions.timezoneId = options.timezone;
  348. if (options.loadStorage)
  349. contextOptions.storageState = options.loadStorage;
  350. if (options.ignoreHttpsErrors)
  351. contextOptions.ignoreHTTPSErrors = true;
  352. if (options.saveHar) {
  353. contextOptions.recordHar = { path: import_path.default.resolve(process.cwd(), options.saveHar), mode: "minimal" };
  354. if (options.saveHarGlob)
  355. contextOptions.recordHar.urlFilter = options.saveHarGlob;
  356. contextOptions.serviceWorkers = "block";
  357. }
  358. let browser;
  359. let context;
  360. if (options.userDataDir) {
  361. context = await browserType.launchPersistentContext(options.userDataDir, { ...launchOptions, ...contextOptions });
  362. browser = context.browser();
  363. } else {
  364. browser = await browserType.launch(launchOptions);
  365. context = await browser.newContext(contextOptions);
  366. }
  367. let closingBrowser = false;
  368. async function closeBrowser() {
  369. if (closingBrowser)
  370. return;
  371. closingBrowser = true;
  372. if (options.saveStorage)
  373. await context.storageState({ path: options.saveStorage }).catch((e) => null);
  374. if (options.saveHar)
  375. await context.close();
  376. await browser.close();
  377. }
  378. context.on("page", (page) => {
  379. page.on("dialog", () => {
  380. });
  381. page.on("close", () => {
  382. const hasPage = browser.contexts().some((context2) => context2.pages().length > 0);
  383. if (hasPage)
  384. return;
  385. closeBrowser().catch(() => {
  386. });
  387. });
  388. });
  389. process.on("SIGINT", async () => {
  390. await closeBrowser();
  391. (0, import_utils.gracefullyProcessExitDoNotHang)(130);
  392. });
  393. const timeout = options.timeout ? parseInt(options.timeout, 10) : 0;
  394. context.setDefaultTimeout(timeout);
  395. context.setDefaultNavigationTimeout(timeout);
  396. delete launchOptions.headless;
  397. delete launchOptions.executablePath;
  398. delete launchOptions.handleSIGINT;
  399. delete contextOptions.deviceScaleFactor;
  400. return { browser, browserName: browserType.name(), context, contextOptions, launchOptions, closeBrowser };
  401. }
  402. async function openPage(context, url) {
  403. let page = context.pages()[0];
  404. if (!page)
  405. page = await context.newPage();
  406. if (url) {
  407. if (import_fs.default.existsSync(url))
  408. url = "file://" + import_path.default.resolve(url);
  409. else if (!url.startsWith("http") && !url.startsWith("file://") && !url.startsWith("about:") && !url.startsWith("data:"))
  410. url = "http://" + url;
  411. await page.goto(url);
  412. }
  413. return page;
  414. }
  415. async function open(options, url) {
  416. const { context } = await launchContext(options, { headless: !!process.env.PWTEST_CLI_HEADLESS, executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH });
  417. await openPage(context, url);
  418. }
  419. async function codegen(options, url) {
  420. const { target: language, output: outputFile, testIdAttribute: testIdAttributeName } = options;
  421. const tracesDir = import_path.default.join(import_os.default.tmpdir(), `playwright-recorder-trace-${Date.now()}`);
  422. const { context, browser, launchOptions, contextOptions, closeBrowser } = await launchContext(options, {
  423. headless: !!process.env.PWTEST_CLI_HEADLESS,
  424. executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH,
  425. tracesDir
  426. });
  427. const donePromise = new import_utils.ManualPromise();
  428. maybeSetupTestHooks(browser, closeBrowser, donePromise);
  429. import_utilsBundle.dotenv.config({ path: "playwright.env" });
  430. await context._enableRecorder({
  431. language,
  432. launchOptions,
  433. contextOptions,
  434. device: options.device,
  435. saveStorage: options.saveStorage,
  436. mode: "recording",
  437. testIdAttributeName,
  438. outputFile: outputFile ? import_path.default.resolve(outputFile) : void 0,
  439. handleSIGINT: false
  440. });
  441. await openPage(context, url);
  442. donePromise.resolve();
  443. }
  444. async function maybeSetupTestHooks(browser, closeBrowser, donePromise) {
  445. if (!process.env.PWTEST_CLI_IS_UNDER_TEST)
  446. return;
  447. const logs = [];
  448. require("playwright-core/lib/utilsBundle").debug.log = (...args) => {
  449. const line = require("util").format(...args) + "\n";
  450. logs.push(line);
  451. process.stderr.write(line);
  452. };
  453. browser.on("disconnected", () => {
  454. const hasCrashLine = logs.some((line) => line.includes("process did exit:") && !line.includes("process did exit: exitCode=0, signal=null"));
  455. if (hasCrashLine) {
  456. process.stderr.write("Detected browser crash.\n");
  457. (0, import_utils.gracefullyProcessExitDoNotHang)(1);
  458. }
  459. });
  460. const close = async () => {
  461. await donePromise;
  462. await closeBrowser();
  463. };
  464. if (process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT) {
  465. setTimeout(close, +process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT);
  466. return;
  467. }
  468. let stdin = "";
  469. process.stdin.on("data", (data) => {
  470. stdin += data.toString();
  471. if (stdin.startsWith("exit")) {
  472. process.stdin.destroy();
  473. close();
  474. }
  475. });
  476. }
  477. async function waitForPage(page, captureOptions) {
  478. if (captureOptions.waitForSelector) {
  479. console.log(`Waiting for selector ${captureOptions.waitForSelector}...`);
  480. await page.waitForSelector(captureOptions.waitForSelector);
  481. }
  482. if (captureOptions.waitForTimeout) {
  483. console.log(`Waiting for timeout ${captureOptions.waitForTimeout}...`);
  484. await page.waitForTimeout(parseInt(captureOptions.waitForTimeout, 10));
  485. }
  486. }
  487. async function screenshot(options, captureOptions, url, path2) {
  488. const { context } = await launchContext(options, { headless: true });
  489. console.log("Navigating to " + url);
  490. const page = await openPage(context, url);
  491. await waitForPage(page, captureOptions);
  492. console.log("Capturing screenshot into " + path2);
  493. await page.screenshot({ path: path2, fullPage: !!captureOptions.fullPage });
  494. await page.close();
  495. }
  496. async function pdf(options, captureOptions, url, path2) {
  497. if (options.browser !== "chromium")
  498. throw new Error("PDF creation is only working with Chromium");
  499. const { context } = await launchContext({ ...options, browser: "chromium" }, { headless: true });
  500. console.log("Navigating to " + url);
  501. const page = await openPage(context, url);
  502. await waitForPage(page, captureOptions);
  503. console.log("Saving as pdf into " + path2);
  504. await page.pdf({ path: path2, format: captureOptions.paperFormat });
  505. await page.close();
  506. }
  507. function lookupBrowserType(options) {
  508. let name = options.browser;
  509. if (options.device) {
  510. const device = playwright.devices[options.device];
  511. name = device.defaultBrowserType;
  512. }
  513. let browserType;
  514. switch (name) {
  515. case "chromium":
  516. browserType = playwright.chromium;
  517. break;
  518. case "webkit":
  519. browserType = playwright.webkit;
  520. break;
  521. case "firefox":
  522. browserType = playwright.firefox;
  523. break;
  524. case "cr":
  525. browserType = playwright.chromium;
  526. break;
  527. case "wk":
  528. browserType = playwright.webkit;
  529. break;
  530. case "ff":
  531. browserType = playwright.firefox;
  532. break;
  533. }
  534. if (browserType)
  535. return browserType;
  536. import_utilsBundle.program.help();
  537. }
  538. function validateOptions(options) {
  539. if (options.device && !(options.device in playwright.devices)) {
  540. const lines = [`Device descriptor not found: '${options.device}', available devices are:`];
  541. for (const name in playwright.devices)
  542. lines.push(` "${name}"`);
  543. throw new Error(lines.join("\n"));
  544. }
  545. if (options.colorScheme && !["light", "dark"].includes(options.colorScheme))
  546. throw new Error('Invalid color scheme, should be one of "light", "dark"');
  547. }
  548. function logErrorAndExit(e) {
  549. if (process.env.PWDEBUGIMPL)
  550. console.error(e);
  551. else
  552. console.error(e.name + ": " + e.message);
  553. (0, import_utils.gracefullyProcessExitDoNotHang)(1);
  554. }
  555. function codegenId() {
  556. return process.env.PW_LANG_NAME || "playwright-test";
  557. }
  558. function commandWithOpenOptions(command, description, options) {
  559. let result = import_utilsBundle.program.command(command).description(description);
  560. for (const option of options)
  561. result = result.option(option[0], ...option.slice(1));
  562. return result.option("-b, --browser <browserType>", "browser to use, one of cr, chromium, ff, firefox, wk, webkit", "chromium").option("--block-service-workers", "block service workers").option("--channel <channel>", 'Chromium distribution channel, "chrome", "chrome-beta", "msedge-dev", etc').option("--color-scheme <scheme>", 'emulate preferred color scheme, "light" or "dark"').option("--device <deviceName>", 'emulate device, for example "iPhone 11"').option("--geolocation <coordinates>", 'specify geolocation coordinates, for example "37.819722,-122.478611"').option("--ignore-https-errors", "ignore https errors").option("--load-storage <filename>", "load context storage state from the file, previously saved with --save-storage").option("--lang <language>", 'specify language / locale, for example "en-GB"').option("--proxy-server <proxy>", 'specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"').option("--proxy-bypass <bypass>", 'comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"').option("--save-har <filename>", "save HAR file with all network activity at the end").option("--save-har-glob <glob pattern>", "filter entries in the HAR by matching url against this glob pattern").option("--save-storage <filename>", "save context storage state at the end, for later use with --load-storage").option("--timezone <time zone>", 'time zone to emulate, for example "Europe/Rome"').option("--timeout <timeout>", "timeout for Playwright actions in milliseconds, no timeout by default").option("--user-agent <ua string>", "specify user agent string").option("--user-data-dir <directory>", "use the specified user data directory instead of a new context").option("--viewport-size <size>", 'specify browser viewport size in pixels, for example "1280, 720"');
  563. }
  564. function buildBasePlaywrightCLICommand(cliTargetLang) {
  565. switch (cliTargetLang) {
  566. case "python":
  567. return `playwright`;
  568. case "java":
  569. return `mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="...options.."`;
  570. case "csharp":
  571. return `pwsh bin/Debug/netX/playwright.ps1`;
  572. default: {
  573. const packageManagerCommand = (0, import_utils2.getPackageManagerExecCommand)();
  574. return `${packageManagerCommand} playwright`;
  575. }
  576. }
  577. }
  578. // Annotate the CommonJS export names for ESM import in node:
  579. 0 && (module.exports = {
  580. program
  581. });