@applitools/eyes-storybook 3.44.2 → 3.45.0

package/CHANGELOG.md

@@ -1,5 +1,143 @@
 # Changelog
 
+## [3.45.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.3...js/eyes-storybook@3.45.0) (2023-11-21)
+
+
+### Features
+
+* added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.3
+  #### Bug Fixes
+
+  * don't throw error for missing configuration file ([#2034](https://github.com/applitools/eyes.sdk.javascript1/issues/2034)) ([d084e7b](https://github.com/applitools/eyes.sdk.javascript1/commit/d084e7bf6e1727e3969622b4e597881f18241eb3))
+* @applitools/logger bumped to 2.0.13
+
+* @applitools/req bumped to 1.6.3
+
+* @applitools/image bumped to 1.1.8
+
+* @applitools/dom-snapshot bumped to 4.7.14
+  #### Bug Fixes
+
+  * preserve css declarations order in dom-snapshot ([#2037](https://github.com/applitools/eyes.sdk.javascript1/issues/2037)) ([1381851](https://github.com/applitools/eyes.sdk.javascript1/commit/1381851d46f28ea7e7724025c4eab33c81c4e144))
+* @applitools/spec-driver-webdriver bumped to 1.0.50
+  #### Bug Fixes
+
+  * send devtool commands in chromium ([#2039](https://github.com/applitools/eyes.sdk.javascript1/issues/2039)) ([ff42043](https://github.com/applitools/eyes.sdk.javascript1/commit/ff42043c3d9f110eb7b22ab1a8448d77859923b4))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.0
+  #### Features
+
+  * added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+
+
+
+* @applitools/core-base bumped to 1.7.3
+  #### Bug Fixes
+
+  * remove connection timeout in case of a long running tasks ([#2006](https://github.com/applitools/eyes.sdk.javascript1/issues/2006)) ([49a596a](https://github.com/applitools/eyes.sdk.javascript1/commit/49a596ac1b022a66b5c07ecfee458cc061891ce0))
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+* @applitools/socket bumped to 1.1.13
+
+* @applitools/spec-driver-selenium bumped to 1.5.64
+
+* @applitools/driver bumped to 1.15.1
+
+* @applitools/screenshoter bumped to 3.8.16
+
+* @applitools/nml-client bumped to 1.5.16
+
+* @applitools/tunnel-client bumped to 1.3.1
+
+* @applitools/ufg-client bumped to 1.9.8
+
+* @applitools/ec-client bumped to 1.7.16
+
+* @applitools/core bumped to 4.2.0
+  #### Features
+
+  * added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+  * log driver environment info to splank ([#2023](https://github.com/applitools/eyes.sdk.javascript1/issues/2023)) ([11d0546](https://github.com/applitools/eyes.sdk.javascript1/commit/11d0546e76962b4c231e140b0229b8402da27f69))
+
+
+  #### Bug Fixes
+
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+
+## [3.44.3](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.2...js/eyes-storybook@3.44.3) (2023-11-07)
+
+
+### Bug Fixes
+
+* add .cmd for storybook binary for windows for local binaries ([#1964](https://github.com/applitools/eyes.sdk.javascript1/issues/1964)) ([b6ee7d9](https://github.com/applitools/eyes.sdk.javascript1/commit/b6ee7d90d13a85f4ccc999cdcbaedb868d94b307))
+
+
+### Dependencies
+
+* @applitools/dom-shared bumped to 1.0.11
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+* @applitools/dom-capture bumped to 11.2.4
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+
+
+
+* @applitools/dom-snapshot bumped to 4.7.13
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+  * handled duplicated style properties in inline style tags ([#2014](https://github.com/applitools/eyes.sdk.javascript1/issues/2014)) ([2f8bada](https://github.com/applitools/eyes.sdk.javascript1/commit/2f8bada9cd44c65a69e54cbd08f57534632f12d2))
+
+
+
+* @applitools/driver bumped to 1.15.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+* @applitools/screenshoter bumped to 3.8.15
+
+* @applitools/nml-client bumped to 1.5.15
+
+* @applitools/ufg-client bumped to 1.9.7
+  #### Bug Fixes
+
+  * added retries on ufg requests that respond with 503 status code ([7d78917](https://github.com/applitools/eyes.sdk.javascript1/commit/7d78917d559fa182c6723ca34cef2118cf08a036))
+* @applitools/spec-driver-webdriver bumped to 1.0.49
+
+* @applitools/spec-driver-selenium bumped to 1.5.63
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.5
+
+* @applitools/ec-client bumped to 1.7.15
+
+* @applitools/core bumped to 4.1.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+
+
+  #### Bug Fixes
+
+  * fixed issue that caused dom snapshots to be taken for different viewport sizes when layout breakpoints were explicitly turned off ([4121876](https://github.com/applitools/eyes.sdk.javascript1/commit/4121876189f133b6023cfea52ca91c02c31079fb))
+
+
+
+
 ## [3.44.2](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.1...js/eyes-storybook@3.44.2) (2023-10-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.44.2",
+  "version": "3.45.0",
   "description": "",
   "keywords": [
     "applitools",
@@ -32,6 +32,7 @@
     "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha --no-timeouts --trace-warnings 'test/e2e/*.e2e.test.js'",
     "test:e2e:versions": "MOCHA_GROUP=e2e_versions run --top-level mocha --no-timeouts --trace-warnings test/versions/*.e2e.versions.test.js",
     "test:e2e:versions_local": "APPLITOOLS_FRAMEWORK_VERSION=latest npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/versions/*.e2e.versions.test.js",
+    "test:sanity": "run --top-level mocha --no-timeouts --trace-warnings 'test/sanity/*.test.js'",
     "test:heavy": "node bin/eyes-storybook.js -f test/fixtures/heavyStorybook/applitools.config.js",
     "storybook": "start-storybook -c test/fixtures/appWithStorybook -p 9001 -s test/fixtures",
     "storybook:httpHeaders": "start-storybook -c test/fixtures/appWithCustomHttpHeaders -p 9007",
@@ -54,14 +55,14 @@
     "up:framework": "yarn add --dev --caret @storybook/react${APPLITOOLS_FRAMEWORK_VERSION:+@$APPLITOOLS_FRAMEWORK_VERSION}"
   },
   "dependencies": {
-    "@applitools/core": "4.0.2",
-    "@applitools/driver": "1.14.4",
+    "@applitools/core": "4.2.0",
+    "@applitools/driver": "1.15.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "2.0.12",
+    "@applitools/logger": "2.0.13",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.2.4",
-    "@applitools/ufg-client": "1.9.6",
-    "@applitools/utils": "1.6.2",
+    "@applitools/spec-driver-puppeteer": "1.3.0",
+    "@applitools/ufg-client": "1.9.8",
+    "@applitools/utils": "1.6.3",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
@@ -74,7 +75,7 @@
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^5.7.0",
+    "@applitools/bongo": "^5.7.6",
     "@applitools/sdk-shared": "0.9.15",
     "@applitools/snaptdout": "^1.0.1",
     "@applitools/test-server": "^1.2.2",

package/src/extractEnvironment.js

@@ -6,7 +6,14 @@ function extractEnvironment() {
   } catch {
     // NOTE: ignore error
   }
-  return {versions};
+  let sdk;
+  try {
+    const {name, version} = require('../package.json');
+    sdk = {lang: 'js', name, currentVersion: version};
+  } catch {
+    // NOTE: ignore error
+  }
+  return {versions, sdk};
 }
 
 module.exports = {extractEnvironment};

package/src/findNpmModuleCommandPath.js

@@ -9,16 +9,9 @@ const path = require('path');
  * @returns {Promise<string|null>} The path to the command.
  */
 module.exports = async function findNpmModuleCommandPath(npmModuleCommand, packageJsonDirPath) {
-  const isWindows = process.platform.startsWith('win');
-
   let checkRootPath = path.resolve(packageJsonDirPath);
   while (checkRootPath !== '') {
-    const commandPath = path.join(
-      checkRootPath,
-      'node_modules',
-      '.bin',
-      npmModuleCommand + (isWindows ? '.cmd' : ''),
-    );
+    const commandPath = path.join(checkRootPath, 'node_modules', '.bin', npmModuleCommand);
     if (await doesFileExist(commandPath)) return commandPath;
 
     const nextPath = path.dirname(checkRootPath);

package/src/utils/determineStorybookVersion.js

@@ -0,0 +1,34 @@
+const {resolve} = require('path');
+const fs = require('fs');
+const findNpmModuleCommandPath = require('../findNpmModuleCommandPath');
+
+async function determineStorybookVersion({packagePath, isWindows}) {
+  let sbArg,
+    storybookPath,
+    isVersion7 = false;
+
+  const commandV6 = 'start-storybook' + (isWindows ? '.cmd' : '');
+  const commandV7 = 'sb' + (isWindows ? '.cmd' : '');
+  const storybookPathV6 = resolve(packagePath, 'node_modules/.bin', commandV6);
+  const storybookPathV7 = resolve(packagePath, 'node_modules/.bin', commandV7);
+
+  // first we look for the binaries in the local node_modules/.bin folder in case there are multiple versions of storybook installed
+  if (fs.existsSync(storybookPathV6)) {
+    storybookPath = storybookPathV6;
+  } else if (fs.existsSync(storybookPathV7)) {
+    storybookPath = storybookPathV7;
+    isVersion7 = true;
+    sbArg = 'dev';
+  } else {
+    // the binary is not in the local node_modules/.bin folder, so we need to find it
+    storybookPath = await findNpmModuleCommandPath(commandV6, packagePath);
+    if (!storybookPath) {
+      storybookPath = await findNpmModuleCommandPath(commandV7, packagePath);
+      isVersion7 = true;
+      sbArg = 'dev';
+    }
+  }
+
+  return {storybookPath, isVersion7, sbArg};
+}
+module.exports = determineStorybookVersion;

package/src/validateAndPopulateConfig.js

@@ -12,8 +12,7 @@ const {
 const startStorybookServer = require('./startStorybookServer');
 const {isIE} = require('./shouldRenderIE');
 const {makeLogger} = require('@applitools/logger');
-const findNpmModuleCommandPath = require('./findNpmModuleCommandPath');
-const {resolve} = require('path');
+const determineStorybookVersion = require('./utils/determineStorybookVersion');
 
 async function validateAndPopulateConfig({config, packagePath = '', logger = makeLogger()}) {
   if (!config.apiKey) {
@@ -22,7 +21,10 @@ async function validateAndPopulateConfig({config, packagePath = '', logger = mak
 
   const packageJsonPath = `${packagePath}/package.json`;
   const packageJson = fs.existsSync(packageJsonPath) ? require(packageJsonPath) : undefined;
-  const {storybookPath, isVersion7, sbArg} = await determineStorybookVersion(packagePath);
+  const {storybookPath, isVersion7, sbArg} = await determineStorybookVersion({
+    packagePath,
+    isWindows: process.platform.startsWith('win'),
+  });
   logger.log(
     `[validateAndPopulateConfig] storybookPath=${storybookPath} isVersion7=${isVersion7} sbArg=${sbArg}`,
   );
@@ -76,34 +78,4 @@ async function validateAndPopulateConfig({config, packagePath = '', logger = mak
   }
   return isVersion7;
 }
-
-async function determineStorybookVersion(packagePath) {
-  let sbArg,
-    storybookPath,
-    isVersion7 = false;
-
-  const storybookPathV6 = resolve(packagePath, 'node_modules/.bin/start-storybook');
-  const storybookPathV7 = resolve(packagePath, 'node_modules/.bin/sb');
-
-  // first we look for the binaries in the local node_modules/.bin folder in case there are multiple versions of storybook installed
-  if (fs.existsSync(storybookPathV6)) {
-    storybookPath = storybookPathV6;
-  } else if (fs.existsSync(storybookPathV7)) {
-    storybookPath = storybookPathV7;
-    isVersion7 = true;
-    sbArg = 'dev';
-  } else {
-    // the binary is not in the local node_modules/.bin folder, so we need to find it
-    storybookPath = await findNpmModuleCommandPath('start-storybook', packagePath);
-    if (!storybookPath) {
-      storybookPath = await findNpmModuleCommandPath('sb', packagePath);
-      isVersion7 = true;
-      sbArg = 'dev';
-    } else {
-      isVersion7 = false;
-    }
-  }
-
-  return {storybookPath, isVersion7, sbArg};
-}
 module.exports = validateAndPopulateConfig;