@applitools/eyes-playwright 1.39.0 → 1.39.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.39.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.39.0...js/eyes-playwright@1.39.1) (2025-08-10)
+
+
+### Bug Fixes
+
+* save pw reporter temp files using the backend | FLD-3427 ([#3132](https://github.com/Applitools-Dev/sdk/issues/3132)) ([5d3e756](https://github.com/Applitools-Dev/sdk/commit/5d3e756aea742b1758032037f56d62a932c805a2))
+
 ## [1.39.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.38.2...js/eyes-playwright@1.39.0) (2025-08-05)
 
 

package/dist/fixture/index.js

@@ -1,30 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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,10 +7,9 @@ const test_1 = require("@playwright/test");
 const getEyes_1 = require("./getEyes");
 var toHaveScreenshot_1 = require("./toHaveScreenshot");
 Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return toHaveScreenshot_1.expect; } });
-const utils = __importStar(require("@applitools/utils"));
 const reporter_1 = require("./reporter");
 const url_1 = require("url");
-const path_1 = __importDefault(require("path"));
+const utils_1 = require("@applitools/utils");
 exports.test = test_1.test.extend({
     eyesConfig: [{}, { option: true }],
     eyesRunner: [
@@ -89,27 +62,15 @@ exports.test = test_1.test.extend({
     ],
     closeEyesIfNeeded: [
         async ({ page, eyesConfig, eyesRunner: runner }, use, testInfo) => {
-            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 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;
             if (eyes) {
                 await eyes.closeAsync();
                 if (isUsingEyesReporter) {
-                    writeResultsWhenReady({ eyes, runner, testInfo });
+                    await writeResultsWhenReady({ eyes, runner, testInfo });
                 }
                 if (eyesConfig.failTestsOnDiff === 'afterEach') {
                     await eyes.getResults(true);
@@ -131,13 +92,17 @@ function outputDigest(workerInfo, results) {
 function output(...args) {
     console.log('👀', ...args);
 }
-function writeResultsWhenReady({ eyes, runner, testInfo }) {
-    var _a;
+async function writeResultsWhenReady({ eyes, runner, testInfo }) {
+    var _a, _b;
     const fixturePromises = ((_a = runner.fixturePromises) !== null && _a !== void 0 ? _a : (runner.fixturePromises = []));
+    const uuid = utils_1.general.guid();
+    await testInfo.attach('applitoolsIdentifier', {
+        body: `${uuid}|${(_b = eyes.getServerUrl()) !== null && _b !== void 0 ? _b : 'https://eyes.applitools.com'}|${eyes.getApiKey()}`,
+    });
     fixturePromises.push(eyes
         .getResults(false)
         .then(async (testResults) => {
-        await reporter_1.InternalData.write({ testInfo, data: testResults });
+        await reporter_1.InternalData.write({ testInfo, data: testResults, eyes, uuid });
     })
         .catch((e) => {
         var _a;

package/dist/fixture/reporter.js

@@ -26,7 +26,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalData = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
-const os = __importStar(require("os"));
+const req_1 = require("@applitools/req");
+const utils = __importStar(require("@applitools/utils"));
+const logger_1 = require("@applitools/logger");
+const storage_blob_1 = require("@azure/storage-blob");
 const playwrightPath = require.resolve('playwright');
 const HtmlReporter = require(path.join(path.dirname(playwrightPath), '/lib/reporters/html')).default;
 const pluginsFile = require.resolve('../../dist/fixture/reportRenderer.js');
@@ -46,20 +49,15 @@ const createInjectedScript = (testResultsMap) => `
 class EyesReporter extends HtmlReporter {
     constructor(options) {
         super(options);
-        this.stdoutData = '';
-        this.applitoolsIdentifiersAndFolders = [];
-    }
-    onStdOut(chunk) {
-        // Capture stdout data for blob reporter scenarios
-        this.stdoutData += chunk.toString();
+        this.applitoolsIdentifiers = [];
     }
     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 === 'applitoolsIdentifier');
         if (index > -1) {
-            const applitoolsIdentifierAndFolder = result.attachments[index].body.toString();
-            this.applitoolsIdentifiersAndFolders.push(applitoolsIdentifierAndFolder);
+            const applitoolsIdentifier = result.attachments[index].body.toString();
+            this.applitoolsIdentifiers.push(applitoolsIdentifier);
             this.removeInternalIdAttachment(result);
         }
     }
@@ -79,10 +77,20 @@ class EyesReporter extends HtmlReporter {
     async onEnd(result) {
         await super.onEnd(result);
         const testResultsMap = {};
-        for (const applitoolsIdentifierAndFolder of this.applitoolsIdentifiersAndFolders) {
-            const content = await exports.InternalData.consume(applitoolsIdentifierAndFolder, this.stdoutData);
-            if (content) {
-                testResultsMap[content.key] = content.data;
+        for (const applitoolsIdentifier of this.applitoolsIdentifiers) {
+            // Parse the identifier format: uuid|serverUrl|apiKey
+            const [uuid, serverUrl, apiKey] = applitoolsIdentifier.split('|');
+            if (uuid && serverUrl && apiKey) {
+                // Create a minimal eyes object for the consume call
+                const eyes = {
+                    getServerUrl: () => serverUrl,
+                    getApiKey: () => apiKey,
+                    // No getLogger method - will use makeLogger() fallback
+                };
+                const content = await exports.InternalData.consume(uuid, eyes);
+                if (content) {
+                    testResultsMap[content.key] = content.data;
+                }
             }
         }
         try {
@@ -96,85 +104,104 @@ class EyesReporter extends HtmlReporter {
     }
 }
 exports.default = EyesReporter;
-const defaultDataDirectory = path.join(os.tmpdir(), 'eyes-playwright-data');
+const getLogger = utils.general.cachify((settings) => {
+    return settings.logger || (0, logger_1.makeLogger)({ level: 'info' });
+}, ([settings]) => settings.serverUrl + settings.apiKey);
+const makeReporterRequest = (settings) => {
+    var _a;
+    const logger = getLogger(settings);
+    const req = (0, req_1.makeReq)({
+        baseUrl: (_a = settings.serverUrl) !== null && _a !== void 0 ? _a : 'https://eyes.applitools.com',
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+            'x-applitools-eyes-client': 'eyes-playwright-reporter',
+            'User-Agent': 'eyes-playwright-reporter',
+            'X-Eyes-Api-Key': settings.apiKey,
+        },
+        retry: [
+            {
+                limit: 3,
+                timeout: 200,
+            },
+        ],
+        hooks: {
+            beforeRequest: request => {
+                var _a;
+                logger.log(`Making request to ${request.request.url} with body: ${(_a = request.options) === null || _a === void 0 ? void 0 : _a.body}`);
+            },
+            afterResponse: async (response) => {
+                logger.log(`Received response from ${response.response.url} with status ${response.response.status} and body: ${await response.response.clone().text()}`);
+                if (response.response.status >= 400) {
+                    logger.error(`Request to ${response.response.url} failed with status ${response.response.status}`, `and body: ${await response.response.clone().text()}`);
+                    throw new Error(`Request to ${response.response.url} failed with status ${response.response.status}`);
+                }
+            },
+        },
+    });
+    return {
+        upload,
+        download,
+    };
+    async function upload(uuid, data) {
+        const blobClient = new storage_blob_1.BlockBlobClient(settings.uploadUrl);
+        const [response1, response2] = await Promise.all([
+            req(`/batch/${uuid}/report/${uuid}`, {
+                method: 'POST',
+            }),
+            blobClient.upload(JSON.stringify(data), JSON.stringify(data).length),
+        ]);
+        return {
+            respCreateUpload: await response1.json(),
+            respUpload: JSON.stringify(response2),
+        };
+    }
+    async function download(uuid) {
+        const response = await req(`/batch/${uuid}/report/${uuid}`, {
+            method: 'GET',
+        });
+        return response.json();
+    }
+};
 exports.InternalData = {
-    determineDirectory(testInfo) {
-        var _a;
-        const blobReporter = testInfo.config.reporter.find(r => r[0].includes('blob'));
-        const customOutputDir = (_a = blobReporter === null || blobReporter === void 0 ? void 0 : blobReporter[1]) === null || _a === void 0 ? void 0 : _a.outputDir;
-        return customOutputDir ? path.join(customOutputDir, 'eyes-report-files') : defaultDataDirectory;
-    },
-    hasBlobReporter(testInfo) {
-        return testInfo.config.reporter.some(r => r[0].includes('blob'));
-    },
-    async write({ testInfo, data }) {
-        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}`;
-        if (this.hasBlobReporter(testInfo)) {
-            // Use stdout approach for blob reporter scenarios
-            // eslint-disable-next-line no-console
-            console.log(`EYES_DATA:${applitoolsIdentifier}:${JSON.stringify({ key, data })}`);
-        }
-        else {
-            // Use file approach for direct reporter scenarios
-            const targetFolder = folder || this.determineDirectory(testInfo);
-            this.ensureFolder(targetFolder);
-            await fs.promises.writeFile(this.getPathForInternalId(applitoolsIdentifier, targetFolder), JSON.stringify({ key, data }));
-        }
+    async write({ testInfo, data, eyes, uuid }) {
+        var _a, _b;
+        const logger = ((_a = eyes.getLogger) === null || _a === void 0 ? void 0 : _a.call(eyes)) || (0, logger_1.makeLogger)();
+        const uploadUrl = eyes._eyes.test.account.batchExecReportsUrl
+            .replace('__batch_id__', uuid)
+            .replace('__report_id__', uuid);
+        const { upload } = makeReporterRequest({
+            serverUrl: (_b = eyes.getServerUrl()) !== null && _b !== void 0 ? _b : 'https://eyes.applitools.com',
+            apiKey: eyes.getApiKey(),
+            uploadUrl,
+            logger: logger,
+        });
+        const response = await upload(uuid, {
+            key: `${testInfo.testId}--${testInfo.retry}`,
+            data,
+        });
+        logger.log('Data written successfully:', response);
     },
-    async consume(applitoolsIdentifierAndFolder, stdoutData) {
-        const [name, folder] = applitoolsIdentifierAndFolder
-            .split('|')
-            .map(s => s.trim())
-            .filter(Boolean); // if the directory is not specified, it will be empty
-        // Try stdout data first (for blob reporter scenarios), then fall back to files
-        if (stdoutData) {
-            // Parse from stdout for blob reporter scenarios
-            const results = this.parseStdoutLine(name, stdoutData);
-            // Return the last result if multiple exist, or undefined if none
-            return results.length > 0 ? results[results.length - 1] : undefined;
-        }
-        else {
-            // Read from file for direct reporter scenarios
-            const targetFolder = folder || defaultDataDirectory;
-            const filepath = this.getPathForInternalId(name, targetFolder);
-            try {
-                const content = await fs.promises.readFile(filepath, 'utf-8').then(JSON.parse);
-                return content;
-            }
-            catch (err) {
-                // TODO no eyes results for test - this is ok, could be that no visual tests occurred for this playwright test
-            }
-        }
-    },
-    parseStdoutLine(identifier, stdoutData) {
-        const lines = stdoutData.split('\n');
-        const eyesLines = lines.filter(line => line.startsWith(`EYES_DATA:${identifier}:`));
-        const results = [];
-        for (const eyesLine of eyesLines) {
-            const jsonPart = eyesLine.replace(`EYES_DATA:${identifier}:`, '');
+    async consume(uuid, eyes) {
+        var _a;
+        const logger = ((_a = eyes.getLogger) === null || _a === void 0 ? void 0 : _a.call(eyes)) || (0, logger_1.makeLogger)();
+        const { download } = makeReporterRequest({
+            serverUrl: eyes.getServerUrl(),
+            apiKey: eyes.getApiKey(),
+            logger: logger,
+        });
+        for (let retry = 0; retry < 3; retry++) {
             try {
-                const parsed = JSON.parse(jsonPart);
-                results.push(parsed);
+                const response = await download(uuid);
+                if (utils.types.has(response, 'status') && response.status !== 200) {
+                    throw new Error(`Failed to consume data for UUID ${uuid}: ${response.status} - ${JSON.stringify(response)}`);
+                }
+                return { key: response.key, data: response.data };
             }
-            catch (err) {
-                // Skip invalid JSON lines
-                continue;
+            catch (error) {
+                logger.warn('Failed to consume data:', error, ". Perhaps the test doesn't include Applitools tests?");
             }
+            await utils.general.sleep(1000 * (retry + 1)); // the backend might need a few seconds to process the upload
         }
-        return results;
-    },
-    ensureFolder(folderPath = defaultDataDirectory) {
-        if (!fs.existsSync(folderPath)) {
-            fs.mkdirSync(folderPath, { recursive: true });
-        }
-    },
-    getPathForInternalId(applitoolsIdentifier, folderPath = defaultDataDirectory) {
-        return path.join(folderPath, applitoolsIdentifier);
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-playwright",
-  "version": "1.39.0",
+  "version": "1.39.1",
   "description": "Applitools Eyes SDK for Playwright",
   "keywords": [
     "eyes-playwright",
@@ -60,8 +60,10 @@
   },
   "dependencies": {
     "@applitools/eyes": "1.36.0",
+    "@applitools/req": "1.8.1",
     "@applitools/spec-driver-playwright": "1.7.1",
     "@applitools/utils": "1.11.0",
+    "@azure/storage-blob": "^12.28.0",
     "@inquirer/prompts": "7.0.1",
     "chalk": "4.1.2",
     "yargs": "17.7.2"
@@ -77,6 +79,7 @@
     "@rollup/plugin-typescript": "^12.1.0",
     "@types/node": "^12.20.55",
     "jszip": "^3.10.1",
+    "nock": "^13.3.2",
     "playwright": "1.49.0",
     "rollup": "^4.1.4"
   },