@playwright/test 1.37.0-alpha-aug-1-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/blob.js

@@ -29,28 +29,23 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * limitations under the License.
  */
 
+const currentVersion = 1;
 class BlobReporter extends _teleEmitter.TeleReporterEmitter {
   constructor(options) {
     super(message => this._messages.push(message), false);
     this._messages = [];
+    this._attachments = [];
     this._options = void 0;
     this._salt = void 0;
-    this._copyFilePromises = new Set();
-    this._outputDir = void 0;
-    this._reportName = void 0;
     this._options = options;
     this._salt = (0, _utils.createGuid)();
   }
   onConfigure(config) {
-    const outputDir = (0, _util.resolveReporterOutputPath)('blob-report', this._options.configDir, this._options.outputDir);
-    const removePromise = process.env.PWTEST_BLOB_DO_NOT_REMOVE ? Promise.resolve() : (0, _utils.removeFolders)([outputDir]);
-    this._outputDir = removePromise.then(() => _fs.default.promises.mkdir(_path.default.join(outputDir, 'resources'), {
-      recursive: true
-    })).then(() => outputDir);
-    this._reportName = `report-${(0, _utils.createGuid)()}`;
+    var _config$shard;
     const metadata = {
+      version: currentVersion,
       projectSuffix: process.env.PWTEST_BLOB_SUFFIX,
-      shard: config.shard ? config.shard : undefined
+      shard: (_config$shard = config.shard) !== null && _config$shard !== void 0 ? _config$shard : undefined
     };
     this._messages.push({
       method: 'onBlobReportMetadata',
@@ -60,48 +55,54 @@ class BlobReporter extends _teleEmitter.TeleReporterEmitter {
   }
   async onEnd(result) {
     await super.onEnd(result);
-    const outputDir = await this._outputDir;
-    const lines = this._messages.map(m => JSON.stringify(m) + '\n');
-    const content = _stream.Readable.from(lines);
+    const outputDir = (0, _util.resolveReporterOutputPath)('blob-report', this._options.configDir, this._options.outputDir);
+    if (!process.env.PWTEST_BLOB_DO_NOT_REMOVE) await (0, _utils.removeFolders)([outputDir]);
+    await _fs.default.promises.mkdir(outputDir, {
+      recursive: true
+    });
+    const reportName = `report-${(0, _utils.createGuid)()}`;
     const zipFile = new _zipBundle.yazl.ZipFile();
     const zipFinishPromise = new _utils.ManualPromise();
+    const finishPromise = zipFinishPromise.catch(e => {
+      throw new Error(`Failed to write report ${reportName + '.zip'}: ` + e.message);
+    });
     zipFile.on('error', error => zipFinishPromise.reject(error));
-    const zipFileName = _path.default.join(outputDir, this._reportName + '.zip');
+    const zipFileName = _path.default.join(outputDir, reportName + '.zip');
     zipFile.outputStream.pipe(_fs.default.createWriteStream(zipFileName)).on('close', () => {
       zipFinishPromise.resolve(undefined);
     }).on('error', error => zipFinishPromise.reject(error));
-    zipFile.addReadStream(content, this._reportName + '.jsonl');
+    for (const {
+      originalPath,
+      zipEntryPath
+    } of this._attachments) {
+      var _fs$statSync;
+      if (!((_fs$statSync = _fs.default.statSync(originalPath, {
+        throwIfNoEntry: false
+      })) !== null && _fs$statSync !== void 0 && _fs$statSync.isFile())) continue;
+      zipFile.addFile(originalPath, zipEntryPath);
+    }
+    const lines = this._messages.map(m => JSON.stringify(m) + '\n');
+    const content = _stream.Readable.from(lines);
+    zipFile.addReadStream(content, reportName + '.jsonl');
     zipFile.end();
-    await Promise.all([...this._copyFilePromises,
-    // Requires Node v14.18.0+
-    zipFinishPromise.catch(e => {
-      throw new Error(`Failed to write report ${zipFileName}: ` + e.message);
-    })]);
+    await finishPromise;
   }
   _serializeAttachments(attachments) {
     return super._serializeAttachments(attachments).map(attachment => {
-      var _fs$statSync;
-      if (!attachment.path || !((_fs$statSync = _fs.default.statSync(attachment.path, {
-        throwIfNoEntry: false
-      })) !== null && _fs$statSync !== void 0 && _fs$statSync.isFile())) return attachment;
+      if (!attachment.path) return attachment;
       // Add run guid to avoid clashes between shards.
       const sha1 = (0, _utils.calculateSha1)(attachment.path + this._salt);
       const extension = _utilsBundle.mime.getExtension(attachment.contentType) || 'dat';
       const newPath = `resources/${sha1}.${extension}`;
-      this._startCopyingFile(attachment.path, newPath);
+      this._attachments.push({
+        originalPath: attachment.path,
+        zipEntryPath: newPath
+      });
       return {
         ...attachment,
         path: newPath
       };
     });
   }
-  _startCopyingFile(from, to) {
-    const copyPromise = this._outputDir.then(dir => _fs.default.promises.copyFile(from, _path.default.join(dir, to))).catch(e => {
-      console.error(`Failed to copy file from "${from}" to "${to}": ${e}`);
-    }).then(() => {
-      this._copyFilePromises.delete(copyPromise);
-    });
-    this._copyFilePromises.add(copyPromise);
-  }
 }
 exports.BlobReporter = BlobReporter;

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,37 +60,44 @@ function patchAttachmentPaths(events, resourceDir) {
 function parseEvents(reportJsonl) {
   return reportJsonl.toString().split('\n').filter(line => line.length).map(line => JSON.parse(line));
 }
-async function extractReportFromZip(file) {
-  const zipFile = new _utils.ZipFile(file);
-  const entryNames = await zipFile.entries();
-  try {
+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 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) {
-      if (entryName.endsWith('.jsonl')) return await zipFile.read(entryName);
+      const content = await zipFile.read(entryName);
+      if (entryName.endsWith('.jsonl')) {
+        const parsedEvents = parseEvents(content);
+        shardEvents.push({
+          metadata: findMetadata(parsedEvents, file),
+          parsedEvents
+        });
+      } else {
+        const fileName = _path.default.join(dir, entryName);
+        await _fs.default.promises.writeFile(fileName, content);
+      }
     }
-  } finally {
     zipFile.close();
   }
-  throw new Error(`Cannot find *.jsonl file in ${file}`);
+  return shardEvents;
 }
 function findMetadata(events, file) {
   var _events$;
   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 = [];
-  for (const reportFile of shardReportFiles) {
-    const reportJsonl = await extractReportFromZip(_path.default.join(dir, reportFile));
-    const parsedEvents = parseEvents(reportJsonl);
-    shardEvents.push({
-      metadata: findMetadata(parsedEvents, reportFile),
-      parsedEvents
-    });
-  }
+  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;
@@ -86,6 +105,7 @@ async function mergeEvents(dir, shardReportFiles) {
     return shardA - shardB;
   });
   const allTestIds = new Set();
+  printStatus(`merging events`);
   for (const {
     parsedEvents
   } of shardEvents) {
@@ -180,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-1-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-1-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 } = {}) {