@applitools/screenshoter 3.3.2 → 3.3.3

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

@@ -9,13 +9,13 @@
       }
     },
     "node_modules/@applitools/screenshoter": {
-      "version": "3.3.1",
+      "version": "3.3.2",
       "resolved": "file:../dry-run.tgz",
-      "integrity": "sha512-Nn4m2tV2g1+ECbNzbJ4NJzvpx02lYAZ6MM4HXuT16ShCZPXi2fCuvnJEZX3D5j/EkZjEB6yFZWXrKT70m2Djew==",
+      "integrity": "sha512-5epXLfRKO+64jIbxTYwUMUui0xGPQmwccz5aMlLg2V1gtgyrcZ689cn7n8jDBWPCt1Ds0MNEZCimcDjGiAXb4Q==",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
-        "@applitools/snippets": "2.1.10",
-        "@applitools/utils": "1.2.4",
+        "@applitools/snippets": "2.1.11",
+        "@applitools/utils": "1.2.5",
         "png-async": "0.9.4"
       },
       "engines": {
@@ -23,17 +23,17 @@
       }
     },
     "node_modules/@applitools/snippets": {
-      "version": "2.1.10",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.10.tgz",
-      "integrity": "sha512-LGjtd8IZOwbhETqKRDX9CX85+BskkFUkuMuLvriSDEEQiSm0MpFbbcJVMjYaVL2qobaJbY+3WvK0g7+gkZuuqA==",
+      "version": "2.1.11",
+      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.11.tgz",
+      "integrity": "sha512-uNx2sqFACva5Lt23NvYjnxkbUoyAmoCN8dVtAFOhL2a0HyxzYKP5z0tCT/JK8QqM3gkSzeQ0rT0FdxQ9UAl7Og==",
       "engines": {
         "node": ">=8.9.0"
       }
     },
     "node_modules/@applitools/utils": {
-      "version": "1.2.4",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.4.tgz",
-      "integrity": "sha512-w7ma6FFGyqhdP6LEcuHFWOcH7EzBjnoAX3UfbFWcTHA3QXnXPX37Y2ENYRodfwkorP1cUKyUHwNXJB/BMIj/hg==",
+      "version": "1.2.5",
+      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.5.tgz",
+      "integrity": "sha512-nETSgqGeCk5yqjFaQ7x1KURf+t5IxsY2RoeFB5w1+6lHprmHdEithMcN0tiJWeqi14QBJdUkXCzCJrMW5RcDFg==",
       "engines": {
         "node": ">= 8.9.0"
       }
@@ -47,22 +47,22 @@
   "dependencies": {
     "@applitools/screenshoter": {
       "version": "file:../dry-run.tgz",
-      "integrity": "sha512-Nn4m2tV2g1+ECbNzbJ4NJzvpx02lYAZ6MM4HXuT16ShCZPXi2fCuvnJEZX3D5j/EkZjEB6yFZWXrKT70m2Djew==",
+      "integrity": "sha512-5epXLfRKO+64jIbxTYwUMUui0xGPQmwccz5aMlLg2V1gtgyrcZ689cn7n8jDBWPCt1Ds0MNEZCimcDjGiAXb4Q==",
       "requires": {
-        "@applitools/snippets": "2.1.10",
-        "@applitools/utils": "1.2.4",
+        "@applitools/snippets": "2.1.11",
+        "@applitools/utils": "1.2.5",
         "png-async": "0.9.4"
       }
     },
     "@applitools/snippets": {
-      "version": "2.1.10",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.10.tgz",
-      "integrity": "sha512-LGjtd8IZOwbhETqKRDX9CX85+BskkFUkuMuLvriSDEEQiSm0MpFbbcJVMjYaVL2qobaJbY+3WvK0g7+gkZuuqA=="
+      "version": "2.1.11",
+      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.11.tgz",
+      "integrity": "sha512-uNx2sqFACva5Lt23NvYjnxkbUoyAmoCN8dVtAFOhL2a0HyxzYKP5z0tCT/JK8QqM3gkSzeQ0rT0FdxQ9UAl7Og=="
     },
     "@applitools/utils": {
-      "version": "1.2.4",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.4.tgz",
-      "integrity": "sha512-w7ma6FFGyqhdP6LEcuHFWOcH7EzBjnoAX3UfbFWcTHA3QXnXPX37Y2ENYRodfwkorP1cUKyUHwNXJB/BMIj/hg=="
+      "version": "1.2.5",
+      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.5.tgz",
+      "integrity": "sha512-nETSgqGeCk5yqjFaQ7x1KURf+t5IxsY2RoeFB5w1+6lHprmHdEithMcN0tiJWeqi14QBJdUkXCzCJrMW5RcDFg=="
     },
     "png-async": {
       "version": "0.9.4",

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 ## Unreleased
 
 
+## 3.3.3 - 2021/12/22
+
+- improve default rotation and scaling logic
+- improve scroll into viewport algorithm
+- fix lazy handling of image rotation
+- updated to @applitools/snippets@2.1.11 (from 2.1.10)
+- updated to @applitools/utils@1.2.5 (from 1.2.4)
+
 ## 3.3.2 - 2021/12/20
 
 - add basic support of webview screenshots on ios

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=30"
+      ],
+      "volumes": [
+        "/dev/shm:/dev/shm"
+      ],
+      "network_mode": "host"
+    },
+    "firefox": {
+      "image": "selenium/standalone-firefox",
+      "environment": [
+        "SE_NODE_OVERRIDE_MAX_SESSIONS=true",
+        "SE_NODE_MAX_SESSIONS=30"
+      ],
+      "volumes": [
+        "/dev/shm:/dev/shm"
+      ],
+      "ports": [
+        "4445:4444"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -49,14 +49,14 @@
     }
   },
   "dependencies": {
-    "@applitools/snippets": "2.1.10",
-    "@applitools/utils": "1.2.4",
+    "@applitools/snippets": "2.1.11",
+    "@applitools/utils": "1.2.5",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/driver": "1.4.5",
+    "@applitools/driver": "1.4.6",
     "@applitools/sdk-release-kit": "0.13.4",
-    "@applitools/spec-driver-webdriverio": "1.2.2",
+    "@applitools/spec-driver-webdriverio": "1.2.5",
     "@applitools/test-utils": "1.0.10",
     "chromedriver": "^95.0.0",
     "eslint": "^7.9.0",

package/src/image.js

@@ -38,7 +38,9 @@ function makeImage(data) {
       return true
     },
     get size() {
-      return utils.geometry.round(utils.geometry.scale(size, transforms.scale))
+      return utils.geometry.round(
+        utils.geometry.rotate(utils.geometry.scale(size, transforms.scale), transforms.rotate),
+      )
     },
     get transforms() {
       return {...transforms}
@@ -51,6 +53,12 @@ function makeImage(data) {
     },
     scale(ratio) {
       transforms.scale *= ratio
+      // size = utils.geometry.scale(size, ratio)
+      return this
+    },
+    rotate(degrees) {
+      transforms.rotate = (transforms.rotate + degrees) % 360
+      // size = utils.geometry.rotate(size, degrees)
       return this
     },
     crop(region) {
@@ -64,17 +72,12 @@ function makeImage(data) {
       } else {
         region = utils.geometry.scale(region, 1 / transforms.scale)
       }
-      region = utils.geometry.rotate(region, transforms.rotate)
-      transforms.crop = transforms.crop
+      region = utils.geometry.rotate(region, -transforms.rotate, utils.geometry.rotate(size, transforms.rotate))
+      region = transforms.crop
         ? utils.geometry.intersect(transforms.crop, utils.geometry.offset(region, transforms.crop))
         : utils.geometry.intersect({x: 0, y: 0, ...size}, region)
-
-      size = utils.geometry.round(utils.geometry.size(transforms.crop))
-
-      return this
-    },
-    rotate(degree) {
-      transforms.rotate = (transforms.rotate + degree) % 360
+      transforms.crop = region
+      size = utils.geometry.size(transforms.crop)
       return this
     },
     copy(srcImage, offset) {
@@ -204,9 +207,9 @@ async function transform(image, transforms) {
     }
   }, image)
 
-  image = transforms.rotate > 0 ? await rotate(image, transforms.rotate) : image
   image = transforms.crop ? await extract(image, transforms.crop) : image
   image = transforms.scale !== 1 ? await scale(image, transforms.scale) : image
+  image = transforms.rotate !== 0 ? await rotate(image, transforms.rotate) : image
   return image
 }
 
@@ -296,7 +299,7 @@ async function rotate(image, degrees) {
     for (let srcY = 0, dstX = 0; srcY < image.height; ++srcY, ++dstX) {
       for (let srcX = 0, dstY = image.width - 1; srcX < image.width; ++srcX, --dstY) {
         const pixel = image.data.readUInt32BE((srcY * image.width + srcX) * 4)
-        dstImage.data.writeUInt32BE(pixel, (srcX * dstImage.width + dstY) * 4)
+        dstImage.data.writeUInt32BE(pixel, (dstY * dstImage.width + dstX) * 4)
       }
     }
   } else {

package/src/scroll-into-viewport.js

@@ -15,14 +15,23 @@ async function scrollIntoViewport({context, scroller, region, logger}) {
   let remainingOffset = {x: elementContextRegion.x, y: elementContextRegion.y}
   while (currentContext) {
     const scrollingElement = await currentContext.getScrollingElement()
-    const scrollingElementOffset = scrollingElement
-      ? utils.geometry.location(await scrollingElement.getClientRegion())
-      : {x: 0, y: 0}
+    if (!scrollingElement) {
+      currentContext = currentContext.parent
+      continue
+    }
 
-    const actualOffset = await scroller.moveTo(
-      utils.geometry.offsetNegative(remainingOffset, scrollingElementOffset),
-      scrollingElement,
-    )
+    const scrollableRegion = await scrollingElement.getClientRegion()
+    const requiredOffset = {
+      x: Math.max(
+        remainingOffset.x - (scrollableRegion.x + Math.max(scrollableRegion.width - elementContextRegion.width, 0)),
+        0,
+      ),
+      y: Math.max(
+        remainingOffset.y - (scrollableRegion.y + Math.max(scrollableRegion.height - elementContextRegion.height, 0)),
+        0,
+      ),
+    }
+    const actualOffset = await scroller.moveTo(requiredOffset, scrollingElement)
 
     remainingOffset = utils.geometry.offset(
       utils.geometry.offsetNegative(remainingOffset, actualOffset),

package/src/take-viewport-screenshot.js

@@ -27,14 +27,13 @@ function makeTakeViewportScreenshot(options) {
 }
 
 function makeTakeDefaultScreenshot({driver, stabilization = {}, debug, logger}) {
-  const calculateScaleRatio = makeCalculateScaleRatio({driver})
   return async function takeScreenshot({name} = {}) {
     logger.verbose('Taking screenshot...')
     const image = makeImage(await driver.takeScreenshot())
     await image.debug({...debug, name, suffix: 'original'})
 
     if (stabilization.scale) image.scale(stabilization.scale)
-    else image.scale(await calculateScaleRatio(image.width))
+    else image.scale(1 / driver.pixelRatio)
 
     if (stabilization.rotate) image.crop(stabilization.rotate)
 
@@ -45,7 +44,6 @@ function makeTakeDefaultScreenshot({driver, stabilization = {}, debug, logger})
 }
 
 function makeTakeMainContextScreenshot({driver, stabilization = {}, debug, logger}) {
-  const calculateScaleRatio = makeCalculateScaleRatio({driver})
   return async function takeScreenshot({name} = {}) {
     logger.verbose('Taking screenshot...')
     const originalContext = driver.currentContext
@@ -55,7 +53,7 @@ function makeTakeMainContextScreenshot({driver, stabilization = {}, debug, logge
     await image.debug({...debug, name, suffix: 'original'})
 
     if (stabilization.scale) image.scale(stabilization.scale)
-    else image.scale(await calculateScaleRatio(image.width))
+    else image.scale(1 / driver.pixelRatio)
 
     if (stabilization.rotate) image.rotate(stabilization.rotate)
 
@@ -66,7 +64,6 @@ function makeTakeMainContextScreenshot({driver, stabilization = {}, debug, logge
 }
 
 function makeTakeSafari11Screenshot({driver, stabilization = {}, debug, logger}) {
-  const calculateScaleRatio = makeCalculateScaleRatio({driver})
   let viewportSize
 
   return async function takeScreenshot({name} = {}) {
@@ -75,7 +72,7 @@ function makeTakeSafari11Screenshot({driver, stabilization = {}, debug, logger})
     await image.debug({...debug, name, suffix: 'original'})
 
     if (stabilization.scale) image.scale(stabilization.scale)
-    else image.scale(await calculateScaleRatio(image.width))
+    else image.scale(1 / driver.pixelRatio)
 
     if (stabilization.rotate) image.rotate(stabilization.rotate)
 
@@ -91,7 +88,6 @@ function makeTakeSafari11Screenshot({driver, stabilization = {}, debug, logger})
 }
 
 function makeTakeMarkedScreenshot({driver, stabilization = {}, debug, logger}) {
-  const calculateScaleRatio = makeCalculateScaleRatio({driver})
   let viewportRegion
 
   return async function takeScreenshot({name} = {}) {
@@ -100,9 +96,10 @@ function makeTakeMarkedScreenshot({driver, stabilization = {}, debug, logger}) {
     await image.debug({...debug, name, suffix: 'original'})
 
     if (stabilization.scale) image.scale(stabilization.scale)
-    else image.scale(await calculateScaleRatio(image.width))
+    else image.scale(1 / driver.pixelRatio)
 
     if (stabilization.rotate) image.rotate(stabilization.rotate)
+    else if (driver.orientation === 'landscape' && image.width < image.height) image.rotate(-90)
 
     if (stabilization.crop) image.crop(stabilization.crop)
     else {
@@ -122,7 +119,8 @@ function makeTakeMarkedScreenshot({driver, stabilization = {}, debug, logger}) {
     try {
       const image = makeImage(await driver.takeScreenshot())
 
-      if (stabilization.rotate) await image.rotate(stabilization.rotate)
+      if (stabilization.rotate) image.rotate(stabilization.rotate)
+      else if (driver.orientation === 'landscape' && image.width < image.height) image.rotate(-90)
 
       await image.debug({...debug, name: 'marker'})
 
@@ -148,6 +146,7 @@ function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
     else image.scale(1 / driver.pixelRatio)
 
     if (stabilization.rotate) image.rotate(stabilization.rotate)
+    else if (driver.orientation === 'landscape' && image.width < image.height) image.rotate(-90)
 
     if (stabilization.crop) image.crop(stabilization.crop)
     else {
@@ -164,25 +163,4 @@ function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
   }
 }
 
-function makeCalculateScaleRatio({driver}) {
-  let viewportWidth, contentWidth
-  const VIEWPORT_THRESHOLD = 1
-  const CONTENT_THRESHOLD = 10
-  return async function calculateScaleRatio(imageWidth) {
-    if (!viewportWidth) viewportWidth = await driver.getViewportSize().then(size => size.width)
-    if (!contentWidth) contentWidth = await driver.mainContext.getContentSize().then(size => size.width)
-    // If the image's width is the same as the viewport's width or the
-    // top level context's width, no scaling is necessary.
-    if (
-      (imageWidth >= viewportWidth - VIEWPORT_THRESHOLD && imageWidth <= viewportWidth + VIEWPORT_THRESHOLD) ||
-      (imageWidth >= contentWidth - CONTENT_THRESHOLD && imageWidth <= contentWidth + CONTENT_THRESHOLD)
-    ) {
-      return 1
-    }
-
-    const scaledImageWidth = Math.round(imageWidth / driver.pixelRatio)
-    return viewportWidth / scaledImageWidth / driver.pixelRatio
-  }
-}
-
 module.exports = makeTakeViewportScreenshot

package/test/e2e/android.spec.js

@@ -240,7 +240,6 @@ describe('screenshoter', () => {
 
     const button = await driver.element(buttonSelector)
     await button.click()
-    console.log(await driver.target.getContexts())
     await driver.target.switchContext('WEBVIEW')
 
     await driver.init()

package/test/e2e/ios.spec.js

@@ -203,6 +203,7 @@ describe('screenshoter ios', () => {
     await driver.target.getContexts()
     await utils.general.sleep(500)
     const [, webview] = await driver.target.getContexts()
+    console.log(webview)
     await driver.target.switchContext(webview)
 
     await driver.init()

package/test/e2e/web-ios.spec.js

@@ -18,6 +18,19 @@ const env = {
     username: process.env.SAUCE_USERNAME,
     accessKey: process.env.SAUCE_ACCESS_KEY,
   },
+
+  // url: 'http://0.0.0.0:4723/wd/hub',
+  // capabilities: {
+  //   name: 'iOS Web Screenshoter Test',
+  //   deviceName: 'iPhone 11 Pro',
+  //   browserName: 'safari',
+  //   platformName: 'iOS',
+  //   platformVersion: '14.5',
+  //   appiumVersion: '1.20.1',
+  //   automationName: 'XCUITest',
+  //   username: process.env.SAUCE_USERNAME,
+  //   accessKey: process.env.SAUCE_ACCESS_KEY,
+  // },
 }
 
 describe('screenshoter web ios', () => {
@@ -39,18 +52,33 @@ describe('screenshoter web ios', () => {
   })
 
   it('take viewport screenshot', () => {
-    return viewport()
+    return viewport({orientation: 'portrait'})
+  })
+
+  it('take viewport screenshot with landscape orientation', () => {
+    return viewport({orientation: 'landscape'})
   })
 
   it('take full page screenshot', () => {
-    return fullPage()
+    return fullPage({orientation: 'portrait'})
   })
 
-  async function viewport(options) {
+  it('take full page screenshot with landscape orientation', () => {
+    return fullPage({orientation: 'landscape'})
+  })
+
+  async function viewport({orientation = 'portrait', ...options} = {}) {
+    const expectedPath = `./test/fixtures/web-ios/page${orientation === 'landscape' ? '-landscape' : ''}.png`
+
+    await driver.target.setOrientation(orientation.toUpperCase())
+    await driver.visit(await driver.getUrl())
+
+    await driver.init()
+
     const screenshot = await takeScreenshot({logger, driver, ...options})
     try {
       const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/web-ios/page.png').toObject()
+      const expected = await makeImage(expectedPath).toObject()
       assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
     } catch (err) {
       await screenshot.image.debug({path: './logs', name: 'ios_viewport_failed'})
@@ -58,11 +86,18 @@ describe('screenshoter web ios', () => {
     }
   }
 
-  async function fullPage(options) {
+  async function fullPage({orientation = 'portrait', ...options} = {}) {
+    const expectedPath = `./test/fixtures/web-ios/page-fully${orientation === 'landscape' ? '-landscape' : ''}.png`
+
+    await driver.target.setOrientation(orientation.toUpperCase())
+    await driver.visit(await driver.getUrl())
+
+    await driver.init()
+
     const screenshot = await takeScreenshot({logger, driver, fully: true, ...options})
     try {
       const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/web-ios/page-fully.png').toObject()
+      const expected = await makeImage(expectedPath).toObject()
       assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
     } catch (err) {
       await screenshot.image.debug({path: './logs', name: 'ios_full_page_failed'})