@applitools/eyes-storybook 3.40.0 → 3.41.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [3.41.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.40.0...js/eyes-storybook@3.41.0) (2023-09-05)
+
+
+### Features
+
+* show aborted tests in Eyes dashboard ([#1877](https://github.com/applitools/eyes.sdk.javascript1/issues/1877)) ([f9840d4](https://github.com/applitools/eyes.sdk.javascript1/commit/f9840d494222ccc6c6f262896771e28da2565bc6))
+
+
+### Dependencies
+
+* @applitools/core-base bumped to 1.6.0
+  #### Features
+
+  * show aborted tests in Eyes dashboard ([#1877](https://github.com/applitools/eyes.sdk.javascript1/issues/1877)) ([f9840d4](https://github.com/applitools/eyes.sdk.javascript1/commit/f9840d494222ccc6c6f262896771e28da2565bc6))
+* @applitools/ec-client bumped to 1.7.8
+
+* @applitools/core bumped to 3.10.2
+
+
 ## [3.40.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook-v3.39.1...js/eyes-storybook@3.40.0) (2023-09-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.40.0",
+  "version": "3.41.0",
   "description": "",
   "keywords": [
     "applitools",
@@ -57,7 +57,7 @@
     "postinstall": "node src/postinstall"
   },
   "dependencies": {
-    "@applitools/core": "3.10.1",
+    "@applitools/core": "3.10.2",
     "@applitools/driver": "1.14.0",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.0.10",

package/src/getStoryData.js

@@ -6,7 +6,7 @@ const getStoryBaselineName = require('./getStoryBaselineName');
 const {URL} = require('url');
 const runRunAfterScript = require('../dist/runRunAfterScript');
 const waitFor = require('./waitFor');
-const PAGE_EVALUATE_TIMEOUT = 120000;
+const PAGE_EVALUATE_TIMEOUT = process.env.APPLITOOLS_PAGE_EVALUATE_TIMEOUT || 120000;
 const DOM_SNAPSHOTS_TIMEOUT = 5 * 60 * 1000;
 const utils = require('@applitools/utils');
 

package/src/processResults.js

@@ -14,26 +14,43 @@ function processResults({
 }) {
   let outputStr = '\n';
   const pluralize = utils.general.pluralize;
-  let testResults = flatten(results.summary.results);
-  const unresolved = testResults.filter(r => r.result.isDifferent);
-  const passedOrNew = testResults.filter(r => r.result.status === 'Passed' || r.result.isNew);
-  const newTests = testResults.filter(r => r.result.isNew);
+  const flattenedTestResults = flatten(results.summary.results);
+  const testResults = flattenedTestResults.filter(r => r && r.result);
+  const testResultsWithErrors = flattenedTestResults.filter(r => r && r.error);
+  const unresolved = testResults.filter(r => r.result.isDifferent && !r.result.isAborted);
+  const passedOrNew = testResults.filter(
+    r => r.result.status === 'Passed' || (r.result.isNew && !r.result.isAborted),
+  );
+  const aborted = testResults.filter(r => r.result.isAborted);
+  const newTests = testResults.filter(r => r.result.isNew && !r.result.isAborted);
   const newTestsSize = newTests.length;
   const warnForUnsavedNewTests = !!(!saveNewTests && newTestsSize);
+  const errMessagesToExclude = [
+    'detected differences',
+    'Please approve the new baseline',
+    'is failed! See details at',
+  ];
 
-  let errors = results.summary.results.map(result => [
-    {err: result.error, title: result.result.name},
-  ]);
-  errors = flatten(errors).filter(
-    ({err}) =>
-      err &&
-      !err.message.includes('detected differences') &&
-      !err.message.includes('Please approve the new baseline'),
-  );
+  const resultsErr = results.results
+    .map(result => {
+      if (!Array.isArray(result.resultsOrErr)) {
+        return {error: result.resultsOrErr, title: result.title};
+      }
+    })
+    .filter(Boolean);
 
-  const hasResults = unresolved.length || passedOrNew.length;
+  const errors = testResultsWithErrors
+    .filter(({error}) => error && !errMessagesToExclude.some(msg => error.message.includes(msg)))
+    .map(({result, error, eyes}) => ({
+      error,
+      title: result?.name || eyes?.test.testName,
+    }))
+    .concat(resultsErr);
+
+  const hasResults = unresolved.length || passedOrNew.length || aborted.length;
   const seeDetailsStr =
-    hasResults && `See details at ${(passedOrNew[0] || unresolved[0]).result.appUrls.batch}`;
+    hasResults &&
+    `See details at ${(passedOrNew[0] || unresolved[0] || aborted[0]).result.appUrls.batch}`;
 
   if (hasResults) {
     outputStr += `${seeDetailsStr}\n\n`;
@@ -46,11 +63,15 @@ function processResults({
   if (unresolved.length > 0) {
     outputStr += testResultsOutput(unresolved, warnForUnsavedNewTests);
   }
+  if (aborted.length > 0) {
+    outputStr += testResultsOutput(aborted, warnForUnsavedNewTests);
+  }
   if (errors.length) {
     const sortedErrors = errors.sort((a, b) => a.title.localeCompare(b.title));
     outputStr += uniq(
       sortedErrors.map(
-        ({title, err}) => `${title} - ${chalk.red('Failed')} ${err.message || err.toString()}`,
+        ({title, error}) =>
+          `${title} - ${chalk.red('Failed')}. ${error.message || error.toString()}`,
       ),
     ).join('\n');
     outputStr += '\n';
@@ -130,7 +151,9 @@ function testResultsOutput(results, warnForUnsavedNewTests) {
   sortedTestResults.forEach(result => {
     const storyTitle = `${result.result.name} [${result.result.hostApp}] [${result.result.hostDisplaySize.width}x${result.result.hostDisplaySize.height}] - `;
 
-    if (result.result.isNew) {
+    if (result.result.isAborted) {
+      outputStr += `${storyTitle}${chalk.keyword('red')(`Aborted`)}\n`;
+    } else if (result.result.isNew) {
       const newResColor = warnForUnsavedNewTests ? 'orange' : 'blue';
       outputStr += `${storyTitle}${chalk.keyword(newResColor)('New')}\n`;
     } else if (!result.result.isDifferent) {

package/src/renderStories.js

@@ -101,7 +101,6 @@ function makeRenderStories({
           if (error) {
             const errMsg = `[page ${pageId}] Failed to get story data for "${title}". ${error}`;
             logger.log(errMsg);
-            throw new Error(errMsg);
           }
           const testResults = await renderStory({
             snapshots: storyData,

package/src/renderStory.js

@@ -129,12 +129,19 @@ function makeRenderStory({
       return new Promise((resolve, reject) => {
         throttle(async () => {
           try {
-            await eyes.checkAndClose({
-              target: snapshots,
-              settings: {...checkParams, ...closeSettings},
-            });
-            const results = await eyes.getResults();
-            resolve(results);
+            if (snapshots) {
+              await eyes.checkAndClose({
+                target: snapshots,
+                settings: {...checkParams, ...closeSettings},
+              });
+              const results = await eyes.getResults();
+              resolve(results);
+            } else {
+              await eyes.abort({settings: {renderers}});
+              reject(
+                new Error(`Failed to get story data for ${openParams.testName}, test was aborted`),
+              );
+            }
           } catch (err) {
             reject(err);
           }