@applitools/screenshoter 3.2.3 → 3.2.7

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

@@ -1,25 +1,68 @@
 {
+  "name": "dry-run",
+  "lockfileVersion": 2,
   "requires": true,
-  "lockfileVersion": 1,
+  "packages": {
+    "": {
+      "dependencies": {
+        "@applitools/screenshoter": "file:../dry-run.tgz"
+      }
+    },
+    "node_modules/@applitools/screenshoter": {
+      "version": "3.2.6",
+      "resolved": "file:../dry-run.tgz",
+      "integrity": "sha512-WzfjtYPRtHz35A5qzYaJbVWkyB17lnzu1JHun6I8U6NvBIOIoxKRiT3H/9YSZqr/WR+eGAXRLV7gYi53/nsmKw==",
+      "license": "SEE LICENSE IN LICENSE",
+      "dependencies": {
+        "@applitools/snippets": "2.1.7",
+        "@applitools/utils": "1.2.3",
+        "png-async": "0.9.4"
+      },
+      "engines": {
+        "node": ">= 8.9.0"
+      }
+    },
+    "node_modules/@applitools/snippets": {
+      "version": "2.1.7",
+      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.7.tgz",
+      "integrity": "sha512-Tr4Gj7Qov/oPy+8WI4oVmmubxqpOzr8P3Wjzpl6rA57xKLg6/TiIg5oZNb4+jEmO2ShjNYLaEwRWHl7kPgb4fw==",
+      "engines": {
+        "node": ">=8.9.0"
+      }
+    },
+    "node_modules/@applitools/utils": {
+      "version": "1.2.3",
+      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.3.tgz",
+      "integrity": "sha512-MZXsrzeHTvjFLzpfyKRDUmZWzNxH3gWd3reqYf+1kYimALKB3CO82VDNmkaGJykrRbxEP03Yqha7fHJj9eKslQ==",
+      "engines": {
+        "node": ">= 8.9.0"
+      }
+    },
+    "node_modules/png-async": {
+      "version": "0.9.4",
+      "resolved": "https://registry.npmjs.org/png-async/-/png-async-0.9.4.tgz",
+      "integrity": "sha512-B//AXX9TkneKfgtOpT1mdUnnhk2BImGD+a98vImsMU8uo1dBeHyW/kM2erWZ/CsYteTPU/xKG+t6T62heHkC3A=="
+    }
+  },
   "dependencies": {
     "@applitools/screenshoter": {
       "version": "file:../dry-run.tgz",
-      "integrity": "sha512-g1lcC02PDAyrfC+1pqfHV9TMoDFoudaxC8XJ70F8HblyeIacygUhZbeKERi8nWG9t8Wuztsn/XIGC0N4vcJzjA==",
+      "integrity": "sha512-WzfjtYPRtHz35A5qzYaJbVWkyB17lnzu1JHun6I8U6NvBIOIoxKRiT3H/9YSZqr/WR+eGAXRLV7gYi53/nsmKw==",
       "requires": {
-        "@applitools/snippets": "2.1.4",
-        "@applitools/utils": "1.2.2",
+        "@applitools/snippets": "2.1.7",
+        "@applitools/utils": "1.2.3",
         "png-async": "0.9.4"
       }
     },
     "@applitools/snippets": {
-      "version": "2.1.4",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.4.tgz",
-      "integrity": "sha512-Jmp+DM9Kj24+ByMaqoKxhMNsefsSshN5+MLyMyrFurb1FGRGoSMmAT5bZCI7zKFG02pxZmjBmenMhpNQbzZR/A=="
+      "version": "2.1.7",
+      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.7.tgz",
+      "integrity": "sha512-Tr4Gj7Qov/oPy+8WI4oVmmubxqpOzr8P3Wjzpl6rA57xKLg6/TiIg5oZNb4+jEmO2ShjNYLaEwRWHl7kPgb4fw=="
     },
     "@applitools/utils": {
-      "version": "1.2.2",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.2.tgz",
-      "integrity": "sha512-SyHY41J+hkZR9gma/M8gjbJXLXeLoVS5DQVYd/RinzWAq62Yvg9eA97+8oHDl8s+6ELK6wMcs4yajjqCPdpF0A=="
+      "version": "1.2.3",
+      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.3.tgz",
+      "integrity": "sha512-MZXsrzeHTvjFLzpfyKRDUmZWzNxH3gWd3reqYf+1kYimALKB3CO82VDNmkaGJykrRbxEP03Yqha7fHJj9eKslQ=="
     },
     "png-async": {
       "version": "0.9.4",

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

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@applitools/screenshoter": "file:../dry-run.tgz"
+  }
+}

package/CHANGELOG.md

@@ -4,6 +4,24 @@
 ## Unreleased
 
 
+## 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
+- updated to @applitools/snippets@2.1.7 (from 2.1.4)
+- updated to @applitools/utils@1.2.3 (from 1.2.2)
+
 ## 3.2.3 - 2021/8/13
 
 - remove base64 sanitizing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.2.3",
+  "version": "3.2.7",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -48,13 +48,13 @@
     }
   },
   "dependencies": {
-    "@applitools/snippets": "2.1.4",
-    "@applitools/utils": "1.2.2",
+    "@applitools/snippets": "2.1.7",
+    "@applitools/utils": "1.2.3",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/driver": "1.1.3",
-    "@applitools/sdk-release-kit": "0.13.0",
+    "@applitools/driver": "1.2.6",
+    "@applitools/sdk-release-kit": "0.13.3",
     "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,31 +105,33 @@ 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
       const element = await context.element(region)
       if (!element) throw new Error('Element not found!')
 
+      const elementContext = element.context
+
       if (fully) {
         const isScrollable = await element.isScrollable()
         // if element is scrollable, then take screenshot of the full element content, otherwise take screenshot of full element
         const region = isScrollable ? null : await element.getRegion()
-        const scrollingElement = isScrollable ? element : await context.getScrollingElement()
+        const scrollingElement = isScrollable ? element : await elementContext.getScrollingElement()
         // css stitching could be applied only to root element of its context
         scrollingMode = scrollingMode === 'css' && !(await scrollingElement.isRoot()) ? 'mixed' : scrollingMode
         return {
-          context,
+          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,
+          context: elementContext,
           region: await element.getRegion(),
-          scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
+          scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
         }
       }
     }
@@ -136,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()
@@ -144,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`

package/test/util/spec-driver.js

@@ -10,12 +10,6 @@ function extractElementId(element) {
   return element.elementId || element[ELEMENT_ID] || element[LEGACY_ELEMENT_ID]
 }
 
-function transformSelector(selector) {
-  if (!utils.types.has(selector, ['type', 'selector'])) return selector
-  else if (selector.type === 'css') return `css selector:${selector.selector}`
-  else return `${selector.type}:${selector.selector}`
-}
-
 // #endregion
 
 // #region UTILITY
@@ -29,16 +23,20 @@ function isElement(element) {
   return Boolean(element.elementId || element[ELEMENT_ID] || element[LEGACY_ELEMENT_ID])
 }
 function isSelector(selector) {
-  return (
-    utils.types.isString(selector) ||
-    utils.types.isFunction(selector) ||
-    utils.types.has(selector, ['type', 'selector'])
-  )
+  return utils.types.isString(selector) || utils.types.isFunction(selector)
 }
 function transformElement(element) {
   const elementId = extractElementId(element)
   return {[ELEMENT_ID]: elementId, [LEGACY_ELEMENT_ID]: elementId}
 }
+function transformSelector(selector) {
+  if (utils.types.has(selector, 'selector')) {
+    if (!utils.types.has(selector, 'type')) return selector.selector
+    if (selector.type === 'css') return `css selector:${selector.selector}`
+    else return `${selector.type}:${selector.selector}`
+  }
+  return selector
+}
 function extractSelector(element) {
   return element.selector
 }
@@ -74,11 +72,11 @@ async function childContext(browser, element) {
   return browser
 }
 async function findElement(browser, selector) {
-  const element = await browser.$(transformSelector(selector))
+  const element = await browser.$(selector)
   return !element.error ? element : null
 }
 async function findElements(browser, selector) {
-  const elements = await browser.$$(transformSelector(selector))
+  const elements = await browser.$$(selector)
   return Array.from(elements)
 }
 async function getElementRegion(browser, element) {
@@ -265,6 +263,7 @@ module.exports = {
   isElement,
   isSelector,
   transformElement,
+  transformSelector,
   extractSelector,
   isEqualElements,
   executeScript,