@applitools/screenshoter 3.2.9 → 3.3.3

package/test/it/image.spec.js

@@ -78,42 +78,69 @@ describe('image', () => {
     assert.strictEqual(actual.height, 50000)
   })
 
-  it('should replace region in image with a higher and wider image', async () => {
+  it('should frame image in a higher and wider region', async () => {
     const image = makeImage('./test/fixtures/image/house.png')
     const srcImage = makeImage({
       width: 200,
       height: 200,
       data: Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0, 0xff])),
     })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 100, height: 100})
+    const combinedImage = await srcImage.frame(image, image, {x: 200, y: 200, width: 100, height: 100})
     const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-higher-wider.png').toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-higher-wider.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 
-  it('should replace region in image with a higher image', async () => {
+  it('should frame image in a higher region', async () => {
     const image = await makeImage('./test/fixtures/image/house.png')
     const srcImage = makeImage({
       width: 200,
       height: 200,
       data: Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0xff, 0, 0xff])),
     })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 200, height: 100})
+    const combinedImage = await srcImage.frame(image, image, {x: 200, y: 200, width: 200, height: 100})
     const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-higher.png').toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-higher.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 
-  it('should replace region in image with a higher image', async () => {
+  it('should frame image in a wider region', async () => {
     const image = await makeImage('./test/fixtures/image/house.png')
-    const srcImage = makeImage({
-      width: 200,
-      height: 200,
-      data: Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0, 0xff, 0xff])),
-    })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 100, height: 200})
-    const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-wider.png').toObject()
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 200, y: 200, width: 100, height: 200})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-wider.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a shorter and thinner region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 250, height: 250})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a shorter region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 200, height: 250})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a thinner region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 250, height: 200})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 })

package/src/calculate-screenshot-regions.js

@@ -1,31 +0,0 @@
-const utils = require('@applitools/utils')
-
-async function calculateScreenshotRegions({context, screenshotRegion, regions}) {
-  const screenshotRegions = []
-  for (const region of regions) {
-    screenshotRegions.push(await transformRegion(region))
-  }
-
-  return screenshotRegions
-
-  async function transformRegion(region) {
-    if (utils.types.has(region, ['x', 'y', 'width', 'height'])) {
-      // if someday different coordinate systems will be supported (context or app based), the conversion will happen here
-      return [regions]
-    }
-    const elements = await context.elements(region)
-    return elements.reduce(async (regions, element) => {
-      regions = await regions
-      const region = await element.getRegion()
-      regions.push({
-        x: Math.max(0, region.x - screenshotRegion.x),
-        y: Math.max(0, region.y - screenshotRegion.y),
-        width: region.width,
-        height: region.height,
-      })
-      return regions
-    }, [])
-  }
-}
-
-module.exports = calculateScreenshotRegions

package/src/screenshoter.js

@@ -1,159 +0,0 @@
-const utils = require('@applitools/utils')
-const makeScroller = require('./scroller')
-const scrollIntoViewport = require('./scroll-into-viewport')
-const takeStitchedScreenshot = require('./take-stitched-screenshot')
-const takeViewportScreenshot = require('./take-viewport-screenshot')
-
-async function screenshoter({
-  driver,
-  frames = [],
-  region,
-  fully,
-  scrollingMode,
-  hideScrollbars,
-  hideCaret,
-  withStatusBar,
-  overlap,
-  framed,
-  wait,
-  stabilization,
-  hooks,
-  debug,
-  logger,
-}) {
-  // screenshot of a window/app was requested (fully or viewport)
-  const window = !region && (!frames || frames.length === 0)
-  // framed screenshots could be taken only when screenshot of window/app fully was requested
-  framed = framed && fully && window
-  // screenshots with status bar could be taken only when screenshot of app or framed app fully was requested
-  withStatusBar = withStatusBar && driver.isNative && window && (!fully || framed)
-  scrollingMode = driver.isNative ? 'scroll' : scrollingMode
-
-  const activeContext = driver.currentContext
-  const context =
-    frames.length > 0
-      ? await activeContext.context(frames.reduce((parent, frame) => ({...frame, parent}), null))
-      : activeContext
-
-  // traverse from main context to target context to hide scrollbars and preserve context state (scroll/translate position)
-  for (const nextContext of context.path) {
-    const scrollingElement = await nextContext.getScrollingElement()
-    // unlike web apps, native apps do not always have scrolling element
-    if (scrollingElement) {
-      if (driver.isWeb && hideScrollbars) await scrollingElement.hideScrollbars()
-      await scrollingElement.preserveState()
-    }
-  }
-
-  // blur active element in target context
-  const activeElement = driver.isWeb && hideCaret ? await context.blurElement() : null
-
-  const target = await getTarget({window, context, region, fully, scrollingMode, logger})
-
-  if (driver.isWeb && hideScrollbars) await target.scroller.hideScrollbars()
-
-  try {
-    if (!window) await scrollIntoViewport({...target, 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 && target.scroller) {
-        await target.scroller.moveTo({x: 0, y: 0}, await driver.mainContext.getScrollingElement())
-      }
-      await hooks.afterScreenshot({driver, scroller: target.scroller, screenshot})
-    }
-
-    return screenshot
-  } finally {
-    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)
-
-    // 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()
-  }
-}
-
-async function getTarget({window, context, region, fully, scrollingMode, logger}) {
-  if (window) {
-    // window/app
-    const scrollingElement = await context.main.getScrollingElement()
-    return {
-      context: context.main,
-      scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
-    }
-  } else if (region) {
-    if (utils.types.has(region, ['x', 'y', 'width', 'height'])) {
-      // region by coordinates
-      const scrollingElement = await context.getScrollingElement()
-      return {
-        context,
-        region,
-        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 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: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
-        }
-      } else {
-        const scrollingElement = await context.getScrollingElement()
-        return {
-          context: elementContext,
-          region: await element.getRegion(),
-          scroller: scrollingElement ? makeScroller({element: scrollingElement, scrollingMode, logger}) : null,
-        }
-      }
-    }
-  } else if (!context.isMain) {
-    // context
-    if (fully) {
-      const scrollingElement = await context.getScrollingElement()
-      return {
-        context,
-        scroller: scrollingElement ? makeScroller({logger, element: scrollingElement, scrollingMode}) : null,
-      }
-    } else {
-      const scrollingElement = await context.parent.getScrollingElement()
-      const element = await context.getContextElement()
-      return {
-        context: context.parent,
-        region: await element.getRegion(), // IMHO we should use CLIENT (without borders) region here
-        scroller: scrollingElement ? makeScroller({logger, element: scrollingElement, scrollingMode}) : null,
-      }
-    }
-  }
-}
-
-module.exports = screenshoter