@applitools/eyes-playwright 1.37.2 → 1.38.0

package/CHANGELOG.md

@@ -1,5 +1,108 @@
 # Changelog
 
+## [1.38.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.37.3...js/eyes-playwright@1.38.0) (2025-07-09)
+
+
+### Features
+
+* canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+* support sharding for the eyes-playwright fixture | FLD-3026 ([#3056](https://github.com/Applitools-Dev/sdk/issues/3056)) ([96191bc](https://github.com/Applitools-Dev/sdk/commit/96191bcf8f13b5360ae5e50e13f20a6b198ff78e))
+
+
+### Bug Fixes
+
+* export type Eyes from the PW fixture ([fd3a9f0](https://github.com/Applitools-Dev/sdk/commit/fd3a9f025da6023f6d500cebd2bf65d26acb5f3e))
+* playwright worker configuration | FLD-2837 ([#3029](https://github.com/Applitools-Dev/sdk/issues/3029)) ([07014ec](https://github.com/Applitools-Dev/sdk/commit/07014ec5f3a16ed620c6ac243523cee05f02a7fd))
+
+## [1.37.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.37.2...js/eyes-playwright@1.37.3) (2025-06-15)
+
+
+### Bug Fixes
+
+* Differentiate Between Invalid and Missing API Key Errors ([6ac17d4](https://github.com/Applitools-Dev/sdk/commit/6ac17d40d7aff45b3de5c949dc7d4673b9739bfd))
+* relative links in readme | AD-9703 ([#2960](https://github.com/Applitools-Dev/sdk/issues/2960)) ([672207b](https://github.com/Applitools-Dev/sdk/commit/672207b55e30f1581defeda4f2f743eaf5b1849d))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.22
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+
+
+
+* @applitools/nml-client bumped to 1.9.5
+  #### Bug Fixes
+
+  * nml-client depends on core-base ([#2995](https://github.com/Applitools-Dev/sdk/issues/2995)) ([1f7cf69](https://github.com/Applitools-Dev/sdk/commit/1f7cf6930709a40a498dd1f525132648aa593af0))
+
+
+
+* @applitools/tunnel-client bumped to 1.8.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+
+* @applitools/ufg-client bumped to 1.16.12
+  #### Bug Fixes
+
+  * remove safari-early-access browser version for js sdks | AD-10226 ([#3034](https://github.com/Applitools-Dev/sdk/issues/3034)) ([7ca09f5](https://github.com/Applitools-Dev/sdk/commit/7ca09f5c0c271570142058ea766533b86434dc2e))
+
+
+
+* @applitools/core bumped to 4.40.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * extractLatestCommitInfo | FLD-3217 ([#3039](https://github.com/Applitools-Dev/sdk/issues/3039)) ([3f72a23](https://github.com/Applitools-Dev/sdk/commit/3f72a230fa0166046ea85ae004cfb544de86e628))
+  * handle error when sending started message in tunnel manager server ([#3019](https://github.com/Applitools-Dev/sdk/issues/3019)) ([2cdaad8](https://github.com/Applitools-Dev/sdk/commit/2cdaad896fd679187449b69abe529b006f6255ee))
+
+
+
+* @applitools/req bumped to 1.7.13
+
+* @applitools/dom-capture bumped to 11.5.6
+
+* @applitools/spec-driver-webdriver bumped to 1.2.6
+
+* @applitools/screenshoter bumped to 3.11.5
+
+* @applitools/core-base bumped to 1.25.4
+  #### Bug Fixes
+
+  * Differentiate Between Invalid and Missing API Key Errors ([6ac17d4](https://github.com/Applitools-Dev/sdk/commit/6ac17d40d7aff45b3de5c949dc7d4673b9739bfd))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+
+
+
+* @applitools/ec-client bumped to 1.10.15
+
+* @applitools/eyes bumped to 1.35.1
+  #### Bug Fixes
+
+  * remove safari-early-access browser version for js sdks | AD-10226 ([#3034](https://github.com/Applitools-Dev/sdk/issues/3034)) ([7ca09f5](https://github.com/Applitools-Dev/sdk/commit/7ca09f5c0c271570142058ea766533b86434dc2e))
+
+
+
+* @applitools/test-server bumped to 1.2.3
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * storybook navigation timeouts ([#2701](https://github.com/Applitools-Dev/sdk/issues/2701)) ([64e3a40](https://github.com/Applitools-Dev/sdk/commit/64e3a40a524ae76ec457ae9c2d1170fbaea5e982))
+
+
+
+
 ## [1.37.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.37.1...js/eyes-playwright@1.37.2) (2025-04-17)
 
 

package/README.md

@@ -33,7 +33,7 @@ The CLI will:
 - Add a demo test to help you get started.
     - You can run the demo test with `npx eyes-setup run-example`
 
-_Note: In cases where imports cannot be modified automatically (e.g., when importing the `test` object from another npm package), you may need to adjust them manually. More details are provided in the [Integration with Playwright](/playwright/integration-with-playwright) section._
+_Note: In cases where imports cannot be modified automatically (e.g., when importing the `test` object from another npm package), you may need to adjust them manually. More details are provided in the [Integration with Playwright](https://applitools.com/tutorials/playwright/integration-with-playwright) section._
 
 
 :::info
@@ -42,7 +42,7 @@ You may be prompted to enter your Eyes Server URL. If you are using the Applitoo
 
 ### Set your Applitools API key
 
-When prompted by the CLI, enter your Applitools API key. If you don't have one, you can sign up for a free account and obtain your API key [from the Applitools Dashboard](/playwright/applitools-dashboard#accessing-the-applitools-dashboard).
+When prompted by the CLI, enter your Applitools API key. If you don't have one, you can sign up for a free account and obtain your API key [from the Applitools Dashboard](https://applitools.com/tutorials/playwright/applitools-dashboard#accessing-the-applitools-dashboard).
 
 Alternatively, you can set the API key as an environment variable:
 

package/dist/fixture/defaults/eyesConfiguration.js

@@ -38,7 +38,12 @@ function addBatchDefaults({ configuration }) {
     (_c = batch.name) !== null && _c !== void 0 ? _c : (batch.name = (0, name_1.getBatchName)({ appName: configuration.appName }));
     (_d = batch.properties) !== null && _d !== void 0 ? _d : (batch.properties = []);
     batch.properties.push({ name: 'CI', value: process.env.CI ? 'true' : 'false' });
-    batch.properties.push({ name: 'Playwright version', value: require('playwright-core/package.json').version });
+    try {
+        batch.properties.push({ name: 'Playwright version', value: require('playwright-core/package.json').version });
+    }
+    catch {
+        // NOTE: ignore error
+    }
     return batch;
 }
 function getFinalEyesConfiguration({ playwrightConfig = {}, projectConfig = {}, eyesConfig = {}, testInfo, }) {

package/dist/fixture/index.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.test = exports.expect = void 0;
 /* eslint-disable no-console */
@@ -33,6 +36,7 @@ Object.defineProperty(exports, "expect", { enumerable: true, get: function () {
 const utils = __importStar(require("@applitools/utils"));
 const reporter_1 = require("./reporter");
 const url_1 = require("url");
+const path_1 = __importDefault(require("path"));
 exports.test = test_1.test.extend({
     eyesConfig: [{}, { option: true }],
     eyesRunner: [
@@ -85,10 +89,20 @@ exports.test = test_1.test.extend({
     ],
     closeEyesIfNeeded: [
         async ({ page, eyesConfig, eyesRunner: runner }, use, testInfo) => {
-            const isUsingEyesReporter = testInfo.config.reporter.some(r => r[0].includes('eyes-playwright'));
+            var _a, _b, _c, _d, _e, _f;
+            const isUsingEyesReporter = testInfo.config.reporter.some(
+            // typeof testInfo.config.reporter is [string, ReporterOptions][], that's why [0] is the reporter name
+            r => r[0].includes('eyes-playwright') || r[0].includes('blob'));
+            const blobSettings = (_b = (_a = testInfo.config.reporter.find(r => r[0].includes('blob'))) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : {};
+            const blobFolder = (_d = (_c = blobSettings.outputDir) !== null && _c !== void 0 ? _c : process.env.PLAYWRIGHT_BLOB_OUTPUT_DIR) !== null && _d !== void 0 ? _d : (((_e = process.env.PLAYWRIGHT_BLOB_OUTPUT_FILE) !== null && _e !== void 0 ? _e : blobSettings.outputFile)
+                ? path_1.default.basename((_f = process.env.PLAYWRIGHT_BLOB_OUTPUT_FILE) !== null && _f !== void 0 ? _f : blobSettings.outputFile)
+                : '');
             if (isUsingEyesReporter) {
-                const internalId = utils.general.guid();
-                await testInfo.attach('internalId', { body: internalId });
+                const applitoolsIdentifier = utils.general.guid();
+                // Create an identifier that will be collected by the html or reporter
+                await testInfo.attach('applitoolsIdentifier', {
+                    body: `${applitoolsIdentifier}|${blobFolder}`,
+                });
             }
             await use();
             const eyes = page.__eyes;
@@ -132,14 +146,16 @@ function writeResultsWhenReady({ eyes, runner, testInfo }) {
     }));
 }
 async function getEyesConfigForWorker(workerInfo) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const { configFile } = workerInfo.config;
-    const playwrightConfig = (_b = (_a = ((configFile ? await import((0, url_1.pathToFileURL)(configFile).href) : {}))) === null || _a === void 0 ? void 0 : _a.use) === null || _b === void 0 ? void 0 : _b.eyesConfig;
+    const playwrightConfigModule = configFile ? await import((0, url_1.pathToFileURL)(configFile).href) : {};
+    const playwrightConfig = ((_a = playwrightConfigModule === null || playwrightConfigModule === void 0 ? void 0 : playwrightConfigModule.use) === null || _a === void 0 ? void 0 : _a.eyesConfig) ||
+        ((_c = (_b = playwrightConfigModule === null || playwrightConfigModule === void 0 ? void 0 : playwrightConfigModule.default) === null || _b === void 0 ? void 0 : _b.use) === null || _c === void 0 ? void 0 : _c.eyesConfig);
     const projectConfig = workerInfo.project.use.eyesConfig;
     const eyesConfig = {
         ...playwrightConfig,
         ...projectConfig,
     };
-    (_c = eyesConfig.failTestsOnDiff) !== null && _c !== void 0 ? _c : (eyesConfig.failTestsOnDiff = process.env.CI ? 'afterAll' : 'afterEach');
+    (_d = eyesConfig.failTestsOnDiff) !== null && _d !== void 0 ? _d : (eyesConfig.failTestsOnDiff = process.env.CI ? 'afterAll' : 'afterEach');
     return eyesConfig;
 }

package/dist/fixture/reporter.js

@@ -24,7 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalData = void 0;
-const os = __importStar(require("os"));
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const playwrightPath = require.resolve('playwright');
@@ -46,30 +45,36 @@ const createInjectedScript = (testResultsMap) => `
 class EyesReporter extends HtmlReporter {
     constructor(options) {
         super(options);
-        this.internalIds = [];
+        this.applitoolsIdentifiersAndFolders = [];
     }
     onTestEnd(test, result) {
         var _a;
         (_a = super.onTestEnd) === null || _a === void 0 ? void 0 : _a.call(this, test, result);
-        const index = result.attachments.findIndex(a => a.name === 'internalId');
+        const index = result.attachments.findIndex(a => a.name === 'applitoolsIdentifier');
         if (index > -1) {
-            const internalId = result.attachments[index].body.toString();
-            this.internalIds.push(internalId);
+            const applitoolsIdentifierAndFolder = result.attachments[index].body.toString();
+            this.applitoolsIdentifiersAndFolders.push(applitoolsIdentifierAndFolder);
             this.removeInternalIdAttachment(result);
         }
     }
+    // TODO: let's remove this method! Removing the internal id from the test result is wrong,
+    // it should be hidden in the HTML report and the test result should be read-only.
     removeInternalIdAttachment(result) {
-        var _a;
-        const index = result.attachments ? result.attachments.findIndex(a => a.name === 'internalId') : -1;
+        var _a, _b, _c;
+        const index = result.attachments ? result.attachments.findIndex(a => (a === null || a === void 0 ? void 0 : a.name) === 'applitoolsIdentifier') : -1;
         if (index > -1)
             (_a = result.attachments) === null || _a === void 0 ? void 0 : _a.splice(index, 1);
-        result.steps.forEach(step => this.removeInternalIdAttachment(step));
+        const index2 = result.attachments ? result.attachments.findIndex(a => !a) : -1;
+        if (index2 > -1)
+            (_c = (_b = result._endPayload) === null || _b === void 0 ? void 0 : _b.attachments) === null || _c === void 0 ? void 0 : _c.splice(index2, 1);
+        if (result.steps)
+            result.steps.forEach(step => this.removeInternalIdAttachment(step));
     }
     async onEnd(result) {
         await super.onEnd(result);
         const testResultsMap = {};
-        for (const internalId of this.internalIds) {
-            const content = await exports.InternalData.consume(internalId);
+        for (const applitoolsIdentifierAndFolder of this.applitoolsIdentifiersAndFolders) {
+            const content = await exports.InternalData.consume(applitoolsIdentifierAndFolder);
             if (content) {
                 testResultsMap[content.key] = content.data;
             }
@@ -87,29 +92,36 @@ class EyesReporter extends HtmlReporter {
 exports.default = EyesReporter;
 exports.InternalData = {
     async write({ testInfo, data }) {
-        const internalId = testInfo.attachments.find(a => a.name === 'internalId').body.toString();
+        const [applitoolsIdentifier, folder] = testInfo.attachments
+            .find(a => a.name === 'applitoolsIdentifier')
+            .body.toString()
+            .split('|')
+            .map(s => s.trim())
+            .filter(Boolean); // if the directory is not specified, it will be empty
         const key = `${testInfo.testId}--${testInfo.retry}`;
-        this.ensureFolder();
-        await fs.promises.writeFile(this.getPathForInternalId(internalId), JSON.stringify({ key, data }));
+        this.ensureFolder(folder);
+        await fs.promises.writeFile(this.getPathForInternalId(applitoolsIdentifier, folder), JSON.stringify({ key, data }));
     },
-    async consume(internalId) {
-        const filepath = this.getPathForInternalId(internalId);
+    async consume(applitoolsIdentifierAndFolder) {
+        const [name, folder] = applitoolsIdentifierAndFolder
+            .split('|')
+            .map(s => s.trim())
+            .filter(Boolean); // if the directory is not specified, it will be empty
+        const filepath = this.getPathForInternalId(name, folder);
         try {
             const content = await fs.promises.readFile(filepath, 'utf-8').then(JSON.parse);
-            await fs.promises.unlink(filepath);
             return content;
         }
         catch (err) {
             // TODO no eyes results for test - this is ok, could be that no visual tests occurred for this playwright test
         }
     },
-    ensureFolder() {
-        const folderPath = path.join(os.tmpdir(), 'eyes-report-files');
+    ensureFolder(folderPath = path.join('blob-report', 'eyes-report-files')) {
         if (!fs.existsSync(folderPath)) {
-            fs.mkdirSync(folderPath);
+            fs.mkdirSync(folderPath, { recursive: true });
         }
     },
-    getPathForInternalId(internalId) {
-        return path.join(os.tmpdir(), 'eyes-report-files', internalId);
+    getPathForInternalId(applitoolsIdentifier, folderPath = path.join('blob-report', 'eyes-report-files')) {
+        return path.join(folderPath, applitoolsIdentifier);
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-playwright",
-  "version": "1.37.2",
+  "version": "1.38.0",
   "description": "Applitools Eyes SDK for Playwright",
   "keywords": [
     "eyes-playwright",
@@ -13,7 +13,7 @@
     "tests",
     "playwright"
   ],
-  "homepage": "https://applitools.com/docs/api-ref/sdk-api/playwright/javascript/",
+  "homepage": "https://applitools.com/tutorials/sdks/playwright-ts-standard",
   "license": "SEE LICENSE IN LICENSE",
   "author": {
     "name": "Applitools Team",
@@ -54,14 +54,14 @@
     "test": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) run --top-level mocha './test/*.spec.{js,ts}' --exit",
     "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-8} --exit",
     "test:fixture": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(npx uuid).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright-fixture' APPLITOOLS_BATCH_ID=$(npx uuid) run playwright test",
-    "setup": "run playwright:setup",
+    "setup": "run playwright:setup && run --top-level xvfb:setup",
     "playwright:setup": "yarn playwright install --with-deps chromium firefox webkit",
     "up:framework": "echo \"$(jq '.devDependencies.playwright = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
   },
   "dependencies": {
-    "@applitools/eyes": "1.34.0",
-    "@applitools/spec-driver-playwright": "1.5.10",
-    "@applitools/utils": "1.8.0",
+    "@applitools/eyes": "1.35.1",
+    "@applitools/spec-driver-playwright": "1.6.0",
+    "@applitools/utils": "1.9.0",
     "@inquirer/prompts": "7.0.1",
     "chalk": "4.1.2",
     "yargs": "17.7.2"

package/types/index.d.ts

@@ -837,7 +837,7 @@ export class BatchClose {
     setProxy(proxy: ProxySettingsPlain): BatchClose;
 }
 export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
-export type BrowserTypePlain = "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back";
+export type BrowserTypePlain = "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-one-version-back" | "safari-two-versions-back";
 export enum BrowserType {
     CHROME = 'chrome',
     CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
@@ -853,7 +853,6 @@ export enum BrowserType {
     EDGE_CHROMIUM_ONE_VERSION_BACK = 'edgechromium-one-version-back',
     EDGE_CHROMIUM_TWO_VERSIONS_BACK = 'edgechromium-two-versions-back',
     SAFARI = 'safari',
-    SAFARI_EARLY_ACCESS = 'safari-earlyaccess',
     SAFARI_ONE_VERSION_BACK = 'safari-one-version-back',
     SAFARI_TWO_VERSIONS_BACK = 'safari-two-versions-back'
 }