@playwright/test 1.31.2 → 1.32.0

package/lib/isomorphic/teleReceiver.js

@@ -0,0 +1,368 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.baseFullConfig = exports.TeleTestCase = exports.TeleSuite = exports.TeleReporterReceiver = void 0;
+exports.parseRegexPatterns = parseRegexPatterns;
+exports.serializeRegexPatterns = serializeRegexPatterns;
+/**
+ * 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.
+ */
+
+class TeleReporterReceiver {
+  constructor(reporter) {
+    this._rootSuite = void 0;
+    this._reporter = void 0;
+    this._tests = new Map();
+    this._rootSuite = new TeleSuite('', 'root');
+    this._reporter = reporter;
+  }
+  dispatch(message) {
+    const {
+      method,
+      params
+    } = message;
+    if (method === 'onBegin') {
+      this._onBegin(params.config, params.projects);
+      return;
+    }
+    if (method === 'onTestBegin') {
+      this._onTestBegin(params.testId, params.result);
+      return;
+    }
+    if (method === 'onTestEnd') {
+      this._onTestEnd(params.testId, params.result);
+      return;
+    }
+    if (method === 'onStepBegin') {
+      this._onStepBegin(params.testId, params.resultId, params.step);
+      return;
+    }
+    if (method === 'onStepEnd') {
+      this._onStepEnd(params.testId, params.resultId, params.step);
+      return;
+    }
+    if (method === 'onError') {
+      this._onError(params.error);
+      return;
+    }
+    if (method === 'onStdIO') {
+      this._onStdIO(params.type, params.testId, params.resultId, params.data, params.isBase64);
+      return;
+    }
+    if (method === 'onEnd') {
+      this._onEnd(params.result);
+      return;
+    }
+  }
+  _onBegin(config, projects) {
+    var _this$_reporter$onBeg, _this$_reporter;
+    const removeMissing = config.listOnly;
+    for (const project of projects) {
+      let projectSuite = this._rootSuite.suites.find(suite => suite.project().id === project.id);
+      if (!projectSuite) {
+        projectSuite = new TeleSuite(project.name, 'project');
+        this._rootSuite.suites.push(projectSuite);
+        projectSuite.parent = this._rootSuite;
+      }
+      const p = this._parseProject(project);
+      projectSuite.project = () => p;
+      this._mergeSuitesInto(project.suites, projectSuite, removeMissing);
+    }
+    (_this$_reporter$onBeg = (_this$_reporter = this._reporter).onBegin) === null || _this$_reporter$onBeg === void 0 ? void 0 : _this$_reporter$onBeg.call(_this$_reporter, this._parseConfig(config), this._rootSuite);
+  }
+  _onTestBegin(testId, payload) {
+    var _this$_reporter$onTes, _this$_reporter2;
+    const test = this._tests.get(testId);
+    const testResult = test._createTestResult(payload.id);
+    testResult.retry = payload.retry;
+    testResult.workerIndex = payload.workerIndex;
+    testResult.parallelIndex = payload.parallelIndex;
+    testResult.startTime = new Date(payload.startTime);
+    (_this$_reporter$onTes = (_this$_reporter2 = this._reporter).onTestBegin) === null || _this$_reporter$onTes === void 0 ? void 0 : _this$_reporter$onTes.call(_this$_reporter2, test, testResult);
+  }
+  _onTestEnd(testId, payload) {
+    var _this$_reporter$onTes2, _this$_reporter3;
+    const test = this._tests.get(testId);
+    const result = test.resultsMap.get(payload.id);
+    result.duration = payload.duration;
+    result.status = payload.status;
+    result.errors = payload.errors;
+    result.attachments = payload.attachments;
+    (_this$_reporter$onTes2 = (_this$_reporter3 = this._reporter).onTestEnd) === null || _this$_reporter$onTes2 === void 0 ? void 0 : _this$_reporter$onTes2.call(_this$_reporter3, test, result);
+  }
+  _onStepBegin(testId, resultId, payload) {
+    var _this$_reporter$onSte, _this$_reporter4;
+    const test = this._tests.get(testId);
+    const result = test.resultsMap.get(resultId);
+    const step = {
+      titlePath: () => [],
+      title: payload.title,
+      category: payload.category,
+      location: payload.location,
+      startTime: new Date(payload.startTime),
+      duration: 0,
+      steps: []
+    };
+    // TODO: implement nested steps.
+    result.stepMap.set(payload.id, step);
+    result.stepStack[result.stepStack.length - 1].steps.push(step);
+    result.stepStack.push(step);
+    (_this$_reporter$onSte = (_this$_reporter4 = this._reporter).onStepBegin) === null || _this$_reporter$onSte === void 0 ? void 0 : _this$_reporter$onSte.call(_this$_reporter4, test, result, step);
+  }
+  _onStepEnd(testId, resultId, payload) {
+    var _this$_reporter$onSte2, _this$_reporter5;
+    const test = this._tests.get(testId);
+    const result = test.resultsMap.get(resultId);
+    const step = result.stepMap.get(payload.id);
+    const i = result.stepStack.indexOf(step);
+    if (i !== -1) result.stepStack.splice(i, 1);
+    step.duration = payload.duration;
+    step.error = payload.error;
+    (_this$_reporter$onSte2 = (_this$_reporter5 = this._reporter).onStepEnd) === null || _this$_reporter$onSte2 === void 0 ? void 0 : _this$_reporter$onSte2.call(_this$_reporter5, test, result, step);
+  }
+  _onError(error) {
+    var _this$_reporter$onErr, _this$_reporter6;
+    (_this$_reporter$onErr = (_this$_reporter6 = this._reporter).onError) === null || _this$_reporter$onErr === void 0 ? void 0 : _this$_reporter$onErr.call(_this$_reporter6, error);
+  }
+  _onStdIO(type, testId, resultId, data, isBase64) {
+    var _this$_reporter$onStd, _this$_reporter7, _this$_reporter$onStd2, _this$_reporter8;
+    const chunk = isBase64 ? Buffer.from(data, 'base64') : data;
+    const test = testId ? this._tests.get(testId) : undefined;
+    const result = test && resultId ? test.resultsMap.get(resultId) : undefined;
+    if (type === 'stdout') (_this$_reporter$onStd = (_this$_reporter7 = this._reporter).onStdOut) === null || _this$_reporter$onStd === void 0 ? void 0 : _this$_reporter$onStd.call(_this$_reporter7, chunk, test, result);else (_this$_reporter$onStd2 = (_this$_reporter8 = this._reporter).onStdErr) === null || _this$_reporter$onStd2 === void 0 ? void 0 : _this$_reporter$onStd2.call(_this$_reporter8, chunk, test, result);
+  }
+  _onEnd(result) {
+    var _this$_reporter$onEnd, _this$_reporter9;
+    (_this$_reporter$onEnd = (_this$_reporter9 = this._reporter).onEnd) === null || _this$_reporter$onEnd === void 0 ? void 0 : _this$_reporter$onEnd.call(_this$_reporter9, result);
+  }
+  _parseConfig(config) {
+    const fullConfig = baseFullConfig;
+    fullConfig.rootDir = config.rootDir;
+    fullConfig.configFile = config.configFile;
+    return fullConfig;
+  }
+  _parseProject(project) {
+    return {
+      id: project.id,
+      metadata: project.metadata,
+      name: project.name,
+      outputDir: project.outputDir,
+      repeatEach: project.repeatEach,
+      retries: project.retries,
+      testDir: project.testDir,
+      testIgnore: parseRegexPatterns(project.testIgnore),
+      testMatch: parseRegexPatterns(project.testMatch),
+      timeout: project.timeout,
+      grep: parseRegexPatterns(project.grep),
+      grepInvert: parseRegexPatterns(project.grepInvert),
+      dependencies: project.dependencies,
+      snapshotDir: project.snapshotDir,
+      use: {}
+    };
+  }
+  _mergeSuitesInto(jsonSuites, parent, removeMissing) {
+    for (const jsonSuite of jsonSuites) {
+      let targetSuite = parent.suites.find(s => s.title === jsonSuite.title);
+      if (!targetSuite) {
+        targetSuite = new TeleSuite(jsonSuite.title, jsonSuite.type);
+        targetSuite.parent = parent;
+        parent.suites.push(targetSuite);
+      }
+      targetSuite.location = jsonSuite.location;
+      targetSuite._fileId = jsonSuite.fileId;
+      targetSuite._parallelMode = jsonSuite.parallelMode;
+      this._mergeSuitesInto(jsonSuite.suites, targetSuite, removeMissing);
+      this._mergeTestsInto(jsonSuite.tests, targetSuite, removeMissing);
+    }
+    if (removeMissing) {
+      const suiteMap = new Map(parent.suites.map(p => [p.title, p]));
+      parent.suites = jsonSuites.map(s => suiteMap.get(s.title)).filter(Boolean);
+    }
+  }
+  _mergeTestsInto(jsonTests, parent, removeMissing) {
+    for (const jsonTest of jsonTests) {
+      let targetTest = parent.tests.find(s => s.title === jsonTest.title);
+      if (!targetTest) {
+        targetTest = new TeleTestCase(jsonTest.testId, jsonTest.title, jsonTest.location);
+        targetTest.parent = parent;
+        parent.tests.push(targetTest);
+        this._tests.set(targetTest.id, targetTest);
+      }
+      this._updateTest(jsonTest, targetTest);
+    }
+    if (removeMissing) {
+      const testMap = new Map(parent.tests.map(p => [p.title, p]));
+      parent.tests = jsonTests.map(s => testMap.get(s.title)).filter(Boolean);
+    }
+  }
+  _updateTest(payload, test) {
+    test.id = payload.testId;
+    test.expectedStatus = payload.expectedStatus;
+    test.timeout = payload.timeout;
+    test.location = payload.location;
+    test.annotations = payload.annotations;
+    test.retries = payload.retries;
+    return test;
+  }
+}
+exports.TeleReporterReceiver = TeleReporterReceiver;
+class TeleSuite {
+  constructor(title, type) {
+    this.title = void 0;
+    this.location = void 0;
+    this.parent = void 0;
+    this._requireFile = '';
+    this.suites = [];
+    this.tests = [];
+    this._timeout = void 0;
+    this._retries = void 0;
+    this._fileId = void 0;
+    this._parallelMode = 'default';
+    this._type = void 0;
+    this.title = title;
+    this._type = type;
+  }
+  allTests() {
+    const result = [];
+    const visit = suite => {
+      for (const entry of [...suite.suites, ...suite.tests]) {
+        if (entry instanceof TeleSuite) visit(entry);else result.push(entry);
+      }
+    };
+    visit(this);
+    return result;
+  }
+  titlePath() {
+    const titlePath = this.parent ? this.parent.titlePath() : [];
+    // Ignore anonymous describe blocks.
+    if (this.title || this._type !== 'describe') titlePath.push(this.title);
+    return titlePath;
+  }
+  project() {
+    return undefined;
+  }
+}
+exports.TeleSuite = TeleSuite;
+class TeleTestCase {
+  constructor(id, title, location) {
+    this.title = void 0;
+    this.fn = () => {};
+    this.results = [];
+    this.location = void 0;
+    this.parent = void 0;
+    this.expectedStatus = 'passed';
+    this.timeout = 0;
+    this.annotations = [];
+    this.retries = 0;
+    this.repeatEachIndex = 0;
+    this.id = void 0;
+    this.resultsMap = new Map();
+    this.id = id;
+    this.title = title;
+    this.location = location;
+  }
+  titlePath() {
+    const titlePath = this.parent ? this.parent.titlePath() : [];
+    titlePath.push(this.title);
+    return titlePath;
+  }
+  outcome() {
+    const nonSkipped = this.results.filter(result => result.status !== 'skipped' && result.status !== 'interrupted');
+    if (!nonSkipped.length) return 'skipped';
+    if (nonSkipped.every(result => result.status === this.expectedStatus)) return 'expected';
+    if (nonSkipped.some(result => result.status === this.expectedStatus)) return 'flaky';
+    return 'unexpected';
+  }
+  ok() {
+    const status = this.outcome();
+    return status === 'expected' || status === 'flaky' || status === 'skipped';
+  }
+  _clearResults() {
+    this.results = [];
+    this.resultsMap.clear();
+  }
+  _createTestResult(id) {
+    this._clearResults();
+    const result = {
+      retry: this.results.length,
+      parallelIndex: -1,
+      workerIndex: -1,
+      duration: -1,
+      startTime: new Date(),
+      stdout: [],
+      stderr: [],
+      attachments: [],
+      status: 'skipped',
+      steps: [],
+      errors: [],
+      stepMap: new Map(),
+      stepStack: []
+    };
+    result.stepStack.push(result);
+    this.results.push(result);
+    this.resultsMap.set(id, result);
+    return result;
+  }
+}
+exports.TeleTestCase = TeleTestCase;
+const baseFullConfig = {
+  forbidOnly: false,
+  fullyParallel: false,
+  globalSetup: null,
+  globalTeardown: null,
+  globalTimeout: 0,
+  grep: /.*/,
+  grepInvert: null,
+  maxFailures: 0,
+  metadata: {},
+  preserveOutput: 'always',
+  projects: [],
+  reporter: [[process.env.CI ? 'dot' : 'list']],
+  reportSlowTests: {
+    max: 5,
+    threshold: 15000
+  },
+  configFile: '',
+  rootDir: '',
+  quiet: false,
+  shard: null,
+  updateSnapshots: 'missing',
+  version: '',
+  workers: 0,
+  webServer: null
+};
+exports.baseFullConfig = baseFullConfig;
+function serializeRegexPatterns(patterns) {
+  if (!Array.isArray(patterns)) patterns = [patterns];
+  return patterns.map(s => {
+    if (typeof s === 'string') return {
+      s
+    };
+    return {
+      r: {
+        source: s.source,
+        flags: s.flags
+      }
+    };
+  });
+}
+function parseRegexPatterns(patterns) {
+  return patterns.map(p => {
+    if (p.s) return p.s;
+    return new RegExp(p.r.source, p.r.flags);
+  });
+}

package/lib/matchers/expect.js

@@ -5,13 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.printReceivedStringContainExpectedSubstring = exports.printReceivedStringContainExpectedResult = exports.expect = void 0;
 var _utils = require("playwright-core/lib/utils");
-var _path = _interopRequireDefault(require("path"));
 var _matchers = require("./matchers");
 var _toMatchSnapshot = require("./toMatchSnapshot");
 var _globals = require("../common/globals");
 var _util = require("../util");
 var _expectBundle = require("../common/expectBundle");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * Copyright Microsoft Corporation. All rights reserved.
  *
@@ -40,6 +38,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // Format substring but do not enclose in double quote marks.
 // The replacement is compatible with pretty-format package.
 const printSubstring = val => val.replace(/"|\\/g, '\\$&');
+let lastCallId = 0;
 const printReceivedStringContainExpectedSubstring = (received, start, length // not end
 ) => (0, _expectBundle.RECEIVED_COLOR)('"' + printSubstring(received.slice(0, start)) + (0, _expectBundle.INVERTED_COLOR)(printSubstring(received.slice(start, start + length))) + printSubstring(received.slice(start + length)) + '"');
 exports.printReceivedStringContainExpectedSubstring = printReceivedStringContainExpectedSubstring;
@@ -102,7 +101,8 @@ class ExpectMetaInfoProxyHandler {
       isSoft,
       isPoll,
       generator,
-      isNot: false
+      isNot: false,
+      nameTokens: []
     };
     if (typeof messageOrOptions === 'string') {
       this._info.message = messageOrOptions;
@@ -114,6 +114,7 @@ class ExpectMetaInfoProxyHandler {
   }
   get(target, matcherName, receiver) {
     let matcher = Reflect.get(target, matcherName, receiver);
+    if (typeof matcherName !== 'string') return matcher;
     if (matcher === undefined) throw new Error(`expect: Property '${matcherName}' not found.`);
     if (typeof matcher !== 'function') {
       if (matcherName === 'not') this._info.isNot = !this._info.isNot;
@@ -128,23 +129,23 @@ class ExpectMetaInfoProxyHandler {
     return (...args) => {
       const testInfo = (0, _globals.currentTestInfo)();
       if (!testInfo) return matcher.call(target, ...args);
-      const stackTrace = (0, _util.captureStackTrace)();
-      const stackLines = stackTrace.frameTexts;
-      const frame = stackTrace.frames[0];
+      const rawStack = (0, _utils.captureRawStack)();
+      const stackFrames = (0, _util.filteredStackTrace)(rawStack);
       const customMessage = this._info.message || '';
       const defaultTitle = `expect${this._info.isPoll ? '.poll' : ''}${this._info.isSoft ? '.soft' : ''}${this._info.isNot ? '.not' : ''}.${matcherName}`;
+      const wallTime = Date.now();
       const step = testInfo._addStep({
-        location: frame && frame.file ? {
-          file: _path.default.resolve(process.cwd(), frame.file),
-          line: frame.line || 0,
-          column: frame.column || 0
-        } : undefined,
+        location: stackFrames[0],
         category: 'expect',
         title: (0, _util.trimLongString)(customMessage || defaultTitle, 1024),
         canHaveChildren: true,
-        forceNoParent: false
+        forceNoParent: false,
+        wallTime
       });
       testInfo.currentStep = step;
+      const generateTraceEvent = matcherName !== 'poll' && matcherName !== 'toPass';
+      const callId = ++lastCallId;
+      if (generateTraceEvent) testInfo._traceEvents.push((0, _utils.createBeforeActionTraceEventForExpect)(`expect@${callId}`, defaultTitle, args[0], stackFrames));
       const reportStepError = jestError => {
         const message = jestError.message;
         if (customMessage) {
@@ -156,19 +157,37 @@ class ExpectMetaInfoProxyHandler {
             // if there's a newline after the matcher text, then remove it as well.
             if (uselessMatcherLineIndex + 1 < messageLines.length && messageLines[uselessMatcherLineIndex + 1].trim() === '') messageLines.splice(uselessMatcherLineIndex, 2);else messageLines.splice(uselessMatcherLineIndex, 1);
           }
-          const newMessage = ['Error: ' + customMessage, '', ...messageLines].join('\n');
+          const newMessage = [customMessage, '', ...messageLines].join('\n');
           jestError.message = newMessage;
-          jestError.stack = newMessage + '\n' + stackLines.join('\n');
+          jestError.stack = jestError.name + ': ' + newMessage + '\n' + (0, _util.stringifyStackFrames)(stackFrames).join('\n');
         }
         const serializerError = (0, _util.serializeError)(jestError);
+        if (generateTraceEvent) {
+          const error = {
+            name: jestError.name,
+            message: jestError.message,
+            stack: jestError.stack
+          };
+          testInfo._traceEvents.push((0, _utils.createAfterActionTraceEventForExpect)(`expect@${callId}`, error));
+        }
         step.complete({
           error: serializerError
         });
         if (this._info.isSoft) testInfo._failWithError(serializerError, false /* isHardError */);else throw jestError;
       };
+      const finalizer = () => {
+        if (generateTraceEvent) testInfo._traceEvents.push((0, _utils.createAfterActionTraceEventForExpect)(`expect@${callId}`));
+        step.complete({});
+      };
       try {
-        const result = matcher.call(target, ...args);
-        if (result instanceof Promise) return result.then(() => step.complete({})).catch(reportStepError);else step.complete({});
+        const expectZone = {
+          title: defaultTitle,
+          wallTime
+        };
+        const result = _utils.zones.run('expectZone', expectZone, () => {
+          return matcher.call(target, ...args);
+        });
+        if (result instanceof Promise) return result.then(() => finalizer()).catch(reportStepError);else finalizer();
       } catch (e) {
         reportStepError(e);
       }