@applitools/screenshoter 3.5.0 → 3.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.5.0",
+  "version": "3.5.2",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -72,19 +72,19 @@
     }
   },
   "dependencies": {
-    "@applitools/image": "1.0.1",
-    "@applitools/logger": "1.1.16",
+    "@applitools/image": "1.0.2",
+    "@applitools/logger": "1.1.20",
     "@applitools/snippets": "2.4.5",
-    "@applitools/utils": "1.3.10",
+    "@applitools/utils": "1.3.12",
     "jpeg-js": "0.4.4",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.6",
-    "@applitools/driver": "^1.9.23",
+    "@applitools/bongo": "^2.2.0",
+    "@applitools/driver": "^1.9.28",
     "@applitools/scripts": "^1.1.0",
-    "@applitools/spec-driver-webdriverio": "^1.2.19",
-    "@applitools/test-utils": "^1.5.0",
+    "@applitools/spec-driver-webdriverio": "^1.2.20",
+    "@applitools/test-utils": "^1.5.1",
     "appium": "^1.22.3",
     "chromedriver": "^101.0.0",
     "eslint": "^8.16.0",

package/src/get-target.js

@@ -37,26 +37,28 @@ async function getTarget({window, context, region, fully, scrollingMode, logger}
           await scrollingElement.scrollTo(utils.geometry.offsetNegative(elementLocation, scrollingLocation))
         }
       }
+      let returnRegion, scrollingElement
 
       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 elementContext.getScrollingElement()
+        returnRegion = isScrollable ? null : await element.getRegion()
+        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: elementContext,
-          region,
-          scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
-        }
       } else {
-        const scrollingElement = await context.getScrollingElement()
-        return {
-          context: elementContext,
-          region: await element.getRegion(),
-          scroller: makeScroller({element: scrollingElement, scrollingMode, logger}),
-        }
+        scrollingElement = await context.getScrollingElement()
+        returnRegion = await element.getRegion()
+      }
+      const scroller = makeScroller({element: scrollingElement, scrollingMode, logger})
+      if (returnRegion && !element.driver.isNative && !(await scrollingElement.isRoot())) {
+        const scrollerOffset = await scroller.getScrollOffset()
+        returnRegion = utils.geometry.offset(returnRegion, scrollerOffset)
+      }
+      return {
+        context: elementContext,
+        region: returnRegion,
+        scroller,
       }
     }
   } else if (!context.isMain) {

package/src/scroller.js

@@ -37,8 +37,8 @@ function makeScroller({logger, element, scrollingMode = 'mixed'}) {
     if (scrollingMode === 'mixed+') return getShiftOffset(element)
   }
 
-  async function getContentSize() {
-    const size = await element.getContentSize()
+  async function getContentSize(options) {
+    const size = await element.getContentSize(options)
     return size
   }
 

package/src/take-screenshot.js

@@ -22,6 +22,7 @@ async function takeScreenshot({
   hooks,
   debug,
   logger,
+  lazyLoad,
 }) {
   debug =
     debug ||
@@ -63,56 +64,58 @@ async function takeScreenshot({
     if (driver.isWeb && hideScrollbars) await target.scroller.hideScrollbars()
   }
 
-  try {
-    // TODO: identify spot in this function to call to takeScreenshot in the nml-client
-    // if running on native mobile and the user has enabled NML
-    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({
-            ...target,
-            withStatusBar,
-            overlap,
-            framed,
-            wait,
-            stabilization,
-            debug,
-            logger,
-          })
-        : await takeSimpleScreenshot({...target, withStatusBar, wait, stabilization, debug, logger})
-
-    screenshot.image.scale(driver.viewportScale)
-
-    const caltulatedRegions = await extractCoodinatesForSelectorsAndElements({regionsToCalculate, screenshot, context})
-
-    if (hooks && hooks.afterScreenshot) {
-      await hooks.afterScreenshot({driver, scroller: target.scroller, screenshot})
-    }
+  if (!window && !driver.isNative) await scrollIntoViewport({...target, logger})
 
-    return {screenshot, caltulatedRegions}
-  } finally {
-    if (target.scroller) {
-      await target.scroller.restoreScrollbars()
-      await target.scroller.restoreState()
-    }
+  if (fully && !target.region && target.scroller) await target.scroller.moveTo({x: 0, y: 0})
+
+  const screenshot =
+    fully && target.scroller
+      ? await takeStitchedScreenshot({
+          ...target,
+          withStatusBar,
+          overlap,
+          framed,
+          wait,
+          stabilization,
+          debug,
+          logger,
+          lazyLoad,
+        })
+      : await takeSimpleScreenshot({...target, withStatusBar, wait, stabilization, debug, logger})
+
+  screenshot.image.scale(driver.viewportScale)
+
+  const calculatedRegions = await extractCoodinatesForSelectorsAndElements({regionsToCalculate, screenshot, context})
 
-    // if there was active element and we have blurred it, then restore focus
-    if (activeElement) await context.focusElement(activeElement)
+  if (hooks && hooks.afterScreenshot) {
+    await hooks.afterScreenshot({driver, scroller: target.scroller, screenshot})
+  }
 
-    // traverse from target context to the main context to restore scrollbars and context states
-    for (const prevContext of context.path.reverse()) {
-      const scrollingElement = await prevContext.getScrollingElement()
-      if (scrollingElement) {
-        if (driver.isWeb && hideScrollbars) await scrollingElement.restoreScrollbars()
-        await scrollingElement.restoreState()
+  return {
+    ...screenshot,
+    scrollingElement: target.scroller && target.scroller.element,
+    calculatedRegions,
+    async restoreState() {
+      if (target.scroller) {
+        await target.scroller.restoreScrollbars()
+        await target.scroller.restoreState()
+      }
+
+      // if there was active element and we have blurred it, then restore focus
+      if (activeElement) await context.focusElement(activeElement)
+
+      // traverse from target context to the main context to restore scrollbars and context states
+      for (const prevContext of context.path.reverse()) {
+        const scrollingElement = await prevContext.getScrollingElement()
+        if (scrollingElement) {
+          if (driver.isWeb && hideScrollbars) await scrollingElement.restoreScrollbars()
+          await scrollingElement.restoreState()
+        }
       }
-    }
 
-    // restore focus on original active context
-    await activeContext.focus()
+      // restore focus on original active context
+      await activeContext.focus()
+    },
   }
 }
 

package/src/take-stitched-screenshot.js

@@ -14,6 +14,7 @@ async function takeStitchedScreenshot({
   wait,
   stabilization,
   debug,
+  lazyLoad,
 }) {
   logger.verbose('Taking full image of...')
 
@@ -30,7 +31,7 @@ async function takeStitchedScreenshot({
 
   await utils.general.sleep(wait)
 
-  const contentSize = await scroller.getContentSize()
+  const contentSize = await scroller.getContentSize({lazyLoad})
 
   logger.verbose(
     'preMoveOffset',