@playwright/test 1.31.2 → 1.32.0

package/lib/store.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.store = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _globals = require("./common/globals");
+var _utilsBundle = require("playwright-core/lib/utilsBundle");
+var _utils = require("playwright-core/lib/utils");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Copyright Microsoft Corporation. All rights reserved.
+ *
+ * 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.
+ */
+
+class JsonStore {
+  async delete(name) {
+    const file = this.path(name);
+    await _fs.default.promises.rm(file, {
+      force: true
+    });
+  }
+  async get(name) {
+    const file = this.path(name);
+    try {
+      const type = contentType(name);
+      if (type === 'binary') return await _fs.default.promises.readFile(file);
+      const text = await _fs.default.promises.readFile(file, 'utf-8');
+      if (type === 'json') return JSON.parse(text);
+      return text;
+    } catch (e) {
+      return undefined;
+    }
+  }
+  path(name) {
+    return _path.default.join(this.root(), name);
+  }
+  root() {
+    const config = (0, _globals.currentConfig)();
+    if (!config) throw new Error('Cannot access store before config is loaded');
+    return config._internal.storeDir;
+  }
+  async set(name, value) {
+    const file = this.path(name);
+    if (value === undefined) {
+      await _fs.default.promises.rm(file, {
+        force: true
+      });
+      return;
+    }
+    let data = '';
+    switch (contentType(name)) {
+      case 'json':
+        {
+          if (Buffer.isBuffer(value)) throw new Error('JSON value must be an Object');
+          data = JSON.stringify(value, undefined, 2);
+          break;
+        }
+      case 'text':
+        {
+          if (!(0, _utils.isString)(value)) throw new Error('Textual value must be a string');
+          data = value;
+          break;
+        }
+      case 'binary':
+        {
+          if (!Buffer.isBuffer(value)) throw new Error('Binary value must be a Buffer');
+          data = value;
+          break;
+        }
+    }
+    await _fs.default.promises.mkdir(_path.default.dirname(file), {
+      recursive: true
+    });
+    await _fs.default.promises.writeFile(file, data);
+  }
+}
+function contentType(name) {
+  var _mime$getType;
+  const mimeType = (_mime$getType = _utilsBundle.mime.getType(_path.default.basename(name))) !== null && _mime$getType !== void 0 ? _mime$getType : 'application/octet-string';
+  if ((0, _utils.isJsonMimeType)(mimeType)) return 'json';
+  if ((0, _utils.isTextualMimeType)(mimeType)) return 'text';
+  return 'binary';
+}
+const store = new JsonStore();
+exports.store = store;

package/lib/util.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.addSuffixToFilePath = addSuffixToFilePath;
 exports.callLogText = callLogText;
-exports.captureStackTrace = captureStackTrace;
 exports.createFileFiltersFromArguments = createFileFiltersFromArguments;
 exports.createFileMatcher = createFileMatcher;
 exports.createFileMatcherFromArguments = createFileMatcherFromArguments;
@@ -16,6 +15,8 @@ exports.errorWithFile = errorWithFile;
 exports.expectTypes = expectTypes;
 exports.experimentalLoaderOption = experimentalLoaderOption;
 exports.fileIsModule = fileIsModule;
+exports.filterStackTrace = filterStackTrace;
+exports.filteredStackTrace = filteredStackTrace;
 exports.folderIsModule = folderIsModule;
 exports.forceRegExp = forceRegExp;
 exports.formatLocation = formatLocation;
@@ -26,6 +27,7 @@ exports.normalizeAndSaveAttachment = normalizeAndSaveAttachment;
 exports.relativeFilePath = relativeFilePath;
 exports.sanitizeForFilePath = sanitizeForFilePath;
 exports.serializeError = serializeError;
+exports.stringifyStackFrames = stringifyStackFrames;
 exports.trimLongString = trimLongString;
 var _fs = _interopRequireDefault(require("fs"));
 var _utilsBundle = require("playwright-core/lib/utilsBundle");
@@ -50,51 +52,33 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * limitations under the License.
  */
 
-const PLAYWRIGHT_CORE_PATH = _path.default.dirname(require.resolve('playwright-core'));
-const EXPECT_PATH = require.resolve('./common/expectBundle');
-const EXPECT_PATH_IMPL = require.resolve('./common/expectBundleImpl');
 const PLAYWRIGHT_TEST_PATH = _path.default.join(__dirname, '..');
+const PLAYWRIGHT_CORE_PATH = _path.default.dirname(require.resolve('playwright-core/package.json'));
 function filterStackTrace(e) {
+  var _e$stack;
   if (process.env.PWDEBUGIMPL) return;
-
-  // This method filters internal stack frames using Error.prepareStackTrace
-  // hook. Read more about the hook: https://v8.dev/docs/stack-trace-api
-  //
-  // NOTE: Error.prepareStackTrace will only be called if `e.stack` has not
-  // been accessed before. This is the case for Jest Expect and simple throw
-  // statements.
-  //
-  // If `e.stack` has been accessed, this method will be NOOP.
-  const oldPrepare = Error.prepareStackTrace;
-  const stackFormatter = oldPrepare || ((error, structuredStackTrace) => [`${error.name}: ${error.message}`, ...structuredStackTrace.map(callSite => '    at ' + callSite.toString())].join('\n'));
-  Error.prepareStackTrace = (error, structuredStackTrace) => {
-    return stackFormatter(error, structuredStackTrace.filter(callSite => {
-      const fileName = callSite.getFileName();
-      const functionName = callSite.getFunctionName() || undefined;
-      if (!fileName) return true;
-      return !fileName.startsWith(PLAYWRIGHT_TEST_PATH) && !fileName.startsWith(PLAYWRIGHT_CORE_PATH) && !(0, _utils.isInternalFileName)(fileName, functionName);
-    }));
-  };
-  // eslint-disable-next-line
-  e.stack; // trigger Error.prepareStackTrace
-  Error.prepareStackTrace = oldPrepare;
+  const stackLines = stringifyStackFrames(filteredStackTrace(((_e$stack = e.stack) === null || _e$stack === void 0 ? void 0 : _e$stack.split('\n')) || []));
+  const message = e.message;
+  e.stack = `${e.name}: ${e.message}\n${stackLines.join('\n')}`;
+  e.message = message;
 }
-function captureStackTrace(customApiName) {
-  const stackTrace = (0, _utils.captureStackTrace)();
+function filteredStackTrace(rawStack) {
   const frames = [];
-  const frameTexts = [];
-  for (let i = 0; i < stackTrace.frames.length; ++i) {
-    const frame = stackTrace.frames[i];
-    if (frame.file === EXPECT_PATH || frame.file === EXPECT_PATH_IMPL) continue;
+  for (const line of rawStack) {
+    const frame = (0, _utilsBundle.parseStackTraceLine)(line);
+    if (!frame || !frame.file) continue;
+    if (!process.env.PWDEBUGIMPL && frame.file.startsWith(PLAYWRIGHT_TEST_PATH)) continue;
+    if (!process.env.PWDEBUGIMPL && frame.file.startsWith(PLAYWRIGHT_CORE_PATH)) continue;
     frames.push(frame);
-    frameTexts.push(stackTrace.frameTexts[i]);
   }
-  return {
-    allFrames: stackTrace.allFrames,
-    frames,
-    frameTexts,
-    apiName: customApiName !== null && customApiName !== void 0 ? customApiName : stackTrace.apiName
-  };
+  return frames;
+}
+function stringifyStackFrames(frames) {
+  const stackLines = [];
+  for (const frame of frames) {
+    if (frame.function) stackLines.push(`    at ${frame.function} (${frame.file}:${frame.line}:${frame.column})`);else stackLines.push(`    at ${frame.file}:${frame.line}:${frame.column}`);
+  }
+  return stackLines;
 }
 function serializeError(error) {
   if (error instanceof Error) {

package/lib/worker/fixtureRunner.js

@@ -40,7 +40,8 @@ class Fixture {
     this.value = null;
     const title = this.registration.customTitle || this.registration.name;
     this._runnableDescription = {
-      title: this.registration.timeout !== undefined ? `Fixture "${title}"` : `setting up "${title}"`,
+      title,
+      phase: 'setup',
       location: registration.location,
       slot: this.registration.timeout === undefined ? undefined : {
         timeout: this.registration.timeout,
@@ -109,8 +110,7 @@ class Fixture {
     await this._teardownWithDepsComplete;
   }
   _setTeardownDescription(timeoutManager) {
-    const title = this.registration.customTitle || this.registration.name;
-    this._runnableDescription.title = this.registration.timeout !== undefined ? `Fixture "${title}"` : `tearing down "${title}"`;
+    this._runnableDescription.phase = 'teardown';
     timeoutManager.setCurrentFixture(this._runnableDescription);
   }
   async _teardownInternal(timeoutManager) {

package/lib/worker/testInfo.js

@@ -52,9 +52,11 @@ class TestInfoImpl {
     this._startTime = void 0;
     this._startWallTime = void 0;
     this._hasHardError = false;
+    this._traceEvents = [];
     this._onTestFailureImmediateCallbacks = new Map();
     this._didTimeout = false;
     this._lastStepId = 0;
+    this.testId = void 0;
     this.repeatEachIndex = void 0;
     this.retry = void 0;
     this.workerIndex = void 0;
@@ -80,6 +82,7 @@ class TestInfoImpl {
     this.errors = [];
     this.currentStep = void 0;
     this._test = test;
+    this.testId = test.id;
     this._onStepBegin = onStepBegin;
     this._onStepEnd = onStepEnd;
     this._startTime = (0, _utils.monotonicTime)();
@@ -199,8 +202,7 @@ class TestInfoImpl {
       testId: this._test.id,
       stepId,
       ...data,
-      location,
-      wallTime: Date.now()
+      location
     };
     this._onStepBegin(payload);
     return step;
@@ -228,7 +230,10 @@ class TestInfoImpl {
     this._hasHardError = state.hasHardError;
   }
   async _runAsStep(cb, stepInfo) {
-    const step = this._addStep(stepInfo);
+    const step = this._addStep({
+      ...stepInfo,
+      wallTime: Date.now()
+    });
     try {
       const result = await cb();
       step.complete({});

package/lib/worker/timeoutManager.js

@@ -93,8 +93,15 @@ class TimeoutManager {
     switch (this._runnable.type) {
       case 'test':
         {
-          const fixtureSuffix = this._fixture ? ` while ${this._fixture.title}` : '';
-          message = `Test timeout of ${timeout}ms exceeded${fixtureSuffix}.`;
+          if (this._fixture) {
+            if (this._fixture.phase === 'setup') {
+              message = `Test timeout of ${timeout}ms exceeded while setting up "${this._fixture.title}".`;
+            } else {
+              message = [`Test finished within timeout of ${timeout}ms, but tearing down "${this._fixture.title}" ran out of time.`, `Please allow more time for the test, since teardown is attributed towards the test timeout budget.`].join('\n');
+            }
+          } else {
+            message = `Test timeout of ${timeout}ms exceeded.`;
+          }
           break;
         }
       case 'afterEach':
@@ -107,8 +114,7 @@ class TimeoutManager {
         break;
       case 'teardown':
         {
-          const fixtureSuffix = this._fixture ? ` while ${this._fixture.title}` : '';
-          message = `Worker teardown timeout of ${timeout}ms exceeded${fixtureSuffix}.`;
+          if (this._fixture) message = `Worker teardown timeout of ${timeout}ms exceeded while ${this._fixture.phase === 'setup' ? 'setting up' : 'tearing down'} "${this._fixture.title}".`;else message = `Worker teardown timeout of ${timeout}ms exceeded.`;
           break;
         }
       case 'skip':
@@ -119,7 +125,7 @@ class TimeoutManager {
         break;
     }
     const fixtureWithSlot = (_this$_fixture2 = this._fixture) !== null && _this$_fixture2 !== void 0 && _this$_fixture2.slot ? this._fixture : undefined;
-    if (fixtureWithSlot) message = `${fixtureWithSlot.title} timeout of ${timeout}ms exceeded.`;
+    if (fixtureWithSlot) message = `Fixture "${fixtureWithSlot.title}" timeout of ${timeout}ms exceeded during ${fixtureWithSlot.phase}.`;
     message = _utilsBundle.colors.red(message);
     const location = (fixtureWithSlot || this._runnable).location;
     return {

package/lib/worker/workerMain.js

@@ -221,7 +221,8 @@ class WorkerMain extends _process.ProcessRunner {
       // In theory, we should run above code without any errors.
       // However, in the case we screwed up, or loadTestFile failed in the worker
       // but not in the runner, let's do a fatal error.
-      this.unhandledError(e);
+      this._fatalErrors.push((0, _util2.serializeError)(e));
+      this._stop();
     } finally {
       const donePayload = {
         fatalErrors: this._fatalErrors,
@@ -299,7 +300,8 @@ class WorkerMain extends _process.ProcessRunner {
         category: 'hook',
         title: 'Before Hooks',
         canHaveChildren: true,
-        forceNoParent: true
+        forceNoParent: true,
+        wallTime: Date.now()
       });
 
       // Note: wrap all preparation steps together, because failure/skip in any of them
@@ -367,7 +369,8 @@ class WorkerMain extends _process.ProcessRunner {
       category: 'hook',
       title: 'After Hooks',
       canHaveChildren: true,
-      forceNoParent: true
+      forceNoParent: true,
+      wallTime: Date.now()
     });
     let firstAfterHooksError;
     let afterHooksSlot;

package/package.json

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

package/types/component.d.ts

@@ -34,7 +34,7 @@ export type ObjectComponent = {
   options?: MountOptions
 };
 
-export type Component = JsxComponent | ObjectComponent;
+export type Component = JsxComponent | ObjectComponent | number | string | Array<any>;
 
 declare global {
   interface Window {

package/types/reporterPrivate.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 type { Suite } from './testReporter';
+
+export interface SuitePrivate extends Suite {
+  _fileId: string | undefined;
+  _parallelMode: 'default' | 'serial' | 'parallel';
+}

package/types/test.d.ts

@@ -1782,19 +1782,8 @@ export interface FullConfig<TestArgs = {}, WorkerArgs = {}> {
 export type TestStatus = 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
 
 /**
- * `WorkerInfo` contains information about the worker that is running tests. It is available to
- * [test.beforeAll(hookFunction)](https://playwright.dev/docs/api/class-test#test-before-all) and
- * [test.afterAll(hookFunction)](https://playwright.dev/docs/api/class-test#test-after-all) hooks and worker-scoped
- * fixtures.
- *
- * ```js
- * import { test, expect } from '@playwright/test';
- *
- * test.beforeAll(async ({ browserName }, workerInfo) => {
- *   console.log(`Running ${browserName} in worker #${workerInfo.workerIndex}`);
- * });
- * ```
- *
+ * `WorkerInfo` contains information about the worker that is running tests and is available to worker-scoped
+ * fixtures. `WorkerInfo` is a subset of [TestInfo] that is available in many other places.
  */
 export interface WorkerInfo {
   /**
@@ -1826,9 +1815,11 @@ export interface WorkerInfo {
 }
 
 /**
- * `TestInfo` contains information about currently running test. It is available to any test function,
- * [test.beforeEach(hookFunction)](https://playwright.dev/docs/api/class-test#test-before-each) and
- * [test.afterEach(hookFunction)](https://playwright.dev/docs/api/class-test#test-after-each) hooks and test-scoped
+ * `TestInfo` contains information about currently running test. It is available to test functions,
+ * [test.beforeEach(hookFunction)](https://playwright.dev/docs/api/class-test#test-before-each),
+ * [test.afterEach(hookFunction)](https://playwright.dev/docs/api/class-test#test-after-each),
+ * [test.beforeAll(hookFunction)](https://playwright.dev/docs/api/class-test#test-before-all) and
+ * [test.afterAll(hookFunction)](https://playwright.dev/docs/api/class-test#test-after-all) hooks, and test-scoped
  * fixtures. `TestInfo` provides utilities to control test execution: attach files, update test timeout, determine
  * which test is currently running and whether it was retried, etc.
  *
@@ -1871,9 +1862,9 @@ export interface TestInfo {
    *
    * ```js
    * import { test, expect } from '@playwright/test';
+   * import { download } from './my-custom-helpers';
    *
    * test('basic test', async ({}, testInfo) => {
-   *   const { download } = require('./my-custom-helpers');
    *   const tmpPath = await download('a');
    *   await testInfo.attach('downloaded', { path: tmpPath });
    * });
@@ -2226,6 +2217,11 @@ export interface TestInfo {
    */
   stdout: Array<string|Buffer>;
 
+  /**
+   * Test id matching the test case id in the reporter API.
+   */
+  testId: string;
+
   /**
    * Timeout in milliseconds for the currently running test. Zero means no timeout. Learn more about
    * [various timeouts](https://playwright.dev/docs/test-timeouts).
@@ -3166,7 +3162,7 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
    * @param title Step name.
    * @param body Step body.
    */
-  step<T>(title: string, body: () => Promise<T>): Promise<T>;
+  step<T>(title: string, body: () => T | Promise<T>): Promise<T>;
   /**
    * `expect` function can be used to create test assertions. Read more about [test assertions](https://playwright.dev/docs/test-assertions).
    *
@@ -3312,7 +3308,7 @@ type ConnectOptions = {
  * [testProject.use](https://playwright.dev/docs/api/class-testproject#test-project-use).
  *
  * ```js
- * import type { PlaywrightTestConfig } from '@playwright/test';
+ * import { defineConfig } from '@playwright/test';
  * export default defineConfig({
  *   use: {
  *     headless: false,
@@ -3439,7 +3435,7 @@ export type VideoMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry';
  * [testProject.use](https://playwright.dev/docs/api/class-testproject#test-project-use).
  *
  * ```js
- * import type { PlaywrightTestConfig } from '@playwright/test';
+ * import { defineConfig } from '@playwright/test';
  * export default defineConfig({
  *   use: {
  *     headless: false,
@@ -4090,12 +4086,12 @@ interface GenericAssertions<R> {
    *
    * ```js
    * const value = 'Is 42 enough?';
-   * expect(value).toMatches(/Is \d+ enough/);
+   * expect(value).toMatch(/Is \d+ enough/);
    * ```
    *
    * @param expected Regular expression to match against.
    */
-  toMatch(expected: RegExp): R;
+  toMatch(expected: RegExp | string): R;
   /**
    * Compares contents of the value with contents of `expected`, performing "deep equality" check. Allows extra
    * properties to be present in the value, unlike

package/types/testReporter.d.ts

@@ -319,6 +319,10 @@ export interface FullResult {
  * import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
  *
  * class MyReporter implements Reporter {
+ *   constructor(options: { customOption?: string } = {}) {
+ *     console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
+ *   }
+ *
  *   onBegin(config: FullConfig, suite: Suite) {
  *     console.log(`Starting the run with ${suite.allTests().length} tests`);
  *   }
@@ -347,7 +351,7 @@ export interface FullResult {
  * import { defineConfig } from '@playwright/test';
  *
  * export default defineConfig({
- *   reporter: './my-awesome-reporter.ts',
+ *   reporter: ['./my-awesome-reporter.ts', { customOption: 'some value' }],
  * });
  * ```
  *

package/lib/common/profiler.js

@@ -1,53 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.startProfiling = startProfiling;
-exports.stopProfiling = stopProfiling;
-var fs = _interopRequireWildcard(require("fs"));
-var path = _interopRequireWildcard(require("path"));
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-/**
- * Copyright Microsoft Corporation. All rights reserved.
- *
- * 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.
- */
-
-const profileDir = process.env.PWTEST_PROFILE_DIR || '';
-let session;
-async function startProfiling() {
-  if (!profileDir) return;
-  session = new (require('inspector').Session)();
-  session.connect();
-  await new Promise(f => {
-    session.post('Profiler.enable', () => {
-      session.post('Profiler.start', f);
-    });
-  });
-}
-async function stopProfiling(processName) {
-  if (!profileDir) return;
-  await new Promise(f => session.post('Profiler.stop', (err, {
-    profile
-  }) => {
-    if (!err) {
-      fs.mkdirSync(profileDir, {
-        recursive: true
-      });
-      fs.writeFileSync(path.join(profileDir, (processName || 'runner') + '.json'), JSON.stringify(profile));
-    }
-    f();
-  }));
-}