@playwright/test 1.34.0-alpha-may-1-2023 → 1.34.0-alpha-may-2-2023

package/lib/common/globals.js

@@ -6,11 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.currentConfig = currentConfig;
 exports.currentExpectTimeout = currentExpectTimeout;
 exports.currentTestInfo = currentTestInfo;
+exports.currentTestInstrumentation = currentTestInstrumentation;
 exports.currentlyLoadingFileSuite = currentlyLoadingFileSuite;
 exports.isWorkerProcess = isWorkerProcess;
 exports.setCurrentConfig = setCurrentConfig;
 exports.setCurrentExpectConfigureTimeout = setCurrentExpectConfigureTimeout;
 exports.setCurrentTestInfo = setCurrentTestInfo;
+exports.setCurrentTestInstrumentation = setCurrentTestInstrumentation;
 exports.setCurrentlyLoadingFileSuite = setCurrentlyLoadingFileSuite;
 exports.setIsWorkerProcess = setIsWorkerProcess;
 /**
@@ -69,4 +71,11 @@ function setCurrentConfig(config) {
 }
 function currentConfig() {
   return currentConfigValue;
+}
+let testInstrumentation;
+function setCurrentTestInstrumentation(instrumentation) {
+  testInstrumentation = instrumentation;
+}
+function currentTestInstrumentation() {
+  return testInstrumentation;
 }

package/lib/index.js

@@ -24,6 +24,7 @@ var playwrightLibrary = _interopRequireWildcard(require("playwright-core"));
 var _utils = require("playwright-core/lib/utils");
 var _testType = require("./common/testType");
 var _folders = require("./isomorphic/folders");
+var _globals = require("./common/globals");
 var _expect = require("./matchers/expect");
 var _store = require("./store");
 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); }
@@ -427,15 +428,15 @@ const playwrightFixtures = {
     _artifactsDir,
     trace,
     screenshot
-  }, use, testInfo) => {
-    const artifactsRecorder = new ArtifactsRecorder(playwright, _artifactsDir(), trace, screenshot);
-    const testInfoImpl = testInfo;
+  }, use) => {
+    let artifactsRecorder;
     const csiListener = {
       onApiCallBegin: (apiCall, stackTrace, wallTime, userData) => {
-        if (apiCall.startsWith('expect.')) return {
+        const testInfo = (0, _globals.currentTestInfo)();
+        if (!testInfo || apiCall.startsWith('expect.') || apiCall.includes('setTestIdAttribute')) return {
           userObject: null
         };
-        const step = testInfoImpl._addStep({
+        const step = testInfo._addStep({
           location: stackTrace === null || stackTrace === void 0 ? void 0 : stackTrace.frames[0],
           category: 'pw:api',
           title: apiCall,
@@ -450,35 +451,71 @@ const playwrightFixtures = {
         });
       },
       onWillPause: () => {
-        testInfo.setTimeout(0);
+        var _currentTestInfo;
+        (_currentTestInfo = (0, _globals.currentTestInfo)()) === null || _currentTestInfo === void 0 ? void 0 : _currentTestInfo.setTimeout(0);
       },
       onDidCreateBrowserContext: async context => {
-        await artifactsRecorder.didCreateBrowserContext(context);
-        attachConnectedHeaderIfNeeded(testInfo, context.browser());
+        var _artifactsRecorder;
+        await ((_artifactsRecorder = artifactsRecorder) === null || _artifactsRecorder === void 0 ? void 0 : _artifactsRecorder.didCreateBrowserContext(context));
+        const testInfo = (0, _globals.currentTestInfo)();
+        if (testInfo) attachConnectedHeaderIfNeeded(testInfo, context.browser());
       },
       onDidCreateRequestContext: async context => {
-        await artifactsRecorder.didCreateRequestContext(context);
+        var _artifactsRecorder2;
+        await ((_artifactsRecorder2 = artifactsRecorder) === null || _artifactsRecorder2 === void 0 ? void 0 : _artifactsRecorder2.didCreateRequestContext(context));
       },
       onWillCloseBrowserContext: async context => {
-        await artifactsRecorder.willCloseBrowserContext(context);
+        var _artifactsRecorder3;
+        await ((_artifactsRecorder3 = artifactsRecorder) === null || _artifactsRecorder3 === void 0 ? void 0 : _artifactsRecorder3.willCloseBrowserContext(context));
       },
       onWillCloseRequestContext: async context => {
-        await artifactsRecorder.willCloseRequestContext(context);
+        var _artifactsRecorder4;
+        await ((_artifactsRecorder4 = artifactsRecorder) === null || _artifactsRecorder4 === void 0 ? void 0 : _artifactsRecorder4.willCloseRequestContext(context));
       }
     };
+    const willStartTest = async testInfo => {
+      artifactsRecorder = new ArtifactsRecorder(playwright, _artifactsDir(), trace, screenshot);
+      await artifactsRecorder.willStartTest(testInfo);
+    };
+    const didFinishTestFunction = async testInfo => {
+      var _artifactsRecorder5;
+      await ((_artifactsRecorder5 = artifactsRecorder) === null || _artifactsRecorder5 === void 0 ? void 0 : _artifactsRecorder5.didFinishTestFunction());
+    };
+    const didFinishTest = async testInfo => {
+      var _artifactsRecorder6;
+      await ((_artifactsRecorder6 = artifactsRecorder) === null || _artifactsRecorder6 === void 0 ? void 0 : _artifactsRecorder6.didFinishTest());
+      artifactsRecorder = undefined;
+    };
+
+    // 1. Setup instrumentation.
+    const clientInstrumentation = playwright._instrumentation;
+    clientInstrumentation.addListener(csiListener);
+    (0, _globals.setCurrentTestInstrumentation)({
+      willStartTest,
+      didFinishTestFunction,
+      didFinishTest
+    });
 
-    // 1. Setup instrumentation and process existing contexts.
-    const instrumentation = playwright._instrumentation;
-    instrumentation.addListener(csiListener);
-    await artifactsRecorder.testStarted(testInfoImpl);
+    // 2. Setup for the first test in the worker.
+    {
+      const firstTestInfo = (0, _globals.currentTestInfo)();
+      if (firstTestInfo) await willStartTest(firstTestInfo);
+    }
 
     // 2. Run the test.
     await use();
 
-    // 3. Cleanup instrumentation.
-    await artifactsRecorder.testFinished();
-    instrumentation.removeListener(csiListener);
+    // 3. Teardown for the last test in the worker.
+    {
+      const lastTestInfo = (0, _globals.currentTestInfo)();
+      if (lastTestInfo) await didFinishTest(lastTestInfo);
+    }
+
+    // 4. Cleanup instrumentation.
+    (0, _globals.setCurrentTestInstrumentation)(undefined);
+    clientInstrumentation.removeListener(csiListener);
   }, {
+    scope: 'worker',
     auto: 'all-hooks-included',
     _title: 'trace recording'
   }],
@@ -681,7 +718,6 @@ class ArtifactsRecorder {
     this._traceOrdinal = 0;
     this._screenshottedSymbol = void 0;
     this._startedCollectingArtifacts = void 0;
-    this._screenshotOnTestFailureBound = void 0;
     this._playwright = playwright;
     this._artifactsDir = artifactsDir;
     this._screenshotMode = normalizeScreenshotMode(screenshot);
@@ -699,9 +735,8 @@ class ArtifactsRecorder {
     };
     this._screenshottedSymbol = Symbol('screenshotted');
     this._startedCollectingArtifacts = Symbol('startedCollectingArtifacts');
-    this._screenshotOnTestFailureBound = this._screenshotOnTestFailure.bind(this);
   }
-  async testStarted(testInfo) {
+  async willStartTest(testInfo) {
     this._testInfo = testInfo;
     this._captureTrace = shouldCaptureTrace(this._traceMode, testInfo) && !process.env.PW_TEST_DISABLE_TRACING;
 
@@ -718,9 +753,6 @@ class ArtifactsRecorder {
       const existingApiRequests = Array.from(this._playwright.request._contexts);
       await Promise.all(existingApiRequests.map(c => this.didCreateRequestContext(c)));
     }
-
-    // Setup "screenshot on failure" callback.
-    if (this._screenshotMode === 'on' || this._screenshotMode === 'only-on-failure') testInfo._onTestFailureImmediateCallbacks.set(this._screenshotOnTestFailureBound, 'Screenshot on failure');
   }
   async didCreateBrowserContext(context) {
     await this._startTraceChunkOnContextCreation(context.tracing);
@@ -744,12 +776,14 @@ class ArtifactsRecorder {
     const tracing = context._tracing;
     await this._stopTracing(tracing, context[kStartedContextTearDown]);
   }
-  async testFinished() {
+  async didFinishTestFunction() {
+    if (this._testInfo._isFailure() && (this._screenshotMode === 'on' || this._screenshotMode === 'only-on-failure')) await this._screenshotOnTestFailure();
+  }
+  async didFinishTest() {
     const captureScreenshots = this._screenshotMode === 'on' || this._screenshotMode === 'only-on-failure' && this._testInfo.status !== this._testInfo.expectedStatus;
     const leftoverContexts = [];
     for (const browserType of [this._playwright.chromium, this._playwright.firefox, this._playwright.webkit]) leftoverContexts.push(...browserType._contexts);
     const leftoverApiRequests = Array.from(this._playwright.request._contexts);
-    this._testInfo._onTestFailureImmediateCallbacks.delete(this._screenshotOnTestFailureBound);
 
     // Collect traces/screenshots for remaining contexts.
     await Promise.all(leftoverContexts.map(async context => {

package/lib/matchers/expect.js

@@ -26,6 +26,8 @@ var _expectBundle = require("../common/expectBundle");
  * limitations under the License.
  */
 
+// from expect/build/types
+
 // #region
 // Mirrored from https://github.com/facebook/jest/blob/f13abff8df9a0e1148baf3584bcde6d1b479edc7/packages/expect/src/print.ts
 /**

package/lib/reporters/junit.js

@@ -36,14 +36,8 @@ class JUnitReporter {
     this.totalSkipped = 0;
     this.outputFile = void 0;
     this.stripANSIControlSequences = false;
-    this.embedAnnotationsAsProperties = false;
-    this.textContentAnnotations = void 0;
-    this.embedAttachmentsAsProperty = void 0;
     this.outputFile = options.outputFile || reportOutputNameFromEnv();
     this.stripANSIControlSequences = options.stripANSIControlSequences || false;
-    this.embedAnnotationsAsProperties = options.embedAnnotationsAsProperties || false;
-    this.textContentAnnotations = options.textContentAnnotations || [];
-    this.embedAttachmentsAsProperty = options.embedAttachmentsAsProperty;
   }
   printsToStdio() {
     return !this.outputFile;
@@ -121,7 +115,7 @@ class JUnitReporter {
     return entry;
   }
   _addTestCase(suiteName, test, entries) {
-    var _properties$children4;
+    var _properties$children2;
     const entry = {
       name: 'testcase',
       attributes: {
@@ -142,72 +136,18 @@ class JUnitReporter {
       name: 'properties',
       children: []
     };
-    if (this.embedAnnotationsAsProperties && test.annotations) {
-      for (const annotation of test.annotations) {
-        var _this$textContentAnno;
-        if ((_this$textContentAnno = this.textContentAnnotations) !== null && _this$textContentAnno !== void 0 && _this$textContentAnno.includes(annotation.type)) {
-          var _properties$children;
-          const property = {
-            name: 'property',
-            attributes: {
-              name: annotation.type
-            },
-            text: annotation.description
-          };
-          (_properties$children = properties.children) === null || _properties$children === void 0 ? void 0 : _properties$children.push(property);
-        } else {
-          var _properties$children2;
-          const property = {
-            name: 'property',
-            attributes: {
-              name: annotation.type,
-              value: annotation !== null && annotation !== void 0 && annotation.description ? annotation.description : ''
-            }
-          };
-          (_properties$children2 = properties.children) === null || _properties$children2 === void 0 ? void 0 : _properties$children2.push(property);
-        }
-      }
-    }
-    const systemErr = [];
-    // attachments are optionally embed as base64 encoded content on inner <item> elements
-    if (this.embedAttachmentsAsProperty) {
-      var _properties$children3;
-      const evidence = {
+    for (const annotation of test.annotations) {
+      var _properties$children;
+      const property = {
         name: 'property',
         attributes: {
-          name: this.embedAttachmentsAsProperty
-        },
-        children: []
-      };
-      for (const result of test.results) {
-        for (const attachment of result.attachments) {
-          let contents;
-          if (attachment.body) {
-            contents = attachment.body.toString('base64');
-          } else {
-            if (!attachment.path) continue;
-            try {
-              if (_fs.default.existsSync(attachment.path)) contents = _fs.default.readFileSync(attachment.path, {
-                encoding: 'base64'
-              });else systemErr.push(`\nWarning: attachment ${attachment.path} is missing`);
-            } catch (e) {}
-          }
-          if (contents) {
-            var _evidence$children;
-            const item = {
-              name: 'item',
-              attributes: {
-                name: attachment.name
-              },
-              text: contents
-            };
-            (_evidence$children = evidence.children) === null || _evidence$children === void 0 ? void 0 : _evidence$children.push(item);
-          }
+          name: annotation.type,
+          value: annotation !== null && annotation !== void 0 && annotation.description ? annotation.description : ''
         }
-      }
-      (_properties$children3 = properties.children) === null || _properties$children3 === void 0 ? void 0 : _properties$children3.push(evidence);
+      };
+      (_properties$children = properties.children) === null || _properties$children === void 0 ? void 0 : _properties$children.push(property);
     }
-    if ((_properties$children4 = properties.children) !== null && _properties$children4 !== void 0 && _properties$children4.length) entry.children.push(properties);
+    if ((_properties$children2 = properties.children) !== null && _properties$children2 !== void 0 && _properties$children2.length) entry.children.push(properties);
     if (test.outcome() === 'skipped') {
       entry.children.push({
         name: 'skipped'
@@ -225,17 +165,16 @@ class JUnitReporter {
       });
     }
     const systemOut = [];
+    const systemErr = [];
     for (const result of test.results) {
       systemOut.push(...result.stdout.map(item => item.toString()));
       systemErr.push(...result.stderr.map(item => item.toString()));
-      if (!this.embedAttachmentsAsProperty) {
-        for (const attachment of result.attachments) {
-          if (!attachment.path) continue;
-          try {
-            const attachmentPath = _path.default.relative(this.config.rootDir, attachment.path);
-            if (_fs.default.existsSync(attachment.path)) systemOut.push(`\n[[ATTACHMENT|${attachmentPath}]]\n`);else systemErr.push(`\nWarning: attachment ${attachmentPath} is missing`);
-          } catch (e) {}
-        }
+      for (const attachment of result.attachments) {
+        if (!attachment.path) continue;
+        try {
+          const attachmentPath = _path.default.relative(this.config.rootDir, attachment.path);
+          if (_fs.default.existsSync(attachment.path)) systemOut.push(`\n[[ATTACHMENT|${attachmentPath}]]\n`);else systemErr.push(`\nWarning: attachment ${attachmentPath} is missing`);
+        } catch (e) {}
       }
     }
     // Note: it is important to only produce a single system-out/system-err entry

package/lib/reporters/merge.js

@@ -89,7 +89,10 @@ function mergeEvents(shardReports) {
       if (event.method === 'onBegin') beginEvents.push(event);else if (event.method === 'onEnd') endEvents.push(event);else events.push(event);
     }
   }
-  return [mergeBeginEvents(beginEvents), ...events, mergeEndEvents(endEvents)];
+  return [mergeBeginEvents(beginEvents), ...events, mergeEndEvents(endEvents), {
+    method: 'onExit',
+    params: undefined
+  }];
 }
 function mergeBeginEvents(beginEvents) {
   if (!beginEvents.length) throw new Error('No begin events found');

package/lib/reporters/teleEmitter.js

@@ -130,6 +130,7 @@ class TeleReporterEmitter {
       }
     });
   }
+  async onExit() {}
   _serializeConfig(config) {
     var _FullConfigInternal$f;
     return {

package/lib/runner/dispatcher.js

@@ -186,7 +186,9 @@ class Dispatcher {
     };
     const remainingByTestId = new Map(testGroup.tests.map(e => [e.id, e]));
     const failedTestIds = new Set();
+    let runningTest = false;
     const onTestBegin = params => {
+      runningTest = true;
       const data = this._testById.get(params.testId);
       const result = data.test._appendTestResult();
       data.resultByWorkerIndex.set(worker.workerIndex, {
@@ -201,6 +203,7 @@ class Dispatcher {
     };
     worker.addListener('testBegin', onTestBegin);
     const onTestEnd = params => {
+      runningTest = false;
       remainingByTestId.delete(params.testId);
       if (this._hasReachedMaxFailures()) {
         // Do not show more than one error to avoid confusion, but report
@@ -313,7 +316,7 @@ class Dispatcher {
             if (runData) {
               result = runData.result;
             } else {
-              if (onlyStartedTests) return true;
+              if (onlyStartedTests && runningTest) return true;
               result = data.test._appendTestResult();
               this._reporter.onTestBegin(test, result);
             }

package/lib/third_party/tsconfig-loader.js

@@ -36,6 +36,10 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 
 /* eslint-disable */
 
+/**
+ * Typing for the parts of tsconfig that we care about
+ */
+
 function tsConfigLoader({
   cwd
 }) {

package/lib/worker/testInfo.js

@@ -27,8 +27,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 class TestInfoImpl {
-  // fn -> title
-
   // ------------ TestInfo fields ------------
 
   get error() {
@@ -53,7 +51,6 @@ class TestInfoImpl {
     this._startWallTime = void 0;
     this._hasHardError = false;
     this._traceEvents = [];
-    this._onTestFailureImmediateCallbacks = new Map();
     this._didTimeout = false;
     this._wasInterrupted = false;
     this._lastStepId = 0;

package/lib/worker/workerMain.js

@@ -41,18 +41,12 @@ class WorkerMain extends _process.ProcessRunner {
 
   // Whether we should skip running remaining tests in this suite because
   // of a setup error, usually beforeAll hook.
-
   // The stage of the full cleanup. Once "finished", we can safely stop running anything.
-
   // Whether the worker was requested to stop.
-
   // This promise resolves once the single "run test group" call finishes.
-
   // Dynamic annotations originated by modifiers with a callback, e.g. `test.skip(() => true)`.
-
   // Suites that had their beforeAll hooks, but not afterAll hooks executed.
   // These suites still need afterAll hooks to be executed for the proper cleanup.
-
   constructor(params) {
     super();
     this._params = void 0;
@@ -300,6 +294,9 @@ class WorkerMain extends _process.ProcessRunner {
         // Note: wrap all preparation steps together, because failure/skip in any of them
         // prevents further setup and/or test from running.
         const beforeHooksError = await testInfo._runAndFailOnError(async () => {
+          var _currentTestInstrumen;
+          await ((_currentTestInstrumen = (0, _globals.currentTestInstrumentation)()) === null || _currentTestInstrumen === void 0 ? void 0 : _currentTestInstrumen.willStartTest(testInfo));
+
           // Run "beforeAll" modifiers on parent suites, unless already run during previous tests.
           for (const suite of suites) {
             if (this._extraSuiteAnnotations.has(suite)) continue;
@@ -379,24 +376,14 @@ class WorkerMain extends _process.ProcessRunner {
         // Note: do not wrap all teardown steps together, because failure in any of them
         // does not prevent further teardown steps from running.
 
-        // Run "immediately upon test failure" callbacks.
-        if (testInfo._isFailure()) {
-          const onFailureError = await testInfo._runAndFailOnError(async () => {
-            testInfo._timeoutManager.setCurrentRunnable({
-              type: 'test',
-              slot: afterHooksSlot
-            });
-            for (const [fn, title] of testInfo._onTestFailureImmediateCallbacks) {
-              (0, _util2.debugTest)(`on-failure callback started`);
-              await testInfo._runAsStep({
-                category: 'hook',
-                title
-              }, fn);
-              (0, _util2.debugTest)(`on-failure callback finished`);
-            }
-          });
-          firstAfterHooksError = firstAfterHooksError || onFailureError;
-        }
+        // Run "immediately upon test function finish" callback.
+        (0, _util2.debugTest)(`on-test-function-finish callback started`);
+        const didFinishTestFunctionError = await testInfo._runAndFailOnError(async () => {
+          var _currentTestInstrumen2;
+          return await ((_currentTestInstrumen2 = (0, _globals.currentTestInstrumentation)()) === null || _currentTestInstrumen2 === void 0 ? void 0 : _currentTestInstrumen2.didFinishTestFunction(testInfo));
+        });
+        firstAfterHooksError = firstAfterHooksError || didFinishTestFunctionError;
+        (0, _util2.debugTest)(`on-test-function-finish callback finished`);
 
         // Run "afterEach" hooks, unless we failed at beforeAll stage.
         if (shouldRunAfterEachHooks) {
@@ -462,6 +449,11 @@ class WorkerMain extends _process.ProcessRunner {
           firstAfterHooksError = firstAfterHooksError || workerScopeError;
         });
       }
+      const didRunTestError = await testInfo._runAndFailOnError(async () => {
+        var _currentTestInstrumen3;
+        return await ((_currentTestInstrumen3 = (0, _globals.currentTestInstrumentation)()) === null || _currentTestInstrumen3 === void 0 ? void 0 : _currentTestInstrumen3.didFinishTest(testInfo));
+      });
+      firstAfterHooksError = firstAfterHooksError || didRunTestError;
       if (firstAfterHooksError) step.complete({
         error: firstAfterHooksError
       });

package/package.json

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