@applitools/eyes-storybook 3.28.0 → 3.29.2

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 ## Unreleased
 
 
+## 3.29.2 - 2022/7/14
+
+### Features
+- Allow configuration file to be loaded from ancestor directories
+### Bug fixes
+- Fixed bug where a failure in a single UFG environment fails all other environments in the same configuration
+
+## 3.29.1 - 2022/6/16
+
+### Features
+- Allowed `` values in custom properties
+- Add special attribute for pseudo elements
+- Support padding for regions in the following region types - ignoreRegions, layoutRegions, strictRegions, contentRegions
+### Bug fixes
+- Fixed broken links to enums implementation in the README.md
+- Fix rendering issues with Salesforce Lightning design system
+- Add timeout when attempting to get data for a story
+
+## 3.29.0 - 2022/6/2
+
+### Features
+- Dorp support for Node.js versions <=12
+### Bug fixes
+
 ## 3.28.0 - 2022/5/26
 
 ### Features

package/README.md

@@ -293,7 +293,7 @@ module.exports = {
 
 Possible values for screen orientation are `landscape` and `portrait`, and if no value is specified, the default is `portrait`.
 
-The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/DeviceName.js
+The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/DeviceName.ts
 
 In addition, it's possible to use chrome's device emulation with custom viewport sizes, pixel density and mobile mode, by passing `deviceScaleFactor` and `mobile` in addition to `width` and `height`. For example:
 
@@ -323,7 +323,7 @@ module.exports = {
 }
 ```
 
-The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/IosDeviceName.js
+The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
 
 Possible values for `iosVersion` are:
 
@@ -852,7 +852,7 @@ storiesOf('Some kind', module).add('Date', () => <div>{date}</div>)
 
 ## Storybook interactions Play functionality
 
-Since version 3.27.7, there is a support for Storybooks' Interactions Play functionality: Stories who use 'Play', screenshot will be taken _automatically_ after the 'Play' flow is done.
+Since version 3.28.0, there is a support for Storybooks' Interactions Play functionality: Stories who use 'Play', screenshot will be taken _automatically_ after the 'Play' flow is done.
 This will replace the existing point of taking screenshots, it should not affect any new or existing Stories which are **not** using the 'Play' functionality.
 Tests that use the _`waitBeforeCapture`_ property, the wait period will begin **after** the 'Play' flow is done.
 You can read more at Storybook interactions documentation:

package/package.json

@@ -1,30 +1,47 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.28.0",
+  "version": "3.29.2",
   "description": "",
-  "engines": {
-    "node": ">=8.6.0"
+  "keywords": [
+    "applitools",
+    "testing",
+    "browser",
+    "grid",
+    "visual-testing",
+    "nodejs",
+    "javascript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "js/packages/eyes-storybook"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Applitools Team <team@applitools.com>",
+  "aliases": [
+    "storybook"
+  ],
+  "bin": {
+    "eyes-storybook": "./bin/eyes-storybook.js"
   },
   "files": [
     "src",
     "bin",
     "dist"
   ],
-  "bin": {
-    "eyes-storybook": "./bin/eyes-storybook.js"
-  },
   "scripts": {
+    "lint": "eslint '**/*.js'",
+    "build": "rollup -c rollup.config.js",
+    "build:heavy": "node scripts/bitmap.js",
     "test": "yarn build && yarn test:mocha && yarn lint",
-    "test:versions": "yarn build && yarn test:e2e:versions && yarn lint",
+    "test:sanity": "yarn test:unit && yarn test:it",
     "test:mocha": "yarn test:unit && yarn test:it && yarn test:e2e",
-    "test:unit": "STDOUT_LEVEL=0 mocha --no-timeouts --trace-warnings 'test/unit/*.test.js'",
-    "test:it": "STDOUT_LEVEL=1 mocha --no-timeouts --trace-warnings 'test/it/*.test.js'",
+    "test:unit": "mocha --no-timeouts --trace-warnings 'test/unit/*.test.js'",
+    "test:it": "mocha --no-timeouts --trace-warnings 'test/it/*.test.js'",
+    "test:versions": "yarn build && yarn test:e2e:versions && yarn lint",
     "test:e2e": "mocha --no-timeouts --trace-warnings 'test/e2e/*.e2e.test.js'",
     "test:e2e:versions": "npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/e2e/*.e2e.versions.test.js",
     "test:e2e:versions_local": "STORYBOOK_VERSION=latest npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/e2e/*.e2e.versions.test.js",
-    "build": "rollup -c rollup.config.js",
-    "build:heavy": "node scripts/bitmap.js",
-    "lint": "eslint '**/*.js'",
     "storybook": "start-storybook -c test/fixtures/appWithStorybook -p 9001 -s test/fixtures",
     "storybook:jslayout": "start-storybook -c test/fixtures/jsLayoutStorybookLocal -p 9001 -s test/fixtures",
     "storybook:csf": "yarn storybook:csf-service && start-storybook -c test/fixtures/storybookCSF/.storybook-temp -p 9001",
@@ -40,39 +57,28 @@
     "changelog:init": "git config changelog.format \"* %s [[%h]($(echo $npm_package_repository_url|cut -d+ -f2|cut -d. -f1-2)/commit/%H)]\"",
     "changelog:install": "sudo apt-get install git-extras",
     "gh:publish": "gh workflow run publish-storybook.yml --ref $(git rev-parse --abbrev-ref HEAD)",
+    "prepublish:setup": "echo 'setup is a no-op. Move along, nothing to see here.'",
+    "deps": "bongo deps",
     "postinstall": "node src/postinstall",
     "preversion": "bongo preversion --verifyPendingChanges",
     "version": "bongo version --withPendingChanges",
-    "postversion": "bongo postversion --skip-release-notification",
-    "deps": "bongo deps",
-    "prepublish:setup": "echo 'setup is a no-op. Move along, nothing to see here.'"
+    "postversion": "bongo postversion --skip-release-notification"
   },
-  "keywords": [
-    "applitools",
-    "testing",
-    "browser",
-    "grid",
-    "visual-testing",
-    "nodejs",
-    "javascript"
-  ],
-  "author": "Applitools Team <team@applitools.com>",
-  "license": "SEE LICENSE IN LICENSE",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
-    "directory": "packages/eyes-storybook"
+  "husky": {
+    "hooks": {
+      "pre-push": "yarn bongo lint"
+    }
   },
   "dependencies": {
-    "@applitools/driver": "1.8.12",
-    "@applitools/eyes-sdk-core": "13.6.21",
+    "@applitools/driver": "1.9.15",
+    "@applitools/eyes-sdk-core": "13.8.12",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.5",
+    "@applitools/logger": "1.1.15",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.1.2",
-    "@applitools/test-server": "1.0.9",
-    "@applitools/utils": "1.3.0",
-    "@applitools/visual-grid-client": "15.12.33",
+    "@applitools/spec-driver-puppeteer": "1.1.6",
+    "@applitools/test-server": "1.1.4",
+    "@applitools/utils": "1.3.10",
+    "@applitools/visual-grid-client": "15.13.6",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
@@ -84,9 +90,9 @@
     "yargs": "15.4.1"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.0",
+    "@applitools/bongo": "^2.1.6",
     "@applitools/scripts": "^1.1.0",
-    "@applitools/sdk-shared": "0.9.11",
+    "@applitools/sdk-shared": "0.9.13",
     "@applitools/snaptdout": "^1.0.1",
     "@storybook/addon-interactions": "^6.4.18",
     "@storybook/react": "^6.4.18",
@@ -115,9 +121,7 @@
     "rollup-plugin-commonjs": "^10.1.0",
     "ua-parser-js": "^0.7.21"
   },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
+  "engines": {
+    "node": ">=12.13.0"
   }
 }

package/src/cli.js

@@ -15,7 +15,7 @@ const handleJsonFile = require('./handleJsonFile');
 const handleTapFile = require('./handleTapFile');
 const handleXmlFile = require('./handleXmlFile');
 const {presult} = require('@applitools/functional-commons');
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 const {performance, timeItAsync} = makeTiming();
 
 (async function() {

package/src/concurrencyMsg.js

@@ -1,5 +1,5 @@
 'use strict';
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 
 module.exports = chalk.yellow(`
 Important notice: Your Applitools visual tests are currently running with a concurrency value of 5.

package/src/errMessages.js

@@ -1,5 +1,5 @@
 'use strict';
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 
 const missingApiKeyFailMsg = `
 ${chalk.red('Environment variable APPLITOOLS_API_KEY is not set.')}

package/src/eyesStorybook.js

@@ -3,7 +3,7 @@ const puppeteer = require('puppeteer');
 const getStories = require('../dist/getStories');
 const {makeVisualGridClient} = require('@applitools/visual-grid-client');
 const {presult, delay} = require('@applitools/functional-commons');
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 const makeInitPage = require('./initPage');
 const makeRenderStory = require('./renderStory');
 const makeRenderStories = require('./renderStories');

package/src/generateConfig.js

@@ -1,15 +1,16 @@
 'use strict';
 const pick = require('lodash.pick');
-const {ConfigUtils, GeneralUtils} = require('@applitools/eyes-sdk-core');
+const utils = require('@applitools/utils');
+const {GeneralUtils} = require('@applitools/eyes-sdk-core');
 const {resolve} = require('path');
 const {deprecationWarning} = GeneralUtils;
 const uniq = require('./uniq');
 
 function generateConfig({argv = {}, defaultConfig = {}, externalConfigParams = []}) {
-  const configPath = argv.conf ? resolve(process.cwd(), argv.conf) : undefined;
   const defaultConfigParams = Object.keys(defaultConfig);
+  const configPaths = argv.conf ? [resolve(process.cwd(), argv.conf)] : undefined;
   const configParams = uniq(defaultConfigParams.concat(externalConfigParams));
-  const config = ConfigUtils.getConfig({configPath, configParams});
+  const config = utils.config.getConfig({paths: configPaths, params: configParams});
   const argvConfig = pick(argv, configParams);
   const result = Object.assign({}, defaultConfig, config, argvConfig);
 

package/src/getStoryData.js

@@ -1,5 +1,5 @@
 'use strict';
-const {presult} = require('@applitools/functional-commons');
+const {presult, ptimeoutWithError} = require('@applitools/functional-commons');
 const {ArgumentGuard} = require('@applitools/eyes-sdk-core');
 const renderStoryWithClientAPI = require('../dist/renderStoryWithClientAPI');
 const runRunBeforeScript = require('../dist/runRunBeforeScript');
@@ -7,6 +7,7 @@ const getStoryBaselineName = require('./getStoryBaselineName');
 const {URL} = require('url');
 const runRunAfterScript = require('../dist/runRunAfterScript');
 const waitFor = require('./waitFor');
+const PAGE_EVALUATE_TIMEOUT = 120000;
 
 function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPagePerStory}) {
   return async function getStoryData({story, storyUrl, page, browser, waitBeforeStory}) {
@@ -18,8 +19,21 @@ function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPa
       const currentUrl = page.url();
       const expectedQueryParams = eyesParameters ? eyesParameters.queryParams : undefined;
       if (urlQueryParamsEquals(currentUrl, expectedQueryParams)) {
-        const err = await page.evaluate(renderStoryWithClientAPI, story.index);
-        err && handleRenderStoryError(err);
+        try {
+          const err = await ptimeoutWithError(
+            page.evaluate(renderStoryWithClientAPI, story.index),
+            PAGE_EVALUATE_TIMEOUT,
+            'page evaluate timed out!',
+          );
+          logger.log(`[story data] done with page evaluate for story index: ${story.index}`);
+          err && handleRenderStoryError(err);
+        } catch (ex) {
+          if (!ex.message.includes('Eyes could not render stories properly'))
+            handleRenderStoryError(ex);
+          else {
+            throw ex;
+          }
+        }
       } else {
         await renderStoryLegacy();
       }

package/src/postinstall.js

@@ -1,4 +1,4 @@
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 const boxen = require('boxen');
 console.log(
   boxen(

package/src/processResults.js

@@ -1,6 +1,6 @@
 'use strict';
 const flatten = require('lodash.flatten');
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 const {TestResultsError, TestResultsFormatter} = require('@applitools/eyes-sdk-core');
 const utils = require('@applitools/utils');
 const uniq = require('./uniq');

package/src/shouldRenderIE.js

@@ -1,5 +1,3 @@
-const {BrowserType} = require('@applitools/eyes-sdk-core');
-
 function splitConfigsByBrowser(config) {
   const browsers = validateBrowsers(config);
   if (browsers.length) {
@@ -33,7 +31,7 @@ function hasIE(config) {
 }
 
 function isIE(browser) {
-  return browser.name === BrowserType.IE_11 || browser.name === 'ie11';
+  return browser.name === 'ie' || browser.name === 'ie11';
 }
 
 function validateBrowsers(config) {

package/src/validateAndPopulateConfig.js

@@ -1,5 +1,5 @@
 'use strict';
-const chalk = require('./chalkify');
+const chalk = require('chalk');
 const fs = require('fs');
 const detect = require('detect-port');
 const {version: packageVersion} = require('../package.json');

package/src/chalkify.js

@@ -1,4 +0,0 @@
-const Chalk = require('chalk').Instance;
-const level = Number(process.env.STDOUT_LEVEL || 2);
-const chalk = new Chalk({level});
-module.exports = chalk;