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

package/lib/cli.js

@@ -245,15 +245,18 @@ function restartWithExperimentalTsEsm(configFile) {
   if (nodeVersion < 16) return false;
   if (!configFile) return false;
   if (process.env.PW_DISABLE_TS_ESM) return false;
-  if (process.env.PW_TS_ESM_ON) return false;
+  if (process.env.PW_TS_ESM_ON) {
+    // clear execArgv after restart, so that childProcess.fork in user code does not inherit our loader.
+    process.execArgv = (0, _util.execArgvWithoutExperimentalLoaderOptions)();
+    return false;
+  }
   if (!(0, _util.fileIsModule)(configFile)) return false;
-  const NODE_OPTIONS = (process.env.NODE_OPTIONS || '') + (0, _util.experimentalLoaderOption)();
   const innerProcess = require('child_process').fork(require.resolve('./cli'), process.argv.slice(2), {
     env: {
       ...process.env,
-      NODE_OPTIONS,
       PW_TS_ESM_ON: '1'
-    }
+    },
+    execArgv: (0, _util.execArgvWithExperimentalLoaderOptions)()
   });
   innerProcess.on('close', code => {
     if (code !== 0 && code !== null) (0, _utils.gracefullyProcessExitDoNotHang)(code);

package/lib/common/process.js

@@ -43,6 +43,9 @@ sendMessageToParent({
 process.on('disconnect', gracefullyCloseAndExit);
 process.on('SIGINT', () => {});
 process.on('SIGTERM', () => {});
+
+// Clear execArgv immediately, so that the user-code does not inherit our loader.
+process.execArgv = (0, _util.execArgvWithoutExperimentalLoaderOptions)();
 let processRunner;
 let processName;
 const startingEnv = {

package/lib/matchers/toMatchSnapshot.js

@@ -76,7 +76,7 @@ class SnapshotHelper {
     let actualModifier = '';
     if (!name) {
       const fullTitleWithoutSpec = [...testInfo.titlePath.slice(1), ++snapshotNames.anonymousSnapshotIndex].join(' ');
-      name = (0, _util.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec)) + '.' + anonymousSnapshotExtension;
+      name = (0, _utils.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec)) + '.' + anonymousSnapshotExtension;
       this.snapshotName = name;
     } else {
       const joinedName = Array.isArray(name) ? name.join(_path.default.sep) : name;

package/lib/plugins/webServerPlugin.js

@@ -8,7 +8,6 @@ var _path = _interopRequireDefault(require("path"));
 var _net = _interopRequireDefault(require("net"));
 var _utilsBundle = require("playwright-core/lib/utilsBundle");
 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.
@@ -79,7 +78,6 @@ class WebServerPlugin {
       command: this._options.command,
       env: {
         ...DEFAULT_ENVIRONMENT_VARIABLES,
-        ...(0, _util.envWithoutExperimentalLoaderOptions)(),
         ...this._options.env
       },
       cwd: this._options.cwd,

package/lib/reporters/blob.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.BlobReporter = void 0;
+exports.currentBlobReportVersion = exports.BlobReporter = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _utils = require("playwright-core/lib/utils");
@@ -29,7 +29,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * limitations under the License.
  */
 
-const currentVersion = 1;
+const currentBlobReportVersion = 1;
+exports.currentBlobReportVersion = currentBlobReportVersion;
 class BlobReporter extends _teleEmitter.TeleReporterEmitter {
   constructor(options) {
     super(message => this._messages.push(message), false);
@@ -37,13 +38,14 @@ class BlobReporter extends _teleEmitter.TeleReporterEmitter {
     this._attachments = [];
     this._options = void 0;
     this._salt = void 0;
+    this._reportName = void 0;
     this._options = options;
     this._salt = (0, _utils.createGuid)();
   }
   onConfigure(config) {
     var _config$shard;
     const metadata = {
-      version: currentVersion,
+      version: currentBlobReportVersion,
       projectSuffix: process.env.PWTEST_BLOB_SUFFIX,
       shard: (_config$shard = config.shard) !== null && _config$shard !== void 0 ? _config$shard : undefined
     };
@@ -51,6 +53,7 @@ class BlobReporter extends _teleEmitter.TeleReporterEmitter {
       method: 'onBlobReportMetadata',
       params: metadata
     });
+    this._reportName = this._computeReportName(config);
     super.onConfigure(config);
   }
   async onEnd(result) {
@@ -60,14 +63,13 @@ class BlobReporter extends _teleEmitter.TeleReporterEmitter {
     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);
+      throw new Error(`Failed to write report ${this._reportName + '.zip'}: ` + e.message);
     });
     zipFile.on('error', error => zipFinishPromise.reject(error));
-    const zipFileName = _path.default.join(outputDir, reportName + '.zip');
+    const zipFileName = _path.default.join(outputDir, this._reportName + '.zip');
     zipFile.outputStream.pipe(_fs.default.createWriteStream(zipFileName)).on('close', () => {
       zipFinishPromise.resolve(undefined);
     }).on('error', error => zipFinishPromise.reject(error));
@@ -83,10 +85,19 @@ class BlobReporter extends _teleEmitter.TeleReporterEmitter {
     }
     const lines = this._messages.map(m => JSON.stringify(m) + '\n');
     const content = _stream.Readable.from(lines);
-    zipFile.addReadStream(content, reportName + '.jsonl');
+    zipFile.addReadStream(content, this._reportName + '.jsonl');
     zipFile.end();
     await finishPromise;
   }
+  _computeReportName(config) {
+    let reportName = 'report';
+    if (process.env.PWTEST_BLOB_SUFFIX) reportName += (0, _utils.sanitizeForFilePath)(process.env.PWTEST_BLOB_SUFFIX);
+    if (config.shard) {
+      const paddedNumber = `${config.shard.current}`.padStart(`${config.shard.total}`.length, '0');
+      reportName += `-${paddedNumber}`;
+    }
+    return reportName;
+  }
   _serializeAttachments(attachments) {
     return super._serializeAttachments(attachments).map(attachment => {
       if (!attachment.path) return attachment;

package/lib/reporters/html.js

@@ -401,7 +401,7 @@ class HtmlBuilder {
         _fs.default.mkdirSync(_path.default.join(this._reportFolder, 'data'), {
           recursive: true
         });
-        const extension = (0, _util.sanitizeForFilePath)(_path.default.extname(a.name).replace(/^\./, '')) || _utilsBundle.mime.getExtension(a.contentType) || 'dat';
+        const extension = (0, _utils.sanitizeForFilePath)(_path.default.extname(a.name).replace(/^\./, '')) || _utilsBundle.mime.getExtension(a.contentType) || 'dat';
         const sha1 = (0, _utils.calculateSha1)(a.body) + '.' + extension;
         _fs.default.writeFileSync(_path.default.join(this._reportFolder, 'data', sha1), a.body);
         return {

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 _blob = require("./blob");
 var _util = require("../util");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
@@ -90,7 +91,9 @@ async function extractAndParseReports(dir, shardFiles, printStatus) {
 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;
+  const metadata = events[0].params;
+  if (metadata.version > _blob.currentBlobReportVersion) throw new Error(`Blob report ${file} was created with a newer version of Playwright.`);
+  return metadata;
 }
 async function mergeEvents(dir, shardReportFiles, printStatus) {
   const events = [];
@@ -198,7 +201,7 @@ function mergeEndEvents(endEvents) {
 }
 async function sortedShardFiles(dir) {
   const files = await _fs.default.promises.readdir(dir);
-  return files.filter(file => file.startsWith('report-') && file.endsWith('.zip')).sort();
+  return files.filter(file => file.startsWith('report') && file.endsWith('.zip')).sort();
 }
 function printStatusToStdout(message) {
   process.stdout.write(`${message}\n`);

package/lib/reporters/raw.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _utils = require("playwright-core/lib/utils");
-var _util = require("../util");
 var _base = require("./base");
 var _json = require("./json");
 var _babelBundle = require("../transform/babelBundle");
@@ -49,7 +48,7 @@ class RawReporter {
       });
       let reportFile;
       for (let i = 0; i < 10; ++i) {
-        reportFile = _path.default.join(reportFolder, (0, _util.sanitizeForFilePath)(project.name || 'project') + (i ? '-' + i : '') + '.report');
+        reportFile = _path.default.join(reportFolder, (0, _utils.sanitizeForFilePath)(project.name || 'project') + (i ? '-' + i : '') + '.report');
         try {
           if (_fs.default.existsSync(reportFile)) continue;
         } catch (e) {}

package/lib/runner/processHost.js

@@ -7,6 +7,7 @@ exports.ProcessHost = void 0;
 var _child_process = _interopRequireDefault(require("child_process"));
 var _events = require("events");
 var _utilsBundle = require("playwright-core/lib/utilsBundle");
+var _util = require("../util");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * Copyright Microsoft Corporation. All rights reserved.
@@ -49,7 +50,10 @@ class ProcessHost extends _events.EventEmitter {
         ...process.env,
         ...this._extraEnv
       },
-      stdio: inheritStdio ? ['ignore', 'inherit', 'inherit', 'ipc'] : ['ignore', 'ignore', process.env.PW_RUNNER_DEBUG ? 'inherit' : 'ignore', 'ipc']
+      stdio: inheritStdio ? ['ignore', 'inherit', 'inherit', 'ipc'] : ['ignore', 'ignore', process.env.PW_RUNNER_DEBUG ? 'inherit' : 'ignore', 'ipc'],
+      ...(process.env.PW_TS_ESM_ON ? {
+        execArgv: (0, _util.execArgvWithExperimentalLoaderOptions)()
+      } : {})
     });
     this.process.on('exit', (code, signal) => {
       this.didExit = true;

package/lib/util.js

@@ -10,10 +10,10 @@ exports.createFileMatcher = createFileMatcher;
 exports.createFileMatcherFromArguments = createFileMatcherFromArguments;
 exports.createTitleMatcher = createTitleMatcher;
 exports.debugTest = void 0;
-exports.envWithoutExperimentalLoaderOptions = envWithoutExperimentalLoaderOptions;
 exports.errorWithFile = errorWithFile;
+exports.execArgvWithExperimentalLoaderOptions = execArgvWithExperimentalLoaderOptions;
+exports.execArgvWithoutExperimentalLoaderOptions = execArgvWithoutExperimentalLoaderOptions;
 exports.expectTypes = expectTypes;
-exports.experimentalLoaderOption = experimentalLoaderOption;
 exports.fileIsModule = fileIsModule;
 exports.filterStackFile = filterStackFile;
 exports.filterStackTrace = filterStackTrace;
@@ -27,7 +27,6 @@ exports.normalizeAndSaveAttachment = normalizeAndSaveAttachment;
 exports.relativeFilePath = relativeFilePath;
 exports.resolveImportSpecifierExtension = resolveImportSpecifierExtension;
 exports.resolveReporterOutputPath = resolveReporterOutputPath;
-exports.sanitizeForFilePath = sanitizeForFilePath;
 exports.serializeError = serializeError;
 exports.stringifyStackFrames = stringifyStackFrames;
 exports.trimLongString = trimLongString;
@@ -187,9 +186,6 @@ function expectTypes(receiver, types, matcherName) {
     throw new Error(`${matcherName} can be only used with ${typesString} object${types.length > 1 ? 's' : ''}`);
   }
 }
-function sanitizeForFilePath(s) {
-  return s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
-}
 function trimLongString(s, length = 100) {
   if (s.length <= length) return s;
   const hash = (0, _utils.calculateSha1)(s);
@@ -203,7 +199,7 @@ function addSuffixToFilePath(filePath, suffix, customExtension, sanitize = false
   const ext = _path.default.extname(filePath);
   const name = _path.default.basename(filePath, ext);
   const base = _path.default.join(dirname, name);
-  return (sanitize ? sanitizeForFilePath(base) : base) + suffix + (customExtension || ext);
+  return (sanitize ? (0, _utils.sanitizeForFilePath)(base) : base) + suffix + (customExtension || ext);
 }
 
 /**
@@ -253,7 +249,7 @@ async function normalizeAndSaveAttachment(outputPath, name, options = {}) {
     var _options$contentType;
     const hash = (0, _utils.calculateSha1)(options.path);
     if (!(0, _utils.isString)(name)) throw new Error('"name" should be string.');
-    const sanitizedNamePrefix = sanitizeForFilePath(name) + '-';
+    const sanitizedNamePrefix = (0, _utils.sanitizeForFilePath)(name) + '-';
     const dest = _path.default.join(outputPath, 'attachments', sanitizedNamePrefix + hash + _path.default.extname(options.path));
     await _fs.default.promises.mkdir(_path.default.dirname(dest), {
       recursive: true
@@ -287,16 +283,12 @@ function folderIsModule(folder) {
   // Rely on `require` internal caching logic.
   return require(packageJsonPath).type === 'module';
 }
-function experimentalLoaderOption() {
-  return ` --no-warnings --experimental-loader=${_url.default.pathToFileURL(require.resolve('@playwright/test/lib/transform/esmLoader')).toString()}`;
+const kExperimentalLoaderOptions = ['--no-warnings', `--experimental-loader=${_url.default.pathToFileURL(require.resolve('@playwright/test/lib/transform/esmLoader')).toString()}`];
+function execArgvWithExperimentalLoaderOptions() {
+  return [...process.execArgv, ...kExperimentalLoaderOptions];
 }
-function envWithoutExperimentalLoaderOptions() {
-  const substring = experimentalLoaderOption();
-  const result = {
-    ...process.env
-  };
-  if (result.NODE_OPTIONS) result.NODE_OPTIONS = result.NODE_OPTIONS.replace(substring, '').trim() || undefined;
-  return result;
+function execArgvWithoutExperimentalLoaderOptions() {
+  return process.execArgv.filter(arg => !kExperimentalLoaderOptions.includes(arg));
 }
 
 // This follows the --moduleResolution=bundler strategy from tsc.

package/lib/worker/testInfo.js

@@ -130,8 +130,8 @@ class TestInfoImpl {
       const relativeTestFilePath = _path.default.relative(this.project.testDir, test._requireFile.replace(/\.(spec|test)\.(js|ts|mjs)$/, ''));
       const sanitizedRelativePath = relativeTestFilePath.replace(process.platform === 'win32' ? new RegExp('\\\\', 'g') : new RegExp('/', 'g'), '-');
       const fullTitleWithoutSpec = test.titlePath().slice(1).join(' ');
-      let testOutputDir = (0, _util.trimLongString)(sanitizedRelativePath + '-' + (0, _util.sanitizeForFilePath)(fullTitleWithoutSpec));
-      if (projectInternal.id) testOutputDir += '-' + (0, _util.sanitizeForFilePath)(projectInternal.id);
+      let testOutputDir = (0, _util.trimLongString)(sanitizedRelativePath + '-' + (0, _utils.sanitizeForFilePath)(fullTitleWithoutSpec));
+      if (projectInternal.id) testOutputDir += '-' + (0, _utils.sanitizeForFilePath)(projectInternal.id);
       if (this.retry) testOutputDir += '-retry' + this.retry;
       if (this.repeatEachIndex) testOutputDir += '-repeat' + this.repeatEachIndex;
       return _path.default.join(this.project.outputDir, testOutputDir);
@@ -364,14 +364,14 @@ class TestInfoImpl {
   }
   _fsSanitizedTestName() {
     const fullTitleWithoutSpec = this.titlePath.slice(1).join(' ');
-    return (0, _util.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec));
+    return (0, _utils.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec));
   }
   snapshotPath(...pathSegments) {
     const subPath = _path.default.join(...pathSegments);
     const parsedSubPath = _path.default.parse(subPath);
     const relativeTestFilePath = _path.default.relative(this.project.testDir, this._test._requireFile);
     const parsedRelativeTestFilePath = _path.default.parse(relativeTestFilePath);
-    const projectNamePathSegment = (0, _util.sanitizeForFilePath)(this.project.name);
+    const projectNamePathSegment = (0, _utils.sanitizeForFilePath)(this.project.name);
     const snapshotPath = (this._projectInternal.snapshotPathTemplate || '').replace(/\{(.)?testDir\}/g, '$1' + this.project.testDir).replace(/\{(.)?snapshotDir\}/g, '$1' + this.project.snapshotDir).replace(/\{(.)?snapshotSuffix\}/g, this.snapshotSuffix ? '$1' + this.snapshotSuffix : '').replace(/\{(.)?testFileDir\}/g, '$1' + parsedRelativeTestFilePath.dir).replace(/\{(.)?platform\}/g, '$1' + process.platform).replace(/\{(.)?projectName\}/g, projectNamePathSegment ? '$1' + projectNamePathSegment : '').replace(/\{(.)?testName\}/g, '$1' + this._fsSanitizedTestName()).replace(/\{(.)?testFileName\}/g, '$1' + parsedRelativeTestFilePath.base).replace(/\{(.)?testFilePath\}/g, '$1' + relativeTestFilePath).replace(/\{(.)?arg\}/g, '$1' + _path.default.join(parsedSubPath.dir, parsedSubPath.name)).replace(/\{(.)?ext\}/g, parsedSubPath.ext ? '$1' + parsedSubPath.ext : '');
     return _path.default.normalize(_path.default.resolve(this._configInternal.configDir, snapshotPath));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playwright/test",
-  "version": "1.37.0-alpha-aug-3-2023",
+  "version": "1.37.0-alpha-aug-4-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-3-2023"
+    "playwright-core": "1.37.0-alpha-aug-4-2023"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"