@applitools/eyes-storybook 3.30.2 → 3.31.0

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 ## Unreleased
 
 
+## 3.31.0 - 2023/2/15
+
+### Features
+- Crop screenshot image base on account info
+- Add the option to send external http headers to Puppeteer Page object
+### Bug fixes
+
 ## 3.30.2 - 2023/1/23
 
 ### Features

package/README.md

@@ -178,6 +178,7 @@ In addition to command-line arguments, it's possible to define the following con
 | `ignoreBaseline`          | false                       |  |
 | `runInDocker`             | false                       | If you are having issues running the SDK in docker, set this flag to `true`. See more info [below](#running-eyes-storybook-in-docker) |
 | `puppeteerOptions`        | undefined                | Options to send to `puppeteer.launch`. This is a low-level configuration and should be used with great care. Example use `{ args: ['--no-sandbox'], headless: false, devtools: true}` |
+| `puppeteerExtraHTTPHeaders`        | undefined                | Options to send to `page.setExtraHTTPHeaders`. [See docs](https://pptr.dev/api/puppeteer.page.setextrahttpheaders)|
 | `jsonFilePath`            | undefined                   | Directory path of a results file. If set, then a [JSON](https://www.json.org/json-en.html) file is created in this directory, the file is created with the name eyes.json and contains the Eyes test results. |
 | `tapFilePath`             | undefined                   | Directory path of a results file. If set, then a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol#Specification) file is created in this directory, the file is created with the name eyes.tap and contains the Eyes test results. |
 | `xmlFilePath`             | undefined                   | Directory path of a results file. If set, then a [XUnit XML](https://google.github.io/rich-test-results/xunitxml) file is created in this directory, the file is created with the name eyes.xml and contains the Eyes test results. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.30.2",
+  "version": "3.31.0",
   "description": "",
   "keywords": [
     "applitools",
@@ -43,6 +43,7 @@
     "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",
     "storybook": "start-storybook -c test/fixtures/appWithStorybook -p 9001 -s test/fixtures",
+    "storybook:httpHeaders": "start-storybook -c test/fixtures/appWithCustomHttpHeaders -p 9007",
     "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",
     "storybook:csf-service": "cp -r test/fixtures/storybookCSF/.storybook/. test/fixtures/storybookCSF/.storybook-temp && rm test/fixtures/storybookCSF/.storybook-temp/config.js",
@@ -54,6 +55,7 @@
     "eyes-storybook:heavy": "node bin/eyes-storybook.js -f test/fixtures/heavyStorybook/applitools.config.js",
     "eyes-storybook:configured": "node bin/eyes-storybook.js -f scripts/preconfigured.config.js",
     "eyes-storybook:zeroStories": "node bin/eyes-storybook.js -f test/fixtures/zeroStoriesRetry/applitools.config.js",
+    "eyes-storybook:httpHeaders": "node bin/eyes-storybook.js -f test/fixtures/appWithCustomHttpHeaders/applitools.config.js",
     "eyes-storybook:csf-v7": "node bin/eyes-storybook.js -f test/fixtures/storybookCSFV7/applitools.config.js",
     "changelog": "git changelog -x -p -f v$npm_package_version > History.md && git add ./History.md && git commit -am 'changelog'",
     "changelog:init": "git config changelog.format \"* %s [[%h]($(echo $npm_package_repository_url|cut -d+ -f2|cut -d. -f1-2)/commit/%H)]\"",
@@ -72,15 +74,15 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.4.2",
-    "@applitools/driver": "1.11.25",
+    "@applitools/core": "2.3.1",
+    "@applitools/driver": "1.11.30",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.40",
+    "@applitools/logger": "1.1.45",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.1.36",
-    "@applitools/test-server": "1.1.21",
-    "@applitools/ufg-client": "1.1.19",
-    "@applitools/utils": "1.3.26",
+    "@applitools/spec-driver-puppeteer": "1.1.41",
+    "@applitools/test-server": "1.1.25",
+    "@applitools/ufg-client": "1.1.25",
+    "@applitools/utils": "1.3.30",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
@@ -93,8 +95,7 @@
     "yargs": "15.4.1"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.2.2",
-    "@applitools/scripts": "^1.2.0",
+    "@applitools/bongo": "^2.2.5",
     "@applitools/sdk-shared": "0.9.15",
     "@applitools/snaptdout": "^1.0.1",
     "@storybook/addon-interactions": "^6.4.18",

package/src/eyesStorybook.js

@@ -205,12 +205,12 @@ async function eyesStorybook({
         timeItAsync,
       }),
     );
-    const [errorCloseManager, testResultsSummary] = await presult(
-      manager.closeManager({throwErr: false}),
+    const [errorInGetResults, testResultsSummary] = await presult(
+      manager.getResults({throwErr: false}),
     );
 
-    if (errorCloseManager) {
-      logger.log('failed to close manager', errorCloseManager);
+    if (errorInGetResults) {
+      logger.log('failed to get results', errorInGetResults);
     }
 
     if (error) {

package/src/initPage.js

@@ -22,6 +22,10 @@ function makeInitPage({iframeUrl, config, browser, logger, getTransitiongIntoIE,
       });
     }
 
+    if (config.puppeteerExtraHTTPHeaders) {
+      await page.setExtraHTTPHeaders(config.puppeteerExtraHTTPHeaders);
+    }
+
     page.on('close', async () => {
       if (!getTransitiongIntoIE() && pagePool.isInPool(pageId)) {
         logger.log(