@applitools/eyes-playwright 1.30.1 → 1.31.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [1.31.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright-v1.30.3...js/eyes-playwright@1.31.0) (2024-11-11)
+
+
+### Features
+
+* add playwright fixture ([#2412](https://github.com/Applitools-Dev/sdk/issues/2412)) ([0632e93](https://github.com/Applitools-Dev/sdk/commit/0632e93dd7f53029a8c5f4230d22a05abf5fefd4))
+* handle retries on the custom html report for playwright ([#2597](https://github.com/Applitools-Dev/sdk/issues/2597)) ([0a93555](https://github.com/Applitools-Dev/sdk/commit/0a935551f5dc939352de700ca904c83f578a1113))
+* html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+* offline execution ([#2528](https://github.com/Applitools-Dev/sdk/issues/2528)) ([e6c3b9e](https://github.com/Applitools-Dev/sdk/commit/e6c3b9e3315203027551da3bfdecf90490edd029))
+
+
+### Bug Fixes
+
+* ignore browser config with classic ([#2620](https://github.com/Applitools-Dev/sdk/issues/2620)) ([6098078](https://github.com/Applitools-Dev/sdk/commit/6098078baea000bbad0f1b42edbfc5489ab4eaf2))
+* playwright fixture feedback ([#2617](https://github.com/Applitools-Dev/sdk/issues/2617)) ([8440631](https://github.com/Applitools-Dev/sdk/commit/8440631280c9a0e79ea2d973656e4c6fd9fb6bc5))
+* playwright fixture run-example cli ([7243c7a](https://github.com/Applitools-Dev/sdk/commit/7243c7a88673fda2df3536d9efd60d371c1ff835))
+* trigger playwright release ([1d3ea3e](https://github.com/Applitools-Dev/sdk/commit/1d3ea3e4d2059c12d8013f04c18f5facffbc5846))
+* trigger release ([c97dbfc](https://github.com/Applitools-Dev/sdk/commit/c97dbfc89245f374917702a867b87f2794155e54))
+* trigger release ([88c4f81](https://github.com/Applitools-Dev/sdk/commit/88c4f812bd92eae61ee8ebbee5da0d64ad8c8859))
+* tunnel client ([670b184](https://github.com/Applitools-Dev/sdk/commit/670b1843ce43347d97e19fa02f8bc630332ff414))
+
+
+### Code Refactoring
+
+* start linting "no-floating-promises" (wip) ([#2539](https://github.com/Applitools-Dev/sdk/issues/2539)) ([51b91cb](https://github.com/Applitools-Dev/sdk/commit/51b91cb15603f7d68e4bd6a16eb0f80e3f380295))
+
+
+### Dependencies
+
+* @applitools/eyes bumped to 1.26.4
+  #### Bug Fixes
+
+  * organize configuration alphabetically and add getters and setters ([684490d](https://github.com/Applitools-Dev/sdk/commit/684490d8d85d1dd0f07bafdcc38febfcf7c58d08))
+
+## [1.30.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.30.1...js/eyes-playwright@1.30.2) (2024-10-31)
+
+
+### Bug Fixes
+
+* playwright fixture run-example cli ([7243c7a](https://github.com/Applitools-Dev/sdk/commit/7243c7a88673fda2df3536d9efd60d371c1ff835))
+
 ## [1.30.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.30.0...js/eyes-playwright@1.30.1) (2024-10-31)
 
 

package/dist/fixture/cli.js

@@ -165,23 +165,23 @@ async function runExample() {
     async function writeTmpPlaywrightConfig() {
         if (!playwrightTmpExists) {
             const playwrighConfig = await fs_1.promises.readFile('./playwright.config.ts', 'utf-8');
-            const apikeyMatch = playwrighConfig.match(/apiKey: (.+)/);
+            const apikeyMatch = playwrighConfig.match(/apiKey: ([^,]+)/);
             const apiKey = apikeyMatch ? apikeyMatch[1] : undefined;
-            const serverUrlMatch = playwrighConfig.match(/serverUrl: (.+)/);
+            const serverUrlMatch = playwrighConfig.match(/serverUrl: ([^,]+)/);
             const serverUrl = serverUrlMatch ? serverUrlMatch[1] : undefined;
             const playwrightTmpConfig = `import { defineConfig, devices } from '@playwright/test';
-  import { EyesFixture } from '@applitools/eyes-playwright/fixture';
-  export default defineConfig<EyesFixture>({
-    testDir: '.',
-    outputDir: './test-results',
-    reporter: [['@applitools/eyes-playwright/reporter', {open: 'always', outputFolder: './eyes-playwright-report'}]],
-    use: {
-      eyesConfig: {
-        apiKey: ${apiKey !== null && apiKey !== void 0 ? apiKey : ''},
-        serverUrl: ${serverUrl !== null && serverUrl !== void 0 ? serverUrl : ''}
-      }
+import { EyesFixture } from '@applitools/eyes-playwright/fixture';
+export default defineConfig<EyesFixture>({
+  testDir: '.',
+  outputDir: './test-results',
+  reporter: [['@applitools/eyes-playwright/reporter', {open: 'always', outputFolder: './eyes-playwright-report'}]],
+  use: {
+    eyesConfig: {
+      apiKey: ${apiKey !== null && apiKey !== void 0 ? apiKey : ''},
+      serverUrl: ${serverUrl !== null && serverUrl !== void 0 ? serverUrl : ''}
     }
-  })`;
+  }
+})`;
             await fs_1.promises.writeFile(playwrightTmpConfigPath, playwrightTmpConfig);
         }
     }

package/dist/fixture/defaults/eyesConfiguration.js

@@ -42,18 +42,17 @@ function addBatchDefaults({ configuration }) {
     return batch;
 }
 function getFinalEyesConfiguration({ playwrightConfig = {}, projectConfig = {}, eyesConfig = {}, testInfo, }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     const configuration = {
         ...playwrightConfig,
         ...projectConfig,
         ...eyesConfig,
     };
     (_a = configuration.appName) !== null && _a !== void 0 ? _a : (configuration.appName = 'My App');
-    (_b = configuration.displayName) !== null && _b !== void 0 ? _b : (configuration.displayName = testInfo.title); // by default, the display name won't include the full path
-    (_c = configuration.testName) !== null && _c !== void 0 ? _c : (configuration.testName = testInfo.titlePath.join(' > '));
+    (_b = configuration.testName) !== null && _b !== void 0 ? _b : (configuration.testName = testInfo.titlePath.slice(1).join(' > '));
     configuration.properties = addConfigurationProperties({ properties: configuration.properties, testInfo });
     configuration.batch = addBatchDefaults({ configuration });
-    (_d = configuration.stitchMode) !== null && _d !== void 0 ? _d : (configuration.stitchMode = 'CSS');
+    (_c = configuration.stitchMode) !== null && _c !== void 0 ? _c : (configuration.stitchMode = 'CSS');
     configuration.forceFullPageScreenshot = true;
     const displayName = typeof configuration.displayName === 'function' ? configuration.displayName(testInfo) : configuration.displayName;
     const testName = typeof configuration.testName === 'function' ? configuration.testName(testInfo) : configuration.testName;

package/dist/fixture/getEyes.js

@@ -19,6 +19,10 @@ async function getEyes({ testInfo, eyesConfig, eyesRunner, page, }) {
         eyesConfig,
         testInfo,
     });
+    // TODO remove this once bug in eyes/core is fixed. The bug is that when passing browsersInfo with classic runner, a test with viewport size 0x0 is created for each browser configuration. It should just be ignored.
+    if (eyesRunner.type === 'classic' && configuration.browsersInfo) {
+        delete configuration.browsersInfo;
+    }
     const eyes = new index_1.Eyes(eyesRunner, {
         // batches are closed automatically after some time, and closing batch from one process might make another process to open a new batch when it's not neccessary.
         // therefore, we decides to set dontCloseBatches to true. If the user wants to see a notification after the batch is closed, we expect them to use our
@@ -33,12 +37,14 @@ async function getEyes({ testInfo, eyesConfig, eyesRunner, page, }) {
     eyes.closeAsync = makeStep('eyes.closeAsync (without exception)', eyes.closeAsync.bind(eyes));
     await eyes.open(page, configuration.appName, configuration.testName);
     page.__eyes = eyes;
+    eyesRunner.isUsed = true;
     return eyes;
 }
 exports.getEyes = getEyes;
 function makeStep(title, f, { box } = { box: true }) {
     return (async (...args) => {
-        return test_1.test.step(title, async () => {
+        const stepTitle = typeof args[0] === 'string' ? `${title} - ${args[0]}` : title;
+        return test_1.test.step(stepTitle, async () => {
             return await f(...args);
         }, { box });
     });

package/dist/fixture/images/link.svg

@@ -1,4 +1,3 @@
 <svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox='0 0 16 16' width='16' height='16'>
-    <title>link</title>
     <path fillRule='evenodd' d='M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z'></path>
 </svg>

package/dist/fixture/index.js

@@ -40,7 +40,9 @@ exports.test = test_1.test.extend({
             const eyesConfig = getEyesConfigForWorker(workerInfo);
             const runner = eyesConfig.type === 'ufg' ? new index_1.VisualGridRunner(eyesConfig) : new index_1.ClassicRunner(eyesConfig);
             await use(runner);
-            output(`Waiting on eyes results for worker #${workerInfo.parallelIndex}-${workerInfo.workerIndex} - it might take a while`);
+            if (runner.isUsed) {
+                output(`Waiting on eyes results for worker #${workerInfo.parallelIndex}-${workerInfo.workerIndex} - it might take a while`);
+            }
             try {
                 await Promise.all((_a = runner === null || runner === void 0 ? void 0 : runner.fixturePromises) !== null && _a !== void 0 ? _a : []);
                 await runner.getAllTestResults(eyesConfig.failTestsOnDiff === 'afterAll').catch(err => {
@@ -51,9 +53,11 @@ exports.test = test_1.test.extend({
             }
             finally {
                 const results = await runner.getAllTestResults(false);
-                output(outputDigest(workerInfo, results));
+                if (runner.isUsed) {
+                    output(outputDigest(workerInfo, results));
+                }
                 if (eyesConfig.afterAll) {
-                    eyesConfig.afterAll(results.getAllResults());
+                    await eyesConfig.afterAll(results.getAllResults());
                 }
             }
         },