@playwright/test 1.36.0-alpha-jun-27-2023 → 1.36.0-alpha-jun-28-2023

package/lib/matchers/toMatchSnapshot.js

@@ -97,15 +97,15 @@ class SnapshotHelper {
     if (options.maxDiffPixelRatio !== undefined && (options.maxDiffPixelRatio < 0 || options.maxDiffPixelRatio > 1)) throw new Error('`maxDiffPixelRatio` option value must be between 0 and 1');
 
     // sanitizes path if string
-    const inputPathSegments = Array.isArray(name) ? name : [(0, _util.addSuffixToFilePath)(name, '', undefined, true)];
-    const outputPathSegments = Array.isArray(name) ? name : [(0, _util.addSuffixToFilePath)(name, actualModifier, undefined, true)];
+    const inputPathSegments = Array.isArray(name) ? name : [addSuffixToFilePath(name, '', undefined, true)];
+    const outputPathSegments = Array.isArray(name) ? name : [addSuffixToFilePath(name, actualModifier, undefined, true)];
     this.snapshotPath = snapshotPathResolver(...inputPathSegments);
     const inputFile = testInfo.outputPath(...inputPathSegments);
     const outputFile = testInfo.outputPath(...outputPathSegments);
-    this.expectedPath = (0, _util.addSuffixToFilePath)(inputFile, '-expected');
-    this.previousPath = (0, _util.addSuffixToFilePath)(outputFile, '-previous');
-    this.actualPath = (0, _util.addSuffixToFilePath)(outputFile, '-actual');
-    this.diffPath = (0, _util.addSuffixToFilePath)(outputFile, '-diff');
+    this.expectedPath = addSuffixToFilePath(inputFile, '-expected');
+    this.previousPath = addSuffixToFilePath(outputFile, '-previous');
+    this.actualPath = addSuffixToFilePath(outputFile, '-actual');
+    this.diffPath = addSuffixToFilePath(outputFile, '-diff');
     this.updateSnapshots = testInfo.config.updateSnapshots;
     if (this.updateSnapshots === 'missing' && testInfo.retry < testInfo.project.retries) this.updateSnapshots = 'none';
     this.mimeType = (_mime$getType = _utilsBundle.mime.getType(_path.default.basename(this.snapshotPath))) !== null && _mime$getType !== void 0 ? _mime$getType : 'application/octet-string';
@@ -150,7 +150,7 @@ class SnapshotHelper {
       writeFileSync(this.snapshotPath, actual);
       writeFileSync(this.actualPath, actual);
       this.testInfo.attachments.push({
-        name: (0, _util.addSuffixToFilePath)(this.snapshotName, '-actual'),
+        name: addSuffixToFilePath(this.snapshotName, '-actual'),
         contentType: this.mimeType,
         path: this.actualPath
       });
@@ -183,7 +183,7 @@ class SnapshotHelper {
     if (expected !== undefined) {
       writeFileSync(this.expectedPath, expected);
       this.testInfo.attachments.push({
-        name: (0, _util.addSuffixToFilePath)(this.snapshotName, '-expected'),
+        name: addSuffixToFilePath(this.snapshotName, '-expected'),
         contentType: this.mimeType,
         path: this.expectedPath
       });
@@ -192,7 +192,7 @@ class SnapshotHelper {
     if (previous !== undefined) {
       writeFileSync(this.previousPath, previous);
       this.testInfo.attachments.push({
-        name: (0, _util.addSuffixToFilePath)(this.snapshotName, '-previous'),
+        name: addSuffixToFilePath(this.snapshotName, '-previous'),
         contentType: this.mimeType,
         path: this.previousPath
       });
@@ -201,7 +201,7 @@ class SnapshotHelper {
     if (actual !== undefined) {
       writeFileSync(this.actualPath, actual);
       this.testInfo.attachments.push({
-        name: (0, _util.addSuffixToFilePath)(this.snapshotName, '-actual'),
+        name: addSuffixToFilePath(this.snapshotName, '-actual'),
         contentType: this.mimeType,
         path: this.actualPath
       });
@@ -210,7 +210,7 @@ class SnapshotHelper {
     if (diff !== undefined) {
       writeFileSync(this.diffPath, diff);
       this.testInfo.attachments.push({
-        name: (0, _util.addSuffixToFilePath)(this.snapshotName, '-diff'),
+        name: addSuffixToFilePath(this.snapshotName, '-diff'),
         contentType: this.mimeType,
         path: this.diffPath
       });
@@ -399,4 +399,14 @@ function determineFileExtension(file) {
 }
 function compareMagicBytes(file, magicBytes) {
   return Buffer.compare(Buffer.from(magicBytes), file.slice(0, magicBytes.length)) === 0;
+}
+function addSuffixToFilePath(filePath, suffix, customExtension, sanitize = false) {
+  const dirname = _path.default.dirname(filePath);
+  const ext = _path.default.extname(filePath);
+  const name = _path.default.basename(filePath, ext);
+  const base = _path.default.join(dirname, name);
+  const sanitizeForSnapshotFilePath = s => {
+    return s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
+  };
+  return (sanitize ? sanitizeForSnapshotFilePath(base) : base) + suffix + (customExtension || ext);
 }

package/lib/util.js

@@ -3,7 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.addSuffixToFilePath = addSuffixToFilePath;
 exports.callLogText = callLogText;
 exports.createFileFiltersFromArguments = createFileFiltersFromArguments;
 exports.createFileMatcher = createFileMatcher;
@@ -186,8 +185,16 @@ 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 sanitizeForFilePath(input) {
+  let nonTrivialSubstitute = false;
+  let sanitized = input.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F\x2A\-\*]+/g, substring => {
+    if (substring !== ' ') nonTrivialSubstitute = true;
+    return '-';
+  });
+  if (!nonTrivialSubstitute) return sanitized;
+  // If we sanitized the beginning or end, remove it for cosmetic reasons.
+  sanitized = sanitized.replace(/^-/, '').replace(/-$/, '');
+  return sanitized + '-' + (0, _utils.calculateSha1)(input).substring(0, 6);
 }
 function trimLongString(s, length = 100) {
   if (s.length <= length) return s;
@@ -197,13 +204,6 @@ function trimLongString(s, length = 100) {
   const end = length - middle.length - start;
   return s.substring(0, start) + middle + s.slice(-end);
 }
-function addSuffixToFilePath(filePath, suffix, customExtension, sanitize = false) {
-  const dirname = _path.default.dirname(filePath);
-  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);
-}
 
 /**
  * Returns absolute path contained within parent directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playwright/test",
-  "version": "1.36.0-alpha-jun-27-2023",
+  "version": "1.36.0-alpha-jun-28-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.36.0-alpha-jun-27-2023"
+    "playwright-core": "1.36.0-alpha-jun-28-2023"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"

package/types/test.d.ts

@@ -3322,7 +3322,7 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
    * ```js
    * // playwright.config.ts
    * import { defineConfig } from '@playwright/test';
-   * import { Options } from './my-test';
+   * import type { Options } from './my-test';
    *
    * export default defineConfig<Options>({
    *   projects: [
@@ -5573,8 +5573,8 @@ interface LocatorAssertions {
    * ```
    *
    * ```js
-   * const locator = page.locator("id=favorite-colors");
-   * await locator.selectOption(["R", "G"]);
+   * const locator = page.locator('id=favorite-colors');
+   * await locator.selectOption(['R', 'G']);
    * await expect(locator).toHaveValues([/R/, /G/]);
    * ```
    *

package/types/testReporter.d.ts

@@ -316,7 +316,7 @@ export interface FullResult {
  *
  * ```js
  * // my-awesome-reporter.ts
- * import { 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 } = {}) {