@playwright/test 1.37.0-alpha-aug-2-2023 → 1.37.0-alpha-aug-3-2023

package/lib/cli.js

@@ -169,7 +169,9 @@ async function mergeReports(reportDir, opts) {
   const configLoader = new _configLoader.ConfigLoader();
   const config = await (configFile ? configLoader.loadConfigFile(configFile) : configLoader.loadEmptyConfig(process.cwd()));
   const dir = _path.default.resolve(process.cwd(), reportDir || '');
-  if (!(await _fs.default.promises.stat(dir)).isDirectory()) throw new Error('Directory does not exist: ' + dir);
+  const dirStat = await _fs.default.promises.stat(dir).catch(e => null);
+  if (!dirStat) throw new Error('Directory does not exist: ' + dir);
+  if (!dirStat.isDirectory()) throw new Error(`"${dir}" is not a directory`);
   let reporterDescriptions = resolveReporterOption(opts.reporter);
   if (!reporterDescriptions && configFile) reporterDescriptions = config.config.reporter;
   if (!reporterDescriptions) reporterDescriptions = [[_config.defaultReporter]];

package/lib/reporters/merge.js

@@ -10,6 +10,7 @@ var _teleReceiver = require("../isomorphic/teleReceiver");
 var _reporters = require("../runner/reporters");
 var _multiplexer = require("./multiplexer");
 var _utils = require("playwright-core/lib/utils");
+var _util = require("../util");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * Copyright (c) Microsoft Corporation.
@@ -28,13 +29,24 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 async function createMergedReport(config, dir, reporterDescriptions) {
+  const reporters = await (0, _reporters.createReporters)(config, 'merge', reporterDescriptions);
+  const multiplexer = new _multiplexer.Multiplexer(reporters);
+  const receiver = new _teleReceiver.TeleReporterReceiver(_path.default.sep, multiplexer, false, config.config);
+  let printStatus = () => {};
+  if (!multiplexer.printsToStdio()) {
+    printStatus = printStatusToStdout;
+    printStatus(`merging reports from ${dir}`);
+  }
   const shardFiles = await sortedShardFiles(dir);
   if (shardFiles.length === 0) throw new Error(`No report files found in ${dir}`);
-  const events = await mergeEvents(dir, shardFiles);
+  const events = await mergeEvents(dir, shardFiles, printStatus);
   patchAttachmentPaths(events, dir);
-  const reporters = await (0, _reporters.createReporters)(config, 'merge', reporterDescriptions);
-  const receiver = new _teleReceiver.TeleReporterReceiver(_path.default.sep, new _multiplexer.Multiplexer(reporters), false, config.config);
-  for (const event of events) await receiver.dispatch(event);
+  printStatus(`processing ${events.length} test events`);
+  for (const event of events) {
+    if (event.method === 'onEnd') printStatus(`building final report`);
+    await receiver.dispatch(event);
+    if (event.method === 'onEnd') printStatus(`finished building report`);
+  }
 }
 function patchAttachmentPaths(events, resourceDir) {
   for (const event of events) {
@@ -48,13 +60,15 @@ function patchAttachmentPaths(events, resourceDir) {
 function parseEvents(reportJsonl) {
   return reportJsonl.toString().split('\n').filter(line => line.length).map(line => JSON.parse(line));
 }
-async function extractAndParseReports(dir, shardFiles) {
+async function extractAndParseReports(dir, shardFiles, printStatus) {
   const shardEvents = [];
   await _fs.default.promises.mkdir(_path.default.join(dir, 'resources'), {
     recursive: true
   });
   for (const file of shardFiles) {
-    const zipFile = new _utils.ZipFile(_path.default.join(dir, file));
+    const absolutePath = _path.default.join(dir, file);
+    printStatus(`extracting: ${(0, _util.relativeFilePath)(absolutePath)}`);
+    const zipFile = new _utils.ZipFile(absolutePath);
     const entryNames = await zipFile.entries();
     for (const entryName of entryNames) {
       const content = await zipFile.read(entryName);
@@ -78,12 +92,12 @@ function findMetadata(events, file) {
   if (((_events$ = events[0]) === null || _events$ === void 0 ? void 0 : _events$.method) !== 'onBlobReportMetadata') throw new Error(`No metadata event found in ${file}`);
   return events[0].params;
 }
-async function mergeEvents(dir, shardReportFiles) {
+async function mergeEvents(dir, shardReportFiles, printStatus) {
   const events = [];
   const configureEvents = [];
   const beginEvents = [];
   const endEvents = [];
-  const shardEvents = await extractAndParseReports(dir, shardReportFiles);
+  const shardEvents = await extractAndParseReports(dir, shardReportFiles, printStatus);
   shardEvents.sort((a, b) => {
     var _a$metadata$shard$cur, _a$metadata$shard, _b$metadata$shard$cur, _b$metadata$shard;
     const shardA = (_a$metadata$shard$cur = (_a$metadata$shard = a.metadata.shard) === null || _a$metadata$shard === void 0 ? void 0 : _a$metadata$shard.current) !== null && _a$metadata$shard$cur !== void 0 ? _a$metadata$shard$cur : 0;
@@ -91,6 +105,7 @@ async function mergeEvents(dir, shardReportFiles) {
     return shardA - shardB;
   });
   const allTestIds = new Set();
+  printStatus(`merging events`);
   for (const {
     parsedEvents
   } of shardEvents) {
@@ -185,6 +200,9 @@ async function sortedShardFiles(dir) {
   const files = await _fs.default.promises.readdir(dir);
   return files.filter(file => file.startsWith('report-') && file.endsWith('.zip')).sort();
 }
+function printStatusToStdout(message) {
+  process.stdout.write(`${message}\n`);
+}
 class ProjectNamePatcher {
   constructor(_allTestIds, _projectNameSuffix) {
     this._testIds = new Set();

package/lib/runner/reporters.js

@@ -72,7 +72,7 @@ async function createReporters(config, mode, descriptions) {
   if (reporters.length && !someReporterPrintsToStdio) {
     // Add a line/dot/list-mode reporter for convenience.
     // Important to put it first, jsut in case some other reporter stalls onEnd.
-    if (mode === 'list') reporters.unshift(new ListModeReporter());else reporters.unshift(!process.env.CI ? new _line.default({
+    if (mode === 'list') reporters.unshift(new ListModeReporter());else if (mode !== 'merge') reporters.unshift(!process.env.CI ? new _line.default({
       omitFailures: true
     }) : new _dot.default());
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playwright/test",
-  "version": "1.37.0-alpha-aug-2-2023",
+  "version": "1.37.0-alpha-aug-3-2023",
   "description": "A high-level API to automate web browsers",
   "repository": "github:Microsoft/playwright",
   "homepage": "https://playwright.dev",
@@ -41,7 +41,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@types/node": "*",
-    "playwright-core": "1.37.0-alpha-aug-2-2023"
+    "playwright-core": "1.37.0-alpha-aug-3-2023"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"

package/types/test.d.ts

@@ -3351,7 +3351,10 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
    * ```js
    * test('example test', async ({ page }) => {
    *   // ...
-   *   await test.info().attach('screenshot', { body: await page.screenshot(), contentType: 'image/png' });
+   *   await test.info().attach('screenshot', {
+   *     body: await page.screenshot(),
+   *     contentType: 'image/png',
+   *   });
    * });
    * ```
    *

package/types/testReporter.d.ts

@@ -316,7 +316,9 @@ export interface FullResult {
  *
  * ```js
  * // my-awesome-reporter.ts
- * import type { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
+ * import type {
+ *   Reporter, FullConfig, Suite, TestCase, TestResult, FullResult
+ * } from '@playwright/test/reporter';
  *
  * class MyReporter implements Reporter {
  *   constructor(options: { customOption?: string } = {}) {