@applitools/screenshoter 3.2.4 → 3.2.8

package/.bongo/dry-run/package-lock.json

@@ -4,10 +4,10 @@
   "dependencies": {
     "@applitools/screenshoter": {
       "version": "file:../dry-run.tgz",
-      "integrity": "sha512-Lb3Yt6kerHemQ1wViG33DcqxwC3bylxdL9A4PZXWs1cwYjxpm05j8k/L+fUJKsiR+0jCQJF3AdzFv/SUlooeyw==",
+      "integrity": "sha512-J9JOZ+7hf0GMgaDZtNE5oVcRcOwtvDD/gXDP/eEY0PFIPFpXeEZU9abkVH4E6VeT6PwRCZz42EIb8Mvf2nsEkQ==",
       "requires": {
         "@applitools/snippets": "2.1.7",
-        "@applitools/utils": "1.2.3",
+        "@applitools/utils": "1.2.4",
         "png-async": "0.9.4"
       }
     },
@@ -17,9 +17,9 @@
       "integrity": "sha512-Tr4Gj7Qov/oPy+8WI4oVmmubxqpOzr8P3Wjzpl6rA57xKLg6/TiIg5oZNb4+jEmO2ShjNYLaEwRWHl7kPgb4fw=="
     },
     "@applitools/utils": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.3.tgz",
-      "integrity": "sha512-MZXsrzeHTvjFLzpfyKRDUmZWzNxH3gWd3reqYf+1kYimALKB3CO82VDNmkaGJykrRbxEP03Yqha7fHJj9eKslQ=="
+      "version": "1.2.4",
+      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.4.tgz",
+      "integrity": "sha512-w7ma6FFGyqhdP6LEcuHFWOcH7EzBjnoAX3UfbFWcTHA3QXnXPX37Y2ENYRodfwkorP1cUKyUHwNXJB/BMIj/hg=="
     },
     "png-async": {
       "version": "0.9.4",

package/CHANGELOG.md

@@ -4,6 +4,22 @@
 ## Unreleased
 
 
+## 3.2.8 - 2021/10/30
+
+- updated to @applitools/utils@1.2.4 (from 1.2.3)
+
+## 3.2.7 - 2021/10/13
+
+- handle a case when scrolling element does not exist
+
+## 3.2.6 - 2021/10/12
+
+- handle a case when scrolling element does not exist
+
+## 3.2.5 - 2021/10/5
+
+- fix issue with fractional image size after scaling
+
 ## 3.2.4 - 2021/9/9
 
 - handle selectors that evaluate to elements from a different context

package/docker-compose.yaml

@@ -0,0 +1,29 @@
+{
+  "version": "3.4",
+  "services": {
+    "chrome": {
+      "image": "selenium/standalone-chrome",
+      "environment": [
+        "SE_NODE_OVERRIDE_MAX_SESSIONS=true",
+        "SE_NODE_MAX_SESSIONS=15"
+      ],
+      "volumes": [
+        "/dev/shm:/dev/shm"
+      ],
+      "network_mode": "host"
+    },
+    "firefox": {
+      "image": "selenium/standalone-firefox",
+      "environment": [
+        "SE_NODE_OVERRIDE_MAX_SESSIONS=true",
+        "SE_NODE_MAX_SESSIONS=15"
+      ],
+      "volumes": [
+        "/dev/shm:/dev/shm"
+      ],
+      "ports": [
+        "4445:4444"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.2.4",
+  "version": "3.2.8",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -17,7 +17,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git"
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/screenshoter"
   },
   "license": "SEE LICENSE IN LICENSE",
   "author": {
@@ -49,12 +50,12 @@
   },
   "dependencies": {
     "@applitools/snippets": "2.1.7",
-    "@applitools/utils": "1.2.3",
+    "@applitools/utils": "1.2.4",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/driver": "1.2.0",
-    "@applitools/sdk-release-kit": "0.13.3",
+    "@applitools/driver": "1.2.7",
+    "@applitools/sdk-release-kit": "0.13.4",
     "eslint": "^7.9.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
     "eslint-plugin-node": "^11.1.0",

package/src/image.js

@@ -40,7 +40,7 @@ function makeImage(data) {
       return true
     },
     get size() {
-      return {...utils.geometry.scale(size, transforms.scale)}
+      return utils.geometry.round(utils.geometry.scale(size, transforms.scale))
     },
     get transforms() {
       return {...transforms}

package/src/screenshoter.js

@@ -54,13 +54,14 @@ async function screenshoter({
   try {
     if (!window) await scrollIntoViewport({...target, logger})
 
-    const screenshot = fully
-      ? await takeStitchedScreenshot({...target, withStatusBar, overlap, framed, wait, stabilization, debug, logger})
-      : await takeViewportScreenshot({...target, withStatusBar, wait, stabilization, debug, logger})
+    const screenshot =
+      fully && target.scroller
+        ? await takeStitchedScreenshot({...target, withStatusBar, overlap, framed, wait, stabilization, debug, logger})
+        : await takeViewportScreenshot({...target, withStatusBar, wait, stabilization, debug, logger})
 
     if (hooks && hooks.afterScreenshot) {
       // imitate image-like state for the hook
-      if (window && fully) {
+      if (window && fully && target.scroller) {
         await target.scroller.moveTo({x: 0, y: 0}, await driver.mainContext.getScrollingElement())
       }
       await hooks.afterScreenshot({driver, scroller: target.scroller, screenshot})
@@ -68,7 +69,9 @@ async function screenshoter({
 
     return screenshot
   } finally {
-    await target.scroller.restoreScrollbars()
+    if (target.scroller) {
+      await target.scroller.restoreScrollbars()
+    }
 
     // if there was active element and we have blurred it, then restore focus
     if (activeElement) await context.focusElement(activeElement)
@@ -93,7 +96,7 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
     const scrollingElement = await context.main.getScrollingElement()
     return {
       context: context.main,
-      scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
+      scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
     }
   } else if (region) {
     if (utils.types.has(region, ['x', 'y', 'width', 'height'])) {
@@ -102,7 +105,7 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
       return {
         context,
         region,
-        scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
+        scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
       }
     } else {
       // region by element or selector
@@ -121,14 +124,14 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
         return {
           context: elementContext,
           region,
-          scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
+          scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
         }
       } else {
         const scrollingElement = await context.getScrollingElement()
         return {
           context: elementContext,
           region: await element.getRegion(),
-          scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
+          scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
         }
       }
     }
@@ -138,7 +141,7 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
       const scrollingElement = await context.getScrollingElement()
       return {
         context,
-        scroller: makeScroller({logger, element: scrollingElement, scrollingMode}),
+        scroller: scrollingElement ? makeScroller({logger, element: scrollingElement, scrollingMode}) : null,
       }
     } else {
       const scrollingElement = await context.parent.getScrollingElement()
@@ -146,7 +149,7 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
       return {
         context: context.parent,
         region: await element.getRegion(), // IMHO we should use CLIENT (without borders) region here
-        scroller: makeScroller({logger, element: scrollingElement, scrollingMode}),
+        scroller: scrollingElement ? makeScroller({logger, element: scrollingElement, scrollingMode}) : null,
       }
     }
   }

package/src/take-screenshot.js

@@ -107,6 +107,7 @@ function makeTakeMarkedScreenshot({driver, stabilization = {}, debug, logger}) {
     else {
       if (!viewportRegion) viewportRegion = await getViewportRegion()
       image.crop(viewportRegion)
+      await image.debug({...debug, name, suffix: 'viewport'})
     }
 
     return image

package/src/take-stitched-screenshot.js

@@ -55,7 +55,7 @@ async function takeStitchedScreenshot({
 
   // TODO padding should be provided from args instead of overlap
   const padding = {top: overlap, bottom: overlap}
-  const [initialRegion, ...partRegions] = utils.geometry.divide(region, image.size, padding)
+  const [initialRegion, ...partRegions] = utils.geometry.divide(region, utils.geometry.round(image.size), padding)
   logger.verbose('Part regions', partRegions)
 
   logger.verbose('Creating stitched image composition container')

package/test/e2e/android.spec.js

@@ -53,8 +53,12 @@ describe('screenshoter', () => {
       return fullApp({type: 'recycler'})
     })
 
+    it('take full app screenshot (non-scrollable)', () => {
+      return fullApp({type: 'non-scrollable'})
+    })
+
     it('take region screenshot', () => {
-      region()
+      return region()
     })
 
     it.skip('take full region screenshot', () => {
@@ -114,6 +118,9 @@ describe('screenshoter', () => {
         buttonSelector = {type: 'id', selector: 'btn_recycler_view'}
         expectedPath = `./test/fixtures/android/app-fully-recycler${options.withStatusBar ? '-statusbar' : ''}.png`
       }
+    } else if (type === 'non-scrollable') {
+      buttonSelector = {type: 'id', selector: 'btn_edit_text'}
+      expectedPath = `./test/fixtures/android/app-fully-non-scrollable${options.withStatusBar ? '-statusbar' : ''}.png`
     } else {
       buttonSelector = {type: 'id', selector: 'btn_scroll_view_footer_header'}
       expectedPath = `./test/fixtures/android/app-fully-scroll${options.withStatusBar ? '-statusbar' : ''}.png`