@applitools/screenshoter 3.3.26 → 3.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.3.26",
+  "version": "3.4.2",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -25,6 +25,9 @@
     "name": "Applitools Team",
     "email": "team@applitools.com"
   },
+  "aliases": [
+    "screenshoter"
+  ],
   "exports": {
     ".": {
       "default": "./index.js"
@@ -67,18 +70,18 @@
     }
   },
   "dependencies": {
-    "@applitools/logger": "1.1.8",
-    "@applitools/snippets": "2.2.3",
-    "@applitools/utils": "1.3.3",
+    "@applitools/logger": "1.1.11",
+    "@applitools/snippets": "2.4.1",
+    "@applitools/utils": "1.3.7",
     "jpeg-js": "0.4.3",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.1",
-    "@applitools/driver": "^1.8.15",
+    "@applitools/bongo": "^2.1.5",
+    "@applitools/driver": "^1.9.3",
     "@applitools/scripts": "1.1.0",
-    "@applitools/spec-driver-webdriverio": "1.2.10",
-    "@applitools/test-utils": "1.3.2",
+    "@applitools/spec-driver-webdriverio": "1.2.11",
+    "@applitools/test-utils": "1.3.3",
     "appium": "^1.22.3",
     "chromedriver": "^101.0.0",
     "eslint": "^8.16.0",

package/src/find-image-pattern.js

@@ -1,8 +1,10 @@
 function findImagePattern(image, pattern) {
-  for (let pixel = 0; pixel < image.width * image.height; ++pixel) {
-    if (isPattern(image, pixel, pattern)) {
-      const patterOffset = Math.round(pattern.offset * pattern.scale)
-      return {x: (pixel % image.width) - patterOffset, y: Math.floor(pixel / image.width) - patterOffset}
+  const patterOffset = Math.round(pattern.offset * pattern.scale)
+  const patternItemSize = Math.round(pattern.size * pattern.scale)
+  for (let x = patterOffset; x <= image.width - patterOffset - pattern.mask.length * patternItemSize; ++x) {
+    for (let y = patterOffset; y <= image.height - patterOffset; ++y) {
+      const pixel = y * image.width + x
+      if (isPattern(image, pixel, pattern)) return {x: x - patterOffset, y: y - patterOffset}
     }
   }
   return null
@@ -11,29 +13,31 @@ function findImagePattern(image, pattern) {
 function isPattern(image, offset, pattern) {
   const length = Math.round(pattern.size * pattern.scale)
   for (const [index, color] of pattern.mask.entries()) {
-    const maxLength = index * pattern.size * pattern.scale // how many pixels actually could be occupied at this point
+    const maxLength = (index + 1) * pattern.size * pattern.scale // how many pixels actually could be occupied at this point
     const missedPixels = Math.abs(maxLength - Math.round(maxLength)) // how many pixels were missed due to rounding
     const skippedPixels = missedPixels >= 0.25 ? Math.ceil(missedPixels) : 0 // how many pixels should be skipped from checking in pattern (usually 1 or 0)
     for (let pixel = index * length; pixel < (index + 1) * length - skippedPixels; ++pixel) {
-      const pixelColor = pixelColorAt(image, offset + pixel)
+      const pixelColor = pixelColorAt(image, offset + pixel, length)
       if (pixelColor !== color) return false
     }
   }
   return true
 }
 
-function pixelColorAt(image, index) {
+function pixelColorAt(image, pixel) {
   const channels = 4
-  const r = image.data[index * channels]
-  const g = image.data[index * channels + 1]
-  const b = image.data[index * channels + 2]
+  for (let offset = 0; offset <= 3; ++offset) {
+    const r = image.data[(pixel - offset) * channels]
+    const g = image.data[(pixel - offset) * channels + 1]
+    const b = image.data[(pixel - offset) * channels + 2]
 
-  const luminance = 0.2126 * r + 0.7152 * g + 0.0722 * b
+    const luminance = 0.2126 * r + 0.7152 * g + 0.0722 * b
 
-  // if luminance is between black and white check the color of previous pixel
-  if (luminance >= 112 && luminance <= 144) return pixelColorAt(image, index - 1)
-  else if (luminance < 128) return /* black */ 1
-  else return /* white*/ 0
+    // if luminance is between black and white check the color of previous pixel
+    if (offset < 3 && luminance >= 112 && luminance <= 144) continue
+
+    return luminance < 128 ? /* black */ 1 : /* white*/ 0
+  }
 }
 
 module.exports = findImagePattern

package/src/get-target.js

@@ -32,7 +32,9 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
         // if element is in a native context, then scroll it to the top, otherwise, it will be not possible to get all of its size
         const scrollingElement = await elementContext.getScrollingElement()
         if (scrollingElement && (await scrollingElement.contains(element))) {
-          await scrollingElement.scrollTo(await element.getRegion())
+          const scrollingLocation = utils.geometry.location(await scrollingElement.getRegion())
+          const elementLocation = utils.geometry.location(await element.getRegion())
+          await scrollingElement.scrollTo(utils.geometry.offsetNegative(elementLocation, scrollingLocation))
         }
       }
 

package/src/image.js

@@ -228,10 +228,11 @@ async function toPng(image) {
   })
 }
 
-async function toFile(image, path) {
+async function toFile(image, filepath) {
   const buffer = await toPng(image)
   return new Promise((resolve, reject) => {
-    fs.writeFile(path, buffer, err => (err ? reject(err) : resolve()))
+    fs.mkdirSync(path.dirname(filepath), {recursive: true})
+    fs.writeFile(filepath, buffer, err => (err ? reject(err) : resolve()))
   })
 }
 

package/src/take-screenshot.js

@@ -45,6 +45,8 @@ async function takeScreenshot({
     // unlike web apps, native apps do not always have scrolling element
     if (scrollingElement) {
       if (driver.isWeb && hideScrollbars) await scrollingElement.hideScrollbars()
+      // this is unwanted but necessary side effect, because it is not possible to extract initial scroll position
+      if (driver.isNative && !window) await scrollingElement.scrollTo({x: 0, y: 0}, {force: true})
       await scrollingElement.preserveState()
     }
   }
@@ -60,12 +62,10 @@ async function takeScreenshot({
   }
 
   try {
-    if (!window && !driver.isNative) {
-      await scrollIntoViewport({context: target.context, region: target.region, scroller: target.scroller, logger})
-    }
-    if (fully && !target.region && target.scroller) {
-      await target.scroller.moveTo({x: 0, y: 0})
-    }
+    if (!window && !driver.isNative) await scrollIntoViewport({...target, logger})
+
+    if (fully && !target.region && target.scroller) await target.scroller.moveTo({x: 0, y: 0})
+
     const screenshot =
       fully && target.scroller
         ? await takeStitchedScreenshot({

package/src/take-stitched-screenshot.js

@@ -17,6 +17,8 @@ async function takeStitchedScreenshot({
 }) {
   logger.verbose('Taking full image of...')
 
+  if (await scroller.element.isPager()) overlap = {top: 0, bottom: 0}
+
   const driver = context.driver
   const takeViewportScreenshot = makeTakeViewportScreenshot({logger, driver, stabilization, debug})
   const scrollerState = await scroller.preserveState()
@@ -94,7 +96,11 @@ async function takeStitchedScreenshot({
     const partName = `${partRegion.x}_${partRegion.y}_${partRegion.width}x${partRegion.height}`
     logger.verbose(`Processing part ${partName}`)
 
-    const compensateOffset = {x: 0, y: initialRegion.y !== partRegion.y ? overlap.top : 0}
+    // compensate scroller region being shifted and top overlap
+    const compensateOffset = {
+      x: scrollerRegionShift.x + 0,
+      y: scrollerRegionShift.y + (initialRegion.y !== partRegion.y ? overlap.top : 0),
+    }
     const requiredOffset = utils.geometry.offsetNegative(utils.geometry.location(partRegion), compensateOffset)
 
     logger.verbose('Move to', requiredOffset)

package/src/take-viewport-screenshot.js

@@ -167,7 +167,7 @@ function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
         image.crop({
           top: driver.statusBarHeight,
           bottom: driver.orientation === 'landscape' ? 0 : driver.navigationBarHeight,
-          left: driver.platformVersion > 7 ? driver.navigationBarHeight : 0,
+          left: driver.platformVersion >= 8 ? driver.navigationBarHeight : 0,
           right: driver.platformVersion < 8 ? driver.navigationBarHeight : 0,
         })
       } else {